CreateKeyRequest (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.kms.model.KMSRequest
    - - software.amazon.awssdk.services.kms.model.CreateKeyRequest

All Implemented Interfaces:: ToCopyableBuilder<CreateKeyRequest.Builder,CreateKeyRequest>

@Generated(value="software.amazon.awssdk:codegen")
public class CreateKeyRequest
extends KMSRequest
implements ToCopyableBuilder<CreateKeyRequest.Builder,CreateKeyRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateKeyRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateKeyRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CreateKeyRequest.Builder`	`builder()`
`Boolean`	`bypassPolicyLockoutSafetyCheck()` A flag to indicate whether to bypass the key policy lockout safety check.
`String`	`description()` A description of the CMK.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`int`	`hashCode()`
`KeyUsageType`	`keyUsage()` The intended use of the CMK.
`String`	`keyUsageAsString()` The intended use of the CMK.
`OriginType`	`origin()` The source of the CMK's key material.
`String`	`originAsString()` The source of the CMK's key material.
`String`	`policy()` The key policy to attach to the CMK.
`static Class<? extends CreateKeyRequest.Builder>`	`serializableBuilderClass()`
`List<Tag>`	`tags()` One or more tags.
`CreateKeyRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
requestOverrideConfig

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - policy
```
public String policy()
```
    The key policy to attach to the CMK.
    
    If you specify a policy and do not set BypassPolicyLockoutSafetyCheck to true, the policy must meet the following criteria:
    - It must allow the principal that is 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 principals that are 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 kilobytes (32768 bytes).
    Returns:
    The key policy to attach to the CMK.
    
    If you specify a policy and do not set BypassPolicyLockoutSafetyCheck to true, the policy must meet the following criteria:
    
    It must allow the principal that is 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 principals that are 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 kilobytes (32768 bytes).
  - description
```
public String description()
```
    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.
  - keyUsage
```
public KeyUsageType keyUsage()
```
    The intended use of the CMK.
    
    You can use CMKs only for symmetric encryption and decryption.
    
    If the service returns an enum value that is not available in the current SDK version, keyUsage will return KeyUsageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyUsageAsString().
    
    Returns:
    
    The intended use of the CMK.
    
    You can use CMKs only for symmetric encryption and decryption.
    
    See Also:
    
    KeyUsageType
  - keyUsageAsString
```
public String keyUsageAsString()
```
    The intended use of the CMK.
    
    You can use CMKs only for symmetric encryption and decryption.
    
    If the service returns an enum value that is not available in the current SDK version, keyUsage will return KeyUsageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyUsageAsString().
    
    Returns:
    
    The intended use of the CMK.
    
    You can use CMKs only for symmetric encryption and decryption.
    
    See Also:
    
    KeyUsageType
  - origin
```
public OriginType origin()
```
    The source of the CMK's key material.
    
    The default is AWS_KMS, which means AWS KMS creates the key material. When this parameter is set to EXTERNAL, the request 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.
    
    The CMK's Origin is immutable and is set when the CMK is created.
    
    If the service returns an enum value that is not available in the current SDK version, origin will return OriginType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from originAsString().
    
    Returns:
    
    The source of the CMK's key material.
    
    The default is AWS_KMS, which means AWS KMS creates the key material. When this parameter is set to EXTERNAL, the request 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.
    
    The CMK's Origin is immutable and is set when the CMK is created.
    
    See Also:
    
    OriginType
  - originAsString
```
public String originAsString()
```
    The source of the CMK's key material.
    
    The default is AWS_KMS, which means AWS KMS creates the key material. When this parameter is set to EXTERNAL, the request 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.
    
    The CMK's Origin is immutable and is set when the CMK is created.
    
    If the service returns an enum value that is not available in the current SDK version, origin will return OriginType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from originAsString().
    
    Returns:
    
    The source of the CMK's key material.
    
    The default is AWS_KMS, which means AWS KMS creates the key material. When this parameter is set to EXTERNAL, the request 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.
    
    The CMK's Origin is immutable and is set when the CMK is created.
    
    See Also:
    
    OriginType
  - bypassPolicyLockoutSafetyCheck
```
public 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 that is 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 that is making the request from making a subsequent PutKeyPolicy request on the CMK.
    
    The default value is false.
  - tags
```
public List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    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.
  - toBuilder
```
public CreateKeyRequest.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateKeyRequest.Builder,CreateKeyRequest>
    
    Specified by:
    
    toBuilder in class KMSRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static CreateKeyRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateKeyRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value

Class CreateKeyRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

policy

description

keyUsage

keyUsageAsString

origin

originAsString

bypassPolicyLockoutSafetyCheck

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField