@aws-sdk/client-elasticache 3.238.0 → 3.241.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (38) hide show
  1. package/dist-cjs/endpoint/ruleset.js +3 -3
  2. package/dist-cjs/models/models_0.js +11 -6
  3. package/dist-cjs/protocols/Aws_query.js +33 -0
  4. package/dist-es/endpoint/ruleset.js +3 -3
  5. package/dist-es/models/models_0.js +5 -0
  6. package/dist-es/protocols/Aws_query.js +33 -0
  7. package/dist-types/ElastiCache.d.ts +93 -113
  8. package/dist-types/ElastiCacheClient.d.ts +3 -3
  9. package/dist-types/commands/AddTagsToResourceCommand.d.ts +2 -2
  10. package/dist-types/commands/AuthorizeCacheSecurityGroupIngressCommand.d.ts +1 -1
  11. package/dist-types/commands/CopySnapshotCommand.d.ts +20 -23
  12. package/dist-types/commands/CreateCacheClusterCommand.d.ts +1 -1
  13. package/dist-types/commands/CreateCacheParameterGroupCommand.d.ts +4 -4
  14. package/dist-types/commands/CreateCacheSecurityGroupCommand.d.ts +1 -1
  15. package/dist-types/commands/CreateCacheSubnetGroupCommand.d.ts +1 -1
  16. package/dist-types/commands/CreateGlobalReplicationGroupCommand.d.ts +0 -1
  17. package/dist-types/commands/CreateReplicationGroupCommand.d.ts +7 -9
  18. package/dist-types/commands/CreateSnapshotCommand.d.ts +1 -2
  19. package/dist-types/commands/DeleteCacheClusterCommand.d.ts +9 -10
  20. package/dist-types/commands/DeleteCacheSecurityGroupCommand.d.ts +1 -1
  21. package/dist-types/commands/DeleteCacheSubnetGroupCommand.d.ts +1 -1
  22. package/dist-types/commands/DeleteGlobalReplicationGroupCommand.d.ts +3 -6
  23. package/dist-types/commands/DeleteReplicationGroupCommand.d.ts +2 -2
  24. package/dist-types/commands/DeleteSnapshotCommand.d.ts +1 -2
  25. package/dist-types/commands/DescribeCacheClustersCommand.d.ts +5 -5
  26. package/dist-types/commands/DescribeEventsCommand.d.ts +1 -1
  27. package/dist-types/commands/DescribeReplicationGroupsCommand.d.ts +1 -1
  28. package/dist-types/commands/DescribeSnapshotsCommand.d.ts +1 -2
  29. package/dist-types/commands/ListAllowedNodeTypeModificationsCommand.d.ts +1 -2
  30. package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -2
  31. package/dist-types/commands/ModifyReplicationGroupCommand.d.ts +4 -5
  32. package/dist-types/commands/RebootCacheClusterCommand.d.ts +4 -6
  33. package/dist-types/commands/TestFailoverCommand.d.ts +17 -19
  34. package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
  35. package/dist-types/models/models_0.d.ts +712 -1204
  36. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
  37. package/dist-types/ts3.4/models/models_0.d.ts +13 -0
  38. package/package.json +4 -4
@@ -9,12 +9,10 @@ export interface CopySnapshotCommandOutput extends CopySnapshotResult, __Metadat
9
9
  }
10
10
  /**
11
11
  * <p>Makes a copy of an existing snapshot.</p>
12
- *
13
- * <note>
12
+ * <note>
14
13
  * <p>This operation is valid for Redis only.</p>
15
14
  * </note>
16
- *
17
- * <important>
15
+ * <important>
18
16
  * <p>Users or groups that have permissions to use the <code>CopySnapshot</code> operation
19
17
  * can create their own Amazon S3 buckets and copy snapshots to it.
20
18
  * To control access to your snapshots, use an IAM policy to control who has the ability to use
@@ -22,52 +20,51 @@ export interface CopySnapshotCommandOutput extends CopySnapshotResult, __Metadat
22
20
  * For more information about using IAM to control the use of ElastiCache operations, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html">Exporting Snapshots</a>
23
21
  * and <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/IAM.html">Authentication & Access Control</a>.</p>
24
22
  * </important>
25
- *
26
- * <p>You could receive the following error messages.</p>
27
- * <p class="title">
23
+ * <p>You could receive the following error messages.</p>
24
+ * <p class="title">
28
25
  * <b>Error Messages</b>
29
26
  * </p>
30
27
  * <ul>
31
28
  * <li>
32
- * <p>
29
+ * <p>
33
30
  * <b>Error Message:</b>
34
31
  * The S3 bucket %s is outside of the region.</p>
35
- * <p>
32
+ * <p>
36
33
  * <b>Solution:</b>
37
34
  * Create an Amazon S3 bucket in the same region as your snapshot.
38
35
  * For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-create-s3-bucket">Step 1: Create an Amazon S3 Bucket</a> in the ElastiCache User Guide.</p>
39
36
  * </li>
40
37
  * <li>
41
- * <p>
38
+ * <p>
42
39
  * <b>Error Message:</b>
43
40
  * The S3 bucket %s does not exist.</p>
44
- * <p>
41
+ * <p>
45
42
  * <b>Solution:</b>
46
43
  * Create an Amazon S3 bucket in the same region as your snapshot.
47
44
  * For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-create-s3-bucket">Step 1: Create an Amazon S3 Bucket</a> in the ElastiCache User Guide.</p>
48
45
  * </li>
49
46
  * <li>
50
- * <p>
47
+ * <p>
51
48
  * <b>Error Message:</b>
52
49
  * The S3 bucket %s is not owned by the authenticated user.</p>
53
- * <p>
50
+ * <p>
54
51
  * <b>Solution:</b>
55
52
  * Create an Amazon S3 bucket in the same region as your snapshot.
56
53
  * For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-create-s3-bucket">Step 1: Create an Amazon S3 Bucket</a> in the ElastiCache User Guide.</p>
57
54
  * </li>
58
55
  * <li>
59
- * <p>
56
+ * <p>
60
57
  * <b>Error Message:</b>
61
58
  * The authenticated user does not have sufficient permissions to perform the desired activity.</p>
62
- * <p>
59
+ * <p>
63
60
  * <b>Solution:</b>
64
61
  * Contact your system administrator to get the needed permissions.</p>
65
62
  * </li>
66
63
  * <li>
67
- * <p>
64
+ * <p>
68
65
  * <b>Error Message:</b>
69
66
  * The S3 bucket %s already contains an object with key %s.</p>
70
- * <p>
67
+ * <p>
71
68
  * <b>Solution:</b>
72
69
  * Give the <code>TargetSnapshotName</code> a new and unique value.
73
70
  * If exporting a snapshot,
@@ -75,28 +72,28 @@ export interface CopySnapshotCommandOutput extends CopySnapshotResult, __Metadat
75
72
  * and use this same value for <code>TargetSnapshotName</code>.</p>
76
73
  * </li>
77
74
  * <li>
78
- * <p>
75
+ * <p>
79
76
  * <b>Error Message: </b>
80
77
  * ElastiCache has not been granted READ permissions %s on the S3 Bucket.</p>
81
- * <p>
78
+ * <p>
82
79
  * <b>Solution:</b>
83
80
  * Add List and Read permissions on the bucket.
84
81
  * For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-grant-access">Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket</a> in the ElastiCache User Guide.</p>
85
82
  * </li>
86
83
  * <li>
87
- * <p>
84
+ * <p>
88
85
  * <b>Error Message: </b>
89
86
  * ElastiCache has not been granted WRITE permissions %s on the S3 Bucket.</p>
90
- * <p>
87
+ * <p>
91
88
  * <b>Solution:</b>
92
89
  * Add Upload/Delete permissions on the bucket.
93
90
  * For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-grant-access">Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket</a> in the ElastiCache User Guide.</p>
94
91
  * </li>
95
92
  * <li>
96
- * <p>
93
+ * <p>
97
94
  * <b>Error Message: </b>
98
95
  * ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket.</p>
99
- * <p>
96
+ * <p>
100
97
  * <b>Solution:</b>
101
98
  * Add View Permissions on the bucket.
102
99
  * For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-grant-access">Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket</a> in the ElastiCache User Guide.</p>
@@ -11,7 +11,7 @@ export interface CreateCacheClusterCommandOutput extends CreateCacheClusterResul
11
11
  * <p>Creates a cluster. All nodes in the
12
12
  * cluster run the same protocol-compliant cache engine software, either Memcached
13
13
  * or Redis.</p>
14
- * <p>This operation is not supported for Redis (cluster mode enabled) clusters.</p>
14
+ * <p>This operation is not supported for Redis (cluster mode enabled) clusters.</p>
15
15
  * @example
16
16
  * Use a bare-bones client and the command you need to make an API call.
17
17
  * ```javascript
@@ -11,16 +11,16 @@ export interface CreateCacheParameterGroupCommandOutput extends CreateCacheParam
11
11
  * <p>Creates a new Amazon ElastiCache cache parameter group. An ElastiCache
12
12
  * cache parameter group is a collection of parameters and their values that are applied to all of the nodes
13
13
  * in any cluster or replication group using the CacheParameterGroup.</p>
14
- * <p>A newly created CacheParameterGroup is an exact duplicate of the default parameter group
14
+ * <p>A newly created CacheParameterGroup is an exact duplicate of the default parameter group
15
15
  * for the CacheParameterGroupFamily. To customize the newly created CacheParameterGroup you can
16
16
  * change the values of specific parameters. For more information, see:</p>
17
- * <ul>
17
+ * <ul>
18
18
  * <li>
19
- * <p>
19
+ * <p>
20
20
  * <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_ModifyCacheParameterGroup.html">ModifyCacheParameterGroup</a> in the ElastiCache API Reference.</p>
21
21
  * </li>
22
22
  * <li>
23
- * <p>
23
+ * <p>
24
24
  * <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ParameterGroups.html">Parameters and Parameter Groups</a> in the ElastiCache User Guide.</p>
25
25
  * </li>
26
26
  * </ul>
@@ -10,7 +10,7 @@ export interface CreateCacheSecurityGroupCommandOutput extends CreateCacheSecuri
10
10
  /**
11
11
  * <p>Creates a new cache security group. Use a
12
12
  * cache security group to control access to one or more clusters.</p>
13
- * <p>Cache security groups are only used when you are creating a cluster outside of an Amazon
13
+ * <p>Cache security groups are only used when you are creating a cluster outside of an Amazon
14
14
  * Virtual Private Cloud (Amazon VPC). If you are creating a cluster inside of a VPC, use a cache
15
15
  * subnet group instead. For more information,
16
16
  * see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CreateCacheSubnetGroup.html">CreateCacheSubnetGroup</a>.</p>
@@ -9,7 +9,7 @@ export interface CreateCacheSubnetGroupCommandOutput extends CreateCacheSubnetGr
9
9
  }
10
10
  /**
11
11
  * <p>Creates a new cache subnet group.</p>
12
- * <p>Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).</p>
12
+ * <p>Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).</p>
13
13
  * @example
14
14
  * Use a bare-bones client and the command you need to make an API call.
15
15
  * ```javascript
@@ -15,7 +15,6 @@ export interface CreateGlobalReplicationGroupCommandOutput extends CreateGlobalR
15
15
  * and disaster recovery across regions. For more information,
16
16
  *
17
17
  * see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Redis-Global-Datastore.html">Replication Across Regions Using Global Datastore</a>. </p>
18
- *
19
18
  * <ul>
20
19
  * <li>
21
20
  * <p>The <b>GlobalReplicationGroupIdSuffix</b> is the name of the Global datastore.</p>
@@ -9,30 +9,28 @@ export interface CreateReplicationGroupCommandOutput extends CreateReplicationGr
9
9
  }
10
10
  /**
11
11
  * <p>Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.</p>
12
- * <p>This API can be used to create a standalone regional replication group or a secondary replication group associated with a Global datastore.</p>
13
- * <p>A Redis (cluster mode disabled) replication group is a collection of clusters,
12
+ * <p>This API can be used to create a standalone regional replication group or a secondary replication group associated with a Global datastore.</p>
13
+ * <p>A Redis (cluster mode disabled) replication group is a collection of clusters,
14
14
  * where one of the clusters is a read/write primary and the others are read-only replicas.
15
15
  * Writes to the primary are asynchronously propagated to the replicas.</p>
16
- * <p>A Redis cluster-mode enabled cluster is comprised of from 1 to 90 shards (API/CLI: node groups).
16
+ * <p>A Redis cluster-mode enabled cluster is comprised of from 1 to 90 shards (API/CLI: node groups).
17
17
  * 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.
18
18
  *
19
19
  * </p>
20
- * <p>The node or shard limit can be increased to a maximum of 500 per cluster if the Redis engine version is 5.0.6 or higher. For example, you can choose to configure a 500 node cluster that ranges between
20
+ * <p>The node or shard limit can be increased to a maximum of 500 per cluster if the Redis engine version is 5.0.6 or higher. For example, you can choose to configure a 500 node cluster that ranges between
21
21
  * 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.
22
22
  * 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
23
23
  * <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SubnetGroups.Creating.html">Creating a Subnet Group</a>. For versions below 5.0.6,
24
24
  * the limit is 250 per cluster.</p>
25
- * <p>To request a limit increase, see
25
+ * <p>To request a limit increase, see
26
26
  * <a href="https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html">Amazon Service Limits</a>
27
27
  * and choose the limit type <b>Nodes per cluster per instance type</b>. </p>
28
- * <p>When a Redis (cluster mode disabled) replication group has been successfully created,
28
+ * <p>When a Redis (cluster mode disabled) replication group has been successfully created,
29
29
  * you can add one or more read replicas to it, up to a total of 5 read replicas.
30
30
  * If you need to increase or decrease the number of node groups (console: shards),
31
31
  * you can avail yourself of ElastiCache for Redis' scaling. For more information,
32
32
  * see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Scaling.html">Scaling ElastiCache for Redis Clusters</a> in the <i>ElastiCache User Guide</i>.</p>
33
- *
34
- *
35
- * <note>
33
+ * <note>
36
34
  * <p>This operation is valid for Redis only.</p>
37
35
  * </note>
38
36
  * @example
@@ -10,8 +10,7 @@ export interface CreateSnapshotCommandOutput extends CreateSnapshotResult, __Met
10
10
  /**
11
11
  * <p>Creates a copy of an entire cluster or replication group at a
12
12
  * specific moment in time.</p>
13
- *
14
- * <note>
13
+ * <note>
15
14
  * <p>This operation is valid for Redis only.</p>
16
15
  * </note>
17
16
  * @example
@@ -13,29 +13,28 @@ export interface DeleteCacheClusterCommandOutput extends DeleteCacheClusterResul
13
13
  * cluster itself. When you receive a successful response from this operation,
14
14
  * Amazon ElastiCache immediately begins deleting the cluster; you cannot cancel or revert
15
15
  * this operation.</p>
16
- * <p>This operation is not valid for:</p>
17
- * <ul>
16
+ * <p>This operation is not valid for:</p>
17
+ * <ul>
18
18
  * <li>
19
- * <p>Redis (cluster mode enabled) clusters</p>
19
+ * <p>Redis (cluster mode enabled) clusters</p>
20
20
  * </li>
21
21
  * <li>
22
- * <p>Redis (cluster mode disabled) clusters</p>
22
+ * <p>Redis (cluster mode disabled) clusters</p>
23
23
  * </li>
24
24
  * <li>
25
- *
26
- * <p>A cluster that is the last read replica of a replication group</p>
25
+ * <p>A cluster that is the last read replica of a replication group</p>
27
26
  * </li>
28
27
  * <li>
29
- * <p>A cluster that is the primary node of a replication group</p>
28
+ * <p>A cluster that is the primary node of a replication group</p>
30
29
  * </li>
31
30
  * <li>
32
- * <p>A node group (shard) that has Multi-AZ mode enabled</p>
31
+ * <p>A node group (shard) that has Multi-AZ mode enabled</p>
33
32
  * </li>
34
33
  * <li>
35
- * <p>A cluster from a Redis (cluster mode enabled) replication group</p>
34
+ * <p>A cluster from a Redis (cluster mode enabled) replication group</p>
36
35
  * </li>
37
36
  * <li>
38
- * <p>A cluster that is not in the <code>available</code> state</p>
37
+ * <p>A cluster that is not in the <code>available</code> state</p>
39
38
  * </li>
40
39
  * </ul>
41
40
  * @example
@@ -9,7 +9,7 @@ export interface DeleteCacheSecurityGroupCommandOutput extends __MetadataBearer
9
9
  }
10
10
  /**
11
11
  * <p>Deletes a cache security group.</p>
12
- * <note>
12
+ * <note>
13
13
  * <p>You cannot delete a cache security group if it is associated with any clusters.</p>
14
14
  * </note>
15
15
  * @example
@@ -9,7 +9,7 @@ export interface DeleteCacheSubnetGroupCommandOutput extends __MetadataBearer {
9
9
  }
10
10
  /**
11
11
  * <p>Deletes a cache subnet group.</p>
12
- * <note>
12
+ * <note>
13
13
  * <p>You cannot delete a default cache subnet group or one that is associated with any clusters.</p>
14
14
  * </note>
15
15
  * @example
@@ -9,7 +9,7 @@ export interface DeleteGlobalReplicationGroupCommandOutput extends DeleteGlobalR
9
9
  }
10
10
  /**
11
11
  * <p>Deleting a Global datastore is a two-step process: </p>
12
- * <ul>
12
+ * <ul>
13
13
  * <li>
14
14
  * <p>First, you must <a>DisassociateGlobalReplicationGroup</a> to remove the secondary clusters in the Global datastore.</p>
15
15
  * </li>
@@ -17,13 +17,10 @@ export interface DeleteGlobalReplicationGroupCommandOutput extends DeleteGlobalR
17
17
  * <p>Once the Global datastore contains only the primary cluster, you can use the <code>DeleteGlobalReplicationGroup</code> API to delete the Global datastore while retainining the primary cluster using <code>RetainPrimaryReplicationGroup=true</code>.</p>
18
18
  * </li>
19
19
  * </ul>
20
- *
21
- *
22
- * <p>Since the Global Datastore has only a primary cluster, you can delete the Global Datastore
20
+ * <p>Since the Global Datastore has only a primary cluster, you can delete the Global Datastore
23
21
  * while retaining the primary by setting <code>RetainPrimaryReplicationGroup=true</code>. The primary cluster is never deleted when deleting a
24
22
  * Global Datastore. It can only be deleted when it no longer is associated with any Global Datastore.</p>
25
- *
26
- * <p>When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources;
23
+ * <p>When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources;
27
24
  * you cannot cancel or revert this operation.</p>
28
25
  * @example
29
26
  * Use a bare-bones client and the command you need to make an API call.
@@ -12,9 +12,9 @@ export interface DeleteReplicationGroupCommandOutput extends DeleteReplicationGr
12
12
  * By default, this operation deletes the entire replication group, including the primary/primaries and all of the read replicas.
13
13
  * If the replication group has only one primary,
14
14
  * you can optionally delete only the read replicas, while retaining the primary by setting <code>RetainPrimaryCluster=true</code>.</p>
15
- * <p>When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources;
15
+ * <p>When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources;
16
16
  * you cannot cancel or revert this operation.</p>
17
- * <note>
17
+ * <note>
18
18
  * <p>This operation is valid for Redis only.</p>
19
19
  * </note>
20
20
  * @example
@@ -11,8 +11,7 @@ export interface DeleteSnapshotCommandOutput extends DeleteSnapshotResult, __Met
11
11
  * <p>Deletes an existing snapshot. When you receive a
12
12
  * successful response from this operation, ElastiCache immediately begins deleting the snapshot;
13
13
  * you cannot cancel or revert this operation.</p>
14
- *
15
- * <note>
14
+ * <note>
16
15
  * <p>This operation is valid for Redis only.</p>
17
16
  * </note>
18
17
  * @example
@@ -11,18 +11,18 @@ export interface DescribeCacheClustersCommandOutput extends CacheClusterMessage,
11
11
  * <p>Returns information about all provisioned
12
12
  * clusters if no cluster identifier is specified, or about a specific cache
13
13
  * cluster if a cluster identifier is supplied.</p>
14
- * <p>By default, abbreviated information about the clusters is returned. You can
14
+ * <p>By default, abbreviated information about the clusters is returned. You can
15
15
  * use the optional <i>ShowCacheNodeInfo</i> flag to retrieve detailed information about the
16
16
  * cache nodes associated with the clusters. These details include the DNS address
17
17
  * and port for the cache node endpoint.</p>
18
- * <p>If the cluster is in the <i>creating</i> state, only cluster-level information is displayed
18
+ * <p>If the cluster is in the <i>creating</i> state, only cluster-level information is displayed
19
19
  * until all of the nodes are successfully provisioned.</p>
20
- * <p>If the cluster is in the <i>deleting</i> state, only cluster-level information is displayed.</p>
21
- * <p>If cache nodes are currently being added to the cluster, node endpoint information
20
+ * <p>If the cluster is in the <i>deleting</i> state, only cluster-level information is displayed.</p>
21
+ * <p>If cache nodes are currently being added to the cluster, node endpoint information
22
22
  * and creation time for the additional nodes are not displayed until they are
23
23
  * completely provisioned. When the cluster state is <i>available</i>, the cluster is
24
24
  * ready for use.</p>
25
- * <p>If cache nodes are currently being removed from the cluster, no endpoint information
25
+ * <p>If cache nodes are currently being removed from the cluster, no endpoint information
26
26
  * for the removed nodes is displayed.</p>
27
27
  * @example
28
28
  * Use a bare-bones client and the command you need to make an API call.
@@ -12,7 +12,7 @@ export interface DescribeEventsCommandOutput extends EventsMessage, __MetadataBe
12
12
  * security groups, and cache parameter groups. You can obtain events specific to a
13
13
  * particular cluster, cache security group, or cache parameter group by providing
14
14
  * the name as a parameter.</p>
15
- * <p>By default, only the events occurring within the last hour are returned;
15
+ * <p>By default, only the events occurring within the last hour are returned;
16
16
  * however, you can retrieve up to 14 days' worth of events if necessary.</p>
17
17
  * @example
18
18
  * Use a bare-bones client and the command you need to make an API call.
@@ -11,7 +11,7 @@ export interface DescribeReplicationGroupsCommandOutput extends ReplicationGroup
11
11
  * <p>Returns information about a particular
12
12
  * replication group. If no identifier is specified, <code>DescribeReplicationGroups</code>
13
13
  * returns information about all replication groups.</p>
14
- * <note>
14
+ * <note>
15
15
  * <p>This operation is valid for Redis only.</p>
16
16
  * </note>
17
17
  * @example
@@ -12,8 +12,7 @@ export interface DescribeSnapshotsCommandOutput extends DescribeSnapshotsListMes
12
12
  * By default, <code>DescribeSnapshots</code> lists all of your snapshots; it can optionally
13
13
  * describe a single snapshot, or just the snapshots associated with a particular cache
14
14
  * cluster.</p>
15
- *
16
- * <note>
15
+ * <note>
17
16
  * <p>This operation is valid for Redis only.</p>
18
17
  * </note>
19
18
  * @example
@@ -10,8 +10,7 @@ export interface ListAllowedNodeTypeModificationsCommandOutput extends AllowedNo
10
10
  /**
11
11
  * <p>Lists all available node types that you
12
12
  * can scale your Redis cluster's or replication group's current node type.</p>
13
- *
14
- * <p>When you use the <code>ModifyCacheCluster</code> or <code>ModifyReplicationGroup</code> operations to
13
+ * <p>When you use the <code>ModifyCacheCluster</code> or <code>ModifyReplicationGroup</code> operations to
15
14
  * scale your cluster or replication group, the value of the <code>CacheNodeType</code> parameter
16
15
  * must be one of the node types returned by this operation.</p>
17
16
  * @example
@@ -12,8 +12,7 @@ export interface ListTagsForResourceCommandOutput extends TagListMessage, __Meta
12
12
  * <p> A tag is a key-value pair where the key and value are case-sensitive.
13
13
  * You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group.
14
14
  * For more information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/IAM.ResourceLevelPermissions.html">Resource-level permissions</a>.</p>
15
- *
16
- * <p>If the cluster is not in the <i>available</i> state, <code>ListTagsForResource</code>
15
+ * <p>If the cluster is not in the <i>available</i> state, <code>ListTagsForResource</code>
17
16
  * returns an error.</p>
18
17
  * @example
19
18
  * Use a bare-bones client and the command you need to make an API call.
@@ -9,20 +9,19 @@ export interface ModifyReplicationGroupCommandOutput extends ModifyReplicationGr
9
9
  }
10
10
  /**
11
11
  * <p>Modifies the settings for a replication group.</p>
12
- *
13
- * <ul>
12
+ * <ul>
14
13
  * <li>
15
- * <p>
14
+ * <p>
16
15
  * <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/scaling-redis-cluster-mode-enabled.html">Scaling for Amazon ElastiCache for Redis (cluster mode enabled)</a>
17
16
  * in the ElastiCache User Guide</p>
18
17
  * </li>
19
18
  * <li>
20
- * <p>
19
+ * <p>
21
20
  * <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_ModifyReplicationGroupShardConfiguration.html">ModifyReplicationGroupShardConfiguration</a>
22
21
  * in the ElastiCache API Reference</p>
23
22
  * </li>
24
23
  * </ul>
25
- * <note>
24
+ * <note>
26
25
  * <p>This operation is valid for Redis only.</p>
27
26
  * </note>
28
27
  * @example
@@ -13,13 +13,11 @@ export interface RebootCacheClusterCommandOutput extends RebootCacheClusterResul
13
13
  * groups to the cluster. The reboot operation takes place as soon as possible, and
14
14
  * results in a momentary outage to the cluster. During the reboot, the cluster
15
15
  * status is set to REBOOTING.</p>
16
- * <p>The reboot causes the contents of the cache (for each cache node being rebooted) to be lost.</p>
17
- * <p>When the reboot is complete, a cluster event is created.</p>
18
- *
19
- * <p>Rebooting a cluster is currently supported on Memcached and Redis (cluster mode disabled) clusters.
16
+ * <p>The reboot causes the contents of the cache (for each cache node being rebooted) to be lost.</p>
17
+ * <p>When the reboot is complete, a cluster event is created.</p>
18
+ * <p>Rebooting a cluster is currently supported on Memcached and Redis (cluster mode disabled) clusters.
20
19
  * Rebooting is not supported on Redis (cluster mode enabled) clusters.</p>
21
- *
22
- * <p>If you make changes to parameters that require a Redis (cluster mode enabled) cluster reboot for the changes to be applied,
20
+ * <p>If you make changes to parameters that require a Redis (cluster mode enabled) cluster reboot for the changes to be applied,
23
21
  * see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/nodes.rebooting.html">Rebooting a Cluster</a> for an alternate process.</p>
24
22
  * @example
25
23
  * Use a bare-bones client and the command you need to make an API call.
@@ -12,66 +12,64 @@ export interface TestFailoverCommandOutput extends TestFailoverResult, __Metadat
12
12
  * a specified node group (called shard in the console) in a replication group (called cluster in the console).</p>
13
13
  * <p>This API is designed for testing the behavior of your application in case of ElastiCache failover. It is not designed to be an operational tool
14
14
  * for initiating a failover to overcome a problem you may have with the cluster. Moreover, in certain conditions such as large-scale operational events, Amazon may block this API. </p>
15
- * <p class="title">
15
+ * <p class="title">
16
16
  * <b>Note the following</b>
17
17
  * </p>
18
18
  * <ul>
19
19
  * <li>
20
- * <p>A customer can use this operation to test automatic failover on up to 5 shards (called node groups in the ElastiCache API and Amazon CLI)
20
+ * <p>A customer can use this operation to test automatic failover on up to 5 shards (called node groups in the ElastiCache API and Amazon CLI)
21
21
  * in any rolling 24-hour period.</p>
22
22
  * </li>
23
23
  * <li>
24
- * <p>If calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently.</p>
25
- * <p> </p>
24
+ * <p>If calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently.</p>
25
+ * <p> </p>
26
26
  * </li>
27
27
  * <li>
28
- * <p>If calling this operation multiple times on different shards in the same Redis (cluster mode enabled) replication group,
28
+ * <p>If calling this operation multiple times on different shards in the same Redis (cluster mode enabled) replication group,
29
29
  * the first node replacement must complete before a subsequent call can be made.</p>
30
30
  * </li>
31
31
  * <li>
32
- * <p>To determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console,
32
+ * <p>To determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console,
33
33
  * the Amazon CLI, or the ElastiCache API.
34
34
  * Look for the following automatic failover related events, listed here in order of occurrance:</p>
35
- * <ol>
35
+ * <ol>
36
36
  * <li>
37
- * <p>Replication group message: <code>Test Failover API called for node group <node-group-id></code>
37
+ * <p>Replication group message: <code>Test Failover API called for node group <node-group-id></code>
38
38
  * </p>
39
39
  * </li>
40
40
  * <li>
41
- * <p>Cache cluster message: <code>Failover from primary node <primary-node-id> to replica node <node-id> completed</code>
41
+ * <p>Cache cluster message: <code>Failover from primary node <primary-node-id> to replica node <node-id> completed</code>
42
42
  * </p>
43
43
  * </li>
44
44
  * <li>
45
- * <p>Replication group message: <code>Failover from primary node <primary-node-id> to replica node <node-id> completed</code>
45
+ * <p>Replication group message: <code>Failover from primary node <primary-node-id> to replica node <node-id> completed</code>
46
46
  * </p>
47
47
  * </li>
48
48
  * <li>
49
- * <p>Cache cluster message: <code>Recovering cache nodes <node-id></code>
49
+ * <p>Cache cluster message: <code>Recovering cache nodes <node-id></code>
50
50
  * </p>
51
51
  * </li>
52
52
  * <li>
53
- * <p>Cache cluster message: <code>Finished recovery for cache nodes <node-id></code>
53
+ * <p>Cache cluster message: <code>Finished recovery for cache nodes <node-id></code>
54
54
  * </p>
55
55
  * </li>
56
56
  * </ol>
57
- *
58
- * <p>For more information see:</p>
59
- * <ul>
57
+ * <p>For more information see:</p>
58
+ * <ul>
60
59
  * <li>
61
- * <p>
60
+ * <p>
62
61
  * <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ECEvents.Viewing.html">Viewing ElastiCache Events</a>
63
62
  * in the <i>ElastiCache User Guide</i>
64
63
  * </p>
65
64
  * </li>
66
65
  * <li>
67
- * <p>
66
+ * <p>
68
67
  * <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_DescribeEvents.html">DescribeEvents</a> in the ElastiCache API Reference</p>
69
68
  * </li>
70
69
  * </ul>
71
70
  * </li>
72
71
  * </ul>
73
- *
74
- * <p>Also see, <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/AutoFailover.html#auto-failover-test">Testing Multi-AZ </a> in the <i>ElastiCache User Guide</i>.</p>
72
+ * <p>Also see, <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/AutoFailover.html#auto-failover-test">Testing Multi-AZ </a> in the <i>ElastiCache User Guide</i>.</p>
75
73
  * @example
76
74
  * Use a bare-bones client and the command you need to make an API call.
77
75
  * ```javascript
@@ -12,7 +12,7 @@ export declare const resolveClientEndpointParameters: <T>(options: T & ClientInp
12
12
  defaultSigningName: string;
13
13
  };
14
14
  export interface EndpointParameters extends __EndpointParameters {
15
- Region?: string;
15
+ Region: string;
16
16
  UseDualStack?: boolean;
17
17
  UseFIPS?: boolean;
18
18
  Endpoint?: string;