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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateApiKeyRequest as input to an Aws::Client method, you can use a vanilla 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_id ⇒ String

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

Returns:

  • (String) —

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

#description ⇒ String

The description of the ApiKey.

Returns:

  • (String) —

    The description of the ApiKey.

#enabled ⇒ Boolean

Specifies whether the ApiKey can be used by callers.

Returns:

  • (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. This parameter is deprecated and should not be used.

Returns:

  • (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.

Returns:

  • (String) —

    The name of the ApiKey.

#stage_keys ⇒ Array<Types::StageKey>

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

Returns:

  • (Array<Types::StageKey>) —

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

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

    The key-value map of strings.

#value ⇒ String

Specifies a value of the API key.

Returns:

  • (String) —

    Specifies a value of the API key.