Menu
Amazon Redshift
API Reference (API Version 2012-12-01)

CreateSnapshotCopyGrant

Creates a snapshot copy grant that permits Amazon Redshift to use a customer master key (CMK) from AWS Key Management Service (AWS 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 AWS 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 AWS account.

Type: String

Required: Yes

KmsKeyId

The unique identifier of the customer master key (CMK) to which to grant Amazon Redshift permission. If no key is specified, the default key is used.

Type: String

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 customer master key (CMK) from AWS 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 AWS 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 AWS account has exceeded the maximum number of snapshot copy grants in this region.

HTTP Status Code: 400

TagLimitExceededFault

The request exceeds the limit of 10 tags for the resource.

HTTP Status Code: 400

See Also

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