AWS CDK Reference

Appearance

v2.274.0

CfnDomain L1 construct ​

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

The AWS::Elasticsearch::Domain resource is being replaced by the AWS::OpenSearchService::Domain 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 Remarks .

CloudFormation
AWS::Elasticsearch::Domain
Source
Generated code
Type last changed
v2.252.0 · 30 Apr 2026

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_elasticsearch as elasticsearch } from 'aws-cdk-lib';

declare const accessPolicies: any;
const cfnDomain = new elasticsearch.CfnDomain(this, 'MyCfnDomain', /* all optional props */ {
  accessPolicies: accessPolicies,
  advancedOptions: {
    advancedOptionsKey: 'advancedOptions',
  },
  advancedSecurityOptions: {
    anonymousAuthEnabled: false,
    enabled: false,
    internalUserDatabaseEnabled: false,
    masterUserOptions: {
      masterUserArn: 'masterUserArn',
      masterUserName: 'masterUserName',
      masterUserPassword: 'masterUserPassword',
    },
  },
  cognitoOptions: {
    enabled: false,
    identityPoolId: 'identityPoolId',
    roleArn: 'roleArn',
    userPoolId: 'userPoolId',
  },
  domainArn: 'domainArn',
  domainEndpointOptions: {
    customEndpoint: 'customEndpoint',
    customEndpointCertificateArn: 'customEndpointCertificateArn',
    customEndpointEnabled: false,
    enforceHttps: false,
    tlsSecurityPolicy: 'tlsSecurityPolicy',
  },
  domainName: 'domainName',
  ebsOptions: {
    ebsEnabled: false,
    iops: 123,
    volumeSize: 123,
    volumeType: 'volumeType',
  },
  elasticsearchClusterConfig: {
    coldStorageOptions: {
      enabled: false,
    },
    dedicatedMasterCount: 123,
    dedicatedMasterEnabled: false,
    dedicatedMasterType: 'dedicatedMasterType',
    instanceCount: 123,
    instanceType: 'instanceType',
    warmCount: 123,
    warmEnabled: false,
    warmType: 'warmType',
    zoneAwarenessConfig: {
      availabilityZoneCount: 123,
    },
    zoneAwarenessEnabled: false,
  },
  elasticsearchVersion: 'elasticsearchVersion',
  encryptionAtRestOptions: {
    enabled: false,
    kmsKeyId: 'kmsKeyId',
  },
  logPublishingOptions: {
    logPublishingOptionsKey: {
      cloudWatchLogsLogGroupArn: 'cloudWatchLogsLogGroupArn',
      enabled: false,
    },
  },
  nodeToNodeEncryptionOptions: {
    enabled: false,
  },
  snapshotOptions: {
    automatedSnapshotStartHour: 123,
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  vpcOptions: {
    securityGroupIds: ['securityGroupIds'],
    subnetIds: ['subnetIds'],
  },
});
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_elasticsearch as elasticsearch

# access_policies: Any

cfn_domain = elasticsearch.CfnDomain(self, "MyCfnDomain",
    access_policies=access_policies,
    advanced_options={
        "advanced_options_key": "advancedOptions"
    },
    advanced_security_options=elasticsearch.CfnDomain.AdvancedSecurityOptionsInputProperty(
        anonymous_auth_enabled=False,
        enabled=False,
        internal_user_database_enabled=False,
        master_user_options=elasticsearch.CfnDomain.MasterUserOptionsProperty(
            master_user_arn="masterUserArn",
            master_user_name="masterUserName",
            master_user_password="masterUserPassword"
        )
    ),
    cognito_options=elasticsearch.CfnDomain.CognitoOptionsProperty(
        enabled=False,
        identity_pool_id="identityPoolId",
        role_arn="roleArn",
        user_pool_id="userPoolId"
    ),
    domain_arn="domainArn",
    domain_endpoint_options=elasticsearch.CfnDomain.DomainEndpointOptionsProperty(
        custom_endpoint="customEndpoint",
        custom_endpoint_certificate_arn="customEndpointCertificateArn",
        custom_endpoint_enabled=False,
        enforce_https=False,
        tls_security_policy="tlsSecurityPolicy"
    ),
    domain_name="domainName",
    ebs_options=elasticsearch.CfnDomain.EBSOptionsProperty(
        ebs_enabled=False,
        iops=123,
        volume_size=123,
        volume_type="volumeType"
    ),
    elasticsearch_cluster_config=elasticsearch.CfnDomain.ElasticsearchClusterConfigProperty(
        cold_storage_options=elasticsearch.CfnDomain.ColdStorageOptionsProperty(
            enabled=False
        ),
        dedicated_master_count=123,
        dedicated_master_enabled=False,
        dedicated_master_type="dedicatedMasterType",
        instance_count=123,
        instance_type="instanceType",
        warm_count=123,
        warm_enabled=False,
        warm_type="warmType",
        zone_awareness_config=elasticsearch.CfnDomain.ZoneAwarenessConfigProperty(
            availability_zone_count=123
        ),
        zone_awareness_enabled=False
    ),
    elasticsearch_version="elasticsearchVersion",
    encryption_at_rest_options=elasticsearch.CfnDomain.EncryptionAtRestOptionsProperty(
        enabled=False,
        kms_key_id="kmsKeyId"
    ),
    log_publishing_options={
        "log_publishing_options_key": elasticsearch.CfnDomain.LogPublishingOptionProperty(
            cloud_watch_logs_log_group_arn="cloudWatchLogsLogGroupArn",
            enabled=False
        )
    },
    node_to_node_encryption_options=elasticsearch.CfnDomain.NodeToNodeEncryptionOptionsProperty(
        enabled=False
    ),
    snapshot_options=elasticsearch.CfnDomain.SnapshotOptionsProperty(
        automated_snapshot_start_hour=123
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    vpc_options=elasticsearch.CfnDomain.VPCOptionsProperty(
        security_group_ids=["securityGroupIds"],
        subnet_ids=["subnetIds"]
    )
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.elasticsearch.*;

Object accessPolicies;

CfnDomain cfnDomain = CfnDomain.Builder.create(this, "MyCfnDomain")
        .accessPolicies(accessPolicies)
        .advancedOptions(Map.of(
                "advancedOptionsKey", "advancedOptions"))
        .advancedSecurityOptions(AdvancedSecurityOptionsInputProperty.builder()
                .anonymousAuthEnabled(false)
                .enabled(false)
                .internalUserDatabaseEnabled(false)
                .masterUserOptions(MasterUserOptionsProperty.builder()
                        .masterUserArn("masterUserArn")
                        .masterUserName("masterUserName")
                        .masterUserPassword("masterUserPassword")
                        .build())
                .build())
        .cognitoOptions(CognitoOptionsProperty.builder()
                .enabled(false)
                .identityPoolId("identityPoolId")
                .roleArn("roleArn")
                .userPoolId("userPoolId")
                .build())
        .domainArn("domainArn")
        .domainEndpointOptions(DomainEndpointOptionsProperty.builder()
                .customEndpoint("customEndpoint")
                .customEndpointCertificateArn("customEndpointCertificateArn")
                .customEndpointEnabled(false)
                .enforceHttps(false)
                .tlsSecurityPolicy("tlsSecurityPolicy")
                .build())
        .domainName("domainName")
        .ebsOptions(EBSOptionsProperty.builder()
                .ebsEnabled(false)
                .iops(123)
                .volumeSize(123)
                .volumeType("volumeType")
                .build())
        .elasticsearchClusterConfig(ElasticsearchClusterConfigProperty.builder()
                .coldStorageOptions(ColdStorageOptionsProperty.builder()
                        .enabled(false)
                        .build())
                .dedicatedMasterCount(123)
                .dedicatedMasterEnabled(false)
                .dedicatedMasterType("dedicatedMasterType")
                .instanceCount(123)
                .instanceType("instanceType")
                .warmCount(123)
                .warmEnabled(false)
                .warmType("warmType")
                .zoneAwarenessConfig(ZoneAwarenessConfigProperty.builder()
                        .availabilityZoneCount(123)
                        .build())
                .zoneAwarenessEnabled(false)
                .build())
        .elasticsearchVersion("elasticsearchVersion")
        .encryptionAtRestOptions(EncryptionAtRestOptionsProperty.builder()
                .enabled(false)
                .kmsKeyId("kmsKeyId")
                .build())
        .logPublishingOptions(Map.of(
                "logPublishingOptionsKey", LogPublishingOptionProperty.builder()
                        .cloudWatchLogsLogGroupArn("cloudWatchLogsLogGroupArn")
                        .enabled(false)
                        .build()))
        .nodeToNodeEncryptionOptions(NodeToNodeEncryptionOptionsProperty.builder()
                .enabled(false)
                .build())
        .snapshotOptions(SnapshotOptionsProperty.builder()
                .automatedSnapshotStartHour(123)
                .build())
        .tags(List.of(CfnTag.builder()
                .key("key")
                .value("value")
                .build()))
        .vpcOptions(VPCOptionsProperty.builder()
                .securityGroupIds(List.of("securityGroupIds"))
                .subnetIds(List.of("subnetIds"))
                .build())
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// 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" }
    }
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var accessPolicies interface{}

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

Initializer ​

ts
new CfnDomain(scope: Construct, id: string, props?: CfnDomainProps)
python
CfnDomain(scope: Construct, id: str, props: typing.Optional[CfnDomainProps] = None)
java
new CfnDomain(Construct scope, String id, CfnDomainProps props)
csharp
new CfnDomain(Construct scope, string id, CfnDomainProps? props = null)
go
NewCfnDomain(Scope Construct, Id *string, Props CfnDomainProps)

Construct Props ​

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

For more information, see Configuring access policies in the Amazon OpenSearch Service Developer Guid e.

advancedOptionsIResolvable | { [key: string]: string }advanced_optionstyping.Union[IResolvable, typing.Mapping[str, str]]advancedOptionsIResolvableAdvancedOptionsIResolvableAdvancedOptionsinterface{}#
Additional options to specify for the OpenSearch Service domain.
notes

For more information, see Advanced cluster parameters in the Amazon OpenSearch Service Developer Guide .

advancedSecurityOptionsIResolvable | CfnDomain.AdvancedSecurityOptionsInputPropertyadvanced_security_optionstyping.Union[IResolvable, AdvancedSecurityOptionsInputProperty]advancedSecurityOptionsIResolvableAdvancedSecurityOptionsIResolvableAdvancedSecurityOptionsinterface{}#
Specifies options for fine-grained access control.
cognitoOptionsIResolvable | CfnDomain.CognitoOptionsPropertycognito_optionstyping.Union[IResolvable, CognitoOptionsProperty]cognitoOptionsIResolvableCognitoOptionsIResolvableCognitoOptionsinterface{}#
Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.
domainArnstringdomain_arnstrdomainArnStringDomainArnstringDomainArn*string#
domainEndpointOptionsIResolvable | CfnDomain.DomainEndpointOptionsPropertydomain_endpoint_optionstyping.Union[IResolvable, DomainEndpointOptionsProperty]domainEndpointOptionsIResolvableDomainEndpointOptionsIResolvableDomainEndpointOptionsinterface{}#
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.
domainNamestringdomain_namestrdomainNameStringDomainNamestringDomainName*string#
A name for the OpenSearch Service domain.
notes

For valid values, see the DomainName data type in the Amazon OpenSearch Service Developer Guide . If you don't specify a name, CloudFormation generates a unique physical ID and uses that ID for the domain name. For more information, see Name Type .

If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

ebsOptionsIResolvable | CfnDomain.EBSOptionsPropertyebs_optionstyping.Union[IResolvable, EBSOptionsProperty]ebsOptionsIResolvableEbsOptionsIResolvableEbsOptionsinterface{}#
The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain.

For more information, see EBS volume size limits in the Amazon OpenSearch Service Developer Guide .

elasticsearchClusterConfigIResolvable | CfnDomain.ElasticsearchClusterConfigPropertyelasticsearch_cluster_configtyping.Union[IResolvable, ElasticsearchClusterConfigProperty]elasticsearchClusterConfigIResolvableElasticsearchClusterConfigIResolvableElasticsearchClusterConfiginterface{}#
ElasticsearchClusterConfig is a property of the AWS::Elasticsearch::Domain resource that configures the cluster of an Amazon OpenSearch Service domain.
elasticsearchVersionstringelasticsearch_versionstrelasticsearchVersionStringElasticsearchVersionstringElasticsearchVersion*string#
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](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/what-is.html#choosing-version) in the *Amazon OpenSearch Service Developer Guide* .
notes

If you set the EnableVersionUpgrade update policy to true , you can update ElasticsearchVersion without interruption. When EnableVersionUpgrade is set to false , or is not specified, updating ElasticsearchVersion results in replacement .

encryptionAtRestOptionsIResolvable | CfnDomain.EncryptionAtRestOptionsPropertyencryption_at_rest_optionstyping.Union[IResolvable, EncryptionAtRestOptionsProperty]encryptionAtRestOptionsIResolvableEncryptionAtRestOptionsIResolvableEncryptionAtRestOptionsinterface{}#
Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service key to use.

See Encryption of data at rest for Amazon OpenSearch Service .

logPublishingOptionsIResolvable | { [key: string]: IResolvable | CfnDomain.LogPublishingOptionProperty }log_publishing_optionstyping.Union[IResolvable, typing.Mapping[str, typing.Union[IResolvable, LogPublishingOptionProperty]]]logPublishingOptionsIResolvableLogPublishingOptionsIResolvableLogPublishingOptionsinterface{}#
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.

Each key needs a valid LogPublishingOption value.

nodeToNodeEncryptionOptionsIResolvable | CfnDomain.NodeToNodeEncryptionOptionsPropertynode_to_node_encryption_optionstyping.Union[IResolvable, NodeToNodeEncryptionOptionsProperty]nodeToNodeEncryptionOptionsIResolvableNodeToNodeEncryptionOptionsIResolvableNodeToNodeEncryptionOptionsinterface{}#
Specifies whether node-to-node encryption is enabled.

See Node-to-node encryption for Amazon OpenSearch Service .

snapshotOptionsIResolvable | CfnDomain.SnapshotOptionsPropertysnapshot_optionstyping.Union[IResolvable, SnapshotOptionsProperty]snapshotOptionsIResolvableSnapshotOptionsIResolvableSnapshotOptionsinterface{}#
*DEPRECATED* .

The automated snapshot configuration for the OpenSearch Service domain indices.

tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#
An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Service domain.
vpcOptionsIResolvable | CfnDomain.VPCOptionsPropertyvpc_optionstyping.Union[IResolvable, VPCOptionsProperty]vpcOptionsIResolvableVpcOptionsIResolvableVpcOptionsinterface{}#
The virtual private cloud (VPC) configuration for the OpenSearch Service domain.

For more information, see Launching your Amazon OpenSearch Service domains within a VPC in the Amazon OpenSearch Service Developer Guide .

Properties ​

accessPoliciesanyaccess_policiesAnyaccessPoliciesObjectAccessPoliciesobjectAccessPoliciesinterface{}required#
An AWS Identity and Access Management ( IAM ) policy document that specifies who can access the OpenSearch Service domain and their permissions.
advancedOptionsIResolvable | { [key: string]: string }advanced_optionstyping.Union[IResolvable, typing.Mapping[str, str]]advancedOptionsIResolvableAdvancedOptionsIResolvableAdvancedOptionsinterface{}#
Additional options to specify for the OpenSearch Service domain.
advancedSecurityOptionsIResolvable | CfnDomain.AdvancedSecurityOptionsInputPropertyadvanced_security_optionstyping.Union[IResolvable, AdvancedSecurityOptionsInputProperty]advancedSecurityOptionsIResolvableAdvancedSecurityOptionsIResolvableAdvancedSecurityOptionsinterface{}#
Specifies options for fine-grained access control.
attrArnstringattr_arnstrattrArnStringAttrArnstringAttrArn*stringrequired#
The Amazon Resource Name (ARN) of the domain, such as `arn:aws:es:us-west-2:123456789012:domain/mystack-elasti-1ab2cdefghij` .

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

attrDomainEndpointstringattr_domain_endpointstrattrDomainEndpointStringAttrDomainEndpointstringAttrDomainEndpoint*stringrequired#
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` .
attrIdstringattr_idstrattrIdStringAttrIdstringAttrId*stringrequired#
CFN_RESOURCE_TYPE_NAMEstringcfn_resource_type_namestrCFN_RESOURCE_TYPE_NAMEStringCFN_RESOURCE_TYPE_NAMEstringCFN_RESOURCE_TYPE_NAME*stringrequiredstatic#
The CloudFormation resource type name for this resource class.
cfnOptionsICfnResourceOptionscfn_optionsICfnResourceOptionscfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsrequired#
Options for this resource, such as condition, update policy etc.
cfnResourceTypestringcfn_resource_typestrcfnResourceTypeStringCfnResourceTypestringCfnResourceType*stringrequired#
AWS resource type.
cognitoOptionsIResolvable | CfnDomain.CognitoOptionsPropertycognito_optionstyping.Union[IResolvable, CognitoOptionsProperty]cognitoOptionsIResolvableCognitoOptionsIResolvableCognitoOptionsinterface{}#
Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.
creationStackstring[]creation_stacktyping.List[str]creationStackList<String>CreationStackstring[]CreationStack*[]*stringrequired#
domainArnstringdomain_arnstrdomainArnStringDomainArnstringDomainArn*string#
domainEndpointOptionsIResolvable | CfnDomain.DomainEndpointOptionsPropertydomain_endpoint_optionstyping.Union[IResolvable, DomainEndpointOptionsProperty]domainEndpointOptionsIResolvableDomainEndpointOptionsIResolvableDomainEndpointOptionsinterface{}#
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.
domainNamestringdomain_namestrdomainNameStringDomainNamestringDomainName*string#
A name for the OpenSearch Service domain.
domainRefDomainReferencedomain_refDomainReferencedomainRefDomainReferenceDomainRefDomainReferenceDomainRefDomainReferencerequired#
A reference to a Domain resource.
ebsOptionsIResolvable | CfnDomain.EBSOptionsPropertyebs_optionstyping.Union[IResolvable, EBSOptionsProperty]ebsOptionsIResolvableEbsOptionsIResolvableEbsOptionsinterface{}#
The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain.
elasticsearchClusterConfigIResolvable | CfnDomain.ElasticsearchClusterConfigPropertyelasticsearch_cluster_configtyping.Union[IResolvable, ElasticsearchClusterConfigProperty]elasticsearchClusterConfigIResolvableElasticsearchClusterConfigIResolvableElasticsearchClusterConfiginterface{}#
ElasticsearchClusterConfig is a property of the AWS::Elasticsearch::Domain resource that configures the cluster of an Amazon OpenSearch Service domain.
elasticsearchVersionstringelasticsearch_versionstrelasticsearchVersionStringElasticsearchVersionstringElasticsearchVersion*string#
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](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/what-is.html#choosing-version) in the *Amazon OpenSearch Service Developer Guide* .
encryptionAtRestOptionsIResolvable | CfnDomain.EncryptionAtRestOptionsPropertyencryption_at_rest_optionstyping.Union[IResolvable, EncryptionAtRestOptionsProperty]encryptionAtRestOptionsIResolvableEncryptionAtRestOptionsIResolvableEncryptionAtRestOptionsinterface{}#
Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service key to use.
logicalIdstringlogical_idstrlogicalIdStringLogicalIdstringLogicalId*stringrequired#
The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

logPublishingOptionsIResolvable | { [key: string]: IResolvable | CfnDomain.LogPublishingOptionProperty }log_publishing_optionstyping.Union[IResolvable, typing.Mapping[str, typing.Union[IResolvable, LogPublishingOptionProperty]]]logPublishingOptionsIResolvableLogPublishingOptionsIResolvableLogPublishingOptionsinterface{}#
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.
nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#
The tree node.
nodeToNodeEncryptionOptionsIResolvable | CfnDomain.NodeToNodeEncryptionOptionsPropertynode_to_node_encryption_optionstyping.Union[IResolvable, NodeToNodeEncryptionOptionsProperty]nodeToNodeEncryptionOptionsIResolvableNodeToNodeEncryptionOptionsIResolvableNodeToNodeEncryptionOptionsinterface{}#
Specifies whether node-to-node encryption is enabled.
refstringrefstrrefStringRefstringRef*stringrequired#
Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

snapshotOptionsIResolvable | CfnDomain.SnapshotOptionsPropertysnapshot_optionstyping.Union[IResolvable, SnapshotOptionsProperty]snapshotOptionsIResolvableSnapshotOptionsIResolvableSnapshotOptionsinterface{}#
*DEPRECATED* .
stackStackstackStackstackStackStackStackStackStackrequired#
The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tagsTagManagertagsTagManagertagsTagManagerTagsTagManagerTagsTagManagerrequired#
Tag Manager which manages the tags for this resource.
tagsRawCfnTag[]tags_rawtyping.List[CfnTag]tagsRawList<CfnTag>TagsRawCfnTag[]TagsRaw*[]CfnTag#
An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Service domain.
vpcOptionsIResolvable | CfnDomain.VPCOptionsPropertyvpc_optionstyping.Union[IResolvable, VPCOptionsProperty]vpcOptionsIResolvableVpcOptionsIResolvableVpcOptionsinterface{}#
The virtual private cloud (VPC) configuration for the OpenSearch Service domain.

Methods ​

addDeletionOverride(path: string): voiddef add_deletion_override(self, path: str) -> Nonepublic void addDeletionOverride(String path)public void AddDeletionOverride(string path)func AddDeletionOverride(Path *string)#
Syntactic sugar for `addOverride(path, undefined)`.
1 parameter

Parameters

  • pathpathpathpathPath — The path of the value to delete.
addDependency(target: CfnResource): voiddef add_dependency(self, target: CfnResource) -> Nonepublic void addDependency(CfnResource target)public void AddDependency(CfnResource target)func AddDependency(Target CfnResource)deprecated#
Use `addResourceDependency` instead.

This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.

addDependsOn(target: CfnResource): voiddef add_depends_on(self, target: CfnResource) -> Nonepublic void addDependsOn(CfnResource target)public void AddDependsOn(CfnResource target)func AddDependsOn(Target CfnResource)deprecated#
Use `addResourceDependency` instead.
notes

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.

addMetadata(key: string, value: any): voiddef add_metadata(self, key: str, value: Any) -> Nonepublic void addMetadata(String key, Object value)public void AddMetadata(string key, object value)func AddMetadata(Key *string, Value interface{})#
Add a value to the CloudFormation Resource Metadata.
addOverride(path: string, value: any): voiddef add_override(self, path: str, value: Any) -> Nonepublic void addOverride(String path, Object value)public void AddOverride(string path, object value)func AddOverride(Path *string, Value interface{})#
Adds an override to the synthesized CloudFormation resource.
notes · 2 parameters

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

typescript
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

json
"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters

  • pathpathpathpathPath — - The path of the property, you can use dot notation to override values in complex types.
  • valuevaluevaluevalueValue — - The value.
addPropertyDeletionOverride(propertyPath: string): voiddef add_property_deletion_override(self, property_path: str) -> Nonepublic void addPropertyDeletionOverride(String propertyPath)public void AddPropertyDeletionOverride(string propertyPath)func AddPropertyDeletionOverride(PropertyPath *string)#
Adds an override that deletes the value of a property from the resource definition.
1 parameter

Parameters

  • propertyPathproperty_pathpropertyPathpropertyPathPropertyPath — The path to the property.
addPropertyOverride(propertyPath: string, value: any): voiddef add_property_override(self, property_path: str, value: Any) -> Nonepublic void addPropertyOverride(String propertyPath, Object value)public void AddPropertyOverride(string propertyPath, object value)func AddPropertyOverride(PropertyPath *string, Value interface{})#
Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

2 parameters

Parameters

  • propertyPathproperty_pathpropertyPathpropertyPathPropertyPath — The path of the property.
  • valuevaluevaluevalueValue — The value.
addResourceDependency(target: CfnResource, reason?: string): voiddef add_resource_dependency(self, target: CfnResource, reason: typing.Optional[str] = None) -> Nonepublic void addResourceDependency(CfnResource target, String reason)public void AddResourceDependency(CfnResource target, string? reason = null)func AddResourceDependency(Target CfnResource, Reason *string)#
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
notes

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.

applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#
Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

1 parameter

Parameters

  • strengthstrengthstrengthstrengthStrength — - The reference strength to use for this resource.
applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): voiddef apply_removal_policy(self, policy: typing.Optional[RemovalPolicy] = None, options: typing.Optional[RemovalPolicyOptions] = None) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)public void ApplyRemovalPolicy(RemovalPolicy? policy = null, RemovalPolicyOptions? options = null)func ApplyRemovalPolicy(Policy RemovalPolicy, Options RemovalPolicyOptions)#
Sets the deletion policy of the resource based on the removal policy specified.
notes

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

arnForDomain(resource: IDomainRef): string@staticmethod def arn_for_domain(resource: IDomainRef) -> strpublic static String arnForDomain(IDomainRef resource)public static string ArnForDomain(IDomainRef resource)func ArnForDomain(Resource IDomainRef) *stringstatic#
cfnPropertyName(cdkPropertyName: string): stringdef cfn_property_name(self, cdk_property_name: str) -> strpublic String cfnPropertyName(String cdkPropertyName)public string CfnPropertyName(string cdkPropertyName)func CfnPropertyName(CdkPropertyName *string) *string#
fromDomainArn(scope: Construct, id: string, arn: string): IDomainRef@staticmethod def from_domain_arn(scope: Construct, id: str, arn: str) -> IDomainRefpublic static IDomainRef fromDomainArn(Construct scope, String id, String arn)public static IDomainRef FromDomainArn(Construct scope, string id, string arn)func FromDomainArn(Scope Construct, Id *string, Arn *string) IDomainRefstatic#
Creates a new IDomainRef from an ARN.
fromDomainName(scope: Construct, id: string, domainName: string): IDomainRef@staticmethod def from_domain_name(scope: Construct, id: str, domain_name: str) -> IDomainRefpublic static IDomainRef fromDomainName(Construct scope, String id, String domainName)public static IDomainRef FromDomainName(Construct scope, string id, string domainName)func FromDomainName(Scope Construct, Id *string, DomainName *string) IDomainRefstatic#
Creates a new IDomainRef from a domainName.
getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Referencedef get_att(self, attribute_name: str, type_hint: typing.Optional[ResolutionTypeHint] = None) -> Referencepublic Reference getAtt(String attributeName, ResolutionTypeHint typeHint)public Reference GetAtt(string attributeName, ResolutionTypeHint? typeHint = null)func GetAtt(AttributeName *string, TypeHint ResolutionTypeHint) Reference#
Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

1 parameter

Parameters

  • attributeNameattribute_nameattributeNameattributeNameAttributeName — The name of the attribute.
getMetadata(key: string): anydef get_metadata(self, key: str) -> Anypublic Object getMetadata(String key)public object GetMetadata(string key)func GetMetadata(Key *string) interface{}#
Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector: TreeInspector): voiddef inspect(self, inspector: TreeInspector) -> Nonepublic void inspect(TreeInspector inspector)public void Inspect(TreeInspector inspector)func Inspect(Inspector TreeInspector)#
Examines the CloudFormation resource and discloses attributes.
1 parameter

Parameters

  • inspectorinspectorinspectorinspectorInspector — tree inspector to collect and process attributes.
isCfnDomain(x: any): boolean@staticmethod def is_cfn_domain(x: Any) -> boolpublic static Boolean isCfnDomain(Object x)public static bool IsCfnDomain(object x)func IsCfnDomain(X interface{}) *boolstatic#
Checks whether the given object is a CfnDomain.
isCfnElement(x: any): boolean@staticmethod def is_cfn_element(x: Any) -> boolpublic static Boolean isCfnElement(Object x)public static bool IsCfnElement(object x)func IsCfnElement(X interface{}) *boolstatic#
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

returns

Returns: The construct as a stack element or undefined if it is not a stack element.

isCfnResource(x: any): boolean@staticmethod def is_cfn_resource(x: Any) -> boolpublic static Boolean isCfnResource(Object x)public static bool IsCfnResource(object x)func IsCfnResource(X interface{}) *boolstatic#
Check whether the given object is a CfnResource.
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#
Checks if `x` is a construct.
notes · 1 parameter · returns

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

  • xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

obtainDependencies(): Stack | CfnResource[]def obtain_dependencies(self, ) -> typing.List[typing.Union[Stack, CfnResource]]public List<Stack> obtainDependencies()public Stack[] ObtainDependencies()func ObtainDependencies() *[]interface{}#
Retrieves an array of resources and stacks this resource depends on.

For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.

overrideLogicalId(newLogicalId: string): voiddef override_logical_id(self, new_logical_id: str) -> Nonepublic void overrideLogicalId(String newLogicalId)public void OverrideLogicalId(string newLogicalId)func OverrideLogicalId(NewLogicalId *string)#
Overrides the auto-generated logical ID with a specific ID.
1 parameter

Parameters

  • newLogicalIdnew_logical_idnewLogicalIdnewLogicalIdNewLogicalId — The new logical ID to use for this stack element.
removeDependency(target: CfnResource): voiddef remove_dependency(self, target: CfnResource) -> Nonepublic void removeDependency(CfnResource target)public void RemoveDependency(CfnResource target)func RemoveDependency(Target CfnResource)deprecated#
Use `removeResourceDependency` instead

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

removeResourceDependency(target: CfnResource): voiddef remove_resource_dependency(self, target: CfnResource) -> Nonepublic void removeResourceDependency(CfnResource target)public void RemoveResourceDependency(CfnResource target)func RemoveResourceDependency(Target CfnResource)#
Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

replaceDependency(target: CfnResource, newTarget: CfnResource): voiddef replace_dependency(self, target: CfnResource, new_target: CfnResource) -> Nonepublic void replaceDependency(CfnResource target, CfnResource newTarget)public void ReplaceDependency(CfnResource target, CfnResource newTarget)func ReplaceDependency(Target CfnResource, NewTarget CfnResource)#
Replaces one dependency with another.
2 parameters

Parameters

  • targettargettargettargetTarget — The dependency to replace.
  • newTargetnew_targetnewTargetnewTargetNewTarget — The new dependency to add.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#
Returns a string representation of this construct.
returns

Returns: a string representation of this resource

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#
Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.