public class CreateKeyRequest extends AmazonWebServiceRequest implements java.io.Serializable, java.lang.Cloneable
Modifier and Type | Field and Description |
---|---|
private java.lang.Boolean |
bypassPolicyLockoutSafetyCheck
A flag to indicate whether to bypass the key policy lockout safety check.
|
private java.lang.String |
description
A description of the CMK.
|
private java.lang.String |
keyUsage
The intended use of the CMK.
|
private java.lang.String |
policy
The key policy to attach to the CMK.
|
NOOP
Constructor and Description |
---|
CreateKeyRequest() |
Modifier and Type | Method and Description |
---|---|
CreateKeyRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(java.lang.Object obj) |
java.lang.Boolean |
getBypassPolicyLockoutSafetyCheck()
A flag to indicate whether to bypass the key policy lockout safety check.
|
java.lang.String |
getDescription()
A description of the CMK.
|
java.lang.String |
getKeyUsage()
The intended use of the CMK.
|
java.lang.String |
getPolicy()
The key policy to attach to the CMK.
|
int |
hashCode() |
java.lang.Boolean |
isBypassPolicyLockoutSafetyCheck()
A flag to indicate whether to bypass the key policy lockout safety check.
|
void |
setBypassPolicyLockoutSafetyCheck(java.lang.Boolean bypassPolicyLockoutSafetyCheck)
A flag to indicate whether to bypass the key policy lockout safety check.
|
void |
setDescription(java.lang.String description)
A description of the CMK.
|
void |
setKeyUsage(KeyUsageType keyUsage)
The intended use of the CMK.
|
void |
setKeyUsage(java.lang.String keyUsage)
The intended use of the CMK.
|
void |
setPolicy(java.lang.String policy)
The key policy to attach to the CMK.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
CreateKeyRequest |
withBypassPolicyLockoutSafetyCheck(java.lang.Boolean bypassPolicyLockoutSafetyCheck)
A flag to indicate whether to bypass the key policy lockout safety check.
|
CreateKeyRequest |
withDescription(java.lang.String description)
A description of the CMK.
|
CreateKeyRequest |
withKeyUsage(KeyUsageType keyUsage)
The intended use of the CMK.
|
CreateKeyRequest |
withKeyUsage(java.lang.String keyUsage)
The intended use of the CMK.
|
CreateKeyRequest |
withPolicy(java.lang.String policy)
The key policy to attach to the CMK.
|
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
private java.lang.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).
private java.lang.String description
A description of the CMK.
Use a description that helps you decide whether the CMK is appropriate for a task.
private java.lang.String keyUsage
The intended use of the CMK.
You can use CMKs only for symmetric encryption and decryption.
private java.lang.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.
public void setPolicy(java.lang.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).
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).
public java.lang.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).
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).
public CreateKeyRequest withPolicy(java.lang.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).
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).
public void setDescription(java.lang.String description)
A description of the CMK.
Use a description that helps you decide whether the CMK is appropriate for a task.
description
- A description of the CMK.
Use a description that helps you decide whether the CMK is appropriate for a task.
public java.lang.String getDescription()
A description of the CMK.
Use a description that helps you decide whether the CMK is appropriate for a task.
Use a description that helps you decide whether the CMK is appropriate for a task.
public CreateKeyRequest withDescription(java.lang.String description)
A description of the CMK.
Use a description that helps you decide whether the CMK is appropriate for a task.
description
- A description of the CMK.
Use a description that helps you decide whether the CMK is appropriate for a task.
public void setKeyUsage(java.lang.String keyUsage)
The intended use of the CMK.
You can use CMKs only for symmetric encryption and decryption.
keyUsage
- The intended use of the CMK.
You can use CMKs only for symmetric encryption and decryption.
KeyUsageType
public java.lang.String getKeyUsage()
The intended use of the CMK.
You can use CMKs only for symmetric encryption and decryption.
You can use CMKs only for symmetric encryption and decryption.
KeyUsageType
public CreateKeyRequest withKeyUsage(java.lang.String keyUsage)
The intended use of the CMK.
You can use CMKs only for symmetric encryption and decryption.
keyUsage
- The intended use of the CMK.
You can use CMKs only for symmetric encryption and decryption.
KeyUsageType
public void setKeyUsage(KeyUsageType keyUsage)
The intended use of the CMK.
You can use CMKs only for symmetric encryption and decryption.
keyUsage
- The intended use of the CMK.
You can use CMKs only for symmetric encryption and decryption.
KeyUsageType
public CreateKeyRequest withKeyUsage(KeyUsageType keyUsage)
The intended use of the CMK.
You can use CMKs only for symmetric encryption and decryption.
keyUsage
- The intended use of the CMK.
You can use CMKs only for symmetric encryption and decryption.
KeyUsageType
public void setBypassPolicyLockoutSafetyCheck(java.lang.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.
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.
public java.lang.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.
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.
public CreateKeyRequest withBypassPolicyLockoutSafetyCheck(java.lang.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.
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.
public java.lang.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.
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.
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public CreateKeyRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()