Class CfnDomain
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.elasticsearch.CfnDomain
- All Implemented Interfaces:
IInspectable
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-09-24T10:56:32.133Z")
@Stability(Stable)
public class CfnDomain
extends CfnResource
implements IInspectable, ITaggable
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 .
Example:
// 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();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
Specifies options for fine-grained access control.static final class
A fluent builder forCfnDomain
.static interface
Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.static interface
Specifies options for cold storage.static interface
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.static interface
The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain.static interface
The cluster configuration for the OpenSearch Service domain.static interface
Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service key to use.static interface
static interface
Specifies information about the master user.static interface
Specifies whether node-to-node encryption is enabled.static interface
static interface
The virtual private cloud (VPC) configuration for the OpenSearch Service domain.static interface
Specifies zone awareness configuration options.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnDomain
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnDomain
(software.amazon.jsii.JsiiObjectRef objRef) CfnDomain
(software.constructs.Construct scope, String id, CfnDomainProps props) -
Method Summary
Modifier and TypeMethodDescriptionAn AWS Identity and Access Management ( IAM ) policy document that specifies who can access the OpenSearch Service domain and their permissions.Additional options to specify for the OpenSearch Service domain.Specifies options for fine-grained access control.The Amazon Resource Name (ARN) of the domain, such asarn:aws:es:us-west-2:123456789012:domain/mystack-elasti-1ab2cdefghij
.The domain-specific endpoint that's used for requests to the OpenSearch APIs, such assearch-mystack-elasti-1ab2cdefghij-ab1c2deckoyb3hofw7wpqa3cm.us-west-1.es.amazonaws.com
.Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.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.A name for the OpenSearch Service domain.The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain.ElasticsearchClusterConfig is a property of the AWS::Elasticsearch::Domain resource that configures the cluster of an Amazon OpenSearch Service domain.The version of Elasticsearch to use, such as 2.3.Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service key to use.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.Specifies whether node-to-node encryption is enabled.DEPRECATED .getTags()
Tag Manager which manages the tags for this resource.An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Service domain.The virtual private cloud (VPC) configuration for the OpenSearch Service domain.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setAccessPolicies
(Object value) An AWS Identity and Access Management ( IAM ) policy document that specifies who can access the OpenSearch Service domain and their permissions.void
setAdvancedOptions
(Map<String, String> value) Additional options to specify for the OpenSearch Service domain.void
setAdvancedOptions
(IResolvable value) Additional options to specify for the OpenSearch Service domain.void
Specifies options for fine-grained access control.void
Specifies options for fine-grained access control.void
setCognitoOptions
(IResolvable value) Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.void
Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.void
setDomainArn
(String value) void
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.void
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.void
setDomainName
(String value) A name for the OpenSearch Service domain.void
setEbsOptions
(IResolvable value) The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain.void
The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain.void
ElasticsearchClusterConfig is a property of the AWS::Elasticsearch::Domain resource that configures the cluster of an Amazon OpenSearch Service domain.void
ElasticsearchClusterConfig is a property of the AWS::Elasticsearch::Domain resource that configures the cluster of an Amazon OpenSearch Service domain.void
setElasticsearchVersion
(String value) The version of Elasticsearch to use, such as 2.3.void
Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service key to use.void
Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service key to use.void
setLogPublishingOptions
(Map<String, Object> value) 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.void
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.void
Specifies whether node-to-node encryption is enabled.void
Specifies whether node-to-node encryption is enabled.void
setSnapshotOptions
(IResolvable value) DEPRECATED .void
DEPRECATED .void
setTagsRaw
(List<CfnTag> value) An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Service domain.void
setVpcOptions
(IResolvable value) The virtual private cloud (VPC) configuration for the OpenSearch Service domain.void
The virtual private cloud (VPC) configuration for the OpenSearch Service domain.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnDomain
protected CfnDomain(software.amazon.jsii.JsiiObjectRef objRef) -
CfnDomain
protected CfnDomain(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnDomain
@Stability(Stable) public CfnDomain(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnDomainProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties.
-
CfnDomain
@Stability(Stable) public CfnDomain(@NotNull software.constructs.Construct scope, @NotNull String id) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrArn
The Amazon Resource Name (ARN) of the domain, such asarn: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
. -
getAttrDomainEndpoint
The domain-specific endpoint that's used for requests to the OpenSearch APIs, such assearch-mystack-elasti-1ab2cdefghij-ab1c2deckoyb3hofw7wpqa3cm.us-west-1.es.amazonaws.com
. -
getAttrId
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getAccessPolicies
An AWS Identity and Access Management ( IAM ) policy document that specifies who can access the OpenSearch Service domain and their permissions. -
setAccessPolicies
An AWS Identity and Access Management ( IAM ) policy document that specifies who can access the OpenSearch Service domain and their permissions. -
getAdvancedOptions
Additional options to specify for the OpenSearch Service domain. -
setAdvancedOptions
Additional options to specify for the OpenSearch Service domain. -
setAdvancedOptions
Additional options to specify for the OpenSearch Service domain. -
getAdvancedSecurityOptions
Specifies options for fine-grained access control. -
setAdvancedSecurityOptions
Specifies options for fine-grained access control. -
setAdvancedSecurityOptions
@Stability(Stable) public void setAdvancedSecurityOptions(@Nullable CfnDomain.AdvancedSecurityOptionsInputProperty value) Specifies options for fine-grained access control. -
getCognitoOptions
Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards. -
setCognitoOptions
Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards. -
setCognitoOptions
Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards. -
getDomainArn
-
setDomainArn
-
getDomainEndpointOptions
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. -
setDomainEndpointOptions
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. -
setDomainEndpointOptions
@Stability(Stable) public void setDomainEndpointOptions(@Nullable CfnDomain.DomainEndpointOptionsProperty value) 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. -
getDomainName
A name for the OpenSearch Service domain. -
setDomainName
A name for the OpenSearch Service domain. -
getEbsOptions
The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain. -
setEbsOptions
The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain. -
setEbsOptions
The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain. -
getElasticsearchClusterConfig
ElasticsearchClusterConfig is a property of the AWS::Elasticsearch::Domain resource that configures the cluster of an Amazon OpenSearch Service domain. -
setElasticsearchClusterConfig
ElasticsearchClusterConfig is a property of the AWS::Elasticsearch::Domain resource that configures the cluster of an Amazon OpenSearch Service domain. -
setElasticsearchClusterConfig
@Stability(Stable) public void setElasticsearchClusterConfig(@Nullable CfnDomain.ElasticsearchClusterConfigProperty value) ElasticsearchClusterConfig is a property of the AWS::Elasticsearch::Domain resource that configures the cluster of an Amazon OpenSearch Service domain. -
getElasticsearchVersion
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 . -
setElasticsearchVersion
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 . -
getEncryptionAtRestOptions
Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service key to use. -
setEncryptionAtRestOptions
Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service key to use. -
setEncryptionAtRestOptions
@Stability(Stable) public void setEncryptionAtRestOptions(@Nullable CfnDomain.EncryptionAtRestOptionsProperty value) Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service key to use. -
getLogPublishingOptions
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. -
setLogPublishingOptions
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. -
setLogPublishingOptions
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. -
getNodeToNodeEncryptionOptions
Specifies whether node-to-node encryption is enabled. -
setNodeToNodeEncryptionOptions
Specifies whether node-to-node encryption is enabled. -
setNodeToNodeEncryptionOptions
@Stability(Stable) public void setNodeToNodeEncryptionOptions(@Nullable CfnDomain.NodeToNodeEncryptionOptionsProperty value) Specifies whether node-to-node encryption is enabled. -
getSnapshotOptions
DEPRECATED . -
setSnapshotOptions
DEPRECATED . -
setSnapshotOptions
@Stability(Stable) public void setSnapshotOptions(@Nullable CfnDomain.SnapshotOptionsProperty value) DEPRECATED . -
getTagsRaw
An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Service domain. -
setTagsRaw
An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Service domain. -
getVpcOptions
The virtual private cloud (VPC) configuration for the OpenSearch Service domain. -
setVpcOptions
The virtual private cloud (VPC) configuration for the OpenSearch Service domain. -
setVpcOptions
The virtual private cloud (VPC) configuration for the OpenSearch Service domain.
-