Documentation ¶
Overview ¶
Package kms provides the client and types for making API requests to AWS Key Management Service.
AWS Key Management Service (AWS KMS) is an encryption and key management web service. This guide describes the AWS KMS operations that you can call programmatically. For general information about AWS KMS, see the AWS Key Management Service Developer Guide (http://docs.aws.amazon.com/kms/latest/developerguide/).
AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWS KMS and other AWS services. For example, the SDKs take care of tasks such as signing requests (see below), managing errors, and retrying requests automatically. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services (http://aws.amazon.com/tools/).
We recommend that you use the AWS SDKs to make programmatic API calls to AWS KMS.
Clients must support TLS (Transport Layer Security) 1.0. We recommend TLS 1.2. Clients must also support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral Diffie-Hellman (DHE) or Elliptic Curve Ephemeral Diffie-Hellman (ECDHE). Most modern systems such as Java 7 and later support these modes.
Signing Requests ¶
Requests must be signed by using an access key ID and a secret access key. We strongly recommend that you do not use your AWS account (root) access key ID and secret key for everyday work with AWS KMS. Instead, use the access key ID and secret access key for an IAM user, or you can use the AWS Security Token Service to generate temporary security credentials that you can use to sign requests.
All AWS KMS operations require Signature Version 4 (http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).
Logging API Requests ¶
AWS KMS supports AWS CloudTrail, a service that logs AWS API calls and related events for your AWS account and delivers them to an Amazon S3 bucket that you specify. By using the information collected by CloudTrail, you can determine what requests were made to AWS KMS, who made the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User Guide (http://docs.aws.amazon.com/awscloudtrail/latest/userguide/).
Additional Resources ¶
For more information about credentials and request signing, see the following:
AWS Security Credentials (http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html)
This topic provides general information about the types of credentials used for accessing AWS.
Temporary Security Credentials (http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html)
This section of the IAM User Guide describes how to create and use temporary security credentials.
Signature Version 4 Signing Process (http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html)
This set of topics walks you through the process of signing a request using an access key ID and a secret access key.
Commonly Used APIs ¶
Of the APIs discussed in this guide, the following will prove the most useful for most applications. You will likely perform actions other than these, such as creating keys and assigning policies, by using the console.
Encrypt
Decrypt
GenerateDataKey
GenerateDataKeyWithoutPlaintext
See https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01 for more information on this service.
See kms package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/kms/
Using the Client ¶
To AWS Key Management Service with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.
See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/
See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
See the AWS Key Management Service client KMS for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/kms/#New
Index ¶
- Constants
- type AlgorithmSpec
- type AliasListEntry
- type CancelKeyDeletionInput
- type CancelKeyDeletionOutput
- type CancelKeyDeletionRequest
- type CreateAliasInput
- type CreateAliasOutput
- type CreateAliasRequest
- type CreateGrantInput
- func (s CreateGrantInput) GoString() string
- func (s *CreateGrantInput) SetConstraints(v *GrantConstraints) *CreateGrantInput
- func (s *CreateGrantInput) SetGrantTokens(v []string) *CreateGrantInput
- func (s *CreateGrantInput) SetGranteePrincipal(v string) *CreateGrantInput
- func (s *CreateGrantInput) SetKeyId(v string) *CreateGrantInput
- func (s *CreateGrantInput) SetName(v string) *CreateGrantInput
- func (s *CreateGrantInput) SetOperations(v []GrantOperation) *CreateGrantInput
- func (s *CreateGrantInput) SetRetiringPrincipal(v string) *CreateGrantInput
- func (s CreateGrantInput) String() string
- func (s *CreateGrantInput) Validate() error
- type CreateGrantOutput
- type CreateGrantRequest
- type CreateKeyInput
- func (s CreateKeyInput) GoString() string
- func (s *CreateKeyInput) SetBypassPolicyLockoutSafetyCheck(v bool) *CreateKeyInput
- func (s *CreateKeyInput) SetDescription(v string) *CreateKeyInput
- func (s *CreateKeyInput) SetKeyUsage(v KeyUsageType) *CreateKeyInput
- func (s *CreateKeyInput) SetOrigin(v OriginType) *CreateKeyInput
- func (s *CreateKeyInput) SetPolicy(v string) *CreateKeyInput
- func (s *CreateKeyInput) SetTags(v []Tag) *CreateKeyInput
- func (s CreateKeyInput) String() string
- func (s *CreateKeyInput) Validate() error
- type CreateKeyOutput
- type CreateKeyRequest
- type DataKeySpec
- type DecryptInput
- func (s DecryptInput) GoString() string
- func (s *DecryptInput) SetCiphertextBlob(v []byte) *DecryptInput
- func (s *DecryptInput) SetEncryptionContext(v map[string]string) *DecryptInput
- func (s *DecryptInput) SetGrantTokens(v []string) *DecryptInput
- func (s DecryptInput) String() string
- func (s *DecryptInput) Validate() error
- type DecryptOutput
- type DecryptRequest
- type DeleteAliasInput
- type DeleteAliasOutput
- type DeleteAliasRequest
- type DeleteImportedKeyMaterialInput
- type DeleteImportedKeyMaterialOutput
- type DeleteImportedKeyMaterialRequest
- type DescribeKeyInput
- type DescribeKeyOutput
- type DescribeKeyRequest
- type DisableKeyInput
- type DisableKeyOutput
- type DisableKeyRequest
- type DisableKeyRotationInput
- type DisableKeyRotationOutput
- type DisableKeyRotationRequest
- type EnableKeyInput
- type EnableKeyOutput
- type EnableKeyRequest
- type EnableKeyRotationInput
- type EnableKeyRotationOutput
- type EnableKeyRotationRequest
- type EncryptInput
- func (s EncryptInput) GoString() string
- func (s *EncryptInput) SetEncryptionContext(v map[string]string) *EncryptInput
- func (s *EncryptInput) SetGrantTokens(v []string) *EncryptInput
- func (s *EncryptInput) SetKeyId(v string) *EncryptInput
- func (s *EncryptInput) SetPlaintext(v []byte) *EncryptInput
- func (s EncryptInput) String() string
- func (s *EncryptInput) Validate() error
- type EncryptOutput
- type EncryptRequest
- type ExpirationModelType
- type GenerateDataKeyInput
- func (s GenerateDataKeyInput) GoString() string
- func (s *GenerateDataKeyInput) SetEncryptionContext(v map[string]string) *GenerateDataKeyInput
- func (s *GenerateDataKeyInput) SetGrantTokens(v []string) *GenerateDataKeyInput
- func (s *GenerateDataKeyInput) SetKeyId(v string) *GenerateDataKeyInput
- func (s *GenerateDataKeyInput) SetKeySpec(v DataKeySpec) *GenerateDataKeyInput
- func (s *GenerateDataKeyInput) SetNumberOfBytes(v int64) *GenerateDataKeyInput
- func (s GenerateDataKeyInput) String() string
- func (s *GenerateDataKeyInput) Validate() error
- type GenerateDataKeyOutput
- func (s GenerateDataKeyOutput) GoString() string
- func (s GenerateDataKeyOutput) SDKResponseMetadata() aws.Response
- func (s *GenerateDataKeyOutput) SetCiphertextBlob(v []byte) *GenerateDataKeyOutput
- func (s *GenerateDataKeyOutput) SetKeyId(v string) *GenerateDataKeyOutput
- func (s *GenerateDataKeyOutput) SetPlaintext(v []byte) *GenerateDataKeyOutput
- func (s GenerateDataKeyOutput) String() string
- type GenerateDataKeyRequest
- type GenerateDataKeyWithoutPlaintextInput
- func (s GenerateDataKeyWithoutPlaintextInput) GoString() string
- func (s *GenerateDataKeyWithoutPlaintextInput) SetEncryptionContext(v map[string]string) *GenerateDataKeyWithoutPlaintextInput
- func (s *GenerateDataKeyWithoutPlaintextInput) SetGrantTokens(v []string) *GenerateDataKeyWithoutPlaintextInput
- func (s *GenerateDataKeyWithoutPlaintextInput) SetKeyId(v string) *GenerateDataKeyWithoutPlaintextInput
- func (s *GenerateDataKeyWithoutPlaintextInput) SetKeySpec(v DataKeySpec) *GenerateDataKeyWithoutPlaintextInput
- func (s *GenerateDataKeyWithoutPlaintextInput) SetNumberOfBytes(v int64) *GenerateDataKeyWithoutPlaintextInput
- func (s GenerateDataKeyWithoutPlaintextInput) String() string
- func (s *GenerateDataKeyWithoutPlaintextInput) Validate() error
- type GenerateDataKeyWithoutPlaintextOutput
- func (s GenerateDataKeyWithoutPlaintextOutput) GoString() string
- func (s GenerateDataKeyWithoutPlaintextOutput) SDKResponseMetadata() aws.Response
- func (s *GenerateDataKeyWithoutPlaintextOutput) SetCiphertextBlob(v []byte) *GenerateDataKeyWithoutPlaintextOutput
- func (s *GenerateDataKeyWithoutPlaintextOutput) SetKeyId(v string) *GenerateDataKeyWithoutPlaintextOutput
- func (s GenerateDataKeyWithoutPlaintextOutput) String() string
- type GenerateDataKeyWithoutPlaintextRequest
- type GenerateRandomInput
- type GenerateRandomOutput
- type GenerateRandomRequest
- type GetKeyPolicyInput
- type GetKeyPolicyOutput
- type GetKeyPolicyRequest
- type GetKeyRotationStatusInput
- type GetKeyRotationStatusOutput
- type GetKeyRotationStatusRequest
- type GetParametersForImportInput
- func (s GetParametersForImportInput) GoString() string
- func (s *GetParametersForImportInput) SetKeyId(v string) *GetParametersForImportInput
- func (s *GetParametersForImportInput) SetWrappingAlgorithm(v AlgorithmSpec) *GetParametersForImportInput
- func (s *GetParametersForImportInput) SetWrappingKeySpec(v WrappingKeySpec) *GetParametersForImportInput
- func (s GetParametersForImportInput) String() string
- func (s *GetParametersForImportInput) Validate() error
- type GetParametersForImportOutput
- func (s GetParametersForImportOutput) GoString() string
- func (s GetParametersForImportOutput) SDKResponseMetadata() aws.Response
- func (s *GetParametersForImportOutput) SetImportToken(v []byte) *GetParametersForImportOutput
- func (s *GetParametersForImportOutput) SetKeyId(v string) *GetParametersForImportOutput
- func (s *GetParametersForImportOutput) SetParametersValidTo(v time.Time) *GetParametersForImportOutput
- func (s *GetParametersForImportOutput) SetPublicKey(v []byte) *GetParametersForImportOutput
- func (s GetParametersForImportOutput) String() string
- type GetParametersForImportRequest
- type GrantConstraints
- type GrantListEntry
- func (s GrantListEntry) GoString() string
- func (s *GrantListEntry) SetConstraints(v *GrantConstraints) *GrantListEntry
- func (s *GrantListEntry) SetCreationDate(v time.Time) *GrantListEntry
- func (s *GrantListEntry) SetGrantId(v string) *GrantListEntry
- func (s *GrantListEntry) SetGranteePrincipal(v string) *GrantListEntry
- func (s *GrantListEntry) SetIssuingAccount(v string) *GrantListEntry
- func (s *GrantListEntry) SetKeyId(v string) *GrantListEntry
- func (s *GrantListEntry) SetName(v string) *GrantListEntry
- func (s *GrantListEntry) SetOperations(v []GrantOperation) *GrantListEntry
- func (s *GrantListEntry) SetRetiringPrincipal(v string) *GrantListEntry
- func (s GrantListEntry) String() string
- type GrantOperation
- type ImportKeyMaterialInput
- func (s ImportKeyMaterialInput) GoString() string
- func (s *ImportKeyMaterialInput) SetEncryptedKeyMaterial(v []byte) *ImportKeyMaterialInput
- func (s *ImportKeyMaterialInput) SetExpirationModel(v ExpirationModelType) *ImportKeyMaterialInput
- func (s *ImportKeyMaterialInput) SetImportToken(v []byte) *ImportKeyMaterialInput
- func (s *ImportKeyMaterialInput) SetKeyId(v string) *ImportKeyMaterialInput
- func (s *ImportKeyMaterialInput) SetValidTo(v time.Time) *ImportKeyMaterialInput
- func (s ImportKeyMaterialInput) String() string
- func (s *ImportKeyMaterialInput) Validate() error
- type ImportKeyMaterialOutput
- type ImportKeyMaterialRequest
- type KMS
- func (c *KMS) CancelKeyDeletionRequest(input *CancelKeyDeletionInput) CancelKeyDeletionRequest
- func (c *KMS) CreateAliasRequest(input *CreateAliasInput) CreateAliasRequest
- func (c *KMS) CreateGrantRequest(input *CreateGrantInput) CreateGrantRequest
- func (c *KMS) CreateKeyRequest(input *CreateKeyInput) CreateKeyRequest
- func (c *KMS) DecryptRequest(input *DecryptInput) DecryptRequest
- func (c *KMS) DeleteAliasRequest(input *DeleteAliasInput) DeleteAliasRequest
- func (c *KMS) DeleteImportedKeyMaterialRequest(input *DeleteImportedKeyMaterialInput) DeleteImportedKeyMaterialRequest
- func (c *KMS) DescribeKeyRequest(input *DescribeKeyInput) DescribeKeyRequest
- func (c *KMS) DisableKeyRequest(input *DisableKeyInput) DisableKeyRequest
- func (c *KMS) DisableKeyRotationRequest(input *DisableKeyRotationInput) DisableKeyRotationRequest
- func (c *KMS) EnableKeyRequest(input *EnableKeyInput) EnableKeyRequest
- func (c *KMS) EnableKeyRotationRequest(input *EnableKeyRotationInput) EnableKeyRotationRequest
- func (c *KMS) EncryptRequest(input *EncryptInput) EncryptRequest
- func (c *KMS) GenerateDataKeyRequest(input *GenerateDataKeyInput) GenerateDataKeyRequest
- func (c *KMS) GenerateDataKeyWithoutPlaintextRequest(input *GenerateDataKeyWithoutPlaintextInput) GenerateDataKeyWithoutPlaintextRequest
- func (c *KMS) GenerateRandomRequest(input *GenerateRandomInput) GenerateRandomRequest
- func (c *KMS) GetKeyPolicyRequest(input *GetKeyPolicyInput) GetKeyPolicyRequest
- func (c *KMS) GetKeyRotationStatusRequest(input *GetKeyRotationStatusInput) GetKeyRotationStatusRequest
- func (c *KMS) GetParametersForImportRequest(input *GetParametersForImportInput) GetParametersForImportRequest
- func (c *KMS) ImportKeyMaterialRequest(input *ImportKeyMaterialInput) ImportKeyMaterialRequest
- func (c *KMS) ListAliasesPages(input *ListAliasesInput, fn func(*ListAliasesOutput, bool) bool) error
- func (c *KMS) ListAliasesPagesWithContext(ctx aws.Context, input *ListAliasesInput, ...) error
- func (c *KMS) ListAliasesRequest(input *ListAliasesInput) ListAliasesRequest
- func (c *KMS) ListGrantsPages(input *ListGrantsInput, fn func(*ListRetirableGrantsOutput, bool) bool) error
- func (c *KMS) ListGrantsPagesWithContext(ctx aws.Context, input *ListGrantsInput, ...) error
- func (c *KMS) ListGrantsRequest(input *ListGrantsInput) ListGrantsRequest
- func (c *KMS) ListKeyPoliciesPages(input *ListKeyPoliciesInput, fn func(*ListKeyPoliciesOutput, bool) bool) error
- func (c *KMS) ListKeyPoliciesPagesWithContext(ctx aws.Context, input *ListKeyPoliciesInput, ...) error
- func (c *KMS) ListKeyPoliciesRequest(input *ListKeyPoliciesInput) ListKeyPoliciesRequest
- func (c *KMS) ListKeysPages(input *ListKeysInput, fn func(*ListKeysOutput, bool) bool) error
- func (c *KMS) ListKeysPagesWithContext(ctx aws.Context, input *ListKeysInput, fn func(*ListKeysOutput, bool) bool, ...) error
- func (c *KMS) ListKeysRequest(input *ListKeysInput) ListKeysRequest
- func (c *KMS) ListResourceTagsRequest(input *ListResourceTagsInput) ListResourceTagsRequest
- func (c *KMS) ListRetirableGrantsRequest(input *ListRetirableGrantsInput) ListRetirableGrantsRequest
- func (c *KMS) PutKeyPolicyRequest(input *PutKeyPolicyInput) PutKeyPolicyRequest
- func (c *KMS) ReEncryptRequest(input *ReEncryptInput) ReEncryptRequest
- func (c *KMS) RetireGrantRequest(input *RetireGrantInput) RetireGrantRequest
- func (c *KMS) RevokeGrantRequest(input *RevokeGrantInput) RevokeGrantRequest
- func (c *KMS) ScheduleKeyDeletionRequest(input *ScheduleKeyDeletionInput) ScheduleKeyDeletionRequest
- func (c *KMS) TagResourceRequest(input *TagResourceInput) TagResourceRequest
- func (c *KMS) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest
- func (c *KMS) UpdateAliasRequest(input *UpdateAliasInput) UpdateAliasRequest
- func (c *KMS) UpdateKeyDescriptionRequest(input *UpdateKeyDescriptionInput) UpdateKeyDescriptionRequest
- type KeyListEntry
- type KeyManagerType
- type KeyMetadata
- func (s KeyMetadata) GoString() string
- func (s *KeyMetadata) SetAWSAccountId(v string) *KeyMetadata
- func (s *KeyMetadata) SetArn(v string) *KeyMetadata
- func (s *KeyMetadata) SetCreationDate(v time.Time) *KeyMetadata
- func (s *KeyMetadata) SetDeletionDate(v time.Time) *KeyMetadata
- func (s *KeyMetadata) SetDescription(v string) *KeyMetadata
- func (s *KeyMetadata) SetEnabled(v bool) *KeyMetadata
- func (s *KeyMetadata) SetExpirationModel(v ExpirationModelType) *KeyMetadata
- func (s *KeyMetadata) SetKeyId(v string) *KeyMetadata
- func (s *KeyMetadata) SetKeyManager(v KeyManagerType) *KeyMetadata
- func (s *KeyMetadata) SetKeyState(v KeyState) *KeyMetadata
- func (s *KeyMetadata) SetKeyUsage(v KeyUsageType) *KeyMetadata
- func (s *KeyMetadata) SetOrigin(v OriginType) *KeyMetadata
- func (s *KeyMetadata) SetValidTo(v time.Time) *KeyMetadata
- func (s KeyMetadata) String() string
- type KeyState
- type KeyUsageType
- type ListAliasesInput
- type ListAliasesOutput
- func (s ListAliasesOutput) GoString() string
- func (s ListAliasesOutput) SDKResponseMetadata() aws.Response
- func (s *ListAliasesOutput) SetAliases(v []AliasListEntry) *ListAliasesOutput
- func (s *ListAliasesOutput) SetNextMarker(v string) *ListAliasesOutput
- func (s *ListAliasesOutput) SetTruncated(v bool) *ListAliasesOutput
- func (s ListAliasesOutput) String() string
- type ListAliasesRequest
- type ListGrantsInput
- func (s ListGrantsInput) GoString() string
- func (s *ListGrantsInput) SetKeyId(v string) *ListGrantsInput
- func (s *ListGrantsInput) SetLimit(v int64) *ListGrantsInput
- func (s *ListGrantsInput) SetMarker(v string) *ListGrantsInput
- func (s ListGrantsInput) String() string
- func (s *ListGrantsInput) Validate() error
- type ListGrantsRequest
- type ListKeyPoliciesInput
- func (s ListKeyPoliciesInput) GoString() string
- func (s *ListKeyPoliciesInput) SetKeyId(v string) *ListKeyPoliciesInput
- func (s *ListKeyPoliciesInput) SetLimit(v int64) *ListKeyPoliciesInput
- func (s *ListKeyPoliciesInput) SetMarker(v string) *ListKeyPoliciesInput
- func (s ListKeyPoliciesInput) String() string
- func (s *ListKeyPoliciesInput) Validate() error
- type ListKeyPoliciesOutput
- func (s ListKeyPoliciesOutput) GoString() string
- func (s ListKeyPoliciesOutput) SDKResponseMetadata() aws.Response
- func (s *ListKeyPoliciesOutput) SetNextMarker(v string) *ListKeyPoliciesOutput
- func (s *ListKeyPoliciesOutput) SetPolicyNames(v []string) *ListKeyPoliciesOutput
- func (s *ListKeyPoliciesOutput) SetTruncated(v bool) *ListKeyPoliciesOutput
- func (s ListKeyPoliciesOutput) String() string
- type ListKeyPoliciesRequest
- type ListKeysInput
- type ListKeysOutput
- func (s ListKeysOutput) GoString() string
- func (s ListKeysOutput) SDKResponseMetadata() aws.Response
- func (s *ListKeysOutput) SetKeys(v []KeyListEntry) *ListKeysOutput
- func (s *ListKeysOutput) SetNextMarker(v string) *ListKeysOutput
- func (s *ListKeysOutput) SetTruncated(v bool) *ListKeysOutput
- func (s ListKeysOutput) String() string
- type ListKeysRequest
- type ListResourceTagsInput
- func (s ListResourceTagsInput) GoString() string
- func (s *ListResourceTagsInput) SetKeyId(v string) *ListResourceTagsInput
- func (s *ListResourceTagsInput) SetLimit(v int64) *ListResourceTagsInput
- func (s *ListResourceTagsInput) SetMarker(v string) *ListResourceTagsInput
- func (s ListResourceTagsInput) String() string
- func (s *ListResourceTagsInput) Validate() error
- type ListResourceTagsOutput
- func (s ListResourceTagsOutput) GoString() string
- func (s ListResourceTagsOutput) SDKResponseMetadata() aws.Response
- func (s *ListResourceTagsOutput) SetNextMarker(v string) *ListResourceTagsOutput
- func (s *ListResourceTagsOutput) SetTags(v []Tag) *ListResourceTagsOutput
- func (s *ListResourceTagsOutput) SetTruncated(v bool) *ListResourceTagsOutput
- func (s ListResourceTagsOutput) String() string
- type ListResourceTagsRequest
- type ListRetirableGrantsInput
- func (s ListRetirableGrantsInput) GoString() string
- func (s *ListRetirableGrantsInput) SetLimit(v int64) *ListRetirableGrantsInput
- func (s *ListRetirableGrantsInput) SetMarker(v string) *ListRetirableGrantsInput
- func (s *ListRetirableGrantsInput) SetRetiringPrincipal(v string) *ListRetirableGrantsInput
- func (s ListRetirableGrantsInput) String() string
- func (s *ListRetirableGrantsInput) Validate() error
- type ListRetirableGrantsOutput
- func (s ListRetirableGrantsOutput) GoString() string
- func (s ListRetirableGrantsOutput) SDKResponseMetadata() aws.Response
- func (s *ListRetirableGrantsOutput) SetGrants(v []GrantListEntry) *ListRetirableGrantsOutput
- func (s *ListRetirableGrantsOutput) SetNextMarker(v string) *ListRetirableGrantsOutput
- func (s *ListRetirableGrantsOutput) SetTruncated(v bool) *ListRetirableGrantsOutput
- func (s ListRetirableGrantsOutput) String() string
- type ListRetirableGrantsRequest
- type OriginType
- type PutKeyPolicyInput
- func (s PutKeyPolicyInput) GoString() string
- func (s *PutKeyPolicyInput) SetBypassPolicyLockoutSafetyCheck(v bool) *PutKeyPolicyInput
- func (s *PutKeyPolicyInput) SetKeyId(v string) *PutKeyPolicyInput
- func (s *PutKeyPolicyInput) SetPolicy(v string) *PutKeyPolicyInput
- func (s *PutKeyPolicyInput) SetPolicyName(v string) *PutKeyPolicyInput
- func (s PutKeyPolicyInput) String() string
- func (s *PutKeyPolicyInput) Validate() error
- type PutKeyPolicyOutput
- type PutKeyPolicyRequest
- type ReEncryptInput
- func (s ReEncryptInput) GoString() string
- func (s *ReEncryptInput) SetCiphertextBlob(v []byte) *ReEncryptInput
- func (s *ReEncryptInput) SetDestinationEncryptionContext(v map[string]string) *ReEncryptInput
- func (s *ReEncryptInput) SetDestinationKeyId(v string) *ReEncryptInput
- func (s *ReEncryptInput) SetGrantTokens(v []string) *ReEncryptInput
- func (s *ReEncryptInput) SetSourceEncryptionContext(v map[string]string) *ReEncryptInput
- func (s ReEncryptInput) String() string
- func (s *ReEncryptInput) Validate() error
- type ReEncryptOutput
- func (s ReEncryptOutput) GoString() string
- func (s ReEncryptOutput) SDKResponseMetadata() aws.Response
- func (s *ReEncryptOutput) SetCiphertextBlob(v []byte) *ReEncryptOutput
- func (s *ReEncryptOutput) SetKeyId(v string) *ReEncryptOutput
- func (s *ReEncryptOutput) SetSourceKeyId(v string) *ReEncryptOutput
- func (s ReEncryptOutput) String() string
- type ReEncryptRequest
- type RetireGrantInput
- func (s RetireGrantInput) GoString() string
- func (s *RetireGrantInput) SetGrantId(v string) *RetireGrantInput
- func (s *RetireGrantInput) SetGrantToken(v string) *RetireGrantInput
- func (s *RetireGrantInput) SetKeyId(v string) *RetireGrantInput
- func (s RetireGrantInput) String() string
- func (s *RetireGrantInput) Validate() error
- type RetireGrantOutput
- type RetireGrantRequest
- type RevokeGrantInput
- type RevokeGrantOutput
- type RevokeGrantRequest
- type ScheduleKeyDeletionInput
- func (s ScheduleKeyDeletionInput) GoString() string
- func (s *ScheduleKeyDeletionInput) SetKeyId(v string) *ScheduleKeyDeletionInput
- func (s *ScheduleKeyDeletionInput) SetPendingWindowInDays(v int64) *ScheduleKeyDeletionInput
- func (s ScheduleKeyDeletionInput) String() string
- func (s *ScheduleKeyDeletionInput) Validate() error
- type ScheduleKeyDeletionOutput
- func (s ScheduleKeyDeletionOutput) GoString() string
- func (s ScheduleKeyDeletionOutput) SDKResponseMetadata() aws.Response
- func (s *ScheduleKeyDeletionOutput) SetDeletionDate(v time.Time) *ScheduleKeyDeletionOutput
- func (s *ScheduleKeyDeletionOutput) SetKeyId(v string) *ScheduleKeyDeletionOutput
- func (s ScheduleKeyDeletionOutput) String() string
- type ScheduleKeyDeletionRequest
- type Tag
- type TagResourceInput
- type TagResourceOutput
- type TagResourceRequest
- type UntagResourceInput
- type UntagResourceOutput
- type UntagResourceRequest
- type UpdateAliasInput
- type UpdateAliasOutput
- type UpdateAliasRequest
- type UpdateKeyDescriptionInput
- func (s UpdateKeyDescriptionInput) GoString() string
- func (s *UpdateKeyDescriptionInput) SetDescription(v string) *UpdateKeyDescriptionInput
- func (s *UpdateKeyDescriptionInput) SetKeyId(v string) *UpdateKeyDescriptionInput
- func (s UpdateKeyDescriptionInput) String() string
- func (s *UpdateKeyDescriptionInput) Validate() error
- type UpdateKeyDescriptionOutput
- type UpdateKeyDescriptionRequest
- type WrappingKeySpec
Examples ¶
- KMS.CancelKeyDeletionRequest (Shared00)
- KMS.CreateAliasRequest (Shared00)
- KMS.CreateGrantRequest (Shared00)
- KMS.CreateKeyRequest (Shared00)
- KMS.DecryptRequest (Shared00)
- KMS.DeleteAliasRequest (Shared00)
- KMS.DeleteImportedKeyMaterialRequest (Shared00)
- KMS.DescribeKeyRequest (Shared00)
- KMS.DisableKeyRequest (Shared00)
- KMS.DisableKeyRotationRequest (Shared00)
- KMS.EnableKeyRequest (Shared00)
- KMS.EnableKeyRotationRequest (Shared00)
- KMS.EncryptRequest (Shared00)
- KMS.GenerateDataKeyRequest (Shared00)
- KMS.GenerateDataKeyWithoutPlaintextRequest (Shared00)
- KMS.GenerateRandomRequest (Shared00)
- KMS.GetKeyPolicyRequest (Shared00)
- KMS.GetKeyRotationStatusRequest (Shared00)
- KMS.GetParametersForImportRequest (Shared00)
- KMS.ImportKeyMaterialRequest (Shared00)
- KMS.ListAliasesRequest (Shared00)
- KMS.ListGrantsRequest (Shared00)
- KMS.ListKeyPoliciesRequest (Shared00)
- KMS.ListKeysRequest (Shared00)
- KMS.ListResourceTagsRequest (Shared00)
- KMS.ListRetirableGrantsRequest (Shared00)
- KMS.PutKeyPolicyRequest (Shared00)
- KMS.ReEncryptRequest (Shared00)
- KMS.RetireGrantRequest (Shared00)
- KMS.RevokeGrantRequest (Shared00)
- KMS.ScheduleKeyDeletionRequest (Shared00)
- KMS.TagResourceRequest (Shared00)
- KMS.UntagResourceRequest (Shared00)
- KMS.UpdateAliasRequest (Shared00)
- KMS.UpdateKeyDescriptionRequest (Shared00)
Constants ¶
const ( // ErrCodeAlreadyExistsException for service response error code // "AlreadyExistsException". // // The request was rejected because it attempted to create a resource that already // exists. ErrCodeAlreadyExistsException = "AlreadyExistsException" // ErrCodeDependencyTimeoutException for service response error code // "DependencyTimeoutException". // // The system timed out while trying to fulfill the request. The request can // be retried. ErrCodeDependencyTimeoutException = "DependencyTimeoutException" // ErrCodeDisabledException for service response error code // "DisabledException". // // The request was rejected because the specified CMK is not enabled. ErrCodeDisabledException = "DisabledException" // ErrCodeExpiredImportTokenException for service response error code // "ExpiredImportTokenException". // // The request was rejected because the provided import token is expired. Use // GetParametersForImport to retrieve a new import token and public key, use // the new public key to encrypt the key material, and then try the request // again. ErrCodeExpiredImportTokenException = "ExpiredImportTokenException" // ErrCodeIncorrectKeyMaterialException for service response error code // "IncorrectKeyMaterialException". // // The request was rejected because the provided key material is invalid or // is not the same key material that was previously imported into this customer // master key (CMK). ErrCodeIncorrectKeyMaterialException = "IncorrectKeyMaterialException" // ErrCodeInternalException for service response error code // "InternalException". // // The request was rejected because an internal exception occurred. The request // can be retried. ErrCodeInternalException = "InternalException" // ErrCodeInvalidAliasNameException for service response error code // "InvalidAliasNameException". // // The request was rejected because the specified alias name is not valid. ErrCodeInvalidAliasNameException = "InvalidAliasNameException" // ErrCodeInvalidArnException for service response error code // "InvalidArnException". // // The request was rejected because a specified ARN was not valid. ErrCodeInvalidArnException = "InvalidArnException" // ErrCodeInvalidCiphertextException for service response error code // "InvalidCiphertextException". // // The request was rejected because the specified ciphertext has been corrupted // or is otherwise invalid. ErrCodeInvalidCiphertextException = "InvalidCiphertextException" // ErrCodeInvalidGrantIdException for service response error code // "InvalidGrantIdException". // // The request was rejected because the specified GrantId is not valid. ErrCodeInvalidGrantIdException = "InvalidGrantIdException" // ErrCodeInvalidGrantTokenException for service response error code // "InvalidGrantTokenException". // // The request was rejected because the specified grant token is not valid. ErrCodeInvalidGrantTokenException = "InvalidGrantTokenException" // ErrCodeInvalidImportTokenException for service response error code // "InvalidImportTokenException". // // The request was rejected because the provided import token is invalid or // is associated with a different customer master key (CMK). ErrCodeInvalidImportTokenException = "InvalidImportTokenException" // ErrCodeInvalidKeyUsageException for service response error code // "InvalidKeyUsageException". // // The request was rejected because the specified KeySpec value is not valid. ErrCodeInvalidKeyUsageException = "InvalidKeyUsageException" // ErrCodeInvalidMarkerException for service response error code // "InvalidMarkerException". // // The request was rejected because the marker that specifies where pagination // should next begin is not valid. ErrCodeInvalidMarkerException = "InvalidMarkerException" // ErrCodeInvalidStateException for service response error code // "InvalidStateException". // // The request was rejected because the state of the specified resource is not // valid for this request. // // For more information about how key state affects the use of a CMK, see How // Key State Affects Use of a Customer Master Key (http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) // in the AWS Key Management Service Developer Guide. ErrCodeInvalidStateException = "InvalidStateException" // "KeyUnavailableException". // // The request was rejected because the specified CMK was not available. The // request can be retried. ErrCodeKeyUnavailableException = "KeyUnavailableException" // ErrCodeLimitExceededException for service response error code // "LimitExceededException". // // The request was rejected because a limit was exceeded. For more information, // see Limits (http://docs.aws.amazon.com/kms/latest/developerguide/limits.html) // in the AWS Key Management Service Developer Guide. ErrCodeLimitExceededException = "LimitExceededException" // ErrCodeMalformedPolicyDocumentException for service response error code // "MalformedPolicyDocumentException". // // The request was rejected because the specified policy is not syntactically // or semantically correct. ErrCodeMalformedPolicyDocumentException = "MalformedPolicyDocumentException" // ErrCodeNotFoundException for service response error code // "NotFoundException". // // The request was rejected because the specified entity or resource could not // be found. ErrCodeNotFoundException = "NotFoundException" // ErrCodeTagException for service response error code // "TagException". // // The request was rejected because one or more tags are not valid. ErrCodeTagException = "TagException" // ErrCodeUnsupportedOperationException for service response error code // "UnsupportedOperationException". // // The request was rejected because a specified parameter is not supported or // a specified resource is not valid for this operation. ErrCodeUnsupportedOperationException = "UnsupportedOperationException" )
const ( ServiceName = "kms" // Service endpoint prefix API calls made to. EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata. )
Service information constants
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AlgorithmSpec ¶
type AlgorithmSpec string
const ( AlgorithmSpecRsaesPkcs1V15 AlgorithmSpec = "RSAES_PKCS1_V1_5" AlgorithmSpecRsaesOaepSha1 AlgorithmSpec = "RSAES_OAEP_SHA_1" AlgorithmSpecRsaesOaepSha256 AlgorithmSpec = "RSAES_OAEP_SHA_256" )
Enum values for AlgorithmSpec
type AliasListEntry ¶
type AliasListEntry struct { // String that contains the key ARN. AliasArn *string `min:"20" type:"string"` // String that contains the alias. AliasName *string `min:"1" type:"string"` // String that contains the key identifier referred to by the alias. TargetKeyId *string `min:"1" type:"string"` // contains filtered or unexported fields }
Contains information about an alias. Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/AliasListEntry
func (AliasListEntry) GoString ¶
func (s AliasListEntry) GoString() string
GoString returns the string representation
func (*AliasListEntry) SetAliasArn ¶
func (s *AliasListEntry) SetAliasArn(v string) *AliasListEntry
SetAliasArn sets the AliasArn field's value.
func (*AliasListEntry) SetAliasName ¶
func (s *AliasListEntry) SetAliasName(v string) *AliasListEntry
SetAliasName sets the AliasName field's value.
func (*AliasListEntry) SetTargetKeyId ¶
func (s *AliasListEntry) SetTargetKeyId(v string) *AliasListEntry
SetTargetKeyId sets the TargetKeyId field's value.
func (AliasListEntry) String ¶
func (s AliasListEntry) String() string
String returns the string representation
type CancelKeyDeletionInput ¶
type CancelKeyDeletionInput struct { // The unique identifier for the customer master key (CMK) for which to cancel // deletion. // // To specify this value, use the unique key ID or the Amazon Resource Name // (ARN) of the CMK. Examples: // // * Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab // // * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab // // To obtain the unique key ID and key ARN for a given CMK, use ListKeys or // DescribeKey. // // KeyId is a required field KeyId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CancelKeyDeletionRequest
func (CancelKeyDeletionInput) GoString ¶
func (s CancelKeyDeletionInput) GoString() string
GoString returns the string representation
func (*CancelKeyDeletionInput) SetKeyId ¶
func (s *CancelKeyDeletionInput) SetKeyId(v string) *CancelKeyDeletionInput
SetKeyId sets the KeyId field's value.
func (CancelKeyDeletionInput) String ¶
func (s CancelKeyDeletionInput) String() string
String returns the string representation
func (*CancelKeyDeletionInput) Validate ¶
func (s *CancelKeyDeletionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CancelKeyDeletionOutput ¶
type CancelKeyDeletionOutput struct { // The unique identifier of the master key for which deletion is canceled. KeyId *string `min:"1" type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CancelKeyDeletionResponse
func (CancelKeyDeletionOutput) GoString ¶
func (s CancelKeyDeletionOutput) GoString() string
GoString returns the string representation
func (CancelKeyDeletionOutput) SDKResponseMetadata ¶
func (s CancelKeyDeletionOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (*CancelKeyDeletionOutput) SetKeyId ¶
func (s *CancelKeyDeletionOutput) SetKeyId(v string) *CancelKeyDeletionOutput
SetKeyId sets the KeyId field's value.
func (CancelKeyDeletionOutput) String ¶
func (s CancelKeyDeletionOutput) String() string
String returns the string representation
type CancelKeyDeletionRequest ¶
type CancelKeyDeletionRequest struct { *aws.Request Input *CancelKeyDeletionInput }
CancelKeyDeletionRequest is a API request type for the CancelKeyDeletion API operation.
func (CancelKeyDeletionRequest) Send ¶
func (r CancelKeyDeletionRequest) Send() (*CancelKeyDeletionOutput, error)
Send marshals and sends the CancelKeyDeletion API request.
type CreateAliasInput ¶
type CreateAliasInput struct { // String that contains the display name. 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 AliasName *string `min:"1" type:"string" required:"true"` // An identifier of the key for which you are creating the alias. This value // cannot be another alias but can be a globally unique identifier or a fully // specified ARN to 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 // // TargetKeyId is a required field TargetKeyId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CreateAliasRequest
func (CreateAliasInput) GoString ¶
func (s CreateAliasInput) GoString() string
GoString returns the string representation
func (*CreateAliasInput) SetAliasName ¶
func (s *CreateAliasInput) SetAliasName(v string) *CreateAliasInput
SetAliasName sets the AliasName field's value.
func (*CreateAliasInput) SetTargetKeyId ¶
func (s *CreateAliasInput) SetTargetKeyId(v string) *CreateAliasInput
SetTargetKeyId sets the TargetKeyId field's value.
func (CreateAliasInput) String ¶
func (s CreateAliasInput) String() string
String returns the string representation
func (*CreateAliasInput) Validate ¶
func (s *CreateAliasInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateAliasOutput ¶
type CreateAliasOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CreateAliasOutput
func (CreateAliasOutput) GoString ¶
func (s CreateAliasOutput) GoString() string
GoString returns the string representation
func (CreateAliasOutput) SDKResponseMetadata ¶
func (s CreateAliasOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (CreateAliasOutput) String ¶
func (s CreateAliasOutput) String() string
String returns the string representation
type CreateAliasRequest ¶
type CreateAliasRequest struct { *aws.Request Input *CreateAliasInput }
CreateAliasRequest is a API request type for the CreateAlias API operation.
func (CreateAliasRequest) Send ¶
func (r CreateAliasRequest) Send() (*CreateAliasOutput, error)
Send marshals and sends the CreateAlias API request.
type CreateGrantInput ¶
type CreateGrantInput struct { // A structure that you can use to allow certain operations in the grant only // when the desired encryption context is present. For more information about // encryption context, see Encryption Context (http://docs.aws.amazon.com/kms/latest/developerguide/encryption-context.html) // in the AWS Key Management Service Developer Guide. Constraints *GrantConstraints `type:"structure"` // A list of grant tokens. // // For more information, see Grant Tokens (http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token) // in the AWS Key Management Service Developer Guide. GrantTokens []string `type:"list"` // The principal that is given permission to perform the operations that the // grant permits. // // To specify the principal, use the Amazon Resource Name (ARN) (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) // of an AWS principal. Valid AWS principals include AWS accounts (root), IAM // users, IAM roles, federated users, and assumed role users. For examples of // the ARN syntax to use for specifying a principal, see AWS Identity and Access // Management (IAM) (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam) // in the Example ARNs section of the AWS General Reference. // // GranteePrincipal is a required field GranteePrincipal *string `min:"1" type:"string" required:"true"` // The unique identifier for the customer master key (CMK) that the grant applies // to. // // To specify this value, use the globally unique key ID or the Amazon Resource // Name (ARN) of the key. Examples: // // * Globally unique key ID: 12345678-1234-1234-1234-123456789012 // // * Key ARN: arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234-123456789012 // // KeyId is a required field KeyId *string `min:"1" type:"string" required:"true"` // A friendly name for identifying the grant. Use this value to prevent unintended // creation of duplicate grants when retrying this request. // // When this value is absent, all CreateGrant requests result in a new grant // with a unique GrantId even if all the supplied parameters are identical. // This can result in unintended duplicates when you retry the CreateGrant request. // // When this value is present, you can retry a CreateGrant request with identical // parameters; if the grant already exists, the original GrantId is returned // without creating a new grant. Note that the returned grant token is unique // with every CreateGrant request, even when a duplicate GrantId is returned. // All grant tokens obtained in this way can be used interchangeably. Name *string `min:"1" type:"string"` // A list of operations that the grant permits. Operations []GrantOperation `type:"list"` // The principal that is given permission to retire the grant by using RetireGrant // operation. // // To specify the principal, use the Amazon Resource Name (ARN) (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) // of an AWS principal. Valid AWS principals include AWS accounts (root), IAM // users, federated users, and assumed role users. For examples of the ARN syntax // to use for specifying a principal, see AWS Identity and Access Management // (IAM) (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam) // in the Example ARNs section of the AWS General Reference. RetiringPrincipal *string `min:"1" type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CreateGrantRequest
func (CreateGrantInput) GoString ¶
func (s CreateGrantInput) GoString() string
GoString returns the string representation
func (*CreateGrantInput) SetConstraints ¶
func (s *CreateGrantInput) SetConstraints(v *GrantConstraints) *CreateGrantInput
SetConstraints sets the Constraints field's value.
func (*CreateGrantInput) SetGrantTokens ¶
func (s *CreateGrantInput) SetGrantTokens(v []string) *CreateGrantInput
SetGrantTokens sets the GrantTokens field's value.
func (*CreateGrantInput) SetGranteePrincipal ¶
func (s *CreateGrantInput) SetGranteePrincipal(v string) *CreateGrantInput
SetGranteePrincipal sets the GranteePrincipal field's value.
func (*CreateGrantInput) SetKeyId ¶
func (s *CreateGrantInput) SetKeyId(v string) *CreateGrantInput
SetKeyId sets the KeyId field's value.
func (*CreateGrantInput) SetName ¶
func (s *CreateGrantInput) SetName(v string) *CreateGrantInput
SetName sets the Name field's value.
func (*CreateGrantInput) SetOperations ¶
func (s *CreateGrantInput) SetOperations(v []GrantOperation) *CreateGrantInput
SetOperations sets the Operations field's value.
func (*CreateGrantInput) SetRetiringPrincipal ¶
func (s *CreateGrantInput) SetRetiringPrincipal(v string) *CreateGrantInput
SetRetiringPrincipal sets the RetiringPrincipal field's value.
func (CreateGrantInput) String ¶
func (s CreateGrantInput) String() string
String returns the string representation
func (*CreateGrantInput) Validate ¶
func (s *CreateGrantInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateGrantOutput ¶
type CreateGrantOutput struct { // The unique identifier for the grant. // // You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation. GrantId *string `min:"1" type:"string"` // The grant token. // // For more information, see Grant Tokens (http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token) // in the AWS Key Management Service Developer Guide. GrantToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CreateGrantResponse
func (CreateGrantOutput) GoString ¶
func (s CreateGrantOutput) GoString() string
GoString returns the string representation
func (CreateGrantOutput) SDKResponseMetadata ¶
func (s CreateGrantOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (*CreateGrantOutput) SetGrantId ¶
func (s *CreateGrantOutput) SetGrantId(v string) *CreateGrantOutput
SetGrantId sets the GrantId field's value.
func (*CreateGrantOutput) SetGrantToken ¶
func (s *CreateGrantOutput) SetGrantToken(v string) *CreateGrantOutput
SetGrantToken sets the GrantToken field's value.
func (CreateGrantOutput) String ¶
func (s CreateGrantOutput) String() string
String returns the string representation
type CreateGrantRequest ¶
type CreateGrantRequest struct { *aws.Request Input *CreateGrantInput }
CreateGrantRequest is a API request type for the CreateGrant API operation.
func (CreateGrantRequest) Send ¶
func (r CreateGrantRequest) Send() (*CreateGrantOutput, error)
Send marshals and sends the CreateGrant API request.
type CreateKeyInput ¶
type CreateKeyInput struct { // A flag to indicate whether to bypass the key policy lockout safety check. // // Setting this value to true increases the likelihood that the CMK becomes // unmanageable. Do not set this value to true indiscriminately. // // For more information, refer to the scenario in the Default Key Policy (http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) // section in the AWS Key Management Service Developer Guide. // // Use this parameter only when you include a policy in the request and you // intend to prevent the principal that is making the request from making a // subsequent PutKeyPolicy request on the CMK. // // The default value is false. BypassPolicyLockoutSafetyCheck *bool `type:"boolean"` // A description of the CMK. // // Use a description that helps you decide whether the CMK is appropriate for // a task. Description *string `type:"string"` // The intended use of the CMK. // // You can use CMKs only for symmetric encryption and decryption. KeyUsage KeyUsageType `type:"string" enum:"true"` // The source of the CMK's key material. // // The default is AWS_KMS, which means AWS KMS creates the key material. When // this parameter is set to EXTERNAL, the request creates a CMK without key // material so that you can import key material from your existing key management // infrastructure. For more information about importing key material into AWS // KMS, see Importing Key Material (http://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) // in the AWS Key Management Service Developer Guide. // // The CMK's Origin is immutable and is set when the CMK is created. Origin OriginType `type:"string" enum:"true"` // The key policy to attach to the CMK. // // If you specify a policy and do not set BypassPolicyLockoutSafetyCheck to // true, the policy must meet the following criteria: // // * It must allow the principal that is making the CreateKey request to // make a subsequent PutKeyPolicy request on the CMK. This reduces the likelihood // that the CMK becomes unmanageable. For more information, refer to the // scenario in the Default Key Policy (http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) // section in the AWS Key Management Service Developer Guide. // // * The principals that are specified in the key policy must exist and be // visible to AWS KMS. When you create a new AWS principal (for example, // an IAM user or role), you might need to enforce a delay before specifying // the new principal in a key policy because the new principal might not // immediately be visible to AWS KMS. For more information, see Changes that // I make are not always immediately visible (http://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) // in the IAM User Guide. // // If you do not specify a policy, AWS KMS attaches a default key policy to // the CMK. For more information, see Default Key Policy (http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default) // in the AWS Key Management Service Developer Guide. // // The policy size limit is 32 KiB (32768 bytes). Policy *string `min:"1" type:"string"` // One or more tags. Each tag consists of a tag key and a tag value. Tag keys // and tag values are both required, but tag values can be empty (null) strings. // // Use this parameter to tag the CMK when it is created. Alternately, you can // omit this parameter and instead tag the CMK after it is created using TagResource. Tags []Tag `type:"list"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CreateKeyRequest
func (CreateKeyInput) GoString ¶
func (s CreateKeyInput) GoString() string
GoString returns the string representation
func (*CreateKeyInput) SetBypassPolicyLockoutSafetyCheck ¶
func (s *CreateKeyInput) SetBypassPolicyLockoutSafetyCheck(v bool) *CreateKeyInput
SetBypassPolicyLockoutSafetyCheck sets the BypassPolicyLockoutSafetyCheck field's value.
func (*CreateKeyInput) SetDescription ¶
func (s *CreateKeyInput) SetDescription(v string) *CreateKeyInput
SetDescription sets the Description field's value.
func (*CreateKeyInput) SetKeyUsage ¶
func (s *CreateKeyInput) SetKeyUsage(v KeyUsageType) *CreateKeyInput
SetKeyUsage sets the KeyUsage field's value.
func (*CreateKeyInput) SetOrigin ¶
func (s *CreateKeyInput) SetOrigin(v OriginType) *CreateKeyInput
SetOrigin sets the Origin field's value.
func (*CreateKeyInput) SetPolicy ¶
func (s *CreateKeyInput) SetPolicy(v string) *CreateKeyInput
SetPolicy sets the Policy field's value.
func (*CreateKeyInput) SetTags ¶
func (s *CreateKeyInput) SetTags(v []Tag) *CreateKeyInput
SetTags sets the Tags field's value.
func (CreateKeyInput) String ¶
func (s CreateKeyInput) String() string
String returns the string representation
func (*CreateKeyInput) Validate ¶
func (s *CreateKeyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateKeyOutput ¶
type CreateKeyOutput struct { // Metadata associated with the CMK. KeyMetadata *KeyMetadata `type:"structure"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CreateKeyResponse
func (CreateKeyOutput) GoString ¶
func (s CreateKeyOutput) GoString() string
GoString returns the string representation
func (CreateKeyOutput) SDKResponseMetadata ¶
func (s CreateKeyOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (*CreateKeyOutput) SetKeyMetadata ¶
func (s *CreateKeyOutput) SetKeyMetadata(v *KeyMetadata) *CreateKeyOutput
SetKeyMetadata sets the KeyMetadata field's value.
func (CreateKeyOutput) String ¶
func (s CreateKeyOutput) String() string
String returns the string representation
type CreateKeyRequest ¶
type CreateKeyRequest struct { *aws.Request Input *CreateKeyInput }
CreateKeyRequest is a API request type for the CreateKey API operation.
func (CreateKeyRequest) Send ¶
func (r CreateKeyRequest) Send() (*CreateKeyOutput, error)
Send marshals and sends the CreateKey API request.
type DataKeySpec ¶
type DataKeySpec string
const ( DataKeySpecAes256 DataKeySpec = "AES_256" DataKeySpecAes128 DataKeySpec = "AES_128" )
Enum values for DataKeySpec
type DecryptInput ¶
type DecryptInput struct { // Ciphertext to be decrypted. The blob includes metadata. // // CiphertextBlob is automatically base64 encoded/decoded by the SDK. // // CiphertextBlob is a required field CiphertextBlob []byte `min:"1" type:"blob" required:"true"` // The encryption context. If this was specified in the Encrypt function, it // must be specified here or the decryption operation will fail. For more information, // see Encryption Context (http://docs.aws.amazon.com/kms/latest/developerguide/encryption-context.html). EncryptionContext map[string]string `type:"map"` // A list of grant tokens. // // For more information, see Grant Tokens (http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token) // in the AWS Key Management Service Developer Guide. GrantTokens []string `type:"list"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DecryptRequest
func (DecryptInput) GoString ¶
func (s DecryptInput) GoString() string
GoString returns the string representation
func (*DecryptInput) SetCiphertextBlob ¶
func (s *DecryptInput) SetCiphertextBlob(v []byte) *DecryptInput
SetCiphertextBlob sets the CiphertextBlob field's value.
func (*DecryptInput) SetEncryptionContext ¶
func (s *DecryptInput) SetEncryptionContext(v map[string]string) *DecryptInput
SetEncryptionContext sets the EncryptionContext field's value.
func (*DecryptInput) SetGrantTokens ¶
func (s *DecryptInput) SetGrantTokens(v []string) *DecryptInput
SetGrantTokens sets the GrantTokens field's value.
func (DecryptInput) String ¶
func (s DecryptInput) String() string
String returns the string representation
func (*DecryptInput) Validate ¶
func (s *DecryptInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DecryptOutput ¶
type DecryptOutput struct { // ARN of the key used to perform the decryption. This value is returned if // no errors are encountered during the operation. KeyId *string `min:"1" type:"string"` // Decrypted plaintext data. This value may not be returned if the customer // master key is not available or if you didn't have permission to use it. // // Plaintext is automatically base64 encoded/decoded by the SDK. Plaintext []byte `min:"1" type:"blob"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DecryptResponse
func (DecryptOutput) GoString ¶
func (s DecryptOutput) GoString() string
GoString returns the string representation
func (DecryptOutput) SDKResponseMetadata ¶
func (s DecryptOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (*DecryptOutput) SetKeyId ¶
func (s *DecryptOutput) SetKeyId(v string) *DecryptOutput
SetKeyId sets the KeyId field's value.
func (*DecryptOutput) SetPlaintext ¶
func (s *DecryptOutput) SetPlaintext(v []byte) *DecryptOutput
SetPlaintext sets the Plaintext field's value.
func (DecryptOutput) String ¶
func (s DecryptOutput) String() string
String returns the string representation
type DecryptRequest ¶
type DecryptRequest struct { *aws.Request Input *DecryptInput }
DecryptRequest is a API request type for the Decrypt API operation.
func (DecryptRequest) Send ¶
func (r DecryptRequest) Send() (*DecryptOutput, error)
Send marshals and sends the Decrypt API request.
type DeleteAliasInput ¶
type DeleteAliasInput struct { // The alias to be deleted. 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 AliasName *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DeleteAliasRequest
func (DeleteAliasInput) GoString ¶
func (s DeleteAliasInput) GoString() string
GoString returns the string representation
func (*DeleteAliasInput) SetAliasName ¶
func (s *DeleteAliasInput) SetAliasName(v string) *DeleteAliasInput
SetAliasName sets the AliasName field's value.
func (DeleteAliasInput) String ¶
func (s DeleteAliasInput) String() string
String returns the string representation
func (*DeleteAliasInput) Validate ¶
func (s *DeleteAliasInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteAliasOutput ¶
type DeleteAliasOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DeleteAliasOutput
func (DeleteAliasOutput) GoString ¶
func (s DeleteAliasOutput) GoString() string
GoString returns the string representation
func (DeleteAliasOutput) SDKResponseMetadata ¶
func (s DeleteAliasOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DeleteAliasOutput) String ¶
func (s DeleteAliasOutput) String() string
String returns the string representation
type DeleteAliasRequest ¶
type DeleteAliasRequest struct { *aws.Request Input *DeleteAliasInput }
DeleteAliasRequest is a API request type for the DeleteAlias API operation.
func (DeleteAliasRequest) Send ¶
func (r DeleteAliasRequest) Send() (*DeleteAliasOutput, error)
Send marshals and sends the DeleteAlias API request.
type DeleteImportedKeyMaterialInput ¶
type DeleteImportedKeyMaterialInput struct { // The identifier of the CMK whose key material to delete. The CMK's Origin // must be EXTERNAL. // // A valid identifier is the unique key ID or the Amazon Resource Name (ARN) // of the CMK. Examples: // // * Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab // // * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab // // KeyId is a required field KeyId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DeleteImportedKeyMaterialRequest
func (DeleteImportedKeyMaterialInput) GoString ¶
func (s DeleteImportedKeyMaterialInput) GoString() string
GoString returns the string representation
func (*DeleteImportedKeyMaterialInput) SetKeyId ¶
func (s *DeleteImportedKeyMaterialInput) SetKeyId(v string) *DeleteImportedKeyMaterialInput
SetKeyId sets the KeyId field's value.
func (DeleteImportedKeyMaterialInput) String ¶
func (s DeleteImportedKeyMaterialInput) String() string
String returns the string representation
func (*DeleteImportedKeyMaterialInput) Validate ¶
func (s *DeleteImportedKeyMaterialInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteImportedKeyMaterialOutput ¶
type DeleteImportedKeyMaterialOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DeleteImportedKeyMaterialOutput
func (DeleteImportedKeyMaterialOutput) GoString ¶
func (s DeleteImportedKeyMaterialOutput) GoString() string
GoString returns the string representation
func (DeleteImportedKeyMaterialOutput) SDKResponseMetadata ¶
func (s DeleteImportedKeyMaterialOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DeleteImportedKeyMaterialOutput) String ¶
func (s DeleteImportedKeyMaterialOutput) String() string
String returns the string representation
type DeleteImportedKeyMaterialRequest ¶
type DeleteImportedKeyMaterialRequest struct { *aws.Request Input *DeleteImportedKeyMaterialInput }
DeleteImportedKeyMaterialRequest is a API request type for the DeleteImportedKeyMaterial API operation.
func (DeleteImportedKeyMaterialRequest) Send ¶
func (r DeleteImportedKeyMaterialRequest) Send() (*DeleteImportedKeyMaterialOutput, error)
Send marshals and sends the DeleteImportedKeyMaterial API request.
type DescribeKeyInput ¶
type DescribeKeyInput struct { // A list of grant tokens. // // For more information, see Grant Tokens (http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token) // in the AWS Key Management Service Developer Guide. GrantTokens []string `type:"list"` // A unique identifier for the customer master key. This value can be a globally // unique identifier, a fully specified ARN to either an alias or a key, or // an alias name prefixed by "alias/". // // * Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 // // * Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName // // * Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012 // // * Alias Name Example - alias/MyAliasName // // KeyId is a required field KeyId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DescribeKeyRequest
func (DescribeKeyInput) GoString ¶
func (s DescribeKeyInput) GoString() string
GoString returns the string representation
func (*DescribeKeyInput) SetGrantTokens ¶
func (s *DescribeKeyInput) SetGrantTokens(v []string) *DescribeKeyInput
SetGrantTokens sets the GrantTokens field's value.
func (*DescribeKeyInput) SetKeyId ¶
func (s *DescribeKeyInput) SetKeyId(v string) *DescribeKeyInput
SetKeyId sets the KeyId field's value.
func (DescribeKeyInput) String ¶
func (s DescribeKeyInput) String() string
String returns the string representation
func (*DescribeKeyInput) Validate ¶
func (s *DescribeKeyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeKeyOutput ¶
type DescribeKeyOutput struct { // Metadata associated with the key. KeyMetadata *KeyMetadata `type:"structure"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DescribeKeyResponse
func (DescribeKeyOutput) GoString ¶
func (s DescribeKeyOutput) GoString() string
GoString returns the string representation
func (DescribeKeyOutput) SDKResponseMetadata ¶
func (s DescribeKeyOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (*DescribeKeyOutput) SetKeyMetadata ¶
func (s *DescribeKeyOutput) SetKeyMetadata(v *KeyMetadata) *DescribeKeyOutput
SetKeyMetadata sets the KeyMetadata field's value.
func (DescribeKeyOutput) String ¶
func (s DescribeKeyOutput) String() string
String returns the string representation
type DescribeKeyRequest ¶
type DescribeKeyRequest struct { *aws.Request Input *DescribeKeyInput }
DescribeKeyRequest is a API request type for the DescribeKey API operation.
func (DescribeKeyRequest) Send ¶
func (r DescribeKeyRequest) Send() (*DescribeKeyOutput, error)
Send marshals and sends the DescribeKey API request.
type DisableKeyInput ¶
type DisableKeyInput struct { // A unique identifier for the CMK. // // Use the CMK's unique identifier or its Amazon Resource Name (ARN). For example: // // * Unique ID: 1234abcd-12ab-34cd-56ef-1234567890ab // // * ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab // // KeyId is a required field KeyId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DisableKeyRequest
func (DisableKeyInput) GoString ¶
func (s DisableKeyInput) GoString() string
GoString returns the string representation
func (*DisableKeyInput) SetKeyId ¶
func (s *DisableKeyInput) SetKeyId(v string) *DisableKeyInput
SetKeyId sets the KeyId field's value.
func (DisableKeyInput) String ¶
func (s DisableKeyInput) String() string
String returns the string representation
func (*DisableKeyInput) Validate ¶
func (s *DisableKeyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DisableKeyOutput ¶
type DisableKeyOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DisableKeyOutput
func (DisableKeyOutput) GoString ¶
func (s DisableKeyOutput) GoString() string
GoString returns the string representation
func (DisableKeyOutput) SDKResponseMetadata ¶
func (s DisableKeyOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DisableKeyOutput) String ¶
func (s DisableKeyOutput) String() string
String returns the string representation
type DisableKeyRequest ¶
type DisableKeyRequest struct { *aws.Request Input *DisableKeyInput }
DisableKeyRequest is a API request type for the DisableKey API operation.
func (DisableKeyRequest) Send ¶
func (r DisableKeyRequest) Send() (*DisableKeyOutput, error)
Send marshals and sends the DisableKey API request.
type DisableKeyRotationInput ¶
type DisableKeyRotationInput struct { // A unique identifier for the customer master key. This value can be a globally // unique identifier or the fully specified ARN to 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 // // KeyId is a required field KeyId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DisableKeyRotationRequest
func (DisableKeyRotationInput) GoString ¶
func (s DisableKeyRotationInput) GoString() string
GoString returns the string representation
func (*DisableKeyRotationInput) SetKeyId ¶
func (s *DisableKeyRotationInput) SetKeyId(v string) *DisableKeyRotationInput
SetKeyId sets the KeyId field's value.
func (DisableKeyRotationInput) String ¶
func (s DisableKeyRotationInput) String() string
String returns the string representation
func (*DisableKeyRotationInput) Validate ¶
func (s *DisableKeyRotationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DisableKeyRotationOutput ¶
type DisableKeyRotationOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DisableKeyRotationOutput
func (DisableKeyRotationOutput) GoString ¶
func (s DisableKeyRotationOutput) GoString() string
GoString returns the string representation
func (DisableKeyRotationOutput) SDKResponseMetadata ¶
func (s DisableKeyRotationOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DisableKeyRotationOutput) String ¶
func (s DisableKeyRotationOutput) String() string
String returns the string representation
type DisableKeyRotationRequest ¶
type DisableKeyRotationRequest struct { *aws.Request Input *DisableKeyRotationInput }
DisableKeyRotationRequest is a API request type for the DisableKeyRotation API operation.
func (DisableKeyRotationRequest) Send ¶
func (r DisableKeyRotationRequest) Send() (*DisableKeyRotationOutput, error)
Send marshals and sends the DisableKeyRotation API request.
type EnableKeyInput ¶
type EnableKeyInput struct { // A unique identifier for the customer master key. This value can be a globally // unique identifier or the fully specified ARN to 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 // // KeyId is a required field KeyId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/EnableKeyRequest
func (EnableKeyInput) GoString ¶
func (s EnableKeyInput) GoString() string
GoString returns the string representation
func (*EnableKeyInput) SetKeyId ¶
func (s *EnableKeyInput) SetKeyId(v string) *EnableKeyInput
SetKeyId sets the KeyId field's value.
func (EnableKeyInput) String ¶
func (s EnableKeyInput) String() string
String returns the string representation
func (*EnableKeyInput) Validate ¶
func (s *EnableKeyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type EnableKeyOutput ¶
type EnableKeyOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/EnableKeyOutput
func (EnableKeyOutput) GoString ¶
func (s EnableKeyOutput) GoString() string
GoString returns the string representation
func (EnableKeyOutput) SDKResponseMetadata ¶
func (s EnableKeyOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (EnableKeyOutput) String ¶
func (s EnableKeyOutput) String() string
String returns the string representation
type EnableKeyRequest ¶
type EnableKeyRequest struct { *aws.Request Input *EnableKeyInput }
EnableKeyRequest is a API request type for the EnableKey API operation.
func (EnableKeyRequest) Send ¶
func (r EnableKeyRequest) Send() (*EnableKeyOutput, error)
Send marshals and sends the EnableKey API request.
type EnableKeyRotationInput ¶
type EnableKeyRotationInput struct { // A unique identifier for the customer master key. This value can be a globally // unique identifier or the fully specified ARN to 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 // // KeyId is a required field KeyId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/EnableKeyRotationRequest
func (EnableKeyRotationInput) GoString ¶
func (s EnableKeyRotationInput) GoString() string
GoString returns the string representation
func (*EnableKeyRotationInput) SetKeyId ¶
func (s *EnableKeyRotationInput) SetKeyId(v string) *EnableKeyRotationInput
SetKeyId sets the KeyId field's value.
func (EnableKeyRotationInput) String ¶
func (s EnableKeyRotationInput) String() string
String returns the string representation
func (*EnableKeyRotationInput) Validate ¶
func (s *EnableKeyRotationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type EnableKeyRotationOutput ¶
type EnableKeyRotationOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/EnableKeyRotationOutput
func (EnableKeyRotationOutput) GoString ¶
func (s EnableKeyRotationOutput) GoString() string
GoString returns the string representation
func (EnableKeyRotationOutput) SDKResponseMetadata ¶
func (s EnableKeyRotationOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (EnableKeyRotationOutput) String ¶
func (s EnableKeyRotationOutput) String() string
String returns the string representation
type EnableKeyRotationRequest ¶
type EnableKeyRotationRequest struct { *aws.Request Input *EnableKeyRotationInput }
EnableKeyRotationRequest is a API request type for the EnableKeyRotation API operation.
func (EnableKeyRotationRequest) Send ¶
func (r EnableKeyRotationRequest) Send() (*EnableKeyRotationOutput, error)
Send marshals and sends the EnableKeyRotation API request.
type EncryptInput ¶
type EncryptInput struct { // 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 // (http://docs.aws.amazon.com/kms/latest/developerguide/encryption-context.html). EncryptionContext map[string]string `type:"map"` // A list of grant tokens. // // For more information, see Grant Tokens (http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token) // in the AWS Key Management Service Developer Guide. GrantTokens []string `type:"list"` // A unique identifier for the customer master key. This value can be a globally // unique identifier, a fully specified ARN to either an alias or a key, or // an alias name prefixed by "alias/". // // * Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 // // * Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName // // * Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012 // // * Alias Name Example - alias/MyAliasName // // KeyId is a required field KeyId *string `min:"1" type:"string" required:"true"` // Data to be encrypted. // // Plaintext is automatically base64 encoded/decoded by the SDK. // // Plaintext is a required field Plaintext []byte `min:"1" type:"blob" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/EncryptRequest
func (EncryptInput) GoString ¶
func (s EncryptInput) GoString() string
GoString returns the string representation
func (*EncryptInput) SetEncryptionContext ¶
func (s *EncryptInput) SetEncryptionContext(v map[string]string) *EncryptInput
SetEncryptionContext sets the EncryptionContext field's value.
func (*EncryptInput) SetGrantTokens ¶
func (s *EncryptInput) SetGrantTokens(v []string) *EncryptInput
SetGrantTokens sets the GrantTokens field's value.
func (*EncryptInput) SetKeyId ¶
func (s *EncryptInput) SetKeyId(v string) *EncryptInput
SetKeyId sets the KeyId field's value.
func (*EncryptInput) SetPlaintext ¶
func (s *EncryptInput) SetPlaintext(v []byte) *EncryptInput
SetPlaintext sets the Plaintext field's value.
func (EncryptInput) String ¶
func (s EncryptInput) String() string
String returns the string representation
func (*EncryptInput) Validate ¶
func (s *EncryptInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type EncryptOutput ¶
type EncryptOutput struct { // The encrypted plaintext. If you are using the CLI, the value is Base64 encoded. // Otherwise, it is not encoded. // // CiphertextBlob is automatically base64 encoded/decoded by the SDK. CiphertextBlob []byte `min:"1" type:"blob"` // The ID of the key used during encryption. KeyId *string `min:"1" type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/EncryptResponse
func (EncryptOutput) GoString ¶
func (s EncryptOutput) GoString() string
GoString returns the string representation
func (EncryptOutput) SDKResponseMetadata ¶
func (s EncryptOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (*EncryptOutput) SetCiphertextBlob ¶
func (s *EncryptOutput) SetCiphertextBlob(v []byte) *EncryptOutput
SetCiphertextBlob sets the CiphertextBlob field's value.
func (*EncryptOutput) SetKeyId ¶
func (s *EncryptOutput) SetKeyId(v string) *EncryptOutput
SetKeyId sets the KeyId field's value.
func (EncryptOutput) String ¶
func (s EncryptOutput) String() string
String returns the string representation
type EncryptRequest ¶
type EncryptRequest struct { *aws.Request Input *EncryptInput }
EncryptRequest is a API request type for the Encrypt API operation.
func (EncryptRequest) Send ¶
func (r EncryptRequest) Send() (*EncryptOutput, error)
Send marshals and sends the Encrypt API request.
type ExpirationModelType ¶
type ExpirationModelType string
const ( ExpirationModelTypeKeyMaterialExpires ExpirationModelType = "KEY_MATERIAL_EXPIRES" ExpirationModelTypeKeyMaterialDoesNotExpire ExpirationModelType = "KEY_MATERIAL_DOES_NOT_EXPIRE" )
Enum values for ExpirationModelType
type GenerateDataKeyInput ¶
type GenerateDataKeyInput struct { // A set of key-value pairs that represents additional authenticated data. // // For more information, see Encryption Context (http://docs.aws.amazon.com/kms/latest/developerguide/encryption-context.html) // in the AWS Key Management Service Developer Guide. EncryptionContext map[string]string `type:"map"` // A list of grant tokens. // // For more information, see Grant Tokens (http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token) // in the AWS Key Management Service Developer Guide. GrantTokens []string `type:"list"` // The identifier of the CMK under which to generate and encrypt the data encryption // key. // // A valid identifier is the unique key ID or the Amazon Resource Name (ARN) // of the CMK, or the alias name or ARN of an alias that refers to the CMK. // Examples: // // * Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab // // * CMK 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 // // KeyId is a required field KeyId *string `min:"1" type:"string" required:"true"` // The length of the data encryption key. Use AES_128 to generate a 128-bit // symmetric key, or AES_256 to generate a 256-bit symmetric key. KeySpec DataKeySpec `type:"string" enum:"true"` // The length of the data encryption key in bytes. For example, use the value // 64 to generate a 512-bit data key (64 bytes is 512 bits). For common key // lengths (128-bit and 256-bit symmetric keys), we recommend that you use the // KeySpec field instead of this one. NumberOfBytes *int64 `min:"1" type:"integer"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKeyRequest
func (GenerateDataKeyInput) GoString ¶
func (s GenerateDataKeyInput) GoString() string
GoString returns the string representation
func (*GenerateDataKeyInput) SetEncryptionContext ¶
func (s *GenerateDataKeyInput) SetEncryptionContext(v map[string]string) *GenerateDataKeyInput
SetEncryptionContext sets the EncryptionContext field's value.
func (*GenerateDataKeyInput) SetGrantTokens ¶
func (s *GenerateDataKeyInput) SetGrantTokens(v []string) *GenerateDataKeyInput
SetGrantTokens sets the GrantTokens field's value.
func (*GenerateDataKeyInput) SetKeyId ¶
func (s *GenerateDataKeyInput) SetKeyId(v string) *GenerateDataKeyInput
SetKeyId sets the KeyId field's value.
func (*GenerateDataKeyInput) SetKeySpec ¶
func (s *GenerateDataKeyInput) SetKeySpec(v DataKeySpec) *GenerateDataKeyInput
SetKeySpec sets the KeySpec field's value.
func (*GenerateDataKeyInput) SetNumberOfBytes ¶
func (s *GenerateDataKeyInput) SetNumberOfBytes(v int64) *GenerateDataKeyInput
SetNumberOfBytes sets the NumberOfBytes field's value.
func (GenerateDataKeyInput) String ¶
func (s GenerateDataKeyInput) String() string
String returns the string representation
func (*GenerateDataKeyInput) Validate ¶
func (s *GenerateDataKeyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GenerateDataKeyOutput ¶
type GenerateDataKeyOutput struct { // The encrypted data encryption key. // // CiphertextBlob is automatically base64 encoded/decoded by the SDK. CiphertextBlob []byte `min:"1" type:"blob"` // The identifier of the CMK under which the data encryption key was generated // and encrypted. KeyId *string `min:"1" type:"string"` // The data encryption key. Use this data key for local encryption and decryption, // then remove it from memory as soon as possible. // // Plaintext is automatically base64 encoded/decoded by the SDK. Plaintext []byte `min:"1" type:"blob"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKeyResponse
func (GenerateDataKeyOutput) GoString ¶
func (s GenerateDataKeyOutput) GoString() string
GoString returns the string representation
func (GenerateDataKeyOutput) SDKResponseMetadata ¶
func (s GenerateDataKeyOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (*GenerateDataKeyOutput) SetCiphertextBlob ¶
func (s *GenerateDataKeyOutput) SetCiphertextBlob(v []byte) *GenerateDataKeyOutput
SetCiphertextBlob sets the CiphertextBlob field's value.
func (*GenerateDataKeyOutput) SetKeyId ¶
func (s *GenerateDataKeyOutput) SetKeyId(v string) *GenerateDataKeyOutput
SetKeyId sets the KeyId field's value.
func (*GenerateDataKeyOutput) SetPlaintext ¶
func (s *GenerateDataKeyOutput) SetPlaintext(v []byte) *GenerateDataKeyOutput
SetPlaintext sets the Plaintext field's value.
func (GenerateDataKeyOutput) String ¶
func (s GenerateDataKeyOutput) String() string
String returns the string representation
type GenerateDataKeyRequest ¶
type GenerateDataKeyRequest struct { *aws.Request Input *GenerateDataKeyInput }
GenerateDataKeyRequest is a API request type for the GenerateDataKey API operation.
func (GenerateDataKeyRequest) Send ¶
func (r GenerateDataKeyRequest) Send() (*GenerateDataKeyOutput, error)
Send marshals and sends the GenerateDataKey API request.
type GenerateDataKeyWithoutPlaintextInput ¶
type GenerateDataKeyWithoutPlaintextInput struct { // A set of key-value pairs that represents additional authenticated data. // // For more information, see Encryption Context (http://docs.aws.amazon.com/kms/latest/developerguide/encryption-context.html) // in the AWS Key Management Service Developer Guide. EncryptionContext map[string]string `type:"map"` // A list of grant tokens. // // For more information, see Grant Tokens (http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token) // in the AWS Key Management Service Developer Guide. GrantTokens []string `type:"list"` // The identifier of the CMK under which to generate and encrypt the data encryption // key. // // A valid identifier is the unique key ID or the Amazon Resource Name (ARN) // of the CMK, or the alias name or ARN of an alias that refers to the CMK. // Examples: // // * Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab // // * CMK 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 // // KeyId is a required field KeyId *string `min:"1" type:"string" required:"true"` // The length of the data encryption key. Use AES_128 to generate a 128-bit // symmetric key, or AES_256 to generate a 256-bit symmetric key. KeySpec DataKeySpec `type:"string" enum:"true"` // The length of the data encryption key in bytes. For example, use the value // 64 to generate a 512-bit data key (64 bytes is 512 bits). For common key // lengths (128-bit and 256-bit symmetric keys), we recommend that you use the // KeySpec field instead of this one. NumberOfBytes *int64 `min:"1" type:"integer"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKeyWithoutPlaintextRequest
func (GenerateDataKeyWithoutPlaintextInput) GoString ¶
func (s GenerateDataKeyWithoutPlaintextInput) GoString() string
GoString returns the string representation
func (*GenerateDataKeyWithoutPlaintextInput) SetEncryptionContext ¶
func (s *GenerateDataKeyWithoutPlaintextInput) SetEncryptionContext(v map[string]string) *GenerateDataKeyWithoutPlaintextInput
SetEncryptionContext sets the EncryptionContext field's value.
func (*GenerateDataKeyWithoutPlaintextInput) SetGrantTokens ¶
func (s *GenerateDataKeyWithoutPlaintextInput) SetGrantTokens(v []string) *GenerateDataKeyWithoutPlaintextInput
SetGrantTokens sets the GrantTokens field's value.
func (*GenerateDataKeyWithoutPlaintextInput) SetKeyId ¶
func (s *GenerateDataKeyWithoutPlaintextInput) SetKeyId(v string) *GenerateDataKeyWithoutPlaintextInput
SetKeyId sets the KeyId field's value.
func (*GenerateDataKeyWithoutPlaintextInput) SetKeySpec ¶
func (s *GenerateDataKeyWithoutPlaintextInput) SetKeySpec(v DataKeySpec) *GenerateDataKeyWithoutPlaintextInput
SetKeySpec sets the KeySpec field's value.
func (*GenerateDataKeyWithoutPlaintextInput) SetNumberOfBytes ¶
func (s *GenerateDataKeyWithoutPlaintextInput) SetNumberOfBytes(v int64) *GenerateDataKeyWithoutPlaintextInput
SetNumberOfBytes sets the NumberOfBytes field's value.
func (GenerateDataKeyWithoutPlaintextInput) String ¶
func (s GenerateDataKeyWithoutPlaintextInput) String() string
String returns the string representation
func (*GenerateDataKeyWithoutPlaintextInput) Validate ¶
func (s *GenerateDataKeyWithoutPlaintextInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GenerateDataKeyWithoutPlaintextOutput ¶
type GenerateDataKeyWithoutPlaintextOutput struct { // The encrypted data encryption key. // // CiphertextBlob is automatically base64 encoded/decoded by the SDK. CiphertextBlob []byte `min:"1" type:"blob"` // The identifier of the CMK under which the data encryption key was generated // and encrypted. KeyId *string `min:"1" type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKeyWithoutPlaintextResponse
func (GenerateDataKeyWithoutPlaintextOutput) GoString ¶
func (s GenerateDataKeyWithoutPlaintextOutput) GoString() string
GoString returns the string representation
func (GenerateDataKeyWithoutPlaintextOutput) SDKResponseMetadata ¶
func (s GenerateDataKeyWithoutPlaintextOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (*GenerateDataKeyWithoutPlaintextOutput) SetCiphertextBlob ¶
func (s *GenerateDataKeyWithoutPlaintextOutput) SetCiphertextBlob(v []byte) *GenerateDataKeyWithoutPlaintextOutput
SetCiphertextBlob sets the CiphertextBlob field's value.
func (*GenerateDataKeyWithoutPlaintextOutput) SetKeyId ¶
func (s *GenerateDataKeyWithoutPlaintextOutput) SetKeyId(v string) *GenerateDataKeyWithoutPlaintextOutput
SetKeyId sets the KeyId field's value.
func (GenerateDataKeyWithoutPlaintextOutput) String ¶
func (s GenerateDataKeyWithoutPlaintextOutput) String() string
String returns the string representation
type GenerateDataKeyWithoutPlaintextRequest ¶
type GenerateDataKeyWithoutPlaintextRequest struct { *aws.Request Input *GenerateDataKeyWithoutPlaintextInput }
GenerateDataKeyWithoutPlaintextRequest is a API request type for the GenerateDataKeyWithoutPlaintext API operation.
func (GenerateDataKeyWithoutPlaintextRequest) Send ¶
func (r GenerateDataKeyWithoutPlaintextRequest) Send() (*GenerateDataKeyWithoutPlaintextOutput, error)
Send marshals and sends the GenerateDataKeyWithoutPlaintext API request.
type GenerateRandomInput ¶
type GenerateRandomInput struct { // The length of the byte string. NumberOfBytes *int64 `min:"1" type:"integer"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateRandomRequest
func (GenerateRandomInput) GoString ¶
func (s GenerateRandomInput) GoString() string
GoString returns the string representation
func (*GenerateRandomInput) SetNumberOfBytes ¶
func (s *GenerateRandomInput) SetNumberOfBytes(v int64) *GenerateRandomInput
SetNumberOfBytes sets the NumberOfBytes field's value.
func (GenerateRandomInput) String ¶
func (s GenerateRandomInput) String() string
String returns the string representation
func (*GenerateRandomInput) Validate ¶
func (s *GenerateRandomInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GenerateRandomOutput ¶
type GenerateRandomOutput struct { // The random byte string. // // Plaintext is automatically base64 encoded/decoded by the SDK. Plaintext []byte `min:"1" type:"blob"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateRandomResponse
func (GenerateRandomOutput) GoString ¶
func (s GenerateRandomOutput) GoString() string
GoString returns the string representation
func (GenerateRandomOutput) SDKResponseMetadata ¶
func (s GenerateRandomOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (*GenerateRandomOutput) SetPlaintext ¶
func (s *GenerateRandomOutput) SetPlaintext(v []byte) *GenerateRandomOutput
SetPlaintext sets the Plaintext field's value.
func (GenerateRandomOutput) String ¶
func (s GenerateRandomOutput) String() string
String returns the string representation
type GenerateRandomRequest ¶
type GenerateRandomRequest struct { *aws.Request Input *GenerateRandomInput }
GenerateRandomRequest is a API request type for the GenerateRandom API operation.
func (GenerateRandomRequest) Send ¶
func (r GenerateRandomRequest) Send() (*GenerateRandomOutput, error)
Send marshals and sends the GenerateRandom API request.
type GetKeyPolicyInput ¶
type GetKeyPolicyInput struct { // A unique identifier for the customer master key. This value can be a globally // unique identifier or the fully specified ARN to 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 // // KeyId is a required field KeyId *string `min:"1" type:"string" required:"true"` // String that contains the name of the policy. Currently, this must be "default". // Policy names can be discovered by calling ListKeyPolicies. // // PolicyName is a required field PolicyName *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetKeyPolicyRequest
func (GetKeyPolicyInput) GoString ¶
func (s GetKeyPolicyInput) GoString() string
GoString returns the string representation
func (*GetKeyPolicyInput) SetKeyId ¶
func (s *GetKeyPolicyInput) SetKeyId(v string) *GetKeyPolicyInput
SetKeyId sets the KeyId field's value.
func (*GetKeyPolicyInput) SetPolicyName ¶
func (s *GetKeyPolicyInput) SetPolicyName(v string) *GetKeyPolicyInput
SetPolicyName sets the PolicyName field's value.
func (GetKeyPolicyInput) String ¶
func (s GetKeyPolicyInput) String() string
String returns the string representation
func (*GetKeyPolicyInput) Validate ¶
func (s *GetKeyPolicyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetKeyPolicyOutput ¶
type GetKeyPolicyOutput struct { // A policy document in JSON format. Policy *string `min:"1" type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetKeyPolicyResponse
func (GetKeyPolicyOutput) GoString ¶
func (s GetKeyPolicyOutput) GoString() string
GoString returns the string representation
func (GetKeyPolicyOutput) SDKResponseMetadata ¶
func (s GetKeyPolicyOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (*GetKeyPolicyOutput) SetPolicy ¶
func (s *GetKeyPolicyOutput) SetPolicy(v string) *GetKeyPolicyOutput
SetPolicy sets the Policy field's value.
func (GetKeyPolicyOutput) String ¶
func (s GetKeyPolicyOutput) String() string
String returns the string representation
type GetKeyPolicyRequest ¶
type GetKeyPolicyRequest struct { *aws.Request Input *GetKeyPolicyInput }
GetKeyPolicyRequest is a API request type for the GetKeyPolicy API operation.
func (GetKeyPolicyRequest) Send ¶
func (r GetKeyPolicyRequest) Send() (*GetKeyPolicyOutput, error)
Send marshals and sends the GetKeyPolicy API request.
type GetKeyRotationStatusInput ¶
type GetKeyRotationStatusInput struct { // A unique identifier for the customer master key. This value can be a globally // unique identifier or the fully specified ARN to 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 // // KeyId is a required field KeyId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetKeyRotationStatusRequest
func (GetKeyRotationStatusInput) GoString ¶
func (s GetKeyRotationStatusInput) GoString() string
GoString returns the string representation
func (*GetKeyRotationStatusInput) SetKeyId ¶
func (s *GetKeyRotationStatusInput) SetKeyId(v string) *GetKeyRotationStatusInput
SetKeyId sets the KeyId field's value.
func (GetKeyRotationStatusInput) String ¶
func (s GetKeyRotationStatusInput) String() string
String returns the string representation
func (*GetKeyRotationStatusInput) Validate ¶
func (s *GetKeyRotationStatusInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetKeyRotationStatusOutput ¶
type GetKeyRotationStatusOutput struct { // A Boolean value that specifies whether key rotation is enabled. KeyRotationEnabled *bool `type:"boolean"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetKeyRotationStatusResponse
func (GetKeyRotationStatusOutput) GoString ¶
func (s GetKeyRotationStatusOutput) GoString() string
GoString returns the string representation
func (GetKeyRotationStatusOutput) SDKResponseMetadata ¶
func (s GetKeyRotationStatusOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (*GetKeyRotationStatusOutput) SetKeyRotationEnabled ¶
func (s *GetKeyRotationStatusOutput) SetKeyRotationEnabled(v bool) *GetKeyRotationStatusOutput
SetKeyRotationEnabled sets the KeyRotationEnabled field's value.
func (GetKeyRotationStatusOutput) String ¶
func (s GetKeyRotationStatusOutput) String() string
String returns the string representation
type GetKeyRotationStatusRequest ¶
type GetKeyRotationStatusRequest struct { *aws.Request Input *GetKeyRotationStatusInput }
GetKeyRotationStatusRequest is a API request type for the GetKeyRotationStatus API operation.
func (GetKeyRotationStatusRequest) Send ¶
func (r GetKeyRotationStatusRequest) Send() (*GetKeyRotationStatusOutput, error)
Send marshals and sends the GetKeyRotationStatus API request.
type GetParametersForImportInput ¶
type GetParametersForImportInput struct { // The identifier of the CMK into which you will import key material. The CMK's // Origin must be EXTERNAL. // // A valid identifier is the unique key ID or the Amazon Resource Name (ARN) // of the CMK. Examples: // // * Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab // // * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab // // KeyId is a required field KeyId *string `min:"1" type:"string" required:"true"` // The algorithm you will use to encrypt the key material before importing it // with ImportKeyMaterial. For more information, see Encrypt the Key Material // (http://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-encrypt-key-material.html) // in the AWS Key Management Service Developer Guide. // // WrappingAlgorithm is a required field WrappingAlgorithm AlgorithmSpec `type:"string" required:"true" enum:"true"` // The type of wrapping key (public key) to return in the response. Only 2048-bit // RSA public keys are supported. // // WrappingKeySpec is a required field WrappingKeySpec WrappingKeySpec `type:"string" required:"true" enum:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetParametersForImportRequest
func (GetParametersForImportInput) GoString ¶
func (s GetParametersForImportInput) GoString() string
GoString returns the string representation
func (*GetParametersForImportInput) SetKeyId ¶
func (s *GetParametersForImportInput) SetKeyId(v string) *GetParametersForImportInput
SetKeyId sets the KeyId field's value.
func (*GetParametersForImportInput) SetWrappingAlgorithm ¶
func (s *GetParametersForImportInput) SetWrappingAlgorithm(v AlgorithmSpec) *GetParametersForImportInput
SetWrappingAlgorithm sets the WrappingAlgorithm field's value.
func (*GetParametersForImportInput) SetWrappingKeySpec ¶
func (s *GetParametersForImportInput) SetWrappingKeySpec(v WrappingKeySpec) *GetParametersForImportInput
SetWrappingKeySpec sets the WrappingKeySpec field's value.
func (GetParametersForImportInput) String ¶
func (s GetParametersForImportInput) String() string
String returns the string representation
func (*GetParametersForImportInput) Validate ¶
func (s *GetParametersForImportInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetParametersForImportOutput ¶
type GetParametersForImportOutput struct { // The import token to send in a subsequent ImportKeyMaterial request. // // ImportToken is automatically base64 encoded/decoded by the SDK. ImportToken []byte `min:"1" type:"blob"` // The identifier of the CMK to use in a subsequent ImportKeyMaterial request. // This is the same CMK specified in the GetParametersForImport request. KeyId *string `min:"1" type:"string"` // The time at which the import token and public key are no longer valid. After // this time, you cannot use them to make an ImportKeyMaterial request and you // must send another GetParametersForImport request to retrieve new ones. ParametersValidTo *time.Time `type:"timestamp" timestampFormat:"unix"` // The public key to use to encrypt the key material before importing it with // ImportKeyMaterial. // // PublicKey is automatically base64 encoded/decoded by the SDK. PublicKey []byte `min:"1" type:"blob"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetParametersForImportResponse
func (GetParametersForImportOutput) GoString ¶
func (s GetParametersForImportOutput) GoString() string
GoString returns the string representation
func (GetParametersForImportOutput) SDKResponseMetadata ¶
func (s GetParametersForImportOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (*GetParametersForImportOutput) SetImportToken ¶
func (s *GetParametersForImportOutput) SetImportToken(v []byte) *GetParametersForImportOutput
SetImportToken sets the ImportToken field's value.
func (*GetParametersForImportOutput) SetKeyId ¶
func (s *GetParametersForImportOutput) SetKeyId(v string) *GetParametersForImportOutput
SetKeyId sets the KeyId field's value.
func (*GetParametersForImportOutput) SetParametersValidTo ¶
func (s *GetParametersForImportOutput) SetParametersValidTo(v time.Time) *GetParametersForImportOutput
SetParametersValidTo sets the ParametersValidTo field's value.
func (*GetParametersForImportOutput) SetPublicKey ¶
func (s *GetParametersForImportOutput) SetPublicKey(v []byte) *GetParametersForImportOutput
SetPublicKey sets the PublicKey field's value.
func (GetParametersForImportOutput) String ¶
func (s GetParametersForImportOutput) String() string
String returns the string representation
type GetParametersForImportRequest ¶
type GetParametersForImportRequest struct { *aws.Request Input *GetParametersForImportInput }
GetParametersForImportRequest is a API request type for the GetParametersForImport API operation.
func (GetParametersForImportRequest) Send ¶
func (r GetParametersForImportRequest) Send() (*GetParametersForImportOutput, error)
Send marshals and sends the GetParametersForImport API request.
type GrantConstraints ¶
type GrantConstraints struct { // A list of key-value pairs that must be present in the encryption context // of certain subsequent operations that the grant allows. When certain subsequent // operations allowed by the grant include encryption context that matches this // list, the grant allows the operation. Otherwise, the grant does not allow // the operation. EncryptionContextEquals map[string]string `type:"map"` // A list of key-value pairs, all of which must be present in the encryption // context of certain subsequent operations that the grant allows. When certain // subsequent operations allowed by the grant include encryption context that // matches this list or is a superset of this list, the grant allows the operation. // Otherwise, the grant does not allow the operation. EncryptionContextSubset map[string]string `type:"map"` // contains filtered or unexported fields }
A structure that you can use to allow certain operations in the grant only when the desired encryption context is present. For more information about encryption context, see Encryption Context (http://docs.aws.amazon.com/kms/latest/developerguide/encryption-context.html) in the AWS Key Management Service Developer Guide.
Grant constraints apply only to operations that accept encryption context as input. For example, the DescribeKey operation does not accept encryption context as input. A grant that allows the DescribeKey operation does so regardless of the grant constraints. In constrast, the Encrypt operation accepts encryption context as input. A grant that allows the Encrypt operation does so only when the encryption context of the Encrypt operation satisfies the grant constraints. Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GrantConstraints
func (GrantConstraints) GoString ¶
func (s GrantConstraints) GoString() string
GoString returns the string representation
func (*GrantConstraints) SetEncryptionContextEquals ¶
func (s *GrantConstraints) SetEncryptionContextEquals(v map[string]string) *GrantConstraints
SetEncryptionContextEquals sets the EncryptionContextEquals field's value.
func (*GrantConstraints) SetEncryptionContextSubset ¶
func (s *GrantConstraints) SetEncryptionContextSubset(v map[string]string) *GrantConstraints
SetEncryptionContextSubset sets the EncryptionContextSubset field's value.
func (GrantConstraints) String ¶
func (s GrantConstraints) String() string
String returns the string representation
type GrantListEntry ¶
type GrantListEntry struct { // A list of key-value pairs that must be present in the encryption context // of certain subsequent operations that the grant allows. Constraints *GrantConstraints `type:"structure"` // The date and time when the grant was created. CreationDate *time.Time `type:"timestamp" timestampFormat:"unix"` // The unique identifier for the grant. GrantId *string `min:"1" type:"string"` // The principal that receives the grant's permissions. GranteePrincipal *string `min:"1" type:"string"` // The AWS account under which the grant was issued. IssuingAccount *string `min:"1" type:"string"` // The unique identifier for the customer master key (CMK) to which the grant // applies. KeyId *string `min:"1" type:"string"` // The friendly name that identifies the grant. If a name was provided in the // CreateGrant request, that name is returned. Otherwise this value is null. Name *string `min:"1" type:"string"` // The list of operations permitted by the grant. Operations []GrantOperation `type:"list"` // The principal that can retire the grant. RetiringPrincipal *string `min:"1" type:"string"` // contains filtered or unexported fields }
Contains information about an entry in a list of grants. Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GrantListEntry
func (GrantListEntry) GoString ¶
func (s GrantListEntry) GoString() string
GoString returns the string representation
func (*GrantListEntry) SetConstraints ¶
func (s *GrantListEntry) SetConstraints(v *GrantConstraints) *GrantListEntry
SetConstraints sets the Constraints field's value.
func (*GrantListEntry) SetCreationDate ¶
func (s *GrantListEntry) SetCreationDate(v time.Time) *GrantListEntry
SetCreationDate sets the CreationDate field's value.
func (*GrantListEntry) SetGrantId ¶
func (s *GrantListEntry) SetGrantId(v string) *GrantListEntry
SetGrantId sets the GrantId field's value.
func (*GrantListEntry) SetGranteePrincipal ¶
func (s *GrantListEntry) SetGranteePrincipal(v string) *GrantListEntry
SetGranteePrincipal sets the GranteePrincipal field's value.
func (*GrantListEntry) SetIssuingAccount ¶
func (s *GrantListEntry) SetIssuingAccount(v string) *GrantListEntry
SetIssuingAccount sets the IssuingAccount field's value.
func (*GrantListEntry) SetKeyId ¶
func (s *GrantListEntry) SetKeyId(v string) *GrantListEntry
SetKeyId sets the KeyId field's value.
func (*GrantListEntry) SetName ¶
func (s *GrantListEntry) SetName(v string) *GrantListEntry
SetName sets the Name field's value.
func (*GrantListEntry) SetOperations ¶
func (s *GrantListEntry) SetOperations(v []GrantOperation) *GrantListEntry
SetOperations sets the Operations field's value.
func (*GrantListEntry) SetRetiringPrincipal ¶
func (s *GrantListEntry) SetRetiringPrincipal(v string) *GrantListEntry
SetRetiringPrincipal sets the RetiringPrincipal field's value.
func (GrantListEntry) String ¶
func (s GrantListEntry) String() string
String returns the string representation
type GrantOperation ¶
type GrantOperation string
const ( GrantOperationDecrypt GrantOperation = "Decrypt" GrantOperationEncrypt GrantOperation = "Encrypt" GrantOperationGenerateDataKey GrantOperation = "GenerateDataKey" GrantOperationGenerateDataKeyWithoutPlaintext GrantOperation = "GenerateDataKeyWithoutPlaintext" GrantOperationReEncryptFrom GrantOperation = "ReEncryptFrom" GrantOperationReEncryptTo GrantOperation = "ReEncryptTo" GrantOperationCreateGrant GrantOperation = "CreateGrant" GrantOperationRetireGrant GrantOperation = "RetireGrant" GrantOperationDescribeKey GrantOperation = "DescribeKey" )
Enum values for GrantOperation
type ImportKeyMaterialInput ¶
type ImportKeyMaterialInput struct { // The encrypted key material to import. It must be encrypted with the public // key that you received in the response to a previous GetParametersForImport // request, using the wrapping algorithm that you specified in that request. // // EncryptedKeyMaterial is automatically base64 encoded/decoded by the SDK. // // EncryptedKeyMaterial is a required field EncryptedKeyMaterial []byte `min:"1" type:"blob" required:"true"` // Specifies whether the key material expires. The default is KEY_MATERIAL_EXPIRES, // in which case you must include the ValidTo parameter. When this parameter // is set to KEY_MATERIAL_DOES_NOT_EXPIRE, you must omit the ValidTo parameter. ExpirationModel ExpirationModelType `type:"string" enum:"true"` // The import token that you received in the response to a previous GetParametersForImport // request. It must be from the same response that contained the public key // that you used to encrypt the key material. // // ImportToken is automatically base64 encoded/decoded by the SDK. // // ImportToken is a required field ImportToken []byte `min:"1" type:"blob" required:"true"` // The identifier of the CMK to import the key material into. The CMK's Origin // must be EXTERNAL. // // A valid identifier is the unique key ID or the Amazon Resource Name (ARN) // of the CMK. Examples: // // * Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab // // * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab // // KeyId is a required field KeyId *string `min:"1" type:"string" required:"true"` // The time at which the imported key material expires. When the key material // expires, AWS KMS deletes the key material and the CMK becomes unusable. You // must omit this parameter when the ExpirationModel parameter is set to KEY_MATERIAL_DOES_NOT_EXPIRE. // Otherwise it is required. ValidTo *time.Time `type:"timestamp" timestampFormat:"unix"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ImportKeyMaterialRequest
func (ImportKeyMaterialInput) GoString ¶
func (s ImportKeyMaterialInput) GoString() string
GoString returns the string representation
func (*ImportKeyMaterialInput) SetEncryptedKeyMaterial ¶
func (s *ImportKeyMaterialInput) SetEncryptedKeyMaterial(v []byte) *ImportKeyMaterialInput
SetEncryptedKeyMaterial sets the EncryptedKeyMaterial field's value.
func (*ImportKeyMaterialInput) SetExpirationModel ¶
func (s *ImportKeyMaterialInput) SetExpirationModel(v ExpirationModelType) *ImportKeyMaterialInput
SetExpirationModel sets the ExpirationModel field's value.
func (*ImportKeyMaterialInput) SetImportToken ¶
func (s *ImportKeyMaterialInput) SetImportToken(v []byte) *ImportKeyMaterialInput
SetImportToken sets the ImportToken field's value.
func (*ImportKeyMaterialInput) SetKeyId ¶
func (s *ImportKeyMaterialInput) SetKeyId(v string) *ImportKeyMaterialInput
SetKeyId sets the KeyId field's value.
func (*ImportKeyMaterialInput) SetValidTo ¶
func (s *ImportKeyMaterialInput) SetValidTo(v time.Time) *ImportKeyMaterialInput
SetValidTo sets the ValidTo field's value.
func (ImportKeyMaterialInput) String ¶
func (s ImportKeyMaterialInput) String() string
String returns the string representation
func (*ImportKeyMaterialInput) Validate ¶
func (s *ImportKeyMaterialInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ImportKeyMaterialOutput ¶
type ImportKeyMaterialOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ImportKeyMaterialResponse
func (ImportKeyMaterialOutput) GoString ¶
func (s ImportKeyMaterialOutput) GoString() string
GoString returns the string representation
func (ImportKeyMaterialOutput) SDKResponseMetadata ¶
func (s ImportKeyMaterialOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ImportKeyMaterialOutput) String ¶
func (s ImportKeyMaterialOutput) String() string
String returns the string representation
type ImportKeyMaterialRequest ¶
type ImportKeyMaterialRequest struct { *aws.Request Input *ImportKeyMaterialInput }
ImportKeyMaterialRequest is a API request type for the ImportKeyMaterial API operation.
func (ImportKeyMaterialRequest) Send ¶
func (r ImportKeyMaterialRequest) Send() (*ImportKeyMaterialOutput, error)
Send marshals and sends the ImportKeyMaterial API request.
type KMS ¶
KMS provides the API operation methods for making requests to AWS Key Management Service. See this package's package overview docs for details on the service.
KMS methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New ¶
New creates a new instance of the KMS client with a config. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.
Example:
// Create a KMS client from just a config. svc := kms.New(myConfig) // Create a KMS client with additional configuration svc := kms.New(myConfig, aws.NewConfig().WithRegion("us-west-2"))
func (*KMS) CancelKeyDeletionRequest ¶
func (c *KMS) CancelKeyDeletionRequest(input *CancelKeyDeletionInput) CancelKeyDeletionRequest
CancelKeyDeletionRequest returns a request value for making API operation for AWS Key Management Service.
Cancels the deletion of a customer master key (CMK). When this operation is successful, the CMK is set to the Disabled state. To enable a CMK, use EnableKey.
For more information about scheduling and canceling deletion of a CMK, see Deleting Customer Master Keys (http://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html) in the AWS Key Management Service Developer Guide.
// Example sending a request using the CancelKeyDeletionRequest method. req := client.CancelKeyDeletionRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CancelKeyDeletion
func (*KMS) CreateAliasRequest ¶
func (c *KMS) CreateAliasRequest(input *CreateAliasInput) CreateAliasRequest
CreateAliasRequest returns a request value for making API operation for AWS Key Management Service.
Creates a display name for a customer master key. An alias can be used to identify a key and should be unique. The console enforces a one-to-one mapping between the alias and a key. An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word "alias" followed by a forward slash (alias/). An alias that begins with "aws" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS).
The alias and the key it is mapped to must be in the same AWS account and the same region.
To map an alias to a different key, call UpdateAlias.
// Example sending a request using the CreateAliasRequest method. req := client.CreateAliasRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CreateAlias
func (*KMS) CreateGrantRequest ¶
func (c *KMS) CreateGrantRequest(input *CreateGrantInput) CreateGrantRequest
CreateGrantRequest returns a request value for making API operation for AWS Key Management Service.
Adds a grant to a key to specify who can use the key and under what conditions. Grants are alternate permission mechanisms to key policies.
For more information about grants, see Grants (http://docs.aws.amazon.com/kms/latest/developerguide/grants.html) in the AWS Key Management Service Developer Guide.
// Example sending a request using the CreateGrantRequest method. req := client.CreateGrantRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CreateGrant
func (*KMS) CreateKeyRequest ¶
func (c *KMS) CreateKeyRequest(input *CreateKeyInput) CreateKeyRequest
CreateKeyRequest returns a request value for making API operation for AWS Key Management Service.
Creates a customer master key (CMK).
You can use a CMK to encrypt small amounts of data (4 KiB or less) directly, but CMKs are more commonly used to encrypt data encryption keys (DEKs), which are used to encrypt raw data. For more information about DEKs and the difference between CMKs and DEKs, see the following:
The GenerateDataKey operation
AWS Key Management Service Concepts (http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html) in the AWS Key Management Service Developer Guide
// Example sending a request using the CreateKeyRequest method. req := client.CreateKeyRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CreateKey
func (*KMS) DecryptRequest ¶
func (c *KMS) DecryptRequest(input *DecryptInput) DecryptRequest
DecryptRequest returns a request value for making API operation for AWS Key Management Service.
Decrypts ciphertext. Ciphertext is plaintext that has been previously encrypted by using any of the following functions:
GenerateDataKey
GenerateDataKeyWithoutPlaintext
Encrypt
Note that if a caller has been granted access permissions to all keys (through, for example, IAM user policies that grant Decrypt permission on all resources), then ciphertext encrypted by using keys in other accounts where the key grants access to the caller can be decrypted. To remedy this, we recommend that you do not grant Decrypt access in an IAM user policy. Instead grant Decrypt access only in key policies. If you must grant Decrypt access in an IAM user policy, you should scope the resource to specific keys or to specific trusted accounts.
// Example sending a request using the DecryptRequest method. req := client.DecryptRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/Decrypt
func (*KMS) DeleteAliasRequest ¶
func (c *KMS) DeleteAliasRequest(input *DeleteAliasInput) DeleteAliasRequest
DeleteAliasRequest returns a request value for making API operation for AWS Key Management Service.
Deletes the specified alias. To map an alias to a different key, call UpdateAlias.
// Example sending a request using the DeleteAliasRequest method. req := client.DeleteAliasRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DeleteAlias
func (*KMS) DeleteImportedKeyMaterialRequest ¶
func (c *KMS) DeleteImportedKeyMaterialRequest(input *DeleteImportedKeyMaterialInput) DeleteImportedKeyMaterialRequest
DeleteImportedKeyMaterialRequest returns a request value for making API operation for AWS Key Management Service.
Deletes key material that you previously imported and makes the specified customer master key (CMK) unusable. For more information about importing key material into AWS KMS, see Importing Key Material (http://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) in the AWS Key Management Service Developer Guide.
When the specified CMK is in the PendingDeletion state, this operation does not change the CMK's state. Otherwise, it changes the CMK's state to PendingImport.
After you delete key material, you can use ImportKeyMaterial to reimport the same key material into the CMK.
// Example sending a request using the DeleteImportedKeyMaterialRequest method. req := client.DeleteImportedKeyMaterialRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DeleteImportedKeyMaterial
func (*KMS) DescribeKeyRequest ¶
func (c *KMS) DescribeKeyRequest(input *DescribeKeyInput) DescribeKeyRequest
DescribeKeyRequest returns a request value for making API operation for AWS Key Management Service.
Provides detailed information about the specified customer master key.
// Example sending a request using the DescribeKeyRequest method. req := client.DescribeKeyRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DescribeKey
func (*KMS) DisableKeyRequest ¶
func (c *KMS) DisableKeyRequest(input *DisableKeyInput) DisableKeyRequest
DisableKeyRequest returns a request value for making API operation for AWS Key Management Service.
Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for cryptographic operations. For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key (http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the AWS Key Management Service Developer Guide.
// Example sending a request using the DisableKeyRequest method. req := client.DisableKeyRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DisableKey
func (*KMS) DisableKeyRotationRequest ¶
func (c *KMS) DisableKeyRotationRequest(input *DisableKeyRotationInput) DisableKeyRotationRequest
DisableKeyRotationRequest returns a request value for making API operation for AWS Key Management Service.
Disables rotation of the specified key.
// Example sending a request using the DisableKeyRotationRequest method. req := client.DisableKeyRotationRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DisableKeyRotation
func (*KMS) EnableKeyRequest ¶
func (c *KMS) EnableKeyRequest(input *EnableKeyInput) EnableKeyRequest
EnableKeyRequest returns a request value for making API operation for AWS Key Management Service.
Marks a key as enabled, thereby permitting its use.
// Example sending a request using the EnableKeyRequest method. req := client.EnableKeyRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/EnableKey
func (*KMS) EnableKeyRotationRequest ¶
func (c *KMS) EnableKeyRotationRequest(input *EnableKeyRotationInput) EnableKeyRotationRequest
EnableKeyRotationRequest returns a request value for making API operation for AWS Key Management Service.
Enables rotation of the specified customer master key.
// Example sending a request using the EnableKeyRotationRequest method. req := client.EnableKeyRotationRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/EnableKeyRotation
func (*KMS) EncryptRequest ¶
func (c *KMS) EncryptRequest(input *EncryptInput) EncryptRequest
EncryptRequest returns a request value for making API operation for AWS Key Management Service.
Encrypts plaintext into ciphertext by using a customer master key. The Encrypt function has two primary use cases:
You can encrypt up to 4 KB of arbitrary data such as an RSA key, a database password, or other sensitive customer information.
If you are moving encrypted data from one region to another, you can use this API to encrypt in the new region the plaintext data key that was used to encrypt the data in the original region. This provides you with an encrypted copy of the data key that can be decrypted in the new region and used there to decrypt the encrypted data.
Unless you are moving encrypted data from one region to another, you don't use this function to encrypt a generated data key within a region. You retrieve data keys already encrypted by calling the GenerateDataKey or GenerateDataKeyWithoutPlaintext function. Data keys don't need to be encrypted again by calling Encrypt.
If you want to encrypt data locally in your application, you can use the GenerateDataKey function to return a plaintext data encryption key and a copy of the key encrypted under the customer master key (CMK) of your choosing.
// Example sending a request using the EncryptRequest method. req := client.EncryptRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/Encrypt
func (*KMS) GenerateDataKeyRequest ¶
func (c *KMS) GenerateDataKeyRequest(input *GenerateDataKeyInput) GenerateDataKeyRequest
GenerateDataKeyRequest returns a request value for making API operation for AWS Key Management Service.
Returns a data encryption key that you can use in your application to encrypt data locally.
You must specify the customer master key (CMK) under which to generate the data key. You must also specify the length of the data key using either the KeySpec or NumberOfBytes field. You must specify one field or the other, but not both. For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use KeySpec.
This operation returns a plaintext copy of the data key in the Plaintext field of the response, and an encrypted copy of the data key in the CiphertextBlob field. The data key is encrypted under the CMK specified in the KeyId field of the request.
We recommend that you use the following pattern to encrypt data locally in your application:
Use this operation (GenerateDataKey) to retrieve a data encryption key.
Use the plaintext data encryption key (returned in the Plaintext field of the response) to encrypt data locally, then erase the plaintext data key from memory.
Store the encrypted data key (returned in the CiphertextBlob field of the response) alongside the locally encrypted data.
To decrypt data locally:
Use the Decrypt operation to decrypt the encrypted data key into a plaintext copy of the data key.
Use the plaintext data key to decrypt data locally, then erase the plaintext data key from memory.
To return only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To return a random byte string that is cryptographically secure, use GenerateRandom.
If you use the optional EncryptionContext field, you must store at least enough information to be able to reconstruct the full encryption context when you later send the ciphertext to the Decrypt operation. It is a good practice to choose an encryption context that you can reconstruct on the fly to better secure the ciphertext. For more information, see Encryption Context (http://docs.aws.amazon.com/kms/latest/developerguide/encryption-context.html) in the AWS Key Management Service Developer Guide.
// Example sending a request using the GenerateDataKeyRequest method. req := client.GenerateDataKeyRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKey
func (*KMS) GenerateDataKeyWithoutPlaintextRequest ¶
func (c *KMS) GenerateDataKeyWithoutPlaintextRequest(input *GenerateDataKeyWithoutPlaintextInput) GenerateDataKeyWithoutPlaintextRequest
GenerateDataKeyWithoutPlaintextRequest returns a request value for making API operation for AWS Key Management Service.
Returns a data encryption key encrypted under a customer master key (CMK). This operation is identical to GenerateDataKey but returns only the encrypted copy of the data key.
This operation is useful in a system that has multiple components with different degrees of trust. For example, consider a system that stores encrypted data in containers. Each container stores the encrypted data and an encrypted copy of the data key. One component of the system, called the control plane, creates new containers. When it creates a new container, it uses this operation (GenerateDataKeyWithoutPlaintext) to get an encrypted data key and then stores it in the container. Later, a different component of the system, called the data plane, puts encrypted data into the containers. To do this, it passes the encrypted data key to the Decrypt operation, then uses the returned plaintext data key to encrypt data, and finally stores the encrypted data in the container. In this system, the control plane never sees the plaintext data key.
// Example sending a request using the GenerateDataKeyWithoutPlaintextRequest method. req := client.GenerateDataKeyWithoutPlaintextRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKeyWithoutPlaintext
func (*KMS) GenerateRandomRequest ¶
func (c *KMS) GenerateRandomRequest(input *GenerateRandomInput) GenerateRandomRequest
GenerateRandomRequest returns a request value for making API operation for AWS Key Management Service.
Returns a random byte string that is cryptographically secure.
For more information about entropy and random number generation, see the AWS Key Management Service Cryptographic Details (https://d0.awsstatic.com/whitepapers/KMS-Cryptographic-Details.pdf) whitepaper.
// Example sending a request using the GenerateRandomRequest method. req := client.GenerateRandomRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateRandom
func (*KMS) GetKeyPolicyRequest ¶
func (c *KMS) GetKeyPolicyRequest(input *GetKeyPolicyInput) GetKeyPolicyRequest
GetKeyPolicyRequest returns a request value for making API operation for AWS Key Management Service.
Retrieves a policy attached to the specified key.
// Example sending a request using the GetKeyPolicyRequest method. req := client.GetKeyPolicyRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetKeyPolicy
func (*KMS) GetKeyRotationStatusRequest ¶
func (c *KMS) GetKeyRotationStatusRequest(input *GetKeyRotationStatusInput) GetKeyRotationStatusRequest
GetKeyRotationStatusRequest returns a request value for making API operation for AWS Key Management Service.
Retrieves a Boolean value that indicates whether key rotation is enabled for the specified key.
// Example sending a request using the GetKeyRotationStatusRequest method. req := client.GetKeyRotationStatusRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetKeyRotationStatus
func (*KMS) GetParametersForImportRequest ¶
func (c *KMS) GetParametersForImportRequest(input *GetParametersForImportInput) GetParametersForImportRequest
GetParametersForImportRequest returns a request value for making API operation for AWS Key Management Service.
Returns the items you need in order to import key material into AWS KMS from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material (http://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) in the AWS Key Management Service Developer Guide.
You must specify the key ID of the customer master key (CMK) into which you will import key material. This CMK's Origin must be EXTERNAL. You must also specify the wrapping algorithm and type of wrapping key (public key) that you will use to encrypt the key material.
This operation returns a public key and an import token. Use the public key to encrypt the key material. Store the import token to send with a subsequent ImportKeyMaterial request. The public key and import token from the same response must be used together. These items are valid for 24 hours, after which they cannot be used for a subsequent ImportKeyMaterial request. To retrieve new ones, send another GetParametersForImport request.
// Example sending a request using the GetParametersForImportRequest method. req := client.GetParametersForImportRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetParametersForImport
func (*KMS) ImportKeyMaterialRequest ¶
func (c *KMS) ImportKeyMaterialRequest(input *ImportKeyMaterialInput) ImportKeyMaterialRequest
ImportKeyMaterialRequest returns a request value for making API operation for AWS Key Management Service.
Imports key material into an AWS KMS customer master key (CMK) from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material (http://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) in the AWS Key Management Service Developer Guide.
You must specify the key ID of the CMK to import the key material into. This CMK's Origin must be EXTERNAL. You must also send an import token and the encrypted key material. Send the import token that you received in the same GetParametersForImport response that contained the public key that you used to encrypt the key material. You must also specify whether the key material expires and if so, when. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. To use the CMK again, you can reimport the same key material. If you set an expiration date, you can change it only by reimporting the same key material and specifying a new expiration date.
When this operation is successful, the specified CMK's key state changes to Enabled, and you can use the CMK.
After you successfully import key material into a CMK, you can reimport the same key material into that CMK, but you cannot import different key material.
// Example sending a request using the ImportKeyMaterialRequest method. req := client.ImportKeyMaterialRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ImportKeyMaterial
func (*KMS) ListAliasesPages ¶
func (c *KMS) ListAliasesPages(input *ListAliasesInput, fn func(*ListAliasesOutput, bool) bool) error
ListAliasesPages iterates over the pages of a ListAliases operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListAliases method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListAliases operation. pageNum := 0 err := client.ListAliasesPages(params, func(page *ListAliasesOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (*KMS) ListAliasesPagesWithContext ¶
func (c *KMS) ListAliasesPagesWithContext(ctx aws.Context, input *ListAliasesInput, fn func(*ListAliasesOutput, bool) bool, opts ...aws.Option) error
ListAliasesPagesWithContext same as ListAliasesPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*KMS) ListAliasesRequest ¶
func (c *KMS) ListAliasesRequest(input *ListAliasesInput) ListAliasesRequest
ListAliasesRequest returns a request value for making API operation for AWS Key Management Service.
Lists all of the key aliases in the account.
// Example sending a request using the ListAliasesRequest method. req := client.ListAliasesRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListAliases
func (*KMS) ListGrantsPages ¶
func (c *KMS) ListGrantsPages(input *ListGrantsInput, fn func(*ListRetirableGrantsOutput, bool) bool) error
ListGrantsPages iterates over the pages of a ListGrants operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListGrants method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListGrants operation. pageNum := 0 err := client.ListGrantsPages(params, func(page *ListRetirableGrantsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (*KMS) ListGrantsPagesWithContext ¶
func (c *KMS) ListGrantsPagesWithContext(ctx aws.Context, input *ListGrantsInput, fn func(*ListRetirableGrantsOutput, bool) bool, opts ...aws.Option) error
ListGrantsPagesWithContext same as ListGrantsPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*KMS) ListGrantsRequest ¶
func (c *KMS) ListGrantsRequest(input *ListGrantsInput) ListGrantsRequest
ListGrantsRequest returns a request value for making API operation for AWS Key Management Service.
List the grants for a specified key.
// Example sending a request using the ListGrantsRequest method. req := client.ListGrantsRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListGrants
func (*KMS) ListKeyPoliciesPages ¶
func (c *KMS) ListKeyPoliciesPages(input *ListKeyPoliciesInput, fn func(*ListKeyPoliciesOutput, bool) bool) error
ListKeyPoliciesPages iterates over the pages of a ListKeyPolicies operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListKeyPolicies method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListKeyPolicies operation. pageNum := 0 err := client.ListKeyPoliciesPages(params, func(page *ListKeyPoliciesOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (*KMS) ListKeyPoliciesPagesWithContext ¶
func (c *KMS) ListKeyPoliciesPagesWithContext(ctx aws.Context, input *ListKeyPoliciesInput, fn func(*ListKeyPoliciesOutput, bool) bool, opts ...aws.Option) error
ListKeyPoliciesPagesWithContext same as ListKeyPoliciesPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*KMS) ListKeyPoliciesRequest ¶
func (c *KMS) ListKeyPoliciesRequest(input *ListKeyPoliciesInput) ListKeyPoliciesRequest
ListKeyPoliciesRequest returns a request value for making API operation for AWS Key Management Service.
Retrieves a list of policies attached to a key.
// Example sending a request using the ListKeyPoliciesRequest method. req := client.ListKeyPoliciesRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListKeyPolicies
func (*KMS) ListKeysPages ¶
func (c *KMS) ListKeysPages(input *ListKeysInput, fn func(*ListKeysOutput, bool) bool) error
ListKeysPages iterates over the pages of a ListKeys operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListKeys method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListKeys operation. pageNum := 0 err := client.ListKeysPages(params, func(page *ListKeysOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (*KMS) ListKeysPagesWithContext ¶
func (c *KMS) ListKeysPagesWithContext(ctx aws.Context, input *ListKeysInput, fn func(*ListKeysOutput, bool) bool, opts ...aws.Option) error
ListKeysPagesWithContext same as ListKeysPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*KMS) ListKeysRequest ¶
func (c *KMS) ListKeysRequest(input *ListKeysInput) ListKeysRequest
ListKeysRequest returns a request value for making API operation for AWS Key Management Service.
Lists the customer master keys.
// Example sending a request using the ListKeysRequest method. req := client.ListKeysRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListKeys
func (*KMS) ListResourceTagsRequest ¶
func (c *KMS) ListResourceTagsRequest(input *ListResourceTagsInput) ListResourceTagsRequest
ListResourceTagsRequest returns a request value for making API operation for AWS Key Management Service.
Returns a list of all tags for the specified customer master key (CMK).
// Example sending a request using the ListResourceTagsRequest method. req := client.ListResourceTagsRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListResourceTags
func (*KMS) ListRetirableGrantsRequest ¶
func (c *KMS) ListRetirableGrantsRequest(input *ListRetirableGrantsInput) ListRetirableGrantsRequest
ListRetirableGrantsRequest returns a request value for making API operation for AWS Key Management Service.
Returns a list of all grants for which the grant's RetiringPrincipal matches the one specified.
A typical use is to list all grants that you are able to retire. To retire a grant, use RetireGrant.
// Example sending a request using the ListRetirableGrantsRequest method. req := client.ListRetirableGrantsRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListRetirableGrants
func (*KMS) PutKeyPolicyRequest ¶
func (c *KMS) PutKeyPolicyRequest(input *PutKeyPolicyInput) PutKeyPolicyRequest
PutKeyPolicyRequest returns a request value for making API operation for AWS Key Management Service.
Attaches a key policy to the specified customer master key (CMK).
For more information about key policies, see Key Policies (http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html) in the AWS Key Management Service Developer Guide.
// Example sending a request using the PutKeyPolicyRequest method. req := client.PutKeyPolicyRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/PutKeyPolicy
func (*KMS) ReEncryptRequest ¶
func (c *KMS) ReEncryptRequest(input *ReEncryptInput) ReEncryptRequest
ReEncryptRequest returns a request value for making API operation for AWS Key Management Service.
Encrypts data on the server side with a new customer master key (CMK) without exposing the plaintext of the data on the client side. The data is first decrypted and then reencrypted. You can also use this operation to change the encryption context of a ciphertext.
Unlike other operations, ReEncrypt is authorized twice, once as ReEncryptFrom on the source CMK and once as ReEncryptTo on the destination CMK. We recommend that you include the "kms:ReEncrypt*" permission in your key policies (http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html) to permit reencryption from or to the CMK. This permission is automatically included in the key policy when you create a CMK through the console, but you must include it manually when you create a CMK programmatically or when you set a key policy with the PutKeyPolicy operation.
// Example sending a request using the ReEncryptRequest method. req := client.ReEncryptRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ReEncrypt
func (*KMS) RetireGrantRequest ¶
func (c *KMS) RetireGrantRequest(input *RetireGrantInput) RetireGrantRequest
RetireGrantRequest returns a request value for making API operation for AWS Key Management Service.
Retires a grant. To clean up, you can retire a grant when you're done using it. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API:
The AWS account (root user) under which the grant was created
The RetiringPrincipal, if present in the grant
The GranteePrincipal, if RetireGrant is an operation specified in the grant
You must identify the grant to retire by its grant token or by a combination of the grant ID and the Amazon Resource Name (ARN) of the customer master key (CMK). A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. The CreateGrant operation returns both.
// Example sending a request using the RetireGrantRequest method. req := client.RetireGrantRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/RetireGrant
func (*KMS) RevokeGrantRequest ¶
func (c *KMS) RevokeGrantRequest(input *RevokeGrantInput) RevokeGrantRequest
RevokeGrantRequest returns a request value for making API operation for AWS Key Management Service.
Revokes a grant. You can revoke a grant to actively deny operations that depend on it.
// Example sending a request using the RevokeGrantRequest method. req := client.RevokeGrantRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/RevokeGrant
func (*KMS) ScheduleKeyDeletionRequest ¶
func (c *KMS) ScheduleKeyDeletionRequest(input *ScheduleKeyDeletionInput) ScheduleKeyDeletionRequest
ScheduleKeyDeletionRequest returns a request value for making API operation for AWS Key Management Service.
Schedules the deletion of a customer master key (CMK). You may provide a waiting period, specified in days, before deletion occurs. If you do not provide a waiting period, the default period of 30 days is used. When this operation is successful, the state of the CMK changes to PendingDeletion. Before the waiting period ends, you can use CancelKeyDeletion to cancel the deletion of the CMK. After the waiting period ends, AWS KMS deletes the CMK and all AWS KMS data associated with it, including all aliases that refer to it.
Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is deleted, all data that was encrypted under the CMK is rendered unrecoverable. To restrict the use of a CMK without deleting it, use DisableKey.
For more information about scheduling a CMK for deletion, see Deleting Customer Master Keys (http://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html) in the AWS Key Management Service Developer Guide.
// Example sending a request using the ScheduleKeyDeletionRequest method. req := client.ScheduleKeyDeletionRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ScheduleKeyDeletion
func (*KMS) TagResourceRequest ¶
func (c *KMS) TagResourceRequest(input *TagResourceInput) TagResourceRequest
TagResourceRequest returns a request value for making API operation for AWS Key Management Service.
Adds or overwrites one or more tags for the specified customer master key (CMK).
Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.
You cannot use the same tag key more than once per CMK. For example, consider a CMK with one tag whose tag key is Purpose and tag value is Test. If you send a TagResource request for this CMK with a tag key of Purpose and a tag value of Prod, it does not create a second tag. Instead, the original tag is overwritten with the new tag value.
// Example sending a request using the TagResourceRequest method. req := client.TagResourceRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/TagResource
func (*KMS) UntagResourceRequest ¶
func (c *KMS) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest
UntagResourceRequest returns a request value for making API operation for AWS Key Management Service.
Removes the specified tag or tags from the specified customer master key (CMK).
To remove a tag, you specify the tag key for each tag to remove. You do not specify the tag value. To overwrite the tag value for an existing tag, use TagResource.
// Example sending a request using the UntagResourceRequest method. req := client.UntagResourceRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UntagResource
func (*KMS) UpdateAliasRequest ¶
func (c *KMS) UpdateAliasRequest(input *UpdateAliasInput) UpdateAliasRequest
UpdateAliasRequest returns a request value for making API operation for AWS Key Management Service.
Updates an alias to map it to a different key.
An alias is not a property of a key. Therefore, an alias can be mapped to and unmapped from an existing key without changing the properties of the key.
An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word "alias" followed by a forward slash (alias/). An alias that begins with "aws" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS).
The alias and the key it is mapped to must be in the same AWS account and the same region.
// Example sending a request using the UpdateAliasRequest method. req := client.UpdateAliasRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UpdateAlias
func (*KMS) UpdateKeyDescriptionRequest ¶
func (c *KMS) UpdateKeyDescriptionRequest(input *UpdateKeyDescriptionInput) UpdateKeyDescriptionRequest
UpdateKeyDescriptionRequest returns a request value for making API operation for AWS Key Management Service.
Updates the description of a customer master key (CMK).
// Example sending a request using the UpdateKeyDescriptionRequest method. req := client.UpdateKeyDescriptionRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UpdateKeyDescription
type KeyListEntry ¶
type KeyListEntry struct { // ARN of the key. KeyArn *string `min:"20" type:"string"` // Unique identifier of the key. KeyId *string `min:"1" type:"string"` // contains filtered or unexported fields }
Contains information about each entry in the key list. Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/KeyListEntry
func (KeyListEntry) GoString ¶
func (s KeyListEntry) GoString() string
GoString returns the string representation
func (*KeyListEntry) SetKeyArn ¶
func (s *KeyListEntry) SetKeyArn(v string) *KeyListEntry
SetKeyArn sets the KeyArn field's value.
func (*KeyListEntry) SetKeyId ¶
func (s *KeyListEntry) SetKeyId(v string) *KeyListEntry
SetKeyId sets the KeyId field's value.
func (KeyListEntry) String ¶
func (s KeyListEntry) String() string
String returns the string representation
type KeyManagerType ¶
type KeyManagerType string
const ( KeyManagerTypeAws KeyManagerType = "AWS" KeyManagerTypeCustomer KeyManagerType = "CUSTOMER" )
Enum values for KeyManagerType
type KeyMetadata ¶
type KeyMetadata struct { // The twelve-digit account ID of the AWS account that owns the CMK. AWSAccountId *string `type:"string"` // The Amazon Resource Name (ARN) of the CMK. For examples, see AWS Key Management // Service (AWS KMS) (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms) // in the Example ARNs section of the AWS General Reference. Arn *string `min:"20" type:"string"` // The date and time when the CMK was created. CreationDate *time.Time `type:"timestamp" timestampFormat:"unix"` // The date and time after which AWS KMS deletes the CMK. This value is present // only when KeyState is PendingDeletion, otherwise this value is omitted. DeletionDate *time.Time `type:"timestamp" timestampFormat:"unix"` // The description of the CMK. Description *string `type:"string"` // Specifies whether the CMK is enabled. When KeyState is Enabled this value // is true, otherwise it is false. Enabled *bool `type:"boolean"` // Specifies whether the CMK's key material expires. This value is present only // when Origin is EXTERNAL, otherwise this value is omitted. ExpirationModel ExpirationModelType `type:"string" enum:"true"` // The globally unique identifier for the CMK. // // KeyId is a required field KeyId *string `min:"1" type:"string" required:"true"` // The CMK's manager. CMKs are either customer-managed or AWS-managed. For more // information about the difference, see Customer Master Keys (http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys) // in the AWS Key Management Service Developer Guide. KeyManager KeyManagerType `type:"string" enum:"true"` // The state of the CMK. // // For more information about how key state affects the use of a CMK, see How // Key State Affects the Use of a Customer Master Key (http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) // in the AWS Key Management Service Developer Guide. KeyState KeyState `type:"string" enum:"true"` // The cryptographic operations for which you can use the CMK. Currently the // only allowed value is ENCRYPT_DECRYPT, which means you can use the CMK for // the Encrypt and Decrypt operations. KeyUsage KeyUsageType `type:"string" enum:"true"` // The source of the CMK's key material. When this value is AWS_KMS, AWS KMS // created the key material. When this value is EXTERNAL, the key material was // imported from your existing key management infrastructure or the CMK lacks // key material. Origin OriginType `type:"string" enum:"true"` // The time at which the imported key material expires. When the key material // expires, AWS KMS deletes the key material and the CMK becomes unusable. This // value is present only for CMKs whose Origin is EXTERNAL and whose ExpirationModel // is KEY_MATERIAL_EXPIRES, otherwise this value is omitted. ValidTo *time.Time `type:"timestamp" timestampFormat:"unix"` // contains filtered or unexported fields }
Contains metadata about a customer master key (CMK).
This data type is used as a response element for the CreateKey and DescribeKey operations. Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/KeyMetadata
func (KeyMetadata) GoString ¶
func (s KeyMetadata) GoString() string
GoString returns the string representation
func (*KeyMetadata) SetAWSAccountId ¶
func (s *KeyMetadata) SetAWSAccountId(v string) *KeyMetadata
SetAWSAccountId sets the AWSAccountId field's value.
func (*KeyMetadata) SetArn ¶
func (s *KeyMetadata) SetArn(v string) *KeyMetadata
SetArn sets the Arn field's value.
func (*KeyMetadata) SetCreationDate ¶
func (s *KeyMetadata) SetCreationDate(v time.Time) *KeyMetadata
SetCreationDate sets the CreationDate field's value.
func (*KeyMetadata) SetDeletionDate ¶
func (s *KeyMetadata) SetDeletionDate(v time.Time) *KeyMetadata
SetDeletionDate sets the DeletionDate field's value.
func (*KeyMetadata) SetDescription ¶
func (s *KeyMetadata) SetDescription(v string) *KeyMetadata
SetDescription sets the Description field's value.
func (*KeyMetadata) SetEnabled ¶
func (s *KeyMetadata) SetEnabled(v bool) *KeyMetadata
SetEnabled sets the Enabled field's value.
func (*KeyMetadata) SetExpirationModel ¶
func (s *KeyMetadata) SetExpirationModel(v ExpirationModelType) *KeyMetadata
SetExpirationModel sets the ExpirationModel field's value.
func (*KeyMetadata) SetKeyId ¶
func (s *KeyMetadata) SetKeyId(v string) *KeyMetadata
SetKeyId sets the KeyId field's value.
func (*KeyMetadata) SetKeyManager ¶
func (s *KeyMetadata) SetKeyManager(v KeyManagerType) *KeyMetadata
SetKeyManager sets the KeyManager field's value.
func (*KeyMetadata) SetKeyState ¶
func (s *KeyMetadata) SetKeyState(v KeyState) *KeyMetadata
SetKeyState sets the KeyState field's value.
func (*KeyMetadata) SetKeyUsage ¶
func (s *KeyMetadata) SetKeyUsage(v KeyUsageType) *KeyMetadata
SetKeyUsage sets the KeyUsage field's value.
func (*KeyMetadata) SetOrigin ¶
func (s *KeyMetadata) SetOrigin(v OriginType) *KeyMetadata
SetOrigin sets the Origin field's value.
func (*KeyMetadata) SetValidTo ¶
func (s *KeyMetadata) SetValidTo(v time.Time) *KeyMetadata
SetValidTo sets the ValidTo field's value.
func (KeyMetadata) String ¶
func (s KeyMetadata) String() string
String returns the string representation
type KeyUsageType ¶
type KeyUsageType string
const (
KeyUsageTypeEncryptDecrypt KeyUsageType = "ENCRYPT_DECRYPT"
)
Enum values for KeyUsageType
type ListAliasesInput ¶
type ListAliasesInput struct { // Use this parameter to specify the maximum number of items to return. When // this value is present, AWS KMS does not return more than the specified number // of items, but it might return fewer. // // This value is optional. If you include a value, it must be between 1 and // 100, inclusive. If you do not include a value, it defaults to 50. Limit *int64 `min:"1" type:"integer"` // Use this parameter in a subsequent request after you receive a response with // truncated results. Set it to the value of NextMarker from the truncated response // you just received. Marker *string `min:"1" type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListAliasesRequest
func (ListAliasesInput) GoString ¶
func (s ListAliasesInput) GoString() string
GoString returns the string representation
func (*ListAliasesInput) SetLimit ¶
func (s *ListAliasesInput) SetLimit(v int64) *ListAliasesInput
SetLimit sets the Limit field's value.
func (*ListAliasesInput) SetMarker ¶
func (s *ListAliasesInput) SetMarker(v string) *ListAliasesInput
SetMarker sets the Marker field's value.
func (ListAliasesInput) String ¶
func (s ListAliasesInput) String() string
String returns the string representation
func (*ListAliasesInput) Validate ¶
func (s *ListAliasesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListAliasesOutput ¶
type ListAliasesOutput struct { // A list of key aliases in the user's account. Aliases []AliasListEntry `type:"list"` // When Truncated is true, this element is present and contains the value to // use for the Marker parameter in a subsequent request. NextMarker *string `min:"1" type:"string"` // A flag that indicates whether there are more items in the list. When this // value is true, the list in this response is truncated. To retrieve more items, // pass the value of the NextMarker element in this response to the Marker parameter // in a subsequent request. Truncated *bool `type:"boolean"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListAliasesResponse
func (ListAliasesOutput) GoString ¶
func (s ListAliasesOutput) GoString() string
GoString returns the string representation
func (ListAliasesOutput) SDKResponseMetadata ¶
func (s ListAliasesOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (*ListAliasesOutput) SetAliases ¶
func (s *ListAliasesOutput) SetAliases(v []AliasListEntry) *ListAliasesOutput
SetAliases sets the Aliases field's value.
func (*ListAliasesOutput) SetNextMarker ¶
func (s *ListAliasesOutput) SetNextMarker(v string) *ListAliasesOutput
SetNextMarker sets the NextMarker field's value.
func (*ListAliasesOutput) SetTruncated ¶
func (s *ListAliasesOutput) SetTruncated(v bool) *ListAliasesOutput
SetTruncated sets the Truncated field's value.
func (ListAliasesOutput) String ¶
func (s ListAliasesOutput) String() string
String returns the string representation
type ListAliasesRequest ¶
type ListAliasesRequest struct { *aws.Request Input *ListAliasesInput }
ListAliasesRequest is a API request type for the ListAliases API operation.
func (ListAliasesRequest) Send ¶
func (r ListAliasesRequest) Send() (*ListAliasesOutput, error)
Send marshals and sends the ListAliases API request.
type ListGrantsInput ¶
type ListGrantsInput struct { // A unique identifier for the customer master key. This value can be a globally // unique identifier or the fully specified ARN to 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 // // KeyId is a required field KeyId *string `min:"1" type:"string" required:"true"` // Use this parameter to specify the maximum number of items to return. When // this value is present, AWS KMS does not return more than the specified number // of items, but it might return fewer. // // This value is optional. If you include a value, it must be between 1 and // 100, inclusive. If you do not include a value, it defaults to 50. Limit *int64 `min:"1" type:"integer"` // Use this parameter in a subsequent request after you receive a response with // truncated results. Set it to the value of NextMarker from the truncated response // you just received. Marker *string `min:"1" type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListGrantsRequest
func (ListGrantsInput) GoString ¶
func (s ListGrantsInput) GoString() string
GoString returns the string representation
func (*ListGrantsInput) SetKeyId ¶
func (s *ListGrantsInput) SetKeyId(v string) *ListGrantsInput
SetKeyId sets the KeyId field's value.
func (*ListGrantsInput) SetLimit ¶
func (s *ListGrantsInput) SetLimit(v int64) *ListGrantsInput
SetLimit sets the Limit field's value.
func (*ListGrantsInput) SetMarker ¶
func (s *ListGrantsInput) SetMarker(v string) *ListGrantsInput
SetMarker sets the Marker field's value.
func (ListGrantsInput) String ¶
func (s ListGrantsInput) String() string
String returns the string representation
func (*ListGrantsInput) Validate ¶
func (s *ListGrantsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListGrantsRequest ¶
type ListGrantsRequest struct { *aws.Request Input *ListGrantsInput }
ListGrantsRequest is a API request type for the ListGrants API operation.
func (ListGrantsRequest) Send ¶
func (r ListGrantsRequest) Send() (*ListRetirableGrantsOutput, error)
Send marshals and sends the ListGrants API request.
type ListKeyPoliciesInput ¶
type ListKeyPoliciesInput struct { // A unique identifier for the customer master key (CMK). You can use the unique // key ID or the Amazon Resource Name (ARN) of the CMK. Examples: // // * Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab // // * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab // // KeyId is a required field KeyId *string `min:"1" type:"string" required:"true"` // Use this parameter to specify the maximum number of items to return. When // this value is present, AWS KMS does not return more than the specified number // of items, but it might return fewer. // // This value is optional. If you include a value, it must be between 1 and // 1000, inclusive. If you do not include a value, it defaults to 100. // // Currently only 1 policy can be attached to a key. Limit *int64 `min:"1" type:"integer"` // Use this parameter in a subsequent request after you receive a response with // truncated results. Set it to the value of NextMarker from the truncated response // you just received. Marker *string `min:"1" type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListKeyPoliciesRequest
func (ListKeyPoliciesInput) GoString ¶
func (s ListKeyPoliciesInput) GoString() string
GoString returns the string representation
func (*ListKeyPoliciesInput) SetKeyId ¶
func (s *ListKeyPoliciesInput) SetKeyId(v string) *ListKeyPoliciesInput
SetKeyId sets the KeyId field's value.
func (*ListKeyPoliciesInput) SetLimit ¶
func (s *ListKeyPoliciesInput) SetLimit(v int64) *ListKeyPoliciesInput
SetLimit sets the Limit field's value.
func (*ListKeyPoliciesInput) SetMarker ¶
func (s *ListKeyPoliciesInput) SetMarker(v string) *ListKeyPoliciesInput
SetMarker sets the Marker field's value.
func (ListKeyPoliciesInput) String ¶
func (s ListKeyPoliciesInput) String() string
String returns the string representation
func (*ListKeyPoliciesInput) Validate ¶
func (s *ListKeyPoliciesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListKeyPoliciesOutput ¶
type ListKeyPoliciesOutput struct { // When Truncated is true, this element is present and contains the value to // use for the Marker parameter in a subsequent request. NextMarker *string `min:"1" type:"string"` // A list of policy names. Currently, there is only one policy and it is named // "Default". PolicyNames []string `type:"list"` // A flag that indicates whether there are more items in the list. When this // value is true, the list in this response is truncated. To retrieve more items, // pass the value of the NextMarker element in this response to the Marker parameter // in a subsequent request. Truncated *bool `type:"boolean"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListKeyPoliciesResponse
func (ListKeyPoliciesOutput) GoString ¶
func (s ListKeyPoliciesOutput) GoString() string
GoString returns the string representation
func (ListKeyPoliciesOutput) SDKResponseMetadata ¶
func (s ListKeyPoliciesOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (*ListKeyPoliciesOutput) SetNextMarker ¶
func (s *ListKeyPoliciesOutput) SetNextMarker(v string) *ListKeyPoliciesOutput
SetNextMarker sets the NextMarker field's value.
func (*ListKeyPoliciesOutput) SetPolicyNames ¶
func (s *ListKeyPoliciesOutput) SetPolicyNames(v []string) *ListKeyPoliciesOutput
SetPolicyNames sets the PolicyNames field's value.
func (*ListKeyPoliciesOutput) SetTruncated ¶
func (s *ListKeyPoliciesOutput) SetTruncated(v bool) *ListKeyPoliciesOutput
SetTruncated sets the Truncated field's value.
func (ListKeyPoliciesOutput) String ¶
func (s ListKeyPoliciesOutput) String() string
String returns the string representation
type ListKeyPoliciesRequest ¶
type ListKeyPoliciesRequest struct { *aws.Request Input *ListKeyPoliciesInput }
ListKeyPoliciesRequest is a API request type for the ListKeyPolicies API operation.
func (ListKeyPoliciesRequest) Send ¶
func (r ListKeyPoliciesRequest) Send() (*ListKeyPoliciesOutput, error)
Send marshals and sends the ListKeyPolicies API request.
type ListKeysInput ¶
type ListKeysInput struct { // Use this parameter to specify the maximum number of items to return. When // this value is present, AWS KMS does not return more than the specified number // of items, but it might return fewer. // // This value is optional. If you include a value, it must be between 1 and // 1000, inclusive. If you do not include a value, it defaults to 100. Limit *int64 `min:"1" type:"integer"` // Use this parameter in a subsequent request after you receive a response with // truncated results. Set it to the value of NextMarker from the truncated response // you just received. Marker *string `min:"1" type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListKeysRequest
func (ListKeysInput) GoString ¶
func (s ListKeysInput) GoString() string
GoString returns the string representation
func (*ListKeysInput) SetLimit ¶
func (s *ListKeysInput) SetLimit(v int64) *ListKeysInput
SetLimit sets the Limit field's value.
func (*ListKeysInput) SetMarker ¶
func (s *ListKeysInput) SetMarker(v string) *ListKeysInput
SetMarker sets the Marker field's value.
func (ListKeysInput) String ¶
func (s ListKeysInput) String() string
String returns the string representation
func (*ListKeysInput) Validate ¶
func (s *ListKeysInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListKeysOutput ¶
type ListKeysOutput struct { // A list of keys. Keys []KeyListEntry `type:"list"` // When Truncated is true, this element is present and contains the value to // use for the Marker parameter in a subsequent request. NextMarker *string `min:"1" type:"string"` // A flag that indicates whether there are more items in the list. When this // value is true, the list in this response is truncated. To retrieve more items, // pass the value of the NextMarker element in this response to the Marker parameter // in a subsequent request. Truncated *bool `type:"boolean"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListKeysResponse
func (ListKeysOutput) GoString ¶
func (s ListKeysOutput) GoString() string
GoString returns the string representation
func (ListKeysOutput) SDKResponseMetadata ¶
func (s ListKeysOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (*ListKeysOutput) SetKeys ¶
func (s *ListKeysOutput) SetKeys(v []KeyListEntry) *ListKeysOutput
SetKeys sets the Keys field's value.
func (*ListKeysOutput) SetNextMarker ¶
func (s *ListKeysOutput) SetNextMarker(v string) *ListKeysOutput
SetNextMarker sets the NextMarker field's value.
func (*ListKeysOutput) SetTruncated ¶
func (s *ListKeysOutput) SetTruncated(v bool) *ListKeysOutput
SetTruncated sets the Truncated field's value.
func (ListKeysOutput) String ¶
func (s ListKeysOutput) String() string
String returns the string representation
type ListKeysRequest ¶
type ListKeysRequest struct { *aws.Request Input *ListKeysInput }
ListKeysRequest is a API request type for the ListKeys API operation.
func (ListKeysRequest) Send ¶
func (r ListKeysRequest) Send() (*ListKeysOutput, error)
Send marshals and sends the ListKeys API request.
type ListResourceTagsInput ¶
type ListResourceTagsInput struct { // A unique identifier for the CMK whose tags you are listing. You can use the // unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples: // // * Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab // // * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab // // KeyId is a required field KeyId *string `min:"1" type:"string" required:"true"` // Use this parameter to specify the maximum number of items to return. When // this value is present, AWS KMS does not return more than the specified number // of items, but it might return fewer. // // This value is optional. If you include a value, it must be between 1 and // 50, inclusive. If you do not include a value, it defaults to 50. Limit *int64 `min:"1" type:"integer"` // Use this parameter in a subsequent request after you receive a response with // truncated results. Set it to the value of NextMarker from the truncated response // you just received. // // Do not attempt to construct this value. Use only the value of NextMarker // from the truncated response you just received. Marker *string `min:"1" type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListResourceTagsRequest
func (ListResourceTagsInput) GoString ¶
func (s ListResourceTagsInput) GoString() string
GoString returns the string representation
func (*ListResourceTagsInput) SetKeyId ¶
func (s *ListResourceTagsInput) SetKeyId(v string) *ListResourceTagsInput
SetKeyId sets the KeyId field's value.
func (*ListResourceTagsInput) SetLimit ¶
func (s *ListResourceTagsInput) SetLimit(v int64) *ListResourceTagsInput
SetLimit sets the Limit field's value.
func (*ListResourceTagsInput) SetMarker ¶
func (s *ListResourceTagsInput) SetMarker(v string) *ListResourceTagsInput
SetMarker sets the Marker field's value.
func (ListResourceTagsInput) String ¶
func (s ListResourceTagsInput) String() string
String returns the string representation
func (*ListResourceTagsInput) Validate ¶
func (s *ListResourceTagsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListResourceTagsOutput ¶
type ListResourceTagsOutput struct { // When Truncated is true, this element is present and contains the value to // use for the Marker parameter in a subsequent request. // // Do not assume or infer any information from this value. NextMarker *string `min:"1" type:"string"` // A list of tags. Each tag consists of a tag key and a tag value. Tags []Tag `type:"list"` // A flag that indicates whether there are more items in the list. When this // value is true, the list in this response is truncated. To retrieve more items, // pass the value of the NextMarker element in this response to the Marker parameter // in a subsequent request. Truncated *bool `type:"boolean"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListResourceTagsResponse
func (ListResourceTagsOutput) GoString ¶
func (s ListResourceTagsOutput) GoString() string
GoString returns the string representation
func (ListResourceTagsOutput) SDKResponseMetadata ¶
func (s ListResourceTagsOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (*ListResourceTagsOutput) SetNextMarker ¶
func (s *ListResourceTagsOutput) SetNextMarker(v string) *ListResourceTagsOutput
SetNextMarker sets the NextMarker field's value.
func (*ListResourceTagsOutput) SetTags ¶
func (s *ListResourceTagsOutput) SetTags(v []Tag) *ListResourceTagsOutput
SetTags sets the Tags field's value.
func (*ListResourceTagsOutput) SetTruncated ¶
func (s *ListResourceTagsOutput) SetTruncated(v bool) *ListResourceTagsOutput
SetTruncated sets the Truncated field's value.
func (ListResourceTagsOutput) String ¶
func (s ListResourceTagsOutput) String() string
String returns the string representation
type ListResourceTagsRequest ¶
type ListResourceTagsRequest struct { *aws.Request Input *ListResourceTagsInput }
ListResourceTagsRequest is a API request type for the ListResourceTags API operation.
func (ListResourceTagsRequest) Send ¶
func (r ListResourceTagsRequest) Send() (*ListResourceTagsOutput, error)
Send marshals and sends the ListResourceTags API request.
type ListRetirableGrantsInput ¶
type ListRetirableGrantsInput struct { // Use this parameter to specify the maximum number of items to return. When // this value is present, AWS KMS does not return more than the specified number // of items, but it might return fewer. // // This value is optional. If you include a value, it must be between 1 and // 100, inclusive. If you do not include a value, it defaults to 50. Limit *int64 `min:"1" type:"integer"` // Use this parameter in a subsequent request after you receive a response with // truncated results. Set it to the value of NextMarker from the truncated response // you just received. Marker *string `min:"1" type:"string"` // The retiring principal for which to list grants. // // To specify the retiring principal, use the Amazon Resource Name (ARN) (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) // of an AWS principal. Valid AWS principals include AWS accounts (root), IAM // users, federated users, and assumed role users. For examples of the ARN syntax // for specifying a principal, see AWS Identity and Access Management (IAM) // (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam) // in the Example ARNs section of the Amazon Web Services General Reference. // // RetiringPrincipal is a required field RetiringPrincipal *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListRetirableGrantsRequest
func (ListRetirableGrantsInput) GoString ¶
func (s ListRetirableGrantsInput) GoString() string
GoString returns the string representation
func (*ListRetirableGrantsInput) SetLimit ¶
func (s *ListRetirableGrantsInput) SetLimit(v int64) *ListRetirableGrantsInput
SetLimit sets the Limit field's value.
func (*ListRetirableGrantsInput) SetMarker ¶
func (s *ListRetirableGrantsInput) SetMarker(v string) *ListRetirableGrantsInput
SetMarker sets the Marker field's value.
func (*ListRetirableGrantsInput) SetRetiringPrincipal ¶
func (s *ListRetirableGrantsInput) SetRetiringPrincipal(v string) *ListRetirableGrantsInput
SetRetiringPrincipal sets the RetiringPrincipal field's value.
func (ListRetirableGrantsInput) String ¶
func (s ListRetirableGrantsInput) String() string
String returns the string representation
func (*ListRetirableGrantsInput) Validate ¶
func (s *ListRetirableGrantsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListRetirableGrantsOutput ¶
type ListRetirableGrantsOutput struct { // A list of grants. Grants []GrantListEntry `type:"list"` // When Truncated is true, this element is present and contains the value to // use for the Marker parameter in a subsequent request. NextMarker *string `min:"1" type:"string"` // A flag that indicates whether there are more items in the list. When this // value is true, the list in this response is truncated. To retrieve more items, // pass the value of the NextMarker element in this response to the Marker parameter // in a subsequent request. Truncated *bool `type:"boolean"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListGrantsOutput
func (ListRetirableGrantsOutput) GoString ¶
func (s ListRetirableGrantsOutput) GoString() string
GoString returns the string representation
func (ListRetirableGrantsOutput) SDKResponseMetadata ¶
func (s ListRetirableGrantsOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (*ListRetirableGrantsOutput) SetGrants ¶
func (s *ListRetirableGrantsOutput) SetGrants(v []GrantListEntry) *ListRetirableGrantsOutput
SetGrants sets the Grants field's value.
func (*ListRetirableGrantsOutput) SetNextMarker ¶
func (s *ListRetirableGrantsOutput) SetNextMarker(v string) *ListRetirableGrantsOutput
SetNextMarker sets the NextMarker field's value.
func (*ListRetirableGrantsOutput) SetTruncated ¶
func (s *ListRetirableGrantsOutput) SetTruncated(v bool) *ListRetirableGrantsOutput
SetTruncated sets the Truncated field's value.
func (ListRetirableGrantsOutput) String ¶
func (s ListRetirableGrantsOutput) String() string
String returns the string representation
type ListRetirableGrantsRequest ¶
type ListRetirableGrantsRequest struct { *aws.Request Input *ListRetirableGrantsInput }
ListRetirableGrantsRequest is a API request type for the ListRetirableGrants API operation.
func (ListRetirableGrantsRequest) Send ¶
func (r ListRetirableGrantsRequest) Send() (*ListRetirableGrantsOutput, error)
Send marshals and sends the ListRetirableGrants API request.
type OriginType ¶
type OriginType string
const ( OriginTypeAwsKms OriginType = "AWS_KMS" OriginTypeExternal OriginType = "EXTERNAL" )
Enum values for OriginType
type PutKeyPolicyInput ¶
type PutKeyPolicyInput struct { // A flag to indicate whether to bypass the key policy lockout safety check. // // Setting this value to true increases the likelihood that the CMK becomes // unmanageable. Do not set this value to true indiscriminately. // // For more information, refer to the scenario in the Default Key Policy (http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) // section in the AWS Key Management Service Developer Guide. // // Use this parameter only when you intend to prevent the principal that is // making the request from making a subsequent PutKeyPolicy request on the CMK. // // The default value is false. BypassPolicyLockoutSafetyCheck *bool `type:"boolean"` // A unique identifier for the CMK. // // Use the CMK's unique identifier or its Amazon Resource Name (ARN). For example: // // * Unique ID: 1234abcd-12ab-34cd-56ef-1234567890ab // // * ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab // // KeyId is a required field KeyId *string `min:"1" type:"string" required:"true"` // The key policy to attach to the CMK. // // If you do not set BypassPolicyLockoutSafetyCheck to true, the policy must // meet the following criteria: // // * It must allow the principal that is making the PutKeyPolicy request // to make a subsequent PutKeyPolicy request on the CMK. This reduces the // likelihood that the CMK becomes unmanageable. For more information, refer // to the scenario in the Default Key Policy (http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) // section in the AWS Key Management Service Developer Guide. // // * The principals that are specified in the key policy must exist and be // visible to AWS KMS. When you create a new AWS principal (for example, // an IAM user or role), you might need to enforce a delay before specifying // the new principal in a key policy because the new principal might not // immediately be visible to AWS KMS. For more information, see Changes that // I make are not always immediately visible (http://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) // in the IAM User Guide. // // The policy size limit is 32 KiB (32768 bytes). // // Policy is a required field Policy *string `min:"1" type:"string" required:"true"` // The name of the key policy. // // This value must be default. // // PolicyName is a required field PolicyName *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/PutKeyPolicyRequest
func (PutKeyPolicyInput) GoString ¶
func (s PutKeyPolicyInput) GoString() string
GoString returns the string representation
func (*PutKeyPolicyInput) SetBypassPolicyLockoutSafetyCheck ¶
func (s *PutKeyPolicyInput) SetBypassPolicyLockoutSafetyCheck(v bool) *PutKeyPolicyInput
SetBypassPolicyLockoutSafetyCheck sets the BypassPolicyLockoutSafetyCheck field's value.
func (*PutKeyPolicyInput) SetKeyId ¶
func (s *PutKeyPolicyInput) SetKeyId(v string) *PutKeyPolicyInput
SetKeyId sets the KeyId field's value.
func (*PutKeyPolicyInput) SetPolicy ¶
func (s *PutKeyPolicyInput) SetPolicy(v string) *PutKeyPolicyInput
SetPolicy sets the Policy field's value.
func (*PutKeyPolicyInput) SetPolicyName ¶
func (s *PutKeyPolicyInput) SetPolicyName(v string) *PutKeyPolicyInput
SetPolicyName sets the PolicyName field's value.
func (PutKeyPolicyInput) String ¶
func (s PutKeyPolicyInput) String() string
String returns the string representation
func (*PutKeyPolicyInput) Validate ¶
func (s *PutKeyPolicyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PutKeyPolicyOutput ¶
type PutKeyPolicyOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/PutKeyPolicyOutput
func (PutKeyPolicyOutput) GoString ¶
func (s PutKeyPolicyOutput) GoString() string
GoString returns the string representation
func (PutKeyPolicyOutput) SDKResponseMetadata ¶
func (s PutKeyPolicyOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (PutKeyPolicyOutput) String ¶
func (s PutKeyPolicyOutput) String() string
String returns the string representation
type PutKeyPolicyRequest ¶
type PutKeyPolicyRequest struct { *aws.Request Input *PutKeyPolicyInput }
PutKeyPolicyRequest is a API request type for the PutKeyPolicy API operation.
func (PutKeyPolicyRequest) Send ¶
func (r PutKeyPolicyRequest) Send() (*PutKeyPolicyOutput, error)
Send marshals and sends the PutKeyPolicy API request.
type ReEncryptInput ¶
type ReEncryptInput struct { // Ciphertext of the data to reencrypt. // // CiphertextBlob is automatically base64 encoded/decoded by the SDK. // // CiphertextBlob is a required field CiphertextBlob []byte `min:"1" type:"blob" required:"true"` // Encryption context to use when the data is reencrypted. DestinationEncryptionContext map[string]string `type:"map"` // A unique identifier for the CMK to use to reencrypt the data. This value // can be a globally unique identifier, a fully specified ARN to either an alias // or a key, or an alias name prefixed by "alias/". // // * Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 // // * Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName // // * Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012 // // * Alias Name Example - alias/MyAliasName // // DestinationKeyId is a required field DestinationKeyId *string `min:"1" type:"string" required:"true"` // A list of grant tokens. // // For more information, see Grant Tokens (http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token) // in the AWS Key Management Service Developer Guide. GrantTokens []string `type:"list"` // Encryption context used to encrypt and decrypt the data specified in the // CiphertextBlob parameter. SourceEncryptionContext map[string]string `type:"map"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ReEncryptRequest
func (ReEncryptInput) GoString ¶
func (s ReEncryptInput) GoString() string
GoString returns the string representation
func (*ReEncryptInput) SetCiphertextBlob ¶
func (s *ReEncryptInput) SetCiphertextBlob(v []byte) *ReEncryptInput
SetCiphertextBlob sets the CiphertextBlob field's value.
func (*ReEncryptInput) SetDestinationEncryptionContext ¶
func (s *ReEncryptInput) SetDestinationEncryptionContext(v map[string]string) *ReEncryptInput
SetDestinationEncryptionContext sets the DestinationEncryptionContext field's value.
func (*ReEncryptInput) SetDestinationKeyId ¶
func (s *ReEncryptInput) SetDestinationKeyId(v string) *ReEncryptInput
SetDestinationKeyId sets the DestinationKeyId field's value.
func (*ReEncryptInput) SetGrantTokens ¶
func (s *ReEncryptInput) SetGrantTokens(v []string) *ReEncryptInput
SetGrantTokens sets the GrantTokens field's value.
func (*ReEncryptInput) SetSourceEncryptionContext ¶
func (s *ReEncryptInput) SetSourceEncryptionContext(v map[string]string) *ReEncryptInput
SetSourceEncryptionContext sets the SourceEncryptionContext field's value.
func (ReEncryptInput) String ¶
func (s ReEncryptInput) String() string
String returns the string representation
func (*ReEncryptInput) Validate ¶
func (s *ReEncryptInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ReEncryptOutput ¶
type ReEncryptOutput struct { // The reencrypted data. // // CiphertextBlob is automatically base64 encoded/decoded by the SDK. CiphertextBlob []byte `min:"1" type:"blob"` // Unique identifier of the CMK used to reencrypt the data. KeyId *string `min:"1" type:"string"` // Unique identifier of the CMK used to originally encrypt the data. SourceKeyId *string `min:"1" type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ReEncryptResponse
func (ReEncryptOutput) GoString ¶
func (s ReEncryptOutput) GoString() string
GoString returns the string representation
func (ReEncryptOutput) SDKResponseMetadata ¶
func (s ReEncryptOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (*ReEncryptOutput) SetCiphertextBlob ¶
func (s *ReEncryptOutput) SetCiphertextBlob(v []byte) *ReEncryptOutput
SetCiphertextBlob sets the CiphertextBlob field's value.
func (*ReEncryptOutput) SetKeyId ¶
func (s *ReEncryptOutput) SetKeyId(v string) *ReEncryptOutput
SetKeyId sets the KeyId field's value.
func (*ReEncryptOutput) SetSourceKeyId ¶
func (s *ReEncryptOutput) SetSourceKeyId(v string) *ReEncryptOutput
SetSourceKeyId sets the SourceKeyId field's value.
func (ReEncryptOutput) String ¶
func (s ReEncryptOutput) String() string
String returns the string representation
type ReEncryptRequest ¶
type ReEncryptRequest struct { *aws.Request Input *ReEncryptInput }
ReEncryptRequest is a API request type for the ReEncrypt API operation.
func (ReEncryptRequest) Send ¶
func (r ReEncryptRequest) Send() (*ReEncryptOutput, error)
Send marshals and sends the ReEncrypt API request.
type RetireGrantInput ¶
type RetireGrantInput struct { // Unique identifier of the grant to retire. The grant ID is returned in the // response to a CreateGrant operation. // // * Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123 GrantId *string `min:"1" type:"string"` // Token that identifies the grant to be retired. GrantToken *string `min:"1" type:"string"` // The Amazon Resource Name of the CMK associated with the grant. Example: // // * arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab KeyId *string `min:"1" type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/RetireGrantRequest
func (RetireGrantInput) GoString ¶
func (s RetireGrantInput) GoString() string
GoString returns the string representation
func (*RetireGrantInput) SetGrantId ¶
func (s *RetireGrantInput) SetGrantId(v string) *RetireGrantInput
SetGrantId sets the GrantId field's value.
func (*RetireGrantInput) SetGrantToken ¶
func (s *RetireGrantInput) SetGrantToken(v string) *RetireGrantInput
SetGrantToken sets the GrantToken field's value.
func (*RetireGrantInput) SetKeyId ¶
func (s *RetireGrantInput) SetKeyId(v string) *RetireGrantInput
SetKeyId sets the KeyId field's value.
func (RetireGrantInput) String ¶
func (s RetireGrantInput) String() string
String returns the string representation
func (*RetireGrantInput) Validate ¶
func (s *RetireGrantInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RetireGrantOutput ¶
type RetireGrantOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/RetireGrantOutput
func (RetireGrantOutput) GoString ¶
func (s RetireGrantOutput) GoString() string
GoString returns the string representation
func (RetireGrantOutput) SDKResponseMetadata ¶
func (s RetireGrantOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (RetireGrantOutput) String ¶
func (s RetireGrantOutput) String() string
String returns the string representation
type RetireGrantRequest ¶
type RetireGrantRequest struct { *aws.Request Input *RetireGrantInput }
RetireGrantRequest is a API request type for the RetireGrant API operation.
func (RetireGrantRequest) Send ¶
func (r RetireGrantRequest) Send() (*RetireGrantOutput, error)
Send marshals and sends the RetireGrant API request.
type RevokeGrantInput ¶
type RevokeGrantInput struct { // Identifier of the grant to be revoked. // // GrantId is a required field GrantId *string `min:"1" type:"string" required:"true"` // A unique identifier for the customer master key associated with the grant. // This value can be a globally unique identifier or the fully specified ARN // to 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 // // KeyId is a required field KeyId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/RevokeGrantRequest
func (RevokeGrantInput) GoString ¶
func (s RevokeGrantInput) GoString() string
GoString returns the string representation
func (*RevokeGrantInput) SetGrantId ¶
func (s *RevokeGrantInput) SetGrantId(v string) *RevokeGrantInput
SetGrantId sets the GrantId field's value.
func (*RevokeGrantInput) SetKeyId ¶
func (s *RevokeGrantInput) SetKeyId(v string) *RevokeGrantInput
SetKeyId sets the KeyId field's value.
func (RevokeGrantInput) String ¶
func (s RevokeGrantInput) String() string
String returns the string representation
func (*RevokeGrantInput) Validate ¶
func (s *RevokeGrantInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RevokeGrantOutput ¶
type RevokeGrantOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/RevokeGrantOutput
func (RevokeGrantOutput) GoString ¶
func (s RevokeGrantOutput) GoString() string
GoString returns the string representation
func (RevokeGrantOutput) SDKResponseMetadata ¶
func (s RevokeGrantOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (RevokeGrantOutput) String ¶
func (s RevokeGrantOutput) String() string
String returns the string representation
type RevokeGrantRequest ¶
type RevokeGrantRequest struct { *aws.Request Input *RevokeGrantInput }
RevokeGrantRequest is a API request type for the RevokeGrant API operation.
func (RevokeGrantRequest) Send ¶
func (r RevokeGrantRequest) Send() (*RevokeGrantOutput, error)
Send marshals and sends the RevokeGrant API request.
type ScheduleKeyDeletionInput ¶
type ScheduleKeyDeletionInput struct { // The unique identifier for the customer master key (CMK) to delete. // // To specify this value, use the unique key ID or the Amazon Resource Name // (ARN) of the CMK. Examples: // // * Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab // // * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab // // To obtain the unique key ID and key ARN for a given CMK, use ListKeys or // DescribeKey. // // KeyId is a required field KeyId *string `min:"1" type:"string" required:"true"` // The waiting period, specified in number of days. After the waiting period // ends, AWS KMS deletes the customer master key (CMK). // // This value is optional. If you include a value, it must be between 7 and // 30, inclusive. If you do not include a value, it defaults to 30. PendingWindowInDays *int64 `min:"1" type:"integer"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ScheduleKeyDeletionRequest
func (ScheduleKeyDeletionInput) GoString ¶
func (s ScheduleKeyDeletionInput) GoString() string
GoString returns the string representation
func (*ScheduleKeyDeletionInput) SetKeyId ¶
func (s *ScheduleKeyDeletionInput) SetKeyId(v string) *ScheduleKeyDeletionInput
SetKeyId sets the KeyId field's value.
func (*ScheduleKeyDeletionInput) SetPendingWindowInDays ¶
func (s *ScheduleKeyDeletionInput) SetPendingWindowInDays(v int64) *ScheduleKeyDeletionInput
SetPendingWindowInDays sets the PendingWindowInDays field's value.
func (ScheduleKeyDeletionInput) String ¶
func (s ScheduleKeyDeletionInput) String() string
String returns the string representation
func (*ScheduleKeyDeletionInput) Validate ¶
func (s *ScheduleKeyDeletionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ScheduleKeyDeletionOutput ¶
type ScheduleKeyDeletionOutput struct { // The date and time after which AWS KMS deletes the customer master key (CMK). DeletionDate *time.Time `type:"timestamp" timestampFormat:"unix"` // The unique identifier of the customer master key (CMK) for which deletion // is scheduled. KeyId *string `min:"1" type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ScheduleKeyDeletionResponse
func (ScheduleKeyDeletionOutput) GoString ¶
func (s ScheduleKeyDeletionOutput) GoString() string
GoString returns the string representation
func (ScheduleKeyDeletionOutput) SDKResponseMetadata ¶
func (s ScheduleKeyDeletionOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (*ScheduleKeyDeletionOutput) SetDeletionDate ¶
func (s *ScheduleKeyDeletionOutput) SetDeletionDate(v time.Time) *ScheduleKeyDeletionOutput
SetDeletionDate sets the DeletionDate field's value.
func (*ScheduleKeyDeletionOutput) SetKeyId ¶
func (s *ScheduleKeyDeletionOutput) SetKeyId(v string) *ScheduleKeyDeletionOutput
SetKeyId sets the KeyId field's value.
func (ScheduleKeyDeletionOutput) String ¶
func (s ScheduleKeyDeletionOutput) String() string
String returns the string representation
type ScheduleKeyDeletionRequest ¶
type ScheduleKeyDeletionRequest struct { *aws.Request Input *ScheduleKeyDeletionInput }
ScheduleKeyDeletionRequest is a API request type for the ScheduleKeyDeletion API operation.
func (ScheduleKeyDeletionRequest) Send ¶
func (r ScheduleKeyDeletionRequest) Send() (*ScheduleKeyDeletionOutput, error)
Send marshals and sends the ScheduleKeyDeletion API request.
type Tag ¶
type Tag struct { // The key of the tag. // // TagKey is a required field TagKey *string `min:"1" type:"string" required:"true"` // The value of the tag. // // TagValue is a required field TagValue *string `type:"string" required:"true"` // contains filtered or unexported fields }
A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings. Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/Tag
func (*Tag) SetTagValue ¶
SetTagValue sets the TagValue field's value.
type TagResourceInput ¶
type TagResourceInput struct { // A unique identifier for the CMK you are tagging. You can use the unique key // ID or the Amazon Resource Name (ARN) of the CMK. Examples: // // * Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab // // * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab // // KeyId is a required field KeyId *string `min:"1" type:"string" required:"true"` // One or more tags. Each tag consists of a tag key and a tag value. // // Tags is a required field Tags []Tag `type:"list" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/TagResourceRequest
func (TagResourceInput) GoString ¶
func (s TagResourceInput) GoString() string
GoString returns the string representation
func (*TagResourceInput) SetKeyId ¶
func (s *TagResourceInput) SetKeyId(v string) *TagResourceInput
SetKeyId sets the KeyId field's value.
func (*TagResourceInput) SetTags ¶
func (s *TagResourceInput) SetTags(v []Tag) *TagResourceInput
SetTags sets the Tags field's value.
func (TagResourceInput) String ¶
func (s TagResourceInput) String() string
String returns the string representation
func (*TagResourceInput) Validate ¶
func (s *TagResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type TagResourceOutput ¶
type TagResourceOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/TagResourceOutput
func (TagResourceOutput) GoString ¶
func (s TagResourceOutput) GoString() string
GoString returns the string representation
func (TagResourceOutput) SDKResponseMetadata ¶
func (s TagResourceOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (TagResourceOutput) String ¶
func (s TagResourceOutput) String() string
String returns the string representation
type TagResourceRequest ¶
type TagResourceRequest struct { *aws.Request Input *TagResourceInput }
TagResourceRequest is a API request type for the TagResource API operation.
func (TagResourceRequest) Send ¶
func (r TagResourceRequest) Send() (*TagResourceOutput, error)
Send marshals and sends the TagResource API request.
type UntagResourceInput ¶
type UntagResourceInput struct { // A unique identifier for the CMK from which you are removing tags. You can // use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples: // // * Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab // // * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab // // KeyId is a required field KeyId *string `min:"1" type:"string" required:"true"` // One or more tag keys. Specify only the tag keys, not the tag values. // // TagKeys is a required field TagKeys []string `type:"list" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UntagResourceRequest
func (UntagResourceInput) GoString ¶
func (s UntagResourceInput) GoString() string
GoString returns the string representation
func (*UntagResourceInput) SetKeyId ¶
func (s *UntagResourceInput) SetKeyId(v string) *UntagResourceInput
SetKeyId sets the KeyId field's value.
func (*UntagResourceInput) SetTagKeys ¶
func (s *UntagResourceInput) SetTagKeys(v []string) *UntagResourceInput
SetTagKeys sets the TagKeys field's value.
func (UntagResourceInput) String ¶
func (s UntagResourceInput) String() string
String returns the string representation
func (*UntagResourceInput) Validate ¶
func (s *UntagResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UntagResourceOutput ¶
type UntagResourceOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UntagResourceOutput
func (UntagResourceOutput) GoString ¶
func (s UntagResourceOutput) GoString() string
GoString returns the string representation
func (UntagResourceOutput) SDKResponseMetadata ¶
func (s UntagResourceOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (UntagResourceOutput) String ¶
func (s UntagResourceOutput) String() string
String returns the string representation
type UntagResourceRequest ¶
type UntagResourceRequest struct { *aws.Request Input *UntagResourceInput }
UntagResourceRequest is a API request type for the UntagResource API operation.
func (UntagResourceRequest) Send ¶
func (r UntagResourceRequest) Send() (*UntagResourceOutput, error)
Send marshals and sends the UntagResource API request.
type UpdateAliasInput ¶
type UpdateAliasInput struct { // 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 AliasName *string `min:"1" type:"string" required:"true"` // 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. // // TargetKeyId is a required field TargetKeyId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UpdateAliasRequest
func (UpdateAliasInput) GoString ¶
func (s UpdateAliasInput) GoString() string
GoString returns the string representation
func (*UpdateAliasInput) SetAliasName ¶
func (s *UpdateAliasInput) SetAliasName(v string) *UpdateAliasInput
SetAliasName sets the AliasName field's value.
func (*UpdateAliasInput) SetTargetKeyId ¶
func (s *UpdateAliasInput) SetTargetKeyId(v string) *UpdateAliasInput
SetTargetKeyId sets the TargetKeyId field's value.
func (UpdateAliasInput) String ¶
func (s UpdateAliasInput) String() string
String returns the string representation
func (*UpdateAliasInput) Validate ¶
func (s *UpdateAliasInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateAliasOutput ¶
type UpdateAliasOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UpdateAliasOutput
func (UpdateAliasOutput) GoString ¶
func (s UpdateAliasOutput) GoString() string
GoString returns the string representation
func (UpdateAliasOutput) SDKResponseMetadata ¶
func (s UpdateAliasOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (UpdateAliasOutput) String ¶
func (s UpdateAliasOutput) String() string
String returns the string representation
type UpdateAliasRequest ¶
type UpdateAliasRequest struct { *aws.Request Input *UpdateAliasInput }
UpdateAliasRequest is a API request type for the UpdateAlias API operation.
func (UpdateAliasRequest) Send ¶
func (r UpdateAliasRequest) Send() (*UpdateAliasOutput, error)
Send marshals and sends the UpdateAlias API request.
type UpdateKeyDescriptionInput ¶
type UpdateKeyDescriptionInput struct { // New description for the CMK. // // Description is a required field Description *string `type:"string" required:"true"` // A unique identifier for the CMK. This value can be a globally unique identifier // or the fully specified ARN to 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 // // KeyId is a required field KeyId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UpdateKeyDescriptionRequest
func (UpdateKeyDescriptionInput) GoString ¶
func (s UpdateKeyDescriptionInput) GoString() string
GoString returns the string representation
func (*UpdateKeyDescriptionInput) SetDescription ¶
func (s *UpdateKeyDescriptionInput) SetDescription(v string) *UpdateKeyDescriptionInput
SetDescription sets the Description field's value.
func (*UpdateKeyDescriptionInput) SetKeyId ¶
func (s *UpdateKeyDescriptionInput) SetKeyId(v string) *UpdateKeyDescriptionInput
SetKeyId sets the KeyId field's value.
func (UpdateKeyDescriptionInput) String ¶
func (s UpdateKeyDescriptionInput) String() string
String returns the string representation
func (*UpdateKeyDescriptionInput) Validate ¶
func (s *UpdateKeyDescriptionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateKeyDescriptionOutput ¶
type UpdateKeyDescriptionOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UpdateKeyDescriptionOutput
func (UpdateKeyDescriptionOutput) GoString ¶
func (s UpdateKeyDescriptionOutput) GoString() string
GoString returns the string representation
func (UpdateKeyDescriptionOutput) SDKResponseMetadata ¶
func (s UpdateKeyDescriptionOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (UpdateKeyDescriptionOutput) String ¶
func (s UpdateKeyDescriptionOutput) String() string
String returns the string representation
type UpdateKeyDescriptionRequest ¶
type UpdateKeyDescriptionRequest struct { *aws.Request Input *UpdateKeyDescriptionInput }
UpdateKeyDescriptionRequest is a API request type for the UpdateKeyDescription API operation.
func (UpdateKeyDescriptionRequest) Send ¶
func (r UpdateKeyDescriptionRequest) Send() (*UpdateKeyDescriptionOutput, error)
Send marshals and sends the UpdateKeyDescription API request.
type WrappingKeySpec ¶
type WrappingKeySpec string
const (
WrappingKeySpecRsa2048 WrappingKeySpec = "RSA_2048"
)
Enum values for WrappingKeySpec