Class: Aws::WAFV2::Types::CreateAPIKeyRequest

Inherits:

Struct

Object
Struct
Aws::WAFV2::Types::CreateAPIKeyRequest

show all

Defined in:: gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#scope ⇒ String
Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution.
#token_domains ⇒ Array<String>
The client application domains that you want to use this API key for.

Instance Attribute Details

#scope ⇒ `String`

Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution.

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:

(String)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 1085

class CreateAPIKeyRequest < Struct.new(
  :scope,
  :token_domains)
  SENSITIVE = []
  include Aws::Structure
end

#token_domains ⇒ `Array<String>`

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.