# 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.

- Source: Generated at build time
- Type last changed: v2.191.0 · 23 Apr 2025

## Example

TypeScript:

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigateway as apigateway } from 'aws-cdk-lib';
const endpointConfigurationProperty: apigateway.CfnDomainNameV2.EndpointConfigurationProperty = {
  ipAddressType: 'ipAddressType',
  types: ['types'],
};
```

Python:

```python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_apigateway as apigateway

endpoint_configuration_property = apigateway.CfnDomainNameV2.EndpointConfigurationProperty(
    ip_address_type="ipAddressType",
    types=["types"]
)
```

Java:

```java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.apigateway.*;

EndpointConfigurationProperty endpointConfigurationProperty = EndpointConfigurationProperty.builder()
        .ipAddressType("ipAddressType")
        .types(List.of("types"))
        .build();
```

C# / .NET:

```csharp
// Install: dotnet add package Amazon.CDK.Lib
// 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" }
};
```

Golang:

```go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

endpointConfigurationProperty := &EndpointConfigurationProperty{
	IpAddressType: jsii.String("ipAddressType"),
	Types: []*string{
		jsii.String("types"),
	},
}
```

## Properties

- `ipAddressType`: string — 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.

- `types`: string[] — 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` .
