interface CfnDomainProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.Elasticsearch.CfnDomainProps |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awselasticsearch#CfnDomainProps |
 Java | software.amazon.awscdk.services.elasticsearch.CfnDomainProps |
 Python | aws_cdk.aws_elasticsearch.CfnDomainProps |
 TypeScript | aws-cdk-lib » aws_elasticsearch » CfnDomainProps |
Properties for defining a CfnDomain.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html
Example
// 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 cfnDomainProps: elasticsearch.CfnDomainProps = {
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'],
},
};
Properties
| Name | Type | Description |
|---|---|---|
| access | any | An AWS Identity and Access Management ( IAM ) policy document that specifies who can access the OpenSearch Service domain and their permissions. |
| advanced | IResolvable | { [string]: string } | Additional options to specify for the OpenSearch Service domain. |
| advanced | IResolvable | Advanced | Specifies options for fine-grained access control. |
| cognito | IResolvable | Cognito | Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards. |
| domain | string | |
| domain | IResolvable | Domain | 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. |
| domain | string | A name for the OpenSearch Service domain. |
| ebs | IResolvable | EBSOptions | The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain. |
| elasticsearch | IResolvable | Elasticsearch | ElasticsearchClusterConfig is a property of the AWS::Elasticsearch::Domain resource that configures the cluster of an Amazon OpenSearch Service domain. |
| elasticsearch | 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 in the Amazon OpenSearch Service Developer Guide . |
| encryption | IResolvable | Encryption | Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service key to use. |
| log | IResolvable | { [string]: IResolvable | Log } | 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. |
| node | IResolvable | Node | Specifies whether node-to-node encryption is enabled. |
| snapshot | IResolvable | Snapshot | DEPRECATED . |
| tags? | Cfn[] | An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Service domain. |
| vpc | IResolvable | VPCOptions | The virtual private cloud (VPC) configuration for the OpenSearch Service domain. |
accessPolicies?
Type:
any
(optional)
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.
advancedOptions?
Type:
IResolvable | { [string]: string }
(optional)
Additional options to specify for the OpenSearch Service domain.
For more information, see Advanced cluster parameters in the Amazon OpenSearch Service Developer Guide .
advancedSecurityOptions?
Type:
IResolvable | Advanced
(optional)
Specifies options for fine-grained access control.
cognitoOptions?
Type:
IResolvable | Cognito
(optional)
Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.
domainArn?
Type:
string
(optional)
domainEndpointOptions?
Type:
IResolvable | Domain
(optional)
Specifies additional options for the domain endpoint, such as whether to require HTTPS for all traffic or whether to use a custom endpoint rather than the default endpoint.
domainName?
Type:
string
(optional)
A name for the OpenSearch Service domain.
For valid values, see the DomainName data type in the Amazon OpenSearch Service Developer Guide . If you don't specify a name, AWS 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.
ebsOptions?
Type:
IResolvable | EBSOptions
(optional)
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 .
elasticsearchClusterConfig?
Type:
IResolvable | Elasticsearch
(optional)
ElasticsearchClusterConfig is a property of the AWS::Elasticsearch::Domain resource that configures the cluster of an Amazon OpenSearch Service domain.
elasticsearchVersion?
Type:
string
(optional)
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 .
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 .
encryptionAtRestOptions?
Type:
IResolvable | Encryption
(optional)
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 .
logPublishingOptions?
Type:
IResolvable | { [string]: IResolvable | Log }
(optional)
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.
nodeToNodeEncryptionOptions?
Type:
IResolvable | Node
(optional)
Specifies whether node-to-node encryption is enabled.
See Node-to-node encryption for Amazon OpenSearch Service .
snapshotOptions?
Type:
IResolvable | Snapshot
(optional)
DEPRECATED .
The automated snapshot configuration for the OpenSearch Service domain indices.
tags?
Type:
Cfn[]
(optional)
An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Service domain.
vpcOptions?
Type:
IResolvable | VPCOptions
(optional)
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 .