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

Inheritance

object

CfnDomain.DomainEndpointOptionsProperty

Implements

CfnDomain.IDomainEndpointOptionsProperty

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

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnDomain.DomainEndpointOptionsProperty : CfnDomain.IDomainEndpointOptionsProperty

Syntax (vb)

Public Class CfnDomain.DomainEndpointOptionsProperty Implements CfnDomain.IDomainEndpointOptionsProperty

Remarks

The <code>AWS::Elasticsearch::Domain</code> resource is being replaced by the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html">AWS::OpenSearchService::Domain</a> resource. While the legacy Elasticsearch resource and options are still supported, we recommend modifying your existing Cloudformation templates to use the new OpenSearch Service resource, which supports both OpenSearch and Elasticsearch. For more information about the service rename, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/rename.html#rename-resource">New resource types</a> in the <em>Amazon OpenSearch Service Developer Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-domainendpointoptions.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.Elasticsearch;

             var domainEndpointOptionsProperty = new DomainEndpointOptionsProperty {
                 CustomEndpoint = "customEndpoint",
                 CustomEndpointCertificateArn = "customEndpointCertificateArn",
                 CustomEndpointEnabled = false,
                 EnforceHttps = false,
                 TlsSecurityPolicy = "tlsSecurityPolicy"
             };

Synopsis

Constructors

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.

Properties

CustomEndpoint	The fully qualified URL for your custom endpoint.
CustomEndpointCertificateArn	The Certificate Manager ARN for your domain's SSL/TLS certificate.
CustomEndpointEnabled	True to enable a custom endpoint for the domain.
EnforceHttps	True to require that all traffic to the domain arrive over HTTPS.
TlsSecurityPolicy	The minimum TLS version required for traffic to the domain. Valid values are TLS 1.3 (recommended) or 1.2:.

Constructors

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.

public DomainEndpointOptionsProperty()

Remarks

The <code>AWS::Elasticsearch::Domain</code> resource is being replaced by the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html">AWS::OpenSearchService::Domain</a> resource. While the legacy Elasticsearch resource and options are still supported, we recommend modifying your existing Cloudformation templates to use the new OpenSearch Service resource, which supports both OpenSearch and Elasticsearch. For more information about the service rename, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/rename.html#rename-resource">New resource types</a> in the <em>Amazon OpenSearch Service Developer Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-domainendpointoptions.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.Elasticsearch;

             var domainEndpointOptionsProperty = new DomainEndpointOptionsProperty {
                 CustomEndpoint = "customEndpoint",
                 CustomEndpointCertificateArn = "customEndpointCertificateArn",
                 CustomEndpointEnabled = false,
                 EnforceHttps = false,
                 TlsSecurityPolicy = "tlsSecurityPolicy"
             };

Properties

CustomEndpoint

The fully qualified URL for your custom endpoint.

public string? CustomEndpoint { get; set; }

Property Value

string

Remarks

Required if you enabled a custom endpoint for the domain.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-domainendpointoptions.html#cfn-elasticsearch-domain-domainendpointoptions-customendpoint

CustomEndpointCertificateArn

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

public string? CustomEndpointCertificateArn { get; set; }

Property Value

string

Remarks

Required if you enabled a custom endpoint for the domain.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-domainendpointoptions.html#cfn-elasticsearch-domain-domainendpointoptions-customendpointcertificatearn

CustomEndpointEnabled

True to enable a custom endpoint for the domain.

public object? CustomEndpointEnabled { get; set; }

Property Value

object

Remarks

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

Type union: either bool or IResolvable

EnforceHttps

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

public object? EnforceHttps { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-domainendpointoptions.html#cfn-elasticsearch-domain-domainendpointoptions-enforcehttps

Type union: either bool or IResolvable

TlsSecurityPolicy

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

public string? TlsSecurityPolicy { get; set; }