Class: AWSCDK::APIGateway::CfnUsagePlan::APIStageProperty

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

Overview

API stage name of the associated API stage in a usage plan.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_id: nil, stage: nil, throttle: nil) ⇒ APIStageProperty

Returns a new instance of APIStageProperty.

Parameters:



605
606
607
608
609
610
611
612
 
# File 'api_gateway/cfn_usage_plan.rb', line 605

def initialize(api_id: nil, stage: nil, throttle: nil)
  @api_id = api_id
  Jsii::Type.check_type(@api_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "apiId") unless @api_id.nil?
  @stage = stage
  Jsii::Type.check_type(@stage, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "stage") unless @stage.nil?
  @throttle = throttle
  Jsii::Type.check_type(@throttle, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheS5DZm5Vc2FnZVBsYW4uVGhyb3R0bGVTZXR0aW5nc1Byb3BlcnR5In1dfX0sImtpbmQiOiJtYXAifX1dfX0=")), "throttle") unless @throttle.nil?
end

Instance Attribute Details

#api_id ⇒ String? (readonly)

API Id of the associated API stage in a usage plan.

Returns:

  • (String, nil)

See Also:



618
619
620
 
# File 'api_gateway/cfn_usage_plan.rb', line 618

def api_id
  @api_id
end

#stage ⇒ String? (readonly)

API stage name of the associated API stage in a usage plan.

Returns:

  • (String, nil)

See Also:



623
624
625
 
# File 'api_gateway/cfn_usage_plan.rb', line 623

def stage
  @stage
end

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

Map containing method level throttling information for API stage in a usage plan.

Returns:

See Also:



628
629
630
 
# File 'api_gateway/cfn_usage_plan.rb', line 628

def throttle
  @throttle
end

Class Method Details

.jsii_properties ⇒ Object 



630
631
632
633
634
635
636
 
# File 'api_gateway/cfn_usage_plan.rb', line 630

def self.jsii_properties
  {
    :api_id => "apiId",
    :stage => "stage",
    :throttle => "throttle",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



638
639
640
641
642
643
644
645
646
 
# File 'api_gateway/cfn_usage_plan.rb', line 638

def to_jsii
  result = {}
  result.merge!({
    "apiId" => @api_id,
    "stage" => @stage,
    "throttle" => @throttle,
  })
  result.compact
end