aws-cdk-lib
Version:
Version 2 of the AWS Cloud Development Kit library
984 lines (983 loc) • 132 kB
TypeScript
import * as cdk from "../../core";
import * as constructs from "constructs";
import * as cfn_parse from "../../core/lib/helpers-internal";
/**
* 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, 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;
/**
* 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
*/
readonly 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
*/
readonly attrConfigurationEndpointPort: string;
/**
* The resource name.
*
* @cloudformationAttribute Id
*/
readonly attrId: string;
/**
* The DNS address of the configuration endpoint for the Valkey or Redis OSS cache cluster.
*
* @cloudformationAttribute RedisEndpoint.Address
*/
readonly attrRedisEndpointAddress: string;
/**
* The port number of the configuration endpoint for the Valkey or Redis OSS cache cluster.
*
* @cloudformationAttribute RedisEndpoint.Port
*/
readonly attrRedisEndpointPort: string;
/**
* 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.
*/
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.
*/
azMode?: string;
/**
* The compute and memory capacity of the nodes in the node group (shard).
*/
cacheNodeType: string;
/**
* The name of the parameter group to associate with this cluster.
*/
cacheParameterGroupName?: string;
/**
* A list of security group names to associate with this cluster.
*/
cacheSecurityGroupNames?: Array<string>;
/**
* The name of the subnet group to be used for the cluster.
*/
cacheSubnetGroupName?: string;
/**
* A name for the cache cluster.
*/
clusterName?: string;
/**
* The name of the cache engine to be used for this cluster.
*/
engine: string;
/**
* The version number of the cache engine to be used for this cluster.
*/
engineVersion?: string;
/**
* The network type you choose when modifying a cluster, either `ipv4` | `ipv6` .
*/
ipDiscovery?: string;
/**
* Specifies the destination, format and type of the logs.
*/
logDeliveryConfigurations?: Array<cdk.IResolvable | CfnCacheCluster.LogDeliveryConfigurationRequestProperty> | cdk.IResolvable;
/**
* Must be either `ipv4` | `ipv6` | `dual_stack` .
*/
networkType?: string;
/**
* The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
*/
notificationTopicArn?: string;
/**
* The number of cache nodes that the cache cluster should have.
*/
numCacheNodes: number;
/**
* The port number on which each of the cache nodes accepts connections.
*/
port?: number;
/**
* The EC2 Availability Zone in which the cluster is created.
*/
preferredAvailabilityZone?: string;
/**
* A list of the Availability Zones in which cache nodes are created.
*/
preferredAvailabilityZones?: Array<string>;
/**
* Specifies the weekly time range during which maintenance on the cluster is performed.
*/
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.
*/
snapshotArns?: Array<string>;
/**
* The name of a Valkey or Redis OSS snapshot from which to restore data into the new node group (shard).
*/
snapshotName?: string;
/**
* The number of days for which ElastiCache retains automatic snapshots before deleting them.
*/
snapshotRetentionLimit?: number;
/**
* The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
*/
snapshotWindow?: string;
/**
* Tag Manager which manages the tags for this resource
*/
readonly tags: cdk.TagManager;
/**
* A list of tags to be added to this resource.
*/
tagsRaw?: Array<cdk.CfnTag>;
/**
* A flag that enables in-transit encryption when set to true.
*/
transitEncryptionEnabled?: boolean | cdk.IResolvable;
/**
* One or more VPC security groups associated with the cluster.
*/
vpcSecurityGroupIds?: Array<string>;
/**
* @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);
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, AWS 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 {
/**
* 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;
/**
* The ID used to associate a secondary cluster to the Global Replication Group.
*
* @cloudformationAttribute GlobalReplicationGroupId
*/
readonly 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
*/
readonly attrStatus: string;
/**
* Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.
*/
automaticFailoverEnabled?: boolean | cdk.IResolvable;
/**
* The cache node type of the Global datastore.
*/
cacheNodeType?: string;
/**
* The name of the cache parameter group to use with the Global datastore.
*/
cacheParameterGroupName?: string;
/**
* The ElastiCache engine.
*/
engine?: string;
/**
* The Elasticache Valkey or Redis OSS engine version.
*/
engineVersion?: string;
/**
* The number of node groups that comprise the Global Datastore.
*/
globalNodeGroupCount?: number;
/**
* The optional description of the Global datastore.
*/
globalReplicationGroupDescription?: string;
/**
* The suffix name of a Global Datastore.
*/
globalReplicationGroupIdSuffix?: string;
/**
* The replication groups that comprise the Global datastore.
*/
members: Array<CfnGlobalReplicationGroup.GlobalReplicationGroupMemberProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* The Regions that comprise the Global Datastore.
*/
regionalConfigurations?: Array<cdk.IResolvable | CfnGlobalReplicationGroup.RegionalConfigurationProperty> | cdk.IResolvable;
/**
* @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);
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;
/**
* Indicates the role of the replication group, `PRIMARY` or `SECONDARY` .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-globalreplicationgroupmember.html#cfn-elasticache-globalreplicationgroup-globalreplicationgroupmember-role
*/
readonly role?: string;
}
}
/**
* Properties for defining a `CfnGlobalReplicationGroup`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html
*/
export interface CfnGlobalReplicationGroupProps {
/**
* Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.
*
* `AutomaticFailoverEnabled` must be enabled for Valkey or Redis OSS (cluster mode enabled) replication groups.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-automaticfailoverenabled
*/
readonly automaticFailoverEnabled?: boolean | cdk.IResolvable;
/**
* The cache node type of the Global datastore.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-cachenodetype
*/
readonly cacheNodeType?: string;
/**
* The name of the cache parameter group to use with the Global datastore.
*
* It must be compatible with the major engine version used by the Global datastore.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-cacheparametergroupname
*/
readonly cacheParameterGroupName?: string;
/**
* The ElastiCache engine.
*
* For Valkey or Redis OSS only.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-engine
*/
readonly engine?: string;
/**
* The Elasticache Valkey or Redis OSS engine version.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-engineversion
*/
readonly engineVersion?: string;
/**
* The number of node groups that comprise the Global Datastore.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-globalnodegroupcount
*/
readonly globalNodeGroupCount?: number;
/**
* The optional description of the Global datastore.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-globalreplicationgroupdescription
*/
readonly globalReplicationGroupDescription?: string;
/**
* The suffix name of a Global Datastore.
*
* The suffix guarantees uniqueness of the Global Datastore name across multiple regions.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-globalreplicationgroupidsuffix
*/
readonly globalReplicationGroupIdSuffix?: string;
/**
* The replication groups that comprise the Global datastore.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-members
*/
readonly members: Array<CfnGlobalReplicationGroup.GlobalReplicationGroupMemberProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* The Regions that comprise the Global Datastore.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-regionalconfigurations
*/
readonly regionalConfigurations?: Array<cdk.IResolvable | CfnGlobalReplicationGroup.RegionalConfigurationProperty> | cdk.IResolvable;
}
/**
* The `AWS::ElastiCache::ParameterGroup` type creates a new cache parameter group.
*
* Cache parameter groups control the parameters for a cache cluster.
*
* @cloudformationResource AWS::ElastiCache::ParameterGroup
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-parametergroup.html
*/
export declare class CfnParameterGroup extends cdk.CfnResource implements cdk.IInspectable, cdk.ITaggable {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnParameterGroup 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): CfnParameterGroup;
/**
* A user-specified name for the cache parameter group.
*
* @cloudformationAttribute CacheParameterGroupName
*/
readonly attrCacheParameterGroupName: string;
/**
* The name of the cache parameter group family that this cache parameter group is compatible with.
*/
cacheParameterGroupFamily: string;
/**
* The description for this cache parameter group.
*/
description: string;
/**
* A comma-delimited list of parameter name/value pairs.
*/
properties?: cdk.IResolvable | Record<string, string>;
/**
* Tag Manager which manages the tags for this resource
*/
readonly tags: cdk.TagManager;
/**
* A tag that can be added to an ElastiCache parameter group.
*/
tagsRaw?: Array<cdk.CfnTag>;
/**
* @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: CfnParameterGroupProps);
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>;
}
/**
* Properties for defining a `CfnParameterGroup`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-parametergroup.html
*/
export interface CfnParameterGroupProps {
/**
* The name of the cache parameter group family that this cache parameter group is compatible with.
*
* Valid values are: `valkey8` | `valkey7` | `memcached1.4` | `memcached1.5` | `memcached1.6` | `redis2.6` | `redis2.8` | `redis3.2` | `redis4.0` | `redis5.0` | `redis6.x` | `redis7`
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-parametergroup.html#cfn-elasticache-parametergroup-cacheparametergroupfamily
*/
readonly cacheParameterGroupFamily: string;
/**
* The description for this cache parameter group.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-parametergroup.html#cfn-elasticache-parametergroup-description
*/
readonly description: string;
/**
* A comma-delimited list of parameter name/value pairs.
*
* For example:
*
* ```
* "Properties" : { "cas_disabled" : "1", "chunk_size_growth_factor" : "1.02"
* }
* ```
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-parametergroup.html#cfn-elasticache-parametergroup-properties
*/
readonly properties?: cdk.IResolvable | Record<string, string>;
/**
* A tag that can be added to an ElastiCache parameter group.
*
* Tags are composed of a Key/Value pair. You can use tags to categorize and track all your parameter groups. A tag with a null Value is permitted.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-parametergroup.html#cfn-elasticache-parametergroup-tags
*/
readonly tags?: Array<cdk.CfnTag>;
}
/**
* The `AWS::ElastiCache::ReplicationGroup` resource creates an Amazon ElastiCache (Valkey or Redis OSS) replication group.
*
* A Valkey or Redis OSS (cluster mode disabled) replication group is a collection of cache clusters, where one of the clusters is a primary read-write cluster and the others are read-only replicas.
*
* A Valkey or Redis OSS (cluster mode enabled) cluster is comprised of from 1 to 90 shards (API/CLI: node groups). Each shard has a primary node and up to 5 read-only replica nodes. The configuration can range from 90 shards and 0 replicas to 15 shards and 5 replicas, which is the maximum number or replicas allowed.
*
* The node or shard limit can be increased to a maximum of 500 per cluster if the engine version is Valkey 7.2 or higher, or Redis OSS 5.0.6 or higher. For example, you can choose to configure a 500 node cluster that ranges between 83 shards (one primary and 5 replicas per shard) and 500 shards (single primary and no replicas). Make sure there are enough available IP addresses to accommodate the increase. Common pitfalls include the subnets in the subnet group have too small a CIDR range or the subnets are shared and heavily used by other clusters. For more information, see [Creating a Subnet Group](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/SubnetGroups.Creating.html) . For versions below 5.0.6, the limit is 250 per cluster.
*
* To request a limit increase, see [Amazon Service Limits](https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html) and choose the limit type *Nodes per cluster per instance type* .
*
* @cloudformationResource AWS::ElastiCache::ReplicationGroup
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html
*/
export declare class CfnReplicationGroup extends cdk.CfnResource implements cdk.IInspectable, cdk.ITaggable {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnReplicationGroup 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): CfnReplicationGroup;
/**
* The DNS hostname of the cache node.
*
* > Valkey or 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. For Valkey or Redis OSS (cluster mode disabled) replication groups, use the `PrimaryEndpoint` or `ReadEndpoint` attributes.
*
* @cloudformationAttribute ConfigurationEndPoint.Address
*/
readonly attrConfigurationEndPointAddress: string;
/**
* The port number that the cache engine is listening on.
*
* @cloudformationAttribute ConfigurationEndPoint.Port
*/
readonly attrConfigurationEndPointPort: string;
/**
* The DNS address of the primary read-write cache node.
*
* @cloudformationAttribute PrimaryEndPoint.Address
*/
readonly attrPrimaryEndPointAddress: string;
/**