Class: AWSCDK::APIGateway::AddAPIKeyOptions

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

Overview

Options to the UsagePlan.addApiKey() method.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(override_logical_id: nil) ⇒ AddAPIKeyOptions

Returns a new instance of AddAPIKeyOptions.

Parameters:

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

    Override the CloudFormation logical id of the AWS::ApiGateway::UsagePlanKey resource.



8
9
10
11
 
# File 'api_gateway/add_api_key_options.rb', line 8

def initialize(override_logical_id: nil)
  @override_logical_id = override_logical_id
  Jsii::Type.check_type(@override_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "overrideLogicalId") unless @override_logical_id.nil?
end

Instance Attribute Details

#override_logical_id ⇒ String? (readonly)

Note:

Default: - autogenerated by the CDK

Override the CloudFormation logical id of the AWS::ApiGateway::UsagePlanKey resource.

Returns:

  • (String, nil) 


17
18
19
 
# File 'api_gateway/add_api_key_options.rb', line 17

def override_logical_id
  @override_logical_id
end

Class Method Details

.jsii_properties ⇒ Object 



19
20
21
22
23
 
# File 'api_gateway/add_api_key_options.rb', line 19

def self.jsii_properties
  {
    :override_logical_id => "overrideLogicalId",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



25
26
27
28
29
30
31
 
# File 'api_gateway/add_api_key_options.rb', line 25

def to_jsii
  result = {}
  result.merge!({
    "overrideLogicalId" => @override_logical_id,
  })
  result.compact
end