You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apigateway/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.

Instance Attribute Summary collapse

Instance Attribute Details

#customer_idString

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

Returns:

  • (String)


660
661
662
663
664
665
666
667
668
669
670
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 660

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

#descriptionString

The description of the ApiKey.

Returns:

  • (String)


660
661
662
663
664
665
666
667
668
669
670
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 660

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

#enabledBoolean

Specifies whether the ApiKey can be used by callers.

Returns:

  • (Boolean)


660
661
662
663
664
665
666
667
668
669
670
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 660

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

#generate_distinct_idBoolean

Specifies whether (true) or not (false) the key identifier is distinct from the created API key value.

Returns:

  • (Boolean)


660
661
662
663
664
665
666
667
668
669
670
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 660

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

#nameString

The name of the ApiKey.

Returns:

  • (String)


660
661
662
663
664
665
666
667
668
669
670
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 660

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

#stage_keysArray<Types::StageKey>

DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.

Returns:



660
661
662
663
664
665
666
667
668
669
670
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 660

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

#tagsHash<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>)


660
661
662
663
664
665
666
667
668
669
670
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 660

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

#valueString

Specifies a value of the API key.

Returns:

  • (String)


660
661
662
663
664
665
666
667
668
669
670
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 660

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