Class: Aws::APIGateway::Types::CreateApiKeyRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::APIGateway::Types::CreateApiKeyRequest
- Defined in:
- gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb
Overview
Request to create an ApiKey resource.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#customer_id ⇒ String
An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.
-
#description ⇒ String
The description of the ApiKey.
-
#enabled ⇒ Boolean
Specifies whether the ApiKey can be used by callers.
-
#generate_distinct_id ⇒ Boolean
Specifies whether (
true
) or not (false
) the key identifier is distinct from the created API key value. -
#name ⇒ String
The name of the ApiKey.
-
#stage_keys ⇒ Array<Types::StageKey>
DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
-
#tags ⇒ Hash<String,String>
The key-value map of strings.
-
#value ⇒ String
Specifies a value of the API key.
Instance Attribute Details
#customer_id ⇒ String
An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.
508 509 510 511 512 513 514 515 516 517 518 519 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 508 class CreateApiKeyRequest < Struct.new( :name, :description, :enabled, :generate_distinct_id, :value, :stage_keys, :customer_id, :tags) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
The description of the ApiKey.
508 509 510 511 512 513 514 515 516 517 518 519 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 508 class CreateApiKeyRequest < Struct.new( :name, :description, :enabled, :generate_distinct_id, :value, :stage_keys, :customer_id, :tags) SENSITIVE = [] include Aws::Structure end |
#enabled ⇒ Boolean
Specifies whether the ApiKey can be used by callers.
508 509 510 511 512 513 514 515 516 517 518 519 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 508 class CreateApiKeyRequest < Struct.new( :name, :description, :enabled, :generate_distinct_id, :value, :stage_keys, :customer_id, :tags) SENSITIVE = [] include Aws::Structure end |
#generate_distinct_id ⇒ Boolean
Specifies whether (true
) or not (false
) the key identifier is
distinct from the created API key value. This parameter is
deprecated and should not be used.
508 509 510 511 512 513 514 515 516 517 518 519 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 508 class CreateApiKeyRequest < Struct.new( :name, :description, :enabled, :generate_distinct_id, :value, :stage_keys, :customer_id, :tags) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
The name of the ApiKey.
508 509 510 511 512 513 514 515 516 517 518 519 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 508 class CreateApiKeyRequest < Struct.new( :name, :description, :enabled, :generate_distinct_id, :value, :stage_keys, :customer_id, :tags) SENSITIVE = [] include Aws::Structure end |
#stage_keys ⇒ Array<Types::StageKey>
DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
508 509 510 511 512 513 514 515 516 517 518 519 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 508 class CreateApiKeyRequest < Struct.new( :name, :description, :enabled, :generate_distinct_id, :value, :stage_keys, :customer_id, :tags) SENSITIVE = [] include Aws::Structure end |
#tags ⇒ Hash<String,String>
The key-value map of strings. The valid character set is
[a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must
not start with aws:
. The tag value can be up to 256 characters.
508 509 510 511 512 513 514 515 516 517 518 519 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 508 class CreateApiKeyRequest < Struct.new( :name, :description, :enabled, :generate_distinct_id, :value, :stage_keys, :customer_id, :tags) SENSITIVE = [] include Aws::Structure end |
#value ⇒ String
Specifies a value of the API key.
508 509 510 511 512 513 514 515 516 517 518 519 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 508 class CreateApiKeyRequest < Struct.new( :name, :description, :enabled, :generate_distinct_id, :value, :stage_keys, :customer_id, :tags) SENSITIVE = [] include Aws::Structure end |