class CfnDomain (construct)
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.Elasticsearch.CfnDomain |
Java | software.amazon.awscdk.services.elasticsearch.CfnDomain |
Python | aws_cdk.aws_elasticsearch.CfnDomain |
TypeScript | @aws-cdk/aws-elasticsearch » CfnDomain |
Implements
IConstruct
, IConstruct
, IDependable
, IInspectable
A CloudFormation AWS::Elasticsearch::Domain
.
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 * as elasticsearch from '@aws-cdk/aws-elasticsearch';
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',
},
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'],
},
});
Initializer
new CfnDomain(scope: Construct, id: string, props?: CfnDomainProps)
Parameters
- scope
Construct
— - scope in which this resource is defined. - id
string
— - scoped id of the resource. - props
Cfn
— - resource properties.Domain Props
Create a new AWS::Elasticsearch::Domain
.
Construct Props
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 | 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.
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 .
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. |
attr | string | The Amazon Resource Name (ARN) of the domain, such as arn:aws:es:us-west-2:123456789012:domain/mystack-elasti-1ab2cdefghij . |
attr | string | 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 . |
cfn | ICfn | Options for this resource, such as condition, update policy etc. |
cfn | { [string]: any } | |
cfn | string | AWS resource type. |
creation | string[] | |
logical | string | The logical ID for this CloudFormation stack element. |
node | Construct | The construct tree node associated with this construct. |
ref | string | Return a string that will be resolved to a CloudFormation { Ref } for this element. |
stack | Stack | The stack in which this element is defined. |
tags | Tag | An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Service domain. |
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 | 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 . |
vpc | IResolvable | VPCOptions | The virtual private cloud (VPC) configuration for the OpenSearch Service domain. |
static CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. |
accessPolicies
Type:
any
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.
attrArn
Type:
string
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
.
attrDomainEndpoint
Type:
string
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
.
cfnOptions
Type:
ICfn
Options for this resource, such as condition, update policy etc.
cfnProperties
Type:
{ [string]: any }
cfnResourceType
Type:
string
AWS resource type.
creationStack
Type:
string[]
logicalId
Type:
string
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)
.
node
Type:
Construct
The construct tree node associated with this construct.
ref
Type:
string
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 })
.
stack
Type:
Stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
tags
Type:
Tag
An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Service domain.
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.
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.
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 .
static CFN_RESOURCE_TYPE_NAME
Type:
string
The CloudFormation resource type name for this resource class.
Methods
Name | Description |
---|---|
add | Syntactic sugar for addOverride(path, undefined) . |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Add a value to the CloudFormation Resource Metadata. |
add | Adds an override to the synthesized CloudFormation resource. |
add | Adds an override that deletes the value of a property from the resource definition. |
add | Adds an override to a resource property. |
apply | Sets the deletion policy of the resource based on the removal policy specified. |
get | Returns a token for an runtime attribute of this resource. |
get | Retrieve a value value from the CloudFormation Resource Metadata. |
inspect(inspector) | Examines the CloudFormation resource and discloses attributes. |
override | Overrides the auto-generated logical ID with a specific ID. |
to | Returns a string representation of this construct. |
protected render |
DeletionOverride(path)
addpublic addDeletionOverride(path: string): void
Parameters
- path
string
— The path of the value to delete.
Syntactic sugar for addOverride(path, undefined)
.
DependsOn(target)
addpublic addDependsOn(target: CfnResource): void
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
Metadata(key, value)
addpublic addMetadata(key: string, value: any): void
Parameters
- key
string
- value
any
Add a value to the CloudFormation Resource Metadata.
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
Override(path, value)
addpublic addOverride(path: string, value: any): void
Parameters
- path
string
— - The path of the property, you can use dot notation to override values in complex types. - value
any
— - The value.
Adds an override to the synthesized CloudFormation resource.
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,
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
"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.
PropertyDeletionOverride(propertyPath)
addpublic addPropertyDeletionOverride(propertyPath: string): void
Parameters
- propertyPath
string
— The path to the property.
Adds an override that deletes the value of a property from the resource definition.
PropertyOverride(propertyPath, value)
addpublic addPropertyOverride(propertyPath: string, value: any): void
Parameters
- propertyPath
string
— The path of the property. - value
any
— The value.
Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value)
.
RemovalPolicy(policy?, options?)
applypublic applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void
Parameters
- policy
Removal
Policy - options
Removal
Policy Options
Sets the deletion policy of the resource based on the removal policy specified.
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
).
Att(attributeName)
getpublic getAtt(attributeName: string): Reference
Parameters
- attributeName
string
— The name of the attribute.
Returns
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.
Metadata(key)
getpublic getMetadata(key: string): any
Parameters
- key
string
Returns
any
Retrieve a value value from the CloudFormation Resource Metadata.
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
inspect(inspector)
public inspect(inspector: TreeInspector): void
Parameters
- inspector
Tree
— - tree inspector to collect and process attributes.Inspector
Examines the CloudFormation resource and discloses attributes.
LogicalId(newLogicalId)
overridepublic overrideLogicalId(newLogicalId: string): void
Parameters
- newLogicalId
string
— The new logical ID to use for this stack element.
Overrides the auto-generated logical ID with a specific ID.
String()
topublic toString(): string
Returns
string
Returns a string representation of this construct.
Properties(props)
protected renderprotected renderProperties(props: { [string]: any }): { [string]: any }
Parameters
- props
{ [string]: any }
Returns
{ [string]: any }