Class CfnDomainName.EndpointConfigurationProperty

The EndpointConfiguration property type specifies the endpoint types and IP address types of an Amazon API Gateway domain name.

Inheritance

object

CfnDomainName.EndpointConfigurationProperty

Implements

CfnDomainName.IEndpointConfigurationProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.APIGateway

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnDomainName.EndpointConfigurationProperty : CfnDomainName.IEndpointConfigurationProperty

Syntax (vb)

Public Class CfnDomainName.EndpointConfigurationProperty Implements CfnDomainName.IEndpointConfigurationProperty

Remarks

EndpointConfiguration is a property of the AWS::ApiGateway::DomainName resource.

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.APIGateway;

             var endpointConfigurationProperty = new EndpointConfigurationProperty {
                 IpAddressType = "ipAddressType",
                 Types = new [] { "types" }
             };

Synopsis

Constructors

EndpointConfigurationProperty()

The EndpointConfiguration property type specifies the endpoint types and IP address types of an Amazon API Gateway domain name.

Properties

IpAddressType	The IP address types that can invoke this DomainName.
Types	A list of endpoint types of an API (RestApi) or its custom domain name (DomainName).

Constructors

EndpointConfigurationProperty()

The EndpointConfiguration property type specifies the endpoint types and IP address types of an Amazon API Gateway domain name.

public EndpointConfigurationProperty()

Remarks

EndpointConfiguration is a property of the AWS::ApiGateway::DomainName resource.

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.APIGateway;

             var endpointConfigurationProperty = new EndpointConfigurationProperty {
                 IpAddressType = "ipAddressType",
                 Types = new [] { "types" }
             };

Properties

IpAddressType

The IP address types that can invoke this DomainName.

public string? IpAddressType { get; set; }

Property Value

string

Remarks

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

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

Types

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

public string[]? Types { get; set; }

Property Value

string[]

Remarks

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 .

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

Implements

CfnDomainName.IEndpointConfigurationProperty