Class CfnDomainPropsMixin

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

Inheritance

object

Mixin

CfnDomainPropsMixin

Implements

IMixin

Inherited Members

Mixin.IsMixin(object)

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.Elasticsearch

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public class CfnDomainPropsMixin : Mixin, IMixin

Syntax (vb)

Public Class CfnDomainPropsMixin Inherits Mixin Implements IMixin

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

Mixin: true

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.CfnPropertyMixins.AWS.Elasticsearch;
             using Amazon.CDK;

             var accessPolicies;
             IMergeStrategy mergeStrategy;

             var cfnDomainPropsMixin = new CfnDomainPropsMixin(new CfnDomainMixinProps {
                 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" }
                 }
             }, new CfnPropertyMixinOptions {
                 Strategy = mergeStrategy
             });

Synopsis

Constructors

CfnDomainPropsMixin(ICfnDomainMixinProps, ICfnPropertyMixinOptions?)

Create a mixin to apply properties to AWS::Elasticsearch::Domain.

Properties

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

Methods

ApplyTo(IConstruct)	Apply the mixin properties to the construct.
Supports(IConstruct)	Check if this mixin supports the given construct.

Constructors

CfnDomainPropsMixin(ICfnDomainMixinProps, ICfnPropertyMixinOptions?)

Create a mixin to apply properties to AWS::Elasticsearch::Domain.

public CfnDomainPropsMixin(ICfnDomainMixinProps props, ICfnPropertyMixinOptions? options = null)

Parameters

props ICfnDomainMixinProps

L1 properties to apply.

options ICfnPropertyMixinOptions

Mixin options.

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

Mixin: true

ExampleMetadata: fixture=_generated

Properties

CFN_PROPERTY_KEYS

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

protected static string[] CFN_PROPERTY_KEYS { 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

Mixin: true

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.CfnPropertyMixins.AWS.Elasticsearch;
             using Amazon.CDK;

             var accessPolicies;
             IMergeStrategy mergeStrategy;

             var cfnDomainPropsMixin = new CfnDomainPropsMixin(new CfnDomainMixinProps {
                 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" }
                 }
             }, new CfnPropertyMixinOptions {
                 Strategy = mergeStrategy
             });

Props

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

protected virtual ICfnDomainMixinProps Props { get; }

Property Value

ICfnDomainMixinProps

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

Mixin: true

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.CfnPropertyMixins.AWS.Elasticsearch;
             using Amazon.CDK;

             var accessPolicies;
             IMergeStrategy mergeStrategy;

             var cfnDomainPropsMixin = new CfnDomainPropsMixin(new CfnDomainMixinProps {
                 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" }
                 }
             }, new CfnPropertyMixinOptions {
                 Strategy = mergeStrategy
             });

Strategy

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

protected virtual IMergeStrategy Strategy { get; }

Property Value

IMergeStrategy

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

Mixin: true

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.CfnPropertyMixins.AWS.Elasticsearch;
             using Amazon.CDK;

             var accessPolicies;
             IMergeStrategy mergeStrategy;

             var cfnDomainPropsMixin = new CfnDomainPropsMixin(new CfnDomainMixinProps {
                 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" }
                 }
             }, new CfnPropertyMixinOptions {
                 Strategy = mergeStrategy
             });

Methods

ApplyTo(IConstruct)

Apply the mixin properties to the construct.

public override void ApplyTo(IConstruct construct)

Parameters

construct IConstruct

Overrides

Mixin.ApplyTo(IConstruct)

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

Mixin: true

ExampleMetadata: fixture=_generated

Supports(IConstruct)

Check if this mixin supports the given construct.

public override bool Supports(IConstruct construct)

Parameters

construct IConstruct

Returns

bool

Overrides

Mixin.Supports(IConstruct)

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

Mixin: true

ExampleMetadata: fixture=_generated

Implements

Constructs.IMixin