aws-sdk-elasticache 1.82.0 → 1.83.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/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-elasticache/client.rb +89 -13
- data/lib/aws-sdk-elasticache/client_api.rb +10 -0
- data/lib/aws-sdk-elasticache/endpoint_parameters.rb +3 -0
- data/lib/aws-sdk-elasticache/endpoint_provider.rb +81 -82
- data/lib/aws-sdk-elasticache/types.rb +90 -1081
- data/lib/aws-sdk-elasticache.rb +1 -1
- metadata +2 -2
@@ -18,19 +18,6 @@ module Aws::ElastiCache
|
|
18
18
|
|
19
19
|
# Represents the input of an AddTagsToResource operation.
|
20
20
|
#
|
21
|
-
# @note When making an API call, you may pass AddTagsToResourceMessage
|
22
|
-
# data as a hash:
|
23
|
-
#
|
24
|
-
# {
|
25
|
-
# resource_name: "String", # required
|
26
|
-
# tags: [ # required
|
27
|
-
# {
|
28
|
-
# key: "String",
|
29
|
-
# value: "String",
|
30
|
-
# },
|
31
|
-
# ],
|
32
|
-
# }
|
33
|
-
#
|
34
21
|
# @!attribute [rw] resource_name
|
35
22
|
# The Amazon Resource Name (ARN) of the resource to which the tags are
|
36
23
|
# to be added, for example
|
@@ -111,14 +98,6 @@ module Aws::ElastiCache
|
|
111
98
|
|
112
99
|
# Specifies the authentication mode to use.
|
113
100
|
#
|
114
|
-
# @note When making an API call, you may pass AuthenticationMode
|
115
|
-
# data as a hash:
|
116
|
-
#
|
117
|
-
# {
|
118
|
-
# type: "password", # accepts password, no-password-required, iam
|
119
|
-
# passwords: ["String"],
|
120
|
-
# }
|
121
|
-
#
|
122
101
|
# @!attribute [rw] type
|
123
102
|
# Specifies the authentication type. Possible options are IAM
|
124
103
|
# authentication, password and no password.
|
@@ -155,15 +134,6 @@ module Aws::ElastiCache
|
|
155
134
|
# Represents the input of an AuthorizeCacheSecurityGroupIngress
|
156
135
|
# operation.
|
157
136
|
#
|
158
|
-
# @note When making an API call, you may pass AuthorizeCacheSecurityGroupIngressMessage
|
159
|
-
# data as a hash:
|
160
|
-
#
|
161
|
-
# {
|
162
|
-
# cache_security_group_name: "String", # required
|
163
|
-
# ec2_security_group_name: "String", # required
|
164
|
-
# ec2_security_group_owner_id: "String", # required
|
165
|
-
# }
|
166
|
-
#
|
167
137
|
# @!attribute [rw] cache_security_group_name
|
168
138
|
# The cache security group that allows network ingress.
|
169
139
|
# @return [String]
|
@@ -221,15 +191,6 @@ module Aws::ElastiCache
|
|
221
191
|
include Aws::Structure
|
222
192
|
end
|
223
193
|
|
224
|
-
# @note When making an API call, you may pass BatchApplyUpdateActionMessage
|
225
|
-
# data as a hash:
|
226
|
-
#
|
227
|
-
# {
|
228
|
-
# replication_group_ids: ["String"],
|
229
|
-
# cache_cluster_ids: ["String"],
|
230
|
-
# service_update_name: "String", # required
|
231
|
-
# }
|
232
|
-
#
|
233
194
|
# @!attribute [rw] replication_group_ids
|
234
195
|
# The replication group IDs
|
235
196
|
# @return [Array<String>]
|
@@ -252,15 +213,6 @@ module Aws::ElastiCache
|
|
252
213
|
include Aws::Structure
|
253
214
|
end
|
254
215
|
|
255
|
-
# @note When making an API call, you may pass BatchStopUpdateActionMessage
|
256
|
-
# data as a hash:
|
257
|
-
#
|
258
|
-
# {
|
259
|
-
# replication_group_ids: ["String"],
|
260
|
-
# cache_cluster_ids: ["String"],
|
261
|
-
# service_update_name: "String", # required
|
262
|
-
# }
|
263
|
-
#
|
264
216
|
# @!attribute [rw] replication_group_ids
|
265
217
|
# The replication group IDs
|
266
218
|
# @return [Array<String>]
|
@@ -552,11 +504,6 @@ module Aws::ElastiCache
|
|
552
504
|
# @!attribute [rw] transit_encryption_enabled
|
553
505
|
# A flag that enables in-transit encryption when set to `true`.
|
554
506
|
#
|
555
|
-
# You cannot modify the value of `TransitEncryptionEnabled` after the
|
556
|
-
# cluster is created. To enable in-transit encryption on a cluster you
|
557
|
-
# must set `TransitEncryptionEnabled` to `true` when you create a
|
558
|
-
# cluster.
|
559
|
-
#
|
560
507
|
# **Required:** Only available when creating a replication group in an
|
561
508
|
# Amazon VPC using redis version `3.2.6`, `4.x` or later.
|
562
509
|
#
|
@@ -612,6 +559,11 @@ module Aws::ElastiCache
|
|
612
559
|
# [1]: https://aws.amazon.com/ec2/nitro/
|
613
560
|
# @return [String]
|
614
561
|
#
|
562
|
+
# @!attribute [rw] transit_encryption_mode
|
563
|
+
# A setting that allows you to migrate your clients to use in-transit
|
564
|
+
# encryption, with no downtime.
|
565
|
+
# @return [String]
|
566
|
+
#
|
615
567
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/CacheCluster AWS API Documentation
|
616
568
|
#
|
617
569
|
class CacheCluster < Struct.new(
|
@@ -646,7 +598,8 @@ module Aws::ElastiCache
|
|
646
598
|
:replication_group_log_delivery_enabled,
|
647
599
|
:log_delivery_configurations,
|
648
600
|
:network_type,
|
649
|
-
:ip_discovery
|
601
|
+
:ip_discovery,
|
602
|
+
:transit_encryption_mode)
|
650
603
|
SENSITIVE = []
|
651
604
|
include Aws::Structure
|
652
605
|
end
|
@@ -1400,13 +1353,6 @@ module Aws::ElastiCache
|
|
1400
1353
|
|
1401
1354
|
# The configuration details of the CloudWatch Logs destination.
|
1402
1355
|
#
|
1403
|
-
# @note When making an API call, you may pass CloudWatchLogsDestinationDetails
|
1404
|
-
# data as a hash:
|
1405
|
-
#
|
1406
|
-
# {
|
1407
|
-
# log_group: "String",
|
1408
|
-
# }
|
1409
|
-
#
|
1410
1356
|
# @!attribute [rw] log_group
|
1411
1357
|
# The name of the CloudWatch Logs log group.
|
1412
1358
|
# @return [String]
|
@@ -1426,14 +1372,6 @@ module Aws::ElastiCache
|
|
1426
1372
|
#
|
1427
1373
|
class ClusterQuotaForCustomerExceededFault < Aws::EmptyStructure; end
|
1428
1374
|
|
1429
|
-
# @note When making an API call, you may pass CompleteMigrationMessage
|
1430
|
-
# data as a hash:
|
1431
|
-
#
|
1432
|
-
# {
|
1433
|
-
# replication_group_id: "String", # required
|
1434
|
-
# force: false,
|
1435
|
-
# }
|
1436
|
-
#
|
1437
1375
|
# @!attribute [rw] replication_group_id
|
1438
1376
|
# The ID of the replication group to which data is being migrated.
|
1439
1377
|
# @return [String]
|
@@ -1471,16 +1409,6 @@ module Aws::ElastiCache
|
|
1471
1409
|
# replicas. Each node group (shard) configuration has the following
|
1472
1410
|
# members: NodeGroupId, NewReplicaCount, and PreferredAvailabilityZones.
|
1473
1411
|
#
|
1474
|
-
# @note When making an API call, you may pass ConfigureShard
|
1475
|
-
# data as a hash:
|
1476
|
-
#
|
1477
|
-
# {
|
1478
|
-
# node_group_id: "AllowedNodeGroupId", # required
|
1479
|
-
# new_replica_count: 1, # required
|
1480
|
-
# preferred_availability_zones: ["String"],
|
1481
|
-
# preferred_outpost_arns: ["String"],
|
1482
|
-
# }
|
1483
|
-
#
|
1484
1412
|
# @!attribute [rw] node_group_id
|
1485
1413
|
# The 4-digit id for the node group you are configuring. For Redis
|
1486
1414
|
# (cluster mode disabled) replication groups, the node group id is
|
@@ -1536,22 +1464,6 @@ module Aws::ElastiCache
|
|
1536
1464
|
|
1537
1465
|
# Represents the input of a `CopySnapshotMessage` operation.
|
1538
1466
|
#
|
1539
|
-
# @note When making an API call, you may pass CopySnapshotMessage
|
1540
|
-
# data as a hash:
|
1541
|
-
#
|
1542
|
-
# {
|
1543
|
-
# source_snapshot_name: "String", # required
|
1544
|
-
# target_snapshot_name: "String", # required
|
1545
|
-
# target_bucket: "String",
|
1546
|
-
# kms_key_id: "String",
|
1547
|
-
# tags: [
|
1548
|
-
# {
|
1549
|
-
# key: "String",
|
1550
|
-
# value: "String",
|
1551
|
-
# },
|
1552
|
-
# ],
|
1553
|
-
# }
|
1554
|
-
#
|
1555
1467
|
# @!attribute [rw] source_snapshot_name
|
1556
1468
|
# The name of an existing snapshot from which to make a copy.
|
1557
1469
|
# @return [String]
|
@@ -1618,62 +1530,6 @@ module Aws::ElastiCache
|
|
1618
1530
|
|
1619
1531
|
# Represents the input of a CreateCacheCluster operation.
|
1620
1532
|
#
|
1621
|
-
# @note When making an API call, you may pass CreateCacheClusterMessage
|
1622
|
-
# data as a hash:
|
1623
|
-
#
|
1624
|
-
# {
|
1625
|
-
# cache_cluster_id: "String", # required
|
1626
|
-
# replication_group_id: "String",
|
1627
|
-
# az_mode: "single-az", # accepts single-az, cross-az
|
1628
|
-
# preferred_availability_zone: "String",
|
1629
|
-
# preferred_availability_zones: ["String"],
|
1630
|
-
# num_cache_nodes: 1,
|
1631
|
-
# cache_node_type: "String",
|
1632
|
-
# engine: "String",
|
1633
|
-
# engine_version: "String",
|
1634
|
-
# cache_parameter_group_name: "String",
|
1635
|
-
# cache_subnet_group_name: "String",
|
1636
|
-
# cache_security_group_names: ["String"],
|
1637
|
-
# security_group_ids: ["String"],
|
1638
|
-
# tags: [
|
1639
|
-
# {
|
1640
|
-
# key: "String",
|
1641
|
-
# value: "String",
|
1642
|
-
# },
|
1643
|
-
# ],
|
1644
|
-
# snapshot_arns: ["String"],
|
1645
|
-
# snapshot_name: "String",
|
1646
|
-
# preferred_maintenance_window: "String",
|
1647
|
-
# port: 1,
|
1648
|
-
# notification_topic_arn: "String",
|
1649
|
-
# auto_minor_version_upgrade: false,
|
1650
|
-
# snapshot_retention_limit: 1,
|
1651
|
-
# snapshot_window: "String",
|
1652
|
-
# auth_token: "String",
|
1653
|
-
# outpost_mode: "single-outpost", # accepts single-outpost, cross-outpost
|
1654
|
-
# preferred_outpost_arn: "String",
|
1655
|
-
# preferred_outpost_arns: ["String"],
|
1656
|
-
# log_delivery_configurations: [
|
1657
|
-
# {
|
1658
|
-
# log_type: "slow-log", # accepts slow-log, engine-log
|
1659
|
-
# destination_type: "cloudwatch-logs", # accepts cloudwatch-logs, kinesis-firehose
|
1660
|
-
# destination_details: {
|
1661
|
-
# cloud_watch_logs_details: {
|
1662
|
-
# log_group: "String",
|
1663
|
-
# },
|
1664
|
-
# kinesis_firehose_details: {
|
1665
|
-
# delivery_stream: "String",
|
1666
|
-
# },
|
1667
|
-
# },
|
1668
|
-
# log_format: "text", # accepts text, json
|
1669
|
-
# enabled: false,
|
1670
|
-
# },
|
1671
|
-
# ],
|
1672
|
-
# transit_encryption_enabled: false,
|
1673
|
-
# network_type: "ipv4", # accepts ipv4, ipv6, dual_stack
|
1674
|
-
# ip_discovery: "ipv4", # accepts ipv4, ipv6
|
1675
|
-
# }
|
1676
|
-
#
|
1677
1533
|
# @!attribute [rw] cache_cluster_id
|
1678
1534
|
# The node group (shard) identifier. This parameter is stored as a
|
1679
1535
|
# lowercase string.
|
@@ -2059,11 +1915,7 @@ module Aws::ElastiCache
|
|
2059
1915
|
# @return [Array<Types::LogDeliveryConfigurationRequest>]
|
2060
1916
|
#
|
2061
1917
|
# @!attribute [rw] transit_encryption_enabled
|
2062
|
-
# A flag that enables in-transit encryption when set to true.
|
2063
|
-
# cannot modify the value of TransitEncryptionEnabled after the
|
2064
|
-
# cluster is created. To enable in-transit encryption on a cluster you
|
2065
|
-
# must set `TransitEncryptionEnabled` to true when you create a
|
2066
|
-
# cluster.
|
1918
|
+
# A flag that enables in-transit encryption when set to true.
|
2067
1919
|
#
|
2068
1920
|
# Only available when creating a cache cluster in an Amazon VPC using
|
2069
1921
|
# Memcached version 1.6.12 or later.
|
@@ -2142,21 +1994,6 @@ module Aws::ElastiCache
|
|
2142
1994
|
|
2143
1995
|
# Represents the input of a `CreateCacheParameterGroup` operation.
|
2144
1996
|
#
|
2145
|
-
# @note When making an API call, you may pass CreateCacheParameterGroupMessage
|
2146
|
-
# data as a hash:
|
2147
|
-
#
|
2148
|
-
# {
|
2149
|
-
# cache_parameter_group_name: "String", # required
|
2150
|
-
# cache_parameter_group_family: "String", # required
|
2151
|
-
# description: "String", # required
|
2152
|
-
# tags: [
|
2153
|
-
# {
|
2154
|
-
# key: "String",
|
2155
|
-
# value: "String",
|
2156
|
-
# },
|
2157
|
-
# ],
|
2158
|
-
# }
|
2159
|
-
#
|
2160
1997
|
# @!attribute [rw] cache_parameter_group_name
|
2161
1998
|
# A user-specified name for the cache parameter group.
|
2162
1999
|
# @return [String]
|
@@ -2205,20 +2042,6 @@ module Aws::ElastiCache
|
|
2205
2042
|
|
2206
2043
|
# Represents the input of a `CreateCacheSecurityGroup` operation.
|
2207
2044
|
#
|
2208
|
-
# @note When making an API call, you may pass CreateCacheSecurityGroupMessage
|
2209
|
-
# data as a hash:
|
2210
|
-
#
|
2211
|
-
# {
|
2212
|
-
# cache_security_group_name: "String", # required
|
2213
|
-
# description: "String", # required
|
2214
|
-
# tags: [
|
2215
|
-
# {
|
2216
|
-
# key: "String",
|
2217
|
-
# value: "String",
|
2218
|
-
# },
|
2219
|
-
# ],
|
2220
|
-
# }
|
2221
|
-
#
|
2222
2045
|
# @!attribute [rw] cache_security_group_name
|
2223
2046
|
# A name for the cache security group. This value is stored as a
|
2224
2047
|
# lowercase string.
|
@@ -2269,21 +2092,6 @@ module Aws::ElastiCache
|
|
2269
2092
|
|
2270
2093
|
# Represents the input of a `CreateCacheSubnetGroup` operation.
|
2271
2094
|
#
|
2272
|
-
# @note When making an API call, you may pass CreateCacheSubnetGroupMessage
|
2273
|
-
# data as a hash:
|
2274
|
-
#
|
2275
|
-
# {
|
2276
|
-
# cache_subnet_group_name: "String", # required
|
2277
|
-
# cache_subnet_group_description: "String", # required
|
2278
|
-
# subnet_ids: ["String"], # required
|
2279
|
-
# tags: [
|
2280
|
-
# {
|
2281
|
-
# key: "String",
|
2282
|
-
# value: "String",
|
2283
|
-
# },
|
2284
|
-
# ],
|
2285
|
-
# }
|
2286
|
-
#
|
2287
2095
|
# @!attribute [rw] cache_subnet_group_name
|
2288
2096
|
# A name for the cache subnet group. This value is stored as a
|
2289
2097
|
# lowercase string.
|
@@ -2335,15 +2143,6 @@ module Aws::ElastiCache
|
|
2335
2143
|
include Aws::Structure
|
2336
2144
|
end
|
2337
2145
|
|
2338
|
-
# @note When making an API call, you may pass CreateGlobalReplicationGroupMessage
|
2339
|
-
# data as a hash:
|
2340
|
-
#
|
2341
|
-
# {
|
2342
|
-
# global_replication_group_id_suffix: "String", # required
|
2343
|
-
# global_replication_group_description: "String",
|
2344
|
-
# primary_replication_group_id: "String", # required
|
2345
|
-
# }
|
2346
|
-
#
|
2347
2146
|
# @!attribute [rw] global_replication_group_id_suffix
|
2348
2147
|
# The suffix name of a Global datastore. Amazon ElastiCache
|
2349
2148
|
# automatically applies a prefix to the Global datastore ID when it is
|
@@ -2404,78 +2203,6 @@ module Aws::ElastiCache
|
|
2404
2203
|
|
2405
2204
|
# Represents the input of a `CreateReplicationGroup` operation.
|
2406
2205
|
#
|
2407
|
-
# @note When making an API call, you may pass CreateReplicationGroupMessage
|
2408
|
-
# data as a hash:
|
2409
|
-
#
|
2410
|
-
# {
|
2411
|
-
# replication_group_id: "String", # required
|
2412
|
-
# replication_group_description: "String", # required
|
2413
|
-
# global_replication_group_id: "String",
|
2414
|
-
# primary_cluster_id: "String",
|
2415
|
-
# automatic_failover_enabled: false,
|
2416
|
-
# multi_az_enabled: false,
|
2417
|
-
# num_cache_clusters: 1,
|
2418
|
-
# preferred_cache_cluster_a_zs: ["String"],
|
2419
|
-
# num_node_groups: 1,
|
2420
|
-
# replicas_per_node_group: 1,
|
2421
|
-
# node_group_configuration: [
|
2422
|
-
# {
|
2423
|
-
# node_group_id: "AllowedNodeGroupId",
|
2424
|
-
# slots: "String",
|
2425
|
-
# replica_count: 1,
|
2426
|
-
# primary_availability_zone: "String",
|
2427
|
-
# replica_availability_zones: ["String"],
|
2428
|
-
# primary_outpost_arn: "String",
|
2429
|
-
# replica_outpost_arns: ["String"],
|
2430
|
-
# },
|
2431
|
-
# ],
|
2432
|
-
# cache_node_type: "String",
|
2433
|
-
# engine: "String",
|
2434
|
-
# engine_version: "String",
|
2435
|
-
# cache_parameter_group_name: "String",
|
2436
|
-
# cache_subnet_group_name: "String",
|
2437
|
-
# cache_security_group_names: ["String"],
|
2438
|
-
# security_group_ids: ["String"],
|
2439
|
-
# tags: [
|
2440
|
-
# {
|
2441
|
-
# key: "String",
|
2442
|
-
# value: "String",
|
2443
|
-
# },
|
2444
|
-
# ],
|
2445
|
-
# snapshot_arns: ["String"],
|
2446
|
-
# snapshot_name: "String",
|
2447
|
-
# preferred_maintenance_window: "String",
|
2448
|
-
# port: 1,
|
2449
|
-
# notification_topic_arn: "String",
|
2450
|
-
# auto_minor_version_upgrade: false,
|
2451
|
-
# snapshot_retention_limit: 1,
|
2452
|
-
# snapshot_window: "String",
|
2453
|
-
# auth_token: "String",
|
2454
|
-
# transit_encryption_enabled: false,
|
2455
|
-
# at_rest_encryption_enabled: false,
|
2456
|
-
# kms_key_id: "String",
|
2457
|
-
# user_group_ids: ["UserGroupId"],
|
2458
|
-
# log_delivery_configurations: [
|
2459
|
-
# {
|
2460
|
-
# log_type: "slow-log", # accepts slow-log, engine-log
|
2461
|
-
# destination_type: "cloudwatch-logs", # accepts cloudwatch-logs, kinesis-firehose
|
2462
|
-
# destination_details: {
|
2463
|
-
# cloud_watch_logs_details: {
|
2464
|
-
# log_group: "String",
|
2465
|
-
# },
|
2466
|
-
# kinesis_firehose_details: {
|
2467
|
-
# delivery_stream: "String",
|
2468
|
-
# },
|
2469
|
-
# },
|
2470
|
-
# log_format: "text", # accepts text, json
|
2471
|
-
# enabled: false,
|
2472
|
-
# },
|
2473
|
-
# ],
|
2474
|
-
# data_tiering_enabled: false,
|
2475
|
-
# network_type: "ipv4", # accepts ipv4, ipv6, dual_stack
|
2476
|
-
# ip_discovery: "ipv4", # accepts ipv4, ipv6
|
2477
|
-
# }
|
2478
|
-
#
|
2479
2206
|
# @!attribute [rw] replication_group_id
|
2480
2207
|
# The replication group identifier. This parameter is stored as a
|
2481
2208
|
# lowercase string.
|
@@ -2707,7 +2434,7 @@ module Aws::ElastiCache
|
|
2707
2434
|
#
|
2708
2435
|
# @!attribute [rw] engine
|
2709
2436
|
# The name of the cache engine to be used for the clusters in this
|
2710
|
-
# replication group.
|
2437
|
+
# replication group. The value must be set to `Redis`.
|
2711
2438
|
# @return [String]
|
2712
2439
|
#
|
2713
2440
|
# @!attribute [rw] engine_version
|
@@ -2899,11 +2626,6 @@ module Aws::ElastiCache
|
|
2899
2626
|
# @!attribute [rw] transit_encryption_enabled
|
2900
2627
|
# A flag that enables in-transit encryption when set to `true`.
|
2901
2628
|
#
|
2902
|
-
# You cannot modify the value of `TransitEncryptionEnabled` after the
|
2903
|
-
# cluster is created. To enable in-transit encryption on a cluster you
|
2904
|
-
# must set `TransitEncryptionEnabled` to `true` when you create a
|
2905
|
-
# cluster.
|
2906
|
-
#
|
2907
2629
|
# This parameter is valid only if the `Engine` parameter is `redis`,
|
2908
2630
|
# the `EngineVersion` parameter is `3.2.6`, `4.x` or later, and the
|
2909
2631
|
# cluster is being created in an Amazon VPC.
|
@@ -2978,6 +2700,23 @@ module Aws::ElastiCache
|
|
2978
2700
|
# [1]: https://aws.amazon.com/ec2/nitro/
|
2979
2701
|
# @return [String]
|
2980
2702
|
#
|
2703
|
+
# @!attribute [rw] transit_encryption_mode
|
2704
|
+
# A setting that allows you to migrate your clients to use in-transit
|
2705
|
+
# encryption, with no downtime.
|
2706
|
+
#
|
2707
|
+
# When setting `TransitEncryptionEnabled` to `true`, you can set your
|
2708
|
+
# `TransitEncryptionMode` to `preferred` in the same request, to allow
|
2709
|
+
# both encrypted and unencrypted connections at the same time. Once
|
2710
|
+
# you migrate all your Redis clients to use encrypted connections you
|
2711
|
+
# can modify the value to `required` to allow encrypted connections
|
2712
|
+
# only.
|
2713
|
+
#
|
2714
|
+
# Setting `TransitEncryptionMode` to `required` is a two-step process
|
2715
|
+
# that requires you to first set the `TransitEncryptionMode` to
|
2716
|
+
# `preferred` first, after that you can set `TransitEncryptionMode` to
|
2717
|
+
# `required`.
|
2718
|
+
# @return [String]
|
2719
|
+
#
|
2981
2720
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/CreateReplicationGroupMessage AWS API Documentation
|
2982
2721
|
#
|
2983
2722
|
class CreateReplicationGroupMessage < Struct.new(
|
@@ -3016,7 +2755,8 @@ module Aws::ElastiCache
|
|
3016
2755
|
:log_delivery_configurations,
|
3017
2756
|
:data_tiering_enabled,
|
3018
2757
|
:network_type,
|
3019
|
-
:ip_discovery
|
2758
|
+
:ip_discovery,
|
2759
|
+
:transit_encryption_mode)
|
3020
2760
|
SENSITIVE = []
|
3021
2761
|
include Aws::Structure
|
3022
2762
|
end
|
@@ -3036,22 +2776,6 @@ module Aws::ElastiCache
|
|
3036
2776
|
|
3037
2777
|
# Represents the input of a `CreateSnapshot` operation.
|
3038
2778
|
#
|
3039
|
-
# @note When making an API call, you may pass CreateSnapshotMessage
|
3040
|
-
# data as a hash:
|
3041
|
-
#
|
3042
|
-
# {
|
3043
|
-
# replication_group_id: "String",
|
3044
|
-
# cache_cluster_id: "String",
|
3045
|
-
# snapshot_name: "String", # required
|
3046
|
-
# kms_key_id: "String",
|
3047
|
-
# tags: [
|
3048
|
-
# {
|
3049
|
-
# key: "String",
|
3050
|
-
# value: "String",
|
3051
|
-
# },
|
3052
|
-
# ],
|
3053
|
-
# }
|
3054
|
-
#
|
3055
2779
|
# @!attribute [rw] replication_group_id
|
3056
2780
|
# The identifier of an existing replication group. The snapshot is
|
3057
2781
|
# created from this replication group.
|
@@ -3101,21 +2825,6 @@ module Aws::ElastiCache
|
|
3101
2825
|
include Aws::Structure
|
3102
2826
|
end
|
3103
2827
|
|
3104
|
-
# @note When making an API call, you may pass CreateUserGroupMessage
|
3105
|
-
# data as a hash:
|
3106
|
-
#
|
3107
|
-
# {
|
3108
|
-
# user_group_id: "String", # required
|
3109
|
-
# engine: "EngineType", # required
|
3110
|
-
# user_ids: ["UserId"],
|
3111
|
-
# tags: [
|
3112
|
-
# {
|
3113
|
-
# key: "String",
|
3114
|
-
# value: "String",
|
3115
|
-
# },
|
3116
|
-
# ],
|
3117
|
-
# }
|
3118
|
-
#
|
3119
2828
|
# @!attribute [rw] user_group_id
|
3120
2829
|
# The ID of the user group.
|
3121
2830
|
# @return [String]
|
@@ -3145,28 +2854,6 @@ module Aws::ElastiCache
|
|
3145
2854
|
include Aws::Structure
|
3146
2855
|
end
|
3147
2856
|
|
3148
|
-
# @note When making an API call, you may pass CreateUserMessage
|
3149
|
-
# data as a hash:
|
3150
|
-
#
|
3151
|
-
# {
|
3152
|
-
# user_id: "UserId", # required
|
3153
|
-
# user_name: "UserName", # required
|
3154
|
-
# engine: "EngineType", # required
|
3155
|
-
# passwords: ["String"],
|
3156
|
-
# access_string: "AccessString", # required
|
3157
|
-
# no_password_required: false,
|
3158
|
-
# tags: [
|
3159
|
-
# {
|
3160
|
-
# key: "String",
|
3161
|
-
# value: "String",
|
3162
|
-
# },
|
3163
|
-
# ],
|
3164
|
-
# authentication_mode: {
|
3165
|
-
# type: "password", # accepts password, no-password-required, iam
|
3166
|
-
# passwords: ["String"],
|
3167
|
-
# },
|
3168
|
-
# }
|
3169
|
-
#
|
3170
2857
|
# @!attribute [rw] user_id
|
3171
2858
|
# The ID of the user.
|
3172
2859
|
# @return [String]
|
@@ -3219,14 +2906,6 @@ module Aws::ElastiCache
|
|
3219
2906
|
|
3220
2907
|
# The endpoint from which data should be migrated.
|
3221
2908
|
#
|
3222
|
-
# @note When making an API call, you may pass CustomerNodeEndpoint
|
3223
|
-
# data as a hash:
|
3224
|
-
#
|
3225
|
-
# {
|
3226
|
-
# address: "String",
|
3227
|
-
# port: 1,
|
3228
|
-
# }
|
3229
|
-
#
|
3230
2909
|
# @!attribute [rw] address
|
3231
2910
|
# The address of the node endpoint
|
3232
2911
|
# @return [String]
|
@@ -3244,17 +2923,6 @@ module Aws::ElastiCache
|
|
3244
2923
|
include Aws::Structure
|
3245
2924
|
end
|
3246
2925
|
|
3247
|
-
# @note When making an API call, you may pass DecreaseNodeGroupsInGlobalReplicationGroupMessage
|
3248
|
-
# data as a hash:
|
3249
|
-
#
|
3250
|
-
# {
|
3251
|
-
# global_replication_group_id: "String", # required
|
3252
|
-
# node_group_count: 1, # required
|
3253
|
-
# global_node_groups_to_remove: ["String"],
|
3254
|
-
# global_node_groups_to_retain: ["String"],
|
3255
|
-
# apply_immediately: false, # required
|
3256
|
-
# }
|
3257
|
-
#
|
3258
2926
|
# @!attribute [rw] global_replication_group_id
|
3259
2927
|
# The name of the Global datastore
|
3260
2928
|
# @return [String]
|
@@ -3320,24 +2988,6 @@ module Aws::ElastiCache
|
|
3320
2988
|
include Aws::Structure
|
3321
2989
|
end
|
3322
2990
|
|
3323
|
-
# @note When making an API call, you may pass DecreaseReplicaCountMessage
|
3324
|
-
# data as a hash:
|
3325
|
-
#
|
3326
|
-
# {
|
3327
|
-
# replication_group_id: "String", # required
|
3328
|
-
# new_replica_count: 1,
|
3329
|
-
# replica_configuration: [
|
3330
|
-
# {
|
3331
|
-
# node_group_id: "AllowedNodeGroupId", # required
|
3332
|
-
# new_replica_count: 1, # required
|
3333
|
-
# preferred_availability_zones: ["String"],
|
3334
|
-
# preferred_outpost_arns: ["String"],
|
3335
|
-
# },
|
3336
|
-
# ],
|
3337
|
-
# replicas_to_remove: ["String"],
|
3338
|
-
# apply_immediately: false, # required
|
3339
|
-
# }
|
3340
|
-
#
|
3341
2991
|
# @!attribute [rw] replication_group_id
|
3342
2992
|
# The id of the replication group from which you want to remove
|
3343
2993
|
# replica nodes.
|
@@ -3418,14 +3068,6 @@ module Aws::ElastiCache
|
|
3418
3068
|
|
3419
3069
|
# Represents the input of a `DeleteCacheCluster` operation.
|
3420
3070
|
#
|
3421
|
-
# @note When making an API call, you may pass DeleteCacheClusterMessage
|
3422
|
-
# data as a hash:
|
3423
|
-
#
|
3424
|
-
# {
|
3425
|
-
# cache_cluster_id: "String", # required
|
3426
|
-
# final_snapshot_identifier: "String",
|
3427
|
-
# }
|
3428
|
-
#
|
3429
3071
|
# @!attribute [rw] cache_cluster_id
|
3430
3072
|
# The cluster identifier for the cluster to be deleted. This parameter
|
3431
3073
|
# is not case sensitive.
|
@@ -3460,13 +3102,6 @@ module Aws::ElastiCache
|
|
3460
3102
|
|
3461
3103
|
# Represents the input of a `DeleteCacheParameterGroup` operation.
|
3462
3104
|
#
|
3463
|
-
# @note When making an API call, you may pass DeleteCacheParameterGroupMessage
|
3464
|
-
# data as a hash:
|
3465
|
-
#
|
3466
|
-
# {
|
3467
|
-
# cache_parameter_group_name: "String", # required
|
3468
|
-
# }
|
3469
|
-
#
|
3470
3105
|
# @!attribute [rw] cache_parameter_group_name
|
3471
3106
|
# The name of the cache parameter group to delete.
|
3472
3107
|
#
|
@@ -3486,13 +3121,6 @@ module Aws::ElastiCache
|
|
3486
3121
|
|
3487
3122
|
# Represents the input of a `DeleteCacheSecurityGroup` operation.
|
3488
3123
|
#
|
3489
|
-
# @note When making an API call, you may pass DeleteCacheSecurityGroupMessage
|
3490
|
-
# data as a hash:
|
3491
|
-
#
|
3492
|
-
# {
|
3493
|
-
# cache_security_group_name: "String", # required
|
3494
|
-
# }
|
3495
|
-
#
|
3496
3124
|
# @!attribute [rw] cache_security_group_name
|
3497
3125
|
# The name of the cache security group to delete.
|
3498
3126
|
#
|
@@ -3511,13 +3139,6 @@ module Aws::ElastiCache
|
|
3511
3139
|
|
3512
3140
|
# Represents the input of a `DeleteCacheSubnetGroup` operation.
|
3513
3141
|
#
|
3514
|
-
# @note When making an API call, you may pass DeleteCacheSubnetGroupMessage
|
3515
|
-
# data as a hash:
|
3516
|
-
#
|
3517
|
-
# {
|
3518
|
-
# cache_subnet_group_name: "String", # required
|
3519
|
-
# }
|
3520
|
-
#
|
3521
3142
|
# @!attribute [rw] cache_subnet_group_name
|
3522
3143
|
# The name of the cache subnet group to delete.
|
3523
3144
|
#
|
@@ -3533,14 +3154,6 @@ module Aws::ElastiCache
|
|
3533
3154
|
include Aws::Structure
|
3534
3155
|
end
|
3535
3156
|
|
3536
|
-
# @note When making an API call, you may pass DeleteGlobalReplicationGroupMessage
|
3537
|
-
# data as a hash:
|
3538
|
-
#
|
3539
|
-
# {
|
3540
|
-
# global_replication_group_id: "String", # required
|
3541
|
-
# retain_primary_replication_group: false, # required
|
3542
|
-
# }
|
3543
|
-
#
|
3544
3157
|
# @!attribute [rw] global_replication_group_id
|
3545
3158
|
# The name of the Global datastore
|
3546
3159
|
# @return [String]
|
@@ -3582,15 +3195,6 @@ module Aws::ElastiCache
|
|
3582
3195
|
|
3583
3196
|
# Represents the input of a `DeleteReplicationGroup` operation.
|
3584
3197
|
#
|
3585
|
-
# @note When making an API call, you may pass DeleteReplicationGroupMessage
|
3586
|
-
# data as a hash:
|
3587
|
-
#
|
3588
|
-
# {
|
3589
|
-
# replication_group_id: "String", # required
|
3590
|
-
# retain_primary_cluster: false,
|
3591
|
-
# final_snapshot_identifier: "String",
|
3592
|
-
# }
|
3593
|
-
#
|
3594
3198
|
# @!attribute [rw] replication_group_id
|
3595
3199
|
# The identifier for the cluster to be deleted. This parameter is not
|
3596
3200
|
# case sensitive.
|
@@ -3634,13 +3238,6 @@ module Aws::ElastiCache
|
|
3634
3238
|
|
3635
3239
|
# Represents the input of a `DeleteSnapshot` operation.
|
3636
3240
|
#
|
3637
|
-
# @note When making an API call, you may pass DeleteSnapshotMessage
|
3638
|
-
# data as a hash:
|
3639
|
-
#
|
3640
|
-
# {
|
3641
|
-
# snapshot_name: "String", # required
|
3642
|
-
# }
|
3643
|
-
#
|
3644
3241
|
# @!attribute [rw] snapshot_name
|
3645
3242
|
# The name of the snapshot to be deleted.
|
3646
3243
|
# @return [String]
|
@@ -3666,13 +3263,6 @@ module Aws::ElastiCache
|
|
3666
3263
|
include Aws::Structure
|
3667
3264
|
end
|
3668
3265
|
|
3669
|
-
# @note When making an API call, you may pass DeleteUserGroupMessage
|
3670
|
-
# data as a hash:
|
3671
|
-
#
|
3672
|
-
# {
|
3673
|
-
# user_group_id: "String", # required
|
3674
|
-
# }
|
3675
|
-
#
|
3676
3266
|
# @!attribute [rw] user_group_id
|
3677
3267
|
# The ID of the user group.
|
3678
3268
|
# @return [String]
|
@@ -3685,13 +3275,6 @@ module Aws::ElastiCache
|
|
3685
3275
|
include Aws::Structure
|
3686
3276
|
end
|
3687
3277
|
|
3688
|
-
# @note When making an API call, you may pass DeleteUserMessage
|
3689
|
-
# data as a hash:
|
3690
|
-
#
|
3691
|
-
# {
|
3692
|
-
# user_id: "UserId", # required
|
3693
|
-
# }
|
3694
|
-
#
|
3695
3278
|
# @!attribute [rw] user_id
|
3696
3279
|
# The ID of the user.
|
3697
3280
|
# @return [String]
|
@@ -3706,17 +3289,6 @@ module Aws::ElastiCache
|
|
3706
3289
|
|
3707
3290
|
# Represents the input of a `DescribeCacheClusters` operation.
|
3708
3291
|
#
|
3709
|
-
# @note When making an API call, you may pass DescribeCacheClustersMessage
|
3710
|
-
# data as a hash:
|
3711
|
-
#
|
3712
|
-
# {
|
3713
|
-
# cache_cluster_id: "String",
|
3714
|
-
# max_records: 1,
|
3715
|
-
# marker: "String",
|
3716
|
-
# show_cache_node_info: false,
|
3717
|
-
# show_cache_clusters_not_in_replication_groups: false,
|
3718
|
-
# }
|
3719
|
-
#
|
3720
3292
|
# @!attribute [rw] cache_cluster_id
|
3721
3293
|
# The user-supplied cluster identifier. If this parameter is
|
3722
3294
|
# specified, only information about that specific cluster is returned.
|
@@ -3767,18 +3339,6 @@ module Aws::ElastiCache
|
|
3767
3339
|
|
3768
3340
|
# Represents the input of a `DescribeCacheEngineVersions` operation.
|
3769
3341
|
#
|
3770
|
-
# @note When making an API call, you may pass DescribeCacheEngineVersionsMessage
|
3771
|
-
# data as a hash:
|
3772
|
-
#
|
3773
|
-
# {
|
3774
|
-
# engine: "String",
|
3775
|
-
# engine_version: "String",
|
3776
|
-
# cache_parameter_group_family: "String",
|
3777
|
-
# max_records: 1,
|
3778
|
-
# marker: "String",
|
3779
|
-
# default_only: false,
|
3780
|
-
# }
|
3781
|
-
#
|
3782
3342
|
# @!attribute [rw] engine
|
3783
3343
|
# The cache engine to return. Valid values: `memcached` \| `redis`
|
3784
3344
|
# @return [String]
|
@@ -3795,7 +3355,7 @@ module Aws::ElastiCache
|
|
3795
3355
|
#
|
3796
3356
|
# Valid values are: `memcached1.4` \| `memcached1.5` \| `memcached1.6`
|
3797
3357
|
# \| `redis2.6` \| `redis2.8` \| `redis3.2` \| `redis4.0` \|
|
3798
|
-
# `redis5.0` \| `redis6.x` \| `redis6.2`
|
3358
|
+
# `redis5.0` \| `redis6.x` \| `redis6.2` \| `redis7`
|
3799
3359
|
#
|
3800
3360
|
# Constraints:
|
3801
3361
|
#
|
@@ -3844,15 +3404,6 @@ module Aws::ElastiCache
|
|
3844
3404
|
|
3845
3405
|
# Represents the input of a `DescribeCacheParameterGroups` operation.
|
3846
3406
|
#
|
3847
|
-
# @note When making an API call, you may pass DescribeCacheParameterGroupsMessage
|
3848
|
-
# data as a hash:
|
3849
|
-
#
|
3850
|
-
# {
|
3851
|
-
# cache_parameter_group_name: "String",
|
3852
|
-
# max_records: 1,
|
3853
|
-
# marker: "String",
|
3854
|
-
# }
|
3855
|
-
#
|
3856
3407
|
# @!attribute [rw] cache_parameter_group_name
|
3857
3408
|
# The name of a specific cache parameter group to return details for.
|
3858
3409
|
# @return [String]
|
@@ -3887,16 +3438,6 @@ module Aws::ElastiCache
|
|
3887
3438
|
|
3888
3439
|
# Represents the input of a `DescribeCacheParameters` operation.
|
3889
3440
|
#
|
3890
|
-
# @note When making an API call, you may pass DescribeCacheParametersMessage
|
3891
|
-
# data as a hash:
|
3892
|
-
#
|
3893
|
-
# {
|
3894
|
-
# cache_parameter_group_name: "String", # required
|
3895
|
-
# source: "String",
|
3896
|
-
# max_records: 1,
|
3897
|
-
# marker: "String",
|
3898
|
-
# }
|
3899
|
-
#
|
3900
3441
|
# @!attribute [rw] cache_parameter_group_name
|
3901
3442
|
# The name of a specific cache parameter group to return details for.
|
3902
3443
|
# @return [String]
|
@@ -3938,15 +3479,6 @@ module Aws::ElastiCache
|
|
3938
3479
|
|
3939
3480
|
# Represents the input of a `DescribeCacheSecurityGroups` operation.
|
3940
3481
|
#
|
3941
|
-
# @note When making an API call, you may pass DescribeCacheSecurityGroupsMessage
|
3942
|
-
# data as a hash:
|
3943
|
-
#
|
3944
|
-
# {
|
3945
|
-
# cache_security_group_name: "String",
|
3946
|
-
# max_records: 1,
|
3947
|
-
# marker: "String",
|
3948
|
-
# }
|
3949
|
-
#
|
3950
3482
|
# @!attribute [rw] cache_security_group_name
|
3951
3483
|
# The name of the cache security group to return details for.
|
3952
3484
|
# @return [String]
|
@@ -3981,15 +3513,6 @@ module Aws::ElastiCache
|
|
3981
3513
|
|
3982
3514
|
# Represents the input of a `DescribeCacheSubnetGroups` operation.
|
3983
3515
|
#
|
3984
|
-
# @note When making an API call, you may pass DescribeCacheSubnetGroupsMessage
|
3985
|
-
# data as a hash:
|
3986
|
-
#
|
3987
|
-
# {
|
3988
|
-
# cache_subnet_group_name: "String",
|
3989
|
-
# max_records: 1,
|
3990
|
-
# marker: "String",
|
3991
|
-
# }
|
3992
|
-
#
|
3993
3516
|
# @!attribute [rw] cache_subnet_group_name
|
3994
3517
|
# The name of the cache subnet group to return details for.
|
3995
3518
|
# @return [String]
|
@@ -4024,21 +3547,12 @@ module Aws::ElastiCache
|
|
4024
3547
|
|
4025
3548
|
# Represents the input of a `DescribeEngineDefaultParameters` operation.
|
4026
3549
|
#
|
4027
|
-
# @note When making an API call, you may pass DescribeEngineDefaultParametersMessage
|
4028
|
-
# data as a hash:
|
4029
|
-
#
|
4030
|
-
# {
|
4031
|
-
# cache_parameter_group_family: "String", # required
|
4032
|
-
# max_records: 1,
|
4033
|
-
# marker: "String",
|
4034
|
-
# }
|
4035
|
-
#
|
4036
3550
|
# @!attribute [rw] cache_parameter_group_family
|
4037
3551
|
# The name of the cache parameter group family.
|
4038
3552
|
#
|
4039
3553
|
# Valid values are: `memcached1.4` \| `memcached1.5` \| `memcached1.6`
|
4040
3554
|
# \| `redis2.6` \| `redis2.8` \| `redis3.2` \| `redis4.0` \|
|
4041
|
-
# `redis5.0` \| `redis6.x` \| `redis6.2`
|
3555
|
+
# `redis5.0` \| `redis6.x` \| `redis6.2` \| `redis7`
|
4042
3556
|
# @return [String]
|
4043
3557
|
#
|
4044
3558
|
# @!attribute [rw] max_records
|
@@ -4084,19 +3598,6 @@ module Aws::ElastiCache
|
|
4084
3598
|
|
4085
3599
|
# Represents the input of a `DescribeEvents` operation.
|
4086
3600
|
#
|
4087
|
-
# @note When making an API call, you may pass DescribeEventsMessage
|
4088
|
-
# data as a hash:
|
4089
|
-
#
|
4090
|
-
# {
|
4091
|
-
# source_identifier: "String",
|
4092
|
-
# source_type: "cache-cluster", # accepts cache-cluster, cache-parameter-group, cache-security-group, cache-subnet-group, replication-group, user, user-group
|
4093
|
-
# start_time: Time.now,
|
4094
|
-
# end_time: Time.now,
|
4095
|
-
# duration: 1,
|
4096
|
-
# max_records: 1,
|
4097
|
-
# marker: "String",
|
4098
|
-
# }
|
4099
|
-
#
|
4100
3601
|
# @!attribute [rw] source_identifier
|
4101
3602
|
# The identifier of the event source for which events are returned. If
|
4102
3603
|
# not specified, all sources are included in the response.
|
@@ -4157,16 +3658,6 @@ module Aws::ElastiCache
|
|
4157
3658
|
include Aws::Structure
|
4158
3659
|
end
|
4159
3660
|
|
4160
|
-
# @note When making an API call, you may pass DescribeGlobalReplicationGroupsMessage
|
4161
|
-
# data as a hash:
|
4162
|
-
#
|
4163
|
-
# {
|
4164
|
-
# global_replication_group_id: "String",
|
4165
|
-
# max_records: 1,
|
4166
|
-
# marker: "String",
|
4167
|
-
# show_member_info: false,
|
4168
|
-
# }
|
4169
|
-
#
|
4170
3661
|
# @!attribute [rw] global_replication_group_id
|
4171
3662
|
# The name of the Global datastore
|
4172
3663
|
# @return [String]
|
@@ -4223,15 +3714,6 @@ module Aws::ElastiCache
|
|
4223
3714
|
|
4224
3715
|
# Represents the input of a `DescribeReplicationGroups` operation.
|
4225
3716
|
#
|
4226
|
-
# @note When making an API call, you may pass DescribeReplicationGroupsMessage
|
4227
|
-
# data as a hash:
|
4228
|
-
#
|
4229
|
-
# {
|
4230
|
-
# replication_group_id: "String",
|
4231
|
-
# max_records: 1,
|
4232
|
-
# marker: "String",
|
4233
|
-
# }
|
4234
|
-
#
|
4235
3717
|
# @!attribute [rw] replication_group_id
|
4236
3718
|
# The identifier for the replication group to be described. This
|
4237
3719
|
# parameter is not case sensitive.
|
@@ -4270,20 +3752,6 @@ module Aws::ElastiCache
|
|
4270
3752
|
|
4271
3753
|
# Represents the input of a `DescribeReservedCacheNodes` operation.
|
4272
3754
|
#
|
4273
|
-
# @note When making an API call, you may pass DescribeReservedCacheNodesMessage
|
4274
|
-
# data as a hash:
|
4275
|
-
#
|
4276
|
-
# {
|
4277
|
-
# reserved_cache_node_id: "String",
|
4278
|
-
# reserved_cache_nodes_offering_id: "String",
|
4279
|
-
# cache_node_type: "String",
|
4280
|
-
# duration: "String",
|
4281
|
-
# product_description: "String",
|
4282
|
-
# offering_type: "String",
|
4283
|
-
# max_records: 1,
|
4284
|
-
# marker: "String",
|
4285
|
-
# }
|
4286
|
-
#
|
4287
3755
|
# @!attribute [rw] reserved_cache_node_id
|
4288
3756
|
# The reserved cache node identifier filter value. Use this parameter
|
4289
3757
|
# to show only the reservation that matches the specified reservation
|
@@ -4464,19 +3932,6 @@ module Aws::ElastiCache
|
|
4464
3932
|
# Represents the input of a `DescribeReservedCacheNodesOfferings`
|
4465
3933
|
# operation.
|
4466
3934
|
#
|
4467
|
-
# @note When making an API call, you may pass DescribeReservedCacheNodesOfferingsMessage
|
4468
|
-
# data as a hash:
|
4469
|
-
#
|
4470
|
-
# {
|
4471
|
-
# reserved_cache_nodes_offering_id: "String",
|
4472
|
-
# cache_node_type: "String",
|
4473
|
-
# duration: "String",
|
4474
|
-
# product_description: "String",
|
4475
|
-
# offering_type: "String",
|
4476
|
-
# max_records: 1,
|
4477
|
-
# marker: "String",
|
4478
|
-
# }
|
4479
|
-
#
|
4480
3935
|
# @!attribute [rw] reserved_cache_nodes_offering_id
|
4481
3936
|
# The offering identifier filter value. Use this parameter to show
|
4482
3937
|
# only the available offering that matches the specified reservation
|
@@ -4650,16 +4105,6 @@ module Aws::ElastiCache
|
|
4650
4105
|
include Aws::Structure
|
4651
4106
|
end
|
4652
4107
|
|
4653
|
-
# @note When making an API call, you may pass DescribeServiceUpdatesMessage
|
4654
|
-
# data as a hash:
|
4655
|
-
#
|
4656
|
-
# {
|
4657
|
-
# service_update_name: "String",
|
4658
|
-
# service_update_status: ["available"], # accepts available, cancelled, expired
|
4659
|
-
# max_records: 1,
|
4660
|
-
# marker: "String",
|
4661
|
-
# }
|
4662
|
-
#
|
4663
4108
|
# @!attribute [rw] service_update_name
|
4664
4109
|
# The unique ID of the service update
|
4665
4110
|
# @return [String]
|
@@ -4715,19 +4160,6 @@ module Aws::ElastiCache
|
|
4715
4160
|
|
4716
4161
|
# Represents the input of a `DescribeSnapshotsMessage` operation.
|
4717
4162
|
#
|
4718
|
-
# @note When making an API call, you may pass DescribeSnapshotsMessage
|
4719
|
-
# data as a hash:
|
4720
|
-
#
|
4721
|
-
# {
|
4722
|
-
# replication_group_id: "String",
|
4723
|
-
# cache_cluster_id: "String",
|
4724
|
-
# snapshot_name: "String",
|
4725
|
-
# snapshot_source: "String",
|
4726
|
-
# marker: "String",
|
4727
|
-
# max_records: 1,
|
4728
|
-
# show_node_group_config: false,
|
4729
|
-
# }
|
4730
|
-
#
|
4731
4163
|
# @!attribute [rw] replication_group_id
|
4732
4164
|
# A user-supplied replication group identifier. If this parameter is
|
4733
4165
|
# specified, only snapshots associated with that specific replication
|
@@ -4788,25 +4220,6 @@ module Aws::ElastiCache
|
|
4788
4220
|
include Aws::Structure
|
4789
4221
|
end
|
4790
4222
|
|
4791
|
-
# @note When making an API call, you may pass DescribeUpdateActionsMessage
|
4792
|
-
# data as a hash:
|
4793
|
-
#
|
4794
|
-
# {
|
4795
|
-
# service_update_name: "String",
|
4796
|
-
# replication_group_ids: ["String"],
|
4797
|
-
# cache_cluster_ids: ["String"],
|
4798
|
-
# engine: "String",
|
4799
|
-
# service_update_status: ["available"], # accepts available, cancelled, expired
|
4800
|
-
# service_update_time_range: {
|
4801
|
-
# start_time: Time.now,
|
4802
|
-
# end_time: Time.now,
|
4803
|
-
# },
|
4804
|
-
# update_action_status: ["not-applied"], # accepts not-applied, waiting-to-start, in-progress, stopping, stopped, complete, scheduling, scheduled, not-applicable
|
4805
|
-
# show_node_level_update_status: false,
|
4806
|
-
# max_records: 1,
|
4807
|
-
# marker: "String",
|
4808
|
-
# }
|
4809
|
-
#
|
4810
4223
|
# @!attribute [rw] service_update_name
|
4811
4224
|
# The unique ID of the service update
|
4812
4225
|
# @return [String]
|
@@ -4869,15 +4282,6 @@ module Aws::ElastiCache
|
|
4869
4282
|
include Aws::Structure
|
4870
4283
|
end
|
4871
4284
|
|
4872
|
-
# @note When making an API call, you may pass DescribeUserGroupsMessage
|
4873
|
-
# data as a hash:
|
4874
|
-
#
|
4875
|
-
# {
|
4876
|
-
# user_group_id: "String",
|
4877
|
-
# max_records: 1,
|
4878
|
-
# marker: "String",
|
4879
|
-
# }
|
4880
|
-
#
|
4881
4285
|
# @!attribute [rw] user_group_id
|
4882
4286
|
# The ID of the user group.
|
4883
4287
|
# @return [String]
|
@@ -4926,22 +4330,6 @@ module Aws::ElastiCache
|
|
4926
4330
|
include Aws::Structure
|
4927
4331
|
end
|
4928
4332
|
|
4929
|
-
# @note When making an API call, you may pass DescribeUsersMessage
|
4930
|
-
# data as a hash:
|
4931
|
-
#
|
4932
|
-
# {
|
4933
|
-
# engine: "EngineType",
|
4934
|
-
# user_id: "UserId",
|
4935
|
-
# filters: [
|
4936
|
-
# {
|
4937
|
-
# name: "FilterName", # required
|
4938
|
-
# values: ["FilterValue"], # required
|
4939
|
-
# },
|
4940
|
-
# ],
|
4941
|
-
# max_records: 1,
|
4942
|
-
# marker: "String",
|
4943
|
-
# }
|
4944
|
-
#
|
4945
4333
|
# @!attribute [rw] engine
|
4946
4334
|
# The Redis engine.
|
4947
4335
|
# @return [String]
|
@@ -5003,18 +4391,6 @@ module Aws::ElastiCache
|
|
5003
4391
|
# Configuration details of either a CloudWatch Logs destination or
|
5004
4392
|
# Kinesis Data Firehose destination.
|
5005
4393
|
#
|
5006
|
-
# @note When making an API call, you may pass DestinationDetails
|
5007
|
-
# data as a hash:
|
5008
|
-
#
|
5009
|
-
# {
|
5010
|
-
# cloud_watch_logs_details: {
|
5011
|
-
# log_group: "String",
|
5012
|
-
# },
|
5013
|
-
# kinesis_firehose_details: {
|
5014
|
-
# delivery_stream: "String",
|
5015
|
-
# },
|
5016
|
-
# }
|
5017
|
-
#
|
5018
4394
|
# @!attribute [rw] cloud_watch_logs_details
|
5019
4395
|
# The configuration details of the CloudWatch Logs destination.
|
5020
4396
|
# @return [Types::CloudWatchLogsDestinationDetails]
|
@@ -5032,15 +4408,6 @@ module Aws::ElastiCache
|
|
5032
4408
|
include Aws::Structure
|
5033
4409
|
end
|
5034
4410
|
|
5035
|
-
# @note When making an API call, you may pass DisassociateGlobalReplicationGroupMessage
|
5036
|
-
# data as a hash:
|
5037
|
-
#
|
5038
|
-
# {
|
5039
|
-
# global_replication_group_id: "String", # required
|
5040
|
-
# replication_group_id: "String", # required
|
5041
|
-
# replication_group_region: "String", # required
|
5042
|
-
# }
|
5043
|
-
#
|
5044
4411
|
# @!attribute [rw] global_replication_group_id
|
5045
4412
|
# The name of the Global datastore
|
5046
4413
|
# @return [String]
|
@@ -5228,15 +4595,6 @@ module Aws::ElastiCache
|
|
5228
4595
|
include Aws::Structure
|
5229
4596
|
end
|
5230
4597
|
|
5231
|
-
# @note When making an API call, you may pass FailoverGlobalReplicationGroupMessage
|
5232
|
-
# data as a hash:
|
5233
|
-
#
|
5234
|
-
# {
|
5235
|
-
# global_replication_group_id: "String", # required
|
5236
|
-
# primary_region: "String", # required
|
5237
|
-
# primary_replication_group_id: "String", # required
|
5238
|
-
# }
|
5239
|
-
#
|
5240
4598
|
# @!attribute [rw] global_replication_group_id
|
5241
4599
|
# The name of the Global datastore
|
5242
4600
|
# @return [String]
|
@@ -5283,14 +4641,6 @@ module Aws::ElastiCache
|
|
5283
4641
|
# Used to streamline results of a search based on the property being
|
5284
4642
|
# filtered.
|
5285
4643
|
#
|
5286
|
-
# @note When making an API call, you may pass Filter
|
5287
|
-
# data as a hash:
|
5288
|
-
#
|
5289
|
-
# {
|
5290
|
-
# name: "FilterName", # required
|
5291
|
-
# values: ["FilterValue"], # required
|
5292
|
-
# }
|
5293
|
-
#
|
5294
4644
|
# @!attribute [rw] name
|
5295
4645
|
# The property being filtered. For example, UserId.
|
5296
4646
|
# @return [String]
|
@@ -5385,11 +4735,7 @@ module Aws::ElastiCache
|
|
5385
4735
|
# @return [Boolean]
|
5386
4736
|
#
|
5387
4737
|
# @!attribute [rw] transit_encryption_enabled
|
5388
|
-
# A flag that enables in-transit encryption when set to true.
|
5389
|
-
# cannot modify the value of `TransitEncryptionEnabled` after the
|
5390
|
-
# cluster is created. To enable in-transit encryption on a cluster you
|
5391
|
-
# must set `TransitEncryptionEnabled` to true when you create a
|
5392
|
-
# cluster.
|
4738
|
+
# A flag that enables in-transit encryption when set to true.
|
5393
4739
|
#
|
5394
4740
|
# **Required:** Only available when creating a replication group in an
|
5395
4741
|
# Amazon VPC using redis version `3.2.6`, `4.x` or later.
|
@@ -5500,27 +4846,6 @@ module Aws::ElastiCache
|
|
5500
4846
|
#
|
5501
4847
|
class GlobalReplicationGroupNotFoundFault < Aws::EmptyStructure; end
|
5502
4848
|
|
5503
|
-
# @note When making an API call, you may pass IncreaseNodeGroupsInGlobalReplicationGroupMessage
|
5504
|
-
# data as a hash:
|
5505
|
-
#
|
5506
|
-
# {
|
5507
|
-
# global_replication_group_id: "String", # required
|
5508
|
-
# node_group_count: 1, # required
|
5509
|
-
# regional_configurations: [
|
5510
|
-
# {
|
5511
|
-
# replication_group_id: "String", # required
|
5512
|
-
# replication_group_region: "String", # required
|
5513
|
-
# resharding_configuration: [ # required
|
5514
|
-
# {
|
5515
|
-
# node_group_id: "AllowedNodeGroupId",
|
5516
|
-
# preferred_availability_zones: ["String"],
|
5517
|
-
# },
|
5518
|
-
# ],
|
5519
|
-
# },
|
5520
|
-
# ],
|
5521
|
-
# apply_immediately: false, # required
|
5522
|
-
# }
|
5523
|
-
#
|
5524
4849
|
# @!attribute [rw] global_replication_group_id
|
5525
4850
|
# The name of the Global datastore
|
5526
4851
|
# @return [String]
|
@@ -5572,23 +4897,6 @@ module Aws::ElastiCache
|
|
5572
4897
|
include Aws::Structure
|
5573
4898
|
end
|
5574
4899
|
|
5575
|
-
# @note When making an API call, you may pass IncreaseReplicaCountMessage
|
5576
|
-
# data as a hash:
|
5577
|
-
#
|
5578
|
-
# {
|
5579
|
-
# replication_group_id: "String", # required
|
5580
|
-
# new_replica_count: 1,
|
5581
|
-
# replica_configuration: [
|
5582
|
-
# {
|
5583
|
-
# node_group_id: "AllowedNodeGroupId", # required
|
5584
|
-
# new_replica_count: 1, # required
|
5585
|
-
# preferred_availability_zones: ["String"],
|
5586
|
-
# preferred_outpost_arns: ["String"],
|
5587
|
-
# },
|
5588
|
-
# ],
|
5589
|
-
# apply_immediately: false, # required
|
5590
|
-
# }
|
5591
|
-
#
|
5592
4900
|
# @!attribute [rw] replication_group_id
|
5593
4901
|
# The id of the replication group to which you want to add replica
|
5594
4902
|
# nodes.
|
@@ -5756,13 +5064,6 @@ module Aws::ElastiCache
|
|
5756
5064
|
|
5757
5065
|
# The configuration details of the Kinesis Data Firehose destination.
|
5758
5066
|
#
|
5759
|
-
# @note When making an API call, you may pass KinesisFirehoseDestinationDetails
|
5760
|
-
# data as a hash:
|
5761
|
-
#
|
5762
|
-
# {
|
5763
|
-
# delivery_stream: "String",
|
5764
|
-
# }
|
5765
|
-
#
|
5766
5067
|
# @!attribute [rw] delivery_stream
|
5767
5068
|
# The name of the Kinesis Data Firehose delivery stream.
|
5768
5069
|
# @return [String]
|
@@ -5778,14 +5079,6 @@ module Aws::ElastiCache
|
|
5778
5079
|
# The input parameters for the `ListAllowedNodeTypeModifications`
|
5779
5080
|
# operation.
|
5780
5081
|
#
|
5781
|
-
# @note When making an API call, you may pass ListAllowedNodeTypeModificationsMessage
|
5782
|
-
# data as a hash:
|
5783
|
-
#
|
5784
|
-
# {
|
5785
|
-
# cache_cluster_id: "String",
|
5786
|
-
# replication_group_id: "String",
|
5787
|
-
# }
|
5788
|
-
#
|
5789
5082
|
# @!attribute [rw] cache_cluster_id
|
5790
5083
|
# The name of the cluster you want to scale up to a larger node
|
5791
5084
|
# instanced type. ElastiCache uses the cluster id to identify the
|
@@ -5817,13 +5110,6 @@ module Aws::ElastiCache
|
|
5817
5110
|
|
5818
5111
|
# The input parameters for the `ListTagsForResource` operation.
|
5819
5112
|
#
|
5820
|
-
# @note When making an API call, you may pass ListTagsForResourceMessage
|
5821
|
-
# data as a hash:
|
5822
|
-
#
|
5823
|
-
# {
|
5824
|
-
# resource_name: "String", # required
|
5825
|
-
# }
|
5826
|
-
#
|
5827
5113
|
# @!attribute [rw] resource_name
|
5828
5114
|
# The Amazon Resource Name (ARN) of the resource for which you want
|
5829
5115
|
# the list of tags, for example
|
@@ -5894,24 +5180,6 @@ module Aws::ElastiCache
|
|
5894
5180
|
|
5895
5181
|
# Specifies the destination, format and type of the logs.
|
5896
5182
|
#
|
5897
|
-
# @note When making an API call, you may pass LogDeliveryConfigurationRequest
|
5898
|
-
# data as a hash:
|
5899
|
-
#
|
5900
|
-
# {
|
5901
|
-
# log_type: "slow-log", # accepts slow-log, engine-log
|
5902
|
-
# destination_type: "cloudwatch-logs", # accepts cloudwatch-logs, kinesis-firehose
|
5903
|
-
# destination_details: {
|
5904
|
-
# cloud_watch_logs_details: {
|
5905
|
-
# log_group: "String",
|
5906
|
-
# },
|
5907
|
-
# kinesis_firehose_details: {
|
5908
|
-
# delivery_stream: "String",
|
5909
|
-
# },
|
5910
|
-
# },
|
5911
|
-
# log_format: "text", # accepts text, json
|
5912
|
-
# enabled: false,
|
5913
|
-
# }
|
5914
|
-
#
|
5915
5183
|
# @!attribute [rw] log_type
|
5916
5184
|
# Refers to [slow-log][1] or engine-log..
|
5917
5185
|
#
|
@@ -5952,48 +5220,6 @@ module Aws::ElastiCache
|
|
5952
5220
|
|
5953
5221
|
# Represents the input of a `ModifyCacheCluster` operation.
|
5954
5222
|
#
|
5955
|
-
# @note When making an API call, you may pass ModifyCacheClusterMessage
|
5956
|
-
# data as a hash:
|
5957
|
-
#
|
5958
|
-
# {
|
5959
|
-
# cache_cluster_id: "String", # required
|
5960
|
-
# num_cache_nodes: 1,
|
5961
|
-
# cache_node_ids_to_remove: ["String"],
|
5962
|
-
# az_mode: "single-az", # accepts single-az, cross-az
|
5963
|
-
# new_availability_zones: ["String"],
|
5964
|
-
# cache_security_group_names: ["String"],
|
5965
|
-
# security_group_ids: ["String"],
|
5966
|
-
# preferred_maintenance_window: "String",
|
5967
|
-
# notification_topic_arn: "String",
|
5968
|
-
# cache_parameter_group_name: "String",
|
5969
|
-
# notification_topic_status: "String",
|
5970
|
-
# apply_immediately: false,
|
5971
|
-
# engine_version: "String",
|
5972
|
-
# auto_minor_version_upgrade: false,
|
5973
|
-
# snapshot_retention_limit: 1,
|
5974
|
-
# snapshot_window: "String",
|
5975
|
-
# cache_node_type: "String",
|
5976
|
-
# auth_token: "String",
|
5977
|
-
# auth_token_update_strategy: "SET", # accepts SET, ROTATE, DELETE
|
5978
|
-
# log_delivery_configurations: [
|
5979
|
-
# {
|
5980
|
-
# log_type: "slow-log", # accepts slow-log, engine-log
|
5981
|
-
# destination_type: "cloudwatch-logs", # accepts cloudwatch-logs, kinesis-firehose
|
5982
|
-
# destination_details: {
|
5983
|
-
# cloud_watch_logs_details: {
|
5984
|
-
# log_group: "String",
|
5985
|
-
# },
|
5986
|
-
# kinesis_firehose_details: {
|
5987
|
-
# delivery_stream: "String",
|
5988
|
-
# },
|
5989
|
-
# },
|
5990
|
-
# log_format: "text", # accepts text, json
|
5991
|
-
# enabled: false,
|
5992
|
-
# },
|
5993
|
-
# ],
|
5994
|
-
# ip_discovery: "ipv4", # accepts ipv4, ipv6
|
5995
|
-
# }
|
5996
|
-
#
|
5997
5223
|
# @!attribute [rw] cache_cluster_id
|
5998
5224
|
# The cluster identifier. This value is stored as a lowercase string.
|
5999
5225
|
# @return [String]
|
@@ -6380,19 +5606,6 @@ module Aws::ElastiCache
|
|
6380
5606
|
|
6381
5607
|
# Represents the input of a `ModifyCacheParameterGroup` operation.
|
6382
5608
|
#
|
6383
|
-
# @note When making an API call, you may pass ModifyCacheParameterGroupMessage
|
6384
|
-
# data as a hash:
|
6385
|
-
#
|
6386
|
-
# {
|
6387
|
-
# cache_parameter_group_name: "String", # required
|
6388
|
-
# parameter_name_values: [ # required
|
6389
|
-
# {
|
6390
|
-
# parameter_name: "String",
|
6391
|
-
# parameter_value: "String",
|
6392
|
-
# },
|
6393
|
-
# ],
|
6394
|
-
# }
|
6395
|
-
#
|
6396
5609
|
# @!attribute [rw] cache_parameter_group_name
|
6397
5610
|
# The name of the cache parameter group to modify.
|
6398
5611
|
# @return [String]
|
@@ -6415,15 +5628,6 @@ module Aws::ElastiCache
|
|
6415
5628
|
|
6416
5629
|
# Represents the input of a `ModifyCacheSubnetGroup` operation.
|
6417
5630
|
#
|
6418
|
-
# @note When making an API call, you may pass ModifyCacheSubnetGroupMessage
|
6419
|
-
# data as a hash:
|
6420
|
-
#
|
6421
|
-
# {
|
6422
|
-
# cache_subnet_group_name: "String", # required
|
6423
|
-
# cache_subnet_group_description: "String",
|
6424
|
-
# subnet_ids: ["String"],
|
6425
|
-
# }
|
6426
|
-
#
|
6427
5631
|
# @!attribute [rw] cache_subnet_group_name
|
6428
5632
|
# The name for the cache subnet group. This value is stored as a
|
6429
5633
|
# lowercase string.
|
@@ -6468,19 +5672,6 @@ module Aws::ElastiCache
|
|
6468
5672
|
include Aws::Structure
|
6469
5673
|
end
|
6470
5674
|
|
6471
|
-
# @note When making an API call, you may pass ModifyGlobalReplicationGroupMessage
|
6472
|
-
# data as a hash:
|
6473
|
-
#
|
6474
|
-
# {
|
6475
|
-
# global_replication_group_id: "String", # required
|
6476
|
-
# apply_immediately: false, # required
|
6477
|
-
# cache_node_type: "String",
|
6478
|
-
# engine_version: "String",
|
6479
|
-
# cache_parameter_group_name: "String",
|
6480
|
-
# global_replication_group_description: "String",
|
6481
|
-
# automatic_failover_enabled: false,
|
6482
|
-
# }
|
6483
|
-
#
|
6484
5675
|
# @!attribute [rw] global_replication_group_id
|
6485
5676
|
# The name of the Global datastore
|
6486
5677
|
# @return [String]
|
@@ -6554,53 +5745,6 @@ module Aws::ElastiCache
|
|
6554
5745
|
|
6555
5746
|
# Represents the input of a `ModifyReplicationGroups` operation.
|
6556
5747
|
#
|
6557
|
-
# @note When making an API call, you may pass ModifyReplicationGroupMessage
|
6558
|
-
# data as a hash:
|
6559
|
-
#
|
6560
|
-
# {
|
6561
|
-
# replication_group_id: "String", # required
|
6562
|
-
# replication_group_description: "String",
|
6563
|
-
# primary_cluster_id: "String",
|
6564
|
-
# snapshotting_cluster_id: "String",
|
6565
|
-
# automatic_failover_enabled: false,
|
6566
|
-
# multi_az_enabled: false,
|
6567
|
-
# node_group_id: "String",
|
6568
|
-
# cache_security_group_names: ["String"],
|
6569
|
-
# security_group_ids: ["String"],
|
6570
|
-
# preferred_maintenance_window: "String",
|
6571
|
-
# notification_topic_arn: "String",
|
6572
|
-
# cache_parameter_group_name: "String",
|
6573
|
-
# notification_topic_status: "String",
|
6574
|
-
# apply_immediately: false,
|
6575
|
-
# engine_version: "String",
|
6576
|
-
# auto_minor_version_upgrade: false,
|
6577
|
-
# snapshot_retention_limit: 1,
|
6578
|
-
# snapshot_window: "String",
|
6579
|
-
# cache_node_type: "String",
|
6580
|
-
# auth_token: "String",
|
6581
|
-
# auth_token_update_strategy: "SET", # accepts SET, ROTATE, DELETE
|
6582
|
-
# user_group_ids_to_add: ["UserGroupId"],
|
6583
|
-
# user_group_ids_to_remove: ["UserGroupId"],
|
6584
|
-
# remove_user_groups: false,
|
6585
|
-
# log_delivery_configurations: [
|
6586
|
-
# {
|
6587
|
-
# log_type: "slow-log", # accepts slow-log, engine-log
|
6588
|
-
# destination_type: "cloudwatch-logs", # accepts cloudwatch-logs, kinesis-firehose
|
6589
|
-
# destination_details: {
|
6590
|
-
# cloud_watch_logs_details: {
|
6591
|
-
# log_group: "String",
|
6592
|
-
# },
|
6593
|
-
# kinesis_firehose_details: {
|
6594
|
-
# delivery_stream: "String",
|
6595
|
-
# },
|
6596
|
-
# },
|
6597
|
-
# log_format: "text", # accepts text, json
|
6598
|
-
# enabled: false,
|
6599
|
-
# },
|
6600
|
-
# ],
|
6601
|
-
# ip_discovery: "ipv4", # accepts ipv4, ipv6
|
6602
|
-
# }
|
6603
|
-
#
|
6604
5748
|
# @!attribute [rw] replication_group_id
|
6605
5749
|
# The identifier of the replication group to modify.
|
6606
5750
|
# @return [String]
|
@@ -6838,6 +5982,29 @@ module Aws::ElastiCache
|
|
6838
5982
|
# [1]: https://aws.amazon.com/ec2/nitro/
|
6839
5983
|
# @return [String]
|
6840
5984
|
#
|
5985
|
+
# @!attribute [rw] transit_encryption_enabled
|
5986
|
+
# A flag that enables in-transit encryption when set to true. If you
|
5987
|
+
# are enabling in-transit encryption for an existing cluster, you must
|
5988
|
+
# also set `TransitEncryptionMode` to `preferred`.
|
5989
|
+
# @return [Boolean]
|
5990
|
+
#
|
5991
|
+
# @!attribute [rw] transit_encryption_mode
|
5992
|
+
# A setting that allows you to migrate your clients to use in-transit
|
5993
|
+
# encryption, with no downtime.
|
5994
|
+
#
|
5995
|
+
# You must set `TransitEncryptionEnabled` to `true`, for your existing
|
5996
|
+
# cluster, and set `TransitEncryptionMode` to `preferred` in the same
|
5997
|
+
# request to allow both encrypted and unencrypted connections at the
|
5998
|
+
# same time. Once you migrate all your Redis clients to use encrypted
|
5999
|
+
# connections you can set the value to `required` to allow encrypted
|
6000
|
+
# connections only.
|
6001
|
+
#
|
6002
|
+
# Setting `TransitEncryptionMode` to `required` is a two-step process
|
6003
|
+
# that requires you to first set the `TransitEncryptionMode` to
|
6004
|
+
# `preferred` first, after that you can set `TransitEncryptionMode` to
|
6005
|
+
# `required`.
|
6006
|
+
# @return [String]
|
6007
|
+
#
|
6841
6008
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/ModifyReplicationGroupMessage AWS API Documentation
|
6842
6009
|
#
|
6843
6010
|
class ModifyReplicationGroupMessage < Struct.new(
|
@@ -6866,7 +6033,9 @@ module Aws::ElastiCache
|
|
6866
6033
|
:user_group_ids_to_remove,
|
6867
6034
|
:remove_user_groups,
|
6868
6035
|
:log_delivery_configurations,
|
6869
|
-
:ip_discovery
|
6036
|
+
:ip_discovery,
|
6037
|
+
:transit_encryption_enabled,
|
6038
|
+
:transit_encryption_mode)
|
6870
6039
|
SENSITIVE = []
|
6871
6040
|
include Aws::Structure
|
6872
6041
|
end
|
@@ -6887,23 +6056,6 @@ module Aws::ElastiCache
|
|
6887
6056
|
# Represents the input for a `ModifyReplicationGroupShardConfiguration`
|
6888
6057
|
# operation.
|
6889
6058
|
#
|
6890
|
-
# @note When making an API call, you may pass ModifyReplicationGroupShardConfigurationMessage
|
6891
|
-
# data as a hash:
|
6892
|
-
#
|
6893
|
-
# {
|
6894
|
-
# replication_group_id: "String", # required
|
6895
|
-
# node_group_count: 1, # required
|
6896
|
-
# apply_immediately: false, # required
|
6897
|
-
# resharding_configuration: [
|
6898
|
-
# {
|
6899
|
-
# node_group_id: "AllowedNodeGroupId",
|
6900
|
-
# preferred_availability_zones: ["String"],
|
6901
|
-
# },
|
6902
|
-
# ],
|
6903
|
-
# node_groups_to_remove: ["AllowedNodeGroupId"],
|
6904
|
-
# node_groups_to_retain: ["AllowedNodeGroupId"],
|
6905
|
-
# }
|
6906
|
-
#
|
6907
6059
|
# @!attribute [rw] replication_group_id
|
6908
6060
|
# The name of the Redis (cluster mode enabled) cluster (replication
|
6909
6061
|
# group) on which the shards are to be configured.
|
@@ -6979,15 +6131,6 @@ module Aws::ElastiCache
|
|
6979
6131
|
include Aws::Structure
|
6980
6132
|
end
|
6981
6133
|
|
6982
|
-
# @note When making an API call, you may pass ModifyUserGroupMessage
|
6983
|
-
# data as a hash:
|
6984
|
-
#
|
6985
|
-
# {
|
6986
|
-
# user_group_id: "String", # required
|
6987
|
-
# user_ids_to_add: ["UserId"],
|
6988
|
-
# user_ids_to_remove: ["UserId"],
|
6989
|
-
# }
|
6990
|
-
#
|
6991
6134
|
# @!attribute [rw] user_group_id
|
6992
6135
|
# The ID of the user group.
|
6993
6136
|
# @return [String]
|
@@ -7010,21 +6153,6 @@ module Aws::ElastiCache
|
|
7010
6153
|
include Aws::Structure
|
7011
6154
|
end
|
7012
6155
|
|
7013
|
-
# @note When making an API call, you may pass ModifyUserMessage
|
7014
|
-
# data as a hash:
|
7015
|
-
#
|
7016
|
-
# {
|
7017
|
-
# user_id: "UserId", # required
|
7018
|
-
# access_string: "AccessString",
|
7019
|
-
# append_access_string: "AccessString",
|
7020
|
-
# passwords: ["String"],
|
7021
|
-
# no_password_required: false,
|
7022
|
-
# authentication_mode: {
|
7023
|
-
# type: "password", # accepts password, no-password-required, iam
|
7024
|
-
# passwords: ["String"],
|
7025
|
-
# },
|
7026
|
-
# }
|
7027
|
-
#
|
7028
6156
|
# @!attribute [rw] user_id
|
7029
6157
|
# The ID of the user.
|
7030
6158
|
# @return [String]
|
@@ -7119,19 +6247,6 @@ module Aws::ElastiCache
|
|
7119
6247
|
# configuration has the following: `Slots`, `PrimaryAvailabilityZone`,
|
7120
6248
|
# `ReplicaAvailabilityZones`, `ReplicaCount`.
|
7121
6249
|
#
|
7122
|
-
# @note When making an API call, you may pass NodeGroupConfiguration
|
7123
|
-
# data as a hash:
|
7124
|
-
#
|
7125
|
-
# {
|
7126
|
-
# node_group_id: "AllowedNodeGroupId",
|
7127
|
-
# slots: "String",
|
7128
|
-
# replica_count: 1,
|
7129
|
-
# primary_availability_zone: "String",
|
7130
|
-
# replica_availability_zones: ["String"],
|
7131
|
-
# primary_outpost_arn: "String",
|
7132
|
-
# replica_outpost_arns: ["String"],
|
7133
|
-
# }
|
7134
|
-
#
|
7135
6250
|
# @!attribute [rw] node_group_id
|
7136
6251
|
# Either the ElastiCache for Redis supplied 4-digit id or a user
|
7137
6252
|
# supplied id for the node group these configuration values apply to.
|
@@ -7464,14 +6579,6 @@ module Aws::ElastiCache
|
|
7464
6579
|
# Describes a name-value pair that is used to update the value of a
|
7465
6580
|
# parameter.
|
7466
6581
|
#
|
7467
|
-
# @note When making an API call, you may pass ParameterNameValue
|
7468
|
-
# data as a hash:
|
7469
|
-
#
|
7470
|
-
# {
|
7471
|
-
# parameter_name: "String",
|
7472
|
-
# parameter_value: "String",
|
7473
|
-
# }
|
7474
|
-
#
|
7475
6582
|
# @!attribute [rw] parameter_name
|
7476
6583
|
# The name of the parameter.
|
7477
6584
|
# @return [String]
|
@@ -7557,6 +6664,15 @@ module Aws::ElastiCache
|
|
7557
6664
|
# The log delivery configurations being modified
|
7558
6665
|
# @return [Array<Types::PendingLogDeliveryConfiguration>]
|
7559
6666
|
#
|
6667
|
+
# @!attribute [rw] transit_encryption_enabled
|
6668
|
+
# A flag that enables in-transit encryption when set to true.
|
6669
|
+
# @return [Boolean]
|
6670
|
+
#
|
6671
|
+
# @!attribute [rw] transit_encryption_mode
|
6672
|
+
# A setting that allows you to migrate your clients to use in-transit
|
6673
|
+
# encryption, with no downtime.
|
6674
|
+
# @return [String]
|
6675
|
+
#
|
7560
6676
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/PendingModifiedValues AWS API Documentation
|
7561
6677
|
#
|
7562
6678
|
class PendingModifiedValues < Struct.new(
|
@@ -7565,7 +6681,9 @@ module Aws::ElastiCache
|
|
7565
6681
|
:engine_version,
|
7566
6682
|
:cache_node_type,
|
7567
6683
|
:auth_token_status,
|
7568
|
-
:log_delivery_configurations
|
6684
|
+
:log_delivery_configurations,
|
6685
|
+
:transit_encryption_enabled,
|
6686
|
+
:transit_encryption_mode)
|
7569
6687
|
SENSITIVE = []
|
7570
6688
|
include Aws::Structure
|
7571
6689
|
end
|
@@ -7603,21 +6721,6 @@ module Aws::ElastiCache
|
|
7603
6721
|
# Represents the input of a `PurchaseReservedCacheNodesOffering`
|
7604
6722
|
# operation.
|
7605
6723
|
#
|
7606
|
-
# @note When making an API call, you may pass PurchaseReservedCacheNodesOfferingMessage
|
7607
|
-
# data as a hash:
|
7608
|
-
#
|
7609
|
-
# {
|
7610
|
-
# reserved_cache_nodes_offering_id: "String", # required
|
7611
|
-
# reserved_cache_node_id: "String",
|
7612
|
-
# cache_node_count: 1,
|
7613
|
-
# tags: [
|
7614
|
-
# {
|
7615
|
-
# key: "String",
|
7616
|
-
# value: "String",
|
7617
|
-
# },
|
7618
|
-
# ],
|
7619
|
-
# }
|
7620
|
-
#
|
7621
6724
|
# @!attribute [rw] reserved_cache_nodes_offering_id
|
7622
6725
|
# The ID of the reserved cache node offering to purchase.
|
7623
6726
|
#
|
@@ -7673,14 +6776,6 @@ module Aws::ElastiCache
|
|
7673
6776
|
include Aws::Structure
|
7674
6777
|
end
|
7675
6778
|
|
7676
|
-
# @note When making an API call, you may pass RebalanceSlotsInGlobalReplicationGroupMessage
|
7677
|
-
# data as a hash:
|
7678
|
-
#
|
7679
|
-
# {
|
7680
|
-
# global_replication_group_id: "String", # required
|
7681
|
-
# apply_immediately: false, # required
|
7682
|
-
# }
|
7683
|
-
#
|
7684
6779
|
# @!attribute [rw] global_replication_group_id
|
7685
6780
|
# The name of the Global datastore
|
7686
6781
|
# @return [String]
|
@@ -7721,14 +6816,6 @@ module Aws::ElastiCache
|
|
7721
6816
|
|
7722
6817
|
# Represents the input of a `RebootCacheCluster` operation.
|
7723
6818
|
#
|
7724
|
-
# @note When making an API call, you may pass RebootCacheClusterMessage
|
7725
|
-
# data as a hash:
|
7726
|
-
#
|
7727
|
-
# {
|
7728
|
-
# cache_cluster_id: "String", # required
|
7729
|
-
# cache_node_ids_to_reboot: ["String"], # required
|
7730
|
-
# }
|
7731
|
-
#
|
7732
6819
|
# @!attribute [rw] cache_cluster_id
|
7733
6820
|
# The cluster identifier. This parameter is stored as a lowercase
|
7734
6821
|
# string.
|
@@ -7783,20 +6870,6 @@ module Aws::ElastiCache
|
|
7783
6870
|
|
7784
6871
|
# A list of the replication groups
|
7785
6872
|
#
|
7786
|
-
# @note When making an API call, you may pass RegionalConfiguration
|
7787
|
-
# data as a hash:
|
7788
|
-
#
|
7789
|
-
# {
|
7790
|
-
# replication_group_id: "String", # required
|
7791
|
-
# replication_group_region: "String", # required
|
7792
|
-
# resharding_configuration: [ # required
|
7793
|
-
# {
|
7794
|
-
# node_group_id: "AllowedNodeGroupId",
|
7795
|
-
# preferred_availability_zones: ["String"],
|
7796
|
-
# },
|
7797
|
-
# ],
|
7798
|
-
# }
|
7799
|
-
#
|
7800
6873
|
# @!attribute [rw] replication_group_id
|
7801
6874
|
# The name of the secondary cluster
|
7802
6875
|
# @return [String]
|
@@ -7822,14 +6895,6 @@ module Aws::ElastiCache
|
|
7822
6895
|
|
7823
6896
|
# Represents the input of a `RemoveTagsFromResource` operation.
|
7824
6897
|
#
|
7825
|
-
# @note When making an API call, you may pass RemoveTagsFromResourceMessage
|
7826
|
-
# data as a hash:
|
7827
|
-
#
|
7828
|
-
# {
|
7829
|
-
# resource_name: "String", # required
|
7830
|
-
# tag_keys: ["String"], # required
|
7831
|
-
# }
|
7832
|
-
#
|
7833
6898
|
# @!attribute [rw] resource_name
|
7834
6899
|
# The Amazon Resource Name (ARN) of the resource from which you want
|
7835
6900
|
# the tags removed, for example
|
@@ -7972,11 +7037,6 @@ module Aws::ElastiCache
|
|
7972
7037
|
# @!attribute [rw] transit_encryption_enabled
|
7973
7038
|
# A flag that enables in-transit encryption when set to `true`.
|
7974
7039
|
#
|
7975
|
-
# You cannot modify the value of `TransitEncryptionEnabled` after the
|
7976
|
-
# cluster is created. To enable in-transit encryption on a cluster you
|
7977
|
-
# must set `TransitEncryptionEnabled` to `true` when you create a
|
7978
|
-
# cluster.
|
7979
|
-
#
|
7980
7040
|
# **Required:** Only available when creating a replication group in an
|
7981
7041
|
# Amazon VPC using redis version `3.2.6`, `4.x` or later.
|
7982
7042
|
#
|
@@ -8032,10 +7092,10 @@ module Aws::ElastiCache
|
|
8032
7092
|
# @return [String]
|
8033
7093
|
#
|
8034
7094
|
# @!attribute [rw] auto_minor_version_upgrade
|
8035
|
-
#
|
7095
|
+
# If you are running Redis engine version 6.0 or later, set this
|
8036
7096
|
# parameter to yes if you want to opt-in to the next auto minor
|
8037
7097
|
# version upgrade campaign. This parameter is disabled for previous
|
8038
|
-
# versions.
|
7098
|
+
# versions.
|
8039
7099
|
# @return [Boolean]
|
8040
7100
|
#
|
8041
7101
|
# @!attribute [rw] network_type
|
@@ -8060,6 +7120,11 @@ module Aws::ElastiCache
|
|
8060
7120
|
# [1]: https://aws.amazon.com/ec2/nitro/
|
8061
7121
|
# @return [String]
|
8062
7122
|
#
|
7123
|
+
# @!attribute [rw] transit_encryption_mode
|
7124
|
+
# A setting that allows you to migrate your clients to use in-transit
|
7125
|
+
# encryption, with no downtime.
|
7126
|
+
# @return [String]
|
7127
|
+
#
|
8063
7128
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/ReplicationGroup AWS API Documentation
|
8064
7129
|
#
|
8065
7130
|
class ReplicationGroup < Struct.new(
|
@@ -8091,7 +7156,8 @@ module Aws::ElastiCache
|
|
8091
7156
|
:data_tiering,
|
8092
7157
|
:auto_minor_version_upgrade,
|
8093
7158
|
:network_type,
|
8094
|
-
:ip_discovery
|
7159
|
+
:ip_discovery,
|
7160
|
+
:transit_encryption_mode)
|
8095
7161
|
SENSITIVE = []
|
8096
7162
|
include Aws::Structure
|
8097
7163
|
end
|
@@ -8170,6 +7236,15 @@ module Aws::ElastiCache
|
|
8170
7236
|
# The log delivery configurations being modified
|
8171
7237
|
# @return [Array<Types::PendingLogDeliveryConfiguration>]
|
8172
7238
|
#
|
7239
|
+
# @!attribute [rw] transit_encryption_enabled
|
7240
|
+
# A flag that enables in-transit encryption when set to true.
|
7241
|
+
# @return [Boolean]
|
7242
|
+
#
|
7243
|
+
# @!attribute [rw] transit_encryption_mode
|
7244
|
+
# A setting that allows you to migrate your clients to use in-transit
|
7245
|
+
# encryption, with no downtime.
|
7246
|
+
# @return [String]
|
7247
|
+
#
|
8173
7248
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/ReplicationGroupPendingModifiedValues AWS API Documentation
|
8174
7249
|
#
|
8175
7250
|
class ReplicationGroupPendingModifiedValues < Struct.new(
|
@@ -8178,7 +7253,9 @@ module Aws::ElastiCache
|
|
8178
7253
|
:resharding,
|
8179
7254
|
:auth_token_status,
|
8180
7255
|
:user_groups,
|
8181
|
-
:log_delivery_configurations
|
7256
|
+
:log_delivery_configurations,
|
7257
|
+
:transit_encryption_enabled,
|
7258
|
+
:transit_encryption_mode)
|
8182
7259
|
SENSITIVE = []
|
8183
7260
|
include Aws::Structure
|
8184
7261
|
end
|
@@ -8592,20 +7669,6 @@ module Aws::ElastiCache
|
|
8592
7669
|
|
8593
7670
|
# Represents the input of a `ResetCacheParameterGroup` operation.
|
8594
7671
|
#
|
8595
|
-
# @note When making an API call, you may pass ResetCacheParameterGroupMessage
|
8596
|
-
# data as a hash:
|
8597
|
-
#
|
8598
|
-
# {
|
8599
|
-
# cache_parameter_group_name: "String", # required
|
8600
|
-
# reset_all_parameters: false,
|
8601
|
-
# parameter_name_values: [
|
8602
|
-
# {
|
8603
|
-
# parameter_name: "String",
|
8604
|
-
# parameter_value: "String",
|
8605
|
-
# },
|
8606
|
-
# ],
|
8607
|
-
# }
|
8608
|
-
#
|
8609
7672
|
# @!attribute [rw] cache_parameter_group_name
|
8610
7673
|
# The name of the cache parameter group to reset.
|
8611
7674
|
# @return [String]
|
@@ -8638,14 +7701,6 @@ module Aws::ElastiCache
|
|
8638
7701
|
# A list of `PreferredAvailabilityZones` objects that specifies the
|
8639
7702
|
# configuration of a node group in the resharded cluster.
|
8640
7703
|
#
|
8641
|
-
# @note When making an API call, you may pass ReshardingConfiguration
|
8642
|
-
# data as a hash:
|
8643
|
-
#
|
8644
|
-
# {
|
8645
|
-
# node_group_id: "AllowedNodeGroupId",
|
8646
|
-
# preferred_availability_zones: ["String"],
|
8647
|
-
# }
|
8648
|
-
#
|
8649
7704
|
# @!attribute [rw] node_group_id
|
8650
7705
|
# Either the ElastiCache for Redis supplied 4-digit id or a user
|
8651
7706
|
# supplied id for the node group these configuration values apply to.
|
@@ -8681,15 +7736,6 @@ module Aws::ElastiCache
|
|
8681
7736
|
|
8682
7737
|
# Represents the input of a `RevokeCacheSecurityGroupIngress` operation.
|
8683
7738
|
#
|
8684
|
-
# @note When making an API call, you may pass RevokeCacheSecurityGroupIngressMessage
|
8685
|
-
# data as a hash:
|
8686
|
-
#
|
8687
|
-
# {
|
8688
|
-
# cache_security_group_name: "String", # required
|
8689
|
-
# ec2_security_group_name: "String", # required
|
8690
|
-
# ec2_security_group_owner_id: "String", # required
|
8691
|
-
# }
|
8692
|
-
#
|
8693
7739
|
# @!attribute [rw] cache_security_group_name
|
8694
7740
|
# The name of the cache security group to revoke ingress from.
|
8695
7741
|
# @return [String]
|
@@ -9226,19 +8272,6 @@ module Aws::ElastiCache
|
|
9226
8272
|
#
|
9227
8273
|
class SnapshotQuotaExceededFault < Aws::EmptyStructure; end
|
9228
8274
|
|
9229
|
-
# @note When making an API call, you may pass StartMigrationMessage
|
9230
|
-
# data as a hash:
|
9231
|
-
#
|
9232
|
-
# {
|
9233
|
-
# replication_group_id: "String", # required
|
9234
|
-
# customer_node_endpoint_list: [ # required
|
9235
|
-
# {
|
9236
|
-
# address: "String",
|
9237
|
-
# port: 1,
|
9238
|
-
# },
|
9239
|
-
# ],
|
9240
|
-
# }
|
9241
|
-
#
|
9242
8275
|
# @!attribute [rw] replication_group_id
|
9243
8276
|
# The ID of the replication group to which data should be migrated.
|
9244
8277
|
# @return [String]
|
@@ -9343,14 +8376,6 @@ module Aws::ElastiCache
|
|
9343
8376
|
# replication groups, those actions will be replicated to all nodes in
|
9344
8377
|
# the replication group. A tag with a null Value is permitted.
|
9345
8378
|
#
|
9346
|
-
# @note When making an API call, you may pass Tag
|
9347
|
-
# data as a hash:
|
9348
|
-
#
|
9349
|
-
# {
|
9350
|
-
# key: "String",
|
9351
|
-
# value: "String",
|
9352
|
-
# }
|
9353
|
-
#
|
9354
8379
|
# @!attribute [rw] key
|
9355
8380
|
# The key for the tag. May not be null.
|
9356
8381
|
# @return [String]
|
@@ -9397,14 +8422,6 @@ module Aws::ElastiCache
|
|
9397
8422
|
#
|
9398
8423
|
class TagQuotaPerResourceExceeded < Aws::EmptyStructure; end
|
9399
8424
|
|
9400
|
-
# @note When making an API call, you may pass TestFailoverMessage
|
9401
|
-
# data as a hash:
|
9402
|
-
#
|
9403
|
-
# {
|
9404
|
-
# replication_group_id: "String", # required
|
9405
|
-
# node_group_id: "AllowedNodeGroupId", # required
|
9406
|
-
# }
|
9407
|
-
#
|
9408
8425
|
# @!attribute [rw] replication_group_id
|
9409
8426
|
# The name of the replication group (console: cluster) whose automatic
|
9410
8427
|
# failover is being tested by this operation.
|
@@ -9448,14 +8465,6 @@ module Aws::ElastiCache
|
|
9448
8465
|
# Filters update actions from the service updates that are in available
|
9449
8466
|
# status during the time range.
|
9450
8467
|
#
|
9451
|
-
# @note When making an API call, you may pass TimeRangeFilter
|
9452
|
-
# data as a hash:
|
9453
|
-
#
|
9454
|
-
# {
|
9455
|
-
# start_time: Time.now,
|
9456
|
-
# end_time: Time.now,
|
9457
|
-
# }
|
9458
|
-
#
|
9459
8468
|
# @!attribute [rw] start_time
|
9460
8469
|
# The start time of the time range filter
|
9461
8470
|
# @return [Time]
|