v1alpha1

package
v0.0.3 Latest Latest
Warning

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

 Go to latest Published: Jan 29, 2024 License: Apache-2.0 Imports: 6 Imported by: 2

Documentation

Overview

+k8s:deepcopy-gen=package Package v1alpha1 is the v1alpha1 version of the secretsmanager.services.k8s.aws API. +groupName=secretsmanager.services.k8s.aws

Index

Constants

This section is empty.

Variables

View Source 
var (
	// GroupVersion is the API Group Version used to register the objects
	GroupVersion = schema.GroupVersion{Group: "secretsmanager.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 APIErrorType added in v0.0.2 

type APIErrorType struct {
	SecretID *string `json:"secretID,omitempty"`
}

The error Secrets Manager encountered while retrieving an individual secret as part of BatchGetSecretValue.

func (*APIErrorType) DeepCopy added in v0.0.2 

func (in *APIErrorType) DeepCopy() *APIErrorType

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

func (*APIErrorType) DeepCopyInto added in v0.0.2 

func (in *APIErrorType) DeepCopyInto(out *APIErrorType)

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

type Filter 

type Filter struct {
	Key    *string   `json:"key,omitempty"`
	Values []*string `json:"values,omitempty"`
}

Allows you to add filters when you use the search function in Secrets Manager. For more information, see Find secrets in Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_search-secret.html).

func (*Filter) DeepCopy 

func (in *Filter) DeepCopy() *Filter

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

func (*Filter) DeepCopyInto 

func (in *Filter) DeepCopyInto(out *Filter)

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

type FilterNameStringType 

type FilterNameStringType string
const (
	FilterNameStringType_description    FilterNameStringType = "description"
	FilterNameStringType_name           FilterNameStringType = "name"
	FilterNameStringType_tag_key        FilterNameStringType = "tag-key"
	FilterNameStringType_tag_value      FilterNameStringType = "tag-value"
	FilterNameStringType_primary_region FilterNameStringType = "primary-region"
	FilterNameStringType_owning_service FilterNameStringType = "owning-service"
	FilterNameStringType_all            FilterNameStringType = "all"
)

type ReplicaRegionType 

type ReplicaRegionType struct {
	KMSKeyID *string `json:"kmsKeyID,omitempty"`
	Region   *string `json:"region,omitempty"`
}

A custom type that specifies a Region and the KmsKeyId for a replica secret.

func (*ReplicaRegionType) DeepCopy 

func (in *ReplicaRegionType) DeepCopy() *ReplicaRegionType

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

func (*ReplicaRegionType) DeepCopyInto 

func (in *ReplicaRegionType) DeepCopyInto(out *ReplicaRegionType)

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

type ReplicationStatusType 

type ReplicationStatusType struct {
	KMSKeyID         *string      `json:"kmsKeyID,omitempty"`
	LastAccessedDate *metav1.Time `json:"lastAccessedDate,omitempty"`
	Region           *string      `json:"region,omitempty"`
	Status           *string      `json:"status,omitempty"`
	StatusMessage    *string      `json:"statusMessage,omitempty"`
}

A replication object consisting of a RegionReplicationStatus object and includes a Region, KMSKeyId, status, and status message.

func (*ReplicationStatusType) DeepCopy 

func (in *ReplicationStatusType) DeepCopy() *ReplicationStatusType

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

func (*ReplicationStatusType) DeepCopyInto 

func (in *ReplicationStatusType) DeepCopyInto(out *ReplicationStatusType)

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

type RotationRulesType 

type RotationRulesType struct {
	AutomaticallyAfterDays *int64  `json:"automaticallyAfterDays,omitempty"`
	Duration               *string `json:"duration,omitempty"`
	ScheduleExpression     *string `json:"scheduleExpression,omitempty"`
}

A structure that defines the rotation configuration for the secret.

func (*RotationRulesType) DeepCopy 

func (in *RotationRulesType) DeepCopy() *RotationRulesType

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

func (*RotationRulesType) DeepCopyInto 

func (in *RotationRulesType) DeepCopyInto(out *RotationRulesType)

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

type Secret 

type Secret struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              SecretSpec   `json:"spec,omitempty"`
	Status            SecretStatus `json:"status,omitempty"`
}

Secret is the Schema for the Secrets API +kubebuilder:object:root=true +kubebuilder:subresource:status

func (*Secret) DeepCopy 

func (in *Secret) DeepCopy() *Secret

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

func (*Secret) DeepCopyInto 

func (in *Secret) DeepCopyInto(out *Secret)

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

func (*Secret) DeepCopyObject 

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

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type SecretList 

type SecretList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Secret `json:"items"`
}

SecretList contains a list of Secret +kubebuilder:object:root=true

func (*SecretList) DeepCopy 

func (in *SecretList) DeepCopy() *SecretList

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

func (*SecretList) DeepCopyInto 

func (in *SecretList) DeepCopyInto(out *SecretList)

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

func (*SecretList) DeepCopyObject 

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

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type SecretListEntry 

type SecretListEntry struct {
	ARN               *string      `json:"arn,omitempty"`
	CreatedDate       *metav1.Time `json:"createdDate,omitempty"`
	DeletedDate       *metav1.Time `json:"deletedDate,omitempty"`
	Description       *string      `json:"description,omitempty"`
	KMSKeyID          *string      `json:"kmsKeyID,omitempty"`
	LastAccessedDate  *metav1.Time `json:"lastAccessedDate,omitempty"`
	LastChangedDate   *metav1.Time `json:"lastChangedDate,omitempty"`
	LastRotatedDate   *metav1.Time `json:"lastRotatedDate,omitempty"`
	Name              *string      `json:"name,omitempty"`
	NextRotationDate  *metav1.Time `json:"nextRotationDate,omitempty"`
	OwningService     *string      `json:"owningService,omitempty"`
	PrimaryRegion     *string      `json:"primaryRegion,omitempty"`
	RotationEnabled   *bool        `json:"rotationEnabled,omitempty"`
	RotationLambdaARN *string      `json:"rotationLambdaARN,omitempty"`
	// A structure that defines the rotation configuration for the secret.
	RotationRules          *RotationRulesType   `json:"rotationRules,omitempty"`
	SecretVersionsToStages map[string][]*string `json:"secretVersionsToStages,omitempty"`
	Tags                   []*Tag               `json:"tags,omitempty"`
}

A structure that contains the details about a secret. It does not include the encrypted SecretString and SecretBinary values. To get those values, use GetSecretValue (https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_GetSecretValue.html) .

func (*SecretListEntry) DeepCopy 

func (in *SecretListEntry) DeepCopy() *SecretListEntry

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

func (*SecretListEntry) DeepCopyInto 

func (in *SecretListEntry) DeepCopyInto(out *SecretListEntry)

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

type SecretSpec 

type SecretSpec struct {

	// The description of the secret.
	Description *string `json:"description,omitempty"`
	// Specifies whether to overwrite a secret with the same name in the destination
	// Region. By default, secrets aren't overwritten.
	ForceOverwriteReplicaSecret *bool `json:"forceOverwriteReplicaSecret,omitempty"`
	// The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt
	// the secret value in the secret. An alias is always prefixed by alias/, for
	// example alias/aws/secretsmanager. For more information, see About aliases
	// (https://docs.aws.amazon.com/kms/latest/developerguide/alias-about.html).
	//
	// To use a KMS key in a different account, use the key ARN or the alias ARN.
	//
	// If you don't specify this value, then Secrets Manager uses the key aws/secretsmanager.
	// If that key doesn't yet exist, then Secrets Manager creates it for you automatically
	// the first time it encrypts the secret value.
	//
	// If the secret is in a different Amazon Web Services account from the credentials
	// calling the API, then you can't use aws/secretsmanager to encrypt the secret,
	// and you must create and use a customer managed KMS key.
	KMSKeyID *string `json:"kmsKeyID,omitempty"`
	// The name of the new secret.
	//
	// The secret name can contain ASCII letters, numbers, and the following characters:
	// /_+=.@-
	//
	// Do not end your secret name with a hyphen followed by six characters. If
	// you do so, you risk confusion and unexpected results when searching for a
	// secret by partial ARN. Secrets Manager automatically adds a hyphen and six
	// random characters after the secret name at the end of the ARN.
	// +kubebuilder:validation:Required
	Name *string `json:"name"`
	// A list of Regions and KMS keys to replicate secrets.
	ReplicaRegions []*ReplicaRegionType `json:"replicaRegions,omitempty"`
	// The text data to encrypt and store in this new version of the secret. We
	// recommend you use a JSON structure of key/value pairs for your secret value.
	//
	// Either SecretString or SecretBinary must have a value, but not both.
	//
	// If you create a secret by using the Secrets Manager console then Secrets
	// Manager puts the protected secret text in only the SecretString parameter.
	// The Secrets Manager console stores the information as a JSON structure of
	// key/value pairs that a Lambda rotation function can parse.
	SecretString *ackv1alpha1.SecretKeyReference `json:"secretString,omitempty"`
	// A list of tags to attach to the secret. Each tag is a key and value pair
	// of strings in a JSON text string, for example:
	//
	// [{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]
	//
	// Secrets Manager tag key names are case sensitive. A tag with the key "ABC"
	// is a different tag from one with key "abc".
	//
	// If you check tags in permissions policies as part of your security strategy,
	// then adding or removing a tag can change permissions. If the completion of
	// this operation would result in you losing your permissions for this secret,
	// then Secrets Manager blocks the operation and returns an Access Denied error.
	// For more information, see Control access to secrets using tags (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#tag-secrets-abac)
	// and Limit access to identities with tags that match secrets' tags (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#auth-and-access_tags2).
	//
	// For information about how to format a JSON parameter for the various command
	// line tool environments, see Using JSON for Parameters (https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json).
	// If your command-line tool or SDK requires quotation marks around the parameter,
	// you should use single quotes to avoid confusion with the double quotes required
	// in the JSON text.
	//
	// For tag quotas and naming restrictions, see Service quotas for Tagging (https://docs.aws.amazon.com/general/latest/gr/arg.html#taged-reference-quotas)
	// in the Amazon Web Services General Reference guide.
	Tags []*Tag `json:"tags,omitempty"`
}

SecretSpec defines the desired state of Secret.

func (*SecretSpec) DeepCopy 

func (in *SecretSpec) DeepCopy() *SecretSpec

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

func (*SecretSpec) DeepCopyInto 

func (in *SecretSpec) DeepCopyInto(out *SecretSpec)

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

type SecretStatus 

type SecretStatus 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 ARN of the secret.
	// +kubebuilder:validation:Optional
	ID *string `json:"id,omitempty"`
	// A list of the replicas of this secret and their status:
	//
	//    * Failed, which indicates that the replica was not created.
	//
	//    * InProgress, which indicates that Secrets Manager is in the process of
	//    creating the replica.
	//
	//    * InSync, which indicates that the replica was created.
	// +kubebuilder:validation:Optional
	ReplicationStatus []*ReplicationStatusType `json:"replicationStatus,omitempty"`
	// The unique identifier associated with the version of the new secret.
	// +kubebuilder:validation:Optional
	VersionID *string `json:"versionID,omitempty"`
}

SecretStatus defines the observed state of Secret

func (*SecretStatus) DeepCopy 

func (in *SecretStatus) DeepCopy() *SecretStatus

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

func (*SecretStatus) DeepCopyInto 

func (in *SecretStatus) DeepCopyInto(out *SecretStatus)

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

type SecretValueEntry added in v0.0.2 

type SecretValueEntry struct {
	ARN           *string   `json:"arn,omitempty"`
	Name          *string   `json:"name,omitempty"`
	SecretBinary  []byte    `json:"secretBinary,omitempty"`
	SecretString  *string   `json:"secretString,omitempty"`
	VersionID     *string   `json:"versionID,omitempty"`
	VersionStages []*string `json:"versionStages,omitempty"`
}

A structure that contains the secret value and other details for a secret.

func (*SecretValueEntry) DeepCopy added in v0.0.2 

func (in *SecretValueEntry) DeepCopy() *SecretValueEntry

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

func (*SecretValueEntry) DeepCopyInto added in v0.0.2 

func (in *SecretValueEntry) DeepCopyInto(out *SecretValueEntry)

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

type SecretVersionsListEntry 

type SecretVersionsListEntry struct {
	LastAccessedDate *metav1.Time `json:"lastAccessedDate,omitempty"`
	VersionID        *string      `json:"versionID,omitempty"`
	VersionStages    []*string    `json:"versionStages,omitempty"`
}

A structure that contains information about one version of a secret.

func (*SecretVersionsListEntry) DeepCopy 

func (in *SecretVersionsListEntry) DeepCopy() *SecretVersionsListEntry

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

func (*SecretVersionsListEntry) DeepCopyInto 

func (in *SecretVersionsListEntry) DeepCopyInto(out *SecretVersionsListEntry)

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

type SortOrderType 

type SortOrderType string
const (
	SortOrderType_asc  SortOrderType = "asc"
	SortOrderType_desc SortOrderType = "desc"
)

type StatusType 

type StatusType string
const (
	StatusType_InSync     StatusType = "InSync"
	StatusType_Failed     StatusType = "Failed"
	StatusType_InProgress StatusType = "InProgress"
)

type Tag 

type Tag struct {
	Key   *string `json:"key,omitempty"`
	Value *string `json:"value,omitempty"`
}

A structure that contains information about a tag.

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 ValidationErrorsEntry 

type ValidationErrorsEntry struct {
	CheckName *string `json:"checkName,omitempty"`
}

Displays errors that occurred during validation of the resource policy.

func (*ValidationErrorsEntry) DeepCopy 

func (in *ValidationErrorsEntry) DeepCopy() *ValidationErrorsEntry

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

func (*ValidationErrorsEntry) DeepCopyInto 

func (in *ValidationErrorsEntry) DeepCopyInto(out *ValidationErrorsEntry)

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

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.