Class PutManagedRuleSetVersionsRequest

    • Method Detail

      • 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 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
      • 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.
      • recommendedVersion

        public final String recommendedVersion()

        The version of the named managed rule group that you'd like your customers to choose, from among your version offerings.

        Returns:
        The version of the named managed rule group that you'd like your customers to choose, from among your version offerings.
      • hasVersionsToPublish

        public final boolean hasVersionsToPublish()
        For responses, this returns true if the service returned a value for the VersionsToPublish property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • versionsToPublish

        public final Map<String,​VersionToPublish> versionsToPublish()

        The versions of the named managed rule group that you want to offer to your customers.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasVersionsToPublish() method.

        Returns:
        The versions of the named managed rule group that you want to offer to your customers.
      • 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