This documentation is for the developer preview release of the AWS CDK. Do not use this version of the AWS CDK in production. Subsequent releases of the AWS CDK will likely include breaking changes.

@aws-cdk/aws-elasticsearch

The CDK Construct Library for AWS Elasticsearch

This module is part of the AWS Cloud Development Kit project.

Reference

View in Nuget

csproj:

<PackageReference Include="Amazon.CDK.AWS.Elasticsearch" Version="0.25.3" />

dotnet:

dotnet add package Amazon.CDK.AWS.Elasticsearch --version 0.25.3

packages.config:

<package id="Amazon.CDK.AWS.Elasticsearch" version="0.25.3" />

View in Maven Central

Apache Buildr:

'software.amazon.awscdk:elasticsearch:jar:0.25.3'

Apache Ivy:

<dependency groupId="software.amazon.awscdk" name="elasticsearch" rev="0.25.3"/>

Apache Maven:

<dependency>
  <groupId>software.amazon.awscdk</groupId>
  <artifactId>elasticsearch</artifactId>
  <version>0.25.3</version>
</dependency>

Gradle / Grails:

compile 'software.amazon.awscdk:elasticsearch:0.25.3'

Groovy Grape:

@Grapes(
@Grab(group='software.amazon.awscdk', module='elasticsearch', version='0.25.3')
)

View in NPM

npm:

$ npm i @aws-cdk/aws-elasticsearch@0.25.3

package.json:

{
  "@aws-cdk/aws-elasticsearch": "^0.25.3"
}

yarn:

$ yarn add @aws-cdk/aws-elasticsearch@0.25.3

View in NPM

npm:

$ npm i @aws-cdk/aws-elasticsearch@0.25.3

package.json:

{
  "@aws-cdk/aws-elasticsearch": "^0.25.3"
}

yarn:

$ yarn add @aws-cdk/aws-elasticsearch@0.25.3

CfnDomain

class @aws-cdk/aws-elasticsearch.CfnDomain(scope, id[, props])

Language-specific names:

using Amazon.CDK.AWS.Elasticsearch;
import software.amazon.awscdk.services.elasticsearch.CfnDomain;
const { CfnDomain } = require('@aws-cdk/aws-elasticsearch');
import { CfnDomain } from '@aws-cdk/aws-elasticsearch';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
domainArn
Type:string (readonly)
domainEndpoint
Type:string (readonly)
domainName
Type:string (readonly)
propertyOverrides
Type:CfnDomainProps (readonly)
tags

The TagManager handles setting, removing and formatting tags

Tags should be managed either passing them as properties during

initiation or by calling methods on this object. If both techniques are

used only the tags from the TagManager will be used. Tag (aspect)

will use the manager.

Type:@aws-cdk/cdk.TagManager (readonly)
class EBSOptionsProperty

Language-specific names:

using Amazon.CDK.AWS.Elasticsearch;
import software.amazon.awscdk.services.elasticsearch.CfnDomain.EBSOptionsProperty;
// CfnDomain.EBSOptionsProperty is an interface
import { CfnDomain.EBSOptionsProperty } from '@aws-cdk/aws-elasticsearch';
ebsEnabled

CfnDomain.EBSOptionsProperty.EBSEnabled

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-ebsoptions.html#cfn-elasticsearch-domain-ebsoptions-ebsenabled

Type:boolean or @aws-cdk/cdk.Token (optional)
iops

CfnDomain.EBSOptionsProperty.Iops

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-ebsoptions.html#cfn-elasticsearch-domain-ebsoptions-iops

Type:number or @aws-cdk/cdk.Token (optional)
volumeSize

CfnDomain.EBSOptionsProperty.VolumeSize

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-ebsoptions.html#cfn-elasticsearch-domain-ebsoptions-volumesize

Type:number or @aws-cdk/cdk.Token (optional)
volumeType

CfnDomain.EBSOptionsProperty.VolumeType

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-ebsoptions.html#cfn-elasticsearch-domain-ebsoptions-volumetype

Type:string (optional)
class ElasticsearchClusterConfigProperty

Language-specific names:

using Amazon.CDK.AWS.Elasticsearch;
import software.amazon.awscdk.services.elasticsearch.CfnDomain.ElasticsearchClusterConfigProperty;
// CfnDomain.ElasticsearchClusterConfigProperty is an interface
import { CfnDomain.ElasticsearchClusterConfigProperty } from '@aws-cdk/aws-elasticsearch';
dedicatedMasterCount

CfnDomain.ElasticsearchClusterConfigProperty.DedicatedMasterCount

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticseachclusterconfig-dedicatedmastercount

Type:number or @aws-cdk/cdk.Token (optional)
dedicatedMasterEnabled

CfnDomain.ElasticsearchClusterConfigProperty.DedicatedMasterEnabled

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticseachclusterconfig-dedicatedmasterenabled

Type:boolean or @aws-cdk/cdk.Token (optional)
dedicatedMasterType

CfnDomain.ElasticsearchClusterConfigProperty.DedicatedMasterType

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticseachclusterconfig-dedicatedmastertype

Type:string (optional)
instanceCount

CfnDomain.ElasticsearchClusterConfigProperty.InstanceCount

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticseachclusterconfig-instancecount

Type:number or @aws-cdk/cdk.Token (optional)
instanceType

CfnDomain.ElasticsearchClusterConfigProperty.InstanceType

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticseachclusterconfig-instnacetype

Type:string (optional)
zoneAwarenessEnabled

CfnDomain.ElasticsearchClusterConfigProperty.ZoneAwarenessEnabled

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html#cfn-elasticsearch-domain-elasticseachclusterconfig-zoneawarenessenabled

Type:boolean or @aws-cdk/cdk.Token (optional)
class EncryptionAtRestOptionsProperty

Language-specific names:

using Amazon.CDK.AWS.Elasticsearch;
import software.amazon.awscdk.services.elasticsearch.CfnDomain.EncryptionAtRestOptionsProperty;
// CfnDomain.EncryptionAtRestOptionsProperty is an interface
import { CfnDomain.EncryptionAtRestOptionsProperty } from '@aws-cdk/aws-elasticsearch';
enabled

CfnDomain.EncryptionAtRestOptionsProperty.Enabled

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-encryptionatrestoptions.html#cfn-elasticsearch-domain-encryptionatrestoptions-enabled

Type:boolean or @aws-cdk/cdk.Token (optional)
kmsKeyId

CfnDomain.EncryptionAtRestOptionsProperty.KmsKeyId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-encryptionatrestoptions.html#cfn-elasticsearch-domain-encryptionatrestoptions-kmskeyid

Type:string (optional)
class NodeToNodeEncryptionOptionsProperty

Language-specific names:

using Amazon.CDK.AWS.Elasticsearch;
import software.amazon.awscdk.services.elasticsearch.CfnDomain.NodeToNodeEncryptionOptionsProperty;
// CfnDomain.NodeToNodeEncryptionOptionsProperty is an interface
import { CfnDomain.NodeToNodeEncryptionOptionsProperty } from '@aws-cdk/aws-elasticsearch';
enabled

CfnDomain.NodeToNodeEncryptionOptionsProperty.Enabled

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-nodetonodeencryptionoptions.html#cfn-elasticsearch-domain-nodetonodeencryptionoptions-enabled

Type:boolean or @aws-cdk/cdk.Token (optional)
class SnapshotOptionsProperty

Language-specific names:

using Amazon.CDK.AWS.Elasticsearch;
import software.amazon.awscdk.services.elasticsearch.CfnDomain.SnapshotOptionsProperty;
// CfnDomain.SnapshotOptionsProperty is an interface
import { CfnDomain.SnapshotOptionsProperty } from '@aws-cdk/aws-elasticsearch';
automatedSnapshotStartHour

CfnDomain.SnapshotOptionsProperty.AutomatedSnapshotStartHour

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-snapshotoptions.html#cfn-elasticsearch-domain-snapshotoptions-automatedsnapshotstarthour

Type:number or @aws-cdk/cdk.Token (optional)
class VPCOptionsProperty

Language-specific names:

using Amazon.CDK.AWS.Elasticsearch;
import software.amazon.awscdk.services.elasticsearch.CfnDomain.VPCOptionsProperty;
// CfnDomain.VPCOptionsProperty is an interface
import { CfnDomain.VPCOptionsProperty } from '@aws-cdk/aws-elasticsearch';
securityGroupIds

CfnDomain.VPCOptionsProperty.SecurityGroupIds

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-vpcoptions.html#cfn-elasticsearch-domain-vpcoptions-securitygroupids

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
subnetIds

CfnDomain.VPCOptionsProperty.SubnetIds

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-vpcoptions.html#cfn-elasticsearch-domain-vpcoptions-subnetids

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

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).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

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.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

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).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnDomainProps (interface)

class @aws-cdk/aws-elasticsearch.CfnDomainProps

Language-specific names:

using Amazon.CDK.AWS.Elasticsearch;
import software.amazon.awscdk.services.elasticsearch.CfnDomainProps;
// CfnDomainProps is an interface
import { CfnDomainProps } from '@aws-cdk/aws-elasticsearch';
accessPolicies

AWS::Elasticsearch::Domain.AccessPolicies

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-accesspolicies

Type:json or @aws-cdk/cdk.Token (optional)
advancedOptions

AWS::Elasticsearch::Domain.AdvancedOptions

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-advancedoptions

Type:@aws-cdk/cdk.Token or string => (string or @aws-cdk/cdk.Token) (optional)
domainName

AWS::Elasticsearch::Domain.DomainName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-domainname

Type:string (optional)
ebsOptions

AWS::Elasticsearch::Domain.EBSOptions

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-ebsoptions

Type:@aws-cdk/cdk.Token or EBSOptionsProperty (optional)
elasticsearchClusterConfig

AWS::Elasticsearch::Domain.ElasticsearchClusterConfig

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-elasticsearchclusterconfig

Type:@aws-cdk/cdk.Token or ElasticsearchClusterConfigProperty (optional)
elasticsearchVersion

AWS::Elasticsearch::Domain.ElasticsearchVersion

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-elasticsearchversion

Type:string (optional)
encryptionAtRestOptions

AWS::Elasticsearch::Domain.EncryptionAtRestOptions

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-encryptionatrestoptions

Type:@aws-cdk/cdk.Token or EncryptionAtRestOptionsProperty (optional)
nodeToNodeEncryptionOptions

AWS::Elasticsearch::Domain.NodeToNodeEncryptionOptions

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-nodetonodeencryptionoptions

Type:@aws-cdk/cdk.Token or NodeToNodeEncryptionOptionsProperty (optional)
snapshotOptions

AWS::Elasticsearch::Domain.SnapshotOptions

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-snapshotoptions

Type:@aws-cdk/cdk.Token or SnapshotOptionsProperty (optional)
tags

AWS::Elasticsearch::Domain.Tags

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-tags

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or @aws-cdk/cdk.CfnTag)[] (optional)
vpcOptions

AWS::Elasticsearch::Domain.VPCOptions

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticsearch-domain.html#cfn-elasticsearch-domain-vpcoptions

Type:@aws-cdk/cdk.Token or VPCOptionsProperty (optional)