v1alpha1

package
v1.0.17 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 12, 2024 License: Apache-2.0 Imports: 6 Imported by: 22

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

View Source 
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

View Source 
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 

func (in *Alias) DeepCopy() *Alias

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Alias.

func (*Alias) DeepCopyInto 

func (in *Alias) DeepCopyInto(out *Alias)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Alias) DeepCopyObject 

func (in *Alias) DeepCopyObject() runtime.Object

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 

func (in *AliasList) DeepCopy() *AliasList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AliasList.

func (*AliasList) DeepCopyInto 

func (in *AliasList) DeepCopyInto(out *AliasList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*AliasList) DeepCopyObject 

func (in *AliasList) DeepCopyObject() runtime.Object

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 Amazon Web Services managed keys (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 key (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk).
	// The KMS key must be in the same Amazon Web Services Region.
	//
	// A valid key 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 Key Management Service Developer Guide .
	//
	// Specify the key ID or key ARN of the KMS key.
	//
	// For example:
	//
	//   - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
	//
	//   - Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
	//
	// To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
	TargetKeyID  *string                                  `json:"targetKeyID,omitempty"`
	TargetKeyRef *ackv1alpha1.AWSResourceReferenceWrapper `json:"targetKeyRef,omitempty"`
}

AliasSpec defines the desired state of Alias.

func (*AliasSpec) DeepCopy 

func (in *AliasSpec) DeepCopy() *AliasSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AliasSpec.

func (*AliasSpec) DeepCopyInto 

func (in *AliasSpec) DeepCopyInto(out *AliasSpec)

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"
	ConnectionErrorCodeType_INSUFFICIENT_FREE_ADDRESSES_IN_SUBNET ConnectionErrorCodeType = "INSUFFICIENT_FREE_ADDRESSES_IN_SUBNET"
)

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 CustomKeyStoresListEntry 

type CustomKeyStoresListEntry struct {
	CloudHsmClusterID *string      `json:"cloudHsmClusterID,omitempty"`
	CreationDate      *metav1.Time `json:"creationDate,omitempty"`
	CustomKeyStoreID  *string      `json:"customKeyStoreID,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"
	CustomerMasterKeySpec_HMAC_224          CustomerMasterKeySpec = "HMAC_224"
	CustomerMasterKeySpec_HMAC_256          CustomerMasterKeySpec = "HMAC_256"
	CustomerMasterKeySpec_HMAC_384          CustomerMasterKeySpec = "HMAC_384"
	CustomerMasterKeySpec_HMAC_512          CustomerMasterKeySpec = "HMAC_512"
	CustomerMasterKeySpec_SM2               CustomerMasterKeySpec = "SM2"
)

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"
	DataKeyPairSpec_SM2             DataKeyPairSpec = "SM2"
)

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"
	EncryptionAlgorithmSpec_SM2PKE             EncryptionAlgorithmSpec = "SM2PKE"
)

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 

func (in *Grant) DeepCopy() *Grant

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Grant.

func (*Grant) DeepCopyInto 

func (in *Grant) DeepCopyInto(out *Grant)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Grant) DeepCopyObject 

func (in *Grant) DeepCopyObject() runtime.Object

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).

KMS applies the grant constraints only to cryptographic operations that support an encryption context, that is, all cryptographic operations with a symmetric encryption KMS key (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 HMAC KMS keys or asymmetric KMS keys, 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 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 

func (in *GrantList) DeepCopy() *GrantList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GrantList.

func (*GrantList) DeepCopyInto 

func (in *GrantList) DeepCopyInto(out *GrantList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*GrantList) DeepCopyObject 

func (in *GrantList) DeepCopyObject() runtime.Object

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).
	//
	// KMS applies the grant constraints only to cryptographic operations that support
	// an encryption context, that is, all cryptographic operations with a symmetric
	// encryption KMS key (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 HMAC KMS keys or asymmetric
	// KMS keys, 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 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"
	GrantOperation_GenerateMac                         GrantOperation = "GenerateMac"
	GrantOperation_VerifyMac                           GrantOperation = "VerifyMac"
)

type GrantSpec 

type GrantSpec struct {

	// Specifies a grant constraint.
	//
	// KMS supports the EncryptionContextEquals and EncryptionContextSubset grant
	// constraints. Each constraint value can include up to 8 encryption context
	// pairs. The encryption context value in each constraint cannot exceed 384
	// characters. For information about grant constraints, see Using grant constraints
	// (https://docs.aws.amazon.com/kms/latest/developerguide/create-grant-overview.html#grant-constraints)
	// in the Key Management Service Developer Guide. For more information about
	// encryption context, see Encryption context (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context)
	// in the Key Management Service Developer Guide .
	//
	// The encryption context grant constraints allow the permissions in the grant
	// only when the encryption context in the request matches (EncryptionContextEquals)
	// or includes (EncryptionContextSubset) the encryption context specified in
	// this structure.
	//
	// The encryption context grant constraints are supported only on grant operations
	// (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#terms-grant-operations)
	// that include an EncryptionContext parameter, such as cryptographic operations
	// on symmetric encryption KMS keys. Grants with grant constraints can include
	// the DescribeKey and RetireGrant operations, but the constraint doesn't apply
	// to these operations. If a grant with a grant constraint includes the CreateGrant
	// operation, the constraint requires that any grants created with the CreateGrant
	// permission have an equally strict or stricter encryption context constraint.
	//
	// You cannot use an encryption context grant constraint for cryptographic operations
	// with asymmetric KMS keys or HMAC KMS keys. These keys don't support an encryption
	// context.
	Constraints *GrantConstraints `json:"constraints,omitempty"`
	// A list of grant tokens.
	//
	// Use a grant token when your permission to call this operation comes from
	// a new grant that has not yet achieved eventual consistency. For more information,
	// see Grant token (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token)
	// and Using a grant token (https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token)
	// in the Key Management Service Developer Guide.
	GrantTokens []*string `json:"grantTokens,omitempty"`
	// The identity that gets the permissions specified in the grant.
	//
	// 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 Amazon Web Services principal. Valid Amazon Web Services principals
	// include Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services General Reference.
	// +kubebuilder:validation:Required
	GranteePrincipal *string `json:"granteePrincipal"`
	// Identifies the KMS key for the grant. The grant gives principals permission
	// to use this KMS key.
	//
	// Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different
	// Amazon Web Services 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 KMS key, use ListKeys or DescribeKey.
	KeyID  *string                                  `json:"keyID,omitempty"`
	KeyRef *ackv1alpha1.AWSResourceReferenceWrapper `json:"keyRef,omitempty"`
	// 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.
	//
	// This list must include only operations that are permitted in a grant. Also,
	// the operation must be supported on the KMS key. For example, you cannot create
	// a grant for a symmetric encryption KMS key that allows the Sign operation,
	// or a grant for an asymmetric KMS key that allows the GenerateDataKey operation.
	// If you try, KMS returns a ValidationError exception. For details, see Grant
	// operations (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#terms-grant-operations)
	// in the Key Management Service Developer Guide.
	// +kubebuilder:validation:Required
	Operations []*string `json:"operations"`
	// The principal that has permission to use the RetireGrant operation to retire
	// the grant.
	//
	// 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 Amazon Web Services principal. Valid Amazon Web Services principals
	// include Amazon Web Services accounts (root), IAM users, federated users,
	// and assumed role users. For examples of the ARN syntax to use for specifying
	// a principal, see Amazon Web Services 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 Amazon Web Services General Reference.
	//
	// The grant determines the retiring principal. Other principals might have
	// permission to retire the grant or revoke the grant. For details, see RevokeGrant
	// and Retiring and revoking grants (https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#grant-delete)
	// in the Key Management Service Developer Guide.
	RetiringPrincipal *string `json:"retiringPrincipal,omitempty"`
}

GrantSpec defines the desired state of Grant.

func (*GrantSpec) DeepCopy 

func (in *GrantSpec) DeepCopy() *GrantSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GrantSpec.

func (*GrantSpec) DeepCopyInto 

func (in *GrantSpec) DeepCopyInto(out *GrantSpec)

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.
	//
	// Use a grant token when your permission to call this operation comes from
	// a new grant that has not yet achieved eventual consistency. For more information,
	// see Grant token (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token)
	// and Using a grant token (https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token)
	// in the 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 

func (in *Key) DeepCopy() *Key

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Key.

func (*Key) DeepCopyInto 

func (in *Key) DeepCopyInto(out *Key)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Key) DeepCopyObject 

func (in *Key) DeepCopyObject() runtime.Object

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 

func (in *KeyList) DeepCopy() *KeyList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KeyList.

func (*KeyList) DeepCopyInto 

func (in *KeyList) DeepCopyInto(out *KeyList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*KeyList) DeepCopyObject 

func (in *KeyList) DeepCopyObject() runtime.Object

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"`
	KeySpec              *string      `json:"keySpec,omitempty"`
	KeyState             *string      `json:"keyState,omitempty"`
	KeyUsage             *string      `json:"keyUsage,omitempty"`
	MacAlgorithms        []*string    `json:"macAlgorithms,omitempty"`
	MultiRegion          *bool        `json:"multiRegion,omitempty"`
	// Describes the configuration of this multi-Region key. This field appears
	// only when the KMS key is a primary or replica of a multi-Region key.
	//
	// For more information about any listed KMS key, use the DescribeKey operation.
	MultiRegionConfiguration    *MultiRegionConfiguration `json:"multiRegionConfiguration,omitempty"`
	Origin                      *string                   `json:"origin,omitempty"`
	PendingDeletionWindowInDays *int64                    `json:"pendingDeletionWindowInDays,omitempty"`
	SigningAlgorithms           []*string                 `json:"signingAlgorithms,omitempty"`
	ValidTo                     *metav1.Time              `json:"validTo,omitempty"`
}

Contains metadata about a KMS key.

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 KMS key 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 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 KMS key.
	//
	// The default value is false.
	BypassPolicyLockoutSafetyCheck *bool `json:"bypassPolicyLockoutSafetyCheck,omitempty"`
	// Creates the KMS key 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 CloudHSM cluster. To create a KMS
	// key in a custom key store, you must also specify the Origin parameter with
	// a value of AWS_CLOUDHSM. The 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 encryption KMS keys in a single
	// Region. You cannot create any other type of KMS key 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 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 KMS, which combines the convenience and extensive integration
	// of KMS with the isolation and control of a single-tenant key store.
	CustomKeyStoreID *string `json:"customKeyStoreID,omitempty"`
	// A description of the KMS key.
	//
	// Use a description that helps you decide whether the KMS key is appropriate
	// for a task. The default value is an empty string (no description).
	//
	// To set or change the description after the key is created, use UpdateKeyDescription.
	Description       *string `json:"description,omitempty"`
	EnableKeyRotation *bool   `json:"enableKeyRotation,omitempty"`
	// Specifies the type of KMS key to create. The default value, SYMMETRIC_DEFAULT,
	// creates a KMS key with a 256-bit AES-GCM key that is used for encryption
	// and decryption, except in China Regions, where it creates a 128-bit symmetric
	// key that uses SM4 encryption. For help choosing a key spec for your KMS key,
	// see Choosing a KMS key type (https://docs.aws.amazon.com/kms/latest/developerguide/key-types.html#symm-asymm-choose)
	// in the Key Management Service Developer Guide .
	//
	// The KeySpec determines whether the KMS key contains a symmetric key or an
	// asymmetric key pair. It also determines the cryptographic algorithms that
	// the KMS key supports. You can't change the KeySpec after the KMS key is created.
	// To further restrict the algorithms that can be used with the KMS key, use
	// a condition key in its key policy or IAM policy. For more information, see
	// kms:EncryptionAlgorithm (https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-encryption-algorithm),
	// kms:MacAlgorithm (https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-mac-algorithm)
	// or kms:Signing Algorithm (https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-signing-algorithm)
	// in the Key Management Service Developer Guide .
	//
	// Amazon Web Services services that are integrated with KMS (http://aws.amazon.com/kms/features/#AWS_Service_Integration)
	// use symmetric encryption KMS keys to protect your data. These services do
	// not support asymmetric KMS keys or HMAC KMS keys.
	//
	// KMS supports the following key specs for KMS keys:
	//
	//   - Symmetric encryption key (default) SYMMETRIC_DEFAULT
	//
	//   - HMAC keys (symmetric) HMAC_224 HMAC_256 HMAC_384 HMAC_512
	//
	//   - Asymmetric RSA key pairs RSA_2048 RSA_3072 RSA_4096
	//
	//   - Asymmetric NIST-recommended elliptic curve key pairs ECC_NIST_P256 (secp256r1)
	//     ECC_NIST_P384 (secp384r1) ECC_NIST_P521 (secp521r1)
	//
	//   - Other asymmetric elliptic curve key pairs ECC_SECG_P256K1 (secp256k1),
	//     commonly used for cryptocurrencies.
	//
	//   - SM2 key pairs (China Regions only) SM2
	KeySpec *string `json:"keySpec,omitempty"`
	// Determines the cryptographic operations (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations)
	// for which you can use the KMS key. The default value is ENCRYPT_DECRYPT.
	// This parameter is optional when you are creating a symmetric encryption KMS
	// key; otherwise, it is required. You can't change the KeyUsage value after
	// the KMS key is created.
	//
	// Select only one valid value.
	//
	//   - For symmetric encryption KMS keys, omit the parameter or specify ENCRYPT_DECRYPT.
	//
	//   - For HMAC KMS keys (symmetric), specify GENERATE_VERIFY_MAC.
	//
	//   - For asymmetric KMS keys with RSA key material, specify ENCRYPT_DECRYPT
	//     or SIGN_VERIFY.
	//
	//   - For asymmetric KMS keys with ECC key material, specify SIGN_VERIFY.
	//
	//   - For asymmetric KMS keys with SM2 key material (China Regions only),
	//     specify ENCRYPT_DECRYPT or SIGN_VERIFY.
	KeyUsage *string `json:"keyUsage,omitempty"`
	// Creates a multi-Region primary key that you can replicate into other Amazon
	// Web Services Regions. You cannot change this value after you create the KMS
	// key.
	//
	// For a multi-Region key, set this parameter to True. For a single-Region KMS
	// key, omit this parameter or set it to False. The default value is False.
	//
	// This operation supports multi-Region keys, an KMS feature that lets you create
	// multiple interoperable KMS keys in different Amazon Web Services Regions.
	// Because these KMS keys have the same key ID, key material, and other metadata,
	// you can use them interchangeably to encrypt data in one Amazon Web Services
	// Region and decrypt it in a different Amazon Web Services Region without re-encrypting
	// the data or making a cross-Region call. For more information about multi-Region
	// keys, see Multi-Region keys in KMS (https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html)
	// in the Key Management Service Developer Guide.
	//
	// This value creates a primary key, not a replica. To create a replica key,
	// use the ReplicateKey operation.
	//
	// You can create a multi-Region version of a symmetric encryption KMS key,
	// an HMAC KMS key, an asymmetric KMS key, or a KMS key with imported key material.
	// However, you cannot create a multi-Region key in a custom key store.
	MultiRegion *bool `json:"multiRegion,omitempty"`
	// The source of the key material for the KMS key. You cannot change the origin
	// after you create the KMS key. The default is AWS_KMS, which means that KMS
	// creates the key material.
	//
	// To create a KMS key with no key material (for imported key material), set
	// the value to EXTERNAL. For more information about importing key material
	// into KMS, see Importing Key Material (https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html)
	// in the Key Management Service Developer Guide. This value is valid only for
	// symmetric encryption KMS keys.
	//
	// To create a KMS key in an KMS custom key store (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html)
	// and create its key material in the associated CloudHSM cluster, set this
	// value to AWS_CLOUDHSM. You must also use the CustomKeyStoreId parameter to
	// identify the custom key store. This value is valid only for symmetric encryption
	// KMS keys.
	Origin *string `json:"origin,omitempty"`
	// The key policy to attach to the KMS key. If you do not specify a key policy,
	// KMS attaches a default key policy to the KMS key. For more information, see
	// Default key policy (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default)
	// in the Key Management Service Developer Guide.
	//
	// 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 KMS key. This reduces the risk
	//     that the KMS key 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 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 KMS. When
	//     you create a new Amazon Web Services 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 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 Amazon Web Services Identity and Access Management User Guide.
	//
	// A key policy document can include only the following characters:
	//
	//   - Printable ASCII characters from the space character (\u0020) through
	//     the end of the ASCII character range.
	//
	//   - Printable characters in the Basic Latin and Latin-1 Supplement character
	//     set (through \u00FF).
	//
	//   - The tab (\u0009), line feed (\u000A), and carriage return (\u000D) special
	//     characters
	//
	// For information about key policies, see Key policies in KMS (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html)
	// in the Key Management Service Developer Guide. 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 Identity and Access Management User Guide .
	Policy *string `json:"policy,omitempty"`
	// Assigns one or more tags to the KMS key. Use this parameter to tag the KMS
	// key when it is created. To tag an existing KMS key, use the TagResource operation.
	//
	// Tagging or untagging a KMS key can allow or deny permission to the KMS key.
	// For details, see ABAC in KMS (https://docs.aws.amazon.com/kms/latest/developerguide/abac.html)
	// in the Key Management Service Developer Guide.
	//
	// 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.
	//
	// 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.
	// You cannot have more than one tag on a KMS key with the same tag key. If
	// you specify an existing tag key with a different tag value, KMS replaces
	// the current tag value with the specified one.
	//
	// When you add tags to an Amazon Web Services resource, Amazon Web Services
	// generates a cost allocation report with usage and costs aggregated by tags.
	// Tags can also be used to control access to a KMS key. For details, see Tagging
	// Keys (https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html).
	Tags []*Tag `json:"tags,omitempty"`
}

KeySpec defines the desired state of Key.

func (*KeySpec) DeepCopy 

func (in *KeySpec) DeepCopy() *KeySpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KeySpec.

func (*KeySpec) DeepCopyInto 

func (in *KeySpec) DeepCopyInto(out *KeySpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type KeySpec_SDK added in v0.0.7 

type KeySpec_SDK string
const (
	KeySpec_SDK_RSA_2048          KeySpec_SDK = "RSA_2048"
	KeySpec_SDK_RSA_3072          KeySpec_SDK = "RSA_3072"
	KeySpec_SDK_RSA_4096          KeySpec_SDK = "RSA_4096"
	KeySpec_SDK_ECC_NIST_P256     KeySpec_SDK = "ECC_NIST_P256"
	KeySpec_SDK_ECC_NIST_P384     KeySpec_SDK = "ECC_NIST_P384"
	KeySpec_SDK_ECC_NIST_P521     KeySpec_SDK = "ECC_NIST_P521"
	KeySpec_SDK_ECC_SECG_P256K1   KeySpec_SDK = "ECC_SECG_P256K1"
	KeySpec_SDK_SYMMETRIC_DEFAULT KeySpec_SDK = "SYMMETRIC_DEFAULT"
	KeySpec_SDK_HMAC_224          KeySpec_SDK = "HMAC_224"
	KeySpec_SDK_HMAC_256          KeySpec_SDK = "HMAC_256"
	KeySpec_SDK_HMAC_384          KeySpec_SDK = "HMAC_384"
	KeySpec_SDK_HMAC_512          KeySpec_SDK = "HMAC_512"
	KeySpec_SDK_SM2               KeySpec_SDK = "SM2"
)

type KeyState 

type KeyState string
const (
	KeyState_Creating               KeyState = "Creating"
	KeyState_Enabled                KeyState = "Enabled"
	KeyState_Disabled               KeyState = "Disabled"
	KeyState_PendingDeletion        KeyState = "PendingDeletion"
	KeyState_PendingImport          KeyState = "PendingImport"
	KeyState_PendingReplicaDeletion KeyState = "PendingReplicaDeletion"
	KeyState_Unavailable            KeyState = "Unavailable"
	KeyState_Updating               KeyState = "Updating"
)

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 Amazon Web Services account that owns
	// the KMS key.
	// +kubebuilder:validation:Optional
	AWSAccountID *string `json:"awsAccountID,omitempty"`
	// The cluster ID of the CloudHSM cluster that contains the key material for
	// the KMS key. When you create a KMS key in a custom key store (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html),
	// KMS creates the key material for the KMS key in the associated CloudHSM cluster.
	// This value is present only when the KMS key is created in a custom key store.
	// +kubebuilder:validation:Optional
	CloudHsmClusterID *string `json:"cloudHsmClusterID,omitempty"`
	// The date and time when the KMS key was created.
	// +kubebuilder:validation:Optional
	CreationDate *metav1.Time `json:"creationDate,omitempty"`
	// The date and time after which KMS deletes this KMS key. This value is present
	// only when the KMS key is scheduled for deletion, that is, when its KeyState
	// is PendingDeletion.
	//
	// When the primary key in a multi-Region key is scheduled for deletion but
	// still has replica keys, its key state is PendingReplicaDeletion and the length
	// of its waiting period is displayed in the PendingDeletionWindowInDays field.
	// +kubebuilder:validation:Optional
	DeletionDate *metav1.Time `json:"deletionDate,omitempty"`
	// Specifies whether the KMS key 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 KMS key supports. You cannot use the KMS
	// key with other encryption algorithms within KMS.
	//
	// This value is present only when the KeyUsage of the KMS key is ENCRYPT_DECRYPT.
	// +kubebuilder:validation:Optional
	EncryptionAlgorithms []*string `json:"encryptionAlgorithms,omitempty"`
	// Specifies whether the KMS key'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 KMS key.
	// +kubebuilder:validation:Optional
	KeyID *string `json:"keyID,omitempty"`
	// The manager of the KMS key. KMS keys in your Amazon Web Services account
	// are either customer managed or Amazon Web Services managed. For more information
	// about the difference, see KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys)
	// in the Key Management Service Developer Guide.
	// +kubebuilder:validation:Optional
	KeyManager *string `json:"keyManager,omitempty"`
	// The current status of the KMS key.
	//
	// For more information about how key state affects the use of a KMS key, see
	// Key states of KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html)
	// in the Key Management Service Developer Guide.
	// +kubebuilder:validation:Optional
	KeyState *string `json:"keyState,omitempty"`
	// The message authentication code (MAC) algorithm that the HMAC KMS key supports.
	//
	// This value is present only when the KeyUsage of the KMS key is GENERATE_VERIFY_MAC.
	// +kubebuilder:validation:Optional
	MacAlgorithms []*string `json:"macAlgorithms,omitempty"`
	// Lists the primary and replica keys in same multi-Region key. This field is
	// present only when the value of the MultiRegion field is True.
	//
	// For more information about any listed KMS key, use the DescribeKey operation.
	//
	//    * MultiRegionKeyType indicates whether the KMS key is a PRIMARY or REPLICA
	//    key.
	//
	//    * PrimaryKey displays the key ARN and Region of the primary key. This
	//    field displays the current KMS key if it is the primary key.
	//
	//    * ReplicaKeys displays the key ARNs and Regions of all replica keys. This
	//    field includes the current KMS key if it is a replica key.
	// +kubebuilder:validation:Optional
	MultiRegionConfiguration *MultiRegionConfiguration `json:"multiRegionConfiguration,omitempty"`
	// The waiting period before the primary key in a multi-Region key is deleted.
	// This waiting period begins when the last of its replica keys is deleted.
	// This value is present only when the KeyState of the KMS key is PendingReplicaDeletion.
	// That indicates that the KMS key is the primary key in a multi-Region key,
	// it is scheduled for deletion, and it still has existing replica keys.
	//
	// When a single-Region KMS key or a multi-Region replica key is scheduled for
	// deletion, its deletion date is displayed in the DeletionDate field. However,
	// when the primary key in a multi-Region key is scheduled for deletion, its
	// waiting period doesn't begin until all of its replica keys are deleted. This
	// value displays that waiting period. When the last replica key in the multi-Region
	// key is deleted, the KeyState of the scheduled primary key changes from PendingReplicaDeletion
	// to PendingDeletion and the deletion date appears in the DeletionDate field.
	// +kubebuilder:validation:Optional
	PendingDeletionWindowInDays *int64 `json:"pendingDeletionWindowInDays,omitempty"`
	// The signing algorithms that the KMS key supports. You cannot use the KMS
	// key with other signing algorithms within KMS.
	//
	// This field appears only when the KeyUsage of the KMS key 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, KMS deletes the key material and the KMS key becomes unusable. This
	// value is present only for KMS keys 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 

func (in *KeyStatus) DeepCopy() *KeyStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KeyStatus.

func (*KeyStatus) DeepCopyInto 

func (in *KeyStatus) DeepCopyInto(out *KeyStatus)

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"
	KeyUsageType_GENERATE_VERIFY_MAC KeyUsageType = "GENERATE_VERIFY_MAC"
)

type MacAlgorithmSpec added in v0.1.2 

type MacAlgorithmSpec string
const (
	MacAlgorithmSpec_HMAC_SHA_224 MacAlgorithmSpec = "HMAC_SHA_224"
	MacAlgorithmSpec_HMAC_SHA_256 MacAlgorithmSpec = "HMAC_SHA_256"
	MacAlgorithmSpec_HMAC_SHA_384 MacAlgorithmSpec = "HMAC_SHA_384"
	MacAlgorithmSpec_HMAC_SHA_512 MacAlgorithmSpec = "HMAC_SHA_512"
)

type MessageType 

type MessageType string
const (
	MessageType_RAW    MessageType = "RAW"
	MessageType_DIGEST MessageType = "DIGEST"
)

type MultiRegionConfiguration added in v0.0.7 

type MultiRegionConfiguration struct {
	MultiRegionKeyType *string `json:"multiRegionKeyType,omitempty"`
	// Describes the primary or replica key in a multi-Region key.
	PrimaryKey  *MultiRegionKey   `json:"primaryKey,omitempty"`
	ReplicaKeys []*MultiRegionKey `json:"replicaKeys,omitempty"`
}

Describes the configuration of this multi-Region key. This field appears only when the KMS key is a primary or replica of a multi-Region key.

For more information about any listed KMS key, use the DescribeKey operation.

func (*MultiRegionConfiguration) DeepCopy added in v0.0.7 

func (in *MultiRegionConfiguration) DeepCopy() *MultiRegionConfiguration

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MultiRegionConfiguration.

func (*MultiRegionConfiguration) DeepCopyInto added in v0.0.7 

func (in *MultiRegionConfiguration) DeepCopyInto(out *MultiRegionConfiguration)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type MultiRegionKey added in v0.0.7 

type MultiRegionKey struct {
	ARN    *string `json:"arn,omitempty"`
	Region *string `json:"region,omitempty"`
}

Describes the primary or replica key in a multi-Region key.

func (*MultiRegionKey) DeepCopy added in v0.0.7 

func (in *MultiRegionKey) DeepCopy() *MultiRegionKey

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MultiRegionKey.

func (*MultiRegionKey) DeepCopyInto added in v0.0.7 

func (in *MultiRegionKey) DeepCopyInto(out *MultiRegionKey)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type MultiRegionKeyType added in v0.0.7 

type MultiRegionKeyType string
const (
	MultiRegionKeyType_PRIMARY MultiRegionKeyType = "PRIMARY"
	MultiRegionKeyType_REPLICA MultiRegionKeyType = "REPLICA"
)

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"
	SigningAlgorithmSpec_SM2DSA                    SigningAlgorithmSpec = "SM2DSA"
)

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 Amazon Web Services Billing and Cost Management User Guide.

func (*Tag) DeepCopy 

func (in *Tag) DeepCopy() *Tag

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Tag.

func (*Tag) DeepCopyInto 

func (in *Tag) DeepCopyInto(out *Tag)

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"
)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.