aws-sdk-cognitoidentityprovider 1.143.0 → 1.144.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 805c071b8a6ca0a9f6704494f44851b7978c5e3250932998a06cb1f2902850df
4
- data.tar.gz: b60770e3e4e61cc64911ac178304c8c1813814079e48c755b0bdd4a3eca57655
3
+ metadata.gz: 2b30b3c80eccac76786e91712eec231f03f9193948e682a04bd7f65a962f7ee8
4
+ data.tar.gz: d9e2bcae1a67646de0940d53a7fe23943c6a0e73035902db0997e8675c5bf343
5
5
  SHA512:
6
- metadata.gz: f87160cb2660f282c9ca3eab1d2c27e3faf4b9e2c9606387061f9c38f07881552797043110a87bfaefdafd0dab654bf05231f1be6303d9988d40d6efbe1b016f
7
- data.tar.gz: a721bf339a258b2456c34de653f6fd4625c2c48f38943968061de81adc6393d45d3414b9f706b9ac93e44409683d33bb9ec21b60ab5a3d34e8362bf5edf98753
6
+ metadata.gz: 392c24d91b9857f50621f6b6a474a15f8045ef410d199f5edb588ce119ea99c5cc306ae4b63b244416d04203f6f3969c04e39fa49f1fe49df8e6609bd172aa7a
7
+ data.tar.gz: 4b13494116d81bce9d37207c9c5f6eb1ea1b7a54649a4292eab9725bf45bb3b7194021432e3a4b6cffb5a1c17fd737770dd22383ab6deccef6afa861d5da759e
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.144.0 (2026-06-01)
5
+ ------------------
6
+
7
+ * Feature - Add support for multi-region replication, enabling synchronization of user data and configurations to a secondary user pool in a standby Region. Add support for customer managed keys (CMK) in AWS KMS for encrypting user pool data at rest.
8
+
4
9
  1.143.0 (2026-05-21)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.143.0
1
+ 1.144.0
@@ -5005,6 +5005,14 @@ module Aws::CognitoIdentityProvider
5005
5005
  #
5006
5006
  # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-sign-in-feature-plans.html
5007
5007
  #
5008
+ # @option params [Types::KeyConfigurationType] :key_configuration
5009
+ # The key configuration for the user pool. Specifies the key type and
5010
+ # KMS key ARN for encryption.
5011
+ #
5012
+ # @option params [Types::IssuerConfigurationType] :issuer_configuration
5013
+ # The issuer configuration for the user pool. Specifies the issuer type
5014
+ # for token generation.
5015
+ #
5008
5016
  # @return [Types::CreateUserPoolResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5009
5017
  #
5010
5018
  # * {Types::CreateUserPoolResponse#user_pool #user_pool} => Types::UserPoolType
@@ -5603,6 +5611,13 @@ module Aws::CognitoIdentityProvider
5603
5611
  # ],
5604
5612
  # },
5605
5613
  # user_pool_tier: "LITE", # accepts LITE, ESSENTIALS, PLUS
5614
+ # key_configuration: {
5615
+ # key_type: "AWS_OWNED_KEY", # accepts AWS_OWNED_KEY, CUSTOMER_MANAGED_KEY
5616
+ # kms_key_arn: "EncryptionKeyArnType",
5617
+ # },
5618
+ # issuer_configuration: {
5619
+ # type: "ORIGINAL", # accepts ORIGINAL, UPDATED
5620
+ # },
5606
5621
  # })
5607
5622
  #
5608
5623
  # @example Response structure
@@ -5700,6 +5715,9 @@ module Aws::CognitoIdentityProvider
5700
5715
  # resp.user_pool.account_recovery_setting.recovery_mechanisms[0].priority #=> Integer
5701
5716
  # resp.user_pool.account_recovery_setting.recovery_mechanisms[0].name #=> String, one of "verified_email", "verified_phone_number", "admin_only"
5702
5717
  # resp.user_pool.user_pool_tier #=> String, one of "LITE", "ESSENTIALS", "PLUS"
5718
+ # resp.user_pool.key_configuration.key_type #=> String, one of "AWS_OWNED_KEY", "CUSTOMER_MANAGED_KEY"
5719
+ # resp.user_pool.key_configuration.kms_key_arn #=> String
5720
+ # resp.user_pool.issuer_configuration.type #=> String, one of "ORIGINAL", "UPDATED"
5703
5721
  #
5704
5722
  # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateUserPool AWS API Documentation
5705
5723
  #
@@ -6405,10 +6423,16 @@ module Aws::CognitoIdentityProvider
6405
6423
  # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-add-custom-domain.html
6406
6424
  # [2]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-assign-domain-prefix.html
6407
6425
  #
6426
+ # @option params [Types::RoutingType] :routing
6427
+ # The configuration of routing for requests to the domain for replicas
6428
+ # of a replicated user pool. The routing configuration is currently only
6429
+ # supported for custom domains.
6430
+ #
6408
6431
  # @return [Types::CreateUserPoolDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6409
6432
  #
6410
6433
  # * {Types::CreateUserPoolDomainResponse#managed_login_version #managed_login_version} => Integer
6411
6434
  # * {Types::CreateUserPoolDomainResponse#cloud_front_domain #cloud_front_domain} => String
6435
+ # * {Types::CreateUserPoolDomainResponse#routing #routing} => Types::RoutingType
6412
6436
  #
6413
6437
  # @example Request syntax with placeholder values
6414
6438
  #
@@ -6419,12 +6443,20 @@ module Aws::CognitoIdentityProvider
6419
6443
  # custom_domain_config: {
6420
6444
  # certificate_arn: "ArnType", # required
6421
6445
  # },
6446
+ # routing: {
6447
+ # failover: {
6448
+ # secondary_region: "RegionNameType", # required
6449
+ # primary_route_53_health_check_id: "HealthCheckIdType", # required
6450
+ # },
6451
+ # },
6422
6452
  # })
6423
6453
  #
6424
6454
  # @example Response structure
6425
6455
  #
6426
6456
  # resp.managed_login_version #=> Integer
6427
6457
  # resp.cloud_front_domain #=> String
6458
+ # resp.routing.failover.secondary_region #=> String
6459
+ # resp.routing.failover.primary_route_53_health_check_id #=> String
6428
6460
  #
6429
6461
  # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateUserPoolDomain AWS API Documentation
6430
6462
  #
@@ -6435,6 +6467,91 @@ module Aws::CognitoIdentityProvider
6435
6467
  req.send_request(options)
6436
6468
  end
6437
6469
 
6470
+ # Creates a replica of an existing user pool in a specified Amazon Web
6471
+ # Services Region. The replica enables multi-region replication for high
6472
+ # availability and disaster recovery. To create a replica, you must have
6473
+ # permissions to create user pools in the target Region.
6474
+ #
6475
+ # <note markdown="1"> Amazon Cognito evaluates Identity and Access Management (IAM) policies
6476
+ # in requests for this API operation. For this operation, you must use
6477
+ # IAM credentials to authorize requests, and you must grant yourself the
6478
+ # corresponding IAM permission in a policy.
6479
+ #
6480
+ # **Learn more**
6481
+ #
6482
+ # * [Signing Amazon Web Services API Requests][1]
6483
+ #
6484
+ # * [Using the Amazon Cognito user pools API and user pool endpoints][2]
6485
+ #
6486
+ # </note>
6487
+ #
6488
+ #
6489
+ #
6490
+ # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html
6491
+ # [2]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html
6492
+ #
6493
+ # @option params [required, String] :user_pool_id
6494
+ # The ID of the user pool to replicate.
6495
+ #
6496
+ # @option params [required, String] :region_name
6497
+ # The Amazon Web Services Region where you want to create the replica
6498
+ # user pool.
6499
+ #
6500
+ # @option params [Hash<String,String>] :user_pool_tags
6501
+ # A map of tags to assign to the replica user pool. Each tag consists of
6502
+ # a key and an optional value, both of which you define. You can
6503
+ # maintain tags independently on replica user pools.
6504
+ #
6505
+ # @return [Types::CreateUserPoolReplicaResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6506
+ #
6507
+ # * {Types::CreateUserPoolReplicaResponse#user_pool_replica #user_pool_replica} => Types::UserPoolReplicaType
6508
+ #
6509
+ #
6510
+ # @example Example: Example create a replica of a user pool in a new Region
6511
+ #
6512
+ # # The following example creates a replica of a user pool in the ap-south-1 Region.
6513
+ #
6514
+ # resp = client.create_user_pool_replica({
6515
+ # region_name: "ap-south-1",
6516
+ # user_pool_id: "us-east-1_abcd12345",
6517
+ # })
6518
+ #
6519
+ # resp.to_h outputs the following:
6520
+ # {
6521
+ # user_pool_replica: {
6522
+ # region_name: "ap-south-1",
6523
+ # role: "SECONDARY",
6524
+ # status: "CREATING",
6525
+ # user_pool_arn: "arn:aws:cognito-idp:ap-south-1:123456789012:userpool/us-east-1_abcd12345",
6526
+ # },
6527
+ # }
6528
+ #
6529
+ # @example Request syntax with placeholder values
6530
+ #
6531
+ # resp = client.create_user_pool_replica({
6532
+ # user_pool_id: "UserPoolIdType", # required
6533
+ # region_name: "RegionNameType", # required
6534
+ # user_pool_tags: {
6535
+ # "TagKeysType" => "TagValueType",
6536
+ # },
6537
+ # })
6538
+ #
6539
+ # @example Response structure
6540
+ #
6541
+ # resp.user_pool_replica.region_name #=> String
6542
+ # resp.user_pool_replica.status #=> String, one of "CREATING", "ACTIVE", "INACTIVE", "DELETING"
6543
+ # resp.user_pool_replica.role #=> String, one of "PRIMARY", "SECONDARY"
6544
+ # resp.user_pool_replica.user_pool_arn #=> String
6545
+ #
6546
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateUserPoolReplica AWS API Documentation
6547
+ #
6548
+ # @overload create_user_pool_replica(params = {})
6549
+ # @param [Hash] params ({})
6550
+ def create_user_pool_replica(params = {}, options = {})
6551
+ req = build_request(:create_user_pool_replica, params)
6552
+ req.send_request(options)
6553
+ end
6554
+
6438
6555
  # Deletes a group from the specified user pool. When you delete a group,
6439
6556
  # that group no longer contributes to users' `cognito:preferred_group`
6440
6557
  # or `cognito:groups` claims, and no longer influence access-control
@@ -6893,6 +7010,81 @@ module Aws::CognitoIdentityProvider
6893
7010
  req.send_request(options)
6894
7011
  end
6895
7012
 
7013
+ # Deletes a secondary replica user pool. You can only delete replicas
7014
+ # that are in the INACTIVE status. This operation must be called from
7015
+ # the primary Region.
7016
+ #
7017
+ # <note markdown="1"> Amazon Cognito evaluates Identity and Access Management (IAM) policies
7018
+ # in requests for this API operation. For this operation, you must use
7019
+ # IAM credentials to authorize requests, and you must grant yourself the
7020
+ # corresponding IAM permission in a policy.
7021
+ #
7022
+ # **Learn more**
7023
+ #
7024
+ # * [Signing Amazon Web Services API Requests][1]
7025
+ #
7026
+ # * [Using the Amazon Cognito user pools API and user pool endpoints][2]
7027
+ #
7028
+ # </note>
7029
+ #
7030
+ #
7031
+ #
7032
+ # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html
7033
+ # [2]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html
7034
+ #
7035
+ # @option params [required, String] :user_pool_id
7036
+ # The ID of the user pool that contains the replica to delete.
7037
+ #
7038
+ # @option params [required, String] :region_name
7039
+ # The Amazon Web Services Region of the replica to delete.
7040
+ #
7041
+ # @return [Types::DeleteUserPoolReplicaResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
7042
+ #
7043
+ # * {Types::DeleteUserPoolReplicaResponse#user_pool_replica #user_pool_replica} => Types::UserPoolReplicaType
7044
+ #
7045
+ #
7046
+ # @example Example: Example delete a user pool replica
7047
+ #
7048
+ # # The following example deletes a user pool replica in the us-east-2 Region.
7049
+ #
7050
+ # resp = client.delete_user_pool_replica({
7051
+ # region_name: "us-east-2",
7052
+ # user_pool_id: "us-west-2_abcd12345",
7053
+ # })
7054
+ #
7055
+ # resp.to_h outputs the following:
7056
+ # {
7057
+ # user_pool_replica: {
7058
+ # region_name: "us-east-2",
7059
+ # role: "SECONDARY",
7060
+ # status: "DELETING",
7061
+ # user_pool_arn: "arn:aws:cognito-idp:us-east-2:123456789012:userpool/us-west-2_abcd12345",
7062
+ # },
7063
+ # }
7064
+ #
7065
+ # @example Request syntax with placeholder values
7066
+ #
7067
+ # resp = client.delete_user_pool_replica({
7068
+ # user_pool_id: "UserPoolIdType", # required
7069
+ # region_name: "RegionNameType", # required
7070
+ # })
7071
+ #
7072
+ # @example Response structure
7073
+ #
7074
+ # resp.user_pool_replica.region_name #=> String
7075
+ # resp.user_pool_replica.status #=> String, one of "CREATING", "ACTIVE", "INACTIVE", "DELETING"
7076
+ # resp.user_pool_replica.role #=> String, one of "PRIMARY", "SECONDARY"
7077
+ # resp.user_pool_replica.user_pool_arn #=> String
7078
+ #
7079
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeleteUserPoolReplica AWS API Documentation
7080
+ #
7081
+ # @overload delete_user_pool_replica(params = {})
7082
+ # @param [Hash] params ({})
7083
+ def delete_user_pool_replica(params = {}, options = {})
7084
+ req = build_request(:delete_user_pool_replica, params)
7085
+ req.send_request(options)
7086
+ end
7087
+
6896
7088
  # Deletes a registered passkey, or WebAuthn, authenticator for the
6897
7089
  # currently signed-in user.
6898
7090
  #
@@ -7450,6 +7642,9 @@ module Aws::CognitoIdentityProvider
7450
7642
  # resp.user_pool.account_recovery_setting.recovery_mechanisms[0].priority #=> Integer
7451
7643
  # resp.user_pool.account_recovery_setting.recovery_mechanisms[0].name #=> String, one of "verified_email", "verified_phone_number", "admin_only"
7452
7644
  # resp.user_pool.user_pool_tier #=> String, one of "LITE", "ESSENTIALS", "PLUS"
7645
+ # resp.user_pool.key_configuration.key_type #=> String, one of "AWS_OWNED_KEY", "CUSTOMER_MANAGED_KEY"
7646
+ # resp.user_pool.key_configuration.kms_key_arn #=> String
7647
+ # resp.user_pool.issuer_configuration.type #=> String, one of "ORIGINAL", "UPDATED"
7453
7648
  #
7454
7649
  # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeUserPool AWS API Documentation
7455
7650
  #
@@ -7602,6 +7797,8 @@ module Aws::CognitoIdentityProvider
7602
7797
  # resp.domain_description.status #=> String, one of "CREATING", "DELETING", "UPDATING", "ACTIVE", "FAILED"
7603
7798
  # resp.domain_description.custom_domain_config.certificate_arn #=> String
7604
7799
  # resp.domain_description.managed_login_version #=> Integer
7800
+ # resp.domain_description.routing.failover.secondary_region #=> String
7801
+ # resp.domain_description.routing.failover.primary_route_53_health_check_id #=> String
7605
7802
  #
7606
7803
  # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeUserPoolDomain AWS API Documentation
7607
7804
  #
@@ -9616,6 +9813,92 @@ module Aws::CognitoIdentityProvider
9616
9813
  req.send_request(options)
9617
9814
  end
9618
9815
 
9816
+ # Lists all replicas for a user pool, including both primary and
9817
+ # secondary replicas. We recommend using pagination to ensure that the
9818
+ # operation returns quickly and successfully.
9819
+ #
9820
+ # <note markdown="1"> Amazon Cognito evaluates Identity and Access Management (IAM) policies
9821
+ # in requests for this API operation. For this operation, you must use
9822
+ # IAM credentials to authorize requests, and you must grant yourself the
9823
+ # corresponding IAM permission in a policy.
9824
+ #
9825
+ # **Learn more**
9826
+ #
9827
+ # * [Signing Amazon Web Services API Requests][1]
9828
+ #
9829
+ # * [Using the Amazon Cognito user pools API and user pool endpoints][2]
9830
+ #
9831
+ # </note>
9832
+ #
9833
+ #
9834
+ #
9835
+ # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html
9836
+ # [2]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html
9837
+ #
9838
+ # @option params [required, String] :user_pool_id
9839
+ # The ID of the user pool for which to list replicas.
9840
+ #
9841
+ # @option params [String] :next_token
9842
+ # A pagination token for retrieving the next page of results. If this
9843
+ # parameter is omitted, the operation returns the first page of results.
9844
+ #
9845
+ # @return [Types::ListUserPoolReplicasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
9846
+ #
9847
+ # * {Types::ListUserPoolReplicasResponse#user_pool_replicas #user_pool_replicas} => Array&lt;Types::UserPoolReplicaType&gt;
9848
+ # * {Types::ListUserPoolReplicasResponse#next_token #next_token} => String
9849
+ #
9850
+ #
9851
+ # @example Example: Example list the replicas of a user pool
9852
+ #
9853
+ # # The following example lists the replicas of a user pool that has a replica in the ap-south-1 Region.
9854
+ #
9855
+ # resp = client.list_user_pool_replicas({
9856
+ # user_pool_id: "eu-north-1_abcd12345",
9857
+ # })
9858
+ #
9859
+ # resp.to_h outputs the following:
9860
+ # {
9861
+ # user_pool_replicas: [
9862
+ # {
9863
+ # region_name: "ap-south-1",
9864
+ # role: "SECONDARY",
9865
+ # status: "CREATING",
9866
+ # user_pool_arn: "arn:aws:cognito-idp:ap-south-1:123456789012:userpool/eu-north-1_abcd12345",
9867
+ # },
9868
+ # {
9869
+ # region_name: "eu-north-1",
9870
+ # role: "PRIMARY",
9871
+ # status: "ACTIVE",
9872
+ # user_pool_arn: "arn:aws:cognito-idp:eu-north-1:123456789012:userpool/eu-north-1_abcd12345",
9873
+ # },
9874
+ # ],
9875
+ # }
9876
+ #
9877
+ # @example Request syntax with placeholder values
9878
+ #
9879
+ # resp = client.list_user_pool_replicas({
9880
+ # user_pool_id: "UserPoolIdType", # required
9881
+ # next_token: "PaginationKeyType",
9882
+ # })
9883
+ #
9884
+ # @example Response structure
9885
+ #
9886
+ # resp.user_pool_replicas #=> Array
9887
+ # resp.user_pool_replicas[0].region_name #=> String
9888
+ # resp.user_pool_replicas[0].status #=> String, one of "CREATING", "ACTIVE", "INACTIVE", "DELETING"
9889
+ # resp.user_pool_replicas[0].role #=> String, one of "PRIMARY", "SECONDARY"
9890
+ # resp.user_pool_replicas[0].user_pool_arn #=> String
9891
+ # resp.next_token #=> String
9892
+ #
9893
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListUserPoolReplicas AWS API Documentation
9894
+ #
9895
+ # @overload list_user_pool_replicas(params = {})
9896
+ # @param [Hash] params ({})
9897
+ def list_user_pool_replicas(params = {}, options = {})
9898
+ req = build_request(:list_user_pool_replicas, params)
9899
+ req.send_request(options)
9900
+ end
9901
+
9619
9902
  # Lists user pools and their details in the current Amazon Web Services
9620
9903
  # account.
9621
9904
  #
@@ -9690,6 +9973,8 @@ module Aws::CognitoIdentityProvider
9690
9973
  # resp.user_pools[0].status #=> String, one of "Enabled", "Disabled"
9691
9974
  # resp.user_pools[0].last_modified_date #=> Time
9692
9975
  # resp.user_pools[0].creation_date #=> Time
9976
+ # resp.user_pools[0].replica_regions #=> Array
9977
+ # resp.user_pools[0].replica_regions[0] #=> String
9693
9978
  # resp.next_token #=> String
9694
9979
  #
9695
9980
  # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListUserPools AWS API Documentation
@@ -10800,6 +11085,12 @@ module Aws::CognitoIdentityProvider
10800
11085
  # `UserPoolAddOns` in an `UpdateUserPool` request. To activate this
10801
11086
  # setting, your user pool must be on the [ Plus tier][1].
10802
11087
  #
11088
+ # In secondary regions for user pools with multi-region replication,
11089
+ # only the `SourceARN` and `From` attributes of `NotifyConfiguration`
11090
+ # can be modified to configure region-specific SES integration. All
11091
+ # other risk configuration settings must match the existing values to
11092
+ # maintain consistency across replicas.
11093
+ #
10803
11094
  #
10804
11095
  #
10805
11096
  # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-plus.html
@@ -12610,8 +12901,14 @@ module Aws::CognitoIdentityProvider
12610
12901
  # existing configuration of your user pool, modified to include the
12611
12902
  # changes that you want to make.
12612
12903
  #
12613
- # With the exception of `UserPoolTier`, if you don't provide a value
12614
- # for an attribute, Amazon Cognito sets it to its default value.
12904
+ # If you don't provide a value for an attribute, Amazon Cognito sets it
12905
+ # to its default value.
12906
+ #
12907
+ # In secondary regions for user pools with multi-region replication,
12908
+ # regional configurations for email, SMS, Lambda functions, and tags can
12909
+ # be updated. Both global and regional settings must be provided as
12910
+ # inputs, with global settings required to match existing values to
12911
+ # maintain consistency across replicas.
12615
12912
  #
12616
12913
  # <note markdown="1"> This action might generate an SMS text message. Starting June 1, 2021,
12617
12914
  # US telecom carriers require you to register an origination phone
@@ -12826,6 +13123,16 @@ module Aws::CognitoIdentityProvider
12826
13123
  #
12827
13124
  # [1]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-sign-in-feature-plans.html
12828
13125
  #
13126
+ # @option params [Types::KeyConfigurationType] :key_configuration
13127
+ # The key configuration for the user pool. In secondary regions, this
13128
+ # parameter must match the existing configuration and cannot be
13129
+ # modified.
13130
+ #
13131
+ # @option params [Types::IssuerConfigurationType] :issuer_configuration
13132
+ # The issuer configuration for the user pool. In secondary regions, this
13133
+ # parameter must match the existing configuration and cannot be
13134
+ # modified.
13135
+ #
12829
13136
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
12830
13137
  #
12831
13138
  # @example Request syntax with placeholder values
@@ -12937,6 +13244,13 @@ module Aws::CognitoIdentityProvider
12937
13244
  # },
12938
13245
  # pool_name: "UserPoolNameType",
12939
13246
  # user_pool_tier: "LITE", # accepts LITE, ESSENTIALS, PLUS
13247
+ # key_configuration: {
13248
+ # key_type: "AWS_OWNED_KEY", # accepts AWS_OWNED_KEY, CUSTOMER_MANAGED_KEY
13249
+ # kms_key_arn: "EncryptionKeyArnType",
13250
+ # },
13251
+ # issuer_configuration: {
13252
+ # type: "ORIGINAL", # accepts ORIGINAL, UPDATED
13253
+ # },
12940
13254
  # })
12941
13255
  #
12942
13256
  # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateUserPool AWS API Documentation
@@ -13501,10 +13815,15 @@ module Aws::CognitoIdentityProvider
13501
13815
  # mismatch in RP ID. To keep the prefix domain passkey integration
13502
13816
  # working, you can explicitly set RP ID to the prefix domain.
13503
13817
  #
13818
+ # @option params [Types::RoutingType] :routing
13819
+ # The routing configuration for the user pool domain. Specifies failover
13820
+ # settings for multi-region deployments.
13821
+ #
13504
13822
  # @return [Types::UpdateUserPoolDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
13505
13823
  #
13506
13824
  # * {Types::UpdateUserPoolDomainResponse#managed_login_version #managed_login_version} => Integer
13507
13825
  # * {Types::UpdateUserPoolDomainResponse#cloud_front_domain #cloud_front_domain} => String
13826
+ # * {Types::UpdateUserPoolDomainResponse#routing #routing} => Types::RoutingType
13508
13827
  #
13509
13828
  # @example Request syntax with placeholder values
13510
13829
  #
@@ -13515,12 +13834,20 @@ module Aws::CognitoIdentityProvider
13515
13834
  # custom_domain_config: {
13516
13835
  # certificate_arn: "ArnType", # required
13517
13836
  # },
13837
+ # routing: {
13838
+ # failover: {
13839
+ # secondary_region: "RegionNameType", # required
13840
+ # primary_route_53_health_check_id: "HealthCheckIdType", # required
13841
+ # },
13842
+ # },
13518
13843
  # })
13519
13844
  #
13520
13845
  # @example Response structure
13521
13846
  #
13522
13847
  # resp.managed_login_version #=> Integer
13523
13848
  # resp.cloud_front_domain #=> String
13849
+ # resp.routing.failover.secondary_region #=> String
13850
+ # resp.routing.failover.primary_route_53_health_check_id #=> String
13524
13851
  #
13525
13852
  # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateUserPoolDomain AWS API Documentation
13526
13853
  #
@@ -13531,6 +13858,87 @@ module Aws::CognitoIdentityProvider
13531
13858
  req.send_request(options)
13532
13859
  end
13533
13860
 
13861
+ # Updates replica-specific settings for a user pool replica. You can
13862
+ # modify the status to activate or deactivate the replica. This request
13863
+ # can be made in both primary and secondary regions of the user pool.
13864
+ #
13865
+ # <note markdown="1"> Amazon Cognito evaluates Identity and Access Management (IAM) policies
13866
+ # in requests for this API operation. For this operation, you must use
13867
+ # IAM credentials to authorize requests, and you must grant yourself the
13868
+ # corresponding IAM permission in a policy.
13869
+ #
13870
+ # **Learn more**
13871
+ #
13872
+ # * [Signing Amazon Web Services API Requests][1]
13873
+ #
13874
+ # * [Using the Amazon Cognito user pools API and user pool endpoints][2]
13875
+ #
13876
+ # </note>
13877
+ #
13878
+ #
13879
+ #
13880
+ # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html
13881
+ # [2]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html
13882
+ #
13883
+ # @option params [required, String] :user_pool_id
13884
+ # The ID of the user pool that contains the replica to update.
13885
+ #
13886
+ # @option params [required, String] :region_name
13887
+ # The Amazon Web Services Region of the replica to update.
13888
+ #
13889
+ # @option params [required, String] :status
13890
+ # The status to set for the replica. Valid values are ACTIVE and
13891
+ # INACTIVE.
13892
+ #
13893
+ # @return [Types::UpdateUserPoolReplicaResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
13894
+ #
13895
+ # * {Types::UpdateUserPoolReplicaResponse#user_pool_replica #user_pool_replica} => Types::UserPoolReplicaType
13896
+ #
13897
+ #
13898
+ # @example Example: Example update a user pool replica
13899
+ #
13900
+ # # The following example sets the status of a user pool replica in the us-east-1 Region to ACTIVE.
13901
+ #
13902
+ # resp = client.update_user_pool_replica({
13903
+ # region_name: "us-east-1",
13904
+ # status: "ACTIVE",
13905
+ # user_pool_id: "ap-south-1_abcd12345",
13906
+ # })
13907
+ #
13908
+ # resp.to_h outputs the following:
13909
+ # {
13910
+ # user_pool_replica: {
13911
+ # region_name: "us-east-1",
13912
+ # role: "SECONDARY",
13913
+ # status: "ACTIVE",
13914
+ # user_pool_arn: "arn:aws:cognito-idp:us-east-1:123456789012:userpool/ap-south-1_abcd12345",
13915
+ # },
13916
+ # }
13917
+ #
13918
+ # @example Request syntax with placeholder values
13919
+ #
13920
+ # resp = client.update_user_pool_replica({
13921
+ # user_pool_id: "UserPoolIdType", # required
13922
+ # region_name: "RegionNameType", # required
13923
+ # status: "ACTIVE", # required, accepts ACTIVE, INACTIVE
13924
+ # })
13925
+ #
13926
+ # @example Response structure
13927
+ #
13928
+ # resp.user_pool_replica.region_name #=> String
13929
+ # resp.user_pool_replica.status #=> String, one of "CREATING", "ACTIVE", "INACTIVE", "DELETING"
13930
+ # resp.user_pool_replica.role #=> String, one of "PRIMARY", "SECONDARY"
13931
+ # resp.user_pool_replica.user_pool_arn #=> String
13932
+ #
13933
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateUserPoolReplica AWS API Documentation
13934
+ #
13935
+ # @overload update_user_pool_replica(params = {})
13936
+ # @param [Hash] params ({})
13937
+ def update_user_pool_replica(params = {}, options = {})
13938
+ req = build_request(:update_user_pool_replica, params)
13939
+ req.send_request(options)
13940
+ end
13941
+
13534
13942
  # Registers the current user's time-based one-time password (TOTP)
13535
13943
  # authenticator with a code generated in their authenticator app from a
13536
13944
  # private key that's supplied by your user pool. Marks the user's
@@ -13666,7 +14074,7 @@ module Aws::CognitoIdentityProvider
13666
14074
  tracer: tracer
13667
14075
  )
13668
14076
  context[:gem_name] = 'aws-sdk-cognitoidentityprovider'
13669
- context[:gem_version] = '1.143.0'
14077
+ context[:gem_version] = '1.144.0'
13670
14078
  Seahorse::Client::Request.new(handlers, context)
13671
14079
  end
13672
14080