aws-cdk-lib
Version:
Version 2 of the AWS Cloud Development Kit library
1,041 lines • 176 kB
TypeScript
import * as cdk from "../../core/lib";
import * as constructs from "constructs";
import * as cfn_parse from "../../core/lib/helpers-internal";
import { CacheClusterReference, GlobalReplicationGroupReference, ICacheClusterRef, IGlobalReplicationGroupRef, IParameterGroupRef, IReplicationGroupRef, ISecurityGroupIngressRef, ISecurityGroupRef, IServerlessCacheRef, ISubnetGroupRef, IUserGroupRef, IUserRef, ParameterGroupReference, ReplicationGroupReference, SecurityGroupIngressReference, SecurityGroupReference, ServerlessCacheReference, SubnetGroupReference, UserGroupReference, UserReference } from "../../interfaces/generated/aws-elasticache-interfaces.generated";
import { aws_ec2 as ec2Refs, aws_elasticache as elastiCacheRefs, aws_kms as kmsRefs } from "../../interfaces";
/**
* The `AWS::ElastiCache::CacheCluster` type creates an Amazon ElastiCache cache cluster.
*
* @cloudformationResource AWS::ElastiCache::CacheCluster
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html
*/
export declare class CfnCacheCluster extends cdk.CfnResource implements cdk.IInspectable, ICacheClusterRef, cdk.ITaggable {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnCacheCluster from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnCacheCluster;
/**
* Checks whether the given object is a CfnCacheCluster
*/
static isCfnCacheCluster(x: any): x is CfnCacheCluster;
/**
* If you are running Valkey 7.2 or later, or Redis OSS engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next minor version upgrade campaign. This parameter is disabled for previous versions.
*/
private _autoMinorVersionUpgrade?;
/**
* Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.
*/
private _azMode?;
/**
* The compute and memory capacity of the nodes in the node group (shard).
*/
private _cacheNodeType;
/**
* The name of the parameter group to associate with this cluster.
*/
private _cacheParameterGroupName?;
/**
* A list of security group names to associate with this cluster.
*/
private _cacheSecurityGroupNames?;
/**
* The name of the subnet group to be used for the cluster.
*/
private _cacheSubnetGroupName?;
/**
* A name for the cache cluster.
*/
private _clusterName?;
/**
* The name of the cache engine to be used for this cluster.
*/
private _engine;
/**
* The version number of the cache engine to be used for this cluster.
*/
private _engineVersion?;
/**
* The network type you choose when modifying a cluster, either `ipv4` | `ipv6` .
*/
private _ipDiscovery?;
/**
* Specifies the destination, format and type of the logs.
*/
private _logDeliveryConfigurations?;
/**
* Must be either `ipv4` | `ipv6` | `dual_stack` .
*/
private _networkType?;
/**
* The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
*/
private _notificationTopicArn?;
/**
* The number of cache nodes that the cache cluster should have.
*/
private _numCacheNodes;
/**
* The port number on which each of the cache nodes accepts connections.
*/
private _port?;
/**
* The EC2 Availability Zone in which the cluster is created.
*/
private _preferredAvailabilityZone?;
/**
* A list of the Availability Zones in which cache nodes are created.
*/
private _preferredAvailabilityZones?;
/**
* Specifies the weekly time range during which maintenance on the cluster is performed.
*/
private _preferredMaintenanceWindow?;
/**
* A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Valkey or Redis OSS RDB snapshot file stored in Amazon S3.
*/
private _snapshotArns?;
/**
* The name of a Valkey or Redis OSS snapshot from which to restore data into the new node group (shard).
*/
private _snapshotName?;
/**
* The number of days for which ElastiCache retains automatic snapshots before deleting them.
*/
private _snapshotRetentionLimit?;
/**
* The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
*/
private _snapshotWindow?;
/**
* Tag Manager which manages the tags for this resource
*/
readonly tags: cdk.TagManager;
/**
* A list of tags to be added to this resource.
*/
private _tagsRaw?;
/**
* A flag that enables in-transit encryption when set to true.
*/
private _transitEncryptionEnabled?;
/**
* One or more VPC security groups associated with the cluster.
*/
private _vpcSecurityGroupIds?;
/**
* Create a new `AWS::ElastiCache::CacheCluster`.
*
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnCacheClusterProps);
get cacheClusterRef(): CacheClusterReference;
/**
* If you are running Valkey 7.2 or later, or Redis OSS engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next minor version upgrade campaign. This parameter is disabled for previous versions.
*/
get autoMinorVersionUpgrade(): boolean | cdk.IResolvable | undefined;
/**
* If you are running Valkey 7.2 or later, or Redis OSS engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next minor version upgrade campaign. This parameter is disabled for previous versions.
*/
set autoMinorVersionUpgrade(value: boolean | cdk.IResolvable | undefined);
/**
* Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.
*/
get azMode(): string | undefined;
/**
* Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.
*/
set azMode(value: string | undefined);
/**
* The compute and memory capacity of the nodes in the node group (shard).
*/
get cacheNodeType(): string;
/**
* The compute and memory capacity of the nodes in the node group (shard).
*/
set cacheNodeType(value: string);
/**
* The name of the parameter group to associate with this cluster.
*/
get cacheParameterGroupName(): string | undefined;
/**
* The name of the parameter group to associate with this cluster.
*/
set cacheParameterGroupName(value: string | undefined);
/**
* A list of security group names to associate with this cluster.
*/
get cacheSecurityGroupNames(): Array<string> | undefined;
/**
* A list of security group names to associate with this cluster.
*/
set cacheSecurityGroupNames(value: Array<string> | undefined);
/**
* The name of the subnet group to be used for the cluster.
*/
get cacheSubnetGroupName(): string | undefined;
/**
* The name of the subnet group to be used for the cluster.
*/
set cacheSubnetGroupName(value: string | undefined);
/**
* A name for the cache cluster.
*/
get clusterName(): string | undefined;
/**
* A name for the cache cluster.
*/
set clusterName(value: string | undefined);
/**
* The name of the cache engine to be used for this cluster.
*/
get engine(): string;
/**
* The name of the cache engine to be used for this cluster.
*/
set engine(value: string);
/**
* The version number of the cache engine to be used for this cluster.
*/
get engineVersion(): string | undefined;
/**
* The version number of the cache engine to be used for this cluster.
*/
set engineVersion(value: string | undefined);
/**
* The network type you choose when modifying a cluster, either `ipv4` | `ipv6` .
*/
get ipDiscovery(): string | undefined;
/**
* The network type you choose when modifying a cluster, either `ipv4` | `ipv6` .
*/
set ipDiscovery(value: string | undefined);
/**
* Specifies the destination, format and type of the logs.
*/
get logDeliveryConfigurations(): Array<cdk.IResolvable | CfnCacheCluster.LogDeliveryConfigurationRequestProperty> | cdk.IResolvable | undefined;
/**
* Specifies the destination, format and type of the logs.
*/
set logDeliveryConfigurations(value: Array<cdk.IResolvable | CfnCacheCluster.LogDeliveryConfigurationRequestProperty> | cdk.IResolvable | undefined);
/**
* Must be either `ipv4` | `ipv6` | `dual_stack` .
*/
get networkType(): string | undefined;
/**
* Must be either `ipv4` | `ipv6` | `dual_stack` .
*/
set networkType(value: string | undefined);
/**
* The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
*/
get notificationTopicArn(): string | undefined;
/**
* The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
*/
set notificationTopicArn(value: string | undefined);
/**
* The number of cache nodes that the cache cluster should have.
*/
get numCacheNodes(): number;
/**
* The number of cache nodes that the cache cluster should have.
*/
set numCacheNodes(value: number);
/**
* The port number on which each of the cache nodes accepts connections.
*/
get port(): number | undefined;
/**
* The port number on which each of the cache nodes accepts connections.
*/
set port(value: number | undefined);
/**
* The EC2 Availability Zone in which the cluster is created.
*/
get preferredAvailabilityZone(): string | undefined;
/**
* The EC2 Availability Zone in which the cluster is created.
*/
set preferredAvailabilityZone(value: string | undefined);
/**
* A list of the Availability Zones in which cache nodes are created.
*/
get preferredAvailabilityZones(): Array<string> | undefined;
/**
* A list of the Availability Zones in which cache nodes are created.
*/
set preferredAvailabilityZones(value: Array<string> | undefined);
/**
* Specifies the weekly time range during which maintenance on the cluster is performed.
*/
get preferredMaintenanceWindow(): string | undefined;
/**
* Specifies the weekly time range during which maintenance on the cluster is performed.
*/
set preferredMaintenanceWindow(value: string | undefined);
/**
* A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Valkey or Redis OSS RDB snapshot file stored in Amazon S3.
*/
get snapshotArns(): Array<string> | undefined;
/**
* A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Valkey or Redis OSS RDB snapshot file stored in Amazon S3.
*/
set snapshotArns(value: Array<string> | undefined);
/**
* The name of a Valkey or Redis OSS snapshot from which to restore data into the new node group (shard).
*/
get snapshotName(): string | undefined;
/**
* The name of a Valkey or Redis OSS snapshot from which to restore data into the new node group (shard).
*/
set snapshotName(value: string | undefined);
/**
* The number of days for which ElastiCache retains automatic snapshots before deleting them.
*/
get snapshotRetentionLimit(): number | undefined;
/**
* The number of days for which ElastiCache retains automatic snapshots before deleting them.
*/
set snapshotRetentionLimit(value: number | undefined);
/**
* The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
*/
get snapshotWindow(): string | undefined;
/**
* The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
*/
set snapshotWindow(value: string | undefined);
/**
* A list of tags to be added to this resource.
*/
get tagsRaw(): Array<cdk.CfnTag> | undefined;
/**
* A list of tags to be added to this resource.
*/
set tagsRaw(value: Array<cdk.CfnTag> | undefined);
/**
* A flag that enables in-transit encryption when set to true.
*/
get transitEncryptionEnabled(): boolean | cdk.IResolvable | undefined;
/**
* A flag that enables in-transit encryption when set to true.
*/
set transitEncryptionEnabled(value: boolean | cdk.IResolvable | undefined);
/**
* One or more VPC security groups associated with the cluster.
*/
get vpcSecurityGroupIds(): Array<string> | undefined;
/**
* One or more VPC security groups associated with the cluster.
*/
set vpcSecurityGroupIds(value: Array<string> | undefined);
/**
* The DNS hostname of the cache node.
*
* > Valkey and Redis OSS (cluster mode disabled) replication groups don't have this attribute. Therefore, `Fn::GetAtt` returns a value for this attribute only if the replication group is clustered. Otherwise, `Fn::GetAtt` fails.
*
* @cloudformationAttribute ConfigurationEndpoint.Address
*/
get attrConfigurationEndpointAddress(): string;
/**
* The port number of the configuration endpoint for the Memcached cache cluster.
*
* > Valkey and Redis OSS (cluster mode disabled) replication groups don't have this attribute. Therefore, `Fn::GetAtt` returns a value for this attribute only if the replication group is clustered. Otherwise, `Fn::GetAtt` fails.
*
* @cloudformationAttribute ConfigurationEndpoint.Port
*/
get attrConfigurationEndpointPort(): string;
/**
* The resource name.
*
* @cloudformationAttribute Id
*/
get attrId(): string;
/**
* The DNS address of the configuration endpoint for the Valkey or Redis OSS cache cluster.
*
* @cloudformationAttribute RedisEndpoint.Address
*/
get attrRedisEndpointAddress(): string;
/**
* The port number of the configuration endpoint for the Valkey or Redis OSS cache cluster.
*
* @cloudformationAttribute RedisEndpoint.Port
*/
get attrRedisEndpointPort(): string;
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
export declare namespace CfnCacheCluster {
/**
* Specifies the destination, format and type of the logs.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cachecluster-logdeliveryconfigurationrequest.html
*/
interface LogDeliveryConfigurationRequestProperty {
/**
* Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cachecluster-logdeliveryconfigurationrequest.html#cfn-elasticache-cachecluster-logdeliveryconfigurationrequest-destinationdetails
*/
readonly destinationDetails: CfnCacheCluster.DestinationDetailsProperty | cdk.IResolvable;
/**
* Specify either CloudWatch Logs or Kinesis Data Firehose as the destination type.
*
* Valid values are either `cloudwatch-logs` or `kinesis-firehose` .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cachecluster-logdeliveryconfigurationrequest.html#cfn-elasticache-cachecluster-logdeliveryconfigurationrequest-destinationtype
*/
readonly destinationType: string;
/**
* Valid values are either `json` or `text` .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cachecluster-logdeliveryconfigurationrequest.html#cfn-elasticache-cachecluster-logdeliveryconfigurationrequest-logformat
*/
readonly logFormat: string;
/**
* Valid value is either `slow-log` , which refers to [slow-log](https://docs.aws.amazon.com/https://redis.io/commands/slowlog) or `engine-log` .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cachecluster-logdeliveryconfigurationrequest.html#cfn-elasticache-cachecluster-logdeliveryconfigurationrequest-logtype
*/
readonly logType: string;
}
/**
* Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cachecluster-destinationdetails.html
*/
interface DestinationDetailsProperty {
/**
* The configuration details of the CloudWatch Logs destination.
*
* Note that this field is marked as required but only if CloudWatch Logs was chosen as the destination.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cachecluster-destinationdetails.html#cfn-elasticache-cachecluster-destinationdetails-cloudwatchlogsdetails
*/
readonly cloudWatchLogsDetails?: CfnCacheCluster.CloudWatchLogsDestinationDetailsProperty | cdk.IResolvable;
/**
* The configuration details of the Kinesis Data Firehose destination.
*
* Note that this field is marked as required but only if Kinesis Data Firehose was chosen as the destination.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cachecluster-destinationdetails.html#cfn-elasticache-cachecluster-destinationdetails-kinesisfirehosedetails
*/
readonly kinesisFirehoseDetails?: cdk.IResolvable | CfnCacheCluster.KinesisFirehoseDestinationDetailsProperty;
}
/**
* Configuration details of a CloudWatch Logs destination.
*
* Note that this field is marked as required but only if CloudWatch Logs was chosen as the destination.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cachecluster-cloudwatchlogsdestinationdetails.html
*/
interface CloudWatchLogsDestinationDetailsProperty {
/**
* The name of the CloudWatch Logs log group.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cachecluster-cloudwatchlogsdestinationdetails.html#cfn-elasticache-cachecluster-cloudwatchlogsdestinationdetails-loggroup
*/
readonly logGroup: string;
}
/**
* The configuration details of the Kinesis Data Firehose destination.
*
* Note that this field is marked as required but only if Kinesis Data Firehose was chosen as the destination.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cachecluster-kinesisfirehosedestinationdetails.html
*/
interface KinesisFirehoseDestinationDetailsProperty {
/**
* The name of the Kinesis Data Firehose delivery stream.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cachecluster-kinesisfirehosedestinationdetails.html#cfn-elasticache-cachecluster-kinesisfirehosedestinationdetails-deliverystream
*/
readonly deliveryStream: string;
}
}
/**
* Properties for defining a `CfnCacheCluster`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html
*/
export interface CfnCacheClusterProps {
/**
* If you are running Valkey 7.2 or later, or Redis OSS engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next minor version upgrade campaign. This parameter is disabled for previous versions.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-autominorversionupgrade
*/
readonly autoMinorVersionUpgrade?: boolean | cdk.IResolvable;
/**
* Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.
*
* This parameter is only supported for Memcached clusters.
*
* If the `AZMode` and `PreferredAvailabilityZones` are not specified, ElastiCache assumes `single-az` mode.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-azmode
*/
readonly azMode?: string;
/**
* The compute and memory capacity of the nodes in the node group (shard).
*
* The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. Changing the CacheNodeType of a Memcached instance is currently not supported. If you need to scale using Memcached, we recommend forcing a replacement update by changing the `LogicalResourceId` of the resource.
*
* - General purpose:
*
* - Current generation:
*
* *M6g node types:* `cache.m6g.large` , `cache.m6g.xlarge` , `cache.m6g.2xlarge` , `cache.m6g.4xlarge` , `cache.m6g.8xlarge` , `cache.m6g.12xlarge` , `cache.m6g.16xlarge` , `cache.m6g.24xlarge`
*
* *M5 node types:* `cache.m5.large` , `cache.m5.xlarge` , `cache.m5.2xlarge` , `cache.m5.4xlarge` , `cache.m5.12xlarge` , `cache.m5.24xlarge`
*
* *M4 node types:* `cache.m4.large` , `cache.m4.xlarge` , `cache.m4.2xlarge` , `cache.m4.4xlarge` , `cache.m4.10xlarge`
*
* *T4g node types:* `cache.t4g.micro` , `cache.t4g.small` , `cache.t4g.medium`
*
* *T3 node types:* `cache.t3.micro` , `cache.t3.small` , `cache.t3.medium`
*
* *T2 node types:* `cache.t2.micro` , `cache.t2.small` , `cache.t2.medium`
* - Previous generation: (not recommended)
*
* *T1 node types:* `cache.t1.micro`
*
* *M1 node types:* `cache.m1.small` , `cache.m1.medium` , `cache.m1.large` , `cache.m1.xlarge`
*
* *M3 node types:* `cache.m3.medium` , `cache.m3.large` , `cache.m3.xlarge` , `cache.m3.2xlarge`
* - Compute optimized:
*
* - Previous generation: (not recommended)
*
* *C1 node types:* `cache.c1.xlarge`
* - Memory optimized:
*
* - Current generation:
*
* *R6gd node types:* `cache.r6gd.xlarge` , `cache.r6gd.2xlarge` , `cache.r6gd.4xlarge` , `cache.r6gd.8xlarge` , `cache.r6gd.12xlarge` , `cache.r6gd.16xlarge`
*
* > The `r6gd` family is available in the following regions: `us-east-2` , `us-east-1` , `us-west-2` , `us-west-1` , `eu-west-1` , `eu-central-1` , `ap-northeast-1` , `ap-southeast-1` , `ap-southeast-2` .
*
* *R6g node types:* `cache.r6g.large` , `cache.r6g.xlarge` , `cache.r6g.2xlarge` , `cache.r6g.4xlarge` , `cache.r6g.8xlarge` , `cache.r6g.12xlarge` , `cache.r6g.16xlarge` , `cache.r6g.24xlarge`
*
* *R5 node types:* `cache.r5.large` , `cache.r5.xlarge` , `cache.r5.2xlarge` , `cache.r5.4xlarge` , `cache.r5.12xlarge` , `cache.r5.24xlarge`
*
* *R4 node types:* `cache.r4.large` , `cache.r4.xlarge` , `cache.r4.2xlarge` , `cache.r4.4xlarge` , `cache.r4.8xlarge` , `cache.r4.16xlarge`
* - Previous generation: (not recommended)
*
* *M2 node types:* `cache.m2.xlarge` , `cache.m2.2xlarge` , `cache.m2.4xlarge`
*
* *R3 node types:* `cache.r3.large` , `cache.r3.xlarge` , `cache.r3.2xlarge` , `cache.r3.4xlarge` , `cache.r3.8xlarge`
*
* For region availability, see [Supported Node Types by Region](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
*
* *Additional node type info*
*
* - All current generation instance types are created in Amazon VPC by default.
* - Valkey and Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.
* - Valkey and Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.
* - Redis OSS configuration variables `appendonly` and `appendfsync` are not supported on Redis OSS version 2.8.22 and later.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-cachenodetype
*/
readonly cacheNodeType: string;
/**
* The name of the parameter group to associate with this cluster.
*
* If this argument is omitted, the default parameter group for the specified engine is used. You cannot use any parameter group which has `cluster-enabled='yes'` when creating a cluster.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-cacheparametergroupname
*/
readonly cacheParameterGroupName?: string;
/**
* A list of security group names to associate with this cluster.
*
* Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC).
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-cachesecuritygroupnames
*/
readonly cacheSecurityGroupNames?: Array<string>;
/**
* The name of the subnet group to be used for the cluster.
*
* Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
*
* > If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see `[AWS::ElastiCache::SubnetGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-subnetgroup.html) .`
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-cachesubnetgroupname
*/
readonly cacheSubnetGroupName?: string;
/**
* A name for the cache cluster.
*
* If you don't specify a name, CloudFormation generates a unique physical ID and uses that ID for the cache cluster. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) .
*
* The name must contain 1 to 50 alphanumeric characters or hyphens. The name must start with a letter and cannot end with a hyphen or contain two consecutive hyphens.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-clustername
*/
readonly clusterName?: string;
/**
* The name of the cache engine to be used for this cluster.
*
* Valid values for this parameter are: `memcached` | valkey | `redis`
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-engine
*/
readonly engine: string;
/**
* The version number of the cache engine to be used for this cluster.
*
* To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.
*
* *Important:* You can upgrade to a newer engine version (see [Selecting a Cache Engine and Version](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/SelectEngine.html#VersionManagement) ), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-engineversion
*/
readonly engineVersion?: string;
/**
* The network type you choose when modifying a cluster, either `ipv4` | `ipv6` .
*
* IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 and Memcached engine version 1.6.6 and above on all instances built on the [Nitro system](https://docs.aws.amazon.com/ec2/nitro/) .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-ipdiscovery
*/
readonly ipDiscovery?: string;
/**
* Specifies the destination, format and type of the logs.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-logdeliveryconfigurations
*/
readonly logDeliveryConfigurations?: Array<cdk.IResolvable | CfnCacheCluster.LogDeliveryConfigurationRequestProperty> | cdk.IResolvable;
/**
* Must be either `ipv4` | `ipv6` | `dual_stack` .
*
* IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 and Memcached engine version 1.6.6 and above on all instances built on the [Nitro system](https://docs.aws.amazon.com/ec2/nitro/) .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-networktype
*/
readonly networkType?: string;
/**
* The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
*
* > The Amazon SNS topic owner must be the same as the cluster owner.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-notificationtopicarn
*/
readonly notificationTopicArn?: string;
/**
* The number of cache nodes that the cache cluster should have.
*
* > However, if the `PreferredAvailabilityZone` and `PreferredAvailabilityZones` properties were not previously specified and you don't specify any new values, an update requires [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-numcachenodes
*/
readonly numCacheNodes: number;
/**
* The port number on which each of the cache nodes accepts connections.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-port
*/
readonly port?: number;
/**
* The EC2 Availability Zone in which the cluster is created.
*
* All nodes belonging to this cluster are placed in the preferred Availability Zone. If you want to create your nodes across multiple Availability Zones, use `PreferredAvailabilityZones` .
*
* Default: System chosen Availability Zone.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-preferredavailabilityzone
*/
readonly preferredAvailabilityZone?: string;
/**
* A list of the Availability Zones in which cache nodes are created.
*
* The order of the zones in the list is not important.
*
* This option is only supported on Memcached.
*
* > If you are creating your cluster in an Amazon VPC (recommended) you can only locate nodes in Availability Zones that are associated with the subnets in the selected subnet group.
* >
* > The number of Availability Zones listed must equal the value of `NumCacheNodes` .
*
* If you want all the nodes in the same Availability Zone, use `PreferredAvailabilityZone` instead, or repeat the Availability Zone multiple times in the list.
*
* Default: System chosen Availability Zones.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-preferredavailabilityzones
*/
readonly preferredAvailabilityZones?: Array<string>;
/**
* Specifies the weekly time range during which maintenance on the cluster is performed.
*
* It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
*
* Valid values for `ddd` are:
*
* - `sun`
* - `mon`
* - `tue`
* - `wed`
* - `thu`
* - `fri`
* - `sat`
*
* Example: `sun:23:00-mon:01:30`
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-preferredmaintenancewindow
*/
readonly preferredMaintenanceWindow?: string;
/**
* A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Valkey or Redis OSS RDB snapshot file stored in Amazon S3.
*
* The snapshot file is used to populate the node group (shard). The Amazon S3 object name in the ARN cannot contain any commas.
*
* > This parameter is only valid if the `Engine` parameter is `redis` .
*
* Example of an Amazon S3 ARN: `arn:aws:s3:::my_bucket/snapshot1.rdb`
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-snapshotarns
*/
readonly snapshotArns?: Array<string>;
/**
* The name of a Valkey or Redis OSS snapshot from which to restore data into the new node group (shard).
*
* The snapshot status changes to `restoring` while the new node group (shard) is being created.
*
* > This parameter is only valid if the `Engine` parameter is `redis` .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-snapshotname
*/
readonly snapshotName?: string;
/**
* The number of days for which ElastiCache retains automatic snapshots before deleting them.
*
* For example, if you set `SnapshotRetentionLimit` to 5, a snapshot taken today is retained for 5 days before being deleted.
*
* > This parameter is only valid if the `Engine` parameter is `redis` .
*
* Default: 0 (i.e., automatic backups are disabled for this cache cluster).
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-snapshotretentionlimit
*/
readonly snapshotRetentionLimit?: number;
/**
* The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
*
* Example: `05:00-09:00`
*
* If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
*
* > This parameter is only valid if the `Engine` parameter is `redis` .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-snapshotwindow
*/
readonly snapshotWindow?: string;
/**
* A list of tags to be added to this resource.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-tags
*/
readonly tags?: Array<cdk.CfnTag>;
/**
* A flag that enables in-transit encryption when set to true.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-transitencryptionenabled
*/
readonly transitEncryptionEnabled?: boolean | cdk.IResolvable;
/**
* One or more VPC security groups associated with the cluster.
*
* Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-vpcsecuritygroupids
*/
readonly vpcSecurityGroupIds?: Array<string>;
}
/**
* Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region.
*
* The secondary cluster accepts only reads. The primary cluster automatically replicates updates to the secondary cluster.
*
* - The *GlobalReplicationGroupIdSuffix* represents the name of the Global datastore, which is what you use to associate a secondary cluster.
*
* @cloudformationResource AWS::ElastiCache::GlobalReplicationGroup
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html
*/
export declare class CfnGlobalReplicationGroup extends cdk.CfnResource implements cdk.IInspectable, IGlobalReplicationGroupRef {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnGlobalReplicationGroup from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnGlobalReplicationGroup;
/**
* Checks whether the given object is a CfnGlobalReplicationGroup
*/
static isCfnGlobalReplicationGroup(x: any): x is CfnGlobalReplicationGroup;
/**
* Creates a new IGlobalReplicationGroupRef from a globalReplicationGroupId
*/
static fromGlobalReplicationGroupId(scope: constructs.Construct, id: string, globalReplicationGroupId: string): IGlobalReplicationGroupRef;
static arnForGlobalReplicationGroup(resource: IGlobalReplicationGroupRef): string;
/**
* Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.
*/
private _automaticFailoverEnabled?;
/**
* The cache node type of the Global datastore.
*/
private _cacheNodeType?;
/**
* The name of the cache parameter group to use with the Global datastore.
*/
private _cacheParameterGroupName?;
/**
* The ElastiCache engine.
*/
private _engine?;
/**
* The Elasticache Valkey or Redis OSS engine version.
*/
private _engineVersion?;
/**
* The number of node groups that comprise the Global Datastore.
*/
private _globalNodeGroupCount?;
/**
* The optional description of the Global datastore.
*/
private _globalReplicationGroupDescription?;
/**
* The suffix name of a Global Datastore.
*/
private _globalReplicationGroupIdSuffix?;
/**
* The replication groups that comprise the Global datastore.
*/
private _members;
/**
* The Regions that comprise the Global Datastore.
*/
private _regionalConfigurations?;
/**
* Create a new `AWS::ElastiCache::GlobalReplicationGroup`.
*
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnGlobalReplicationGroupProps);
get globalReplicationGroupRef(): GlobalReplicationGroupReference;
/**
* Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.
*/
get automaticFailoverEnabled(): boolean | cdk.IResolvable | undefined;
/**
* Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.
*/
set automaticFailoverEnabled(value: boolean | cdk.IResolvable | undefined);
/**
* The cache node type of the Global datastore.
*/
get cacheNodeType(): string | undefined;
/**
* The cache node type of the Global datastore.
*/
set cacheNodeType(value: string | undefined);
/**
* The name of the cache parameter group to use with the Global datastore.
*/
get cacheParameterGroupName(): string | undefined;
/**
* The name of the cache parameter group to use with the Global datastore.
*/
set cacheParameterGroupName(value: string | undefined);
/**
* The ElastiCache engine.
*/
get engine(): string | undefined;
/**
* The ElastiCache engine.
*/
set engine(value: string | undefined);
/**
* The Elasticache Valkey or Redis OSS engine version.
*/
get engineVersion(): string | undefined;
/**
* The Elasticache Valkey or Redis OSS engine version.
*/
set engineVersion(value: string | undefined);
/**
* The number of node groups that comprise the Global Datastore.
*/
get globalNodeGroupCount(): number | undefined;
/**
* The number of node groups that comprise the Global Datastore.
*/
set globalNodeGroupCount(value: number | undefined);
/**
* The optional description of the Global datastore.
*/
get globalReplicationGroupDescription(): string | undefined;
/**
* The optional description of the Global datastore.
*/
set globalReplicationGroupDescription(value: string | undefined);
/**
* The suffix name of a Global Datastore.
*/
get globalReplicationGroupIdSuffix(): string | undefined;
/**
* The suffix name of a Global Datastore.
*/
set globalReplicationGroupIdSuffix(value: string | undefined);
/**
* The replication groups that comprise the Global datastore.
*/
get members(): Array<CfnGlobalReplicationGroup.GlobalReplicationGroupMemberProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* The replication groups that comprise the Global datastore.
*/
set members(value: Array<CfnGlobalReplicationGroup.GlobalReplicationGroupMemberProperty | cdk.IResolvable> | cdk.IResolvable);
/**
* The Regions that comprise the Global Datastore.
*/
get regionalConfigurations(): Array<cdk.IResolvable | CfnGlobalReplicationGroup.RegionalConfigurationProperty> | cdk.IResolvable | undefined;
/**
* The Regions that comprise the Global Datastore.
*/
set regionalConfigurations(value: Array<cdk.IResolvable | CfnGlobalReplicationGroup.RegionalConfigurationProperty> | cdk.IResolvable | undefined);
/**
* The ID used to associate a secondary cluster to the Global Replication Group.
*
* @cloudformationAttribute GlobalReplicationGroupId
*/
get attrGlobalReplicationGroupId(): string;
/**
* The status of the Global Datastore. Can be `Creating` , `Modifying` , `Available` , `Deleting` or `Primary-Only` . Primary-only status indicates the global datastore contains only a primary cluster. Either all secondary clusters are deleted or not successfully created.
*
* @cloudformationAttribute Status
*/
get attrStatus(): string;
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
export declare namespace CfnGlobalReplicationGroup {
/**
* A list of the replication groups.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-regionalconfiguration.html
*/
interface RegionalConfigurationProperty {
/**
* The name of the secondary cluster.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-regionalconfiguration.html#cfn-elasticache-globalreplicationgroup-regionalconfiguration-replicationgroupid
*/
readonly replicationGroupId?: string;
/**
* The Amazon region where the cluster is stored.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-regionalconfiguration.html#cfn-elasticache-globalreplicationgroup-regionalconfiguration-replicationgroupregion
*/
readonly replicationGroupRegion?: string;
/**
* A list of PreferredAvailabilityZones objects that specifies the configuration of a node group in the resharded cluster.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-regionalconfiguration.html#cfn-elasticache-globalreplicationgroup-regionalconfiguration-reshardingconfigurations
*/
readonly reshardingConfigurations?: Array<cdk.IResolvable | CfnGlobalReplicationGroup.ReshardingConfigurationProperty> | cdk.IResolvable;
}
/**
* A list of `PreferredAvailabilityZones` objects that specifies the configuration of a node group in the resharded cluster.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-reshardingconfiguration.html
*/
interface ReshardingConfigurationProperty {
/**
* Either the ElastiCache supplied 4-digit id or a user supplied id for the node group these configuration values apply to.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-reshardingconfiguration.html#cfn-elasticache-globalreplicationgroup-reshardingconfiguration-nodegroupid
*/
readonly nodeGroupId?: string;
/**
* A list of preferred availability zones for the nodes in this cluster.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-reshardingconfiguration.html#cfn-elasticache-globalreplicationgroup-reshardingconfiguration-preferredavailabilityzones
*/
readonly preferredAvailabilityZones?: Array<string>;
}
/**
* A member of a Global datastore.
*
* It contains the Replication Group Id, the Amazon region and the role of the replication group.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-globalreplicationgroupmember.html
*/
interface GlobalReplicationGroupMemberProperty {
/**
* The replication group id of the Global datastore member.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-globalreplicationgroupmember.html#cfn-elasticache-globalreplicationgroup-globalreplicationgroupmember-replicationgroupid
*/
readonly replicationGroupId?: string;
/**
* The Amazon region of the Global datastore member.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-globalreplicationgroupmember.html#cfn-elasticache-globalreplicationgroup-globalreplicationgroupmember-replicationgroupregion
*/
readonly replicationGroupRegion?: string;
/**
* Ind