software.amazon.awssdk.services.wafv2.model

Class DescribeManagedRuleGroupRequest

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.DescribeManagedRuleGroupRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeManagedRuleGroupRequest.Builder,DescribeManagedRuleGroupRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeManagedRuleGroupRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeManagedRuleGroupRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name() The name of the managed rule group.
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.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeManagedRuleGroupRequest.Builder>	serializableBuilderClass()
DescribeManagedRuleGroupRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	vendorName() The name of the managed rule group vendor.
String	versionName() The version of the rule group.

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

vendorName

public final String vendorName()

The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.

Returns:

The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.

name

public final String name()

The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

Returns:

The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

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

versionName

public final String versionName()

The version of the rule group. You can only use a version that is not scheduled for expiration. If you don't provide this, WAF uses the vendor's default version.

Returns:

The version of the rule group. You can only use a version that is not scheduled for expiration. If you don't provide this, WAF uses the vendor's default version.

toBuilder

public DescribeManagedRuleGroupRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeManagedRuleGroupRequest.Builder,DescribeManagedRuleGroupRequest>

Specified by:

toBuilder in class Wafv2Request

builder

public static DescribeManagedRuleGroupRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeManagedRuleGroupRequest.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