@aws-sdk/client-elasticache 3.321.1 → 3.326.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 (66) hide show
  1. package/dist-types/commands/AddTagsToResourceCommand.d.ts +11 -0
  2. package/dist-types/commands/AuthorizeCacheSecurityGroupIngressCommand.d.ts +18 -0
  3. package/dist-types/commands/BatchApplyUpdateActionCommand.d.ts +22 -0
  4. package/dist-types/commands/BatchStopUpdateActionCommand.d.ts +22 -0
  5. package/dist-types/commands/CompleteMigrationCommand.d.ts +123 -0
  6. package/dist-types/commands/CopySnapshotCommand.d.ts +57 -0
  7. package/dist-types/commands/CreateCacheClusterCommand.d.ts +117 -0
  8. package/dist-types/commands/CreateCacheParameterGroupCommand.d.ts +12 -0
  9. package/dist-types/commands/CreateCacheSecurityGroupCommand.d.ts +18 -0
  10. package/dist-types/commands/CreateCacheSubnetGroupCommand.d.ts +28 -0
  11. package/dist-types/commands/CreateGlobalReplicationGroupCommand.d.ts +33 -0
  12. package/dist-types/commands/CreateReplicationGroupCommand.d.ts +123 -0
  13. package/dist-types/commands/CreateSnapshotCommand.d.ts +57 -0
  14. package/dist-types/commands/CreateUserCommand.d.ts +19 -0
  15. package/dist-types/commands/CreateUserGroupCommand.d.ts +24 -0
  16. package/dist-types/commands/DecreaseNodeGroupsInGlobalReplicationGroupCommand.d.ts +33 -0
  17. package/dist-types/commands/DecreaseReplicaCountCommand.d.ts +123 -0
  18. package/dist-types/commands/DeleteCacheClusterCommand.d.ts +117 -0
  19. package/dist-types/commands/DeleteCacheParameterGroupCommand.d.ts +4 -0
  20. package/dist-types/commands/DeleteCacheSecurityGroupCommand.d.ts +4 -0
  21. package/dist-types/commands/DeleteCacheSubnetGroupCommand.d.ts +4 -0
  22. package/dist-types/commands/DeleteGlobalReplicationGroupCommand.d.ts +33 -0
  23. package/dist-types/commands/DeleteReplicationGroupCommand.d.ts +123 -0
  24. package/dist-types/commands/DeleteSnapshotCommand.d.ts +57 -0
  25. package/dist-types/commands/DeleteUserCommand.d.ts +19 -0
  26. package/dist-types/commands/DeleteUserGroupCommand.d.ts +24 -0
  27. package/dist-types/commands/DescribeCacheClustersCommand.d.ts +120 -0
  28. package/dist-types/commands/DescribeCacheEngineVersionsCommand.d.ts +15 -0
  29. package/dist-types/commands/DescribeCacheParameterGroupsCommand.d.ts +15 -0
  30. package/dist-types/commands/DescribeCacheParametersCommand.d.ts +37 -0
  31. package/dist-types/commands/DescribeCacheSecurityGroupsCommand.d.ts +21 -0
  32. package/dist-types/commands/DescribeCacheSubnetGroupsCommand.d.ts +31 -0
  33. package/dist-types/commands/DescribeEngineDefaultParametersCommand.d.ts +40 -0
  34. package/dist-types/commands/DescribeEventsCommand.d.ts +14 -0
  35. package/dist-types/commands/DescribeGlobalReplicationGroupsCommand.d.ts +36 -0
  36. package/dist-types/commands/DescribeReplicationGroupsCommand.d.ts +126 -0
  37. package/dist-types/commands/DescribeReservedCacheNodesCommand.d.ts +28 -0
  38. package/dist-types/commands/DescribeReservedCacheNodesOfferingsCommand.d.ts +23 -0
  39. package/dist-types/commands/DescribeServiceUpdatesCommand.d.ts +22 -0
  40. package/dist-types/commands/DescribeSnapshotsCommand.d.ts +60 -0
  41. package/dist-types/commands/DescribeUpdateActionsCommand.d.ts +55 -0
  42. package/dist-types/commands/DescribeUserGroupsCommand.d.ts +29 -0
  43. package/dist-types/commands/DescribeUsersCommand.d.ts +24 -0
  44. package/dist-types/commands/DisassociateGlobalReplicationGroupCommand.d.ts +33 -0
  45. package/dist-types/commands/FailoverGlobalReplicationGroupCommand.d.ts +33 -0
  46. package/dist-types/commands/IncreaseNodeGroupsInGlobalReplicationGroupCommand.d.ts +33 -0
  47. package/dist-types/commands/IncreaseReplicaCountCommand.d.ts +123 -0
  48. package/dist-types/commands/ListAllowedNodeTypeModificationsCommand.d.ts +11 -0
  49. package/dist-types/commands/ListTagsForResourceCommand.d.ts +11 -0
  50. package/dist-types/commands/ModifyCacheClusterCommand.d.ts +117 -0
  51. package/dist-types/commands/ModifyCacheParameterGroupCommand.d.ts +6 -0
  52. package/dist-types/commands/ModifyCacheSubnetGroupCommand.d.ts +28 -0
  53. package/dist-types/commands/ModifyGlobalReplicationGroupCommand.d.ts +33 -0
  54. package/dist-types/commands/ModifyReplicationGroupCommand.d.ts +123 -0
  55. package/dist-types/commands/ModifyReplicationGroupShardConfigurationCommand.d.ts +123 -0
  56. package/dist-types/commands/ModifyUserCommand.d.ts +19 -0
  57. package/dist-types/commands/ModifyUserGroupCommand.d.ts +24 -0
  58. package/dist-types/commands/PurchaseReservedCacheNodesOfferingCommand.d.ts +25 -0
  59. package/dist-types/commands/RebalanceSlotsInGlobalReplicationGroupCommand.d.ts +33 -0
  60. package/dist-types/commands/RebootCacheClusterCommand.d.ts +117 -0
  61. package/dist-types/commands/RemoveTagsFromResourceCommand.d.ts +11 -0
  62. package/dist-types/commands/ResetCacheParameterGroupCommand.d.ts +6 -0
  63. package/dist-types/commands/RevokeCacheSecurityGroupIngressCommand.d.ts +18 -0
  64. package/dist-types/commands/StartMigrationCommand.d.ts +123 -0
  65. package/dist-types/commands/TestFailoverCommand.d.ts +123 -0
  66. package/package.json +16 -16
@@ -48,6 +48,15 @@ export interface AddTagsToResourceCommandOutput extends TagListMessage, __Metada
48
48
  * };
49
49
  * const command = new AddTagsToResourceCommand(input);
50
50
  * const response = await client.send(command);
51
+ * // { // TagListMessage
52
+ * // TagList: [ // TagList
53
+ * // { // Tag
54
+ * // Key: "STRING_VALUE",
55
+ * // Value: "STRING_VALUE",
56
+ * // },
57
+ * // ],
58
+ * // };
59
+ *
51
60
  * ```
52
61
  *
53
62
  * @param AddTagsToResourceCommandInput - {@link AddTagsToResourceCommandInput}
@@ -92,6 +101,8 @@ export interface AddTagsToResourceCommandOutput extends TagListMessage, __Metada
92
101
  * @throws {@link UserNotFoundFault} (client fault)
93
102
  * <p>The user does not exist or could not be found.</p>
94
103
  *
104
+ * @throws {@link ElastiCacheServiceException}
105
+ * <p>Base exception class for all service exceptions from ElastiCache service.</p>
95
106
  *
96
107
  * @example AddTagsToResource
97
108
  * ```javascript
@@ -39,6 +39,22 @@ export interface AuthorizeCacheSecurityGroupIngressCommandOutput extends Authori
39
39
  * };
40
40
  * const command = new AuthorizeCacheSecurityGroupIngressCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // { // AuthorizeCacheSecurityGroupIngressResult
43
+ * // CacheSecurityGroup: { // CacheSecurityGroup
44
+ * // OwnerId: "STRING_VALUE",
45
+ * // CacheSecurityGroupName: "STRING_VALUE",
46
+ * // Description: "STRING_VALUE",
47
+ * // EC2SecurityGroups: [ // EC2SecurityGroupList
48
+ * // { // EC2SecurityGroup
49
+ * // Status: "STRING_VALUE",
50
+ * // EC2SecurityGroupName: "STRING_VALUE",
51
+ * // EC2SecurityGroupOwnerId: "STRING_VALUE",
52
+ * // },
53
+ * // ],
54
+ * // ARN: "STRING_VALUE",
55
+ * // },
56
+ * // };
57
+ *
42
58
  * ```
43
59
  *
44
60
  * @param AuthorizeCacheSecurityGroupIngressCommandInput - {@link AuthorizeCacheSecurityGroupIngressCommandInput}
@@ -62,6 +78,8 @@ export interface AuthorizeCacheSecurityGroupIngressCommandOutput extends Authori
62
78
  * @throws {@link InvalidParameterValueException} (client fault)
63
79
  * <p>The value for a parameter is invalid.</p>
64
80
  *
81
+ * @throws {@link ElastiCacheServiceException}
82
+ * <p>Base exception class for all service exceptions from ElastiCache service.</p>
65
83
  *
66
84
  * @example AuthorizeCacheCacheSecurityGroupIngress
67
85
  * ```javascript
@@ -37,6 +37,26 @@ export interface BatchApplyUpdateActionCommandOutput extends UpdateActionResults
37
37
  * };
38
38
  * const command = new BatchApplyUpdateActionCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // { // UpdateActionResultsMessage
41
+ * // ProcessedUpdateActions: [ // ProcessedUpdateActionList
42
+ * // { // ProcessedUpdateAction
43
+ * // ReplicationGroupId: "STRING_VALUE",
44
+ * // CacheClusterId: "STRING_VALUE",
45
+ * // ServiceUpdateName: "STRING_VALUE",
46
+ * // UpdateActionStatus: "not-applied" || "waiting-to-start" || "in-progress" || "stopping" || "stopped" || "complete" || "scheduling" || "scheduled" || "not-applicable",
47
+ * // },
48
+ * // ],
49
+ * // UnprocessedUpdateActions: [ // UnprocessedUpdateActionList
50
+ * // { // UnprocessedUpdateAction
51
+ * // ReplicationGroupId: "STRING_VALUE",
52
+ * // CacheClusterId: "STRING_VALUE",
53
+ * // ServiceUpdateName: "STRING_VALUE",
54
+ * // ErrorType: "STRING_VALUE",
55
+ * // ErrorMessage: "STRING_VALUE",
56
+ * // },
57
+ * // ],
58
+ * // };
59
+ *
40
60
  * ```
41
61
  *
42
62
  * @param BatchApplyUpdateActionCommandInput - {@link BatchApplyUpdateActionCommandInput}
@@ -51,6 +71,8 @@ export interface BatchApplyUpdateActionCommandOutput extends UpdateActionResults
51
71
  * @throws {@link ServiceUpdateNotFoundFault} (client fault)
52
72
  * <p>The service update doesn't exist</p>
53
73
  *
74
+ * @throws {@link ElastiCacheServiceException}
75
+ * <p>Base exception class for all service exceptions from ElastiCache service.</p>
54
76
  *
55
77
  */
56
78
  export declare class BatchApplyUpdateActionCommand extends $Command<BatchApplyUpdateActionCommandInput, BatchApplyUpdateActionCommandOutput, ElastiCacheClientResolvedConfig> {
@@ -37,6 +37,26 @@ export interface BatchStopUpdateActionCommandOutput extends UpdateActionResultsM
37
37
  * };
38
38
  * const command = new BatchStopUpdateActionCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // { // UpdateActionResultsMessage
41
+ * // ProcessedUpdateActions: [ // ProcessedUpdateActionList
42
+ * // { // ProcessedUpdateAction
43
+ * // ReplicationGroupId: "STRING_VALUE",
44
+ * // CacheClusterId: "STRING_VALUE",
45
+ * // ServiceUpdateName: "STRING_VALUE",
46
+ * // UpdateActionStatus: "not-applied" || "waiting-to-start" || "in-progress" || "stopping" || "stopped" || "complete" || "scheduling" || "scheduled" || "not-applicable",
47
+ * // },
48
+ * // ],
49
+ * // UnprocessedUpdateActions: [ // UnprocessedUpdateActionList
50
+ * // { // UnprocessedUpdateAction
51
+ * // ReplicationGroupId: "STRING_VALUE",
52
+ * // CacheClusterId: "STRING_VALUE",
53
+ * // ServiceUpdateName: "STRING_VALUE",
54
+ * // ErrorType: "STRING_VALUE",
55
+ * // ErrorMessage: "STRING_VALUE",
56
+ * // },
57
+ * // ],
58
+ * // };
59
+ *
40
60
  * ```
41
61
  *
42
62
  * @param BatchStopUpdateActionCommandInput - {@link BatchStopUpdateActionCommandInput}
@@ -51,6 +71,8 @@ export interface BatchStopUpdateActionCommandOutput extends UpdateActionResultsM
51
71
  * @throws {@link ServiceUpdateNotFoundFault} (client fault)
52
72
  * <p>The service update doesn't exist</p>
53
73
  *
74
+ * @throws {@link ElastiCacheServiceException}
75
+ * <p>Base exception class for all service exceptions from ElastiCache service.</p>
54
76
  *
55
77
  */
56
78
  export declare class BatchStopUpdateActionCommand extends $Command<BatchStopUpdateActionCommandInput, BatchStopUpdateActionCommandOutput, ElastiCacheClientResolvedConfig> {
@@ -32,6 +32,127 @@ export interface CompleteMigrationCommandOutput extends CompleteMigrationRespons
32
32
  * };
33
33
  * const command = new CompleteMigrationCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // CompleteMigrationResponse
36
+ * // ReplicationGroup: { // ReplicationGroup
37
+ * // ReplicationGroupId: "STRING_VALUE",
38
+ * // Description: "STRING_VALUE",
39
+ * // GlobalReplicationGroupInfo: { // GlobalReplicationGroupInfo
40
+ * // GlobalReplicationGroupId: "STRING_VALUE",
41
+ * // GlobalReplicationGroupMemberRole: "STRING_VALUE",
42
+ * // },
43
+ * // Status: "STRING_VALUE",
44
+ * // PendingModifiedValues: { // ReplicationGroupPendingModifiedValues
45
+ * // PrimaryClusterId: "STRING_VALUE",
46
+ * // AutomaticFailoverStatus: "enabled" || "disabled",
47
+ * // Resharding: { // ReshardingStatus
48
+ * // SlotMigration: { // SlotMigration
49
+ * // ProgressPercentage: Number("double"),
50
+ * // },
51
+ * // },
52
+ * // AuthTokenStatus: "SETTING" || "ROTATING",
53
+ * // UserGroups: { // UserGroupsUpdateStatus
54
+ * // UserGroupIdsToAdd: [ // UserGroupIdList
55
+ * // "STRING_VALUE",
56
+ * // ],
57
+ * // UserGroupIdsToRemove: [
58
+ * // "STRING_VALUE",
59
+ * // ],
60
+ * // },
61
+ * // LogDeliveryConfigurations: [ // PendingLogDeliveryConfigurationList
62
+ * // { // PendingLogDeliveryConfiguration
63
+ * // LogType: "slow-log" || "engine-log",
64
+ * // DestinationType: "cloudwatch-logs" || "kinesis-firehose",
65
+ * // DestinationDetails: { // DestinationDetails
66
+ * // CloudWatchLogsDetails: { // CloudWatchLogsDestinationDetails
67
+ * // LogGroup: "STRING_VALUE",
68
+ * // },
69
+ * // KinesisFirehoseDetails: { // KinesisFirehoseDestinationDetails
70
+ * // DeliveryStream: "STRING_VALUE",
71
+ * // },
72
+ * // },
73
+ * // LogFormat: "text" || "json",
74
+ * // },
75
+ * // ],
76
+ * // TransitEncryptionEnabled: true || false,
77
+ * // TransitEncryptionMode: "preferred" || "required",
78
+ * // },
79
+ * // MemberClusters: [ // ClusterIdList
80
+ * // "STRING_VALUE",
81
+ * // ],
82
+ * // NodeGroups: [ // NodeGroupList
83
+ * // { // NodeGroup
84
+ * // NodeGroupId: "STRING_VALUE",
85
+ * // Status: "STRING_VALUE",
86
+ * // PrimaryEndpoint: { // Endpoint
87
+ * // Address: "STRING_VALUE",
88
+ * // Port: Number("int"),
89
+ * // },
90
+ * // ReaderEndpoint: {
91
+ * // Address: "STRING_VALUE",
92
+ * // Port: Number("int"),
93
+ * // },
94
+ * // Slots: "STRING_VALUE",
95
+ * // NodeGroupMembers: [ // NodeGroupMemberList
96
+ * // { // NodeGroupMember
97
+ * // CacheClusterId: "STRING_VALUE",
98
+ * // CacheNodeId: "STRING_VALUE",
99
+ * // ReadEndpoint: {
100
+ * // Address: "STRING_VALUE",
101
+ * // Port: Number("int"),
102
+ * // },
103
+ * // PreferredAvailabilityZone: "STRING_VALUE",
104
+ * // PreferredOutpostArn: "STRING_VALUE",
105
+ * // CurrentRole: "STRING_VALUE",
106
+ * // },
107
+ * // ],
108
+ * // },
109
+ * // ],
110
+ * // SnapshottingClusterId: "STRING_VALUE",
111
+ * // AutomaticFailover: "enabled" || "disabled" || "enabling" || "disabling",
112
+ * // MultiAZ: "enabled" || "disabled",
113
+ * // ConfigurationEndpoint: "<Endpoint>",
114
+ * // SnapshotRetentionLimit: Number("int"),
115
+ * // SnapshotWindow: "STRING_VALUE",
116
+ * // ClusterEnabled: true || false,
117
+ * // CacheNodeType: "STRING_VALUE",
118
+ * // AuthTokenEnabled: true || false,
119
+ * // AuthTokenLastModifiedDate: new Date("TIMESTAMP"),
120
+ * // TransitEncryptionEnabled: true || false,
121
+ * // AtRestEncryptionEnabled: true || false,
122
+ * // MemberClustersOutpostArns: [ // ReplicationGroupOutpostArnList
123
+ * // "STRING_VALUE",
124
+ * // ],
125
+ * // KmsKeyId: "STRING_VALUE",
126
+ * // ARN: "STRING_VALUE",
127
+ * // UserGroupIds: [
128
+ * // "STRING_VALUE",
129
+ * // ],
130
+ * // LogDeliveryConfigurations: [ // LogDeliveryConfigurationList
131
+ * // { // LogDeliveryConfiguration
132
+ * // LogType: "slow-log" || "engine-log",
133
+ * // DestinationType: "cloudwatch-logs" || "kinesis-firehose",
134
+ * // DestinationDetails: {
135
+ * // CloudWatchLogsDetails: {
136
+ * // LogGroup: "STRING_VALUE",
137
+ * // },
138
+ * // KinesisFirehoseDetails: {
139
+ * // DeliveryStream: "STRING_VALUE",
140
+ * // },
141
+ * // },
142
+ * // LogFormat: "text" || "json",
143
+ * // Status: "active" || "enabling" || "modifying" || "disabling" || "error",
144
+ * // Message: "STRING_VALUE",
145
+ * // },
146
+ * // ],
147
+ * // ReplicationGroupCreateTime: new Date("TIMESTAMP"),
148
+ * // DataTiering: "enabled" || "disabled",
149
+ * // AutoMinorVersionUpgrade: true || false,
150
+ * // NetworkType: "ipv4" || "ipv6" || "dual_stack",
151
+ * // IpDiscovery: "ipv4" || "ipv6",
152
+ * // TransitEncryptionMode: "preferred" || "required",
153
+ * // },
154
+ * // };
155
+ *
35
156
  * ```
36
157
  *
37
158
  * @param CompleteMigrationCommandInput - {@link CompleteMigrationCommandInput}
@@ -49,6 +170,8 @@ export interface CompleteMigrationCommandOutput extends CompleteMigrationRespons
49
170
  * @throws {@link ReplicationGroupNotUnderMigrationFault} (client fault)
50
171
  * <p>The designated replication group is not available for data migration.</p>
51
172
  *
173
+ * @throws {@link ElastiCacheServiceException}
174
+ * <p>Base exception class for all service exceptions from ElastiCache service.</p>
52
175
  *
53
176
  */
54
177
  export declare class CompleteMigrationCommand extends $Command<CompleteMigrationCommandInput, CompleteMigrationCommandOutput, ElastiCacheClientResolvedConfig> {
@@ -130,6 +130,61 @@ export interface CopySnapshotCommandOutput extends CopySnapshotResult, __Metadat
130
130
  * };
131
131
  * const command = new CopySnapshotCommand(input);
132
132
  * const response = await client.send(command);
133
+ * // { // CopySnapshotResult
134
+ * // Snapshot: { // Snapshot
135
+ * // SnapshotName: "STRING_VALUE",
136
+ * // ReplicationGroupId: "STRING_VALUE",
137
+ * // ReplicationGroupDescription: "STRING_VALUE",
138
+ * // CacheClusterId: "STRING_VALUE",
139
+ * // SnapshotStatus: "STRING_VALUE",
140
+ * // SnapshotSource: "STRING_VALUE",
141
+ * // CacheNodeType: "STRING_VALUE",
142
+ * // Engine: "STRING_VALUE",
143
+ * // EngineVersion: "STRING_VALUE",
144
+ * // NumCacheNodes: Number("int"),
145
+ * // PreferredAvailabilityZone: "STRING_VALUE",
146
+ * // PreferredOutpostArn: "STRING_VALUE",
147
+ * // CacheClusterCreateTime: new Date("TIMESTAMP"),
148
+ * // PreferredMaintenanceWindow: "STRING_VALUE",
149
+ * // TopicArn: "STRING_VALUE",
150
+ * // Port: Number("int"),
151
+ * // CacheParameterGroupName: "STRING_VALUE",
152
+ * // CacheSubnetGroupName: "STRING_VALUE",
153
+ * // VpcId: "STRING_VALUE",
154
+ * // AutoMinorVersionUpgrade: true || false,
155
+ * // SnapshotRetentionLimit: Number("int"),
156
+ * // SnapshotWindow: "STRING_VALUE",
157
+ * // NumNodeGroups: Number("int"),
158
+ * // AutomaticFailover: "enabled" || "disabled" || "enabling" || "disabling",
159
+ * // NodeSnapshots: [ // NodeSnapshotList
160
+ * // { // NodeSnapshot
161
+ * // CacheClusterId: "STRING_VALUE",
162
+ * // NodeGroupId: "STRING_VALUE",
163
+ * // CacheNodeId: "STRING_VALUE",
164
+ * // NodeGroupConfiguration: { // NodeGroupConfiguration
165
+ * // NodeGroupId: "STRING_VALUE",
166
+ * // Slots: "STRING_VALUE",
167
+ * // ReplicaCount: Number("int"),
168
+ * // PrimaryAvailabilityZone: "STRING_VALUE",
169
+ * // ReplicaAvailabilityZones: [ // AvailabilityZonesList
170
+ * // "STRING_VALUE",
171
+ * // ],
172
+ * // PrimaryOutpostArn: "STRING_VALUE",
173
+ * // ReplicaOutpostArns: [ // OutpostArnsList
174
+ * // "STRING_VALUE",
175
+ * // ],
176
+ * // },
177
+ * // CacheSize: "STRING_VALUE",
178
+ * // CacheNodeCreateTime: new Date("TIMESTAMP"),
179
+ * // SnapshotCreateTime: new Date("TIMESTAMP"),
180
+ * // },
181
+ * // ],
182
+ * // KmsKeyId: "STRING_VALUE",
183
+ * // ARN: "STRING_VALUE",
184
+ * // DataTiering: "enabled" || "disabled",
185
+ * // },
186
+ * // };
187
+ *
133
188
  * ```
134
189
  *
135
190
  * @param CopySnapshotCommandInput - {@link CopySnapshotCommandInput}
@@ -159,6 +214,8 @@ export interface CopySnapshotCommandOutput extends CopySnapshotResult, __Metadat
159
214
  * @throws {@link TagQuotaPerResourceExceeded} (client fault)
160
215
  * <p>The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.</p>
161
216
  *
217
+ * @throws {@link ElastiCacheServiceException}
218
+ * <p>Base exception class for all service exceptions from ElastiCache service.</p>
162
219
  *
163
220
  * @example CopySnapshot
164
221
  * ```javascript
@@ -93,6 +93,121 @@ export interface CreateCacheClusterCommandOutput extends CreateCacheClusterResul
93
93
  * };
94
94
  * const command = new CreateCacheClusterCommand(input);
95
95
  * const response = await client.send(command);
96
+ * // { // CreateCacheClusterResult
97
+ * // CacheCluster: { // CacheCluster
98
+ * // CacheClusterId: "STRING_VALUE",
99
+ * // ConfigurationEndpoint: { // Endpoint
100
+ * // Address: "STRING_VALUE",
101
+ * // Port: Number("int"),
102
+ * // },
103
+ * // ClientDownloadLandingPage: "STRING_VALUE",
104
+ * // CacheNodeType: "STRING_VALUE",
105
+ * // Engine: "STRING_VALUE",
106
+ * // EngineVersion: "STRING_VALUE",
107
+ * // CacheClusterStatus: "STRING_VALUE",
108
+ * // NumCacheNodes: Number("int"),
109
+ * // PreferredAvailabilityZone: "STRING_VALUE",
110
+ * // PreferredOutpostArn: "STRING_VALUE",
111
+ * // CacheClusterCreateTime: new Date("TIMESTAMP"),
112
+ * // PreferredMaintenanceWindow: "STRING_VALUE",
113
+ * // PendingModifiedValues: { // PendingModifiedValues
114
+ * // NumCacheNodes: Number("int"),
115
+ * // CacheNodeIdsToRemove: [ // CacheNodeIdsList
116
+ * // "STRING_VALUE",
117
+ * // ],
118
+ * // EngineVersion: "STRING_VALUE",
119
+ * // CacheNodeType: "STRING_VALUE",
120
+ * // AuthTokenStatus: "SETTING" || "ROTATING",
121
+ * // LogDeliveryConfigurations: [ // PendingLogDeliveryConfigurationList
122
+ * // { // PendingLogDeliveryConfiguration
123
+ * // LogType: "slow-log" || "engine-log",
124
+ * // DestinationType: "cloudwatch-logs" || "kinesis-firehose",
125
+ * // DestinationDetails: { // DestinationDetails
126
+ * // CloudWatchLogsDetails: { // CloudWatchLogsDestinationDetails
127
+ * // LogGroup: "STRING_VALUE",
128
+ * // },
129
+ * // KinesisFirehoseDetails: { // KinesisFirehoseDestinationDetails
130
+ * // DeliveryStream: "STRING_VALUE",
131
+ * // },
132
+ * // },
133
+ * // LogFormat: "text" || "json",
134
+ * // },
135
+ * // ],
136
+ * // TransitEncryptionEnabled: true || false,
137
+ * // TransitEncryptionMode: "preferred" || "required",
138
+ * // },
139
+ * // NotificationConfiguration: { // NotificationConfiguration
140
+ * // TopicArn: "STRING_VALUE",
141
+ * // TopicStatus: "STRING_VALUE",
142
+ * // },
143
+ * // CacheSecurityGroups: [ // CacheSecurityGroupMembershipList
144
+ * // { // CacheSecurityGroupMembership
145
+ * // CacheSecurityGroupName: "STRING_VALUE",
146
+ * // Status: "STRING_VALUE",
147
+ * // },
148
+ * // ],
149
+ * // CacheParameterGroup: { // CacheParameterGroupStatus
150
+ * // CacheParameterGroupName: "STRING_VALUE",
151
+ * // ParameterApplyStatus: "STRING_VALUE",
152
+ * // CacheNodeIdsToReboot: [
153
+ * // "STRING_VALUE",
154
+ * // ],
155
+ * // },
156
+ * // CacheSubnetGroupName: "STRING_VALUE",
157
+ * // CacheNodes: [ // CacheNodeList
158
+ * // { // CacheNode
159
+ * // CacheNodeId: "STRING_VALUE",
160
+ * // CacheNodeStatus: "STRING_VALUE",
161
+ * // CacheNodeCreateTime: new Date("TIMESTAMP"),
162
+ * // Endpoint: {
163
+ * // Address: "STRING_VALUE",
164
+ * // Port: Number("int"),
165
+ * // },
166
+ * // ParameterGroupStatus: "STRING_VALUE",
167
+ * // SourceCacheNodeId: "STRING_VALUE",
168
+ * // CustomerAvailabilityZone: "STRING_VALUE",
169
+ * // CustomerOutpostArn: "STRING_VALUE",
170
+ * // },
171
+ * // ],
172
+ * // AutoMinorVersionUpgrade: true || false,
173
+ * // SecurityGroups: [ // SecurityGroupMembershipList
174
+ * // { // SecurityGroupMembership
175
+ * // SecurityGroupId: "STRING_VALUE",
176
+ * // Status: "STRING_VALUE",
177
+ * // },
178
+ * // ],
179
+ * // ReplicationGroupId: "STRING_VALUE",
180
+ * // SnapshotRetentionLimit: Number("int"),
181
+ * // SnapshotWindow: "STRING_VALUE",
182
+ * // AuthTokenEnabled: true || false,
183
+ * // AuthTokenLastModifiedDate: new Date("TIMESTAMP"),
184
+ * // TransitEncryptionEnabled: true || false,
185
+ * // AtRestEncryptionEnabled: true || false,
186
+ * // ARN: "STRING_VALUE",
187
+ * // ReplicationGroupLogDeliveryEnabled: true || false,
188
+ * // LogDeliveryConfigurations: [ // LogDeliveryConfigurationList
189
+ * // { // LogDeliveryConfiguration
190
+ * // LogType: "slow-log" || "engine-log",
191
+ * // DestinationType: "cloudwatch-logs" || "kinesis-firehose",
192
+ * // DestinationDetails: {
193
+ * // CloudWatchLogsDetails: {
194
+ * // LogGroup: "STRING_VALUE",
195
+ * // },
196
+ * // KinesisFirehoseDetails: {
197
+ * // DeliveryStream: "STRING_VALUE",
198
+ * // },
199
+ * // },
200
+ * // LogFormat: "text" || "json",
201
+ * // Status: "active" || "enabling" || "modifying" || "disabling" || "error",
202
+ * // Message: "STRING_VALUE",
203
+ * // },
204
+ * // ],
205
+ * // NetworkType: "ipv4" || "ipv6" || "dual_stack",
206
+ * // IpDiscovery: "ipv4" || "ipv6",
207
+ * // TransitEncryptionMode: "preferred" || "required",
208
+ * // },
209
+ * // };
210
+ *
96
211
  * ```
97
212
  *
98
213
  * @param CreateCacheClusterCommandInput - {@link CreateCacheClusterCommandInput}
@@ -144,6 +259,8 @@ export interface CreateCacheClusterCommandOutput extends CreateCacheClusterResul
144
259
  * @throws {@link TagQuotaPerResourceExceeded} (client fault)
145
260
  * <p>The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.</p>
146
261
  *
262
+ * @throws {@link ElastiCacheServiceException}
263
+ * <p>Base exception class for all service exceptions from ElastiCache service.</p>
147
264
  *
148
265
  * @example CreateCacheCluster
149
266
  * ```javascript
@@ -54,6 +54,16 @@ export interface CreateCacheParameterGroupCommandOutput extends CreateCacheParam
54
54
  * };
55
55
  * const command = new CreateCacheParameterGroupCommand(input);
56
56
  * const response = await client.send(command);
57
+ * // { // CreateCacheParameterGroupResult
58
+ * // CacheParameterGroup: { // CacheParameterGroup
59
+ * // CacheParameterGroupName: "STRING_VALUE",
60
+ * // CacheParameterGroupFamily: "STRING_VALUE",
61
+ * // Description: "STRING_VALUE",
62
+ * // IsGlobal: true || false,
63
+ * // ARN: "STRING_VALUE",
64
+ * // },
65
+ * // };
66
+ *
57
67
  * ```
58
68
  *
59
69
  * @param CreateCacheParameterGroupCommandInput - {@link CreateCacheParameterGroupCommandInput}
@@ -80,6 +90,8 @@ export interface CreateCacheParameterGroupCommandOutput extends CreateCacheParam
80
90
  * @throws {@link TagQuotaPerResourceExceeded} (client fault)
81
91
  * <p>The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.</p>
82
92
  *
93
+ * @throws {@link ElastiCacheServiceException}
94
+ * <p>Base exception class for all service exceptions from ElastiCache service.</p>
83
95
  *
84
96
  * @example CreateCacheParameterGroup
85
97
  * ```javascript
@@ -43,6 +43,22 @@ export interface CreateCacheSecurityGroupCommandOutput extends CreateCacheSecuri
43
43
  * };
44
44
  * const command = new CreateCacheSecurityGroupCommand(input);
45
45
  * const response = await client.send(command);
46
+ * // { // CreateCacheSecurityGroupResult
47
+ * // CacheSecurityGroup: { // CacheSecurityGroup
48
+ * // OwnerId: "STRING_VALUE",
49
+ * // CacheSecurityGroupName: "STRING_VALUE",
50
+ * // Description: "STRING_VALUE",
51
+ * // EC2SecurityGroups: [ // EC2SecurityGroupList
52
+ * // { // EC2SecurityGroup
53
+ * // Status: "STRING_VALUE",
54
+ * // EC2SecurityGroupName: "STRING_VALUE",
55
+ * // EC2SecurityGroupOwnerId: "STRING_VALUE",
56
+ * // },
57
+ * // ],
58
+ * // ARN: "STRING_VALUE",
59
+ * // },
60
+ * // };
61
+ *
46
62
  * ```
47
63
  *
48
64
  * @param CreateCacheSecurityGroupCommandInput - {@link CreateCacheSecurityGroupCommandInput}
@@ -66,6 +82,8 @@ export interface CreateCacheSecurityGroupCommandOutput extends CreateCacheSecuri
66
82
  * @throws {@link TagQuotaPerResourceExceeded} (client fault)
67
83
  * <p>The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.</p>
68
84
  *
85
+ * @throws {@link ElastiCacheServiceException}
86
+ * <p>Base exception class for all service exceptions from ElastiCache service.</p>
69
87
  *
70
88
  * @example CreateCacheSecurityGroup
71
89
  * ```javascript
@@ -42,6 +42,32 @@ export interface CreateCacheSubnetGroupCommandOutput extends CreateCacheSubnetGr
42
42
  * };
43
43
  * const command = new CreateCacheSubnetGroupCommand(input);
44
44
  * const response = await client.send(command);
45
+ * // { // CreateCacheSubnetGroupResult
46
+ * // CacheSubnetGroup: { // CacheSubnetGroup
47
+ * // CacheSubnetGroupName: "STRING_VALUE",
48
+ * // CacheSubnetGroupDescription: "STRING_VALUE",
49
+ * // VpcId: "STRING_VALUE",
50
+ * // Subnets: [ // SubnetList
51
+ * // { // Subnet
52
+ * // SubnetIdentifier: "STRING_VALUE",
53
+ * // SubnetAvailabilityZone: { // AvailabilityZone
54
+ * // Name: "STRING_VALUE",
55
+ * // },
56
+ * // SubnetOutpost: { // SubnetOutpost
57
+ * // SubnetOutpostArn: "STRING_VALUE",
58
+ * // },
59
+ * // SupportedNetworkTypes: [ // NetworkTypeList
60
+ * // "ipv4" || "ipv6" || "dual_stack",
61
+ * // ],
62
+ * // },
63
+ * // ],
64
+ * // ARN: "STRING_VALUE",
65
+ * // SupportedNetworkTypes: [
66
+ * // "ipv4" || "ipv6" || "dual_stack",
67
+ * // ],
68
+ * // },
69
+ * // };
70
+ *
45
71
  * ```
46
72
  *
47
73
  * @param CreateCacheSubnetGroupCommandInput - {@link CreateCacheSubnetGroupCommandInput}
@@ -69,6 +95,8 @@ export interface CreateCacheSubnetGroupCommandOutput extends CreateCacheSubnetGr
69
95
  * @throws {@link TagQuotaPerResourceExceeded} (client fault)
70
96
  * <p>The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.</p>
71
97
  *
98
+ * @throws {@link ElastiCacheServiceException}
99
+ * <p>Base exception class for all service exceptions from ElastiCache service.</p>
72
100
  *
73
101
  * @example CreateCacheSubnet
74
102
  * ```javascript
@@ -47,6 +47,37 @@ export interface CreateGlobalReplicationGroupCommandOutput extends CreateGlobalR
47
47
  * };
48
48
  * const command = new CreateGlobalReplicationGroupCommand(input);
49
49
  * const response = await client.send(command);
50
+ * // { // CreateGlobalReplicationGroupResult
51
+ * // GlobalReplicationGroup: { // GlobalReplicationGroup
52
+ * // GlobalReplicationGroupId: "STRING_VALUE",
53
+ * // GlobalReplicationGroupDescription: "STRING_VALUE",
54
+ * // Status: "STRING_VALUE",
55
+ * // CacheNodeType: "STRING_VALUE",
56
+ * // Engine: "STRING_VALUE",
57
+ * // EngineVersion: "STRING_VALUE",
58
+ * // Members: [ // GlobalReplicationGroupMemberList
59
+ * // { // GlobalReplicationGroupMember
60
+ * // ReplicationGroupId: "STRING_VALUE",
61
+ * // ReplicationGroupRegion: "STRING_VALUE",
62
+ * // Role: "STRING_VALUE",
63
+ * // AutomaticFailover: "enabled" || "disabled" || "enabling" || "disabling",
64
+ * // Status: "STRING_VALUE",
65
+ * // },
66
+ * // ],
67
+ * // ClusterEnabled: true || false,
68
+ * // GlobalNodeGroups: [ // GlobalNodeGroupList
69
+ * // { // GlobalNodeGroup
70
+ * // GlobalNodeGroupId: "STRING_VALUE",
71
+ * // Slots: "STRING_VALUE",
72
+ * // },
73
+ * // ],
74
+ * // AuthTokenEnabled: true || false,
75
+ * // TransitEncryptionEnabled: true || false,
76
+ * // AtRestEncryptionEnabled: true || false,
77
+ * // ARN: "STRING_VALUE",
78
+ * // },
79
+ * // };
80
+ *
50
81
  * ```
51
82
  *
52
83
  * @param CreateGlobalReplicationGroupCommandInput - {@link CreateGlobalReplicationGroupCommandInput}
@@ -70,6 +101,8 @@ export interface CreateGlobalReplicationGroupCommandOutput extends CreateGlobalR
70
101
  * @throws {@link ServiceLinkedRoleNotFoundFault} (client fault)
71
102
  * <p>The specified service linked role (SLR) was not found.</p>
72
103
  *
104
+ * @throws {@link ElastiCacheServiceException}
105
+ * <p>Base exception class for all service exceptions from ElastiCache service.</p>
73
106
  *
74
107
  */
75
108
  export declare class CreateGlobalReplicationGroupCommand extends $Command<CreateGlobalReplicationGroupCommandInput, CreateGlobalReplicationGroupCommandOutput, ElastiCacheClientResolvedConfig> {