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

Inherits:
Struct
  • Object
show all
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

Instance Attribute Details

#customer_idString

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

Returns:

  • (String)


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

#descriptionString

The description of the ApiKey.

Returns:

  • (String)


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

#enabledBoolean

Specifies whether the ApiKey can be used by callers.

Returns:

  • (Boolean)


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_idBoolean

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)


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

#nameString

The name of the ApiKey.

Returns:

  • (String)


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_keysArray<Types::StageKey>

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

Returns:



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

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


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

#valueString

Specifies a value of the API key.

Returns:

  • (String)


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