1.204.0

interface DomainEndpointOptionsProperty

LanguageType name
.NETAmazon.CDK.AWS.OpenSearchService.CfnDomain.DomainEndpointOptionsProperty
Javasoftware.amazon.awscdk.services.opensearchservice.CfnDomain.DomainEndpointOptionsProperty
Pythonaws_cdk.aws_opensearchservice.CfnDomain.DomainEndpointOptionsProperty
TypeScript @aws-cdk/aws-opensearchservice » CfnDomain » DomainEndpointOptionsProperty

Specifies additional options for the domain endpoint, such as whether to require HTTPS for all traffic or whether to use a custom endpoint rather than the default endpoint.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as opensearchservice from '@aws-cdk/aws-opensearchservice';
const domainEndpointOptionsProperty: opensearchservice.CfnDomain.DomainEndpointOptionsProperty = {
  customEndpoint: 'customEndpoint',
  customEndpointCertificateArn: 'customEndpointCertificateArn',
  customEndpointEnabled: false,
  enforceHttps: false,
  tlsSecurityPolicy: 'tlsSecurityPolicy',
};

Properties

NameTypeDescription
customEndpoint?stringThe fully qualified URL for your custom endpoint.
customEndpointCertificateArn?stringThe AWS Certificate Manager ARN for your domain's SSL/TLS certificate.
customEndpointEnabled?boolean | IResolvableTrue to enable a custom endpoint for the domain.
enforceHttps?boolean | IResolvableTrue to require that all traffic to the domain arrive over HTTPS.
tlsSecurityPolicy?stringThe minimum TLS version required for traffic to the domain. Valid values are TLS 1.0 (default) or 1.2:.

customEndpoint?

Type: string (optional)

The fully qualified URL for your custom endpoint.

Required if you enabled a custom endpoint for the domain.

customEndpointCertificateArn?

Type: string (optional)

The AWS Certificate Manager ARN for your domain's SSL/TLS certificate.

Required if you enabled a custom endpoint for the domain.

customEndpointEnabled?

Type: boolean | IResolvable (optional)

True to enable a custom endpoint for the domain.

If enabled, you must also provide values for CustomEndpoint and CustomEndpointCertificateArn .

enforceHttps?

Type: boolean | IResolvable (optional)

True to require that all traffic to the domain arrive over HTTPS.

Required if you enable fine-grained access control in AdvancedSecurityOptions .

tlsSecurityPolicy?

Type: string (optional)

The minimum TLS version required for traffic to the domain. Valid values are TLS 1.0 (default) or 1.2:.

  • Policy-Min-TLS-1-0-2019-07
  • Policy-Min-TLS-1-2-2019-07
← PreviousNext →