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.

EncryptInput

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

type EncryptInput struct { EncryptionContext map[string]*string `type:"map"` GrantTokens []*string `type:"list"` KeyId *string `min:"1" type:"string" required:"true"` Plaintext []byte `min:"1" type:"blob" required:"true" sensitive:"true"` }

EncryptionContext

Type: map[string]*string

Name-value pair that specifies the encryption context to be used for authenticated encryption. If used here, the same value must be supplied to the Decrypt API or decryption will fail. For more information, see Encryption Context (https://docs.aws.amazon.com/kms/latest/developerguide/encryption-context.html).

GrantTokens

Type: []*string

A list of grant tokens.

For more information, see Grant Tokens (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token) in the AWS Key Management Service Developer Guide.

KeyId

Type: *string

A unique identifier for the customer master key (CMK).

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

KeyId is a required field

Plaintext

Type: []byte

Data to be encrypted.

Plaintext is automatically base64 encoded/decoded by the SDK.

Plaintext is a required field

Method

GoString

func (s EncryptInput) GoString() string

GoString returns the string representation

SetEncryptionContext

func (s *EncryptInput) SetEncryptionContext(v map[string]*string) *EncryptInput

SetEncryptionContext sets the EncryptionContext field's value.

SetGrantTokens

func (s *EncryptInput) SetGrantTokens(v []*string) *EncryptInput

SetGrantTokens sets the GrantTokens field's value.

SetKeyId

func (s *EncryptInput) SetKeyId(v string) *EncryptInput

SetKeyId sets the KeyId field's value.

SetPlaintext

func (s *EncryptInput) SetPlaintext(v []byte) *EncryptInput

SetPlaintext sets the Plaintext field's value.

String

func (s EncryptInput) String() string

String returns the string representation

Validate

func (s *EncryptInput) Validate() error

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

On this page: