Class CreateKeyRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
A flag to indicate whether to bypass the key policy lockout safety check.A description of the CMK.The intended use of the CMK.The key policy to attach to the CMK.int
hashCode()
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
The key policy to attach to the CMK.toString()
Returns a string representation of this object; useful for testing and debugging.withBypassPolicyLockoutSafetyCheck
(Boolean bypassPolicyLockoutSafetyCheck) A flag to indicate whether to bypass the key policy lockout safety check.withDescription
(String description) A description of the CMK.withKeyUsage
(KeyUsageType keyUsage) The intended use of the CMK.withKeyUsage
(String keyUsage) The intended use of the CMK.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
-
Constructor Details
-
CreateKeyRequest
public CreateKeyRequest()
-
-
Method Details
-
setPolicy
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
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
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
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
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
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
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:
-
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:
-
withKeyUsage
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:
-
setKeyUsage
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:
-
withKeyUsage
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:
-
setBypassPolicyLockoutSafetyCheck
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
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
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
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
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
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:
-