class Aws::APIGateway::Types::CreateApiKeyRequest

Request to create an ApiKey resource.

@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",
      },
    }

@!attribute [rw] name

The name of the ApiKey.
@return [String]

@!attribute [rw] description

The description of the ApiKey.
@return [String]

@!attribute [rw] enabled

Specifies whether the ApiKey can be used by callers.
@return [Boolean]

@!attribute [rw] generate_distinct_id

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.
@return [Boolean]

@!attribute [rw] value

Specifies a value of the API key.
@return [String]

@!attribute [rw] stage_keys

DEPRECATED FOR USAGE PLANS - Specifies stages associated with the
API key.
@return [Array<Types::StageKey>]

@!attribute [rw] customer_id

An AWS Marketplace customer identifier , when integrating with the
AWS SaaS Marketplace.
@return [String]

@!attribute [rw] tags

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.
@return [Hash<String,String>]

Constants

SENSITIVE