aws-sdk-elasticache 1.2.0 → 1.3.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.
- checksums.yaml +4 -4
- data/lib/aws-sdk-elasticache.rb +1 -1
- data/lib/aws-sdk-elasticache/client.rb +273 -178
- data/lib/aws-sdk-elasticache/client_api.rb +48 -0
- data/lib/aws-sdk-elasticache/types.rb +358 -257
- metadata +2 -2
@@ -137,6 +137,8 @@ module Aws::ElastiCache
|
|
137
137
|
ModifyCacheSubnetGroupResult = Shapes::StructureShape.new(name: 'ModifyCacheSubnetGroupResult')
|
138
138
|
ModifyReplicationGroupMessage = Shapes::StructureShape.new(name: 'ModifyReplicationGroupMessage')
|
139
139
|
ModifyReplicationGroupResult = Shapes::StructureShape.new(name: 'ModifyReplicationGroupResult')
|
140
|
+
ModifyReplicationGroupShardConfigurationMessage = Shapes::StructureShape.new(name: 'ModifyReplicationGroupShardConfigurationMessage')
|
141
|
+
ModifyReplicationGroupShardConfigurationResult = Shapes::StructureShape.new(name: 'ModifyReplicationGroupShardConfigurationResult')
|
140
142
|
NodeGroup = Shapes::StructureShape.new(name: 'NodeGroup')
|
141
143
|
NodeGroupConfiguration = Shapes::StructureShape.new(name: 'NodeGroupConfiguration')
|
142
144
|
NodeGroupConfigurationList = Shapes::ListShape.new(name: 'NodeGroupConfigurationList')
|
@@ -145,6 +147,7 @@ module Aws::ElastiCache
|
|
145
147
|
NodeGroupMemberList = Shapes::ListShape.new(name: 'NodeGroupMemberList')
|
146
148
|
NodeGroupNotFoundFault = Shapes::StructureShape.new(name: 'NodeGroupNotFoundFault')
|
147
149
|
NodeGroupsPerReplicationGroupQuotaExceededFault = Shapes::StructureShape.new(name: 'NodeGroupsPerReplicationGroupQuotaExceededFault')
|
150
|
+
NodeGroupsToRemoveList = Shapes::ListShape.new(name: 'NodeGroupsToRemoveList')
|
148
151
|
NodeQuotaForClusterExceededFault = Shapes::StructureShape.new(name: 'NodeQuotaForClusterExceededFault')
|
149
152
|
NodeQuotaForCustomerExceededFault = Shapes::StructureShape.new(name: 'NodeQuotaForCustomerExceededFault')
|
150
153
|
NodeSnapshot = Shapes::StructureShape.new(name: 'NodeSnapshot')
|
@@ -182,11 +185,15 @@ module Aws::ElastiCache
|
|
182
185
|
ReservedCacheNodesOfferingMessage = Shapes::StructureShape.new(name: 'ReservedCacheNodesOfferingMessage')
|
183
186
|
ReservedCacheNodesOfferingNotFoundFault = Shapes::StructureShape.new(name: 'ReservedCacheNodesOfferingNotFoundFault')
|
184
187
|
ResetCacheParameterGroupMessage = Shapes::StructureShape.new(name: 'ResetCacheParameterGroupMessage')
|
188
|
+
ReshardingConfiguration = Shapes::StructureShape.new(name: 'ReshardingConfiguration')
|
189
|
+
ReshardingConfigurationList = Shapes::ListShape.new(name: 'ReshardingConfigurationList')
|
190
|
+
ReshardingStatus = Shapes::StructureShape.new(name: 'ReshardingStatus')
|
185
191
|
RevokeCacheSecurityGroupIngressMessage = Shapes::StructureShape.new(name: 'RevokeCacheSecurityGroupIngressMessage')
|
186
192
|
RevokeCacheSecurityGroupIngressResult = Shapes::StructureShape.new(name: 'RevokeCacheSecurityGroupIngressResult')
|
187
193
|
SecurityGroupIdsList = Shapes::ListShape.new(name: 'SecurityGroupIdsList')
|
188
194
|
SecurityGroupMembership = Shapes::StructureShape.new(name: 'SecurityGroupMembership')
|
189
195
|
SecurityGroupMembershipList = Shapes::ListShape.new(name: 'SecurityGroupMembershipList')
|
196
|
+
SlotMigration = Shapes::StructureShape.new(name: 'SlotMigration')
|
190
197
|
Snapshot = Shapes::StructureShape.new(name: 'Snapshot')
|
191
198
|
SnapshotAlreadyExistsFault = Shapes::StructureShape.new(name: 'SnapshotAlreadyExistsFault')
|
192
199
|
SnapshotArnsList = Shapes::ListShape.new(name: 'SnapshotArnsList')
|
@@ -681,6 +688,16 @@ module Aws::ElastiCache
|
|
681
688
|
ModifyReplicationGroupResult.add_member(:replication_group, Shapes::ShapeRef.new(shape: ReplicationGroup, location_name: "ReplicationGroup"))
|
682
689
|
ModifyReplicationGroupResult.struct_class = Types::ModifyReplicationGroupResult
|
683
690
|
|
691
|
+
ModifyReplicationGroupShardConfigurationMessage.add_member(:replication_group_id, Shapes::ShapeRef.new(shape: String, required: true, location_name: "ReplicationGroupId"))
|
692
|
+
ModifyReplicationGroupShardConfigurationMessage.add_member(:node_group_count, Shapes::ShapeRef.new(shape: Integer, required: true, location_name: "NodeGroupCount"))
|
693
|
+
ModifyReplicationGroupShardConfigurationMessage.add_member(:apply_immediately, Shapes::ShapeRef.new(shape: Boolean, required: true, location_name: "ApplyImmediately"))
|
694
|
+
ModifyReplicationGroupShardConfigurationMessage.add_member(:resharding_configuration, Shapes::ShapeRef.new(shape: ReshardingConfigurationList, location_name: "ReshardingConfiguration"))
|
695
|
+
ModifyReplicationGroupShardConfigurationMessage.add_member(:node_groups_to_remove, Shapes::ShapeRef.new(shape: NodeGroupsToRemoveList, location_name: "NodeGroupsToRemove"))
|
696
|
+
ModifyReplicationGroupShardConfigurationMessage.struct_class = Types::ModifyReplicationGroupShardConfigurationMessage
|
697
|
+
|
698
|
+
ModifyReplicationGroupShardConfigurationResult.add_member(:replication_group, Shapes::ShapeRef.new(shape: ReplicationGroup, location_name: "ReplicationGroup"))
|
699
|
+
ModifyReplicationGroupShardConfigurationResult.struct_class = Types::ModifyReplicationGroupShardConfigurationResult
|
700
|
+
|
684
701
|
NodeGroup.add_member(:node_group_id, Shapes::ShapeRef.new(shape: String, location_name: "NodeGroupId"))
|
685
702
|
NodeGroup.add_member(:status, Shapes::ShapeRef.new(shape: String, location_name: "Status"))
|
686
703
|
NodeGroup.add_member(:primary_endpoint, Shapes::ShapeRef.new(shape: Endpoint, location_name: "PrimaryEndpoint"))
|
@@ -707,6 +724,8 @@ module Aws::ElastiCache
|
|
707
724
|
|
708
725
|
NodeGroupMemberList.member = Shapes::ShapeRef.new(shape: NodeGroupMember, location_name: "NodeGroupMember")
|
709
726
|
|
727
|
+
NodeGroupsToRemoveList.member = Shapes::ShapeRef.new(shape: String, location_name: "NodeGroupToRemove")
|
728
|
+
|
710
729
|
NodeSnapshot.add_member(:cache_cluster_id, Shapes::ShapeRef.new(shape: String, location_name: "CacheClusterId"))
|
711
730
|
NodeSnapshot.add_member(:node_group_id, Shapes::ShapeRef.new(shape: String, location_name: "NodeGroupId"))
|
712
731
|
NodeSnapshot.add_member(:cache_node_id, Shapes::ShapeRef.new(shape: String, location_name: "CacheNodeId"))
|
@@ -802,6 +821,7 @@ module Aws::ElastiCache
|
|
802
821
|
|
803
822
|
ReplicationGroupPendingModifiedValues.add_member(:primary_cluster_id, Shapes::ShapeRef.new(shape: String, location_name: "PrimaryClusterId"))
|
804
823
|
ReplicationGroupPendingModifiedValues.add_member(:automatic_failover_status, Shapes::ShapeRef.new(shape: PendingAutomaticFailoverStatus, location_name: "AutomaticFailoverStatus"))
|
824
|
+
ReplicationGroupPendingModifiedValues.add_member(:resharding, Shapes::ShapeRef.new(shape: ReshardingStatus, location_name: "Resharding"))
|
805
825
|
ReplicationGroupPendingModifiedValues.struct_class = Types::ReplicationGroupPendingModifiedValues
|
806
826
|
|
807
827
|
ReservedCacheNode.add_member(:reserved_cache_node_id, Shapes::ShapeRef.new(shape: String, location_name: "ReservedCacheNodeId"))
|
@@ -845,6 +865,14 @@ module Aws::ElastiCache
|
|
845
865
|
ResetCacheParameterGroupMessage.add_member(:parameter_name_values, Shapes::ShapeRef.new(shape: ParameterNameValueList, location_name: "ParameterNameValues"))
|
846
866
|
ResetCacheParameterGroupMessage.struct_class = Types::ResetCacheParameterGroupMessage
|
847
867
|
|
868
|
+
ReshardingConfiguration.add_member(:preferred_availability_zones, Shapes::ShapeRef.new(shape: AvailabilityZonesList, location_name: "PreferredAvailabilityZones"))
|
869
|
+
ReshardingConfiguration.struct_class = Types::ReshardingConfiguration
|
870
|
+
|
871
|
+
ReshardingConfigurationList.member = Shapes::ShapeRef.new(shape: ReshardingConfiguration, location_name: "ReshardingConfiguration")
|
872
|
+
|
873
|
+
ReshardingStatus.add_member(:slot_migration, Shapes::ShapeRef.new(shape: SlotMigration, location_name: "SlotMigration"))
|
874
|
+
ReshardingStatus.struct_class = Types::ReshardingStatus
|
875
|
+
|
848
876
|
RevokeCacheSecurityGroupIngressMessage.add_member(:cache_security_group_name, Shapes::ShapeRef.new(shape: String, required: true, location_name: "CacheSecurityGroupName"))
|
849
877
|
RevokeCacheSecurityGroupIngressMessage.add_member(:ec2_security_group_name, Shapes::ShapeRef.new(shape: String, required: true, location_name: "EC2SecurityGroupName"))
|
850
878
|
RevokeCacheSecurityGroupIngressMessage.add_member(:ec2_security_group_owner_id, Shapes::ShapeRef.new(shape: String, required: true, location_name: "EC2SecurityGroupOwnerId"))
|
@@ -861,6 +889,9 @@ module Aws::ElastiCache
|
|
861
889
|
|
862
890
|
SecurityGroupMembershipList.member = Shapes::ShapeRef.new(shape: SecurityGroupMembership)
|
863
891
|
|
892
|
+
SlotMigration.add_member(:progress_percentage, Shapes::ShapeRef.new(shape: Double, location_name: "ProgressPercentage"))
|
893
|
+
SlotMigration.struct_class = Types::SlotMigration
|
894
|
+
|
864
895
|
Snapshot.add_member(:snapshot_name, Shapes::ShapeRef.new(shape: String, location_name: "SnapshotName"))
|
865
896
|
Snapshot.add_member(:replication_group_id, Shapes::ShapeRef.new(shape: String, location_name: "ReplicationGroupId"))
|
866
897
|
Snapshot.add_member(:replication_group_description, Shapes::ShapeRef.new(shape: String, location_name: "ReplicationGroupDescription"))
|
@@ -1428,6 +1459,23 @@ module Aws::ElastiCache
|
|
1428
1459
|
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterCombinationException)
|
1429
1460
|
end)
|
1430
1461
|
|
1462
|
+
api.add_operation(:modify_replication_group_shard_configuration, Seahorse::Model::Operation.new.tap do |o|
|
1463
|
+
o.name = "ModifyReplicationGroupShardConfiguration"
|
1464
|
+
o.http_method = "POST"
|
1465
|
+
o.http_request_uri = "/"
|
1466
|
+
o.input = Shapes::ShapeRef.new(shape: ModifyReplicationGroupShardConfigurationMessage)
|
1467
|
+
o.output = Shapes::ShapeRef.new(shape: ModifyReplicationGroupShardConfigurationResult)
|
1468
|
+
o.errors << Shapes::ShapeRef.new(shape: ReplicationGroupNotFoundFault)
|
1469
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidReplicationGroupStateFault)
|
1470
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidCacheClusterStateFault)
|
1471
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidVPCNetworkStateFault)
|
1472
|
+
o.errors << Shapes::ShapeRef.new(shape: InsufficientCacheClusterCapacityFault)
|
1473
|
+
o.errors << Shapes::ShapeRef.new(shape: NodeGroupsPerReplicationGroupQuotaExceededFault)
|
1474
|
+
o.errors << Shapes::ShapeRef.new(shape: NodeQuotaForCustomerExceededFault)
|
1475
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterValueException)
|
1476
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterCombinationException)
|
1477
|
+
end)
|
1478
|
+
|
1431
1479
|
api.add_operation(:purchase_reserved_cache_nodes_offering, Seahorse::Model::Operation.new.tap do |o|
|
1432
1480
|
o.name = "PurchaseReservedCacheNodesOffering"
|
1433
1481
|
o.http_method = "POST"
|
@@ -28,6 +28,7 @@ module Aws::ElastiCache
|
|
28
28
|
# to be added, for example
|
29
29
|
# `arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster` or
|
30
30
|
# `arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot`.
|
31
|
+
# ElastiCache resources are *cluster* and *snapshot*.
|
31
32
|
#
|
32
33
|
# For more information about ARNs, see [Amazon Resource Names (ARNs)
|
33
34
|
# and AWS Service Namespaces][1].
|
@@ -50,12 +51,12 @@ module Aws::ElastiCache
|
|
50
51
|
include Aws::Structure
|
51
52
|
end
|
52
53
|
|
53
|
-
# Represents the allowed node types you can use to modify your
|
54
|
-
#
|
54
|
+
# Represents the allowed node types you can use to modify your cluster
|
55
|
+
# or replication group.
|
55
56
|
#
|
56
57
|
# @!attribute [rw] scale_up_modifications
|
57
58
|
# A string list, each element of which specifies a cache node type
|
58
|
-
# which you can use to scale your
|
59
|
+
# which you can use to scale your cluster or replication group.
|
59
60
|
#
|
60
61
|
# When scaling up a Redis cluster or replication group using
|
61
62
|
# `ModifyCacheCluster` or `ModifyReplicationGroup`, use a value from
|
@@ -122,7 +123,7 @@ module Aws::ElastiCache
|
|
122
123
|
include Aws::Structure
|
123
124
|
end
|
124
125
|
|
125
|
-
# Describes an Availability Zone in which the
|
126
|
+
# Describes an Availability Zone in which the cluster is launched.
|
126
127
|
#
|
127
128
|
# @!attribute [rw] name
|
128
129
|
# The name of the Availability Zone.
|
@@ -135,11 +136,11 @@ module Aws::ElastiCache
|
|
135
136
|
include Aws::Structure
|
136
137
|
end
|
137
138
|
|
138
|
-
# Contains all of the attributes of a specific
|
139
|
+
# Contains all of the attributes of a specific cluster.
|
139
140
|
#
|
140
141
|
# @!attribute [rw] cache_cluster_id
|
141
|
-
# The user-supplied identifier of the
|
142
|
-
#
|
142
|
+
# The user-supplied identifier of the cluster. This identifier is a
|
143
|
+
# unique key that identifies a cluster.
|
143
144
|
# @return [String]
|
144
145
|
#
|
145
146
|
# @!attribute [rw] configuration_endpoint
|
@@ -157,7 +158,7 @@ module Aws::ElastiCache
|
|
157
158
|
# @return [String]
|
158
159
|
#
|
159
160
|
# @!attribute [rw] cache_node_type
|
160
|
-
# The name of the compute and memory capacity node type for the
|
161
|
+
# The name of the compute and memory capacity node type for the
|
161
162
|
# cluster.
|
162
163
|
#
|
163
164
|
# The following node types are supported by ElastiCache. Generally
|
@@ -217,9 +218,6 @@ module Aws::ElastiCache
|
|
217
218
|
# * Redis Append-only files (AOF) functionality is not supported for
|
218
219
|
# T1 or T2 instances.
|
219
220
|
#
|
220
|
-
# Supported node types are available in all regions except as noted in
|
221
|
-
# the following table.
|
222
|
-
#
|
223
221
|
# For a complete listing of node types and specifications, see [Amazon
|
224
222
|
# ElastiCache Product Features and Details][1] and either [Cache Node
|
225
223
|
# Type-Specific Parameters for Memcached][2] or [Cache Node
|
@@ -234,35 +232,35 @@ module Aws::ElastiCache
|
|
234
232
|
#
|
235
233
|
# @!attribute [rw] engine
|
236
234
|
# The name of the cache engine (`memcached` or `redis`) to be used for
|
237
|
-
# this
|
235
|
+
# this cluster.
|
238
236
|
# @return [String]
|
239
237
|
#
|
240
238
|
# @!attribute [rw] engine_version
|
241
|
-
# The version of the cache engine that is used in this
|
239
|
+
# The version of the cache engine that is used in this cluster.
|
242
240
|
# @return [String]
|
243
241
|
#
|
244
242
|
# @!attribute [rw] cache_cluster_status
|
245
|
-
# The current state of this
|
246
|
-
#
|
247
|
-
# `incompatible-network`, `modifying`, `rebooting
|
248
|
-
#
|
243
|
+
# The current state of this cluster, one of the following values:
|
244
|
+
# `available`, `creating`, `deleted`, `deleting`,
|
245
|
+
# `incompatible-network`, `modifying`, `rebooting cluster nodes`,
|
246
|
+
# `restore-failed`, or `snapshotting`.
|
249
247
|
# @return [String]
|
250
248
|
#
|
251
249
|
# @!attribute [rw] num_cache_nodes
|
252
|
-
# The number of cache nodes in the
|
250
|
+
# The number of cache nodes in the cluster.
|
253
251
|
#
|
254
252
|
# For clusters running Redis, this value must be 1. For clusters
|
255
253
|
# running Memcached, this value must be between 1 and 20.
|
256
254
|
# @return [Integer]
|
257
255
|
#
|
258
256
|
# @!attribute [rw] preferred_availability_zone
|
259
|
-
# The name of the Availability Zone in which the
|
260
|
-
#
|
257
|
+
# The name of the Availability Zone in which the cluster is located or
|
258
|
+
# "Multiple" if the cache nodes are located in different
|
261
259
|
# Availability Zones.
|
262
260
|
# @return [String]
|
263
261
|
#
|
264
262
|
# @!attribute [rw] cache_cluster_create_time
|
265
|
-
# The date and time when the
|
263
|
+
# The date and time when the cluster was created.
|
266
264
|
# @return [Time]
|
267
265
|
#
|
268
266
|
# @!attribute [rw] preferred_maintenance_window
|
@@ -291,8 +289,8 @@ module Aws::ElastiCache
|
|
291
289
|
# @return [String]
|
292
290
|
#
|
293
291
|
# @!attribute [rw] pending_modified_values
|
294
|
-
# A group of settings that are applied to the
|
295
|
-
#
|
292
|
+
# A group of settings that are applied to the cluster in the future,
|
293
|
+
# or that are currently being applied.
|
296
294
|
# @return [Types::PendingModifiedValues]
|
297
295
|
#
|
298
296
|
# @!attribute [rw] notification_configuration
|
@@ -311,12 +309,11 @@ module Aws::ElastiCache
|
|
311
309
|
# @return [Types::CacheParameterGroupStatus]
|
312
310
|
#
|
313
311
|
# @!attribute [rw] cache_subnet_group_name
|
314
|
-
# The name of the cache subnet group associated with the
|
315
|
-
# cluster.
|
312
|
+
# The name of the cache subnet group associated with the cluster.
|
316
313
|
# @return [String]
|
317
314
|
#
|
318
315
|
# @!attribute [rw] cache_nodes
|
319
|
-
# A list of cache nodes that are members of the
|
316
|
+
# A list of cache nodes that are members of the cluster.
|
320
317
|
# @return [Array<Types::CacheNode>]
|
321
318
|
#
|
322
319
|
# @!attribute [rw] auto_minor_version_upgrade
|
@@ -324,18 +321,17 @@ module Aws::ElastiCache
|
|
324
321
|
# @return [Boolean]
|
325
322
|
#
|
326
323
|
# @!attribute [rw] security_groups
|
327
|
-
# A list of VPC Security Groups associated with the
|
324
|
+
# A list of VPC Security Groups associated with the cluster.
|
328
325
|
# @return [Array<Types::SecurityGroupMembership>]
|
329
326
|
#
|
330
327
|
# @!attribute [rw] replication_group_id
|
331
|
-
# The replication group to which this
|
332
|
-
#
|
333
|
-
# replication group.
|
328
|
+
# The replication group to which this cluster belongs. If this field
|
329
|
+
# is empty, the cluster is not associated with any replication group.
|
334
330
|
# @return [String]
|
335
331
|
#
|
336
332
|
# @!attribute [rw] snapshot_retention_limit
|
337
|
-
# The number of days for which ElastiCache retains automatic
|
338
|
-
#
|
333
|
+
# The number of days for which ElastiCache retains automatic cluster
|
334
|
+
# snapshots before deleting them. For example, if you set
|
339
335
|
# `SnapshotRetentionLimit` to 5, a snapshot that was taken today is
|
340
336
|
# retained for 5 days before being deleted.
|
341
337
|
#
|
@@ -345,7 +341,7 @@ module Aws::ElastiCache
|
|
345
341
|
#
|
346
342
|
# @!attribute [rw] snapshot_window
|
347
343
|
# The daily time range (in UTC) during which ElastiCache begins taking
|
348
|
-
# a daily snapshot of your
|
344
|
+
# a daily snapshot of your cluster.
|
349
345
|
#
|
350
346
|
# Example: `05:00-09:00`
|
351
347
|
# @return [String]
|
@@ -417,8 +413,8 @@ module Aws::ElastiCache
|
|
417
413
|
# @return [String]
|
418
414
|
#
|
419
415
|
# @!attribute [rw] cache_clusters
|
420
|
-
# A list of
|
421
|
-
# information about one
|
416
|
+
# A list of clusters. Each item in the list contains detailed
|
417
|
+
# information about one cluster.
|
422
418
|
# @return [Array<Types::CacheCluster>]
|
423
419
|
#
|
424
420
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/CacheClusterMessage AWS API Documentation
|
@@ -485,9 +481,9 @@ module Aws::ElastiCache
|
|
485
481
|
include Aws::Structure
|
486
482
|
end
|
487
483
|
|
488
|
-
# Represents an individual cache node within a
|
489
|
-
#
|
490
|
-
#
|
484
|
+
# Represents an individual cache node within a cluster. Each cache node
|
485
|
+
# runs its own instance of the cluster's protocol-compliant caching
|
486
|
+
# software - either Memcached or Redis.
|
491
487
|
#
|
492
488
|
# The following node types are supported by ElastiCache. Generally
|
493
489
|
# speaking, the current generation types provide more memory and
|
@@ -546,9 +542,6 @@ module Aws::ElastiCache
|
|
546
542
|
# * Redis Append-only files (AOF) functionality is not supported for T1
|
547
543
|
# or T2 instances.
|
548
544
|
#
|
549
|
-
# Supported node types are available in all regions except as noted in
|
550
|
-
# the following table.
|
551
|
-
#
|
552
545
|
# For a complete listing of node types and specifications, see [Amazon
|
553
546
|
# ElastiCache Product Features and Details][1] and either [Cache Node
|
554
547
|
# Type-Specific Parameters for Memcached][2] or [Cache Node
|
@@ -585,7 +578,7 @@ module Aws::ElastiCache
|
|
585
578
|
# @!attribute [rw] source_cache_node_id
|
586
579
|
# The ID of the primary node to which this read replica node is
|
587
580
|
# synchronized. If this field is empty, this node is not associated
|
588
|
-
# with a primary
|
581
|
+
# with a primary cluster.
|
589
582
|
# @return [String]
|
590
583
|
#
|
591
584
|
# @!attribute [rw] customer_availability_zone
|
@@ -606,8 +599,8 @@ module Aws::ElastiCache
|
|
606
599
|
end
|
607
600
|
|
608
601
|
# A parameter that has a different value for each cache node type it is
|
609
|
-
# applied to. For example, in a Redis
|
610
|
-
#
|
602
|
+
# applied to. For example, in a Redis cluster, a `cache.m1.large` cache
|
603
|
+
# node type would have a larger `maxmemory` value than a
|
611
604
|
# `cache.m1.small` type.
|
612
605
|
#
|
613
606
|
# @!attribute [rw] parameter_name
|
@@ -837,8 +830,8 @@ module Aws::ElastiCache
|
|
837
830
|
include Aws::Structure
|
838
831
|
end
|
839
832
|
|
840
|
-
# Represents a
|
841
|
-
#
|
833
|
+
# Represents a cluster's status within a particular cache security
|
834
|
+
# group.
|
842
835
|
#
|
843
836
|
# @!attribute [rw] cache_security_group_name
|
844
837
|
# The name of the cache security group.
|
@@ -847,7 +840,7 @@ module Aws::ElastiCache
|
|
847
840
|
# @!attribute [rw] status
|
848
841
|
# The membership status in the cache security group. The status
|
849
842
|
# changes when a cache security group is modified, or when the cache
|
850
|
-
# security groups assigned to a
|
843
|
+
# security groups assigned to a cluster are modified.
|
851
844
|
# @return [String]
|
852
845
|
#
|
853
846
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/CacheSecurityGroupMembership AWS API Documentation
|
@@ -979,8 +972,8 @@ module Aws::ElastiCache
|
|
979
972
|
end
|
980
973
|
|
981
974
|
# @!attribute [rw] snapshot
|
982
|
-
# Represents a copy of an entire Redis
|
983
|
-
#
|
975
|
+
# Represents a copy of an entire Redis cluster as of the time when the
|
976
|
+
# snapshot was taken.
|
984
977
|
# @return [Types::Snapshot]
|
985
978
|
#
|
986
979
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/CopySnapshotResult AWS API Documentation
|
@@ -1046,14 +1039,14 @@ module Aws::ElastiCache
|
|
1046
1039
|
# operation or parameter is not supported on Redis (cluster mode
|
1047
1040
|
# enabled) replication groups.
|
1048
1041
|
#
|
1049
|
-
# The ID of the replication group to which this
|
1050
|
-
#
|
1051
|
-
#
|
1052
|
-
#
|
1053
|
-
#
|
1042
|
+
# The ID of the replication group to which this cluster should belong.
|
1043
|
+
# If this parameter is specified, the cluster is added to the
|
1044
|
+
# specified replication group as a read replica; otherwise, the
|
1045
|
+
# cluster is a standalone primary that is not part of any replication
|
1046
|
+
# group.
|
1054
1047
|
#
|
1055
1048
|
# If the specified replication group is Multi-AZ enabled and the
|
1056
|
-
# Availability Zone is not specified, the
|
1049
|
+
# Availability Zone is not specified, the cluster is created in
|
1057
1050
|
# Availability Zones that provide the best spread of read replicas
|
1058
1051
|
# across Availability Zones.
|
1059
1052
|
#
|
@@ -1067,19 +1060,18 @@ module Aws::ElastiCache
|
|
1067
1060
|
# a single Availability Zone or created across multiple Availability
|
1068
1061
|
# Zones in the cluster's region.
|
1069
1062
|
#
|
1070
|
-
# This parameter is only supported for Memcached
|
1063
|
+
# This parameter is only supported for Memcached clusters.
|
1071
1064
|
#
|
1072
1065
|
# If the `AZMode` and `PreferredAvailabilityZones` are not specified,
|
1073
1066
|
# ElastiCache assumes `single-az` mode.
|
1074
1067
|
# @return [String]
|
1075
1068
|
#
|
1076
1069
|
# @!attribute [rw] preferred_availability_zone
|
1077
|
-
# The EC2 Availability Zone in which the
|
1070
|
+
# The EC2 Availability Zone in which the cluster is created.
|
1078
1071
|
#
|
1079
|
-
# All nodes belonging to this Memcached
|
1080
|
-
#
|
1081
|
-
#
|
1082
|
-
# `PreferredAvailabilityZones`.
|
1072
|
+
# All nodes belonging to this Memcached cluster are placed in the
|
1073
|
+
# preferred Availability Zone. If you want to create your nodes across
|
1074
|
+
# multiple Availability Zones, use `PreferredAvailabilityZones`.
|
1083
1075
|
#
|
1084
1076
|
# Default: System chosen Availability Zone.
|
1085
1077
|
# @return [String]
|
@@ -1090,9 +1082,9 @@ module Aws::ElastiCache
|
|
1090
1082
|
#
|
1091
1083
|
# This option is only supported on Memcached.
|
1092
1084
|
#
|
1093
|
-
# <note markdown="1"> If you are creating your
|
1094
|
-
#
|
1095
|
-
#
|
1085
|
+
# <note markdown="1"> If you are creating your cluster in an Amazon VPC (recommended) you
|
1086
|
+
# can only locate nodes in Availability Zones that are associated with
|
1087
|
+
# the subnets in the selected subnet group.
|
1096
1088
|
#
|
1097
1089
|
# The number of Availability Zones listed must equal the value of
|
1098
1090
|
# `NumCacheNodes`.
|
@@ -1107,7 +1099,7 @@ module Aws::ElastiCache
|
|
1107
1099
|
# @return [Array<String>]
|
1108
1100
|
#
|
1109
1101
|
# @!attribute [rw] num_cache_nodes
|
1110
|
-
# The initial number of cache nodes that the
|
1102
|
+
# The initial number of cache nodes that the cluster has.
|
1111
1103
|
#
|
1112
1104
|
# For clusters running Redis, this value must be 1. For clusters
|
1113
1105
|
# running Memcached, this value must be between 1 and 20.
|
@@ -1182,9 +1174,6 @@ module Aws::ElastiCache
|
|
1182
1174
|
# * Redis Append-only files (AOF) functionality is not supported for
|
1183
1175
|
# T1 or T2 instances.
|
1184
1176
|
#
|
1185
|
-
# Supported node types are available in all regions except as noted in
|
1186
|
-
# the following table.
|
1187
|
-
#
|
1188
1177
|
# For a complete listing of node types and specifications, see [Amazon
|
1189
1178
|
# ElastiCache Product Features and Details][1] and either [Cache Node
|
1190
1179
|
# Type-Specific Parameters for Memcached][2] or [Cache Node
|
@@ -1198,21 +1187,21 @@ module Aws::ElastiCache
|
|
1198
1187
|
# @return [String]
|
1199
1188
|
#
|
1200
1189
|
# @!attribute [rw] engine
|
1201
|
-
# The name of the cache engine to be used for this
|
1190
|
+
# The name of the cache engine to be used for this cluster.
|
1202
1191
|
#
|
1203
1192
|
# Valid values for this parameter are: `memcached` \| `redis`
|
1204
1193
|
# @return [String]
|
1205
1194
|
#
|
1206
1195
|
# @!attribute [rw] engine_version
|
1207
|
-
# The version number of the cache engine to be used for this
|
1208
|
-
#
|
1196
|
+
# The version number of the cache engine to be used for this cluster.
|
1197
|
+
# To view the supported cache engine versions, use the
|
1209
1198
|
# DescribeCacheEngineVersions operation.
|
1210
1199
|
#
|
1211
1200
|
# **Important:** You can upgrade to a newer engine version (see
|
1212
1201
|
# [Selecting a Cache Engine and Version][1]), but you cannot downgrade
|
1213
1202
|
# to an earlier engine version. If you want to use an earlier engine
|
1214
|
-
# version, you must delete the existing
|
1215
|
-
#
|
1203
|
+
# version, you must delete the existing cluster or replication group
|
1204
|
+
# and create it anew with the earlier engine version.
|
1216
1205
|
#
|
1217
1206
|
#
|
1218
1207
|
#
|
@@ -1220,17 +1209,17 @@ module Aws::ElastiCache
|
|
1220
1209
|
# @return [String]
|
1221
1210
|
#
|
1222
1211
|
# @!attribute [rw] cache_parameter_group_name
|
1223
|
-
# The name of the parameter group to associate with this
|
1224
|
-
#
|
1225
|
-
#
|
1226
|
-
#
|
1212
|
+
# The name of the parameter group to associate with this cluster. If
|
1213
|
+
# this argument is omitted, the default parameter group for the
|
1214
|
+
# specified engine is used. You cannot use any parameter group which
|
1215
|
+
# has `cluster-enabled='yes'` when creating a cluster.
|
1227
1216
|
# @return [String]
|
1228
1217
|
#
|
1229
1218
|
# @!attribute [rw] cache_subnet_group_name
|
1230
|
-
# The name of the subnet group to be used for the
|
1219
|
+
# The name of the subnet group to be used for the cluster.
|
1231
1220
|
#
|
1232
|
-
# Use this parameter only when you are creating a
|
1233
|
-
#
|
1221
|
+
# Use this parameter only when you are creating a cluster in an Amazon
|
1222
|
+
# Virtual Private Cloud (Amazon VPC).
|
1234
1223
|
#
|
1235
1224
|
# If you're going to launch your cluster in an Amazon VPC, you need
|
1236
1225
|
# to create a subnet group before you start creating a cluster. For
|
@@ -1242,17 +1231,17 @@ module Aws::ElastiCache
|
|
1242
1231
|
# @return [String]
|
1243
1232
|
#
|
1244
1233
|
# @!attribute [rw] cache_security_group_names
|
1245
|
-
# A list of security group names to associate with this
|
1234
|
+
# A list of security group names to associate with this cluster.
|
1246
1235
|
#
|
1247
|
-
# Use this parameter only when you are creating a
|
1248
|
-
#
|
1236
|
+
# Use this parameter only when you are creating a cluster outside of
|
1237
|
+
# an Amazon Virtual Private Cloud (Amazon VPC).
|
1249
1238
|
# @return [Array<String>]
|
1250
1239
|
#
|
1251
1240
|
# @!attribute [rw] security_group_ids
|
1252
|
-
# One or more VPC security groups associated with the
|
1241
|
+
# One or more VPC security groups associated with the cluster.
|
1253
1242
|
#
|
1254
|
-
# Use this parameter only when you are creating a
|
1255
|
-
#
|
1243
|
+
# Use this parameter only when you are creating a cluster in an Amazon
|
1244
|
+
# Virtual Private Cloud (Amazon VPC).
|
1256
1245
|
# @return [Array<String>]
|
1257
1246
|
#
|
1258
1247
|
# @!attribute [rw] tags
|
@@ -1285,7 +1274,7 @@ module Aws::ElastiCache
|
|
1285
1274
|
#
|
1286
1275
|
# @!attribute [rw] preferred_maintenance_window
|
1287
1276
|
# Specifies the weekly time range during which maintenance on the
|
1288
|
-
#
|
1277
|
+
# cluster is performed. It is specified as a range in the format
|
1289
1278
|
# ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance
|
1290
1279
|
# window is a 60 minute period. Valid values for `ddd` are:
|
1291
1280
|
#
|
@@ -1322,8 +1311,7 @@ module Aws::ElastiCache
|
|
1322
1311
|
# The Amazon Resource Name (ARN) of the Amazon Simple Notification
|
1323
1312
|
# Service (SNS) topic to which notifications are sent.
|
1324
1313
|
#
|
1325
|
-
# <note markdown="1"> The Amazon SNS topic owner must be the same as the
|
1326
|
-
# owner.
|
1314
|
+
# <note markdown="1"> The Amazon SNS topic owner must be the same as the cluster owner.
|
1327
1315
|
#
|
1328
1316
|
# </note>
|
1329
1317
|
# @return [String]
|
@@ -1342,8 +1330,7 @@ module Aws::ElastiCache
|
|
1342
1330
|
#
|
1343
1331
|
# </note>
|
1344
1332
|
#
|
1345
|
-
# Default: 0 (i.e., automatic backups are disabled for this
|
1346
|
-
# cluster).
|
1333
|
+
# Default: 0 (i.e., automatic backups are disabled for this cluster).
|
1347
1334
|
# @return [Integer]
|
1348
1335
|
#
|
1349
1336
|
# @!attribute [rw] snapshot_window
|
@@ -1364,6 +1351,14 @@ module Aws::ElastiCache
|
|
1364
1351
|
# **Reserved parameter.** The password used to access a password
|
1365
1352
|
# protected server.
|
1366
1353
|
#
|
1354
|
+
# This parameter is valid only if:
|
1355
|
+
#
|
1356
|
+
# * The parameter `TransitEncryptionEnabled` was set to `true` when
|
1357
|
+
# the cluster was created.
|
1358
|
+
#
|
1359
|
+
# * The line `requirepass` was added to the database configuration
|
1360
|
+
# file.
|
1361
|
+
#
|
1367
1362
|
# Password constraints:
|
1368
1363
|
#
|
1369
1364
|
# * Must be only printable ASCII characters.
|
@@ -1412,7 +1407,7 @@ module Aws::ElastiCache
|
|
1412
1407
|
end
|
1413
1408
|
|
1414
1409
|
# @!attribute [rw] cache_cluster
|
1415
|
-
# Contains all of the attributes of a specific
|
1410
|
+
# Contains all of the attributes of a specific cluster.
|
1416
1411
|
# @return [Types::CacheCluster]
|
1417
1412
|
#
|
1418
1413
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/CreateCacheClusterResult AWS API Documentation
|
@@ -1639,9 +1634,9 @@ module Aws::ElastiCache
|
|
1639
1634
|
# @return [String]
|
1640
1635
|
#
|
1641
1636
|
# @!attribute [rw] primary_cluster_id
|
1642
|
-
# The identifier of the
|
1643
|
-
#
|
1644
|
-
#
|
1637
|
+
# The identifier of the cluster that serves as the primary for this
|
1638
|
+
# replication group. This cluster must already exist and have a status
|
1639
|
+
# of `available`.
|
1645
1640
|
#
|
1646
1641
|
# This parameter is not required if `NumCacheClusters`,
|
1647
1642
|
# `NumNodeGroups`, or `ReplicasPerNodeGroup` is specified.
|
@@ -1686,16 +1681,16 @@ module Aws::ElastiCache
|
|
1686
1681
|
#
|
1687
1682
|
# @!attribute [rw] preferred_cache_cluster_a_zs
|
1688
1683
|
# A list of EC2 Availability Zones in which the replication group's
|
1689
|
-
#
|
1690
|
-
#
|
1684
|
+
# clusters are created. The order of the Availability Zones in the
|
1685
|
+
# list is the order in which clusters are allocated. The primary
|
1691
1686
|
# cluster is created in the first AZ in the list.
|
1692
1687
|
#
|
1693
1688
|
# This parameter is not used if there is more than one node group
|
1694
1689
|
# (shard). You should use `NodeGroupConfiguration` instead.
|
1695
1690
|
#
|
1696
1691
|
# <note markdown="1"> If you are creating your replication group in an Amazon VPC
|
1697
|
-
# (recommended), you can only locate
|
1698
|
-
#
|
1692
|
+
# (recommended), you can only locate clusters in Availability Zones
|
1693
|
+
# associated with the subnets in the selected subnet group.
|
1699
1694
|
#
|
1700
1695
|
# The number of Availability Zones listed must equal the value of
|
1701
1696
|
# `NumCacheClusters`.
|
@@ -1791,9 +1786,6 @@ module Aws::ElastiCache
|
|
1791
1786
|
# * Redis Append-only files (AOF) functionality is not supported for
|
1792
1787
|
# T1 or T2 instances.
|
1793
1788
|
#
|
1794
|
-
# Supported node types are available in all regions except as noted in
|
1795
|
-
# the following table.
|
1796
|
-
#
|
1797
1789
|
# For a complete listing of node types and specifications, see [Amazon
|
1798
1790
|
# ElastiCache Product Features and Details][1] and either [Cache Node
|
1799
1791
|
# Type-Specific Parameters for Memcached][2] or [Cache Node
|
@@ -1807,21 +1799,21 @@ module Aws::ElastiCache
|
|
1807
1799
|
# @return [String]
|
1808
1800
|
#
|
1809
1801
|
# @!attribute [rw] engine
|
1810
|
-
# The name of the cache engine to be used for the
|
1811
|
-
#
|
1802
|
+
# The name of the cache engine to be used for the clusters in this
|
1803
|
+
# replication group.
|
1812
1804
|
# @return [String]
|
1813
1805
|
#
|
1814
1806
|
# @!attribute [rw] engine_version
|
1815
|
-
# The version number of the cache engine to be used for the
|
1816
|
-
#
|
1817
|
-
#
|
1807
|
+
# The version number of the cache engine to be used for the clusters
|
1808
|
+
# in this replication group. To view the supported cache engine
|
1809
|
+
# versions, use the `DescribeCacheEngineVersions` operation.
|
1818
1810
|
#
|
1819
1811
|
# **Important:** You can upgrade to a newer engine version (see
|
1820
1812
|
# [Selecting a Cache Engine and Version][1]) in the *ElastiCache User
|
1821
1813
|
# Guide*, but you cannot downgrade to an earlier engine version. If
|
1822
1814
|
# you want to use an earlier engine version, you must delete the
|
1823
|
-
# existing
|
1824
|
-
#
|
1815
|
+
# existing cluster or replication group and create it anew with the
|
1816
|
+
# earlier engine version.
|
1825
1817
|
#
|
1826
1818
|
#
|
1827
1819
|
#
|
@@ -1872,7 +1864,8 @@ module Aws::ElastiCache
|
|
1872
1864
|
#
|
1873
1865
|
# @!attribute [rw] tags
|
1874
1866
|
# A list of cost allocation tags to be added to this resource. A tag
|
1875
|
-
# is a key-value pair.
|
1867
|
+
# is a key-value pair. A tag key does not have to be accompanied by a
|
1868
|
+
# tag value.
|
1876
1869
|
# @return [Array<Types::Tag>]
|
1877
1870
|
#
|
1878
1871
|
# @!attribute [rw] snapshot_arns
|
@@ -1896,7 +1889,7 @@ module Aws::ElastiCache
|
|
1896
1889
|
#
|
1897
1890
|
# @!attribute [rw] preferred_maintenance_window
|
1898
1891
|
# Specifies the weekly time range during which maintenance on the
|
1899
|
-
#
|
1892
|
+
# cluster is performed. It is specified as a range in the format
|
1900
1893
|
# ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance
|
1901
1894
|
# window is a 60 minute period. Valid values for `ddd` are:
|
1902
1895
|
#
|
@@ -1933,8 +1926,7 @@ module Aws::ElastiCache
|
|
1933
1926
|
# The Amazon Resource Name (ARN) of the Amazon Simple Notification
|
1934
1927
|
# Service (SNS) topic to which notifications are sent.
|
1935
1928
|
#
|
1936
|
-
# <note markdown="1"> The Amazon SNS topic owner must be the same as the
|
1937
|
-
# owner.
|
1929
|
+
# <note markdown="1"> The Amazon SNS topic owner must be the same as the cluster owner.
|
1938
1930
|
#
|
1939
1931
|
# </note>
|
1940
1932
|
# @return [String]
|
@@ -1949,8 +1941,7 @@ module Aws::ElastiCache
|
|
1949
1941
|
# `SnapshotRetentionLimit` to 5, a snapshot that was taken today is
|
1950
1942
|
# retained for 5 days before being deleted.
|
1951
1943
|
#
|
1952
|
-
# Default: 0 (i.e., automatic backups are disabled for this
|
1953
|
-
# cluster).
|
1944
|
+
# Default: 0 (i.e., automatic backups are disabled for this cluster).
|
1954
1945
|
# @return [Integer]
|
1955
1946
|
#
|
1956
1947
|
# @!attribute [rw] snapshot_window
|
@@ -2090,8 +2081,8 @@ module Aws::ElastiCache
|
|
2090
2081
|
# @return [String]
|
2091
2082
|
#
|
2092
2083
|
# @!attribute [rw] cache_cluster_id
|
2093
|
-
# The identifier of an existing
|
2094
|
-
#
|
2084
|
+
# The identifier of an existing cluster. The snapshot is created from
|
2085
|
+
# this cluster.
|
2095
2086
|
# @return [String]
|
2096
2087
|
#
|
2097
2088
|
# @!attribute [rw] snapshot_name
|
@@ -2108,8 +2099,8 @@ module Aws::ElastiCache
|
|
2108
2099
|
end
|
2109
2100
|
|
2110
2101
|
# @!attribute [rw] snapshot
|
2111
|
-
# Represents a copy of an entire Redis
|
2112
|
-
#
|
2102
|
+
# Represents a copy of an entire Redis cluster as of the time when the
|
2103
|
+
# snapshot was taken.
|
2113
2104
|
# @return [Types::Snapshot]
|
2114
2105
|
#
|
2115
2106
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/CreateSnapshotResult AWS API Documentation
|
@@ -2130,15 +2121,14 @@ module Aws::ElastiCache
|
|
2130
2121
|
# }
|
2131
2122
|
#
|
2132
2123
|
# @!attribute [rw] cache_cluster_id
|
2133
|
-
# The
|
2134
|
-
#
|
2124
|
+
# The cluster identifier for the cluster to be deleted. This parameter
|
2125
|
+
# is not case sensitive.
|
2135
2126
|
# @return [String]
|
2136
2127
|
#
|
2137
2128
|
# @!attribute [rw] final_snapshot_identifier
|
2138
|
-
# The user-supplied name of a final
|
2139
|
-
#
|
2140
|
-
#
|
2141
|
-
# afterward.
|
2129
|
+
# The user-supplied name of a final cluster snapshot. This is the
|
2130
|
+
# unique name that identifies the snapshot. ElastiCache creates the
|
2131
|
+
# snapshot, and then deletes the cluster immediately afterward.
|
2142
2132
|
# @return [String]
|
2143
2133
|
#
|
2144
2134
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DeleteCacheClusterMessage AWS API Documentation
|
@@ -2150,7 +2140,7 @@ module Aws::ElastiCache
|
|
2150
2140
|
end
|
2151
2141
|
|
2152
2142
|
# @!attribute [rw] cache_cluster
|
2153
|
-
# Contains all of the attributes of a specific
|
2143
|
+
# Contains all of the attributes of a specific cluster.
|
2154
2144
|
# @return [Types::CacheCluster]
|
2155
2145
|
#
|
2156
2146
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DeleteCacheClusterResult AWS API Documentation
|
@@ -2173,7 +2163,7 @@ module Aws::ElastiCache
|
|
2173
2163
|
# The name of the cache parameter group to delete.
|
2174
2164
|
#
|
2175
2165
|
# <note markdown="1"> The specified cache security group must not be associated with any
|
2176
|
-
#
|
2166
|
+
# clusters.
|
2177
2167
|
#
|
2178
2168
|
# </note>
|
2179
2169
|
# @return [String]
|
@@ -2303,8 +2293,8 @@ module Aws::ElastiCache
|
|
2303
2293
|
end
|
2304
2294
|
|
2305
2295
|
# @!attribute [rw] snapshot
|
2306
|
-
# Represents a copy of an entire Redis
|
2307
|
-
#
|
2296
|
+
# Represents a copy of an entire Redis cluster as of the time when the
|
2297
|
+
# snapshot was taken.
|
2308
2298
|
# @return [Types::Snapshot]
|
2309
2299
|
#
|
2310
2300
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DeleteSnapshotResult AWS API Documentation
|
@@ -2329,8 +2319,8 @@ module Aws::ElastiCache
|
|
2329
2319
|
#
|
2330
2320
|
# @!attribute [rw] cache_cluster_id
|
2331
2321
|
# The user-supplied cluster identifier. If this parameter is
|
2332
|
-
# specified, only information about that specific
|
2333
|
-
#
|
2322
|
+
# specified, only information about that specific cluster is returned.
|
2323
|
+
# This parameter isn't case sensitive.
|
2334
2324
|
# @return [String]
|
2335
2325
|
#
|
2336
2326
|
# @!attribute [rw] max_records
|
@@ -2891,9 +2881,6 @@ module Aws::ElastiCache
|
|
2891
2881
|
# * Redis Append-only files (AOF) functionality is not supported for
|
2892
2882
|
# T1 or T2 instances.
|
2893
2883
|
#
|
2894
|
-
# Supported node types are available in all regions except as noted in
|
2895
|
-
# the following table.
|
2896
|
-
#
|
2897
2884
|
# For a complete listing of node types and specifications, see [Amazon
|
2898
2885
|
# ElastiCache Product Features and Details][1] and either [Cache Node
|
2899
2886
|
# Type-Specific Parameters for Memcached][2] or [Cache Node
|
@@ -3043,9 +3030,6 @@ module Aws::ElastiCache
|
|
3043
3030
|
# * Redis Append-only files (AOF) functionality is not supported for
|
3044
3031
|
# T1 or T2 instances.
|
3045
3032
|
#
|
3046
|
-
# Supported node types are available in all regions except as noted in
|
3047
|
-
# the following table.
|
3048
|
-
#
|
3049
3033
|
# For a complete listing of node types and specifications, see [Amazon
|
3050
3034
|
# ElastiCache Product Features and Details][1] and either [Cache Node
|
3051
3035
|
# Type-Specific Parameters for Memcached][2] or [Cache Node
|
@@ -3155,8 +3139,7 @@ module Aws::ElastiCache
|
|
3155
3139
|
#
|
3156
3140
|
# @!attribute [rw] cache_cluster_id
|
3157
3141
|
# A user-supplied cluster identifier. If this parameter is specified,
|
3158
|
-
# only snapshots associated with that specific
|
3159
|
-
# described.
|
3142
|
+
# only snapshots associated with that specific cluster are described.
|
3160
3143
|
# @return [String]
|
3161
3144
|
#
|
3162
3145
|
# @!attribute [rw] snapshot_name
|
@@ -3286,18 +3269,18 @@ module Aws::ElastiCache
|
|
3286
3269
|
end
|
3287
3270
|
|
3288
3271
|
# Represents a single occurrence of something interesting within the
|
3289
|
-
# system. Some examples of events are creating a
|
3290
|
-
#
|
3272
|
+
# system. Some examples of events are creating a cluster, adding or
|
3273
|
+
# removing a cache node, or rebooting a node.
|
3291
3274
|
#
|
3292
3275
|
# @!attribute [rw] source_identifier
|
3293
3276
|
# The identifier for the source of the event. For example, if the
|
3294
|
-
# event occurred at the
|
3295
|
-
#
|
3277
|
+
# event occurred at the cluster level, the identifier would be the
|
3278
|
+
# name of the cluster.
|
3296
3279
|
# @return [String]
|
3297
3280
|
#
|
3298
3281
|
# @!attribute [rw] source_type
|
3299
|
-
# Specifies the origin of this event - a
|
3300
|
-
#
|
3282
|
+
# Specifies the origin of this event - a cluster, a parameter group, a
|
3283
|
+
# security group, etc.
|
3301
3284
|
# @return [String]
|
3302
3285
|
#
|
3303
3286
|
# @!attribute [rw] message
|
@@ -3349,7 +3332,7 @@ module Aws::ElastiCache
|
|
3349
3332
|
# }
|
3350
3333
|
#
|
3351
3334
|
# @!attribute [rw] cache_cluster_id
|
3352
|
-
# The name of the
|
3335
|
+
# The name of the cluster you want to scale up to a larger node
|
3353
3336
|
# instanced type. ElastiCache uses the cluster id to identify the
|
3354
3337
|
# current node type of this cluster and from that to create a list of
|
3355
3338
|
# node types you can scale up to.
|
@@ -3432,17 +3415,16 @@ module Aws::ElastiCache
|
|
3432
3415
|
# }
|
3433
3416
|
#
|
3434
3417
|
# @!attribute [rw] cache_cluster_id
|
3435
|
-
# The
|
3436
|
-
# string.
|
3418
|
+
# The cluster identifier. This value is stored as a lowercase string.
|
3437
3419
|
# @return [String]
|
3438
3420
|
#
|
3439
3421
|
# @!attribute [rw] num_cache_nodes
|
3440
|
-
# The number of cache nodes that the
|
3441
|
-
#
|
3442
|
-
#
|
3443
|
-
#
|
3444
|
-
#
|
3445
|
-
#
|
3422
|
+
# The number of cache nodes that the cluster should have. If the value
|
3423
|
+
# for `NumCacheNodes` is greater than the sum of the number of current
|
3424
|
+
# cache nodes and the number of cache nodes pending creation (which
|
3425
|
+
# may be zero), more nodes are added. If the value is less than the
|
3426
|
+
# number of existing cache nodes, nodes are removed. If the value is
|
3427
|
+
# equal to the number of current cache nodes, any pending add or
|
3446
3428
|
# remove requests are canceled.
|
3447
3429
|
#
|
3448
3430
|
# If you are removing cache nodes, you must use the
|
@@ -3472,7 +3454,7 @@ module Aws::ElastiCache
|
|
3472
3454
|
# request. To cancel pending operations to modify the number of cache
|
3473
3455
|
# nodes in a cluster, use the `ModifyCacheCluster` request and set
|
3474
3456
|
# `NumCacheNodes` equal to the number of cache nodes currently in the
|
3475
|
-
#
|
3457
|
+
# cluster.
|
3476
3458
|
#
|
3477
3459
|
# </note>
|
3478
3460
|
# @return [Integer]
|
@@ -3492,18 +3474,18 @@ module Aws::ElastiCache
|
|
3492
3474
|
# @return [Array<String>]
|
3493
3475
|
#
|
3494
3476
|
# @!attribute [rw] az_mode
|
3495
|
-
# Specifies whether the new nodes in this Memcached
|
3496
|
-
#
|
3477
|
+
# Specifies whether the new nodes in this Memcached cluster are all
|
3478
|
+
# created in a single Availability Zone or created across multiple
|
3497
3479
|
# Availability Zones.
|
3498
3480
|
#
|
3499
3481
|
# Valid values: `single-az` \| `cross-az`.
|
3500
3482
|
#
|
3501
|
-
# This option is only supported for Memcached
|
3483
|
+
# This option is only supported for Memcached clusters.
|
3502
3484
|
#
|
3503
|
-
# <note markdown="1"> You cannot specify `single-az` if the Memcached
|
3504
|
-
#
|
3505
|
-
#
|
3506
|
-
#
|
3485
|
+
# <note markdown="1"> You cannot specify `single-az` if the Memcached cluster already has
|
3486
|
+
# cache nodes in different Availability Zones. If `cross-az` is
|
3487
|
+
# specified, existing Memcached nodes remain in their current
|
3488
|
+
# Availability Zone.
|
3507
3489
|
#
|
3508
3490
|
# Only newly created nodes are located in different Availability
|
3509
3491
|
# Zones. For instructions on how to move existing Memcached nodes to
|
@@ -3603,8 +3585,8 @@ module Aws::ElastiCache
|
|
3603
3585
|
# @return [Array<String>]
|
3604
3586
|
#
|
3605
3587
|
# @!attribute [rw] cache_security_group_names
|
3606
|
-
# A list of cache security group names to authorize on this
|
3607
|
-
#
|
3588
|
+
# A list of cache security group names to authorize on this cluster.
|
3589
|
+
# This change is asynchronously applied as soon as possible.
|
3608
3590
|
#
|
3609
3591
|
# You can use this parameter only with clusters that are created
|
3610
3592
|
# outside of an Amazon Virtual Private Cloud (Amazon VPC).
|
@@ -3614,7 +3596,7 @@ module Aws::ElastiCache
|
|
3614
3596
|
# @return [Array<String>]
|
3615
3597
|
#
|
3616
3598
|
# @!attribute [rw] security_group_ids
|
3617
|
-
# Specifies the VPC Security Groups associated with the
|
3599
|
+
# Specifies the VPC Security Groups associated with the cluster.
|
3618
3600
|
#
|
3619
3601
|
# This parameter can be used only with clusters that are created in an
|
3620
3602
|
# Amazon Virtual Private Cloud (Amazon VPC).
|
@@ -3649,16 +3631,16 @@ module Aws::ElastiCache
|
|
3649
3631
|
# The Amazon Resource Name (ARN) of the Amazon SNS topic to which
|
3650
3632
|
# notifications are sent.
|
3651
3633
|
#
|
3652
|
-
# <note markdown="1"> The Amazon SNS topic owner must be same as the
|
3634
|
+
# <note markdown="1"> The Amazon SNS topic owner must be same as the cluster owner.
|
3653
3635
|
#
|
3654
3636
|
# </note>
|
3655
3637
|
# @return [String]
|
3656
3638
|
#
|
3657
3639
|
# @!attribute [rw] cache_parameter_group_name
|
3658
|
-
# The name of the cache parameter group to apply to this
|
3659
|
-
#
|
3660
|
-
#
|
3661
|
-
#
|
3640
|
+
# The name of the cache parameter group to apply to this cluster. This
|
3641
|
+
# change is asynchronously applied as soon as possible for parameters
|
3642
|
+
# when the `ApplyImmediately` parameter is specified as `true` for
|
3643
|
+
# this request.
|
3662
3644
|
# @return [String]
|
3663
3645
|
#
|
3664
3646
|
# @!attribute [rw] notification_topic_status
|
@@ -3672,9 +3654,9 @@ module Aws::ElastiCache
|
|
3672
3654
|
# If `true`, this parameter causes the modifications in this request
|
3673
3655
|
# and any pending modifications to be applied, asynchronously and as
|
3674
3656
|
# soon as possible, regardless of the `PreferredMaintenanceWindow`
|
3675
|
-
# setting for the
|
3657
|
+
# setting for the cluster.
|
3676
3658
|
#
|
3677
|
-
# If `false`, changes to the
|
3659
|
+
# If `false`, changes to the cluster are applied on the next
|
3678
3660
|
# maintenance reboot, or the next failure reboot, whichever occurs
|
3679
3661
|
# first.
|
3680
3662
|
#
|
@@ -3694,8 +3676,8 @@ module Aws::ElastiCache
|
|
3694
3676
|
# **Important:** You can upgrade to a newer engine version (see
|
3695
3677
|
# [Selecting a Cache Engine and Version][1]), but you cannot downgrade
|
3696
3678
|
# to an earlier engine version. If you want to use an earlier engine
|
3697
|
-
# version, you must delete the existing
|
3698
|
-
#
|
3679
|
+
# version, you must delete the existing cluster and create it anew
|
3680
|
+
# with the earlier engine version.
|
3699
3681
|
#
|
3700
3682
|
#
|
3701
3683
|
#
|
@@ -3707,8 +3689,8 @@ module Aws::ElastiCache
|
|
3707
3689
|
# @return [Boolean]
|
3708
3690
|
#
|
3709
3691
|
# @!attribute [rw] snapshot_retention_limit
|
3710
|
-
# The number of days for which ElastiCache retains automatic
|
3711
|
-
#
|
3692
|
+
# The number of days for which ElastiCache retains automatic cluster
|
3693
|
+
# snapshots before deleting them. For example, if you set
|
3712
3694
|
# `SnapshotRetentionLimit` to 5, a snapshot that was taken today is
|
3713
3695
|
# retained for 5 days before being deleted.
|
3714
3696
|
#
|
@@ -3720,12 +3702,11 @@ module Aws::ElastiCache
|
|
3720
3702
|
#
|
3721
3703
|
# @!attribute [rw] snapshot_window
|
3722
3704
|
# The daily time range (in UTC) during which ElastiCache begins taking
|
3723
|
-
# a daily snapshot of your
|
3705
|
+
# a daily snapshot of your cluster.
|
3724
3706
|
# @return [String]
|
3725
3707
|
#
|
3726
3708
|
# @!attribute [rw] cache_node_type
|
3727
|
-
# A valid cache node type that you want to scale this
|
3728
|
-
# to.
|
3709
|
+
# A valid cache node type that you want to scale this cluster up to.
|
3729
3710
|
# @return [String]
|
3730
3711
|
#
|
3731
3712
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/ModifyCacheClusterMessage AWS API Documentation
|
@@ -3752,7 +3733,7 @@ module Aws::ElastiCache
|
|
3752
3733
|
end
|
3753
3734
|
|
3754
3735
|
# @!attribute [rw] cache_cluster
|
3755
|
-
# Contains all of the attributes of a specific
|
3736
|
+
# Contains all of the attributes of a specific cluster.
|
3756
3737
|
# @return [Types::CacheCluster]
|
3757
3738
|
#
|
3758
3739
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/ModifyCacheClusterResult AWS API Documentation
|
@@ -3892,9 +3873,9 @@ module Aws::ElastiCache
|
|
3892
3873
|
# @return [String]
|
3893
3874
|
#
|
3894
3875
|
# @!attribute [rw] snapshotting_cluster_id
|
3895
|
-
# The
|
3896
|
-
#
|
3897
|
-
#
|
3876
|
+
# The cluster ID that is used as the daily snapshot source for the
|
3877
|
+
# replication group. This parameter cannot be set for Redis (cluster
|
3878
|
+
# mode enabled) replication groups.
|
3898
3879
|
# @return [String]
|
3899
3880
|
#
|
3900
3881
|
# @!attribute [rw] automatic_failover_enabled
|
@@ -3919,20 +3900,19 @@ module Aws::ElastiCache
|
|
3919
3900
|
# soon as possible.
|
3920
3901
|
#
|
3921
3902
|
# This parameter can be used only with replication group containing
|
3922
|
-
#
|
3923
|
-
#
|
3903
|
+
# clusters running outside of an Amazon Virtual Private Cloud (Amazon
|
3904
|
+
# VPC).
|
3924
3905
|
#
|
3925
3906
|
# Constraints: Must contain no more than 255 alphanumeric characters.
|
3926
3907
|
# Must not be `Default`.
|
3927
3908
|
# @return [Array<String>]
|
3928
3909
|
#
|
3929
3910
|
# @!attribute [rw] security_group_ids
|
3930
|
-
# Specifies the VPC Security Groups associated with the
|
3931
|
-
#
|
3911
|
+
# Specifies the VPC Security Groups associated with the clusters in
|
3912
|
+
# the replication group.
|
3932
3913
|
#
|
3933
3914
|
# This parameter can be used only with replication group containing
|
3934
|
-
#
|
3935
|
-
# VPC).
|
3915
|
+
# clusters running in an Amazon Virtual Private Cloud (Amazon VPC).
|
3936
3916
|
# @return [Array<String>]
|
3937
3917
|
#
|
3938
3918
|
# @!attribute [rw] preferred_maintenance_window
|
@@ -4001,8 +3981,8 @@ module Aws::ElastiCache
|
|
4001
3981
|
# @return [Boolean]
|
4002
3982
|
#
|
4003
3983
|
# @!attribute [rw] engine_version
|
4004
|
-
# The upgraded version of the cache engine to be run on the
|
4005
|
-
#
|
3984
|
+
# The upgraded version of the cache engine to be run on the clusters
|
3985
|
+
# in the replication group.
|
4006
3986
|
#
|
4007
3987
|
# **Important:** You can upgrade to a newer engine version (see
|
4008
3988
|
# [Selecting a Cache Engine and Version][1]), but you cannot downgrade
|
@@ -4085,6 +4065,82 @@ module Aws::ElastiCache
|
|
4085
4065
|
include Aws::Structure
|
4086
4066
|
end
|
4087
4067
|
|
4068
|
+
# Represents the input for a `ModifyReplicationGroupShardConfiguration`
|
4069
|
+
# operation.
|
4070
|
+
#
|
4071
|
+
# @note When making an API call, you may pass ModifyReplicationGroupShardConfigurationMessage
|
4072
|
+
# data as a hash:
|
4073
|
+
#
|
4074
|
+
# {
|
4075
|
+
# replication_group_id: "String", # required
|
4076
|
+
# node_group_count: 1, # required
|
4077
|
+
# apply_immediately: false, # required
|
4078
|
+
# resharding_configuration: [
|
4079
|
+
# {
|
4080
|
+
# preferred_availability_zones: ["String"],
|
4081
|
+
# },
|
4082
|
+
# ],
|
4083
|
+
# node_groups_to_remove: ["String"],
|
4084
|
+
# }
|
4085
|
+
#
|
4086
|
+
# @!attribute [rw] replication_group_id
|
4087
|
+
# The name of the Redis (cluster mode enabled) cluster (replication
|
4088
|
+
# group) on which the shards are to be configured.
|
4089
|
+
# @return [String]
|
4090
|
+
#
|
4091
|
+
# @!attribute [rw] node_group_count
|
4092
|
+
# The number of node groups (shards) that results from the
|
4093
|
+
# modification of the shard configuration.
|
4094
|
+
# @return [Integer]
|
4095
|
+
#
|
4096
|
+
# @!attribute [rw] apply_immediately
|
4097
|
+
# Indicates that the shard reconfiguration process begins immediately.
|
4098
|
+
# At present, the only permitted value for this parameter is `true`.
|
4099
|
+
#
|
4100
|
+
# Value: true
|
4101
|
+
# @return [Boolean]
|
4102
|
+
#
|
4103
|
+
# @!attribute [rw] resharding_configuration
|
4104
|
+
# Specifies the preferred availability zones for each node group in
|
4105
|
+
# the cluster. If the value of `NodeGroupCount` is greater than the
|
4106
|
+
# current number of node groups (shards), you can use this parameter
|
4107
|
+
# to specify the preferred availability zones of the cluster's
|
4108
|
+
# shards. If you omit this parameter ElastiCache selects availability
|
4109
|
+
# zones for you.
|
4110
|
+
#
|
4111
|
+
# You can specify this parameter only if the value of `NodeGroupCount`
|
4112
|
+
# is greater than the current number of node groups (shards).
|
4113
|
+
# @return [Array<Types::ReshardingConfiguration>]
|
4114
|
+
#
|
4115
|
+
# @!attribute [rw] node_groups_to_remove
|
4116
|
+
# If the value of `NodeGroupCount` is less than the current number of
|
4117
|
+
# node groups (shards), `NodeGroupsToRemove` is a required list of
|
4118
|
+
# node group ids to remove from the cluster.
|
4119
|
+
# @return [Array<String>]
|
4120
|
+
#
|
4121
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/ModifyReplicationGroupShardConfigurationMessage AWS API Documentation
|
4122
|
+
#
|
4123
|
+
class ModifyReplicationGroupShardConfigurationMessage < Struct.new(
|
4124
|
+
:replication_group_id,
|
4125
|
+
:node_group_count,
|
4126
|
+
:apply_immediately,
|
4127
|
+
:resharding_configuration,
|
4128
|
+
:node_groups_to_remove)
|
4129
|
+
include Aws::Structure
|
4130
|
+
end
|
4131
|
+
|
4132
|
+
# @!attribute [rw] replication_group
|
4133
|
+
# Contains all of the attributes of a specific Redis replication
|
4134
|
+
# group.
|
4135
|
+
# @return [Types::ReplicationGroup]
|
4136
|
+
#
|
4137
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/ModifyReplicationGroupShardConfigurationResult AWS API Documentation
|
4138
|
+
#
|
4139
|
+
class ModifyReplicationGroupShardConfigurationResult < Struct.new(
|
4140
|
+
:replication_group)
|
4141
|
+
include Aws::Structure
|
4142
|
+
end
|
4143
|
+
|
4088
4144
|
# Represents a collection of cache nodes in a replication group. One
|
4089
4145
|
# node in the node group is the read/write primary node. All the other
|
4090
4146
|
# nodes are read-only Replica nodes.
|
@@ -4126,7 +4182,7 @@ module Aws::ElastiCache
|
|
4126
4182
|
include Aws::Structure
|
4127
4183
|
end
|
4128
4184
|
|
4129
|
-
#
|
4185
|
+
# Node group (shard) configuration options. Each node group (shard)
|
4130
4186
|
# configuration has the following: `Slots`, `PrimaryAvailabilityZone`,
|
4131
4187
|
# `ReplicaAvailabilityZones`, `ReplicaCount`.
|
4132
4188
|
#
|
@@ -4176,11 +4232,11 @@ module Aws::ElastiCache
|
|
4176
4232
|
# Represents a single node within a node group (shard).
|
4177
4233
|
#
|
4178
4234
|
# @!attribute [rw] cache_cluster_id
|
4179
|
-
# The ID of the
|
4235
|
+
# The ID of the cluster to which the node belongs.
|
4180
4236
|
# @return [String]
|
4181
4237
|
#
|
4182
4238
|
# @!attribute [rw] cache_node_id
|
4183
|
-
# The ID of the node within its
|
4239
|
+
# The ID of the node within its cluster. A node ID is a numeric
|
4184
4240
|
# identifier (0001, 0002, etc.).
|
4185
4241
|
# @return [String]
|
4186
4242
|
#
|
@@ -4209,10 +4265,10 @@ module Aws::ElastiCache
|
|
4209
4265
|
include Aws::Structure
|
4210
4266
|
end
|
4211
4267
|
|
4212
|
-
# Represents an individual cache node in a snapshot of a
|
4268
|
+
# Represents an individual cache node in a snapshot of a cluster.
|
4213
4269
|
#
|
4214
4270
|
# @!attribute [rw] cache_cluster_id
|
4215
|
-
# A unique identifier for the source
|
4271
|
+
# A unique identifier for the source cluster.
|
4216
4272
|
# @return [String]
|
4217
4273
|
#
|
4218
4274
|
# @!attribute [rw] node_group_id
|
@@ -4220,7 +4276,7 @@ module Aws::ElastiCache
|
|
4220
4276
|
# @return [String]
|
4221
4277
|
#
|
4222
4278
|
# @!attribute [rw] cache_node_id
|
4223
|
-
# The cache node identifier for the node in the source
|
4279
|
+
# The cache node identifier for the node in the source cluster.
|
4224
4280
|
# @return [String]
|
4225
4281
|
#
|
4226
4282
|
# @!attribute [rw] node_group_configuration
|
@@ -4233,7 +4289,7 @@ module Aws::ElastiCache
|
|
4233
4289
|
#
|
4234
4290
|
# @!attribute [rw] cache_node_create_time
|
4235
4291
|
# The date and time when the cache node was created in the source
|
4236
|
-
#
|
4292
|
+
# cluster.
|
4237
4293
|
# @return [Time]
|
4238
4294
|
#
|
4239
4295
|
# @!attribute [rw] snapshot_create_time
|
@@ -4364,11 +4420,11 @@ module Aws::ElastiCache
|
|
4364
4420
|
include Aws::Structure
|
4365
4421
|
end
|
4366
4422
|
|
4367
|
-
# A group of settings that are applied to the
|
4368
|
-
#
|
4423
|
+
# A group of settings that are applied to the cluster in the future, or
|
4424
|
+
# that are currently being applied.
|
4369
4425
|
#
|
4370
4426
|
# @!attribute [rw] num_cache_nodes
|
4371
|
-
# The new number of cache nodes for the
|
4427
|
+
# The new number of cache nodes for the cluster.
|
4372
4428
|
#
|
4373
4429
|
# For clusters running Redis, this value must be 1. For clusters
|
4374
4430
|
# running Memcached, this value must be between 1 and 20.
|
@@ -4376,17 +4432,17 @@ module Aws::ElastiCache
|
|
4376
4432
|
#
|
4377
4433
|
# @!attribute [rw] cache_node_ids_to_remove
|
4378
4434
|
# A list of cache node IDs that are being removed (or will be removed)
|
4379
|
-
# from the
|
4380
|
-
#
|
4435
|
+
# from the cluster. A node ID is a numeric identifier (0001, 0002,
|
4436
|
+
# etc.).
|
4381
4437
|
# @return [Array<String>]
|
4382
4438
|
#
|
4383
4439
|
# @!attribute [rw] engine_version
|
4384
|
-
# The new cache engine version that the
|
4440
|
+
# The new cache engine version that the cluster runs.
|
4385
4441
|
# @return [String]
|
4386
4442
|
#
|
4387
4443
|
# @!attribute [rw] cache_node_type
|
4388
|
-
# The cache node type that this
|
4389
|
-
#
|
4444
|
+
# The cache node type that this cluster or replication group is scaled
|
4445
|
+
# to.
|
4390
4446
|
# @return [String]
|
4391
4447
|
#
|
4392
4448
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/PendingModifiedValues AWS API Documentation
|
@@ -4468,14 +4524,14 @@ module Aws::ElastiCache
|
|
4468
4524
|
# }
|
4469
4525
|
#
|
4470
4526
|
# @!attribute [rw] cache_cluster_id
|
4471
|
-
# The
|
4472
|
-
#
|
4527
|
+
# The cluster identifier. This parameter is stored as a lowercase
|
4528
|
+
# string.
|
4473
4529
|
# @return [String]
|
4474
4530
|
#
|
4475
4531
|
# @!attribute [rw] cache_node_ids_to_reboot
|
4476
4532
|
# A list of cache node IDs to reboot. A node ID is a numeric
|
4477
|
-
# identifier (0001, 0002, etc.). To reboot an entire
|
4478
|
-
#
|
4533
|
+
# identifier (0001, 0002, etc.). To reboot an entire cluster, specify
|
4534
|
+
# all of the cache node IDs.
|
4479
4535
|
# @return [Array<String>]
|
4480
4536
|
#
|
4481
4537
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/RebootCacheClusterMessage AWS API Documentation
|
@@ -4487,7 +4543,7 @@ module Aws::ElastiCache
|
|
4487
4543
|
end
|
4488
4544
|
|
4489
4545
|
# @!attribute [rw] cache_cluster
|
4490
|
-
# Contains all of the attributes of a specific
|
4546
|
+
# Contains all of the attributes of a specific cluster.
|
4491
4547
|
# @return [Types::CacheCluster]
|
4492
4548
|
#
|
4493
4549
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/RebootCacheClusterResult AWS API Documentation
|
@@ -4560,7 +4616,7 @@ module Aws::ElastiCache
|
|
4560
4616
|
# @return [String]
|
4561
4617
|
#
|
4562
4618
|
# @!attribute [rw] description
|
4563
|
-
# The description of the replication group.
|
4619
|
+
# The user supplied description of the replication group.
|
4564
4620
|
# @return [String]
|
4565
4621
|
#
|
4566
4622
|
# @!attribute [rw] status
|
@@ -4575,18 +4631,20 @@ module Aws::ElastiCache
|
|
4575
4631
|
# @return [Types::ReplicationGroupPendingModifiedValues]
|
4576
4632
|
#
|
4577
4633
|
# @!attribute [rw] member_clusters
|
4578
|
-
# The
|
4579
|
-
#
|
4634
|
+
# The identifiers of all the nodes that are part of this replication
|
4635
|
+
# group.
|
4580
4636
|
# @return [Array<String>]
|
4581
4637
|
#
|
4582
4638
|
# @!attribute [rw] node_groups
|
4583
|
-
# A
|
4584
|
-
# replication
|
4639
|
+
# A list of node groups in this replication group. For Redis (cluster
|
4640
|
+
# mode disabled) replication groups, this is a single-element list.
|
4641
|
+
# For Redis (cluster mode enabled) replication groups, the list
|
4642
|
+
# contains an entry for each node group (shard).
|
4585
4643
|
# @return [Array<Types::NodeGroup>]
|
4586
4644
|
#
|
4587
4645
|
# @!attribute [rw] snapshotting_cluster_id
|
4588
|
-
# The
|
4589
|
-
#
|
4646
|
+
# The cluster ID that is used as the daily snapshot source for the
|
4647
|
+
# replication group.
|
4590
4648
|
# @return [String]
|
4591
4649
|
#
|
4592
4650
|
# @!attribute [rw] automatic_failover
|
@@ -4604,13 +4662,13 @@ module Aws::ElastiCache
|
|
4604
4662
|
# @return [String]
|
4605
4663
|
#
|
4606
4664
|
# @!attribute [rw] configuration_endpoint
|
4607
|
-
# The configuration endpoint for this
|
4665
|
+
# The configuration endpoint for this replication group. Use the
|
4608
4666
|
# configuration endpoint to connect to this replication group.
|
4609
4667
|
# @return [Types::Endpoint]
|
4610
4668
|
#
|
4611
4669
|
# @!attribute [rw] snapshot_retention_limit
|
4612
|
-
# The number of days for which ElastiCache retains automatic
|
4613
|
-
#
|
4670
|
+
# The number of days for which ElastiCache retains automatic cluster
|
4671
|
+
# snapshots before deleting them. For example, if you set
|
4614
4672
|
# `SnapshotRetentionLimit` to 5, a snapshot that was taken today is
|
4615
4673
|
# retained for 5 days before being deleted.
|
4616
4674
|
#
|
@@ -4738,11 +4796,16 @@ module Aws::ElastiCache
|
|
4738
4796
|
# * Redis (cluster mode enabled): T1 node types.
|
4739
4797
|
# @return [String]
|
4740
4798
|
#
|
4799
|
+
# @!attribute [rw] resharding
|
4800
|
+
# The status of an online resharding operation.
|
4801
|
+
# @return [Types::ReshardingStatus]
|
4802
|
+
#
|
4741
4803
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/ReplicationGroupPendingModifiedValues AWS API Documentation
|
4742
4804
|
#
|
4743
4805
|
class ReplicationGroupPendingModifiedValues < Struct.new(
|
4744
4806
|
:primary_cluster_id,
|
4745
|
-
:automatic_failover_status
|
4807
|
+
:automatic_failover_status,
|
4808
|
+
:resharding)
|
4746
4809
|
include Aws::Structure
|
4747
4810
|
end
|
4748
4811
|
|
@@ -4817,9 +4880,6 @@ module Aws::ElastiCache
|
|
4817
4880
|
# * Redis Append-only files (AOF) functionality is not supported for
|
4818
4881
|
# T1 or T2 instances.
|
4819
4882
|
#
|
4820
|
-
# Supported node types are available in all regions except as noted in
|
4821
|
-
# the following table.
|
4822
|
-
#
|
4823
4883
|
# For a complete listing of node types and specifications, see [Amazon
|
4824
4884
|
# ElastiCache Product Features and Details][1] and either [Cache Node
|
4825
4885
|
# Type-Specific Parameters for Memcached][2] or [Cache Node
|
@@ -4971,9 +5031,6 @@ module Aws::ElastiCache
|
|
4971
5031
|
# * Redis Append-only files (AOF) functionality is not supported for
|
4972
5032
|
# T1 or T2 instances.
|
4973
5033
|
#
|
4974
|
-
# Supported node types are available in all regions except as noted in
|
4975
|
-
# the following table.
|
4976
|
-
#
|
4977
5034
|
# For a complete listing of node types and specifications, see [Amazon
|
4978
5035
|
# ElastiCache Product Features and Details][1] and either [Cache Node
|
4979
5036
|
# Type-Specific Parameters for Memcached][2] or [Cache Node
|
@@ -5088,6 +5145,41 @@ module Aws::ElastiCache
|
|
5088
5145
|
include Aws::Structure
|
5089
5146
|
end
|
5090
5147
|
|
5148
|
+
# A list of `PreferredAvailabilityZones` objects that specifies the
|
5149
|
+
# configuration of a node group in the resharded cluster.
|
5150
|
+
#
|
5151
|
+
# @note When making an API call, you may pass ReshardingConfiguration
|
5152
|
+
# data as a hash:
|
5153
|
+
#
|
5154
|
+
# {
|
5155
|
+
# preferred_availability_zones: ["String"],
|
5156
|
+
# }
|
5157
|
+
#
|
5158
|
+
# @!attribute [rw] preferred_availability_zones
|
5159
|
+
# A list of preferred availability zones for the nodes in this
|
5160
|
+
# cluster.
|
5161
|
+
# @return [Array<String>]
|
5162
|
+
#
|
5163
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/ReshardingConfiguration AWS API Documentation
|
5164
|
+
#
|
5165
|
+
class ReshardingConfiguration < Struct.new(
|
5166
|
+
:preferred_availability_zones)
|
5167
|
+
include Aws::Structure
|
5168
|
+
end
|
5169
|
+
|
5170
|
+
# The status of an online resharding operation.
|
5171
|
+
#
|
5172
|
+
# @!attribute [rw] slot_migration
|
5173
|
+
# Represents the progress of an online resharding operation.
|
5174
|
+
# @return [Types::SlotMigration]
|
5175
|
+
#
|
5176
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/ReshardingStatus AWS API Documentation
|
5177
|
+
#
|
5178
|
+
class ReshardingStatus < Struct.new(
|
5179
|
+
:slot_migration)
|
5180
|
+
include Aws::Structure
|
5181
|
+
end
|
5182
|
+
|
5091
5183
|
# Represents the input of a `RevokeCacheSecurityGroupIngress` operation.
|
5092
5184
|
#
|
5093
5185
|
# @note When making an API call, you may pass RevokeCacheSecurityGroupIngressMessage
|
@@ -5148,7 +5240,7 @@ module Aws::ElastiCache
|
|
5148
5240
|
# @!attribute [rw] status
|
5149
5241
|
# The status of the cache security group membership. The status
|
5150
5242
|
# changes whenever a cache security group is modified, or when the
|
5151
|
-
# cache security groups assigned to a
|
5243
|
+
# cache security groups assigned to a cluster are modified.
|
5152
5244
|
# @return [String]
|
5153
5245
|
#
|
5154
5246
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/SecurityGroupMembership AWS API Documentation
|
@@ -5159,8 +5251,21 @@ module Aws::ElastiCache
|
|
5159
5251
|
include Aws::Structure
|
5160
5252
|
end
|
5161
5253
|
|
5162
|
-
# Represents
|
5163
|
-
#
|
5254
|
+
# Represents the progress of an online resharding operation.
|
5255
|
+
#
|
5256
|
+
# @!attribute [rw] progress_percentage
|
5257
|
+
# The percentage of the slot migration that is complete.
|
5258
|
+
# @return [Float]
|
5259
|
+
#
|
5260
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/SlotMigration AWS API Documentation
|
5261
|
+
#
|
5262
|
+
class SlotMigration < Struct.new(
|
5263
|
+
:progress_percentage)
|
5264
|
+
include Aws::Structure
|
5265
|
+
end
|
5266
|
+
|
5267
|
+
# Represents a copy of an entire Redis cluster as of the time when the
|
5268
|
+
# snapshot was taken.
|
5164
5269
|
#
|
5165
5270
|
# @!attribute [rw] snapshot_name
|
5166
5271
|
# The name of a snapshot. For an automatic snapshot, the name is
|
@@ -5177,7 +5282,7 @@ module Aws::ElastiCache
|
|
5177
5282
|
# @return [String]
|
5178
5283
|
#
|
5179
5284
|
# @!attribute [rw] cache_cluster_id
|
5180
|
-
# The user-supplied identifier of the source
|
5285
|
+
# The user-supplied identifier of the source cluster.
|
5181
5286
|
# @return [String]
|
5182
5287
|
#
|
5183
5288
|
# @!attribute [rw] snapshot_status
|
@@ -5192,7 +5297,7 @@ module Aws::ElastiCache
|
|
5192
5297
|
#
|
5193
5298
|
# @!attribute [rw] cache_node_type
|
5194
5299
|
# The name of the compute and memory capacity node type for the source
|
5195
|
-
#
|
5300
|
+
# cluster.
|
5196
5301
|
#
|
5197
5302
|
# The following node types are supported by ElastiCache. Generally
|
5198
5303
|
# speaking, the current generation types provide more memory and
|
@@ -5251,9 +5356,6 @@ module Aws::ElastiCache
|
|
5251
5356
|
# * Redis Append-only files (AOF) functionality is not supported for
|
5252
5357
|
# T1 or T2 instances.
|
5253
5358
|
#
|
5254
|
-
# Supported node types are available in all regions except as noted in
|
5255
|
-
# the following table.
|
5256
|
-
#
|
5257
5359
|
# For a complete listing of node types and specifications, see [Amazon
|
5258
5360
|
# ElastiCache Product Features and Details][1] and either [Cache Node
|
5259
5361
|
# Type-Specific Parameters for Memcached][2] or [Cache Node
|
@@ -5268,28 +5370,28 @@ module Aws::ElastiCache
|
|
5268
5370
|
#
|
5269
5371
|
# @!attribute [rw] engine
|
5270
5372
|
# The name of the cache engine (`memcached` or `redis`) used by the
|
5271
|
-
# source
|
5373
|
+
# source cluster.
|
5272
5374
|
# @return [String]
|
5273
5375
|
#
|
5274
5376
|
# @!attribute [rw] engine_version
|
5275
5377
|
# The version of the cache engine version that is used by the source
|
5276
|
-
#
|
5378
|
+
# cluster.
|
5277
5379
|
# @return [String]
|
5278
5380
|
#
|
5279
5381
|
# @!attribute [rw] num_cache_nodes
|
5280
|
-
# The number of cache nodes in the source
|
5382
|
+
# The number of cache nodes in the source cluster.
|
5281
5383
|
#
|
5282
5384
|
# For clusters running Redis, this value must be 1. For clusters
|
5283
5385
|
# running Memcached, this value must be between 1 and 20.
|
5284
5386
|
# @return [Integer]
|
5285
5387
|
#
|
5286
5388
|
# @!attribute [rw] preferred_availability_zone
|
5287
|
-
# The name of the Availability Zone in which the source
|
5288
|
-
#
|
5389
|
+
# The name of the Availability Zone in which the source cluster is
|
5390
|
+
# located.
|
5289
5391
|
# @return [String]
|
5290
5392
|
#
|
5291
5393
|
# @!attribute [rw] cache_cluster_create_time
|
5292
|
-
# The date and time when the source
|
5394
|
+
# The date and time when the source cluster was created.
|
5293
5395
|
# @return [Time]
|
5294
5396
|
#
|
5295
5397
|
# @!attribute [rw] preferred_maintenance_window
|
@@ -5319,27 +5421,26 @@ module Aws::ElastiCache
|
|
5319
5421
|
#
|
5320
5422
|
# @!attribute [rw] topic_arn
|
5321
5423
|
# The Amazon Resource Name (ARN) for the topic used by the source
|
5322
|
-
#
|
5424
|
+
# cluster for publishing notifications.
|
5323
5425
|
# @return [String]
|
5324
5426
|
#
|
5325
5427
|
# @!attribute [rw] port
|
5326
|
-
# The port number used by each cache nodes in the source
|
5327
|
-
# cluster.
|
5428
|
+
# The port number used by each cache nodes in the source cluster.
|
5328
5429
|
# @return [Integer]
|
5329
5430
|
#
|
5330
5431
|
# @!attribute [rw] cache_parameter_group_name
|
5331
|
-
# The cache parameter group that is associated with the source
|
5432
|
+
# The cache parameter group that is associated with the source
|
5332
5433
|
# cluster.
|
5333
5434
|
# @return [String]
|
5334
5435
|
#
|
5335
5436
|
# @!attribute [rw] cache_subnet_group_name
|
5336
|
-
# The name of the cache subnet group associated with the source
|
5437
|
+
# The name of the cache subnet group associated with the source
|
5337
5438
|
# cluster.
|
5338
5439
|
# @return [String]
|
5339
5440
|
#
|
5340
5441
|
# @!attribute [rw] vpc_id
|
5341
5442
|
# The Amazon Virtual Private Cloud identifier (VPC ID) of the cache
|
5342
|
-
# subnet group for the source
|
5443
|
+
# subnet group for the source cluster.
|
5343
5444
|
# @return [String]
|
5344
5445
|
#
|
5345
5446
|
# @!attribute [rw] auto_minor_version_upgrade
|
@@ -5351,10 +5452,10 @@ module Aws::ElastiCache
|
|
5351
5452
|
# retains the snapshot before deleting it.
|
5352
5453
|
#
|
5353
5454
|
# For manual snapshots, this field reflects the
|
5354
|
-
# `SnapshotRetentionLimit` for the source
|
5355
|
-
#
|
5356
|
-
#
|
5357
|
-
#
|
5455
|
+
# `SnapshotRetentionLimit` for the source cluster when the snapshot
|
5456
|
+
# was created. This field is otherwise ignored: Manual snapshots do
|
5457
|
+
# not expire, and can only be deleted using the `DeleteSnapshot`
|
5458
|
+
# operation.
|
5358
5459
|
#
|
5359
5460
|
# **Important** If the value of SnapshotRetentionLimit is set to zero
|
5360
5461
|
# (0), backups are turned off.
|
@@ -5362,7 +5463,7 @@ module Aws::ElastiCache
|
|
5362
5463
|
#
|
5363
5464
|
# @!attribute [rw] snapshot_window
|
5364
5465
|
# The daily time range during which ElastiCache takes daily snapshots
|
5365
|
-
# of the source
|
5466
|
+
# of the source cluster.
|
5366
5467
|
# @return [String]
|
5367
5468
|
#
|
5368
5469
|
# @!attribute [rw] num_node_groups
|
@@ -5386,7 +5487,7 @@ module Aws::ElastiCache
|
|
5386
5487
|
# @return [String]
|
5387
5488
|
#
|
5388
5489
|
# @!attribute [rw] node_snapshots
|
5389
|
-
# A list of the cache nodes in the source
|
5490
|
+
# A list of the cache nodes in the source cluster.
|
5390
5491
|
# @return [Array<Types::NodeSnapshot>]
|
5391
5492
|
#
|
5392
5493
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/Snapshot AWS API Documentation
|
@@ -5419,9 +5520,9 @@ module Aws::ElastiCache
|
|
5419
5520
|
include Aws::Structure
|
5420
5521
|
end
|
5421
5522
|
|
5422
|
-
# Represents the subnet associated with a
|
5423
|
-
#
|
5424
|
-
#
|
5523
|
+
# Represents the subnet associated with a cluster. This parameter refers
|
5524
|
+
# to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and
|
5525
|
+
# used with ElastiCache.
|
5425
5526
|
#
|
5426
5527
|
# @!attribute [rw] subnet_identifier
|
5427
5528
|
# The unique identifier for the subnet.
|