Class: AWSCDK::APIGateway::CfnAPIKey::StageKeyProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::APIGateway::CfnAPIKey::StageKeyProperty

Defined in:

api_gateway/cfn_api_key.rb

Overview

StageKey is a property of the AWS::ApiGateway::ApiKey resource that specifies the stage to associate with the API key. This association allows only clients with the key to make requests to methods in that stage.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-apikey-stagekey.html

Instance Attribute Summary

• #rest_api_id ⇒ String^? readonly

  The string identifier of the associated RestApi.

• #stage_name ⇒ String^? readonly

  The stage name associated with the stage key.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(rest_api_id: nil, stage_name: nil) ⇒ StageKeyProperty constructor

  A new instance of StageKeyProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(rest_api_id: nil, stage_name: nil) ⇒ StageKeyProperty

Returns a new instance of StageKeyProperty.

Parameters:

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

  The string identifier of the associated RestApi.

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

  The stage name associated with the stage key.

# File 'api_gateway/cfn_api_key.rb', line 626

def initialize(rest_api_id: nil, stage_name: nil)
  @rest_api_id = rest_api_id
  Jsii::Type.check_type(@rest_api_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "restApiId") unless @rest_api_id.nil?
  @stage_name = stage_name
  Jsii::Type.check_type(@stage_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "stageName") unless @stage_name.nil?
end

Instance Attribute Details

#rest_api_id ⇒ String^? (readonly)

The string identifier of the associated RestApi.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-apikey-stagekey.html#cfn-apigateway-apikey-stagekey-restapiid

# File 'api_gateway/cfn_api_key.rb', line 637

def rest_api_id
  @rest_api_id
end

#stage_name ⇒ String^? (readonly)

The stage name associated with the stage key.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-apikey-stagekey.html#cfn-apigateway-apikey-stagekey-stagename

# File 'api_gateway/cfn_api_key.rb', line 642

def stage_name
  @stage_name
end

Class Method Details

.jsii_properties ⇒ Object

# File 'api_gateway/cfn_api_key.rb', line 644

def self.jsii_properties
  {
    :rest_api_id => "restApiId",
    :stage_name => "stageName",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'api_gateway/cfn_api_key.rb', line 651

def to_jsii
  result = {}
  result.merge!({
    "restApiId" => @rest_api_id,
    "stageName" => @stage_name,
  })
  result.compact
end