AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

UpdateAliasInput

import "github.com/aws/aws-sdk-go/service/kms"

type UpdateAliasInput struct { AliasName *string `min:"1" type:"string" required:"true"` TargetKeyId *string `min:"1" type:"string" required:"true"` }

AliasName

Type: *string

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.

AliasName is a required field

TargetKeyId

Type: *string

Unique identifier of the customer master key to be mapped to the alias.

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.

To verify that the alias is mapped to the correct CMK, use ListAliases.

TargetKeyId is a required field

Method

GoString

func (s UpdateAliasInput) GoString() string

GoString returns the string representation

SetAliasName

func (s *UpdateAliasInput) SetAliasName(v string) *UpdateAliasInput

SetAliasName sets the AliasName field's value.

SetTargetKeyId

func (s *UpdateAliasInput) SetTargetKeyId(v string) *UpdateAliasInput

SetTargetKeyId sets the TargetKeyId field's value.

String

func (s UpdateAliasInput) String() string

String returns the string representation

Validate

func (s *UpdateAliasInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: