Class: AWSCDK::APIGateway::CfnDomainNameV2::EndpointConfigurationProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::APIGateway::CfnDomainNameV2::EndpointConfigurationProperty

Defined in:

api_gateway/cfn_domain_name_v2.rb

Overview

The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has and the IP address types that can invoke it.

See Also:

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

Instance Attribute Summary

• #ip_address_type ⇒ String^? readonly

  The IP address types that can invoke an API (RestApi) or a DomainName.

• #types ⇒ Array<String>^? readonly

  A list of endpoint types of an API (RestApi) or its custom domain name (DomainName).

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(ip_address_type: nil, types: nil) ⇒ EndpointConfigurationProperty constructor

  A new instance of EndpointConfigurationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(ip_address_type: nil, types: nil) ⇒ EndpointConfigurationProperty

Returns a new instance of EndpointConfigurationProperty.

Parameters:

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

  The IP address types that can invoke an API (RestApi) or a DomainName.

• types (Array<String>, nil) (defaults to: nil) —

  A list of endpoint types of an API (RestApi) or its custom domain name (DomainName).

# File 'api_gateway/cfn_domain_name_v2.rb', line 613

def initialize(ip_address_type: nil, types: nil)
  @ip_address_type = ip_address_type
  Jsii::Type.check_type(@ip_address_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "ipAddressType") unless @ip_address_type.nil?
  @types = types
  Jsii::Type.check_type(@types, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "types") unless @types.nil?
end

Instance Attribute Details

#ip_address_type ⇒ String^? (readonly)

The IP address types that can invoke an API (RestApi) or a DomainName.

Use ipv4 to allow only IPv4 addresses to invoke an API or DomainName, or use dualstack to allow both IPv4 and IPv6 addresses to invoke an API or a DomainName. For the PRIVATE endpoint type, only dualstack is supported.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainnamev2-endpointconfiguration.html#cfn-apigateway-domainnamev2-endpointconfiguration-ipaddresstype

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

def ip_address_type
  @ip_address_type
end

#types ⇒ Array<String>^? (readonly)

A list of endpoint types of an API (RestApi) or its custom domain name (DomainName).

For an edge-optimized API and its custom domain name, the endpoint type is "EDGE" . For a regional API and its custom domain name, the endpoint type is REGIONAL . For a private API, the endpoint type is PRIVATE .

Returns:

• (Array<String>, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainnamev2-endpointconfiguration.html#cfn-apigateway-domainnamev2-endpointconfiguration-types

# File 'api_gateway/cfn_domain_name_v2.rb', line 633

def types
  @types
end

Class Method Details

.jsii_properties ⇒ Object

# File 'api_gateway/cfn_domain_name_v2.rb', line 635

def self.jsii_properties
  {
    :ip_address_type => "ipAddressType",
    :types => "types",
  }
end

Instance Method Details

#to_jsii ⇒ Object

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

def to_jsii
  result = {}
  result.merge!({
    "ipAddressType" => @ip_address_type,
    "types" => @types,
  })
  result.compact
end