Documentation
¶
Overview ¶
+k8s:deepcopy-gen=package Package v1alpha1 is the v1alpha1 version of the kms.services.k8s.aws API. +groupName=kms.services.k8s.aws
Index ¶
- Constants
- Variables
- type AlgorithmSpec
- type Alias
- type AliasList
- type AliasListEntry
- type AliasSpec
- type AliasStatus
- type ConnectionErrorCodeType
- type ConnectionStateType
- type CustomKeyStore
- type CustomKeyStoreList
- type CustomKeyStoreSpec
- type CustomKeyStoreStatus
- type CustomKeyStoresListEntry
- type CustomerMasterKeySpec
- type DataKeyPairSpec
- type DataKeySpec
- type EncryptionAlgorithmSpec
- type ExpirationModelType
- type Grant
- type GrantConstraints
- type GrantList
- type GrantListEntry
- type GrantOperation
- type GrantSpec
- type GrantStatus
- type Key
- type KeyList
- type KeyListEntry
- type KeyManagerType
- type KeyMetadata
- type KeySpec
- type KeyState
- type KeyStatus
- type KeyUsageType
- type MessageType
- type OriginType
- type SigningAlgorithmSpec
- type Tag
- type WrappingKeySpec
Constants ¶
const ( // AnnotationPrefix is the prefix for all annotations specifically for // the KMS service. AnnotationPrefix = "kms.services.k8s.aws/" // AnnotationDeletePendingWindow is an annotation whose value is the number // of days the "PendingWindowInDays" value should assume when deleting a // Key. AnnotationDeletePendingWindow = AnnotationPrefix + "pending-window-in-days" )
Variables ¶
var ( // GroupVersion is the API Group Version used to register the objects GroupVersion = schema.GroupVersion{Group: "kms.services.k8s.aws", Version: "v1alpha1"} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion} // AddToScheme adds the types in this group-version to the given scheme. AddToScheme = SchemeBuilder.AddToScheme )
Functions ¶
This section is empty.
Types ¶
type AlgorithmSpec ¶
type AlgorithmSpec string
const ( AlgorithmSpec_RSAES_PKCS1_V1_5 AlgorithmSpec = "RSAES_PKCS1_V1_5" AlgorithmSpec_RSAES_OAEP_SHA_1 AlgorithmSpec = "RSAES_OAEP_SHA_1" AlgorithmSpec_RSAES_OAEP_SHA_256 AlgorithmSpec = "RSAES_OAEP_SHA_256" )
type Alias ¶
type Alias struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec AliasSpec `json:"spec,omitempty"` Status AliasStatus `json:"status,omitempty"` }
Alias is the Schema for the Aliases API +kubebuilder:object:root=true +kubebuilder:subresource:status
func (*Alias) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Alias.
func (*Alias) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Alias) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type AliasList ¶
type AliasList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []Alias `json:"items"` }
AliasList contains a list of Alias +kubebuilder:object:root=true
func (*AliasList) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AliasList.
func (*AliasList) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*AliasList) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type AliasListEntry ¶
type AliasListEntry struct { AliasARN *string `json:"aliasARN,omitempty"` AliasName *string `json:"aliasName,omitempty"` CreationDate *metav1.Time `json:"creationDate,omitempty"` LastUpdatedDate *metav1.Time `json:"lastUpdatedDate,omitempty"` TargetKeyID *string `json:"targetKeyID,omitempty"` }
Contains information about an alias.
func (*AliasListEntry) DeepCopy ¶
func (in *AliasListEntry) DeepCopy() *AliasListEntry
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AliasListEntry.
func (*AliasListEntry) DeepCopyInto ¶
func (in *AliasListEntry) DeepCopyInto(out *AliasListEntry)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type AliasSpec ¶
type AliasSpec struct { // Specifies the alias name. This value must begin with alias/ followed by a // name, such as alias/ExampleAlias. // // The AliasName value must be string of 1-256 characters. It can contain only // alphanumeric characters, forward slashes (/), underscores (_), and dashes // (-). The alias name cannot begin with alias/aws/. The alias/aws/ prefix is // reserved for AWS managed CMKs (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk). // +kubebuilder:validation:Required Name *string `json:"name"` // Associates the alias with the specified customer managed CMK (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk). // The CMK must be in the same AWS Region. // // A valid CMK ID is required. If you supply a null or empty string value, this // operation returns an error. // // For help finding the key ID and ARN, see Finding the Key ID and ARN (https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html#find-cmk-id-arn) // in the AWS Key Management Service Developer Guide. // // Specify the key ID or the Amazon Resource Name (ARN) of the CMK. // // For example: // // * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab // // * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab // // To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. // +kubebuilder:validation:Required TargetKeyID *string `json:"targetKeyID"` }
AliasSpec defines the desired state of Alias.
func (*AliasSpec) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AliasSpec.
func (*AliasSpec) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type AliasStatus ¶
type AliasStatus struct { // All CRs managed by ACK have a common `Status.ACKResourceMetadata` member // that is used to contain resource sync state, account ownership, // constructed ARN for the resource // +kubebuilder:validation:Optional ACKResourceMetadata *ackv1alpha1.ResourceMetadata `json:"ackResourceMetadata"` // All CRS managed by ACK have a common `Status.Conditions` member that // contains a collection of `ackv1alpha1.Condition` objects that describe // the various terminal states of the CR and its backend AWS service API // resource // +kubebuilder:validation:Optional Conditions []*ackv1alpha1.Condition `json:"conditions"` }
AliasStatus defines the observed state of Alias
func (*AliasStatus) DeepCopy ¶
func (in *AliasStatus) DeepCopy() *AliasStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AliasStatus.
func (*AliasStatus) DeepCopyInto ¶
func (in *AliasStatus) DeepCopyInto(out *AliasStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ConnectionErrorCodeType ¶
type ConnectionErrorCodeType string
const ( ConnectionErrorCodeType_INVALID_CREDENTIALS ConnectionErrorCodeType = "INVALID_CREDENTIALS" ConnectionErrorCodeType_CLUSTER_NOT_FOUND ConnectionErrorCodeType = "CLUSTER_NOT_FOUND" ConnectionErrorCodeType_NETWORK_ERRORS ConnectionErrorCodeType = "NETWORK_ERRORS" ConnectionErrorCodeType_INTERNAL_ERROR ConnectionErrorCodeType = "INTERNAL_ERROR" ConnectionErrorCodeType_INSUFFICIENT_CLOUDHSM_HSMS ConnectionErrorCodeType = "INSUFFICIENT_CLOUDHSM_HSMS" ConnectionErrorCodeType_USER_LOCKED_OUT ConnectionErrorCodeType = "USER_LOCKED_OUT" ConnectionErrorCodeType_USER_NOT_FOUND ConnectionErrorCodeType = "USER_NOT_FOUND" ConnectionErrorCodeType_USER_LOGGED_IN ConnectionErrorCodeType = "USER_LOGGED_IN" ConnectionErrorCodeType_SUBNET_NOT_FOUND ConnectionErrorCodeType = "SUBNET_NOT_FOUND" )
type ConnectionStateType ¶
type ConnectionStateType string
const ( ConnectionStateType_CONNECTED ConnectionStateType = "CONNECTED" ConnectionStateType_CONNECTING ConnectionStateType = "CONNECTING" ConnectionStateType_FAILED ConnectionStateType = "FAILED" ConnectionStateType_DISCONNECTED ConnectionStateType = "DISCONNECTED" ConnectionStateType_DISCONNECTING ConnectionStateType = "DISCONNECTING" )
type CustomKeyStore ¶
type CustomKeyStore struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec CustomKeyStoreSpec `json:"spec,omitempty"` Status CustomKeyStoreStatus `json:"status,omitempty"` }
CustomKeyStore is the Schema for the CustomKeyStores API +kubebuilder:object:root=true +kubebuilder:subresource:status
func (*CustomKeyStore) DeepCopy ¶
func (in *CustomKeyStore) DeepCopy() *CustomKeyStore
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CustomKeyStore.
func (*CustomKeyStore) DeepCopyInto ¶
func (in *CustomKeyStore) DeepCopyInto(out *CustomKeyStore)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*CustomKeyStore) DeepCopyObject ¶
func (in *CustomKeyStore) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type CustomKeyStoreList ¶
type CustomKeyStoreList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []CustomKeyStore `json:"items"` }
CustomKeyStoreList contains a list of CustomKeyStore +kubebuilder:object:root=true
func (*CustomKeyStoreList) DeepCopy ¶
func (in *CustomKeyStoreList) DeepCopy() *CustomKeyStoreList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CustomKeyStoreList.
func (*CustomKeyStoreList) DeepCopyInto ¶
func (in *CustomKeyStoreList) DeepCopyInto(out *CustomKeyStoreList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*CustomKeyStoreList) DeepCopyObject ¶
func (in *CustomKeyStoreList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type CustomKeyStoreSpec ¶
type CustomKeyStoreSpec struct { // Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster // ID of any active AWS CloudHSM cluster that is not already associated with // a custom key store. To find the cluster ID, use the DescribeClusters (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html) // operation. // +kubebuilder:validation:Required CloudHsmClusterID *string `json:"cloudHsmClusterID"` // Enter the password of the kmsuser crypto user (CU) account (https://docs.aws.amazon.com/kms/latest/developerguide/key-store-concepts.html#concept-kmsuser) // in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this // user to manage key material on your behalf. // // The password must be a string of 7 to 32 characters. Its value is case sensitive. // // This parameter tells AWS KMS the kmsuser account password; it does not change // the password in the AWS CloudHSM cluster. // +kubebuilder:validation:Required KeyStorePassword *string `json:"keyStorePassword"` // Specifies a friendly name for the custom key store. The name must be unique // in your AWS account. // +kubebuilder:validation:Required Name *string `json:"name"` // Enter the content of the trust anchor certificate for the cluster. This is // the content of the customerCA.crt file that you created when you initialized // the cluster (https://docs.aws.amazon.com/cloudhsm/latest/userguide/initialize-cluster.html). // +kubebuilder:validation:Required TrustAnchorCertificate *string `json:"trustAnchorCertificate"` }
CustomKeyStoreSpec defines the desired state of CustomKeyStore.
func (*CustomKeyStoreSpec) DeepCopy ¶
func (in *CustomKeyStoreSpec) DeepCopy() *CustomKeyStoreSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CustomKeyStoreSpec.
func (*CustomKeyStoreSpec) DeepCopyInto ¶
func (in *CustomKeyStoreSpec) DeepCopyInto(out *CustomKeyStoreSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CustomKeyStoreStatus ¶
type CustomKeyStoreStatus struct { // All CRs managed by ACK have a common `Status.ACKResourceMetadata` member // that is used to contain resource sync state, account ownership, // constructed ARN for the resource // +kubebuilder:validation:Optional ACKResourceMetadata *ackv1alpha1.ResourceMetadata `json:"ackResourceMetadata"` // All CRS managed by ACK have a common `Status.Conditions` member that // contains a collection of `ackv1alpha1.Condition` objects that describe // the various terminal states of the CR and its backend AWS service API // resource // +kubebuilder:validation:Optional Conditions []*ackv1alpha1.Condition `json:"conditions"` // A unique identifier for the new custom key store. // +kubebuilder:validation:Optional CustomKeyStoreID *string `json:"customKeyStoreID,omitempty"` }
CustomKeyStoreStatus defines the observed state of CustomKeyStore
func (*CustomKeyStoreStatus) DeepCopy ¶
func (in *CustomKeyStoreStatus) DeepCopy() *CustomKeyStoreStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CustomKeyStoreStatus.
func (*CustomKeyStoreStatus) DeepCopyInto ¶
func (in *CustomKeyStoreStatus) DeepCopyInto(out *CustomKeyStoreStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CustomKeyStoresListEntry ¶
type CustomKeyStoresListEntry struct { CloudHsmClusterID *string `json:"cloudHsmClusterID,omitempty"` ConnectionErrorCode *string `json:"connectionErrorCode,omitempty"` ConnectionState *string `json:"connectionState,omitempty"` CreationDate *metav1.Time `json:"creationDate,omitempty"` CustomKeyStoreID *string `json:"customKeyStoreID,omitempty"` CustomKeyStoreName *string `json:"customKeyStoreName,omitempty"` TrustAnchorCertificate *string `json:"trustAnchorCertificate,omitempty"` }
Contains information about each custom key store in the custom key store list.
func (*CustomKeyStoresListEntry) DeepCopy ¶
func (in *CustomKeyStoresListEntry) DeepCopy() *CustomKeyStoresListEntry
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CustomKeyStoresListEntry.
func (*CustomKeyStoresListEntry) DeepCopyInto ¶
func (in *CustomKeyStoresListEntry) DeepCopyInto(out *CustomKeyStoresListEntry)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CustomerMasterKeySpec ¶
type CustomerMasterKeySpec string
const ( CustomerMasterKeySpec_RSA_2048 CustomerMasterKeySpec = "RSA_2048" CustomerMasterKeySpec_RSA_3072 CustomerMasterKeySpec = "RSA_3072" CustomerMasterKeySpec_RSA_4096 CustomerMasterKeySpec = "RSA_4096" CustomerMasterKeySpec_ECC_NIST_P256 CustomerMasterKeySpec = "ECC_NIST_P256" CustomerMasterKeySpec_ECC_NIST_P384 CustomerMasterKeySpec = "ECC_NIST_P384" CustomerMasterKeySpec_ECC_NIST_P521 CustomerMasterKeySpec = "ECC_NIST_P521" CustomerMasterKeySpec_ECC_SECG_P256K1 CustomerMasterKeySpec = "ECC_SECG_P256K1" CustomerMasterKeySpec_SYMMETRIC_DEFAULT CustomerMasterKeySpec = "SYMMETRIC_DEFAULT" )
type DataKeyPairSpec ¶
type DataKeyPairSpec string
const ( DataKeyPairSpec_RSA_2048 DataKeyPairSpec = "RSA_2048" DataKeyPairSpec_RSA_3072 DataKeyPairSpec = "RSA_3072" DataKeyPairSpec_RSA_4096 DataKeyPairSpec = "RSA_4096" DataKeyPairSpec_ECC_NIST_P256 DataKeyPairSpec = "ECC_NIST_P256" DataKeyPairSpec_ECC_NIST_P384 DataKeyPairSpec = "ECC_NIST_P384" DataKeyPairSpec_ECC_NIST_P521 DataKeyPairSpec = "ECC_NIST_P521" DataKeyPairSpec_ECC_SECG_P256K1 DataKeyPairSpec = "ECC_SECG_P256K1" )
type DataKeySpec ¶
type DataKeySpec string
const ( DataKeySpec_AES_256 DataKeySpec = "AES_256" DataKeySpec_AES_128 DataKeySpec = "AES_128" )
type EncryptionAlgorithmSpec ¶
type EncryptionAlgorithmSpec string
const ( EncryptionAlgorithmSpec_SYMMETRIC_DEFAULT EncryptionAlgorithmSpec = "SYMMETRIC_DEFAULT" EncryptionAlgorithmSpec_RSAES_OAEP_SHA_1 EncryptionAlgorithmSpec = "RSAES_OAEP_SHA_1" EncryptionAlgorithmSpec_RSAES_OAEP_SHA_256 EncryptionAlgorithmSpec = "RSAES_OAEP_SHA_256" )
type ExpirationModelType ¶
type ExpirationModelType string
const ( ExpirationModelType_KEY_MATERIAL_EXPIRES ExpirationModelType = "KEY_MATERIAL_EXPIRES" ExpirationModelType_KEY_MATERIAL_DOES_NOT_EXPIRE ExpirationModelType = "KEY_MATERIAL_DOES_NOT_EXPIRE" )
type Grant ¶
type Grant struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec GrantSpec `json:"spec,omitempty"` Status GrantStatus `json:"status,omitempty"` }
Grant is the Schema for the Grants API +kubebuilder:object:root=true +kubebuilder:subresource:status
func (*Grant) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Grant.
func (*Grant) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Grant) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type GrantConstraints ¶
type GrantConstraints struct { EncryptionContextEquals map[string]*string `json:"encryptionContextEquals,omitempty"` EncryptionContextSubset map[string]*string `json:"encryptionContextSubset,omitempty"` }
Use this structure to allow cryptographic operations (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) in the grant only when the operation request includes the specified encryption context (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context).
AWS KMS applies the grant constraints only to cryptographic operations that support an encryption context, that is, all cryptographic operations with a symmetric CMK (https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html#symmetric-cmks). Grant constraints are not applied to operations that do not support an encryption context, such as cryptographic operations with asymmetric CMKs and management operations, such as DescribeKey or RetireGrant.
In a cryptographic operation, the encryption context in the decryption operation must be an exact, case-sensitive match for the keys and values in the encryption context of the encryption operation. Only the order of the pairs can vary.
However, in a grant constraint, the key in each key-value pair is not case sensitive, but the value is case sensitive.
To avoid confusion, do not use multiple encryption context pairs that differ only by case. To require a fully case-sensitive encryption context, use the kms:EncryptionContext: and kms:EncryptionContextKeys conditions in an IAM or key policy. For details, see kms:EncryptionContext: (https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-encryption-context) in the AWS Key Management Service Developer Guide .
func (*GrantConstraints) DeepCopy ¶
func (in *GrantConstraints) DeepCopy() *GrantConstraints
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GrantConstraints.
func (*GrantConstraints) DeepCopyInto ¶
func (in *GrantConstraints) DeepCopyInto(out *GrantConstraints)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type GrantList ¶
type GrantList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []Grant `json:"items"` }
GrantList contains a list of Grant +kubebuilder:object:root=true
func (*GrantList) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GrantList.
func (*GrantList) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*GrantList) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type GrantListEntry ¶
type GrantListEntry struct { // Use this structure to allow cryptographic operations (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) // in the grant only when the operation request includes the specified encryption // context (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context). // // AWS KMS applies the grant constraints only to cryptographic operations that // support an encryption context, that is, all cryptographic operations with // a symmetric CMK (https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html#symmetric-cmks). // Grant constraints are not applied to operations that do not support an encryption // context, such as cryptographic operations with asymmetric CMKs and management // operations, such as DescribeKey or RetireGrant. // // In a cryptographic operation, the encryption context in the decryption operation // must be an exact, case-sensitive match for the keys and values in the encryption // context of the encryption operation. Only the order of the pairs can vary. // // However, in a grant constraint, the key in each key-value pair is not case // sensitive, but the value is case sensitive. // // To avoid confusion, do not use multiple encryption context pairs that differ // only by case. To require a fully case-sensitive encryption context, use the // kms:EncryptionContext: and kms:EncryptionContextKeys conditions in an IAM // or key policy. For details, see kms:EncryptionContext: (https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-encryption-context) // in the AWS Key Management Service Developer Guide . Constraints *GrantConstraints `json:"constraints,omitempty"` CreationDate *metav1.Time `json:"creationDate,omitempty"` GrantID *string `json:"grantID,omitempty"` GranteePrincipal *string `json:"granteePrincipal,omitempty"` IssuingAccount *string `json:"issuingAccount,omitempty"` KeyID *string `json:"keyID,omitempty"` Name *string `json:"name,omitempty"` Operations []*string `json:"operations,omitempty"` RetiringPrincipal *string `json:"retiringPrincipal,omitempty"` }
Contains information about a grant.
func (*GrantListEntry) DeepCopy ¶
func (in *GrantListEntry) DeepCopy() *GrantListEntry
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GrantListEntry.
func (*GrantListEntry) DeepCopyInto ¶
func (in *GrantListEntry) DeepCopyInto(out *GrantListEntry)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type GrantOperation ¶
type GrantOperation string
const ( GrantOperation_Decrypt GrantOperation = "Decrypt" GrantOperation_Encrypt GrantOperation = "Encrypt" GrantOperation_GenerateDataKey GrantOperation = "GenerateDataKey" GrantOperation_GenerateDataKeyWithoutPlaintext GrantOperation = "GenerateDataKeyWithoutPlaintext" GrantOperation_ReEncryptFrom GrantOperation = "ReEncryptFrom" GrantOperation_ReEncryptTo GrantOperation = "ReEncryptTo" GrantOperation_Sign GrantOperation = "Sign" GrantOperation_Verify GrantOperation = "Verify" GrantOperation_GetPublicKey GrantOperation = "GetPublicKey" GrantOperation_CreateGrant GrantOperation = "CreateGrant" GrantOperation_RetireGrant GrantOperation = "RetireGrant" GrantOperation_DescribeKey GrantOperation = "DescribeKey" GrantOperation_GenerateDataKeyPair GrantOperation = "GenerateDataKeyPair" GrantOperation_GenerateDataKeyPairWithoutPlaintext GrantOperation = "GenerateDataKeyPairWithoutPlaintext" )
type GrantSpec ¶
type GrantSpec struct { // Allows a cryptographic operation (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) // only when the encryption context matches or includes the encryption context // specified in this structure. For more information about encryption context, // see Encryption Context (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) // in the AWS Key Management Service Developer Guide . // // Grant constraints are not applied to operations that do not support an encryption // context, such as cryptographic operations with asymmetric CMKs and management // operations, such as DescribeKey or RetireGrant. Constraints *GrantConstraints `json:"constraints,omitempty"` // A list of grant tokens. // // For more information, see Grant Tokens (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token) // in the AWS Key Management Service Developer Guide. GrantTokens []*string `json:"grantTokens,omitempty"` // The principal that is given permission to perform the operations that the // grant permits. // // To specify the principal, use the Amazon Resource Name (ARN) (https://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) (https://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. // +kubebuilder:validation:Required GranteePrincipal *string `json:"granteePrincipal"` // The unique identifier for the customer master key (CMK) that the grant applies // to. // // Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify // a CMK in a different AWS account, you must use the key ARN. // // For example: // // * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab // // * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab // // To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. // +kubebuilder:validation:Required KeyID *string `json:"keyID"` // A friendly name for the grant. Use this value to prevent the 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 for the same grant ID can be used interchangeably. Name *string `json:"name,omitempty"` // A list of operations that the grant permits. // +kubebuilder:validation:Required Operations []*string `json:"operations"` // The principal that is given permission to retire the grant by using RetireGrant // operation. // // To specify the principal, use the Amazon Resource Name (ARN) (https://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) (https://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 `json:"retiringPrincipal,omitempty"` }
GrantSpec defines the desired state of Grant.
func (*GrantSpec) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GrantSpec.
func (*GrantSpec) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type GrantStatus ¶
type GrantStatus struct { // All CRs managed by ACK have a common `Status.ACKResourceMetadata` member // that is used to contain resource sync state, account ownership, // constructed ARN for the resource // +kubebuilder:validation:Optional ACKResourceMetadata *ackv1alpha1.ResourceMetadata `json:"ackResourceMetadata"` // All CRS managed by ACK have a common `Status.Conditions` member that // contains a collection of `ackv1alpha1.Condition` objects that describe // the various terminal states of the CR and its backend AWS service API // resource // +kubebuilder:validation:Optional Conditions []*ackv1alpha1.Condition `json:"conditions"` // The unique identifier for the grant. // // You can use the GrantId in a ListGrants, RetireGrant, or RevokeGrant operation. // +kubebuilder:validation:Optional GrantID *string `json:"grantID,omitempty"` // The grant token. // // For more information, see Grant Tokens (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token) // in the AWS Key Management Service Developer Guide. // +kubebuilder:validation:Optional GrantToken *string `json:"grantToken,omitempty"` }
GrantStatus defines the observed state of Grant
func (*GrantStatus) DeepCopy ¶
func (in *GrantStatus) DeepCopy() *GrantStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GrantStatus.
func (*GrantStatus) DeepCopyInto ¶
func (in *GrantStatus) DeepCopyInto(out *GrantStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Key ¶
type Key struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec KeySpec `json:"spec,omitempty"` Status KeyStatus `json:"status,omitempty"` }
Key is the Schema for the Keys API +kubebuilder:object:root=true +kubebuilder:subresource:status
func (*Key) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Key.
func (*Key) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Key) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type KeyList ¶
type KeyList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []Key `json:"items"` }
KeyList contains a list of Key +kubebuilder:object:root=true
func (*KeyList) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KeyList.
func (*KeyList) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*KeyList) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type KeyListEntry ¶
type KeyListEntry struct { KeyARN *string `json:"keyARN,omitempty"` KeyID *string `json:"keyID,omitempty"` }
Contains information about each entry in the key list.
func (*KeyListEntry) DeepCopy ¶
func (in *KeyListEntry) DeepCopy() *KeyListEntry
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KeyListEntry.
func (*KeyListEntry) DeepCopyInto ¶
func (in *KeyListEntry) DeepCopyInto(out *KeyListEntry)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KeyManagerType ¶
type KeyManagerType string
const ( KeyManagerType_AWS KeyManagerType = "AWS" KeyManagerType_CUSTOMER KeyManagerType = "CUSTOMER" )
type KeyMetadata ¶
type KeyMetadata struct { AWSAccountID *string `json:"awsAccountID,omitempty"` ARN *string `json:"arn,omitempty"` CloudHsmClusterID *string `json:"cloudHsmClusterID,omitempty"` CreationDate *metav1.Time `json:"creationDate,omitempty"` CustomKeyStoreID *string `json:"customKeyStoreID,omitempty"` DeletionDate *metav1.Time `json:"deletionDate,omitempty"` Description *string `json:"description,omitempty"` Enabled *bool `json:"enabled,omitempty"` EncryptionAlgorithms []*string `json:"encryptionAlgorithms,omitempty"` ExpirationModel *string `json:"expirationModel,omitempty"` KeyID *string `json:"keyID,omitempty"` KeyManager *string `json:"keyManager,omitempty"` KeyState *string `json:"keyState,omitempty"` KeyUsage *string `json:"keyUsage,omitempty"` Origin *string `json:"origin,omitempty"` SigningAlgorithms []*string `json:"signingAlgorithms,omitempty"` ValidTo *metav1.Time `json:"validTo,omitempty"` }
Contains metadata about a customer master key (CMK).
This data type is used as a response element for the CreateKey and DescribeKey operations.
func (*KeyMetadata) DeepCopy ¶
func (in *KeyMetadata) DeepCopy() *KeyMetadata
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KeyMetadata.
func (*KeyMetadata) DeepCopyInto ¶
func (in *KeyMetadata) DeepCopyInto(out *KeyMetadata)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KeySpec ¶
type KeySpec struct { // A flag to indicate whether to bypass the key policy lockout safety check. // // Setting this value to true increases the risk 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 (https://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 `json:"bypassPolicyLockoutSafetyCheck,omitempty"` // Creates the CMK in the specified custom key store (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) // and the key material in its associated AWS CloudHSM cluster. To create a // CMK in a custom key store, you must also specify the Origin parameter with // a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with // the custom key store must have at least two active HSMs, each in a different // Availability Zone in the Region. // // This parameter is valid only for symmetric CMKs. You cannot create an asymmetric // CMK in a custom key store. // // To find the ID of a custom key store, use the DescribeCustomKeyStores operation. // // The response includes the custom key store ID and the ID of the AWS CloudHSM // cluster. // // This operation is part of the Custom Key Store feature (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) // feature in AWS KMS, which combines the convenience and extensive integration // of AWS KMS with the isolation and control of a single-tenant key store. CustomKeyStoreID *string `json:"customKeyStoreID,omitempty"` // A description of the CMK. // // Use a description that helps you decide whether the CMK is appropriate for // a task. Description *string `json:"description,omitempty"` // Determines the cryptographic operations (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) // for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This // parameter is required only for asymmetric CMKs. You can't change the KeyUsage // value after the CMK is created. // // Select only one valid value. // // * For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT. // // * For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or // SIGN_VERIFY. // // * For asymmetric CMKs with ECC key material, specify SIGN_VERIFY. KeyUsage *string `json:"keyUsage,omitempty"` // The source of the key material for the CMK. You cannot change the origin // after you create the CMK. The default is AWS_KMS, which means AWS KMS creates // the key material. // // When the parameter value is EXTERNAL, AWS KMS 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 (https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) // in the AWS Key Management Service Developer Guide. This value is valid only // for symmetric CMKs. // // When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS // KMS custom key store (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) // and creates its key material in the associated AWS CloudHSM cluster. You // must also use the CustomKeyStoreId parameter to identify the custom key store. // This value is valid only for symmetric CMKs. Origin *string `json:"origin,omitempty"` // The key policy to attach to the CMK. // // If you provide a key policy, it must meet the following criteria: // // * If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy // must allow the principal that is making the CreateKey request to make // a subsequent PutKeyPolicy request on the CMK. This reduces the risk that // the CMK becomes unmanageable. For more information, refer to the scenario // in the Default Key Policy (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) // section of the AWS Key Management Service Developer Guide . // // * Each statement in the key policy must contain one or more principals. // The principals 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 including the new principal in // a key policy because the new principal might not be immediately visible // to AWS KMS. For more information, see Changes that I make are not always // immediately visible (https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) // in the AWS Identity and Access Management User Guide. // // If you do not provide a key policy, AWS KMS attaches a default key policy // to the CMK. For more information, see Default Key Policy (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default) // in the AWS Key Management Service Developer Guide. // // The key policy size quota is 32 kilobytes (32768 bytes). // // For help writing and formatting a JSON policy document, see the IAM JSON // Policy Reference (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html) // in the IAM User Guide . Policy *string `json:"policy,omitempty"` // One or more tags. Each tag consists of a tag key and a tag value. Both the // tag key and the tag value are required, but the tag value can be an empty // (null) string. // // When you add tags to an AWS resource, AWS generates a cost allocation report // with usage and costs aggregated by tags. For information about adding, changing, // deleting and listing tags for CMKs, see Tagging Keys (https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html). // // Use this parameter to tag the CMK when it is created. To add tags to an existing // CMK, use the TagResource operation. // // To use this parameter, you must have kms:TagResource (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) // permission in an IAM policy. Tags []*Tag `json:"tags,omitempty"` }
KeySpec defines the desired state of Key.
func (*KeySpec) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KeySpec.
func (*KeySpec) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KeyStatus ¶
type KeyStatus struct { // All CRs managed by ACK have a common `Status.ACKResourceMetadata` member // that is used to contain resource sync state, account ownership, // constructed ARN for the resource // +kubebuilder:validation:Optional ACKResourceMetadata *ackv1alpha1.ResourceMetadata `json:"ackResourceMetadata"` // All CRS managed by ACK have a common `Status.Conditions` member that // contains a collection of `ackv1alpha1.Condition` objects that describe // the various terminal states of the CR and its backend AWS service API // resource // +kubebuilder:validation:Optional Conditions []*ackv1alpha1.Condition `json:"conditions"` // The twelve-digit account ID of the AWS account that owns the CMK. // +kubebuilder:validation:Optional AWSAccountID *string `json:"awsAccountID,omitempty"` // The cluster ID of the AWS CloudHSM cluster that contains the key material // for the CMK. When you create a CMK in a custom key store (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html), // AWS KMS creates the key material for the CMK in the associated AWS CloudHSM // cluster. This value is present only when the CMK is created in a custom key // store. // +kubebuilder:validation:Optional CloudHsmClusterID *string `json:"cloudHsmClusterID,omitempty"` // The date and time when the CMK was created. // +kubebuilder:validation:Optional CreationDate *metav1.Time `json:"creationDate,omitempty"` // The date and time after which AWS KMS deletes the CMK. This value is present // only when KeyState is PendingDeletion. // +kubebuilder:validation:Optional DeletionDate *metav1.Time `json:"deletionDate,omitempty"` // Specifies whether the CMK is enabled. When KeyState is Enabled this value // is true, otherwise it is false. // +kubebuilder:validation:Optional Enabled *bool `json:"enabled,omitempty"` // The encryption algorithms that the CMK supports. You cannot use the CMK with // other encryption algorithms within AWS KMS. // // This field appears only when the KeyUsage of the CMK is ENCRYPT_DECRYPT. // +kubebuilder:validation:Optional EncryptionAlgorithms []*string `json:"encryptionAlgorithms,omitempty"` // Specifies whether the CMK's key material expires. This value is present only // when Origin is EXTERNAL, otherwise this value is omitted. // +kubebuilder:validation:Optional ExpirationModel *string `json:"expirationModel,omitempty"` // The globally unique identifier for the CMK. // +kubebuilder:validation:Optional KeyID *string `json:"keyID,omitempty"` // The manager of the CMK. CMKs in your AWS account are either customer managed // or AWS managed. For more information about the difference, see Customer Master // Keys (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys) // in the AWS Key Management Service Developer Guide. // +kubebuilder:validation:Optional KeyManager *string `json:"keyManager,omitempty"` // The current status of the CMK. // // For more information about how key state affects the use of a CMK, see Key // state: Effect on your CMK (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) // in the AWS Key Management Service Developer Guide. // +kubebuilder:validation:Optional KeyState *string `json:"keyState,omitempty"` // The signing algorithms that the CMK supports. You cannot use the CMK with // other signing algorithms within AWS KMS. // // This field appears only when the KeyUsage of the CMK is SIGN_VERIFY. // +kubebuilder:validation:Optional SigningAlgorithms []*string `json:"signingAlgorithms,omitempty"` // 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. // +kubebuilder:validation:Optional ValidTo *metav1.Time `json:"validTo,omitempty"` }
KeyStatus defines the observed state of Key
func (*KeyStatus) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KeyStatus.
func (*KeyStatus) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KeyUsageType ¶
type KeyUsageType string
const ( KeyUsageType_SIGN_VERIFY KeyUsageType = "SIGN_VERIFY" KeyUsageType_ENCRYPT_DECRYPT KeyUsageType = "ENCRYPT_DECRYPT" )
type MessageType ¶
type MessageType string
const ( MessageType_RAW MessageType = "RAW" MessageType_DIGEST MessageType = "DIGEST" )
type OriginType ¶
type OriginType string
const ( OriginType_AWS_KMS OriginType = "AWS_KMS" OriginType_EXTERNAL OriginType = "EXTERNAL" OriginType_AWS_CLOUDHSM OriginType = "AWS_CLOUDHSM" )
type SigningAlgorithmSpec ¶
type SigningAlgorithmSpec string
const ( SigningAlgorithmSpec_RSASSA_PSS_SHA_256 SigningAlgorithmSpec = "RSASSA_PSS_SHA_256" SigningAlgorithmSpec_RSASSA_PSS_SHA_384 SigningAlgorithmSpec = "RSASSA_PSS_SHA_384" SigningAlgorithmSpec_RSASSA_PSS_SHA_512 SigningAlgorithmSpec = "RSASSA_PSS_SHA_512" SigningAlgorithmSpec_RSASSA_PKCS1_V1_5_SHA_256 SigningAlgorithmSpec = "RSASSA_PKCS1_V1_5_SHA_256" SigningAlgorithmSpec_RSASSA_PKCS1_V1_5_SHA_384 SigningAlgorithmSpec = "RSASSA_PKCS1_V1_5_SHA_384" SigningAlgorithmSpec_RSASSA_PKCS1_V1_5_SHA_512 SigningAlgorithmSpec = "RSASSA_PKCS1_V1_5_SHA_512" SigningAlgorithmSpec_ECDSA_SHA_256 SigningAlgorithmSpec = "ECDSA_SHA_256" SigningAlgorithmSpec_ECDSA_SHA_384 SigningAlgorithmSpec = "ECDSA_SHA_384" SigningAlgorithmSpec_ECDSA_SHA_512 SigningAlgorithmSpec = "ECDSA_SHA_512" )
type Tag ¶
type Tag struct { TagKey *string `json:"tagKey,omitempty"` TagValue *string `json:"tagValue,omitempty"` }
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.
For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html) in the AWS Billing and Cost Management User Guide.
func (*Tag) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Tag.
func (*Tag) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type WrappingKeySpec ¶
type WrappingKeySpec string
const (
WrappingKeySpec_RSA_2048 WrappingKeySpec = "RSA_2048"
)