public static interface CreateKeyRequest.Builder extends KmsRequest.Builder, SdkPojo, CopyableBuilder<CreateKeyRequest.Builder,CreateKeyRequest>
| Modifier and Type | Method and Description |
|---|---|
CreateKeyRequest.Builder |
bypassPolicyLockoutSafetyCheck(Boolean bypassPolicyLockoutSafetyCheck)
A flag to indicate whether to bypass the key policy lockout safety check.
|
CreateKeyRequest.Builder |
customKeyStoreId(String customKeyStoreId)
Creates the CMK in the specified custom key store and
the key material in its associated AWS CloudHSM cluster.
|
CreateKeyRequest.Builder |
description(String description)
A description of the CMK.
|
CreateKeyRequest.Builder |
keyUsage(KeyUsageType keyUsage)
The intended use of the CMK.
|
CreateKeyRequest.Builder |
keyUsage(String keyUsage)
The intended use of the CMK.
|
CreateKeyRequest.Builder |
origin(OriginType origin)
The source of the CMK's key material.
|
CreateKeyRequest.Builder |
origin(String origin)
The source of the CMK's key material.
|
CreateKeyRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
CreateKeyRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
CreateKeyRequest.Builder |
policy(String policy)
The key policy to attach to the CMK.
|
CreateKeyRequest.Builder |
tags(Collection<Tag> tags)
One or more tags.
|
CreateKeyRequest.Builder |
tags(Consumer<Tag.Builder>... tags)
One or more tags.
|
CreateKeyRequest.Builder |
tags(Tag... tags)
One or more tags.
|
buildoverrideConfigurationcopyapplyMutation, buildCreateKeyRequest.Builder policy(String policy)
The key policy to attach to the CMK.
If you provide a key policy, it must meet the following criteria:
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal
that is making the CreateKey request to make a subsequent PutKeyPolicy request on the
CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in
the Default Key Policy section of the AWS Key Management Service Developer Guide.
Each statement in the key policy must contain one or more principals. The principals 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 including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
If you do not provide a key 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 key policy size limit is 32 kilobytes (32768 bytes).
policy - The key policy to attach to the CMK.
If you provide a key policy, it must meet the following criteria:
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the
principal that is making the CreateKey request to make a subsequent PutKeyPolicy
request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information,
refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide.
Each statement in the key policy must contain one or more principals. The principals 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 including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
If you do not provide a key 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 key policy size limit is 32 kilobytes (32768 bytes).
CreateKeyRequest.Builder description(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.
CreateKeyRequest.Builder keyUsage(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,
KeyUsageTypeCreateKeyRequest.Builder keyUsage(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,
KeyUsageTypeCreateKeyRequest.Builder origin(String origin)
The source of the CMK's key material. You cannot change the origin after you create the CMK.
The default is AWS_KMS, which means AWS KMS creates the key material in its own key store.
When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can
import key material from your existing key management infrastructure. For more information about importing
key material into AWS KMS, see Importing Key Material in
the AWS Key Management Service Developer Guide.
When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in a AWS KMS custom key store and
creates its key material in the associated AWS CloudHSM cluster. You must also use the
CustomKeyStoreId parameter to identify the custom key store.
origin - The source of the CMK's key material. You cannot change the origin after you create the CMK.
The default is AWS_KMS, which means AWS KMS creates the key material in its own key
store.
When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that
you can import key material from your existing key management infrastructure. For more information
about importing key material into AWS KMS, see Importing Key
Material in the AWS Key Management Service Developer Guide.
When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in a AWS KMS custom key
store and creates its key material in the associated AWS CloudHSM cluster. You must also use the
CustomKeyStoreId parameter to identify the custom key store.
OriginType,
OriginTypeCreateKeyRequest.Builder origin(OriginType origin)
The source of the CMK's key material. You cannot change the origin after you create the CMK.
The default is AWS_KMS, which means AWS KMS creates the key material in its own key store.
When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can
import key material from your existing key management infrastructure. For more information about importing
key material into AWS KMS, see Importing Key Material in
the AWS Key Management Service Developer Guide.
When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in a AWS KMS custom key store and
creates its key material in the associated AWS CloudHSM cluster. You must also use the
CustomKeyStoreId parameter to identify the custom key store.
origin - The source of the CMK's key material. You cannot change the origin after you create the CMK.
The default is AWS_KMS, which means AWS KMS creates the key material in its own key
store.
When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that
you can import key material from your existing key management infrastructure. For more information
about importing key material into AWS KMS, see Importing Key
Material in the AWS Key Management Service Developer Guide.
When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in a AWS KMS custom key
store and creates its key material in the associated AWS CloudHSM cluster. You must also use the
CustomKeyStoreId parameter to identify the custom key store.
OriginType,
OriginTypeCreateKeyRequest.Builder customKeyStoreId(String customKeyStoreId)
Creates the CMK in the specified custom key store and
the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also
specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster
that is associated with the custom key store must have at least two active HSMs, each in a different
Availability Zone in the Region.
To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
customKeyStoreId - Creates the CMK in the specified custom key
store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key
store, you must also specify the Origin parameter with a value of
AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must
have at least two active HSMs, each in a different Availability Zone in the Region.
To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
CreateKeyRequest.Builder bypassPolicyLockoutSafetyCheck(Boolean bypassPolicyLockoutSafetyCheck)
A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the risk 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 that is 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 risk 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 that is making the request from making a subsequent PutKeyPolicy request on the CMK.
The default value is false.
CreateKeyRequest.Builder tags(Collection<Tag> tags)
One or more tags. Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.
Use this parameter to tag the CMK when it is created. Alternately, you can omit this parameter and instead tag the CMK after it is created using TagResource.
tags - One or more tags. Each tag consists of a tag key and a tag value. Tag keys and tag values are both
required, but tag values can be empty (null) strings.
Use this parameter to tag the CMK when it is created. Alternately, you can omit this parameter and instead tag the CMK after it is created using TagResource.
CreateKeyRequest.Builder tags(Tag... tags)
One or more tags. Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.
Use this parameter to tag the CMK when it is created. Alternately, you can omit this parameter and instead tag the CMK after it is created using TagResource.
tags - One or more tags. Each tag consists of a tag key and a tag value. Tag keys and tag values are both
required, but tag values can be empty (null) strings.
Use this parameter to tag the CMK when it is created. Alternately, you can omit this parameter and instead tag the CMK after it is created using TagResource.
CreateKeyRequest.Builder tags(Consumer<Tag.Builder>... tags)
One or more tags. Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.
Use this parameter to tag the CMK when it is created. Alternately, you can omit this parameter and instead tag the CMK after it is created using TagResource.
This is a convenience that creates an instance of theList.Builder avoiding the need to create
one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately and its result
is passed to #tags(List) .tags - a consumer that will call methods on List.Builder #tags(List) CreateKeyRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderoverrideConfiguration - The override configuration.CreateKeyRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderbuilderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.