Class CfnDomain

The AWS::Elasticsearch::Domain resource creates an Amazon OpenSearch Service domain.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnDomain

Implements

IInspectable

IDomainRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.Elasticsearch

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnDomain : CfnResource, IInspectable, IDomainRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnDomain Inherits CfnResource Implements IInspectable, IDomainRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

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 legacy Elasticsearch. For instructions to upgrade domains defined within CloudFormation from Elasticsearch to OpenSearch, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#aws-resource-opensearchservice-domain--remarks">Remarks</a> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html

CloudformationResource: AWS::Elasticsearch::Domain

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 accessPolicies;

             var cfnDomain = new CfnDomain(this, "MyCfnDomain", new CfnDomainProps {
                 AccessPolicies = accessPolicies,
                 AdvancedOptions = new Dictionary<string, string> {
                     { "advancedOptionsKey", "advancedOptions" }
                 },
                 AdvancedSecurityOptions = new AdvancedSecurityOptionsInputProperty {
                     AnonymousAuthEnabled = false,
                     Enabled = false,
                     InternalUserDatabaseEnabled = false,
                     MasterUserOptions = new MasterUserOptionsProperty {
                         MasterUserArn = "masterUserArn",
                         MasterUserName = "masterUserName",
                         MasterUserPassword = "masterUserPassword"
                     }
                 },
                 CognitoOptions = new CognitoOptionsProperty {
                     Enabled = false,
                     IdentityPoolId = "identityPoolId",
                     RoleArn = "roleArn",
                     UserPoolId = "userPoolId"
                 },
                 DomainArn = "domainArn",
                 DomainEndpointOptions = new DomainEndpointOptionsProperty {
                     CustomEndpoint = "customEndpoint",
                     CustomEndpointCertificateArn = "customEndpointCertificateArn",
                     CustomEndpointEnabled = false,
                     EnforceHttps = false,
                     TlsSecurityPolicy = "tlsSecurityPolicy"
                 },
                 DomainName = "domainName",
                 EbsOptions = new EBSOptionsProperty {
                     EbsEnabled = false,
                     Iops = 123,
                     VolumeSize = 123,
                     VolumeType = "volumeType"
                 },
                 ElasticsearchClusterConfig = new ElasticsearchClusterConfigProperty {
                     ColdStorageOptions = new ColdStorageOptionsProperty {
                         Enabled = false
                     },
                     DedicatedMasterCount = 123,
                     DedicatedMasterEnabled = false,
                     DedicatedMasterType = "dedicatedMasterType",
                     InstanceCount = 123,
                     InstanceType = "instanceType",
                     WarmCount = 123,
                     WarmEnabled = false,
                     WarmType = "warmType",
                     ZoneAwarenessConfig = new ZoneAwarenessConfigProperty {
                         AvailabilityZoneCount = 123
                     },
                     ZoneAwarenessEnabled = false
                 },
                 ElasticsearchVersion = "elasticsearchVersion",
                 EncryptionAtRestOptions = new EncryptionAtRestOptionsProperty {
                     Enabled = false,
                     KmsKeyId = "kmsKeyId"
                 },
                 LogPublishingOptions = new Dictionary<string, object> {
                     { "logPublishingOptionsKey", new LogPublishingOptionProperty {
                         CloudWatchLogsLogGroupArn = "cloudWatchLogsLogGroupArn",
                         Enabled = false
                     } }
                 },
                 NodeToNodeEncryptionOptions = new NodeToNodeEncryptionOptionsProperty {
                     Enabled = false
                 },
                 SnapshotOptions = new SnapshotOptionsProperty {
                     AutomatedSnapshotStartHour = 123
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 VpcOptions = new VPCOptionsProperty {
                     SecurityGroupIds = new [] { "securityGroupIds" },
                     SubnetIds = new [] { "subnetIds" }
                 }
             });

Synopsis

Constructors

CfnDomain(Construct, string, ICfnDomainProps?)

Create a new AWS::Elasticsearch::Domain.

Properties

AccessPolicies	An AWS Identity and Access Management ( IAM ) policy document that specifies who can access the OpenSearch Service domain and their permissions.
AdvancedOptions	Additional options to specify for the OpenSearch Service domain.
AdvancedSecurityOptions	Specifies options for fine-grained access control.
AttrArn	The Amazon Resource Name (ARN) of the domain, such as arn:aws:es:us-west-2:123456789012:domain/mystack-elasti-1ab2cdefghij .
AttrDomainEndpoint	The domain-specific endpoint that's used for requests to the OpenSearch APIs, such as search-mystack-elasti-1ab2cdefghij-ab1c2deckoyb3hofw7wpqa3cm.us-west-1.es.amazonaws.com .
AttrId	The AWS::Elasticsearch::Domain resource creates an Amazon OpenSearch Service domain.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	The AWS::Elasticsearch::Domain resource creates an Amazon OpenSearch Service domain.
CognitoOptions	Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.
DomainArn	The AWS::Elasticsearch::Domain resource creates an Amazon OpenSearch Service domain.
DomainEndpointOptions	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.
DomainName	A name for the OpenSearch Service domain.
DomainRef	A reference to a Domain resource.
EbsOptions	The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain.
ElasticsearchClusterConfig	ElasticsearchClusterConfig is a property of the AWS::Elasticsearch::Domain resource that configures the cluster of an Amazon OpenSearch Service domain.
ElasticsearchVersion	The version of Elasticsearch to use, such as 2.3. If not specified, 1.5 is used as the default. For information about the versions that OpenSearch Service supports, see Supported versions of OpenSearch and Elasticsearch in the Amazon OpenSearch Service Developer Guide .
EncryptionAtRestOptions	Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service key to use.
LogPublishingOptions	An object with one or more of the following keys: SEARCH_SLOW_LOGS , ES_APPLICATION_LOGS , INDEX_SLOW_LOGS , AUDIT_LOGS , depending on the types of logs you want to publish.
NodeToNodeEncryptionOptions	Specifies whether node-to-node encryption is enabled.
SnapshotOptions	DEPRECATED .
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Service domain.
VpcOptions	The virtual private cloud (VPC) configuration for the OpenSearch Service domain.

Methods

ArnForDomain(IDomainRef)	The AWS::Elasticsearch::Domain resource creates an Amazon OpenSearch Service domain.
FromDomainArn(Construct, string, string)	Creates a new IDomainRef from an ARN.
FromDomainName(Construct, string, string)	Creates a new IDomainRef from a domainName.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnDomain(object)	Checks whether the given object is a CfnDomain.
RenderProperties(IDictionary<string, object>)	The AWS::Elasticsearch::Domain resource creates an Amazon OpenSearch Service domain.

Constructors

CfnDomain(Construct, string, ICfnDomainProps?)

Create a new AWS::Elasticsearch::Domain.

public CfnDomain(Construct scope, string id, ICfnDomainProps? props = null)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnDomainProps

Resource properties.

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 legacy Elasticsearch. For instructions to upgrade domains defined within CloudFormation from Elasticsearch to OpenSearch, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#aws-resource-opensearchservice-domain--remarks">Remarks</a> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html

CloudformationResource: AWS::Elasticsearch::Domain

ExampleMetadata: fixture=_generated

Properties

AccessPolicies

An AWS Identity and Access Management ( IAM ) policy document that specifies who can access the OpenSearch Service domain and their permissions.

public virtual object? AccessPolicies { get; set; }

Property Value

object

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 legacy Elasticsearch. For instructions to upgrade domains defined within CloudFormation from Elasticsearch to OpenSearch, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#aws-resource-opensearchservice-domain--remarks">Remarks</a> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html

CloudformationResource: AWS::Elasticsearch::Domain

ExampleMetadata: fixture=_generated

AdvancedOptions

Additional options to specify for the OpenSearch Service domain.

public virtual object? AdvancedOptions { get; set; }

Property Value

object

Remarks

Type union: either Dictionary<string, string> or IResolvable

AdvancedSecurityOptions

Specifies options for fine-grained access control.

public virtual object? AdvancedSecurityOptions { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnDomain.IAdvancedSecurityOptionsInputProperty

AttrArn

The Amazon Resource Name (ARN) of the domain, such as arn:aws:es:us-west-2:123456789012:domain/mystack-elasti-1ab2cdefghij .

public virtual string AttrArn { get; }

Property Value

string

Remarks

This returned value is the same as the one returned by AWS::Elasticsearch::Domain.DomainArn .

CloudformationAttribute: Arn

AttrDomainEndpoint

The domain-specific endpoint that's used for requests to the OpenSearch APIs, such as search-mystack-elasti-1ab2cdefghij-ab1c2deckoyb3hofw7wpqa3cm.us-west-1.es.amazonaws.com .

public virtual string AttrDomainEndpoint { get; }

Property Value

string

Remarks

CloudformationAttribute: DomainEndpoint

AttrId

The AWS::Elasticsearch::Domain resource creates an Amazon OpenSearch Service domain.

public virtual string AttrId { get; }

Property Value

string

Remarks

CloudformationAttribute: Id

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

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 legacy Elasticsearch. For instructions to upgrade domains defined within CloudFormation from Elasticsearch to OpenSearch, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#aws-resource-opensearchservice-domain--remarks">Remarks</a> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html

CloudformationResource: AWS::Elasticsearch::Domain

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::Elasticsearch::Domain resource creates an Amazon OpenSearch Service domain.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

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 legacy Elasticsearch. For instructions to upgrade domains defined within CloudFormation from Elasticsearch to OpenSearch, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#aws-resource-opensearchservice-domain--remarks">Remarks</a> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html

CloudformationResource: AWS::Elasticsearch::Domain

ExampleMetadata: fixture=_generated

CognitoOptions

Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.

public virtual object? CognitoOptions { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnDomain.ICognitoOptionsProperty

DomainArn

The AWS::Elasticsearch::Domain resource creates an Amazon OpenSearch Service domain.

public virtual string? DomainArn { get; set; }

Property Value

string

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 legacy Elasticsearch. For instructions to upgrade domains defined within CloudFormation from Elasticsearch to OpenSearch, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#aws-resource-opensearchservice-domain--remarks">Remarks</a> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html

CloudformationResource: AWS::Elasticsearch::Domain

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 accessPolicies;

             var cfnDomain = new CfnDomain(this, "MyCfnDomain", new CfnDomainProps {
                 AccessPolicies = accessPolicies,
                 AdvancedOptions = new Dictionary<string, string> {
                     { "advancedOptionsKey", "advancedOptions" }
                 },
                 AdvancedSecurityOptions = new AdvancedSecurityOptionsInputProperty {
                     AnonymousAuthEnabled = false,
                     Enabled = false,
                     InternalUserDatabaseEnabled = false,
                     MasterUserOptions = new MasterUserOptionsProperty {
                         MasterUserArn = "masterUserArn",
                         MasterUserName = "masterUserName",
                         MasterUserPassword = "masterUserPassword"
                     }
                 },
                 CognitoOptions = new CognitoOptionsProperty {
                     Enabled = false,
                     IdentityPoolId = "identityPoolId",
                     RoleArn = "roleArn",
                     UserPoolId = "userPoolId"
                 },
                 DomainArn = "domainArn",
                 DomainEndpointOptions = new DomainEndpointOptionsProperty {
                     CustomEndpoint = "customEndpoint",
                     CustomEndpointCertificateArn = "customEndpointCertificateArn",
                     CustomEndpointEnabled = false,
                     EnforceHttps = false,
                     TlsSecurityPolicy = "tlsSecurityPolicy"
                 },
                 DomainName = "domainName",
                 EbsOptions = new EBSOptionsProperty {
                     EbsEnabled = false,
                     Iops = 123,
                     VolumeSize = 123,
                     VolumeType = "volumeType"
                 },
                 ElasticsearchClusterConfig = new ElasticsearchClusterConfigProperty {
                     ColdStorageOptions = new ColdStorageOptionsProperty {
                         Enabled = false
                     },
                     DedicatedMasterCount = 123,
                     DedicatedMasterEnabled = false,
                     DedicatedMasterType = "dedicatedMasterType",
                     InstanceCount = 123,
                     InstanceType = "instanceType",
                     WarmCount = 123,
                     WarmEnabled = false,
                     WarmType = "warmType",
                     ZoneAwarenessConfig = new ZoneAwarenessConfigProperty {
                         AvailabilityZoneCount = 123
                     },
                     ZoneAwarenessEnabled = false
                 },
                 ElasticsearchVersion = "elasticsearchVersion",
                 EncryptionAtRestOptions = new EncryptionAtRestOptionsProperty {
                     Enabled = false,
                     KmsKeyId = "kmsKeyId"
                 },
                 LogPublishingOptions = new Dictionary<string, object> {
                     { "logPublishingOptionsKey", new LogPublishingOptionProperty {
                         CloudWatchLogsLogGroupArn = "cloudWatchLogsLogGroupArn",
                         Enabled = false
                     } }
                 },
                 NodeToNodeEncryptionOptions = new NodeToNodeEncryptionOptionsProperty {
                     Enabled = false
                 },
                 SnapshotOptions = new SnapshotOptionsProperty {
                     AutomatedSnapshotStartHour = 123
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 VpcOptions = new VPCOptionsProperty {
                     SecurityGroupIds = new [] { "securityGroupIds" },
                     SubnetIds = new [] { "subnetIds" }
                 }
             });

DomainEndpointOptions

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 virtual object? DomainEndpointOptions { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnDomain.IDomainEndpointOptionsProperty

DomainName

A name for the OpenSearch Service domain.

public virtual string? DomainName { get; set; }

Property Value

string

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 legacy Elasticsearch. For instructions to upgrade domains defined within CloudFormation from Elasticsearch to OpenSearch, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#aws-resource-opensearchservice-domain--remarks">Remarks</a> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html

CloudformationResource: AWS::Elasticsearch::Domain

ExampleMetadata: fixture=_generated

DomainRef

A reference to a Domain resource.

public virtual IDomainReference DomainRef { get; }

Property Value

IDomainReference

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 legacy Elasticsearch. For instructions to upgrade domains defined within CloudFormation from Elasticsearch to OpenSearch, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#aws-resource-opensearchservice-domain--remarks">Remarks</a> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html

CloudformationResource: AWS::Elasticsearch::Domain

ExampleMetadata: fixture=_generated

EbsOptions

The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain.

public virtual object? EbsOptions { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnDomain.IEBSOptionsProperty

ElasticsearchClusterConfig

ElasticsearchClusterConfig is a property of the AWS::Elasticsearch::Domain resource that configures the cluster of an Amazon OpenSearch Service domain.

public virtual object? ElasticsearchClusterConfig { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnDomain.IElasticsearchClusterConfigProperty

ElasticsearchVersion

The version of Elasticsearch to use, such as 2.3. If not specified, 1.5 is used as the default. For information about the versions that OpenSearch Service supports, see Supported versions of OpenSearch and Elasticsearch in the Amazon OpenSearch Service Developer Guide .

public virtual string? ElasticsearchVersion { get; set; }

Property Value

string

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 legacy Elasticsearch. For instructions to upgrade domains defined within CloudFormation from Elasticsearch to OpenSearch, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#aws-resource-opensearchservice-domain--remarks">Remarks</a> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html

CloudformationResource: AWS::Elasticsearch::Domain

ExampleMetadata: fixture=_generated

EncryptionAtRestOptions

Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service key to use.

public virtual object? EncryptionAtRestOptions { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnDomain.IEncryptionAtRestOptionsProperty

LogPublishingOptions

An object with one or more of the following keys: SEARCH_SLOW_LOGS , ES_APPLICATION_LOGS , INDEX_SLOW_LOGS , AUDIT_LOGS , depending on the types of logs you want to publish.

public virtual object? LogPublishingOptions { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or Dictionary<string, either IResolvable or CfnDomain.ILogPublishingOptionProperty>

NodeToNodeEncryptionOptions

Specifies whether node-to-node encryption is enabled.

public virtual object? NodeToNodeEncryptionOptions { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnDomain.INodeToNodeEncryptionOptionsProperty

SnapshotOptions

DEPRECATED .

public virtual object? SnapshotOptions { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnDomain.ISnapshotOptionsProperty

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

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 legacy Elasticsearch. For instructions to upgrade domains defined within CloudFormation from Elasticsearch to OpenSearch, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#aws-resource-opensearchservice-domain--remarks">Remarks</a> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html

CloudformationResource: AWS::Elasticsearch::Domain

ExampleMetadata: fixture=_generated

TagsRaw

An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Service domain.

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

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 legacy Elasticsearch. For instructions to upgrade domains defined within CloudFormation from Elasticsearch to OpenSearch, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#aws-resource-opensearchservice-domain--remarks">Remarks</a> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html

CloudformationResource: AWS::Elasticsearch::Domain

ExampleMetadata: fixture=_generated

VpcOptions

The virtual private cloud (VPC) configuration for the OpenSearch Service domain.

public virtual object? VpcOptions { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnDomain.IVPCOptionsProperty

Methods

ArnForDomain(IDomainRef)

The AWS::Elasticsearch::Domain resource creates an Amazon OpenSearch Service domain.

public static string ArnForDomain(IDomainRef resource)

Parameters

resource IDomainRef

Returns

string

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 legacy Elasticsearch. For instructions to upgrade domains defined within CloudFormation from Elasticsearch to OpenSearch, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#aws-resource-opensearchservice-domain--remarks">Remarks</a> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html

CloudformationResource: AWS::Elasticsearch::Domain

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 accessPolicies;

             var cfnDomain = new CfnDomain(this, "MyCfnDomain", new CfnDomainProps {
                 AccessPolicies = accessPolicies,
                 AdvancedOptions = new Dictionary<string, string> {
                     { "advancedOptionsKey", "advancedOptions" }
                 },
                 AdvancedSecurityOptions = new AdvancedSecurityOptionsInputProperty {
                     AnonymousAuthEnabled = false,
                     Enabled = false,
                     InternalUserDatabaseEnabled = false,
                     MasterUserOptions = new MasterUserOptionsProperty {
                         MasterUserArn = "masterUserArn",
                         MasterUserName = "masterUserName",
                         MasterUserPassword = "masterUserPassword"
                     }
                 },
                 CognitoOptions = new CognitoOptionsProperty {
                     Enabled = false,
                     IdentityPoolId = "identityPoolId",
                     RoleArn = "roleArn",
                     UserPoolId = "userPoolId"
                 },
                 DomainArn = "domainArn",
                 DomainEndpointOptions = new DomainEndpointOptionsProperty {
                     CustomEndpoint = "customEndpoint",
                     CustomEndpointCertificateArn = "customEndpointCertificateArn",
                     CustomEndpointEnabled = false,
                     EnforceHttps = false,
                     TlsSecurityPolicy = "tlsSecurityPolicy"
                 },
                 DomainName = "domainName",
                 EbsOptions = new EBSOptionsProperty {
                     EbsEnabled = false,
                     Iops = 123,
                     VolumeSize = 123,
                     VolumeType = "volumeType"
                 },
                 ElasticsearchClusterConfig = new ElasticsearchClusterConfigProperty {
                     ColdStorageOptions = new ColdStorageOptionsProperty {
                         Enabled = false
                     },
                     DedicatedMasterCount = 123,
                     DedicatedMasterEnabled = false,
                     DedicatedMasterType = "dedicatedMasterType",
                     InstanceCount = 123,
                     InstanceType = "instanceType",
                     WarmCount = 123,
                     WarmEnabled = false,
                     WarmType = "warmType",
                     ZoneAwarenessConfig = new ZoneAwarenessConfigProperty {
                         AvailabilityZoneCount = 123
                     },
                     ZoneAwarenessEnabled = false
                 },
                 ElasticsearchVersion = "elasticsearchVersion",
                 EncryptionAtRestOptions = new EncryptionAtRestOptionsProperty {
                     Enabled = false,
                     KmsKeyId = "kmsKeyId"
                 },
                 LogPublishingOptions = new Dictionary<string, object> {
                     { "logPublishingOptionsKey", new LogPublishingOptionProperty {
                         CloudWatchLogsLogGroupArn = "cloudWatchLogsLogGroupArn",
                         Enabled = false
                     } }
                 },
                 NodeToNodeEncryptionOptions = new NodeToNodeEncryptionOptionsProperty {
                     Enabled = false
                 },
                 SnapshotOptions = new SnapshotOptionsProperty {
                     AutomatedSnapshotStartHour = 123
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 VpcOptions = new VPCOptionsProperty {
                     SecurityGroupIds = new [] { "securityGroupIds" },
                     SubnetIds = new [] { "subnetIds" }
                 }
             });

FromDomainArn(Construct, string, string)

Creates a new IDomainRef from an ARN.

public static IDomainRef FromDomainArn(Construct scope, string id, string arn)

Parameters

scope Construct

id string

arn string

Returns

IDomainRef

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 legacy Elasticsearch. For instructions to upgrade domains defined within CloudFormation from Elasticsearch to OpenSearch, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#aws-resource-opensearchservice-domain--remarks">Remarks</a> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html

CloudformationResource: AWS::Elasticsearch::Domain

ExampleMetadata: fixture=_generated

FromDomainName(Construct, string, string)

Creates a new IDomainRef from a domainName.

public static IDomainRef FromDomainName(Construct scope, string id, string domainName)

Parameters

scope Construct

id string

domainName string

Returns

IDomainRef

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 legacy Elasticsearch. For instructions to upgrade domains defined within CloudFormation from Elasticsearch to OpenSearch, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#aws-resource-opensearchservice-domain--remarks">Remarks</a> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html

CloudformationResource: AWS::Elasticsearch::Domain

ExampleMetadata: fixture=_generated

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

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 legacy Elasticsearch. For instructions to upgrade domains defined within CloudFormation from Elasticsearch to OpenSearch, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#aws-resource-opensearchservice-domain--remarks">Remarks</a> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html

CloudformationResource: AWS::Elasticsearch::Domain

ExampleMetadata: fixture=_generated

IsCfnDomain(object)

Checks whether the given object is a CfnDomain.

public static bool IsCfnDomain(object x)

Parameters

x object

Returns

bool

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 legacy Elasticsearch. For instructions to upgrade domains defined within CloudFormation from Elasticsearch to OpenSearch, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#aws-resource-opensearchservice-domain--remarks">Remarks</a> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html

CloudformationResource: AWS::Elasticsearch::Domain

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS::Elasticsearch::Domain resource creates an Amazon OpenSearch Service domain.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

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 legacy Elasticsearch. For instructions to upgrade domains defined within CloudFormation from Elasticsearch to OpenSearch, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#aws-resource-opensearchservice-domain--remarks">Remarks</a> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html

CloudformationResource: AWS::Elasticsearch::Domain

ExampleMetadata: fixture=_generated

Implements

IInspectable

IDomainRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable