Class: AWSCDK::APIGateway::CfnAPIKeyProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
api_gateway/cfn_api_key_props.rb

Overview

Properties for defining a CfnApiKey.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(customer_id: nil, description: nil, enabled: nil, generate_distinct_id: nil, name: nil, stage_keys: nil, tags: nil, value: nil) ⇒ CfnAPIKeyProps

Returns a new instance of CfnAPIKeyProps.

Parameters:

  • customer_id (String, nil) (defaults to: nil) —

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

  • description (String, nil) (defaults to: nil) —

    The description of the ApiKey.

  • enabled (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Specifies whether the ApiKey can be used by callers.

  • generate_distinct_id (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

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

  • name (String, nil) (defaults to: nil) —

    A name for the API key.

  • stage_keys (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::APIGateway::CfnAPIKey::StageKeyProperty>, nil) (defaults to: nil) —

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

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    The key-value map of strings.

  • value (String, nil) (defaults to: nil) —

    Specifies a value of the API key.



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'api_gateway/cfn_api_key_props.rb', line 17

def initialize(customer_id: nil, description: nil, enabled: nil, generate_distinct_id: nil, name: nil, stage_keys: nil, tags: nil, value: nil)
  @customer_id = customer_id
  Jsii::Type.check_type(@customer_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "customerId") unless @customer_id.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @enabled = enabled
  Jsii::Type.check_type(@enabled, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "enabled") unless @enabled.nil?
  @generate_distinct_id = generate_distinct_id
  Jsii::Type.check_type(@generate_distinct_id, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "generateDistinctId") unless @generate_distinct_id.nil?
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
  @stage_keys = stage_keys
  Jsii::Type.check_type(@stage_keys, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheS5DZm5BcGlLZXkuU3RhZ2VLZXlQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "stageKeys") unless @stage_keys.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
  @value = value
  Jsii::Type.check_type(@value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "value") unless @value.nil?
end

Instance Attribute Details

#customer_id ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



40
41
42
 
# File 'api_gateway/cfn_api_key_props.rb', line 40

def customer_id
  @customer_id
end

#description ⇒ String? (readonly)

The description of the ApiKey.

Returns:

  • (String, nil)

See Also:



45
46
47
 
# File 'api_gateway/cfn_api_key_props.rb', line 45

def description
  @description
end

#enabled ⇒ Boolean, ... (readonly)

Note:

Default: - false

Specifies whether the ApiKey can be used by callers.

Returns:

See Also:



51
52
53
 
# File 'api_gateway/cfn_api_key_props.rb', line 51

def enabled
  @enabled
end

#generate_distinct_id ⇒ Boolean, ... (readonly)

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:

See Also:



58
59
60
 
# File 'api_gateway/cfn_api_key_props.rb', line 58

def generate_distinct_id
  @generate_distinct_id
end

#name ⇒ String? (readonly)

A name for the API key.

If you don't specify a name, CloudFormation generates a unique physical ID and uses that ID for the API key name. For more information, see Name Type .

If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

Returns:

  • (String, nil)

See Also:



67
68
69
 
# File 'api_gateway/cfn_api_key_props.rb', line 67

def name
  @name
end

#stage_keys ⇒ AWSCDK::IResolvable, ... (readonly)

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

Returns:

See Also:



72
73
74
 
# File 'api_gateway/cfn_api_key_props.rb', line 72

def stage_keys
  @stage_keys
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

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:

See Also:



79
80
81
 
# File 'api_gateway/cfn_api_key_props.rb', line 79

def tags
  @tags
end

#value ⇒ String? (readonly)

Specifies a value of the API key.

Returns:

  • (String, nil)

See Also:



84
85
86
 
# File 'api_gateway/cfn_api_key_props.rb', line 84

def value
  @value
end

Class Method Details

.jsii_properties ⇒ Object 



86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'api_gateway/cfn_api_key_props.rb', line 86

def self.jsii_properties
  {
    :customer_id => "customerId",
    :description => "description",
    :enabled => "enabled",
    :generate_distinct_id => "generateDistinctId",
    :name => "name",
    :stage_keys => "stageKeys",
    :tags => "tags",
    :value => "value",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'api_gateway/cfn_api_key_props.rb', line 99

def to_jsii
  result = {}
  result.merge!({
    "customerId" => @customer_id,
    "description" => @description,
    "enabled" => @enabled,
    "generateDistinctId" => @generate_distinct_id,
    "name" => @name,
    "stageKeys" => @stage_keys,
    "tags" => @tags,
    "value" => @value,
  })
  result.compact
end