Class: Aws::WAFV2::Types::APIKeySummary

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb

Overview

Information for a single API key.

API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#api_key ⇒ String

The generated, encrypted API key. You can copy this for use in your JavaScript CAPTCHA integration.

Returns:

  • (String) 


45
46
47
48
49
50
51
52
 
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 45

class APIKeySummary < Struct.new(
  :token_domains,
  :api_key,
  :creation_timestamp,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#creation_timestamp ⇒ Time

The date and time that the key was created.

Returns:

  • (Time) 


45
46
47
48
49
50
51
52
 
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 45

class APIKeySummary < Struct.new(
  :token_domains,
  :api_key,
  :creation_timestamp,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#token_domains ⇒ Array<String>

The token domains that are defined in this API key.

Returns:

  • (Array<String>) 


45
46
47
48
49
50
51
52
 
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 45

class APIKeySummary < Struct.new(
  :token_domains,
  :api_key,
  :creation_timestamp,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#version ⇒ Integer

Internal value used by WAF to manage the key.

Returns:

  • (Integer) 


45
46
47
48
49
50
51
52
 
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 45

class APIKeySummary < Struct.new(
  :token_domains,
  :api_key,
  :creation_timestamp,
  :version)
  SENSITIVE = []
  include Aws::Structure
end