Show / Hide Table of Contents

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.OpenSearchService
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDomain.DomainEndpointOptionsProperty : CfnDomain.IDomainEndpointOptionsProperty
Syntax (vb)
Public Class CfnDomain.DomainEndpointOptionsProperty Implements CfnDomain.IDomainEndpointOptionsProperty
Remarks

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

             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 AWS 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. The policy can be one of the following values:.

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

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

             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-opensearchservice-domain-domainendpointoptions.html#cfn-opensearchservice-domain-domainendpointoptions-customendpoint

CustomEndpointCertificateArn

The AWS 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-opensearchservice-domain-domainendpointoptions.html#cfn-opensearchservice-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 .

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

EnforceHttps

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

public object? EnforceHttps { get; set; }
Property Value

object

Remarks

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

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

TlsSecurityPolicy

The minimum TLS version required for traffic to the domain. The policy can be one of the following values:.

public string? TlsSecurityPolicy { get; set; }
Property Value

string

Remarks

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

    Implements

    CfnDomain.IDomainEndpointOptionsProperty
    Back to top Generated by DocFX