aws-sdk-elasticache 1.43.0 → 1.44.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 +644 -7
- data/lib/aws-sdk-elasticache/client_api.rb +323 -0
- data/lib/aws-sdk-elasticache/errors.rb +132 -0
- data/lib/aws-sdk-elasticache/types.rb +722 -15
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 541bd1cd3afa08a0c58b083183d00a462043a8672fecfe584ad235d606564be3
|
4
|
+
data.tar.gz: 8eddd7f9704008ad68dd34359dd658a08e3461a31627beb099074c56367f7d1b
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 8d963a8f9333af7ee93e719831db912407ea49cabcdb620d0a4dd70392084f5cf301dc9d7dc7c9f7989c03399cebab14dc4eba75f137bd3cfecfe53642147e9f
|
7
|
+
data.tar.gz: 39f85a305e2610fd5d08f4db7977a558aea238576346c5b8dda923c82862850ec7f70ffdc02406134ceecbaed61d85005211206242b668a2fd1f870ca7104e38
|
data/lib/aws-sdk-elasticache.rb
CHANGED
@@ -628,6 +628,10 @@ module Aws::ElastiCache
|
|
628
628
|
# resp.replication_group.pending_modified_values.automatic_failover_status #=> String, one of "enabled", "disabled"
|
629
629
|
# resp.replication_group.pending_modified_values.resharding.slot_migration.progress_percentage #=> Float
|
630
630
|
# resp.replication_group.pending_modified_values.auth_token_status #=> String, one of "SETTING", "ROTATING"
|
631
|
+
# resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_add #=> Array
|
632
|
+
# resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_add[0] #=> String
|
633
|
+
# resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_remove #=> Array
|
634
|
+
# resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_remove[0] #=> String
|
631
635
|
# resp.replication_group.member_clusters #=> Array
|
632
636
|
# resp.replication_group.member_clusters[0] #=> String
|
633
637
|
# resp.replication_group.node_groups #=> Array
|
@@ -644,6 +648,7 @@ module Aws::ElastiCache
|
|
644
648
|
# resp.replication_group.node_groups[0].node_group_members[0].read_endpoint.address #=> String
|
645
649
|
# resp.replication_group.node_groups[0].node_group_members[0].read_endpoint.port #=> Integer
|
646
650
|
# resp.replication_group.node_groups[0].node_group_members[0].preferred_availability_zone #=> String
|
651
|
+
# resp.replication_group.node_groups[0].node_group_members[0].preferred_outpost_arn #=> String
|
647
652
|
# resp.replication_group.node_groups[0].node_group_members[0].current_role #=> String
|
648
653
|
# resp.replication_group.snapshotting_cluster_id #=> String
|
649
654
|
# resp.replication_group.automatic_failover #=> String, one of "enabled", "disabled", "enabling", "disabling"
|
@@ -658,8 +663,12 @@ module Aws::ElastiCache
|
|
658
663
|
# resp.replication_group.auth_token_last_modified_date #=> Time
|
659
664
|
# resp.replication_group.transit_encryption_enabled #=> Boolean
|
660
665
|
# resp.replication_group.at_rest_encryption_enabled #=> Boolean
|
666
|
+
# resp.replication_group.member_clusters_outpost_arns #=> Array
|
667
|
+
# resp.replication_group.member_clusters_outpost_arns[0] #=> String
|
661
668
|
# resp.replication_group.kms_key_id #=> String
|
662
669
|
# resp.replication_group.arn #=> String
|
670
|
+
# resp.replication_group.user_group_ids #=> Array
|
671
|
+
# resp.replication_group.user_group_ids[0] #=> String
|
663
672
|
#
|
664
673
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/CompleteMigration AWS API Documentation
|
665
674
|
#
|
@@ -845,6 +854,7 @@ module Aws::ElastiCache
|
|
845
854
|
# resp.snapshot.engine_version #=> String
|
846
855
|
# resp.snapshot.num_cache_nodes #=> Integer
|
847
856
|
# resp.snapshot.preferred_availability_zone #=> String
|
857
|
+
# resp.snapshot.preferred_outpost_arn #=> String
|
848
858
|
# resp.snapshot.cache_cluster_create_time #=> Time
|
849
859
|
# resp.snapshot.preferred_maintenance_window #=> String
|
850
860
|
# resp.snapshot.topic_arn #=> String
|
@@ -867,6 +877,9 @@ module Aws::ElastiCache
|
|
867
877
|
# resp.snapshot.node_snapshots[0].node_group_configuration.primary_availability_zone #=> String
|
868
878
|
# resp.snapshot.node_snapshots[0].node_group_configuration.replica_availability_zones #=> Array
|
869
879
|
# resp.snapshot.node_snapshots[0].node_group_configuration.replica_availability_zones[0] #=> String
|
880
|
+
# resp.snapshot.node_snapshots[0].node_group_configuration.primary_outpost_arn #=> String
|
881
|
+
# resp.snapshot.node_snapshots[0].node_group_configuration.replica_outpost_arns #=> Array
|
882
|
+
# resp.snapshot.node_snapshots[0].node_group_configuration.replica_outpost_arns[0] #=> String
|
870
883
|
# resp.snapshot.node_snapshots[0].cache_size #=> String
|
871
884
|
# resp.snapshot.node_snapshots[0].cache_node_create_time #=> Time
|
872
885
|
# resp.snapshot.node_snapshots[0].snapshot_create_time #=> Time
|
@@ -1212,6 +1225,16 @@ module Aws::ElastiCache
|
|
1212
1225
|
#
|
1213
1226
|
# [1]: http://redis.io/commands/AUTH
|
1214
1227
|
#
|
1228
|
+
# @option params [String] :outpost_mode
|
1229
|
+
# Specifies whether the nodes in the cluster are created in a single
|
1230
|
+
# outpost or across multiple outposts.
|
1231
|
+
#
|
1232
|
+
# @option params [String] :preferred_outpost_arn
|
1233
|
+
# The outpost ARN in which the cache cluster is created.
|
1234
|
+
#
|
1235
|
+
# @option params [Array<String>] :preferred_outpost_arns
|
1236
|
+
# The outpost ARNs in which the cache cluster is created.
|
1237
|
+
#
|
1215
1238
|
# @return [Types::CreateCacheClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1216
1239
|
#
|
1217
1240
|
# * {Types::CreateCacheClusterResult#cache_cluster #cache_cluster} => Types::CacheCluster
|
@@ -1336,6 +1359,9 @@ module Aws::ElastiCache
|
|
1336
1359
|
# snapshot_retention_limit: 1,
|
1337
1360
|
# snapshot_window: "String",
|
1338
1361
|
# auth_token: "String",
|
1362
|
+
# outpost_mode: "single-outpost", # accepts single-outpost, cross-outpost
|
1363
|
+
# preferred_outpost_arn: "String",
|
1364
|
+
# preferred_outpost_arns: ["String"],
|
1339
1365
|
# })
|
1340
1366
|
#
|
1341
1367
|
# @example Response structure
|
@@ -1350,6 +1376,7 @@ module Aws::ElastiCache
|
|
1350
1376
|
# resp.cache_cluster.cache_cluster_status #=> String
|
1351
1377
|
# resp.cache_cluster.num_cache_nodes #=> Integer
|
1352
1378
|
# resp.cache_cluster.preferred_availability_zone #=> String
|
1379
|
+
# resp.cache_cluster.preferred_outpost_arn #=> String
|
1353
1380
|
# resp.cache_cluster.cache_cluster_create_time #=> Time
|
1354
1381
|
# resp.cache_cluster.preferred_maintenance_window #=> String
|
1355
1382
|
# resp.cache_cluster.pending_modified_values.num_cache_nodes #=> Integer
|
@@ -1377,6 +1404,7 @@ module Aws::ElastiCache
|
|
1377
1404
|
# resp.cache_cluster.cache_nodes[0].parameter_group_status #=> String
|
1378
1405
|
# resp.cache_cluster.cache_nodes[0].source_cache_node_id #=> String
|
1379
1406
|
# resp.cache_cluster.cache_nodes[0].customer_availability_zone #=> String
|
1407
|
+
# resp.cache_cluster.cache_nodes[0].customer_outpost_arn #=> String
|
1380
1408
|
# resp.cache_cluster.auto_minor_version_upgrade #=> Boolean
|
1381
1409
|
# resp.cache_cluster.security_groups #=> Array
|
1382
1410
|
# resp.cache_cluster.security_groups[0].security_group_id #=> String
|
@@ -1629,6 +1657,7 @@ module Aws::ElastiCache
|
|
1629
1657
|
# resp.cache_subnet_group.subnets #=> Array
|
1630
1658
|
# resp.cache_subnet_group.subnets[0].subnet_identifier #=> String
|
1631
1659
|
# resp.cache_subnet_group.subnets[0].subnet_availability_zone.name #=> String
|
1660
|
+
# resp.cache_subnet_group.subnets[0].subnet_outpost.subnet_outpost_arn #=> String
|
1632
1661
|
# resp.cache_subnet_group.arn #=> String
|
1633
1662
|
#
|
1634
1663
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/CreateCacheSubnetGroup AWS API Documentation
|
@@ -1656,8 +1685,20 @@ module Aws::ElastiCache
|
|
1656
1685
|
# secondary cluster.
|
1657
1686
|
#
|
1658
1687
|
# @option params [required, String] :global_replication_group_id_suffix
|
1659
|
-
# The suffix name of a Global Datastore.
|
1660
|
-
#
|
1688
|
+
# The suffix name of a Global Datastore. Amazon ElastiCache
|
1689
|
+
# automatically applies a prefix to the Global Datastore ID when it is
|
1690
|
+
# created. Each AWS Region has its own prefix. For instance, a Global
|
1691
|
+
# Datastore ID created in the US-West-1 region will begin with "dsdfu"
|
1692
|
+
# along with the suffix name you provide. The suffix, combined with the
|
1693
|
+
# auto-generated prefix, guarantees uniqueness of the Global Datastore
|
1694
|
+
# name across multiple regions.
|
1695
|
+
#
|
1696
|
+
# For a full list of AWS Regions and their respective Global Datastore
|
1697
|
+
# iD prefixes, see [Using the AWS CLI with Global Datastores ][1].
|
1698
|
+
#
|
1699
|
+
#
|
1700
|
+
#
|
1701
|
+
# [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Redis-Global-Clusters-CLI.html
|
1661
1702
|
#
|
1662
1703
|
# @option params [String] :global_replication_group_description
|
1663
1704
|
# Provides details of the Global Datastore
|
@@ -2138,6 +2179,9 @@ module Aws::ElastiCache
|
|
2138
2179
|
# @option params [String] :kms_key_id
|
2139
2180
|
# The ID of the KMS key used to encrypt the disk in the cluster.
|
2140
2181
|
#
|
2182
|
+
# @option params [Array<String>] :user_group_ids
|
2183
|
+
# The list of user groups to associate with the replication group.
|
2184
|
+
#
|
2141
2185
|
# @return [Types::CreateReplicationGroupResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2142
2186
|
#
|
2143
2187
|
# * {Types::CreateReplicationGroupResult#replication_group #replication_group} => Types::ReplicationGroup
|
@@ -2253,6 +2297,8 @@ module Aws::ElastiCache
|
|
2253
2297
|
# replica_count: 1,
|
2254
2298
|
# primary_availability_zone: "String",
|
2255
2299
|
# replica_availability_zones: ["String"],
|
2300
|
+
# primary_outpost_arn: "String",
|
2301
|
+
# replica_outpost_arns: ["String"],
|
2256
2302
|
# },
|
2257
2303
|
# ],
|
2258
2304
|
# cache_node_type: "String",
|
@@ -2280,6 +2326,7 @@ module Aws::ElastiCache
|
|
2280
2326
|
# transit_encryption_enabled: false,
|
2281
2327
|
# at_rest_encryption_enabled: false,
|
2282
2328
|
# kms_key_id: "String",
|
2329
|
+
# user_group_ids: ["UserGroupId"],
|
2283
2330
|
# })
|
2284
2331
|
#
|
2285
2332
|
# @example Response structure
|
@@ -2293,6 +2340,10 @@ module Aws::ElastiCache
|
|
2293
2340
|
# resp.replication_group.pending_modified_values.automatic_failover_status #=> String, one of "enabled", "disabled"
|
2294
2341
|
# resp.replication_group.pending_modified_values.resharding.slot_migration.progress_percentage #=> Float
|
2295
2342
|
# resp.replication_group.pending_modified_values.auth_token_status #=> String, one of "SETTING", "ROTATING"
|
2343
|
+
# resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_add #=> Array
|
2344
|
+
# resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_add[0] #=> String
|
2345
|
+
# resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_remove #=> Array
|
2346
|
+
# resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_remove[0] #=> String
|
2296
2347
|
# resp.replication_group.member_clusters #=> Array
|
2297
2348
|
# resp.replication_group.member_clusters[0] #=> String
|
2298
2349
|
# resp.replication_group.node_groups #=> Array
|
@@ -2309,6 +2360,7 @@ module Aws::ElastiCache
|
|
2309
2360
|
# resp.replication_group.node_groups[0].node_group_members[0].read_endpoint.address #=> String
|
2310
2361
|
# resp.replication_group.node_groups[0].node_group_members[0].read_endpoint.port #=> Integer
|
2311
2362
|
# resp.replication_group.node_groups[0].node_group_members[0].preferred_availability_zone #=> String
|
2363
|
+
# resp.replication_group.node_groups[0].node_group_members[0].preferred_outpost_arn #=> String
|
2312
2364
|
# resp.replication_group.node_groups[0].node_group_members[0].current_role #=> String
|
2313
2365
|
# resp.replication_group.snapshotting_cluster_id #=> String
|
2314
2366
|
# resp.replication_group.automatic_failover #=> String, one of "enabled", "disabled", "enabling", "disabling"
|
@@ -2323,8 +2375,12 @@ module Aws::ElastiCache
|
|
2323
2375
|
# resp.replication_group.auth_token_last_modified_date #=> Time
|
2324
2376
|
# resp.replication_group.transit_encryption_enabled #=> Boolean
|
2325
2377
|
# resp.replication_group.at_rest_encryption_enabled #=> Boolean
|
2378
|
+
# resp.replication_group.member_clusters_outpost_arns #=> Array
|
2379
|
+
# resp.replication_group.member_clusters_outpost_arns[0] #=> String
|
2326
2380
|
# resp.replication_group.kms_key_id #=> String
|
2327
2381
|
# resp.replication_group.arn #=> String
|
2382
|
+
# resp.replication_group.user_group_ids #=> Array
|
2383
|
+
# resp.replication_group.user_group_ids[0] #=> String
|
2328
2384
|
#
|
2329
2385
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/CreateReplicationGroup AWS API Documentation
|
2330
2386
|
#
|
@@ -2507,6 +2563,7 @@ module Aws::ElastiCache
|
|
2507
2563
|
# resp.snapshot.engine_version #=> String
|
2508
2564
|
# resp.snapshot.num_cache_nodes #=> Integer
|
2509
2565
|
# resp.snapshot.preferred_availability_zone #=> String
|
2566
|
+
# resp.snapshot.preferred_outpost_arn #=> String
|
2510
2567
|
# resp.snapshot.cache_cluster_create_time #=> Time
|
2511
2568
|
# resp.snapshot.preferred_maintenance_window #=> String
|
2512
2569
|
# resp.snapshot.topic_arn #=> String
|
@@ -2529,6 +2586,9 @@ module Aws::ElastiCache
|
|
2529
2586
|
# resp.snapshot.node_snapshots[0].node_group_configuration.primary_availability_zone #=> String
|
2530
2587
|
# resp.snapshot.node_snapshots[0].node_group_configuration.replica_availability_zones #=> Array
|
2531
2588
|
# resp.snapshot.node_snapshots[0].node_group_configuration.replica_availability_zones[0] #=> String
|
2589
|
+
# resp.snapshot.node_snapshots[0].node_group_configuration.primary_outpost_arn #=> String
|
2590
|
+
# resp.snapshot.node_snapshots[0].node_group_configuration.replica_outpost_arns #=> Array
|
2591
|
+
# resp.snapshot.node_snapshots[0].node_group_configuration.replica_outpost_arns[0] #=> String
|
2532
2592
|
# resp.snapshot.node_snapshots[0].cache_size #=> String
|
2533
2593
|
# resp.snapshot.node_snapshots[0].cache_node_create_time #=> Time
|
2534
2594
|
# resp.snapshot.node_snapshots[0].snapshot_create_time #=> Time
|
@@ -2544,6 +2604,134 @@ module Aws::ElastiCache
|
|
2544
2604
|
req.send_request(options)
|
2545
2605
|
end
|
2546
2606
|
|
2607
|
+
# For Redis engine version 6.04 onwards: Creates a Redis user. For more
|
2608
|
+
# information, see [Using Role Based Access Control (RBAC)][1].
|
2609
|
+
#
|
2610
|
+
#
|
2611
|
+
#
|
2612
|
+
# [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html
|
2613
|
+
#
|
2614
|
+
# @option params [required, String] :user_id
|
2615
|
+
# The ID of the user.
|
2616
|
+
#
|
2617
|
+
# @option params [required, String] :user_name
|
2618
|
+
# The username of the user.
|
2619
|
+
#
|
2620
|
+
# @option params [required, String] :engine
|
2621
|
+
# Must be Redis.
|
2622
|
+
#
|
2623
|
+
# @option params [Array<String>] :passwords
|
2624
|
+
# Passwords used for this user account. You can create up to two
|
2625
|
+
# passwords for each user.
|
2626
|
+
#
|
2627
|
+
# @option params [required, String] :access_string
|
2628
|
+
# Access permissions string used for this user account.
|
2629
|
+
#
|
2630
|
+
# @option params [Boolean] :no_password_required
|
2631
|
+
# Indicates a password is not required for this user account.
|
2632
|
+
#
|
2633
|
+
# @return [Types::User] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2634
|
+
#
|
2635
|
+
# * {Types::User#user_id #user_id} => String
|
2636
|
+
# * {Types::User#user_name #user_name} => String
|
2637
|
+
# * {Types::User#status #status} => String
|
2638
|
+
# * {Types::User#engine #engine} => String
|
2639
|
+
# * {Types::User#access_string #access_string} => String
|
2640
|
+
# * {Types::User#user_group_ids #user_group_ids} => Array<String>
|
2641
|
+
# * {Types::User#authentication #authentication} => Types::Authentication
|
2642
|
+
# * {Types::User#arn #arn} => String
|
2643
|
+
#
|
2644
|
+
# @example Request syntax with placeholder values
|
2645
|
+
#
|
2646
|
+
# resp = client.create_user({
|
2647
|
+
# user_id: "UserId", # required
|
2648
|
+
# user_name: "UserName", # required
|
2649
|
+
# engine: "EngineType", # required
|
2650
|
+
# passwords: ["String"],
|
2651
|
+
# access_string: "AccessString", # required
|
2652
|
+
# no_password_required: false,
|
2653
|
+
# })
|
2654
|
+
#
|
2655
|
+
# @example Response structure
|
2656
|
+
#
|
2657
|
+
# resp.user_id #=> String
|
2658
|
+
# resp.user_name #=> String
|
2659
|
+
# resp.status #=> String
|
2660
|
+
# resp.engine #=> String
|
2661
|
+
# resp.access_string #=> String
|
2662
|
+
# resp.user_group_ids #=> Array
|
2663
|
+
# resp.user_group_ids[0] #=> String
|
2664
|
+
# resp.authentication.type #=> String, one of "password", "no-password"
|
2665
|
+
# resp.authentication.password_count #=> Integer
|
2666
|
+
# resp.arn #=> String
|
2667
|
+
#
|
2668
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/CreateUser AWS API Documentation
|
2669
|
+
#
|
2670
|
+
# @overload create_user(params = {})
|
2671
|
+
# @param [Hash] params ({})
|
2672
|
+
def create_user(params = {}, options = {})
|
2673
|
+
req = build_request(:create_user, params)
|
2674
|
+
req.send_request(options)
|
2675
|
+
end
|
2676
|
+
|
2677
|
+
# For Redis engine version 6.04 onwards: Creates a Redis user group. For
|
2678
|
+
# more information, see [Using Role Based Access Control (RBAC)][1]
|
2679
|
+
#
|
2680
|
+
#
|
2681
|
+
#
|
2682
|
+
# [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html
|
2683
|
+
#
|
2684
|
+
# @option params [required, String] :user_group_id
|
2685
|
+
# The ID of the user group.
|
2686
|
+
#
|
2687
|
+
# @option params [required, String] :engine
|
2688
|
+
# Must be Redis.
|
2689
|
+
#
|
2690
|
+
# @option params [Array<String>] :user_ids
|
2691
|
+
# The list of user IDs that belong to the user group.
|
2692
|
+
#
|
2693
|
+
# @return [Types::UserGroup] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2694
|
+
#
|
2695
|
+
# * {Types::UserGroup#user_group_id #user_group_id} => String
|
2696
|
+
# * {Types::UserGroup#status #status} => String
|
2697
|
+
# * {Types::UserGroup#engine #engine} => String
|
2698
|
+
# * {Types::UserGroup#user_ids #user_ids} => Array<String>
|
2699
|
+
# * {Types::UserGroup#pending_changes #pending_changes} => Types::UserGroupPendingChanges
|
2700
|
+
# * {Types::UserGroup#replication_groups #replication_groups} => Array<String>
|
2701
|
+
# * {Types::UserGroup#arn #arn} => String
|
2702
|
+
#
|
2703
|
+
# @example Request syntax with placeholder values
|
2704
|
+
#
|
2705
|
+
# resp = client.create_user_group({
|
2706
|
+
# user_group_id: "String", # required
|
2707
|
+
# engine: "EngineType", # required
|
2708
|
+
# user_ids: ["UserId"],
|
2709
|
+
# })
|
2710
|
+
#
|
2711
|
+
# @example Response structure
|
2712
|
+
#
|
2713
|
+
# resp.user_group_id #=> String
|
2714
|
+
# resp.status #=> String
|
2715
|
+
# resp.engine #=> String
|
2716
|
+
# resp.user_ids #=> Array
|
2717
|
+
# resp.user_ids[0] #=> String
|
2718
|
+
# resp.pending_changes.user_ids_to_remove #=> Array
|
2719
|
+
# resp.pending_changes.user_ids_to_remove[0] #=> String
|
2720
|
+
# resp.pending_changes.user_ids_to_add #=> Array
|
2721
|
+
# resp.pending_changes.user_ids_to_add[0] #=> String
|
2722
|
+
# resp.replication_groups #=> Array
|
2723
|
+
# resp.replication_groups[0] #=> String
|
2724
|
+
# resp.arn #=> String
|
2725
|
+
#
|
2726
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/CreateUserGroup AWS API Documentation
|
2727
|
+
#
|
2728
|
+
# @overload create_user_group(params = {})
|
2729
|
+
# @param [Hash] params ({})
|
2730
|
+
def create_user_group(params = {}, options = {})
|
2731
|
+
req = build_request(:create_user_group, params)
|
2732
|
+
req.send_request(options)
|
2733
|
+
end
|
2734
|
+
|
2547
2735
|
# Decreases the number of node groups in a Global Datastore
|
2548
2736
|
#
|
2549
2737
|
# @option params [required, String] :global_replication_group_id
|
@@ -2673,6 +2861,7 @@ module Aws::ElastiCache
|
|
2673
2861
|
# node_group_id: "AllowedNodeGroupId", # required
|
2674
2862
|
# new_replica_count: 1, # required
|
2675
2863
|
# preferred_availability_zones: ["String"],
|
2864
|
+
# preferred_outpost_arns: ["String"],
|
2676
2865
|
# },
|
2677
2866
|
# ],
|
2678
2867
|
# replicas_to_remove: ["String"],
|
@@ -2690,6 +2879,10 @@ module Aws::ElastiCache
|
|
2690
2879
|
# resp.replication_group.pending_modified_values.automatic_failover_status #=> String, one of "enabled", "disabled"
|
2691
2880
|
# resp.replication_group.pending_modified_values.resharding.slot_migration.progress_percentage #=> Float
|
2692
2881
|
# resp.replication_group.pending_modified_values.auth_token_status #=> String, one of "SETTING", "ROTATING"
|
2882
|
+
# resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_add #=> Array
|
2883
|
+
# resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_add[0] #=> String
|
2884
|
+
# resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_remove #=> Array
|
2885
|
+
# resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_remove[0] #=> String
|
2693
2886
|
# resp.replication_group.member_clusters #=> Array
|
2694
2887
|
# resp.replication_group.member_clusters[0] #=> String
|
2695
2888
|
# resp.replication_group.node_groups #=> Array
|
@@ -2706,6 +2899,7 @@ module Aws::ElastiCache
|
|
2706
2899
|
# resp.replication_group.node_groups[0].node_group_members[0].read_endpoint.address #=> String
|
2707
2900
|
# resp.replication_group.node_groups[0].node_group_members[0].read_endpoint.port #=> Integer
|
2708
2901
|
# resp.replication_group.node_groups[0].node_group_members[0].preferred_availability_zone #=> String
|
2902
|
+
# resp.replication_group.node_groups[0].node_group_members[0].preferred_outpost_arn #=> String
|
2709
2903
|
# resp.replication_group.node_groups[0].node_group_members[0].current_role #=> String
|
2710
2904
|
# resp.replication_group.snapshotting_cluster_id #=> String
|
2711
2905
|
# resp.replication_group.automatic_failover #=> String, one of "enabled", "disabled", "enabling", "disabling"
|
@@ -2720,8 +2914,12 @@ module Aws::ElastiCache
|
|
2720
2914
|
# resp.replication_group.auth_token_last_modified_date #=> Time
|
2721
2915
|
# resp.replication_group.transit_encryption_enabled #=> Boolean
|
2722
2916
|
# resp.replication_group.at_rest_encryption_enabled #=> Boolean
|
2917
|
+
# resp.replication_group.member_clusters_outpost_arns #=> Array
|
2918
|
+
# resp.replication_group.member_clusters_outpost_arns[0] #=> String
|
2723
2919
|
# resp.replication_group.kms_key_id #=> String
|
2724
2920
|
# resp.replication_group.arn #=> String
|
2921
|
+
# resp.replication_group.user_group_ids #=> Array
|
2922
|
+
# resp.replication_group.user_group_ids[0] #=> String
|
2725
2923
|
#
|
2726
2924
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DecreaseReplicaCount AWS API Documentation
|
2727
2925
|
#
|
@@ -2823,6 +3021,7 @@ module Aws::ElastiCache
|
|
2823
3021
|
# resp.cache_cluster.cache_cluster_status #=> String
|
2824
3022
|
# resp.cache_cluster.num_cache_nodes #=> Integer
|
2825
3023
|
# resp.cache_cluster.preferred_availability_zone #=> String
|
3024
|
+
# resp.cache_cluster.preferred_outpost_arn #=> String
|
2826
3025
|
# resp.cache_cluster.cache_cluster_create_time #=> Time
|
2827
3026
|
# resp.cache_cluster.preferred_maintenance_window #=> String
|
2828
3027
|
# resp.cache_cluster.pending_modified_values.num_cache_nodes #=> Integer
|
@@ -2850,6 +3049,7 @@ module Aws::ElastiCache
|
|
2850
3049
|
# resp.cache_cluster.cache_nodes[0].parameter_group_status #=> String
|
2851
3050
|
# resp.cache_cluster.cache_nodes[0].source_cache_node_id #=> String
|
2852
3051
|
# resp.cache_cluster.cache_nodes[0].customer_availability_zone #=> String
|
3052
|
+
# resp.cache_cluster.cache_nodes[0].customer_outpost_arn #=> String
|
2853
3053
|
# resp.cache_cluster.auto_minor_version_upgrade #=> Boolean
|
2854
3054
|
# resp.cache_cluster.security_groups #=> Array
|
2855
3055
|
# resp.cache_cluster.security_groups[0].security_group_id #=> String
|
@@ -3129,6 +3329,10 @@ module Aws::ElastiCache
|
|
3129
3329
|
# resp.replication_group.pending_modified_values.automatic_failover_status #=> String, one of "enabled", "disabled"
|
3130
3330
|
# resp.replication_group.pending_modified_values.resharding.slot_migration.progress_percentage #=> Float
|
3131
3331
|
# resp.replication_group.pending_modified_values.auth_token_status #=> String, one of "SETTING", "ROTATING"
|
3332
|
+
# resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_add #=> Array
|
3333
|
+
# resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_add[0] #=> String
|
3334
|
+
# resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_remove #=> Array
|
3335
|
+
# resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_remove[0] #=> String
|
3132
3336
|
# resp.replication_group.member_clusters #=> Array
|
3133
3337
|
# resp.replication_group.member_clusters[0] #=> String
|
3134
3338
|
# resp.replication_group.node_groups #=> Array
|
@@ -3145,6 +3349,7 @@ module Aws::ElastiCache
|
|
3145
3349
|
# resp.replication_group.node_groups[0].node_group_members[0].read_endpoint.address #=> String
|
3146
3350
|
# resp.replication_group.node_groups[0].node_group_members[0].read_endpoint.port #=> Integer
|
3147
3351
|
# resp.replication_group.node_groups[0].node_group_members[0].preferred_availability_zone #=> String
|
3352
|
+
# resp.replication_group.node_groups[0].node_group_members[0].preferred_outpost_arn #=> String
|
3148
3353
|
# resp.replication_group.node_groups[0].node_group_members[0].current_role #=> String
|
3149
3354
|
# resp.replication_group.snapshotting_cluster_id #=> String
|
3150
3355
|
# resp.replication_group.automatic_failover #=> String, one of "enabled", "disabled", "enabling", "disabling"
|
@@ -3159,8 +3364,12 @@ module Aws::ElastiCache
|
|
3159
3364
|
# resp.replication_group.auth_token_last_modified_date #=> Time
|
3160
3365
|
# resp.replication_group.transit_encryption_enabled #=> Boolean
|
3161
3366
|
# resp.replication_group.at_rest_encryption_enabled #=> Boolean
|
3367
|
+
# resp.replication_group.member_clusters_outpost_arns #=> Array
|
3368
|
+
# resp.replication_group.member_clusters_outpost_arns[0] #=> String
|
3162
3369
|
# resp.replication_group.kms_key_id #=> String
|
3163
3370
|
# resp.replication_group.arn #=> String
|
3371
|
+
# resp.replication_group.user_group_ids #=> Array
|
3372
|
+
# resp.replication_group.user_group_ids[0] #=> String
|
3164
3373
|
#
|
3165
3374
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DeleteReplicationGroup AWS API Documentation
|
3166
3375
|
#
|
@@ -3246,6 +3455,7 @@ module Aws::ElastiCache
|
|
3246
3455
|
# resp.snapshot.engine_version #=> String
|
3247
3456
|
# resp.snapshot.num_cache_nodes #=> Integer
|
3248
3457
|
# resp.snapshot.preferred_availability_zone #=> String
|
3458
|
+
# resp.snapshot.preferred_outpost_arn #=> String
|
3249
3459
|
# resp.snapshot.cache_cluster_create_time #=> Time
|
3250
3460
|
# resp.snapshot.preferred_maintenance_window #=> String
|
3251
3461
|
# resp.snapshot.topic_arn #=> String
|
@@ -3268,6 +3478,9 @@ module Aws::ElastiCache
|
|
3268
3478
|
# resp.snapshot.node_snapshots[0].node_group_configuration.primary_availability_zone #=> String
|
3269
3479
|
# resp.snapshot.node_snapshots[0].node_group_configuration.replica_availability_zones #=> Array
|
3270
3480
|
# resp.snapshot.node_snapshots[0].node_group_configuration.replica_availability_zones[0] #=> String
|
3481
|
+
# resp.snapshot.node_snapshots[0].node_group_configuration.primary_outpost_arn #=> String
|
3482
|
+
# resp.snapshot.node_snapshots[0].node_group_configuration.replica_outpost_arns #=> Array
|
3483
|
+
# resp.snapshot.node_snapshots[0].node_group_configuration.replica_outpost_arns[0] #=> String
|
3271
3484
|
# resp.snapshot.node_snapshots[0].cache_size #=> String
|
3272
3485
|
# resp.snapshot.node_snapshots[0].cache_node_create_time #=> Time
|
3273
3486
|
# resp.snapshot.node_snapshots[0].snapshot_create_time #=> Time
|
@@ -3283,6 +3496,109 @@ module Aws::ElastiCache
|
|
3283
3496
|
req.send_request(options)
|
3284
3497
|
end
|
3285
3498
|
|
3499
|
+
# For Redis engine version 6.04 onwards: Deletes a user. The user will
|
3500
|
+
# be removed from all user groups and in turn removed from all
|
3501
|
+
# replication groups. For more information, see [Using Role Based Access
|
3502
|
+
# Control (RBAC)][1].
|
3503
|
+
#
|
3504
|
+
#
|
3505
|
+
#
|
3506
|
+
# [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html
|
3507
|
+
#
|
3508
|
+
# @option params [required, String] :user_id
|
3509
|
+
# The ID of the user.
|
3510
|
+
#
|
3511
|
+
# @return [Types::User] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3512
|
+
#
|
3513
|
+
# * {Types::User#user_id #user_id} => String
|
3514
|
+
# * {Types::User#user_name #user_name} => String
|
3515
|
+
# * {Types::User#status #status} => String
|
3516
|
+
# * {Types::User#engine #engine} => String
|
3517
|
+
# * {Types::User#access_string #access_string} => String
|
3518
|
+
# * {Types::User#user_group_ids #user_group_ids} => Array<String>
|
3519
|
+
# * {Types::User#authentication #authentication} => Types::Authentication
|
3520
|
+
# * {Types::User#arn #arn} => String
|
3521
|
+
#
|
3522
|
+
# @example Request syntax with placeholder values
|
3523
|
+
#
|
3524
|
+
# resp = client.delete_user({
|
3525
|
+
# user_id: "UserId", # required
|
3526
|
+
# })
|
3527
|
+
#
|
3528
|
+
# @example Response structure
|
3529
|
+
#
|
3530
|
+
# resp.user_id #=> String
|
3531
|
+
# resp.user_name #=> String
|
3532
|
+
# resp.status #=> String
|
3533
|
+
# resp.engine #=> String
|
3534
|
+
# resp.access_string #=> String
|
3535
|
+
# resp.user_group_ids #=> Array
|
3536
|
+
# resp.user_group_ids[0] #=> String
|
3537
|
+
# resp.authentication.type #=> String, one of "password", "no-password"
|
3538
|
+
# resp.authentication.password_count #=> Integer
|
3539
|
+
# resp.arn #=> String
|
3540
|
+
#
|
3541
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DeleteUser AWS API Documentation
|
3542
|
+
#
|
3543
|
+
# @overload delete_user(params = {})
|
3544
|
+
# @param [Hash] params ({})
|
3545
|
+
def delete_user(params = {}, options = {})
|
3546
|
+
req = build_request(:delete_user, params)
|
3547
|
+
req.send_request(options)
|
3548
|
+
end
|
3549
|
+
|
3550
|
+
# For Redis engine version 6.04 onwards: Deletes a ser group. The user
|
3551
|
+
# group must first be disassociated from the replcation group before it
|
3552
|
+
# can be deleted. For more information, see [Using Role Based Access
|
3553
|
+
# Control (RBAC)][1].
|
3554
|
+
#
|
3555
|
+
#
|
3556
|
+
#
|
3557
|
+
# [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html
|
3558
|
+
#
|
3559
|
+
# @option params [required, String] :user_group_id
|
3560
|
+
# The ID of the user group.
|
3561
|
+
#
|
3562
|
+
# @return [Types::UserGroup] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3563
|
+
#
|
3564
|
+
# * {Types::UserGroup#user_group_id #user_group_id} => String
|
3565
|
+
# * {Types::UserGroup#status #status} => String
|
3566
|
+
# * {Types::UserGroup#engine #engine} => String
|
3567
|
+
# * {Types::UserGroup#user_ids #user_ids} => Array<String>
|
3568
|
+
# * {Types::UserGroup#pending_changes #pending_changes} => Types::UserGroupPendingChanges
|
3569
|
+
# * {Types::UserGroup#replication_groups #replication_groups} => Array<String>
|
3570
|
+
# * {Types::UserGroup#arn #arn} => String
|
3571
|
+
#
|
3572
|
+
# @example Request syntax with placeholder values
|
3573
|
+
#
|
3574
|
+
# resp = client.delete_user_group({
|
3575
|
+
# user_group_id: "String", # required
|
3576
|
+
# })
|
3577
|
+
#
|
3578
|
+
# @example Response structure
|
3579
|
+
#
|
3580
|
+
# resp.user_group_id #=> String
|
3581
|
+
# resp.status #=> String
|
3582
|
+
# resp.engine #=> String
|
3583
|
+
# resp.user_ids #=> Array
|
3584
|
+
# resp.user_ids[0] #=> String
|
3585
|
+
# resp.pending_changes.user_ids_to_remove #=> Array
|
3586
|
+
# resp.pending_changes.user_ids_to_remove[0] #=> String
|
3587
|
+
# resp.pending_changes.user_ids_to_add #=> Array
|
3588
|
+
# resp.pending_changes.user_ids_to_add[0] #=> String
|
3589
|
+
# resp.replication_groups #=> Array
|
3590
|
+
# resp.replication_groups[0] #=> String
|
3591
|
+
# resp.arn #=> String
|
3592
|
+
#
|
3593
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DeleteUserGroup AWS API Documentation
|
3594
|
+
#
|
3595
|
+
# @overload delete_user_group(params = {})
|
3596
|
+
# @param [Hash] params ({})
|
3597
|
+
def delete_user_group(params = {}, options = {})
|
3598
|
+
req = build_request(:delete_user_group, params)
|
3599
|
+
req.send_request(options)
|
3600
|
+
end
|
3601
|
+
|
3286
3602
|
# Returns information about all provisioned clusters if no cluster
|
3287
3603
|
# identifier is specified, or about a specific cache cluster if a
|
3288
3604
|
# cluster identifier is supplied.
|
@@ -3479,6 +3795,7 @@ module Aws::ElastiCache
|
|
3479
3795
|
# resp.cache_clusters[0].cache_cluster_status #=> String
|
3480
3796
|
# resp.cache_clusters[0].num_cache_nodes #=> Integer
|
3481
3797
|
# resp.cache_clusters[0].preferred_availability_zone #=> String
|
3798
|
+
# resp.cache_clusters[0].preferred_outpost_arn #=> String
|
3482
3799
|
# resp.cache_clusters[0].cache_cluster_create_time #=> Time
|
3483
3800
|
# resp.cache_clusters[0].preferred_maintenance_window #=> String
|
3484
3801
|
# resp.cache_clusters[0].pending_modified_values.num_cache_nodes #=> Integer
|
@@ -3506,6 +3823,7 @@ module Aws::ElastiCache
|
|
3506
3823
|
# resp.cache_clusters[0].cache_nodes[0].parameter_group_status #=> String
|
3507
3824
|
# resp.cache_clusters[0].cache_nodes[0].source_cache_node_id #=> String
|
3508
3825
|
# resp.cache_clusters[0].cache_nodes[0].customer_availability_zone #=> String
|
3826
|
+
# resp.cache_clusters[0].cache_nodes[0].customer_outpost_arn #=> String
|
3509
3827
|
# resp.cache_clusters[0].auto_minor_version_upgrade #=> Boolean
|
3510
3828
|
# resp.cache_clusters[0].security_groups #=> Array
|
3511
3829
|
# resp.cache_clusters[0].security_groups[0].security_group_id #=> String
|
@@ -4512,6 +4830,7 @@ module Aws::ElastiCache
|
|
4512
4830
|
# resp.cache_subnet_groups[0].subnets #=> Array
|
4513
4831
|
# resp.cache_subnet_groups[0].subnets[0].subnet_identifier #=> String
|
4514
4832
|
# resp.cache_subnet_groups[0].subnets[0].subnet_availability_zone.name #=> String
|
4833
|
+
# resp.cache_subnet_groups[0].subnets[0].subnet_outpost.subnet_outpost_arn #=> String
|
4515
4834
|
# resp.cache_subnet_groups[0].arn #=> String
|
4516
4835
|
#
|
4517
4836
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DescribeCacheSubnetGroups AWS API Documentation
|
@@ -5367,7 +5686,7 @@ module Aws::ElastiCache
|
|
5367
5686
|
#
|
5368
5687
|
# resp = client.describe_events({
|
5369
5688
|
# source_identifier: "String",
|
5370
|
-
# source_type: "cache-cluster", # accepts cache-cluster, cache-parameter-group, cache-security-group, cache-subnet-group, replication-group
|
5689
|
+
# source_type: "cache-cluster", # accepts cache-cluster, cache-parameter-group, cache-security-group, cache-subnet-group, replication-group, user, user-group
|
5371
5690
|
# start_time: Time.now,
|
5372
5691
|
# end_time: Time.now,
|
5373
5692
|
# duration: 1,
|
@@ -5380,7 +5699,7 @@ module Aws::ElastiCache
|
|
5380
5699
|
# resp.marker #=> String
|
5381
5700
|
# resp.events #=> Array
|
5382
5701
|
# resp.events[0].source_identifier #=> String
|
5383
|
-
# resp.events[0].source_type #=> String, one of "cache-cluster", "cache-parameter-group", "cache-security-group", "cache-subnet-group", "replication-group"
|
5702
|
+
# resp.events[0].source_type #=> String, one of "cache-cluster", "cache-parameter-group", "cache-security-group", "cache-subnet-group", "replication-group", "user", "user-group"
|
5384
5703
|
# resp.events[0].message #=> String
|
5385
5704
|
# resp.events[0].date #=> Time
|
5386
5705
|
#
|
@@ -5587,6 +5906,10 @@ module Aws::ElastiCache
|
|
5587
5906
|
# resp.replication_groups[0].pending_modified_values.automatic_failover_status #=> String, one of "enabled", "disabled"
|
5588
5907
|
# resp.replication_groups[0].pending_modified_values.resharding.slot_migration.progress_percentage #=> Float
|
5589
5908
|
# resp.replication_groups[0].pending_modified_values.auth_token_status #=> String, one of "SETTING", "ROTATING"
|
5909
|
+
# resp.replication_groups[0].pending_modified_values.user_groups.user_group_ids_to_add #=> Array
|
5910
|
+
# resp.replication_groups[0].pending_modified_values.user_groups.user_group_ids_to_add[0] #=> String
|
5911
|
+
# resp.replication_groups[0].pending_modified_values.user_groups.user_group_ids_to_remove #=> Array
|
5912
|
+
# resp.replication_groups[0].pending_modified_values.user_groups.user_group_ids_to_remove[0] #=> String
|
5590
5913
|
# resp.replication_groups[0].member_clusters #=> Array
|
5591
5914
|
# resp.replication_groups[0].member_clusters[0] #=> String
|
5592
5915
|
# resp.replication_groups[0].node_groups #=> Array
|
@@ -5603,6 +5926,7 @@ module Aws::ElastiCache
|
|
5603
5926
|
# resp.replication_groups[0].node_groups[0].node_group_members[0].read_endpoint.address #=> String
|
5604
5927
|
# resp.replication_groups[0].node_groups[0].node_group_members[0].read_endpoint.port #=> Integer
|
5605
5928
|
# resp.replication_groups[0].node_groups[0].node_group_members[0].preferred_availability_zone #=> String
|
5929
|
+
# resp.replication_groups[0].node_groups[0].node_group_members[0].preferred_outpost_arn #=> String
|
5606
5930
|
# resp.replication_groups[0].node_groups[0].node_group_members[0].current_role #=> String
|
5607
5931
|
# resp.replication_groups[0].snapshotting_cluster_id #=> String
|
5608
5932
|
# resp.replication_groups[0].automatic_failover #=> String, one of "enabled", "disabled", "enabling", "disabling"
|
@@ -5617,8 +5941,12 @@ module Aws::ElastiCache
|
|
5617
5941
|
# resp.replication_groups[0].auth_token_last_modified_date #=> Time
|
5618
5942
|
# resp.replication_groups[0].transit_encryption_enabled #=> Boolean
|
5619
5943
|
# resp.replication_groups[0].at_rest_encryption_enabled #=> Boolean
|
5944
|
+
# resp.replication_groups[0].member_clusters_outpost_arns #=> Array
|
5945
|
+
# resp.replication_groups[0].member_clusters_outpost_arns[0] #=> String
|
5620
5946
|
# resp.replication_groups[0].kms_key_id #=> String
|
5621
5947
|
# resp.replication_groups[0].arn #=> String
|
5948
|
+
# resp.replication_groups[0].user_group_ids #=> Array
|
5949
|
+
# resp.replication_groups[0].user_group_ids[0] #=> String
|
5622
5950
|
#
|
5623
5951
|
#
|
5624
5952
|
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
@@ -6480,6 +6808,7 @@ module Aws::ElastiCache
|
|
6480
6808
|
# resp.snapshots[0].engine_version #=> String
|
6481
6809
|
# resp.snapshots[0].num_cache_nodes #=> Integer
|
6482
6810
|
# resp.snapshots[0].preferred_availability_zone #=> String
|
6811
|
+
# resp.snapshots[0].preferred_outpost_arn #=> String
|
6483
6812
|
# resp.snapshots[0].cache_cluster_create_time #=> Time
|
6484
6813
|
# resp.snapshots[0].preferred_maintenance_window #=> String
|
6485
6814
|
# resp.snapshots[0].topic_arn #=> String
|
@@ -6502,6 +6831,9 @@ module Aws::ElastiCache
|
|
6502
6831
|
# resp.snapshots[0].node_snapshots[0].node_group_configuration.primary_availability_zone #=> String
|
6503
6832
|
# resp.snapshots[0].node_snapshots[0].node_group_configuration.replica_availability_zones #=> Array
|
6504
6833
|
# resp.snapshots[0].node_snapshots[0].node_group_configuration.replica_availability_zones[0] #=> String
|
6834
|
+
# resp.snapshots[0].node_snapshots[0].node_group_configuration.primary_outpost_arn #=> String
|
6835
|
+
# resp.snapshots[0].node_snapshots[0].node_group_configuration.replica_outpost_arns #=> Array
|
6836
|
+
# resp.snapshots[0].node_snapshots[0].node_group_configuration.replica_outpost_arns[0] #=> String
|
6505
6837
|
# resp.snapshots[0].node_snapshots[0].cache_size #=> String
|
6506
6838
|
# resp.snapshots[0].node_snapshots[0].cache_node_create_time #=> Time
|
6507
6839
|
# resp.snapshots[0].node_snapshots[0].snapshot_create_time #=> Time
|
@@ -6629,6 +6961,133 @@ module Aws::ElastiCache
|
|
6629
6961
|
req.send_request(options)
|
6630
6962
|
end
|
6631
6963
|
|
6964
|
+
# Returns a list of user groups.
|
6965
|
+
#
|
6966
|
+
# @option params [String] :user_group_id
|
6967
|
+
# The ID of the user group.
|
6968
|
+
#
|
6969
|
+
# @option params [Integer] :max_records
|
6970
|
+
# The maximum number of records to include in the response. If more
|
6971
|
+
# records exist than the specified MaxRecords value, a marker is
|
6972
|
+
# included in the response so that the remaining results can be
|
6973
|
+
# retrieved.
|
6974
|
+
#
|
6975
|
+
# @option params [String] :marker
|
6976
|
+
# An optional marker returned from a prior request. Use this marker for
|
6977
|
+
# pagination of results from this operation. If this parameter is
|
6978
|
+
# specified, the response includes only records beyond the marker, up to
|
6979
|
+
# the value specified by MaxRecords. >
|
6980
|
+
#
|
6981
|
+
# @return [Types::DescribeUserGroupsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6982
|
+
#
|
6983
|
+
# * {Types::DescribeUserGroupsResult#user_groups #user_groups} => Array<Types::UserGroup>
|
6984
|
+
# * {Types::DescribeUserGroupsResult#marker #marker} => String
|
6985
|
+
#
|
6986
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
6987
|
+
#
|
6988
|
+
# @example Request syntax with placeholder values
|
6989
|
+
#
|
6990
|
+
# resp = client.describe_user_groups({
|
6991
|
+
# user_group_id: "String",
|
6992
|
+
# max_records: 1,
|
6993
|
+
# marker: "String",
|
6994
|
+
# })
|
6995
|
+
#
|
6996
|
+
# @example Response structure
|
6997
|
+
#
|
6998
|
+
# resp.user_groups #=> Array
|
6999
|
+
# resp.user_groups[0].user_group_id #=> String
|
7000
|
+
# resp.user_groups[0].status #=> String
|
7001
|
+
# resp.user_groups[0].engine #=> String
|
7002
|
+
# resp.user_groups[0].user_ids #=> Array
|
7003
|
+
# resp.user_groups[0].user_ids[0] #=> String
|
7004
|
+
# resp.user_groups[0].pending_changes.user_ids_to_remove #=> Array
|
7005
|
+
# resp.user_groups[0].pending_changes.user_ids_to_remove[0] #=> String
|
7006
|
+
# resp.user_groups[0].pending_changes.user_ids_to_add #=> Array
|
7007
|
+
# resp.user_groups[0].pending_changes.user_ids_to_add[0] #=> String
|
7008
|
+
# resp.user_groups[0].replication_groups #=> Array
|
7009
|
+
# resp.user_groups[0].replication_groups[0] #=> String
|
7010
|
+
# resp.user_groups[0].arn #=> String
|
7011
|
+
# resp.marker #=> String
|
7012
|
+
#
|
7013
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DescribeUserGroups AWS API Documentation
|
7014
|
+
#
|
7015
|
+
# @overload describe_user_groups(params = {})
|
7016
|
+
# @param [Hash] params ({})
|
7017
|
+
def describe_user_groups(params = {}, options = {})
|
7018
|
+
req = build_request(:describe_user_groups, params)
|
7019
|
+
req.send_request(options)
|
7020
|
+
end
|
7021
|
+
|
7022
|
+
# Returns a list of users.
|
7023
|
+
#
|
7024
|
+
# @option params [String] :engine
|
7025
|
+
# The Redis engine.
|
7026
|
+
#
|
7027
|
+
# @option params [String] :user_id
|
7028
|
+
# The ID of the user.
|
7029
|
+
#
|
7030
|
+
# @option params [Array<Types::Filter>] :filters
|
7031
|
+
# Filter to determine the list of User IDs to return.
|
7032
|
+
#
|
7033
|
+
# @option params [Integer] :max_records
|
7034
|
+
# The maximum number of records to include in the response. If more
|
7035
|
+
# records exist than the specified MaxRecords value, a marker is
|
7036
|
+
# included in the response so that the remaining results can be
|
7037
|
+
# retrieved.
|
7038
|
+
#
|
7039
|
+
# @option params [String] :marker
|
7040
|
+
# An optional marker returned from a prior request. Use this marker for
|
7041
|
+
# pagination of results from this operation. If this parameter is
|
7042
|
+
# specified, the response includes only records beyond the marker, up to
|
7043
|
+
# the value specified by MaxRecords. >
|
7044
|
+
#
|
7045
|
+
# @return [Types::DescribeUsersResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7046
|
+
#
|
7047
|
+
# * {Types::DescribeUsersResult#users #users} => Array<Types::User>
|
7048
|
+
# * {Types::DescribeUsersResult#marker #marker} => String
|
7049
|
+
#
|
7050
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
7051
|
+
#
|
7052
|
+
# @example Request syntax with placeholder values
|
7053
|
+
#
|
7054
|
+
# resp = client.describe_users({
|
7055
|
+
# engine: "EngineType",
|
7056
|
+
# user_id: "UserId",
|
7057
|
+
# filters: [
|
7058
|
+
# {
|
7059
|
+
# name: "FilterName", # required
|
7060
|
+
# values: ["FilterValue"], # required
|
7061
|
+
# },
|
7062
|
+
# ],
|
7063
|
+
# max_records: 1,
|
7064
|
+
# marker: "String",
|
7065
|
+
# })
|
7066
|
+
#
|
7067
|
+
# @example Response structure
|
7068
|
+
#
|
7069
|
+
# resp.users #=> Array
|
7070
|
+
# resp.users[0].user_id #=> String
|
7071
|
+
# resp.users[0].user_name #=> String
|
7072
|
+
# resp.users[0].status #=> String
|
7073
|
+
# resp.users[0].engine #=> String
|
7074
|
+
# resp.users[0].access_string #=> String
|
7075
|
+
# resp.users[0].user_group_ids #=> Array
|
7076
|
+
# resp.users[0].user_group_ids[0] #=> String
|
7077
|
+
# resp.users[0].authentication.type #=> String, one of "password", "no-password"
|
7078
|
+
# resp.users[0].authentication.password_count #=> Integer
|
7079
|
+
# resp.users[0].arn #=> String
|
7080
|
+
# resp.marker #=> String
|
7081
|
+
#
|
7082
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DescribeUsers AWS API Documentation
|
7083
|
+
#
|
7084
|
+
# @overload describe_users(params = {})
|
7085
|
+
# @param [Hash] params ({})
|
7086
|
+
def describe_users(params = {}, options = {})
|
7087
|
+
req = build_request(:describe_users, params)
|
7088
|
+
req.send_request(options)
|
7089
|
+
end
|
7090
|
+
|
6632
7091
|
# Remove a secondary cluster from the Global Datastore using the Global
|
6633
7092
|
# Datastore name. The secondary cluster will no longer receive updates
|
6634
7093
|
# from the primary cluster, but will remain as a standalone cluster in
|
@@ -6860,6 +7319,7 @@ module Aws::ElastiCache
|
|
6860
7319
|
# node_group_id: "AllowedNodeGroupId", # required
|
6861
7320
|
# new_replica_count: 1, # required
|
6862
7321
|
# preferred_availability_zones: ["String"],
|
7322
|
+
# preferred_outpost_arns: ["String"],
|
6863
7323
|
# },
|
6864
7324
|
# ],
|
6865
7325
|
# apply_immediately: false, # required
|
@@ -6876,6 +7336,10 @@ module Aws::ElastiCache
|
|
6876
7336
|
# resp.replication_group.pending_modified_values.automatic_failover_status #=> String, one of "enabled", "disabled"
|
6877
7337
|
# resp.replication_group.pending_modified_values.resharding.slot_migration.progress_percentage #=> Float
|
6878
7338
|
# resp.replication_group.pending_modified_values.auth_token_status #=> String, one of "SETTING", "ROTATING"
|
7339
|
+
# resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_add #=> Array
|
7340
|
+
# resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_add[0] #=> String
|
7341
|
+
# resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_remove #=> Array
|
7342
|
+
# resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_remove[0] #=> String
|
6879
7343
|
# resp.replication_group.member_clusters #=> Array
|
6880
7344
|
# resp.replication_group.member_clusters[0] #=> String
|
6881
7345
|
# resp.replication_group.node_groups #=> Array
|
@@ -6892,6 +7356,7 @@ module Aws::ElastiCache
|
|
6892
7356
|
# resp.replication_group.node_groups[0].node_group_members[0].read_endpoint.address #=> String
|
6893
7357
|
# resp.replication_group.node_groups[0].node_group_members[0].read_endpoint.port #=> Integer
|
6894
7358
|
# resp.replication_group.node_groups[0].node_group_members[0].preferred_availability_zone #=> String
|
7359
|
+
# resp.replication_group.node_groups[0].node_group_members[0].preferred_outpost_arn #=> String
|
6895
7360
|
# resp.replication_group.node_groups[0].node_group_members[0].current_role #=> String
|
6896
7361
|
# resp.replication_group.snapshotting_cluster_id #=> String
|
6897
7362
|
# resp.replication_group.automatic_failover #=> String, one of "enabled", "disabled", "enabling", "disabling"
|
@@ -6906,8 +7371,12 @@ module Aws::ElastiCache
|
|
6906
7371
|
# resp.replication_group.auth_token_last_modified_date #=> Time
|
6907
7372
|
# resp.replication_group.transit_encryption_enabled #=> Boolean
|
6908
7373
|
# resp.replication_group.at_rest_encryption_enabled #=> Boolean
|
7374
|
+
# resp.replication_group.member_clusters_outpost_arns #=> Array
|
7375
|
+
# resp.replication_group.member_clusters_outpost_arns[0] #=> String
|
6909
7376
|
# resp.replication_group.kms_key_id #=> String
|
6910
7377
|
# resp.replication_group.arn #=> String
|
7378
|
+
# resp.replication_group.user_group_ids #=> Array
|
7379
|
+
# resp.replication_group.user_group_ids[0] #=> String
|
6911
7380
|
#
|
6912
7381
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/IncreaseReplicaCount AWS API Documentation
|
6913
7382
|
#
|
@@ -7455,7 +7924,7 @@ module Aws::ElastiCache
|
|
7455
7924
|
# snapshot_window: "String",
|
7456
7925
|
# cache_node_type: "String",
|
7457
7926
|
# auth_token: "String",
|
7458
|
-
# auth_token_update_strategy: "SET", # accepts SET, ROTATE
|
7927
|
+
# auth_token_update_strategy: "SET", # accepts SET, ROTATE, DELETE
|
7459
7928
|
# })
|
7460
7929
|
#
|
7461
7930
|
# @example Response structure
|
@@ -7470,6 +7939,7 @@ module Aws::ElastiCache
|
|
7470
7939
|
# resp.cache_cluster.cache_cluster_status #=> String
|
7471
7940
|
# resp.cache_cluster.num_cache_nodes #=> Integer
|
7472
7941
|
# resp.cache_cluster.preferred_availability_zone #=> String
|
7942
|
+
# resp.cache_cluster.preferred_outpost_arn #=> String
|
7473
7943
|
# resp.cache_cluster.cache_cluster_create_time #=> Time
|
7474
7944
|
# resp.cache_cluster.preferred_maintenance_window #=> String
|
7475
7945
|
# resp.cache_cluster.pending_modified_values.num_cache_nodes #=> Integer
|
@@ -7497,6 +7967,7 @@ module Aws::ElastiCache
|
|
7497
7967
|
# resp.cache_cluster.cache_nodes[0].parameter_group_status #=> String
|
7498
7968
|
# resp.cache_cluster.cache_nodes[0].source_cache_node_id #=> String
|
7499
7969
|
# resp.cache_cluster.cache_nodes[0].customer_availability_zone #=> String
|
7970
|
+
# resp.cache_cluster.cache_nodes[0].customer_outpost_arn #=> String
|
7500
7971
|
# resp.cache_cluster.auto_minor_version_upgrade #=> Boolean
|
7501
7972
|
# resp.cache_cluster.security_groups #=> Array
|
7502
7973
|
# resp.cache_cluster.security_groups[0].security_group_id #=> String
|
@@ -7675,6 +8146,7 @@ module Aws::ElastiCache
|
|
7675
8146
|
# resp.cache_subnet_group.subnets #=> Array
|
7676
8147
|
# resp.cache_subnet_group.subnets[0].subnet_identifier #=> String
|
7677
8148
|
# resp.cache_subnet_group.subnets[0].subnet_availability_zone.name #=> String
|
8149
|
+
# resp.cache_subnet_group.subnets[0].subnet_outpost.subnet_outpost_arn #=> String
|
7678
8150
|
# resp.cache_subnet_group.arn #=> String
|
7679
8151
|
#
|
7680
8152
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/ModifyCacheSubnetGroup AWS API Documentation
|
@@ -7963,6 +8435,16 @@ module Aws::ElastiCache
|
|
7963
8435
|
#
|
7964
8436
|
# [1]: https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/auth.html
|
7965
8437
|
#
|
8438
|
+
# @option params [Array<String>] :user_group_ids_to_add
|
8439
|
+
# A list of user group IDs.
|
8440
|
+
#
|
8441
|
+
# @option params [Array<String>] :user_group_ids_to_remove
|
8442
|
+
# A list of users groups to remove, meaning the users in the group no
|
8443
|
+
# longer can access thereplication group.
|
8444
|
+
#
|
8445
|
+
# @option params [Boolean] :remove_user_groups
|
8446
|
+
# Removes the user groups that can access this replication group.
|
8447
|
+
#
|
7966
8448
|
# @return [Types::ModifyReplicationGroupResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7967
8449
|
#
|
7968
8450
|
# * {Types::ModifyReplicationGroupResult#replication_group #replication_group} => Types::ReplicationGroup
|
@@ -8061,7 +8543,10 @@ module Aws::ElastiCache
|
|
8061
8543
|
# snapshot_window: "String",
|
8062
8544
|
# cache_node_type: "String",
|
8063
8545
|
# auth_token: "String",
|
8064
|
-
# auth_token_update_strategy: "SET", # accepts SET, ROTATE
|
8546
|
+
# auth_token_update_strategy: "SET", # accepts SET, ROTATE, DELETE
|
8547
|
+
# user_group_ids_to_add: ["UserGroupId"],
|
8548
|
+
# user_group_ids_to_remove: ["UserGroupId"],
|
8549
|
+
# remove_user_groups: false,
|
8065
8550
|
# })
|
8066
8551
|
#
|
8067
8552
|
# @example Response structure
|
@@ -8075,6 +8560,10 @@ module Aws::ElastiCache
|
|
8075
8560
|
# resp.replication_group.pending_modified_values.automatic_failover_status #=> String, one of "enabled", "disabled"
|
8076
8561
|
# resp.replication_group.pending_modified_values.resharding.slot_migration.progress_percentage #=> Float
|
8077
8562
|
# resp.replication_group.pending_modified_values.auth_token_status #=> String, one of "SETTING", "ROTATING"
|
8563
|
+
# resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_add #=> Array
|
8564
|
+
# resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_add[0] #=> String
|
8565
|
+
# resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_remove #=> Array
|
8566
|
+
# resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_remove[0] #=> String
|
8078
8567
|
# resp.replication_group.member_clusters #=> Array
|
8079
8568
|
# resp.replication_group.member_clusters[0] #=> String
|
8080
8569
|
# resp.replication_group.node_groups #=> Array
|
@@ -8091,6 +8580,7 @@ module Aws::ElastiCache
|
|
8091
8580
|
# resp.replication_group.node_groups[0].node_group_members[0].read_endpoint.address #=> String
|
8092
8581
|
# resp.replication_group.node_groups[0].node_group_members[0].read_endpoint.port #=> Integer
|
8093
8582
|
# resp.replication_group.node_groups[0].node_group_members[0].preferred_availability_zone #=> String
|
8583
|
+
# resp.replication_group.node_groups[0].node_group_members[0].preferred_outpost_arn #=> String
|
8094
8584
|
# resp.replication_group.node_groups[0].node_group_members[0].current_role #=> String
|
8095
8585
|
# resp.replication_group.snapshotting_cluster_id #=> String
|
8096
8586
|
# resp.replication_group.automatic_failover #=> String, one of "enabled", "disabled", "enabling", "disabling"
|
@@ -8105,8 +8595,12 @@ module Aws::ElastiCache
|
|
8105
8595
|
# resp.replication_group.auth_token_last_modified_date #=> Time
|
8106
8596
|
# resp.replication_group.transit_encryption_enabled #=> Boolean
|
8107
8597
|
# resp.replication_group.at_rest_encryption_enabled #=> Boolean
|
8598
|
+
# resp.replication_group.member_clusters_outpost_arns #=> Array
|
8599
|
+
# resp.replication_group.member_clusters_outpost_arns[0] #=> String
|
8108
8600
|
# resp.replication_group.kms_key_id #=> String
|
8109
8601
|
# resp.replication_group.arn #=> String
|
8602
|
+
# resp.replication_group.user_group_ids #=> Array
|
8603
|
+
# resp.replication_group.user_group_ids[0] #=> String
|
8110
8604
|
#
|
8111
8605
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/ModifyReplicationGroup AWS API Documentation
|
8112
8606
|
#
|
@@ -8194,6 +8688,10 @@ module Aws::ElastiCache
|
|
8194
8688
|
# resp.replication_group.pending_modified_values.automatic_failover_status #=> String, one of "enabled", "disabled"
|
8195
8689
|
# resp.replication_group.pending_modified_values.resharding.slot_migration.progress_percentage #=> Float
|
8196
8690
|
# resp.replication_group.pending_modified_values.auth_token_status #=> String, one of "SETTING", "ROTATING"
|
8691
|
+
# resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_add #=> Array
|
8692
|
+
# resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_add[0] #=> String
|
8693
|
+
# resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_remove #=> Array
|
8694
|
+
# resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_remove[0] #=> String
|
8197
8695
|
# resp.replication_group.member_clusters #=> Array
|
8198
8696
|
# resp.replication_group.member_clusters[0] #=> String
|
8199
8697
|
# resp.replication_group.node_groups #=> Array
|
@@ -8210,6 +8708,7 @@ module Aws::ElastiCache
|
|
8210
8708
|
# resp.replication_group.node_groups[0].node_group_members[0].read_endpoint.address #=> String
|
8211
8709
|
# resp.replication_group.node_groups[0].node_group_members[0].read_endpoint.port #=> Integer
|
8212
8710
|
# resp.replication_group.node_groups[0].node_group_members[0].preferred_availability_zone #=> String
|
8711
|
+
# resp.replication_group.node_groups[0].node_group_members[0].preferred_outpost_arn #=> String
|
8213
8712
|
# resp.replication_group.node_groups[0].node_group_members[0].current_role #=> String
|
8214
8713
|
# resp.replication_group.snapshotting_cluster_id #=> String
|
8215
8714
|
# resp.replication_group.automatic_failover #=> String, one of "enabled", "disabled", "enabling", "disabling"
|
@@ -8224,8 +8723,12 @@ module Aws::ElastiCache
|
|
8224
8723
|
# resp.replication_group.auth_token_last_modified_date #=> Time
|
8225
8724
|
# resp.replication_group.transit_encryption_enabled #=> Boolean
|
8226
8725
|
# resp.replication_group.at_rest_encryption_enabled #=> Boolean
|
8726
|
+
# resp.replication_group.member_clusters_outpost_arns #=> Array
|
8727
|
+
# resp.replication_group.member_clusters_outpost_arns[0] #=> String
|
8227
8728
|
# resp.replication_group.kms_key_id #=> String
|
8228
8729
|
# resp.replication_group.arn #=> String
|
8730
|
+
# resp.replication_group.user_group_ids #=> Array
|
8731
|
+
# resp.replication_group.user_group_ids[0] #=> String
|
8229
8732
|
#
|
8230
8733
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/ModifyReplicationGroupShardConfiguration AWS API Documentation
|
8231
8734
|
#
|
@@ -8236,6 +8739,120 @@ module Aws::ElastiCache
|
|
8236
8739
|
req.send_request(options)
|
8237
8740
|
end
|
8238
8741
|
|
8742
|
+
# Changes user password(s) and/or access string.
|
8743
|
+
#
|
8744
|
+
# @option params [required, String] :user_id
|
8745
|
+
# The ID of the user.
|
8746
|
+
#
|
8747
|
+
# @option params [String] :access_string
|
8748
|
+
# Access permissions string used for this user account.
|
8749
|
+
#
|
8750
|
+
# @option params [String] :append_access_string
|
8751
|
+
# Adds additional user permissions to the access string.
|
8752
|
+
#
|
8753
|
+
# @option params [Array<String>] :passwords
|
8754
|
+
# The passwords belonging to the user account. You are allowed up to
|
8755
|
+
# two.
|
8756
|
+
#
|
8757
|
+
# @option params [Boolean] :no_password_required
|
8758
|
+
# Indicates no password is required for the user account.
|
8759
|
+
#
|
8760
|
+
# @return [Types::User] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8761
|
+
#
|
8762
|
+
# * {Types::User#user_id #user_id} => String
|
8763
|
+
# * {Types::User#user_name #user_name} => String
|
8764
|
+
# * {Types::User#status #status} => String
|
8765
|
+
# * {Types::User#engine #engine} => String
|
8766
|
+
# * {Types::User#access_string #access_string} => String
|
8767
|
+
# * {Types::User#user_group_ids #user_group_ids} => Array<String>
|
8768
|
+
# * {Types::User#authentication #authentication} => Types::Authentication
|
8769
|
+
# * {Types::User#arn #arn} => String
|
8770
|
+
#
|
8771
|
+
# @example Request syntax with placeholder values
|
8772
|
+
#
|
8773
|
+
# resp = client.modify_user({
|
8774
|
+
# user_id: "UserId", # required
|
8775
|
+
# access_string: "AccessString",
|
8776
|
+
# append_access_string: "AccessString",
|
8777
|
+
# passwords: ["String"],
|
8778
|
+
# no_password_required: false,
|
8779
|
+
# })
|
8780
|
+
#
|
8781
|
+
# @example Response structure
|
8782
|
+
#
|
8783
|
+
# resp.user_id #=> String
|
8784
|
+
# resp.user_name #=> String
|
8785
|
+
# resp.status #=> String
|
8786
|
+
# resp.engine #=> String
|
8787
|
+
# resp.access_string #=> String
|
8788
|
+
# resp.user_group_ids #=> Array
|
8789
|
+
# resp.user_group_ids[0] #=> String
|
8790
|
+
# resp.authentication.type #=> String, one of "password", "no-password"
|
8791
|
+
# resp.authentication.password_count #=> Integer
|
8792
|
+
# resp.arn #=> String
|
8793
|
+
#
|
8794
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/ModifyUser AWS API Documentation
|
8795
|
+
#
|
8796
|
+
# @overload modify_user(params = {})
|
8797
|
+
# @param [Hash] params ({})
|
8798
|
+
def modify_user(params = {}, options = {})
|
8799
|
+
req = build_request(:modify_user, params)
|
8800
|
+
req.send_request(options)
|
8801
|
+
end
|
8802
|
+
|
8803
|
+
# Changes the list of users that belong to the user group.
|
8804
|
+
#
|
8805
|
+
# @option params [required, String] :user_group_id
|
8806
|
+
# The ID of the user group.
|
8807
|
+
#
|
8808
|
+
# @option params [Array<String>] :user_ids_to_add
|
8809
|
+
# The list of user IDs to add to the user group.
|
8810
|
+
#
|
8811
|
+
# @option params [Array<String>] :user_ids_to_remove
|
8812
|
+
# The list of user IDs to remove from the user group.
|
8813
|
+
#
|
8814
|
+
# @return [Types::UserGroup] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8815
|
+
#
|
8816
|
+
# * {Types::UserGroup#user_group_id #user_group_id} => String
|
8817
|
+
# * {Types::UserGroup#status #status} => String
|
8818
|
+
# * {Types::UserGroup#engine #engine} => String
|
8819
|
+
# * {Types::UserGroup#user_ids #user_ids} => Array<String>
|
8820
|
+
# * {Types::UserGroup#pending_changes #pending_changes} => Types::UserGroupPendingChanges
|
8821
|
+
# * {Types::UserGroup#replication_groups #replication_groups} => Array<String>
|
8822
|
+
# * {Types::UserGroup#arn #arn} => String
|
8823
|
+
#
|
8824
|
+
# @example Request syntax with placeholder values
|
8825
|
+
#
|
8826
|
+
# resp = client.modify_user_group({
|
8827
|
+
# user_group_id: "String", # required
|
8828
|
+
# user_ids_to_add: ["UserId"],
|
8829
|
+
# user_ids_to_remove: ["UserId"],
|
8830
|
+
# })
|
8831
|
+
#
|
8832
|
+
# @example Response structure
|
8833
|
+
#
|
8834
|
+
# resp.user_group_id #=> String
|
8835
|
+
# resp.status #=> String
|
8836
|
+
# resp.engine #=> String
|
8837
|
+
# resp.user_ids #=> Array
|
8838
|
+
# resp.user_ids[0] #=> String
|
8839
|
+
# resp.pending_changes.user_ids_to_remove #=> Array
|
8840
|
+
# resp.pending_changes.user_ids_to_remove[0] #=> String
|
8841
|
+
# resp.pending_changes.user_ids_to_add #=> Array
|
8842
|
+
# resp.pending_changes.user_ids_to_add[0] #=> String
|
8843
|
+
# resp.replication_groups #=> Array
|
8844
|
+
# resp.replication_groups[0] #=> String
|
8845
|
+
# resp.arn #=> String
|
8846
|
+
#
|
8847
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/ModifyUserGroup AWS API Documentation
|
8848
|
+
#
|
8849
|
+
# @overload modify_user_group(params = {})
|
8850
|
+
# @param [Hash] params ({})
|
8851
|
+
def modify_user_group(params = {}, options = {})
|
8852
|
+
req = build_request(:modify_user_group, params)
|
8853
|
+
req.send_request(options)
|
8854
|
+
end
|
8855
|
+
|
8239
8856
|
# Allows you to purchase a reserved cache node offering.
|
8240
8857
|
#
|
8241
8858
|
# @option params [required, String] :reserved_cache_nodes_offering_id
|
@@ -8459,6 +9076,7 @@ module Aws::ElastiCache
|
|
8459
9076
|
# resp.cache_cluster.cache_cluster_status #=> String
|
8460
9077
|
# resp.cache_cluster.num_cache_nodes #=> Integer
|
8461
9078
|
# resp.cache_cluster.preferred_availability_zone #=> String
|
9079
|
+
# resp.cache_cluster.preferred_outpost_arn #=> String
|
8462
9080
|
# resp.cache_cluster.cache_cluster_create_time #=> Time
|
8463
9081
|
# resp.cache_cluster.preferred_maintenance_window #=> String
|
8464
9082
|
# resp.cache_cluster.pending_modified_values.num_cache_nodes #=> Integer
|
@@ -8486,6 +9104,7 @@ module Aws::ElastiCache
|
|
8486
9104
|
# resp.cache_cluster.cache_nodes[0].parameter_group_status #=> String
|
8487
9105
|
# resp.cache_cluster.cache_nodes[0].source_cache_node_id #=> String
|
8488
9106
|
# resp.cache_cluster.cache_nodes[0].customer_availability_zone #=> String
|
9107
|
+
# resp.cache_cluster.cache_nodes[0].customer_outpost_arn #=> String
|
8489
9108
|
# resp.cache_cluster.auto_minor_version_upgrade #=> Boolean
|
8490
9109
|
# resp.cache_cluster.security_groups #=> Array
|
8491
9110
|
# resp.cache_cluster.security_groups[0].security_group_id #=> String
|
@@ -8756,6 +9375,10 @@ module Aws::ElastiCache
|
|
8756
9375
|
# resp.replication_group.pending_modified_values.automatic_failover_status #=> String, one of "enabled", "disabled"
|
8757
9376
|
# resp.replication_group.pending_modified_values.resharding.slot_migration.progress_percentage #=> Float
|
8758
9377
|
# resp.replication_group.pending_modified_values.auth_token_status #=> String, one of "SETTING", "ROTATING"
|
9378
|
+
# resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_add #=> Array
|
9379
|
+
# resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_add[0] #=> String
|
9380
|
+
# resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_remove #=> Array
|
9381
|
+
# resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_remove[0] #=> String
|
8759
9382
|
# resp.replication_group.member_clusters #=> Array
|
8760
9383
|
# resp.replication_group.member_clusters[0] #=> String
|
8761
9384
|
# resp.replication_group.node_groups #=> Array
|
@@ -8772,6 +9395,7 @@ module Aws::ElastiCache
|
|
8772
9395
|
# resp.replication_group.node_groups[0].node_group_members[0].read_endpoint.address #=> String
|
8773
9396
|
# resp.replication_group.node_groups[0].node_group_members[0].read_endpoint.port #=> Integer
|
8774
9397
|
# resp.replication_group.node_groups[0].node_group_members[0].preferred_availability_zone #=> String
|
9398
|
+
# resp.replication_group.node_groups[0].node_group_members[0].preferred_outpost_arn #=> String
|
8775
9399
|
# resp.replication_group.node_groups[0].node_group_members[0].current_role #=> String
|
8776
9400
|
# resp.replication_group.snapshotting_cluster_id #=> String
|
8777
9401
|
# resp.replication_group.automatic_failover #=> String, one of "enabled", "disabled", "enabling", "disabling"
|
@@ -8786,8 +9410,12 @@ module Aws::ElastiCache
|
|
8786
9410
|
# resp.replication_group.auth_token_last_modified_date #=> Time
|
8787
9411
|
# resp.replication_group.transit_encryption_enabled #=> Boolean
|
8788
9412
|
# resp.replication_group.at_rest_encryption_enabled #=> Boolean
|
9413
|
+
# resp.replication_group.member_clusters_outpost_arns #=> Array
|
9414
|
+
# resp.replication_group.member_clusters_outpost_arns[0] #=> String
|
8789
9415
|
# resp.replication_group.kms_key_id #=> String
|
8790
9416
|
# resp.replication_group.arn #=> String
|
9417
|
+
# resp.replication_group.user_group_ids #=> Array
|
9418
|
+
# resp.replication_group.user_group_ids[0] #=> String
|
8791
9419
|
#
|
8792
9420
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/StartMigration AWS API Documentation
|
8793
9421
|
#
|
@@ -8883,6 +9511,10 @@ module Aws::ElastiCache
|
|
8883
9511
|
# resp.replication_group.pending_modified_values.automatic_failover_status #=> String, one of "enabled", "disabled"
|
8884
9512
|
# resp.replication_group.pending_modified_values.resharding.slot_migration.progress_percentage #=> Float
|
8885
9513
|
# resp.replication_group.pending_modified_values.auth_token_status #=> String, one of "SETTING", "ROTATING"
|
9514
|
+
# resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_add #=> Array
|
9515
|
+
# resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_add[0] #=> String
|
9516
|
+
# resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_remove #=> Array
|
9517
|
+
# resp.replication_group.pending_modified_values.user_groups.user_group_ids_to_remove[0] #=> String
|
8886
9518
|
# resp.replication_group.member_clusters #=> Array
|
8887
9519
|
# resp.replication_group.member_clusters[0] #=> String
|
8888
9520
|
# resp.replication_group.node_groups #=> Array
|
@@ -8899,6 +9531,7 @@ module Aws::ElastiCache
|
|
8899
9531
|
# resp.replication_group.node_groups[0].node_group_members[0].read_endpoint.address #=> String
|
8900
9532
|
# resp.replication_group.node_groups[0].node_group_members[0].read_endpoint.port #=> Integer
|
8901
9533
|
# resp.replication_group.node_groups[0].node_group_members[0].preferred_availability_zone #=> String
|
9534
|
+
# resp.replication_group.node_groups[0].node_group_members[0].preferred_outpost_arn #=> String
|
8902
9535
|
# resp.replication_group.node_groups[0].node_group_members[0].current_role #=> String
|
8903
9536
|
# resp.replication_group.snapshotting_cluster_id #=> String
|
8904
9537
|
# resp.replication_group.automatic_failover #=> String, one of "enabled", "disabled", "enabling", "disabling"
|
@@ -8913,8 +9546,12 @@ module Aws::ElastiCache
|
|
8913
9546
|
# resp.replication_group.auth_token_last_modified_date #=> Time
|
8914
9547
|
# resp.replication_group.transit_encryption_enabled #=> Boolean
|
8915
9548
|
# resp.replication_group.at_rest_encryption_enabled #=> Boolean
|
9549
|
+
# resp.replication_group.member_clusters_outpost_arns #=> Array
|
9550
|
+
# resp.replication_group.member_clusters_outpost_arns[0] #=> String
|
8916
9551
|
# resp.replication_group.kms_key_id #=> String
|
8917
9552
|
# resp.replication_group.arn #=> String
|
9553
|
+
# resp.replication_group.user_group_ids #=> Array
|
9554
|
+
# resp.replication_group.user_group_ids[0] #=> String
|
8918
9555
|
#
|
8919
9556
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/TestFailover AWS API Documentation
|
8920
9557
|
#
|
@@ -8938,7 +9575,7 @@ module Aws::ElastiCache
|
|
8938
9575
|
params: params,
|
8939
9576
|
config: config)
|
8940
9577
|
context[:gem_name] = 'aws-sdk-elasticache'
|
8941
|
-
context[:gem_version] = '1.
|
9578
|
+
context[:gem_version] = '1.44.0'
|
8942
9579
|
Seahorse::Client::Request.new(handlers, context)
|
8943
9580
|
end
|
8944
9581
|
|