@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 key.
|
CreateAliasRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfiguration
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public 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 Amazon Web Services
managed keys.
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 Amazon Web
Services managed keys.
public final String targetKeyId()
Associates the alias with the specified customer managed key. The KMS key must be in the same Amazon Web Services Region.
A valid key 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 Key Management Service Developer Guide .
Specify the key ID or key ARN of the KMS key.
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 KMS key, use ListKeys or DescribeKey.
A valid key 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 Key Management Service Developer Guide .
Specify the key ID or key ARN of the KMS key.
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 KMS key, use ListKeys or DescribeKey.
public CreateAliasRequest.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<CreateAliasRequest.Builder,CreateAliasRequest>
toBuilder
in class KmsRequest
public static CreateAliasRequest.Builder builder()
public static Class<? extends CreateAliasRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkRequest
Copyright © 2022. All rights reserved.