Package software.amazon.awssdk.services.wafv2.model

Class GetRateBasedStatementManagedKeysRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.wafv2.model.Wafv2Request

software.amazon.awssdk.services.wafv2.model.GetRateBasedStatementManagedKeysRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetRateBasedStatementManagedKeysRequest.Builder,GetRateBasedStatementManagedKeysRequest>

@Generated("software.amazon.awssdk:codegen")
public final class GetRateBasedStatementManagedKeysRequest
extends Wafv2Request
implements ToCopyableBuilder<GetRateBasedStatementManagedKeysRequest.Builder,GetRateBasedStatementManagedKeysRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetRateBasedStatementManagedKeysRequest.Builder

Method Summary

Modifier and Type	Method	Description
static GetRateBasedStatementManagedKeysRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	ruleGroupRuleName()	The name of the rule group reference statement in your web ACL.
String	ruleName()	The name of the rate-based rule to get the keys for.
Scope	scope()	Specifies whether this is for an Amazon CloudFront distribution or for a regional application.
String	scopeAsString()	Specifies whether this is for an Amazon CloudFront distribution or for a regional application.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GetRateBasedStatementManagedKeysRequest.Builder>	serializableBuilderClass()
GetRateBasedStatementManagedKeysRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	webACLId()	The unique identifier for the web ACL.
String	webACLName()	The name of the web ACL.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

scope

public final Scope scope()

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

• CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

• API and SDKs - For all calls, use the Region endpoint us-east-1.

If the service returns an enum value that is not available in the current SDK version, scope will return Scope.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scopeAsString().

Returns:

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

• CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

• API and SDKs - For all calls, use the Region endpoint us-east-1.

See Also:

Scope

scopeAsString

public final String scopeAsString()

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

• CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

• API and SDKs - For all calls, use the Region endpoint us-east-1.

If the service returns an enum value that is not available in the current SDK version, scope will return Scope.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scopeAsString().

Returns:

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

• CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

• API and SDKs - For all calls, use the Region endpoint us-east-1.

See Also:

Scope

webACLName

public final String webACLName()

The name of the web ACL. You cannot change the name of a web ACL after you create it.

Returns:

The name of the web ACL. You cannot change the name of a web ACL after you create it.

webACLId

public final String webACLId()

The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

Returns:

The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

ruleGroupRuleName

public final String ruleGroupRuleName()

The name of the rule group reference statement in your web ACL. This is required only when you have the rate-based rule nested inside a rule group.

Returns:

The name of the rule group reference statement in your web ACL. This is required only when you have the rate-based rule nested inside a rule group.

ruleName

public final String ruleName()

The name of the rate-based rule to get the keys for. If you have the rule defined inside a rule group that you're using in your web ACL, also provide the name of the rule group reference statement in the request parameter RuleGroupRuleName.

Returns:

The name of the rate-based rule to get the keys for. If you have the rule defined inside a rule group that you're using in your web ACL, also provide the name of the rule group reference statement in the request parameter RuleGroupRuleName.

toBuilder

public GetRateBasedStatementManagedKeysRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetRateBasedStatementManagedKeysRequest.Builder,GetRateBasedStatementManagedKeysRequest>

Specified by:

toBuilder in class Wafv2Request

builder

public static GetRateBasedStatementManagedKeysRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetRateBasedStatementManagedKeysRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo