Class: Aws::APIGateway::Types::CreateApiKeyRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-apigateway/types.rb

Overview

Note:

When making an API call, you may pass CreateApiKeyRequest data as a hash:

{
  name: "String",
  description: "String",
  enabled: false,
  generate_distinct_id: false,
  value: "String",
  stage_keys: [
    {
      rest_api_id: "String",
      stage_name: "String",
    },
  ],
  customer_id: "String",
  tags: {
    "String" => "String",
  },
}

Request to create an ApiKey resource.

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#customer_id ⇒ String

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

Returns:

  • (String) 


681
682
683
684
685
686
687
688
689
690
691
692
 
# File 'lib/aws-sdk-apigateway/types.rb', line 681

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.

Returns:

  • (String) 


681
682
683
684
685
686
687
688
689
690
691
692
 
# File 'lib/aws-sdk-apigateway/types.rb', line 681

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.

Returns:

  • (Boolean) 


681
682
683
684
685
686
687
688
689
690
691
692
 
# File 'lib/aws-sdk-apigateway/types.rb', line 681

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.

Returns:

  • (Boolean) 


681
682
683
684
685
686
687
688
689
690
691
692
 
# File 'lib/aws-sdk-apigateway/types.rb', line 681

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.

Returns:

  • (String) 


681
682
683
684
685
686
687
688
689
690
691
692
 
# File 'lib/aws-sdk-apigateway/types.rb', line 681

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.

Returns:



681
682
683
684
685
686
687
688
689
690
691
692
 
# File 'lib/aws-sdk-apigateway/types.rb', line 681

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.

Returns:

  • (Hash<String,String>) 


681
682
683
684
685
686
687
688
689
690
691
692
 
# File 'lib/aws-sdk-apigateway/types.rb', line 681

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.

Returns:

  • (String) 


681
682
683
684
685
686
687
688
689
690
691
692
 
# File 'lib/aws-sdk-apigateway/types.rb', line 681

class CreateApiKeyRequest < Struct.new(
  :name,
  :description,
  :enabled,
  :generate_distinct_id,
  :value,
  :stage_keys,
  :customer_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end