Class CfnDomainNameV2.EndpointConfigurationProperty

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.

Inheritance

object

CfnDomainNameV2.EndpointConfigurationProperty

Implements

CfnDomainNameV2.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 CfnDomainNameV2.EndpointConfigurationProperty : CfnDomainNameV2.IEndpointConfigurationProperty

Syntax (vb)

Public Class CfnDomainNameV2.EndpointConfigurationProperty Implements CfnDomainNameV2.IEndpointConfigurationProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainnamev2-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 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.

Properties

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

Constructors

EndpointConfigurationProperty()

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.

public EndpointConfigurationProperty()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainnamev2-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 an API (RestApi) or a DomainName.

public string? IpAddressType { get; set; }

Property Value

string

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainnamev2-endpointconfiguration.html#cfn-apigateway-domainnamev2-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-domainnamev2-endpointconfiguration.html#cfn-apigateway-domainnamev2-endpointconfiguration-types

Implements

CfnDomainNameV2.IEndpointConfigurationProperty