@Generated(value="software.amazon.awssdk:codegen") public final class CreateAliasRequest extends KmsRequest implements ToCopyableBuilder<CreateAliasRequest.Builder,CreateAliasRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
CreateAliasRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
String |
aliasName()
Specifies the alias name.
|
static CreateAliasRequest.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
List<SdkField<?>> |
sdkFields() |
static Class<? extends CreateAliasRequest.Builder> |
serializableBuilderClass() |
String |
targetKeyId()
Associates the alias with the specified customer managed CMK.
|
CreateAliasRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String aliasName()
Specifies the alias name. This value must begin with alias/ followed by a name, such as
alias/ExampleAlias.
The AliasName value must be string of 1-256 characters. It can contain only alphanumeric characters,
forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with alias/aws/.
The alias/aws/ prefix is reserved for AWS managed CMKs.
alias/ followed by a name, such as
alias/ExampleAlias.
The AliasName value must be string of 1-256 characters. It can contain only alphanumeric
characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with
alias/aws/. The alias/aws/ prefix is reserved for AWS managed
CMKs.
public final String targetKeyId()
Associates the alias with the specified customer managed CMK. The CMK must be in the same AWS Region.
A valid CMK ID is required. If you supply a null or empty string value, this operation returns an error.
For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
A valid CMK ID is required. If you supply a null or empty string value, this operation returns an error.
For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
public CreateAliasRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<CreateAliasRequest.Builder,CreateAliasRequest>toBuilder in class KmsRequestpublic static CreateAliasRequest.Builder builder()
public static Class<? extends CreateAliasRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2021. All rights reserved.