com.amazonaws.services.kms.model

Class CreateKeyRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kms.model.CreateKeyRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class CreateKeyRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the CreateKey operation.

Creates a customer master key. Customer master keys can be used to encrypt small amounts of data (less than 4K) directly, but they are most commonly used to encrypt or envelope data keys that are then used to encrypt customer data. For more information about data keys, see GenerateDataKey and GenerateDataKeyWithoutPlaintext.

See Also:

AWSKMS.createKey(CreateKeyRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateKeyRequest()

Method Summary

Methods

Modifier and Type	Method and Description
CreateKeyRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getDescription() Description of the key.
String	getKeyUsage() Specifies the intended use of the key.
String	getPolicy() Policy to be attached to the key.
int	hashCode()
void	setDescription(String description) Description of the key.
void	setKeyUsage(KeyUsageType keyUsage) Specifies the intended use of the key.
void	setKeyUsage(String keyUsage) Specifies the intended use of the key.
void	setPolicy(String policy) Policy to be attached to the key.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateKeyRequest	withDescription(String description) Description of the key.
CreateKeyRequest	withKeyUsage(KeyUsageType keyUsage) Specifies the intended use of the key.
CreateKeyRequest	withKeyUsage(String keyUsage) Specifies the intended use of the key.
CreateKeyRequest	withPolicy(String policy) Policy to be attached to the key.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateKeyRequest

public CreateKeyRequest()

Method Detail

getPolicy

public String getPolicy()

Policy to be attached to the key. This is required and delegates back to the account. The key is the root of trust.

Constraints:
Length: 1 - 131072
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+

Returns:

Policy to be attached to the key. This is required and delegates back to the account. The key is the root of trust.

setPolicy

public void setPolicy(String policy)

Policy to be attached to the key. This is required and delegates back to the account. The key is the root of trust.

Constraints:
Length: 1 - 131072
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+

Parameters:

policy - Policy to be attached to the key. This is required and delegates back to the account. The key is the root of trust.

withPolicy

public CreateKeyRequest withPolicy(String policy)

Policy to be attached to the key. This is required and delegates back to the account. The key is the root of trust.

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

Constraints:
Length: 1 - 131072
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+

Parameters:

policy - Policy to be attached to the key. This is required and delegates back to the account. The key is the root of trust.

Returns:

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

getDescription

public String getDescription()

Description of the key. We recommend that you choose a description that helps your customer decide whether the key is appropriate for a task.

Constraints:
Length: 0 - 8192

Returns:

Description of the key. We recommend that you choose a description that helps your customer decide whether the key is appropriate for a task.

setDescription

public void setDescription(String description)

Description of the key. We recommend that you choose a description that helps your customer decide whether the key is appropriate for a task.

Constraints:
Length: 0 - 8192

Parameters:

description - Description of the key. We recommend that you choose a description that helps your customer decide whether the key is appropriate for a task.

withDescription

public CreateKeyRequest withDescription(String description)

Description of the key. We recommend that you choose a description that helps your customer decide whether the key is appropriate for a task.

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

Constraints:
Length: 0 - 8192

Parameters:

description - Description of the key. We recommend that you choose a description that helps your customer decide whether the key is appropriate for a task.

Returns:

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

getKeyUsage

public String getKeyUsage()

Specifies the intended use of the key. Currently this defaults to ENCRYPT/DECRYPT, and only symmetric encryption and decryption are supported.

Constraints:
Allowed Values: ENCRYPT_DECRYPT

Returns:

Specifies the intended use of the key. Currently this defaults to ENCRYPT/DECRYPT, and only symmetric encryption and decryption are supported.

See Also:

KeyUsageType

setKeyUsage

public void setKeyUsage(String keyUsage)

Specifies the intended use of the key. Currently this defaults to ENCRYPT/DECRYPT, and only symmetric encryption and decryption are supported.

Constraints:
Allowed Values: ENCRYPT_DECRYPT

Parameters:

keyUsage - Specifies the intended use of the key. Currently this defaults to ENCRYPT/DECRYPT, and only symmetric encryption and decryption are supported.

See Also:

KeyUsageType

withKeyUsage

public CreateKeyRequest withKeyUsage(String keyUsage)

Specifies the intended use of the key. Currently this defaults to ENCRYPT/DECRYPT, and only symmetric encryption and decryption are supported.

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

Constraints:
Allowed Values: ENCRYPT_DECRYPT

Parameters:

keyUsage - Specifies the intended use of the key. Currently this defaults to ENCRYPT/DECRYPT, and only symmetric encryption and decryption are supported.

Returns:

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

See Also:

KeyUsageType

setKeyUsage

public void setKeyUsage(KeyUsageType keyUsage)

Specifies the intended use of the key. Currently this defaults to ENCRYPT/DECRYPT, and only symmetric encryption and decryption are supported.

Constraints:
Allowed Values: ENCRYPT_DECRYPT

Parameters:

keyUsage - Specifies the intended use of the key. Currently this defaults to ENCRYPT/DECRYPT, and only symmetric encryption and decryption are supported.

See Also:

KeyUsageType

withKeyUsage

public CreateKeyRequest withKeyUsage(KeyUsageType keyUsage)

Specifies the intended use of the key. Currently this defaults to ENCRYPT/DECRYPT, and only symmetric encryption and decryption are supported.

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

Constraints:
Allowed Values: ENCRYPT_DECRYPT

Parameters:

keyUsage - Specifies the intended use of the key. Currently this defaults to ENCRYPT/DECRYPT, and only symmetric encryption and decryption are supported.

Returns:

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

See Also:

KeyUsageType

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 CreateKeyRequest 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()