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

Interface CreateApiKeyRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateApiKeyRequest.Builder,CreateApiKeyRequest>, SdkBuilder<CreateApiKeyRequest.Builder,CreateApiKeyRequest>, SdkPojo, SdkRequest.Builder, Wafv2Request.Builder
Enclosing class:
CreateApiKeyRequest
@Mutable @NotThreadSafe public static interface CreateApiKeyRequest.Builder extends Wafv2Request.Builder, SdkPojo, CopyableBuilder<CreateApiKeyRequest.Builder,CreateApiKeyRequest>

  • Method Details

    • scope

      CreateApiKeyRequest.Builder scope(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • scope

      CreateApiKeyRequest.Builder scope(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tokenDomains

      CreateApiKeyRequest.Builder tokenDomains(Collection<String> tokenDomains)

      The client application domains that you want to use this API key for.

      Example JSON: "TokenDomains": ["abc.com", "store.abc.com"]

      Public suffixes aren't allowed. For example, you can't use gov.au or co.uk as token domains.

      Parameters:
      tokenDomains - The client application domains that you want to use this API key for.

      Example JSON: "TokenDomains": ["abc.com", "store.abc.com"]

      Public suffixes aren't allowed. For example, you can't use gov.au or co.uk as token domains.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tokenDomains

      CreateApiKeyRequest.Builder tokenDomains(String... tokenDomains)

      The client application domains that you want to use this API key for.

      Example JSON: "TokenDomains": ["abc.com", "store.abc.com"]

      Public suffixes aren't allowed. For example, you can't use gov.au or co.uk as token domains.

      Parameters:
      tokenDomains - The client application domains that you want to use this API key for.

      Example JSON: "TokenDomains": ["abc.com", "store.abc.com"]

      Public suffixes aren't allowed. For example, you can't use gov.au or co.uk as token domains.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateApiKeyRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder

    • overrideConfiguration

      CreateApiKeyRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder