Class: AWSCDK::RefactorSpaces::CfnApplication::APIGatewayProxyInputProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::RefactorSpaces::CfnApplication::APIGatewayProxyInputProperty

Defined in:

refactor_spaces/cfn_application.rb

Overview

A wrapper object holding the Amazon API Gateway endpoint input.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-refactorspaces-application-apigatewayproxyinput.html

Instance Attribute Summary

• #endpoint_type ⇒ String^? readonly

  The type of endpoint to use for the API Gateway proxy.

• #stage_name ⇒ String^? readonly

  The name of the API Gateway stage.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(endpoint_type: nil, stage_name: nil) ⇒ APIGatewayProxyInputProperty constructor

  A new instance of APIGatewayProxyInputProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(endpoint_type: nil, stage_name: nil) ⇒ APIGatewayProxyInputProperty

Returns a new instance of APIGatewayProxyInputProperty.

Parameters:

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

  The type of endpoint to use for the API Gateway proxy.

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

  The name of the API Gateway stage.

# File 'refactor_spaces/cfn_application.rb', line 648

def initialize(endpoint_type: nil, stage_name: nil)
  @endpoint_type = endpoint_type
  Jsii::Type.check_type(@endpoint_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "endpointType") unless @endpoint_type.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

#endpoint_type ⇒ String^? (readonly)

The type of endpoint to use for the API Gateway proxy.

If no value is specified in the request, the value is set to REGIONAL by default.

If the value is set to PRIVATE in the request, this creates a private API endpoint that is isolated from the public internet. The private endpoint can only be accessed by using Amazon Virtual Private Cloud (Amazon VPC) interface endpoints for the Amazon API Gateway that has been granted access. For more information about creating a private connection with Refactor Spaces and interface endpoint ( AWS PrivateLink ) availability, see Access Refactor Spaces using an interface endpoint ( AWS PrivateLink ) .

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-refactorspaces-application-apigatewayproxyinput.html#cfn-refactorspaces-application-apigatewayproxyinput-endpointtype

# File 'refactor_spaces/cfn_application.rb', line 663

def endpoint_type
  @endpoint_type
end

#stage_name ⇒ String^? (readonly)

The name of the API Gateway stage.

The name defaults to prod .

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-refactorspaces-application-apigatewayproxyinput.html#cfn-refactorspaces-application-apigatewayproxyinput-stagename

# File 'refactor_spaces/cfn_application.rb', line 670

def stage_name
  @stage_name
end

Class Method Details

.jsii_properties ⇒ Object

# File 'refactor_spaces/cfn_application.rb', line 672

def self.jsii_properties
  {
    :endpoint_type => "endpointType",
    :stage_name => "stageName",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'refactor_spaces/cfn_application.rb', line 679

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