com.amazonaws.services.redshift.model

Class CreateSnapshotCopyGrantRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.redshift.model.CreateSnapshotCopyGrantRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class CreateSnapshotCopyGrantRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the CreateSnapshotCopyGrant operation.

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 .

See Also:

AmazonRedshift.createSnapshotCopyGrant(CreateSnapshotCopyGrantRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateSnapshotCopyGrantRequest()

Method Summary

Methods

Modifier and Type	Method and Description
CreateSnapshotCopyGrantRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getKmsKeyId() The unique identifier of the customer master key (CMK) to which to grant Amazon Redshift permission.
String	getSnapshotCopyGrantName() The name of the snapshot copy grant.
List<Tag>	getTags() A list of tag instances.
int	hashCode()
void	setKmsKeyId(String kmsKeyId) The unique identifier of the customer master key (CMK) to which to grant Amazon Redshift permission.
void	setSnapshotCopyGrantName(String snapshotCopyGrantName) The name of the snapshot copy grant.
void	setTags(Collection<Tag> tags) A list of tag instances.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateSnapshotCopyGrantRequest	withKmsKeyId(String kmsKeyId) The unique identifier of the customer master key (CMK) to which to grant Amazon Redshift permission.
CreateSnapshotCopyGrantRequest	withSnapshotCopyGrantName(String snapshotCopyGrantName) The name of the snapshot copy grant.
CreateSnapshotCopyGrantRequest	withTags(Collection<Tag> tags) A list of tag instances.
CreateSnapshotCopyGrantRequest	withTags(Tag... tags) A list of tag instances.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateSnapshotCopyGrantRequest

public CreateSnapshotCopyGrantRequest()

Method Detail

getSnapshotCopyGrantName

public String getSnapshotCopyGrantName()

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.

Returns:

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.

setSnapshotCopyGrantName

public void setSnapshotCopyGrantName(String 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.

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.

withSnapshotCopyGrantName

public CreateSnapshotCopyGrantRequest withSnapshotCopyGrantName(String 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.

Returns a reference to this object so that method calls can be chained together.

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.

Returns:

A reference to this updated object so that method calls can be chained together.

getKmsKeyId

public String getKmsKeyId()

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.

Returns:

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.

setKmsKeyId

public void setKmsKeyId(String 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.

Parameters:

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.

withKmsKeyId

public CreateSnapshotCopyGrantRequest withKmsKeyId(String 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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

getTags

public List<Tag> getTags()

A list of tag instances.

Returns:

A list of tag instances.

setTags

public void setTags(Collection<Tag> tags)

A list of tag instances.

Parameters:

tags - A list of tag instances.

withTags

public CreateSnapshotCopyGrantRequest withTags(Tag... tags)

A list of tag instances.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Returns a reference to this object so that method calls can be chained together.

Parameters:

tags - A list of tag instances.

Returns:

A reference to this updated object so that method calls can be chained together.

withTags

public CreateSnapshotCopyGrantRequest withTags(Collection<Tag> tags)

A list of tag instances.

Returns a reference to this object so that method calls can be chained together.

Parameters:

tags - A list of tag instances.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public CreateSnapshotCopyGrantRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()