CreateSnapshotCopyGrant - Amazon Redshift
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

CreateSnapshotCopyGrant

Creates a snapshot copy grant that permits Amazon Redshift to use an encrypted symmetric key from Amazon Key Management Service (KMS) to encrypt copied snapshots in a destination region.

For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

SnapshotCopyGrantName

The name of the snapshot copy grant. This name must be unique in the region for the Amazon Web Services account.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens.

  • Alphabetic characters must be lowercase.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

  • Must be unique for all clusters within an Amazon Web Services account.

Type: String

Length Constraints: Maximum length of 2147483647.

Required: Yes

KmsKeyId

The unique identifier of the encrypted symmetric key to which to grant Amazon Redshift permission. If no key is specified, the default key is used.

Type: String

Length Constraints: Maximum length of 2147483647.

Required: No

Tags.Tag.N

A list of tag instances.

Type: Array of Tag objects

Required: No

Response Elements

The following element is returned by the service.

SnapshotCopyGrant

The snapshot copy grant that grants Amazon Redshift permission to encrypt copied snapshots with the specified encrypted symmetric key from Amazon KMS in the destination region.

For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.

Type: SnapshotCopyGrant object

Errors

For information about the errors that are common to all actions, see Common Errors.

DependentServiceRequestThrottlingFault

The request cannot be completed because a dependent service is throttling requests made by Amazon Redshift on your behalf. Wait and retry the request.

HTTP Status Code: 400

InvalidTagFault

The tag is invalid.

HTTP Status Code: 400

LimitExceededFault

The encryption key has exceeded its grant limit in Amazon KMS.

HTTP Status Code: 400

SnapshotCopyGrantAlreadyExistsFault

The snapshot copy grant can't be created because a grant with the same name already exists.

HTTP Status Code: 400

SnapshotCopyGrantQuotaExceededFault

The Amazon Web Services account has exceeded the maximum number of snapshot copy grants in this region.

HTTP Status Code: 400

TagLimitExceededFault

You have exceeded the number of tags allowed.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of CreateSnapshotCopyGrant.

Sample Request

https://redshift.us-east-2.amazonaws.com/ ?Action=CreateSnapshotCopyGrant &SnapshotCopyGrantName=mysnapshotcopygrantnew &SignatureMethod=HmacSHA256&SignatureVersion=4 &Version=2012-12-01 &X-Amz-Algorithm=AWS4-HMAC-SHA256 &X-Amz-Credential=AKIAIOSFODNN7EXAMPLE/20190817/us-east-2/redshift/aws4_request &X-Amz-Date=20190825T160000Z &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date &X-Amz-Signature=0aa1234bb5cc678ddddd901ee2ff3aa45678b90c12d345e6ff789012345a6b7b

Sample Response

<CreateSnapshotCopyGrantResponse xmlns="http://redshift.amazonaws.com/doc/2012-12-01/"> <CreateSnapshotCopyGrantResult> <SnapshotCopyGrant> <SnapshotCopyGrantName>mysnapshotcopygrantnew</SnapshotCopyGrantName> <KmsKeyId>arn:aws:kms:us-east-2:123456789012:key/bPxRfih3yCo8nvbEXAMPLEKEY</KmsKeyId> <Tags/> </SnapshotCopyGrant> </CreateSnapshotCopyGrantResult> <ResponseMetadata> <RequestId>085f3206-2837-11ea-9939-5fccefa818c0</RequestId> </ResponseMetadata> </CreateSnapshotCopyGrantResponse>

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: