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

Class UpdateManagedRuleSetVersionExpiryDateRequest

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.UpdateManagedRuleSetVersionExpiryDateRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateManagedRuleSetVersionExpiryDateRequest.Builder,UpdateManagedRuleSetVersionExpiryDateRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateManagedRuleSetVersionExpiryDateRequest extends Wafv2Request implements ToCopyableBuilder<UpdateManagedRuleSetVersionExpiryDateRequest.Builder,UpdateManagedRuleSetVersionExpiryDateRequest>

  • Method Details

    • name

      public final String name()

      The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

      This name is assigned to the corresponding managed rule group, which your customers can access and use.

      Returns:
      The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

      This name is assigned to the corresponding managed rule group, which your customers can access and use.

    • scope

      public final Scope scope()

      Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use CLOUDFRONT.

      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 a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use CLOUDFRONT.

      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:

    • scopeAsString

      public final String scopeAsString()

      Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use CLOUDFRONT.

      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 a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use CLOUDFRONT.

      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:

    • id

      public final String id()

      A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.

      Returns:
      A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.

    • lockToken

      public final String lockToken()

      A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

      Returns:
      A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

    • versionToExpire

      public final String versionToExpire()

      The version that you want to remove from your list of offerings for the named managed rule group.

      Returns:
      The version that you want to remove from your list of offerings for the named managed rule group.

    • expiryTimestamp

      public final Instant expiryTimestamp()

      The time that you want the version to expire.

      Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z".

      Returns:
      The time that you want the version to expire.

      Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z".

    • toBuilder

      public UpdateManagedRuleSetVersionExpiryDateRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<UpdateManagedRuleSetVersionExpiryDateRequest.Builder,UpdateManagedRuleSetVersionExpiryDateRequest>
      Specified by:
      toBuilder in class Wafv2Request

    • builder

      public static UpdateManagedRuleSetVersionExpiryDateRequest.Builder builder()

    • serializableBuilderClass

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