elasticacheCluster.md

elasticacheCluster Submodule

Constructs

ElasticacheCluster

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster aws_elasticache_cluster}.

Initializers

import { elasticacheCluster } from '@cdktf/aws-cdk'

new elasticacheCluster.ElasticacheCluster(scope: Construct, id: string, config: ElasticacheClusterConfig)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	string	The scoped construct ID.
config	ElasticacheClusterConfig	No description.

---

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

id^Required

• Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

config^Required

• Type: ElasticacheClusterConfig

---

Methods

Name	Description
toString	Returns a string representation of this construct.
addOverride	No description.
overrideLogicalId	Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId	Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform	No description.
toMetadata	No description.
toTerraform	Adds this resource to the terraform JSON output.
addMoveTarget	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
hasResourceMove	No description.
importFrom	No description.
interpolationForAttribute	No description.
moveFromId	Move the resource corresponding to "id" to this resource.
moveTo	Moves this resource to the target resource given by moveTarget.
moveToId	Moves this resource to the resource corresponding to "id".
resetApplyImmediately	No description.
resetAvailabilityZone	No description.
resetAzMode	No description.
resetEngine	No description.
resetEngineVersion	No description.
resetFinalSnapshotIdentifier	No description.
resetId	No description.
resetMaintenanceWindow	No description.
resetNodeType	No description.
resetNotificationTopicArn	No description.
resetNumCacheNodes	No description.
resetParameterGroupName	No description.
resetPort	No description.
resetPreferredAvailabilityZones	No description.
resetReplicationGroupId	No description.
resetSecurityGroupIds	No description.
resetSecurityGroupNames	No description.
resetSnapshotArns	No description.
resetSnapshotName	No description.
resetSnapshotRetentionLimit	No description.
resetSnapshotWindow	No description.
resetSubnetGroupName	No description.
resetTags	No description.
resetTagsAll	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

addOverride

public addOverride(path: string, value: any): void

path^Required

• Type: string

---

value^Required

• Type: any

---

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

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

newLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

---

resetOverrideLogicalId

public resetOverrideLogicalId(): void

Resets a previously passed logical Id to use the auto-generated logical id again.

toHclTerraform

public toHclTerraform(): any

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

Adds this resource to the terraform JSON output.

addMoveTarget

public addMoveTarget(moveTarget: string): void

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTarget^Required

• Type: string

The string move target that will correspond to this resource.

---

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

hasResourceMove

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

importFrom

public importFrom(id: string, provider?: TerraformProvider): void

id^Required

• Type: string

---

provider^Optional

• Type: cdktf.TerraformProvider

---

interpolationForAttribute

public interpolationForAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

moveFromId

public moveFromId(id: string): void

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

id^Required

• Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

---

moveTo

public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

moveTarget^Required

• Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

---

index^Optional

• Type: string | number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

---

moveToId

public moveToId(id: string): void

Moves this resource to the resource corresponding to "id".

id^Required

• Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

---

resetApplyImmediately

public resetApplyImmediately(): void

resetAvailabilityZone

public resetAvailabilityZone(): void

resetAzMode

public resetAzMode(): void

resetEngine

public resetEngine(): void

resetEngineVersion

public resetEngineVersion(): void

resetFinalSnapshotIdentifier

public resetFinalSnapshotIdentifier(): void

resetId

public resetId(): void

resetMaintenanceWindow

public resetMaintenanceWindow(): void

resetNodeType

public resetNodeType(): void

resetNotificationTopicArn

public resetNotificationTopicArn(): void

resetNumCacheNodes

public resetNumCacheNodes(): void

resetParameterGroupName

public resetParameterGroupName(): void

resetPort

public resetPort(): void

resetPreferredAvailabilityZones

public resetPreferredAvailabilityZones(): void

resetReplicationGroupId

public resetReplicationGroupId(): void

resetSecurityGroupIds

public resetSecurityGroupIds(): void

resetSecurityGroupNames

public resetSecurityGroupNames(): void

resetSnapshotArns

public resetSnapshotArns(): void

resetSnapshotName

public resetSnapshotName(): void

resetSnapshotRetentionLimit

public resetSnapshotRetentionLimit(): void

resetSnapshotWindow

public resetSnapshotWindow(): void

resetSubnetGroupName

public resetSubnetGroupName(): void

resetTags

public resetTags(): void

resetTagsAll

public resetTagsAll(): void

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isTerraformElement	No description.
isTerraformResource	No description.
generateConfigForImport	Generates CDKTF code for importing a ElasticacheCluster resource upon running "cdktf plan ".

---

isConstruct

import { elasticacheCluster } from '@cdktf/aws-cdk'

elasticacheCluster.ElasticacheCluster.isConstruct(x: any)

Checks if x is a construct.

x^Required

• Type: any

Any object.

---

isTerraformElement

import { elasticacheCluster } from '@cdktf/aws-cdk'

elasticacheCluster.ElasticacheCluster.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

import { elasticacheCluster } from '@cdktf/aws-cdk'

elasticacheCluster.ElasticacheCluster.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

import { elasticacheCluster } from '@cdktf/aws-cdk'

elasticacheCluster.ElasticacheCluster.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a ElasticacheCluster resource upon running "cdktf plan ".

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

importToId^Required

• Type: string

The construct id used in the generated config for the ElasticacheCluster to import.

---

importFromId^Required

• Type: string

The id of the existing ElasticacheCluster that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#import import section} in the documentation of this resource for the id to use

---

provider^Optional

• Type: cdktf.TerraformProvider

? Optional instance of the provider where the ElasticacheCluster to import is found.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
cdktfStack	cdktf.TerraformStack	No description.
fqn	string	No description.
friendlyUniqueId	string	No description.
terraformMetaArguments	{[ key: string ]: any}	No description.
terraformResourceType	string	No description.
terraformGeneratorMetadata	cdktf.TerraformProviderGeneratorMetadata	No description.
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	No description.
count	number | cdktf.TerraformCount	No description.
dependsOn	string[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
arn	string	No description.
cacheNodes	ElasticacheClusterCacheNodesList	No description.
clusterAddress	string	No description.
configurationEndpoint	string	No description.
engineVersionActual	string	No description.
applyImmediatelyInput	boolean | cdktf.IResolvable	No description.
availabilityZoneInput	string	No description.
azModeInput	string	No description.
clusterIdInput	string	No description.
engineInput	string	No description.
engineVersionInput	string	No description.
finalSnapshotIdentifierInput	string	No description.
idInput	string	No description.
maintenanceWindowInput	string	No description.
nodeTypeInput	string	No description.
notificationTopicArnInput	string	No description.
numCacheNodesInput	number	No description.
parameterGroupNameInput	string	No description.
portInput	number	No description.
preferredAvailabilityZonesInput	string[]	No description.
replicationGroupIdInput	string	No description.
securityGroupIdsInput	string[]	No description.
securityGroupNamesInput	string[]	No description.
snapshotArnsInput	string[]	No description.
snapshotNameInput	string	No description.
snapshotRetentionLimitInput	number	No description.
snapshotWindowInput	string	No description.
subnetGroupNameInput	string	No description.
tagsAllInput	{[ key: string ]: string}	No description.
tagsInput	{[ key: string ]: string}	No description.
applyImmediately	boolean | cdktf.IResolvable	No description.
availabilityZone	string	No description.
azMode	string	No description.
clusterId	string	No description.
engine	string	No description.
engineVersion	string	No description.
finalSnapshotIdentifier	string	No description.
id	string	No description.
maintenanceWindow	string	No description.
nodeType	string	No description.
notificationTopicArn	string	No description.
numCacheNodes	number	No description.
parameterGroupName	string	No description.
port	number	No description.
preferredAvailabilityZones	string[]	No description.
replicationGroupId	string	No description.
securityGroupIds	string[]	No description.
securityGroupNames	string[]	No description.
snapshotArns	string[]	No description.
snapshotName	string	No description.
snapshotRetentionLimit	number	No description.
snapshotWindow	string	No description.
subnetGroupName	string	No description.
tags	{[ key: string ]: string}	No description.
tagsAll	{[ key: string ]: string}	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: cdktf.TerraformStack

---

fqn^Required

public readonly fqn: string;

• Type: string

---

friendlyUniqueId^Required

public readonly friendlyUniqueId: string;

• Type: string

---

terraformMetaArguments^Required

public readonly terraformMetaArguments: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

terraformResourceType^Required

public readonly terraformResourceType: string;

• Type: string

---

terraformGeneratorMetadata^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

• Type: cdktf.TerraformProviderGeneratorMetadata

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: string[];

• Type: string[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

arn^Required

public readonly arn: string;

• Type: string

---

cacheNodes^Required

public readonly cacheNodes: ElasticacheClusterCacheNodesList;

• Type: ElasticacheClusterCacheNodesList

---

clusterAddress^Required

public readonly clusterAddress: string;

• Type: string

---

configurationEndpoint^Required

public readonly configurationEndpoint: string;

• Type: string

---

engineVersionActual^Required

public readonly engineVersionActual: string;

• Type: string

---

applyImmediatelyInput^Optional

public readonly applyImmediatelyInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

availabilityZoneInput^Optional

public readonly availabilityZoneInput: string;

• Type: string

---

azModeInput^Optional

public readonly azModeInput: string;

• Type: string

---

clusterIdInput^Optional

public readonly clusterIdInput: string;

• Type: string

---

engineInput^Optional

public readonly engineInput: string;

• Type: string

---

engineVersionInput^Optional

public readonly engineVersionInput: string;

• Type: string

---

finalSnapshotIdentifierInput^Optional

public readonly finalSnapshotIdentifierInput: string;

• Type: string

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

maintenanceWindowInput^Optional

public readonly maintenanceWindowInput: string;

• Type: string

---

nodeTypeInput^Optional

public readonly nodeTypeInput: string;

• Type: string

---

notificationTopicArnInput^Optional

public readonly notificationTopicArnInput: string;

• Type: string

---

numCacheNodesInput^Optional

public readonly numCacheNodesInput: number;

• Type: number

---

parameterGroupNameInput^Optional

public readonly parameterGroupNameInput: string;

• Type: string

---

portInput^Optional

public readonly portInput: number;

• Type: number

---

preferredAvailabilityZonesInput^Optional

public readonly preferredAvailabilityZonesInput: string[];

• Type: string[]

---

replicationGroupIdInput^Optional

public readonly replicationGroupIdInput: string;

• Type: string

---

securityGroupIdsInput^Optional

public readonly securityGroupIdsInput: string[];

• Type: string[]

---

securityGroupNamesInput^Optional

public readonly securityGroupNamesInput: string[];

• Type: string[]

---

snapshotArnsInput^Optional

public readonly snapshotArnsInput: string[];

• Type: string[]

---

snapshotNameInput^Optional

public readonly snapshotNameInput: string;

• Type: string

---

snapshotRetentionLimitInput^Optional

public readonly snapshotRetentionLimitInput: number;

• Type: number

---

snapshotWindowInput^Optional

public readonly snapshotWindowInput: string;

• Type: string

---

subnetGroupNameInput^Optional

public readonly subnetGroupNameInput: string;

• Type: string

---

tagsAllInput^Optional

public readonly tagsAllInput: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

tagsInput^Optional

public readonly tagsInput: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

applyImmediately^Required

public readonly applyImmediately: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

availabilityZone^Required

public readonly availabilityZone: string;

• Type: string

---

azMode^Required

public readonly azMode: string;

• Type: string

---

clusterId^Required

public readonly clusterId: string;

• Type: string

---

engine^Required

public readonly engine: string;

• Type: string

---

engineVersion^Required

public readonly engineVersion: string;

• Type: string

---

finalSnapshotIdentifier^Required

public readonly finalSnapshotIdentifier: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

maintenanceWindow^Required

public readonly maintenanceWindow: string;

• Type: string

---

nodeType^Required

public readonly nodeType: string;

• Type: string

---

notificationTopicArn^Required

public readonly notificationTopicArn: string;

• Type: string

---

numCacheNodes^Required

public readonly numCacheNodes: number;

• Type: number

---

parameterGroupName^Required

public readonly parameterGroupName: string;

• Type: string

---

port^Required

public readonly port: number;

• Type: number

---

preferredAvailabilityZones^Required

public readonly preferredAvailabilityZones: string[];

• Type: string[]

---

replicationGroupId^Required

public readonly replicationGroupId: string;

• Type: string

---

securityGroupIds^Required

public readonly securityGroupIds: string[];

• Type: string[]

---

securityGroupNames^Required

public readonly securityGroupNames: string[];

• Type: string[]

---

snapshotArns^Required

public readonly snapshotArns: string[];

• Type: string[]

---

snapshotName^Required

public readonly snapshotName: string;

• Type: string

---

snapshotRetentionLimit^Required

public readonly snapshotRetentionLimit: number;

• Type: number

---

snapshotWindow^Required

public readonly snapshotWindow: string;

• Type: string

---

subnetGroupName^Required

public readonly subnetGroupName: string;

• Type: string

---

tags^Required

public readonly tags: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

tagsAll^Required

public readonly tagsAll: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

ElasticacheClusterCacheNodes

Initializer

import { elasticacheCluster } from '@cdktf/aws-cdk'

const elasticacheClusterCacheNodes: elasticacheCluster.ElasticacheClusterCacheNodes = { ... }

ElasticacheClusterConfig

Initializer

import { elasticacheCluster } from '@cdktf/aws-cdk'

const elasticacheClusterConfig: elasticacheCluster.ElasticacheClusterConfig = { ... }

Properties

Name	Type	Description
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	No description.
count	number | cdktf.TerraformCount	No description.
dependsOn	cdktf.ITerraformDependable[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
clusterId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#cluster_id ElasticacheCluster#cluster_id}.
applyImmediately	boolean | cdktf.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#apply_immediately ElasticacheCluster#apply_immediately}.
availabilityZone	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#availability_zone ElasticacheCluster#availability_zone}.
azMode	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#az_mode ElasticacheCluster#az_mode}.
engine	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#engine ElasticacheCluster#engine}.
engineVersion	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#engine_version ElasticacheCluster#engine_version}.
finalSnapshotIdentifier	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#final_snapshot_identifier ElasticacheCluster#final_snapshot_identifier}.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#id ElasticacheCluster#id}.
maintenanceWindow	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#maintenance_window ElasticacheCluster#maintenance_window}.
nodeType	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#node_type ElasticacheCluster#node_type}.
notificationTopicArn	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#notification_topic_arn ElasticacheCluster#notification_topic_arn}.
numCacheNodes	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#num_cache_nodes ElasticacheCluster#num_cache_nodes}.
parameterGroupName	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#parameter_group_name ElasticacheCluster#parameter_group_name}.
port	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#port ElasticacheCluster#port}.
preferredAvailabilityZones	string[]	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#preferred_availability_zones ElasticacheCluster#preferred_availability_zones}.
replicationGroupId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#replication_group_id ElasticacheCluster#replication_group_id}.
securityGroupIds	string[]	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#security_group_ids ElasticacheCluster#security_group_ids}.
securityGroupNames	string[]	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#security_group_names ElasticacheCluster#security_group_names}.
snapshotArns	string[]	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#snapshot_arns ElasticacheCluster#snapshot_arns}.
snapshotName	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#snapshot_name ElasticacheCluster#snapshot_name}.
snapshotRetentionLimit	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#snapshot_retention_limit ElasticacheCluster#snapshot_retention_limit}.
snapshotWindow	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#snapshot_window ElasticacheCluster#snapshot_window}.
subnetGroupName	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#subnet_group_name ElasticacheCluster#subnet_group_name}.
tags	{[ key: string ]: string}	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#tags ElasticacheCluster#tags}.
tagsAll	{[ key: string ]: string}	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#tags_all ElasticacheCluster#tags_all}.

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: ITerraformDependable[];

• Type: cdktf.ITerraformDependable[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

clusterId^Required

public readonly clusterId: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#cluster_id ElasticacheCluster#cluster_id}.

---

applyImmediately^Optional

public readonly applyImmediately: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#apply_immediately ElasticacheCluster#apply_immediately}.

---

availabilityZone^Optional

public readonly availabilityZone: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#availability_zone ElasticacheCluster#availability_zone}.

---

azMode^Optional

public readonly azMode: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#az_mode ElasticacheCluster#az_mode}.

---

engine^Optional

public readonly engine: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#engine ElasticacheCluster#engine}.

---

engineVersion^Optional

public readonly engineVersion: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#engine_version ElasticacheCluster#engine_version}.

---

finalSnapshotIdentifier^Optional

public readonly finalSnapshotIdentifier: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#final_snapshot_identifier ElasticacheCluster#final_snapshot_identifier}.

---

id^Optional

public readonly id: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#id ElasticacheCluster#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

---

maintenanceWindow^Optional

public readonly maintenanceWindow: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#maintenance_window ElasticacheCluster#maintenance_window}.

---

nodeType^Optional

public readonly nodeType: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#node_type ElasticacheCluster#node_type}.

---

notificationTopicArn^Optional

public readonly notificationTopicArn: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#notification_topic_arn ElasticacheCluster#notification_topic_arn}.

---

numCacheNodes^Optional

public readonly numCacheNodes: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#num_cache_nodes ElasticacheCluster#num_cache_nodes}.

---

parameterGroupName^Optional

public readonly parameterGroupName: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#parameter_group_name ElasticacheCluster#parameter_group_name}.

---

port^Optional

public readonly port: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#port ElasticacheCluster#port}.

---

preferredAvailabilityZones^Optional

public readonly preferredAvailabilityZones: string[];

• Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#preferred_availability_zones ElasticacheCluster#preferred_availability_zones}.

---

replicationGroupId^Optional

public readonly replicationGroupId: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#replication_group_id ElasticacheCluster#replication_group_id}.

---

securityGroupIds^Optional

public readonly securityGroupIds: string[];

• Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#security_group_ids ElasticacheCluster#security_group_ids}.

---

securityGroupNames^Optional

public readonly securityGroupNames: string[];

• Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#security_group_names ElasticacheCluster#security_group_names}.

---

snapshotArns^Optional

public readonly snapshotArns: string[];

• Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#snapshot_arns ElasticacheCluster#snapshot_arns}.

---

snapshotName^Optional

public readonly snapshotName: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#snapshot_name ElasticacheCluster#snapshot_name}.

---

snapshotRetentionLimit^Optional

public readonly snapshotRetentionLimit: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#snapshot_retention_limit ElasticacheCluster#snapshot_retention_limit}.

---

snapshotWindow^Optional

public readonly snapshotWindow: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#snapshot_window ElasticacheCluster#snapshot_window}.

---

subnetGroupName^Optional

public readonly subnetGroupName: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#subnet_group_name ElasticacheCluster#subnet_group_name}.

---

tags^Optional

public readonly tags: {[ key: string ]: string};

• Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#tags ElasticacheCluster#tags}.

---

tagsAll^Optional

public readonly tagsAll: {[ key: string ]: string};

• Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/elasticache_cluster#tags_all ElasticacheCluster#tags_all}.

---

Classes

ElasticacheClusterCacheNodesList

Initializers

import { elasticacheCluster } from '@cdktf/aws-cdk'

new elasticacheCluster.ElasticacheClusterCacheNodesList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.
wrapsSet	boolean	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

wrapsSet^Required

• Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

Methods

Name	Description
allWithMapKey	Creating an iterator for this complex list.
computeFqn	No description.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.
get	No description.

---

allWithMapKey

public allWithMapKey(mapKeyAttributeName: string): DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

mapKeyAttributeName^Required

• Type: string

---

computeFqn

public computeFqn(): string

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

get

public get(index: number): ElasticacheClusterCacheNodesOutputReference

index^Required

• Type: number

the index of the item to return.

---

Properties

Name	Type	Description
creationStack	string[]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	string	No description.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

ElasticacheClusterCacheNodesOutputReference

Initializers

import { elasticacheCluster } from '@cdktf/aws-cdk'

new elasticacheCluster.ElasticacheClusterCacheNodesOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.
complexObjectIndex	number	the index of this item in the list.
complexObjectIsFromSet	boolean	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

complexObjectIndex^Required

• Type: number

the index of this item in the list.

---

complexObjectIsFromSet^Required

• Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

Methods

Name	Description
computeFqn	No description.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
interpolationForAttribute	No description.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.

---

computeFqn

public computeFqn(): string

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

---

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name	Type	Description
creationStack	string[]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	string	No description.
address	string	No description.
availabilityZone	string	No description.
id	string	No description.
port	number	No description.
internalValue	ElasticacheClusterCacheNodes	No description.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

address^Required

public readonly address: string;

• Type: string

---

availabilityZone^Required

public readonly availabilityZone: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

port^Required

public readonly port: number;

• Type: number

---

internalValue^Optional

public readonly internalValue: ElasticacheClusterCacheNodes;

• Type: ElasticacheClusterCacheNodes

---