AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Adds a new Amazon Web Services Region to the keyspace. You can add a new Region to
a keyspace that is either a single or a multi-Region keyspace. Amazon Keyspaces is
going to replicate all tables in the keyspace to the new Region. To successfully replicate
all tables to the new Region, they must use client-side timestamps for conflict resolution.
To enable client-side timestamps, specify clientSideTimestamps.status = enabled
when invoking the API. For more information about client-side timestamps, see Client-side
timestamps in Amazon Keyspaces in the Amazon Keyspaces Developer Guide.
To add a Region to a keyspace using the UpdateKeyspace API, the IAM principal
needs permissions for the following IAM actions:
cassandra:Alter
cassandra:AlterMultiRegionResource
cassandra:Create
cassandra:CreateMultiRegionResource
cassandra:Select
cassandra:SelectMultiRegionResource
cassandra:Modify
cassandra:ModifyMultiRegionResource
If the keyspace contains a table that is configured in provisioned mode with auto scaling enabled, the following additional IAM actions need to be allowed.
application-autoscaling:RegisterScalableTarget
application-autoscaling:DeregisterScalableTarget
application-autoscaling:DescribeScalableTargets
application-autoscaling:PutScalingPolicy
application-autoscaling:DescribeScalingPolicies
To use the UpdateKeyspace API, the IAM principal also needs permissions to
create a service-linked role with the following elements:
iam:CreateServiceLinkedRole - The action the principal can perform.
arn:aws:iam::*:role/aws-service-role/replication.cassandra.amazonaws.com/AWSServiceRoleForKeyspacesReplication
- The resource that the action can be performed on.
iam:AWSServiceName: replication.cassandra.amazonaws.com - The only Amazon
Web Services service that this role can be attached to is Amazon Keyspaces.
For more information, see Configure the IAM permissions required to add an Amazon Web Services Region to a keyspace in the Amazon Keyspaces Developer Guide.
For .NET Core this operation is only available in asynchronous form. Please refer to UpdateKeyspaceAsync.
Namespace: Amazon.Keyspaces
Assembly: AWSSDK.Keyspaces.dll
Version: 3.x.y.z
public abstract UpdateKeyspaceResponse UpdateKeyspace( UpdateKeyspaceRequest request )
Container for the necessary parameters to execute the UpdateKeyspace service method.
| Exception | Condition |
|---|---|
| AccessDeniedException | You don't have sufficient access permissions to perform this action. |
| ConflictException | Amazon Keyspaces couldn't complete the requested action. This error may occur if you try to perform an action and the same or a different action is already in progress, or if you try to create a resource that already exists. |
| InternalServerException | Amazon Keyspaces was unable to fully process this request because of an internal server error. |
| ResourceNotFoundException | The operation tried to access a keyspace, table, or type that doesn't exist. The resource might not be specified correctly, or its status might not be ACTIVE. |
| ServiceQuotaExceededException | The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide. |
| ValidationException | The operation failed due to an invalid or malformed request. |
.NET Framework:
Supported in: 4.7.2 and newer