Struct: kms.UpdateAliasInput

import "../ibm-cos-sdk-go/service/kms"

Implemented Interfaces

s3crypto.Cipher, s3manager.ReadSeekerWriteTo, request.Validator, s3manager.WriterReadFrom

Structure Field Summary

• AliasName *string

  Identifies the alias that is changing its KMS key.

• TargetKeyId *string

  Identifies the customer managed key (docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk) to associate with the alias.

• _ struct{}

Service Operations

• GoString() string operation

  GoString returns the string representation.

• SetAliasName(string) *UpdateAliasInput operation

  SetAliasName sets the AliasName field's value.

• SetTargetKeyId(string) *UpdateAliasInput operation

  SetTargetKeyId sets the TargetKeyId field's value.

• String() string operation

  String returns the string representation.

• Validate() error operation

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

Structure Field Details

AliasName *string `min:"1" type:"string" required:"true"`

Identifies the alias that is changing its KMS key. This value must begin with alias/ followed by the alias name, such as alias/ExampleAlias. You cannot use UpdateAlias to change the alias name.

Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

AliasName is a required field

TargetKeyId *string `min:"1" type:"string" required:"true"`

Identifies the customer managed key (docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk) to associate with the alias. You don't have permission to associate an alias with an Amazon Web Services managed key (docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk).

The KMS key must be in the same Amazon Web Services account and Region as the alias. Also, the new target KMS key must be the same type as the current target KMS key (both symmetric or both asymmetric or both HMAC) and they must have the same key usage.

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.

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

TargetKeyId is a required field

_ struct{} `type:"structure"`

Method Details

func (s UpdateAliasInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as “sensitive” in the API will not be included in the string output. The member name will be present, but the value will be replaced with “sensitive”.

// File 'service/kms/api.go', line 16946

func (s UpdateAliasInput) GoString() string {
	return s.String()
}

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

SetAliasName sets the AliasName field's value.

// File 'service/kms/api.go', line 16973

func (s *UpdateAliasInput) SetAliasName(v string) *UpdateAliasInput {
	s.AliasName = &v
	return s
}

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

SetTargetKeyId sets the TargetKeyId field's value.

// File 'service/kms/api.go', line 16979

func (s *UpdateAliasInput) SetTargetKeyId(v string) *UpdateAliasInput {
	s.TargetKeyId = &v
	return s
}

func (s UpdateAliasInput) String() string

String returns the string representation.

API parameter values that are decorated as “sensitive” in the API will not be included in the string output. The member name will be present, but the value will be replaced with “sensitive”.

// File 'service/kms/api.go', line 16937

func (s UpdateAliasInput) String() string {
	return awsutil.Prettify(s)
}

func (s *UpdateAliasInput) Validate() error

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

// File 'service/kms/api.go', line 16951

func (s *UpdateAliasInput) Validate() error {
	invalidParams := request.ErrInvalidParams{Context: "UpdateAliasInput"}
	if s.AliasName == nil {
		invalidParams.Add(request.NewErrParamRequired("AliasName"))
	}
	if s.AliasName != nil && len(*s.AliasName) < 1 {
		invalidParams.Add(request.NewErrParamMinLen("AliasName", 1))
	}
	if s.TargetKeyId == nil {
		invalidParams.Add(request.NewErrParamRequired("TargetKeyId"))
	}
	if s.TargetKeyId != nil && len(*s.TargetKeyId) < 1 {
		invalidParams.Add(request.NewErrParamMinLen("TargetKeyId", 1))
	}

	if invalidParams.Len() > 0 {
		return invalidParams
	}
	return nil
}