Class UpdateAliasRequest

    • Constructor Detail

      • UpdateAliasRequest

        public UpdateAliasRequest()
    • Method Detail

      • setAliasName

        public void setAliasName​(String aliasName)

        String that contains the name of the alias to be modified. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/aws" are reserved.

        Parameters:
        aliasName - String that contains the name of the alias to be modified. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/aws" are reserved.
      • getAliasName

        public String getAliasName()

        String that contains the name of the alias to be modified. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/aws" are reserved.

        Returns:
        String that contains the name of the alias to be modified. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/aws" are reserved.
      • withAliasName

        public UpdateAliasRequest withAliasName​(String aliasName)

        String that contains the name of the alias to be modified. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/aws" are reserved.

        Parameters:
        aliasName - String that contains the name of the alias to be modified. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/aws" are reserved.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setTargetKeyId

        public void setTargetKeyId​(String targetKeyId)

        Unique identifier of the customer master key to be mapped to the alias. This value can be a globally unique identifier or the fully specified ARN of a key.

        • Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234 -1234-123456789012

        • Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

        You can call ListAliases to verify that the alias is mapped to the correct TargetKeyId.

        Parameters:
        targetKeyId - Unique identifier of the customer master key to be mapped to the alias. This value can be a globally unique identifier or the fully specified ARN of a key.

        • Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234 -1234-1234-123456789012

        • Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

        You can call ListAliases to verify that the alias is mapped to the correct TargetKeyId.

      • getTargetKeyId

        public String getTargetKeyId()

        Unique identifier of the customer master key to be mapped to the alias. This value can be a globally unique identifier or the fully specified ARN of a key.

        • Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234 -1234-123456789012

        • Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

        You can call ListAliases to verify that the alias is mapped to the correct TargetKeyId.

        Returns:
        Unique identifier of the customer master key to be mapped to the alias. This value can be a globally unique identifier or the fully specified ARN of a key.

        • Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678- 1234-1234-1234-123456789012

        • Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

        You can call ListAliases to verify that the alias is mapped to the correct TargetKeyId.

      • withTargetKeyId

        public UpdateAliasRequest withTargetKeyId​(String targetKeyId)

        Unique identifier of the customer master key to be mapped to the alias. This value can be a globally unique identifier or the fully specified ARN of a key.

        • Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234 -1234-123456789012

        • Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

        You can call ListAliases to verify that the alias is mapped to the correct TargetKeyId.

        Parameters:
        targetKeyId - Unique identifier of the customer master key to be mapped to the alias. This value can be a globally unique identifier or the fully specified ARN of a key.

        • Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234 -1234-1234-123456789012

        • Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

        You can call ListAliases to verify that the alias is mapped to the correct TargetKeyId.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • toString

        public String toString()
        Returns a string representation of this object; useful for testing and debugging.
        Overrides:
        toString in class Object
        Returns:
        A string representation of this object.
        See Also:
        Object.toString()
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object