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

Interface CreateApiKeyRequest.Builder

    • Method Detail

      • scope

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

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

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

      • scope

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

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

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

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