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
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description CreateKeyRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CreateKeyRequest
clone()
Creates a shallow clone of this request.boolean
equals(Object obj)
Boolean
getBypassPolicyLockoutSafetyCheck()
A flag to indicate whether to bypass the key policy lockout safety check.String
getDescription()
A description of the CMK.String
getKeyUsage()
The intended use of the CMK.String
getPolicy()
The key policy to attach to the CMK.int
hashCode()
Boolean
isBypassPolicyLockoutSafetyCheck()
A flag to indicate whether to bypass the key policy lockout safety check.void
setBypassPolicyLockoutSafetyCheck(Boolean bypassPolicyLockoutSafetyCheck)
A flag to indicate whether to bypass the key policy lockout safety check.void
setDescription(String description)
A description of the CMK.void
setKeyUsage(KeyUsageType keyUsage)
The intended use of the CMK.void
setKeyUsage(String keyUsage)
The intended use of the CMK.void
setPolicy(String policy)
The key policy to attach to the CMK.String
toString()
Returns a string representation of this object; useful for testing and debugging.CreateKeyRequest
withBypassPolicyLockoutSafetyCheck(Boolean bypassPolicyLockoutSafetyCheck)
A flag to indicate whether to bypass the key policy lockout safety check.CreateKeyRequest
withDescription(String description)
A description of the CMK.CreateKeyRequest
withKeyUsage(KeyUsageType keyUsage)
The intended use of the CMK.CreateKeyRequest
withKeyUsage(String keyUsage)
The intended use of the CMK.CreateKeyRequest
withPolicy(String policy)
The key policy to attach to the CMK.-
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
Method Detail
-
setPolicy
public void setPolicy(String policy)
The key policy to attach to the CMK.
If you specify a key policy, it must meet the following criteria:
-
It must allow the principal making the
CreateKey
request to make a subsequent PutKeyPolicy request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide. -
The principal(s) specified in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the IAM User Guide.
If you do not specify a policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
The policy size limit is 32 KiB (32768 bytes).
- Parameters:
policy
- The key policy to attach to the CMK.If you specify a key policy, it must meet the following criteria:
-
It must allow the principal making the
CreateKey
request to make a subsequent PutKeyPolicy request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide. -
The principal(s) specified in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the IAM User Guide.
If you do not specify a policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
The policy size limit is 32 KiB (32768 bytes).
-
-
-
getPolicy
public String getPolicy()
The key policy to attach to the CMK.
If you specify a key policy, it must meet the following criteria:
-
It must allow the principal making the
CreateKey
request to make a subsequent PutKeyPolicy request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide. -
The principal(s) specified in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the IAM User Guide.
If you do not specify a policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
The policy size limit is 32 KiB (32768 bytes).
- Returns:
- The key policy to attach to the CMK.
If you specify a key policy, it must meet the following criteria:
-
It must allow the principal making the
CreateKey
request to make a subsequent PutKeyPolicy request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide. -
The principal(s) specified in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the IAM User Guide.
If you do not specify a policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
The policy size limit is 32 KiB (32768 bytes).
-
-
-
withPolicy
public CreateKeyRequest withPolicy(String policy)
The key policy to attach to the CMK.
If you specify a key policy, it must meet the following criteria:
-
It must allow the principal making the
CreateKey
request to make a subsequent PutKeyPolicy request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide. -
The principal(s) specified in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the IAM User Guide.
If you do not specify a policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
The policy size limit is 32 KiB (32768 bytes).
- Parameters:
policy
- The key policy to attach to the CMK.If you specify a key policy, it must meet the following criteria:
-
It must allow the principal making the
CreateKey
request to make a subsequent PutKeyPolicy request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide. -
The principal(s) specified in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the IAM User Guide.
If you do not specify a policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
The policy size limit is 32 KiB (32768 bytes).
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
setDescription
public void setDescription(String description)
A description of the CMK.
Use a description that helps you decide whether the CMK is appropriate for a task.
- Parameters:
description
- A description of the CMK.Use a description that helps you decide whether the CMK is appropriate for a task.
-
getDescription
public String getDescription()
A description of the CMK.
Use a description that helps you decide whether the CMK is appropriate for a task.
- Returns:
- A description of the CMK.
Use a description that helps you decide whether the CMK is appropriate for a task.
-
withDescription
public CreateKeyRequest withDescription(String description)
A description of the CMK.
Use a description that helps you decide whether the CMK is appropriate for a task.
- Parameters:
description
- A description of the CMK.Use a description that helps you decide whether the CMK is appropriate for a task.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setKeyUsage
public void setKeyUsage(String keyUsage)
The intended use of the CMK.
You can use CMKs only for symmetric encryption and decryption.
- Parameters:
keyUsage
- The intended use of the CMK.You can use CMKs only for symmetric encryption and decryption.
- See Also:
KeyUsageType
-
getKeyUsage
public String getKeyUsage()
The intended use of the CMK.
You can use CMKs only for symmetric encryption and decryption.
- Returns:
- The intended use of the CMK.
You can use CMKs only for symmetric encryption and decryption.
- See Also:
KeyUsageType
-
withKeyUsage
public CreateKeyRequest withKeyUsage(String keyUsage)
The intended use of the CMK.
You can use CMKs only for symmetric encryption and decryption.
- Parameters:
keyUsage
- The intended use of the CMK.You can use CMKs only for symmetric encryption and decryption.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
KeyUsageType
-
setKeyUsage
public void setKeyUsage(KeyUsageType keyUsage)
The intended use of the CMK.
You can use CMKs only for symmetric encryption and decryption.
- Parameters:
keyUsage
- The intended use of the CMK.You can use CMKs only for symmetric encryption and decryption.
- See Also:
KeyUsageType
-
withKeyUsage
public CreateKeyRequest withKeyUsage(KeyUsageType keyUsage)
The intended use of the CMK.
You can use CMKs only for symmetric encryption and decryption.
- Parameters:
keyUsage
- The intended use of the CMK.You can use CMKs only for symmetric encryption and decryption.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
KeyUsageType
-
setBypassPolicyLockoutSafetyCheck
public void setBypassPolicyLockoutSafetyCheck(Boolean bypassPolicyLockoutSafetyCheck)
A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the likelihood that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.
Use this parameter only when you include a policy in the request and you intend to prevent the principal making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.
- Parameters:
bypassPolicyLockoutSafetyCheck
- A flag to indicate whether to bypass the key policy lockout safety check.Setting this value to true increases the likelihood that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.
Use this parameter only when you include a policy in the request and you intend to prevent the principal making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.
-
getBypassPolicyLockoutSafetyCheck
public Boolean getBypassPolicyLockoutSafetyCheck()
A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the likelihood that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.
Use this parameter only when you include a policy in the request and you intend to prevent the principal making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.
- Returns:
- A flag to indicate whether to bypass the key policy lockout
safety check.
Setting this value to true increases the likelihood that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.
Use this parameter only when you include a policy in the request and you intend to prevent the principal making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.
-
withBypassPolicyLockoutSafetyCheck
public CreateKeyRequest withBypassPolicyLockoutSafetyCheck(Boolean bypassPolicyLockoutSafetyCheck)
A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the likelihood that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.
Use this parameter only when you include a policy in the request and you intend to prevent the principal making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.
- Parameters:
bypassPolicyLockoutSafetyCheck
- A flag to indicate whether to bypass the key policy lockout safety check.Setting this value to true increases the likelihood that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.
Use this parameter only when you include a policy in the request and you intend to prevent the principal making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isBypassPolicyLockoutSafetyCheck
public Boolean isBypassPolicyLockoutSafetyCheck()
A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the likelihood that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.
Use this parameter only when you include a policy in the request and you intend to prevent the principal making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.
- Returns:
- A flag to indicate whether to bypass the key policy lockout
safety check.
Setting this value to true increases the likelihood that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.
Use this parameter only when you include a policy in the request and you intend to prevent the principal making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
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 classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-