Class: AWSCDK::APIGateway::CfnUsagePlanKeyProps

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

Overview

Properties for defining a CfnUsagePlanKey.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(key_id:, key_type:, usage_plan_id:) ⇒ CfnUsagePlanKeyProps

Returns a new instance of CfnUsagePlanKeyProps.

Parameters:



12
13
14
15
16
17
18
19
 
# File 'api_gateway/cfn_usage_plan_key_props.rb', line 12

def initialize(key_id:, key_type:, usage_plan_id:)
  @key_id = key_id
  Jsii::Type.check_type(@key_id, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19hcGlnYXRld2F5LklBcGlLZXlSZWYifV19fQ==")), "keyId")
  @key_type = key_type
  Jsii::Type.check_type(@key_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "keyType")
  @usage_plan_id = usage_plan_id
  Jsii::Type.check_type(@usage_plan_id, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19hcGlnYXRld2F5LklVc2FnZVBsYW5SZWYifV19fQ==")), "usagePlanId")
end

Instance Attribute Details

#key_id ⇒ String, AWSCDK::Interfaces::AWSApigateway::IAPIKeyRef (readonly)

The Id of the UsagePlanKey resource.

Returns:

See Also:



25
26
27
 
# File 'api_gateway/cfn_usage_plan_key_props.rb', line 25

def key_id
  @key_id
end

#key_type ⇒ String (readonly)

The type of a UsagePlanKey resource for a plan customer.

Returns:

  • (String)

See Also:



30
31
32
 
# File 'api_gateway/cfn_usage_plan_key_props.rb', line 30

def key_type
  @key_type
end

#usage_plan_id ⇒ String, AWSCDK::Interfaces::AWSApigateway::IUsagePlanRef (readonly)

The Id of the UsagePlan resource representing the usage plan containing the UsagePlanKey resource representing a plan customer.

Returns:

See Also:



35
36
37
 
# File 'api_gateway/cfn_usage_plan_key_props.rb', line 35

def usage_plan_id
  @usage_plan_id
end

Class Method Details

.jsii_properties ⇒ Object 



37
38
39
40
41
42
43
 
# File 'api_gateway/cfn_usage_plan_key_props.rb', line 37

def self.jsii_properties
  {
    :key_id => "keyId",
    :key_type => "keyType",
    :usage_plan_id => "usagePlanId",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



45
46
47
48
49
50
51
52
53
 
# File 'api_gateway/cfn_usage_plan_key_props.rb', line 45

def to_jsii
  result = {}
  result.merge!({
    "keyId" => @key_id,
    "keyType" => @key_type,
    "usagePlanId" => @usage_plan_id,
  })
  result.compact
end