Documentation ¶
Overview ¶
+kubebuilder:object:generate=true +groupName=secretsmanager.aws.kubedb.com +versionName=v1alpha1
Index ¶
- Constants
- Variables
- type ReplicaInitParameters
- type ReplicaObservation
- type ReplicaParameters
- type Secret
- func (in *Secret) DeepCopy() *Secret
- func (in *Secret) DeepCopyInto(out *Secret)
- func (in *Secret) DeepCopyObject() runtime.Object
- func (mg *Secret) GetCondition(ct xpv1.ConditionType) xpv1.Condition
- func (tr *Secret) GetConnectionDetailsMapping() map[string]string
- func (mg *Secret) GetDeletionPolicy() xpv1.DeletionPolicy
- func (tr *Secret) GetID() string
- func (tr *Secret) GetInitParameters() (map[string]any, error)
- func (mg *Secret) GetManagementPolicies() xpv1.ManagementPolicies
- func (tr *Secret) GetMergedParameters(shouldMergeInitProvider bool) (map[string]any, error)
- func (tr *Secret) GetObservation() (map[string]any, error)
- func (tr *Secret) GetParameters() (map[string]any, error)
- func (mg *Secret) GetProviderConfigReference() *xpv1.Reference
- func (mg *Secret) GetPublishConnectionDetailsTo() *xpv1.PublishConnectionDetailsTo
- func (mg *Secret) GetTerraformResourceType() string
- func (tr *Secret) GetTerraformSchemaVersion() int
- func (mg *Secret) GetWriteConnectionSecretToReference() *xpv1.SecretReference
- func (tr *Secret) LateInitialize(attrs []byte) (bool, error)
- func (mg *Secret) ResolveReferences(ctx context.Context, c client.Reader) error
- func (mg *Secret) SetConditions(c ...xpv1.Condition)
- func (mg *Secret) SetDeletionPolicy(r xpv1.DeletionPolicy)
- func (mg *Secret) SetManagementPolicies(r xpv1.ManagementPolicies)
- func (tr *Secret) SetObservation(obs map[string]any) error
- func (tr *Secret) SetParameters(params map[string]any) error
- func (mg *Secret) SetProviderConfigReference(r *xpv1.Reference)
- func (mg *Secret) SetPublishConnectionDetailsTo(r *xpv1.PublishConnectionDetailsTo)
- func (mg *Secret) SetWriteConnectionSecretToReference(r *xpv1.SecretReference)
- type SecretInitParameters
- type SecretList
- type SecretObservation
- type SecretParameters
- type SecretSpec
- type SecretStatus
Constants ¶
const ( CRDGroup = "secretsmanager.aws.kubedb.com" CRDVersion = "v1alpha1" )
Package type metadata.
Variables ¶
var ( // CRDGroupVersion is the API Group Version used to register the objects CRDGroupVersion = schema.GroupVersion{Group: CRDGroup, Version: CRDVersion} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: CRDGroupVersion} // AddToScheme adds the types in this group-version to the given scheme. AddToScheme = SchemeBuilder.AddToScheme )
var ( Secret_Kind = "Secret" Secret_GroupKind = schema.GroupKind{Group: CRDGroup, Kind: Secret_Kind}.String() Secret_KindAPIVersion = Secret_Kind + "." + CRDGroupVersion.String() Secret_GroupVersionKind = CRDGroupVersion.WithKind(Secret_Kind) )
Repository type metadata.
Functions ¶
This section is empty.
Types ¶
type ReplicaInitParameters ¶
type ReplicaInitParameters struct { // ARN, Key ID, or Alias of the AWS KMS key within the region secret is replicated to. If one is not specified, then Secrets Manager defaults to using the AWS account's default KMS key (aws/secretsmanager) in the region or creates one for use if non-existent. KMSKeyID *string `json:"kmsKeyId,omitempty" tf:"kms_key_id,omitempty"` // Region for replicating the secret. Region *string `json:"region,omitempty" tf:"region,omitempty"` }
func (*ReplicaInitParameters) DeepCopy ¶
func (in *ReplicaInitParameters) DeepCopy() *ReplicaInitParameters
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ReplicaInitParameters.
func (*ReplicaInitParameters) DeepCopyInto ¶
func (in *ReplicaInitParameters) DeepCopyInto(out *ReplicaInitParameters)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ReplicaObservation ¶
type ReplicaObservation struct { // ARN, Key ID, or Alias of the AWS KMS key within the region secret is replicated to. If one is not specified, then Secrets Manager defaults to using the AWS account's default KMS key (aws/secretsmanager) in the region or creates one for use if non-existent. KMSKeyID *string `json:"kmsKeyId,omitempty" tf:"kms_key_id,omitempty"` // Date that you last accessed the secret in the Region. LastAccessedDate *string `json:"lastAccessedDate,omitempty" tf:"last_accessed_date,omitempty"` // Region for replicating the secret. Region *string `json:"region,omitempty" tf:"region,omitempty"` // Status can be InProgress, Failed, or InSync. Status *string `json:"status,omitempty" tf:"status,omitempty"` // Message such as Replication succeeded or Secret with this name already exists in this region. StatusMessage *string `json:"statusMessage,omitempty" tf:"status_message,omitempty"` }
func (*ReplicaObservation) DeepCopy ¶
func (in *ReplicaObservation) DeepCopy() *ReplicaObservation
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ReplicaObservation.
func (*ReplicaObservation) DeepCopyInto ¶
func (in *ReplicaObservation) DeepCopyInto(out *ReplicaObservation)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ReplicaParameters ¶
type ReplicaParameters struct { // ARN, Key ID, or Alias of the AWS KMS key within the region secret is replicated to. If one is not specified, then Secrets Manager defaults to using the AWS account's default KMS key (aws/secretsmanager) in the region or creates one for use if non-existent. // +kubebuilder:validation:Optional KMSKeyID *string `json:"kmsKeyId,omitempty" tf:"kms_key_id,omitempty"` // Region for replicating the secret. // +kubebuilder:validation:Optional Region *string `json:"region" tf:"region,omitempty"` }
func (*ReplicaParameters) DeepCopy ¶
func (in *ReplicaParameters) DeepCopy() *ReplicaParameters
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ReplicaParameters.
func (*ReplicaParameters) DeepCopyInto ¶
func (in *ReplicaParameters) DeepCopyInto(out *ReplicaParameters)
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"` // +kubebuilder:validation:XValidation:rule="!('*' in self.managementPolicies || 'Create' in self.managementPolicies || 'Update' in self.managementPolicies) || has(self.forProvider.region)",message="spec.forProvider.region is a required parameter" Spec SecretSpec `json:"spec"` Status SecretStatus `json:"status,omitempty"` }
Secret is the Schema for the Secrets API. Provides a resource to manage AWS Secrets Manager secret metadata +kubebuilder:printcolumn:name="READY",type="string",JSONPath=".status.conditions[?(@.type=='Ready')].status" +kubebuilder:printcolumn:name="SYNCED",type="string",JSONPath=".status.conditions[?(@.type=='Synced')].status" +kubebuilder:printcolumn:name="EXTERNAL-NAME",type="string",JSONPath=".metadata.annotations.crossplane\\.io/external-name" +kubebuilder:printcolumn:name="AGE",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:subresource:status +kubebuilder:resource:scope=Cluster,categories={crossplane,managed,aws}
func (*Secret) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Secret.
func (*Secret) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Secret) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Secret) GetCondition ¶
func (mg *Secret) GetCondition(ct xpv1.ConditionType) xpv1.Condition
GetCondition of this Secret.
func (*Secret) GetConnectionDetailsMapping ¶
GetConnectionDetailsMapping for this Secret
func (*Secret) GetDeletionPolicy ¶
func (mg *Secret) GetDeletionPolicy() xpv1.DeletionPolicy
GetDeletionPolicy of this Secret.
func (*Secret) GetInitParameters ¶
GetInitParameters of this Secret
func (*Secret) GetManagementPolicies ¶
func (mg *Secret) GetManagementPolicies() xpv1.ManagementPolicies
GetManagementPolicies of this Secret.
func (*Secret) GetMergedParameters ¶
GetInitParameters of this Secret
func (*Secret) GetObservation ¶
GetObservation of this Secret
func (*Secret) GetParameters ¶
GetParameters of this Secret
func (*Secret) GetProviderConfigReference ¶
GetProviderConfigReference of this Secret.
func (*Secret) GetPublishConnectionDetailsTo ¶
func (mg *Secret) GetPublishConnectionDetailsTo() *xpv1.PublishConnectionDetailsTo
GetPublishConnectionDetailsTo of this Secret.
func (*Secret) GetTerraformResourceType ¶
GetTerraformResourceType returns Terraform resource type for this Secret
func (*Secret) GetTerraformSchemaVersion ¶
GetTerraformSchemaVersion returns the associated Terraform schema version
func (*Secret) GetWriteConnectionSecretToReference ¶
func (mg *Secret) GetWriteConnectionSecretToReference() *xpv1.SecretReference
GetWriteConnectionSecretToReference of this Secret.
func (*Secret) LateInitialize ¶
LateInitialize this Secret using its observed tfState. returns True if there are any spec changes for the resource.
func (*Secret) ResolveReferences ¶
ResolveReferences of this Secret.
func (*Secret) SetConditions ¶
SetConditions of this Secret.
func (*Secret) SetDeletionPolicy ¶
func (mg *Secret) SetDeletionPolicy(r xpv1.DeletionPolicy)
SetDeletionPolicy of this Secret.
func (*Secret) SetManagementPolicies ¶
func (mg *Secret) SetManagementPolicies(r xpv1.ManagementPolicies)
SetManagementPolicies of this Secret.
func (*Secret) SetObservation ¶
SetObservation for this Secret
func (*Secret) SetParameters ¶
SetParameters for this Secret
func (*Secret) SetProviderConfigReference ¶
SetProviderConfigReference of this Secret.
func (*Secret) SetPublishConnectionDetailsTo ¶
func (mg *Secret) SetPublishConnectionDetailsTo(r *xpv1.PublishConnectionDetailsTo)
SetPublishConnectionDetailsTo of this Secret.
func (*Secret) SetWriteConnectionSecretToReference ¶
func (mg *Secret) SetWriteConnectionSecretToReference(r *xpv1.SecretReference)
SetWriteConnectionSecretToReference of this Secret.
type SecretInitParameters ¶
type SecretInitParameters struct { // Description of the secret. Description *string `json:"description,omitempty" tf:"description,omitempty"` // Accepts boolean value to specify whether to overwrite a secret with the same name in the destination Region. ForceOverwriteReplicaSecret *bool `json:"forceOverwriteReplicaSecret,omitempty" tf:"force_overwrite_replica_secret,omitempty"` // Friendly name of the new secret. The secret name can consist of uppercase letters, lowercase letters, digits, and any of the following characters: /_+=.@- Conflicts with name_prefix. Name *string `json:"name,omitempty" tf:"name,omitempty"` // Creates a unique name beginning with the specified prefix. Conflicts with name. NamePrefix *string `json:"namePrefix,omitempty" tf:"name_prefix,omitempty"` // Number of days that AWS Secrets Manager waits before it can delete the secret. This value can be 0 to force deletion without recovery or range from 7 to 30 days. The default value is 30. RecoveryWindowInDays *float64 `json:"recoveryWindowInDays,omitempty" tf:"recovery_window_in_days,omitempty"` // Configuration block to support secret replication. See details below. Replica []ReplicaInitParameters `json:"replica,omitempty" tf:"replica,omitempty"` // Key-value map of user-defined tags that are attached to the secret. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level. Tags map[string]*string `json:"tags,omitempty" tf:"tags,omitempty"` // Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block. TagsAll map[string]*string `json:"tagsAll,omitempty" tf:"tags_all,omitempty"` }
func (*SecretInitParameters) DeepCopy ¶
func (in *SecretInitParameters) DeepCopy() *SecretInitParameters
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SecretInitParameters.
func (*SecretInitParameters) DeepCopyInto ¶
func (in *SecretInitParameters) DeepCopyInto(out *SecretInitParameters)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SecretList ¶
type SecretList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []Secret `json:"items"` }
SecretList contains a list of Secrets
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.
func (*SecretList) GetItems ¶
func (l *SecretList) GetItems() []resource.Managed
GetItems of this SecretList.
type SecretObservation ¶
type SecretObservation struct { // ARN of the secret. Arn *string `json:"arn,omitempty" tf:"arn,omitempty"` // Description of the secret. Description *string `json:"description,omitempty" tf:"description,omitempty"` // Accepts boolean value to specify whether to overwrite a secret with the same name in the destination Region. ForceOverwriteReplicaSecret *bool `json:"forceOverwriteReplicaSecret,omitempty" tf:"force_overwrite_replica_secret,omitempty"` // ARN of the secret. ID *string `json:"id,omitempty" tf:"id,omitempty"` // ARN or Id of the AWS KMS key to be used to encrypt the secret values in the versions stored in this secret. If you need to reference a CMK in a different account, you can use only the key ARN. If you don't specify this value, then Secrets Manager defaults to using the AWS account's default KMS key (the one named aws/secretsmanager). If the default KMS key with that name doesn't yet exist, then AWS Secrets Manager creates it for you automatically the first time. KMSKeyID *string `json:"kmsKeyId,omitempty" tf:"kms_key_id,omitempty"` // Friendly name of the new secret. The secret name can consist of uppercase letters, lowercase letters, digits, and any of the following characters: /_+=.@- Conflicts with name_prefix. Name *string `json:"name,omitempty" tf:"name,omitempty"` // Creates a unique name beginning with the specified prefix. Conflicts with name. NamePrefix *string `json:"namePrefix,omitempty" tf:"name_prefix,omitempty"` // Valid JSON document representing a resource policy. Removing policy from your configuration or setting policy to null or an empty string (i.e., policy = "") will not delete the policy since it could have been set by aws_secretsmanager_secret_policy. To delete the policy, set it to "{}" (an empty JSON document). Policy *string `json:"policy,omitempty" tf:"policy,omitempty"` // Number of days that AWS Secrets Manager waits before it can delete the secret. This value can be 0 to force deletion without recovery or range from 7 to 30 days. The default value is 30. RecoveryWindowInDays *float64 `json:"recoveryWindowInDays,omitempty" tf:"recovery_window_in_days,omitempty"` // Configuration block to support secret replication. See details below. Replica []ReplicaObservation `json:"replica,omitempty" tf:"replica,omitempty"` // Key-value map of user-defined tags that are attached to the secret. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level. Tags map[string]*string `json:"tags,omitempty" tf:"tags,omitempty"` // Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block. TagsAll map[string]*string `json:"tagsAll,omitempty" tf:"tags_all,omitempty"` }
func (*SecretObservation) DeepCopy ¶
func (in *SecretObservation) DeepCopy() *SecretObservation
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SecretObservation.
func (*SecretObservation) DeepCopyInto ¶
func (in *SecretObservation) DeepCopyInto(out *SecretObservation)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SecretParameters ¶
type SecretParameters struct { // Description of the secret. // +kubebuilder:validation:Optional Description *string `json:"description,omitempty" tf:"description,omitempty"` // Accepts boolean value to specify whether to overwrite a secret with the same name in the destination Region. // +kubebuilder:validation:Optional ForceOverwriteReplicaSecret *bool `json:"forceOverwriteReplicaSecret,omitempty" tf:"force_overwrite_replica_secret,omitempty"` // ARN or Id of the AWS KMS key to be used to encrypt the secret values in the versions stored in this secret. If you need to reference a CMK in a different account, you can use only the key ARN. If you don't specify this value, then Secrets Manager defaults to using the AWS account's default KMS key (the one named aws/secretsmanager). If the default KMS key with that name doesn't yet exist, then AWS Secrets Manager creates it for you automatically the first time. // +crossplane:generate:reference:type=kubedb.dev/provider-aws/apis/kms/v1alpha1.Key // +kubebuilder:validation:Optional KMSKeyID *string `json:"kmsKeyId,omitempty" tf:"kms_key_id,omitempty"` // Reference to a Key in kms to populate kmsKeyId. // +kubebuilder:validation:Optional KMSKeyIDRef *v1.Reference `json:"kmsKeyIdRef,omitempty" tf:"-"` // Selector for a Key in kms to populate kmsKeyId. // +kubebuilder:validation:Optional KMSKeyIDSelector *v1.Selector `json:"kmsKeyIdSelector,omitempty" tf:"-"` // Friendly name of the new secret. The secret name can consist of uppercase letters, lowercase letters, digits, and any of the following characters: /_+=.@- Conflicts with name_prefix. // +kubebuilder:validation:Optional Name *string `json:"name,omitempty" tf:"name,omitempty"` // Creates a unique name beginning with the specified prefix. Conflicts with name. // +kubebuilder:validation:Optional NamePrefix *string `json:"namePrefix,omitempty" tf:"name_prefix,omitempty"` // Number of days that AWS Secrets Manager waits before it can delete the secret. This value can be 0 to force deletion without recovery or range from 7 to 30 days. The default value is 30. // +kubebuilder:validation:Optional RecoveryWindowInDays *float64 `json:"recoveryWindowInDays,omitempty" tf:"recovery_window_in_days,omitempty"` // Region for replicating the secret. // Region is the region you'd like your resource to be created in. // +upjet:crd:field:TFTag=- // +kubebuilder:validation:Optional Region *string `json:"region,omitempty" tf:"-"` // Configuration block to support secret replication. See details below. // +kubebuilder:validation:Optional Replica []ReplicaParameters `json:"replica,omitempty" tf:"replica,omitempty"` // Key-value map of user-defined tags that are attached to the secret. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level. // +kubebuilder:validation:Optional Tags map[string]*string `json:"tags,omitempty" tf:"tags,omitempty"` // Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block. // +kubebuilder:validation:Optional TagsAll map[string]*string `json:"tagsAll,omitempty" tf:"tags_all,omitempty"` }
func (*SecretParameters) DeepCopy ¶
func (in *SecretParameters) DeepCopy() *SecretParameters
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SecretParameters.
func (*SecretParameters) DeepCopyInto ¶
func (in *SecretParameters) DeepCopyInto(out *SecretParameters)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SecretSpec ¶
type SecretSpec struct { v1.ResourceSpec `json:",inline"` ForProvider SecretParameters `json:"forProvider"` // THIS IS A BETA FIELD. It will be honored // unless the Management Policies feature flag is disabled. // InitProvider holds the same fields as ForProvider, with the exception // of Identifier and other resource reference fields. The fields that are // in InitProvider are merged into ForProvider when the resource is created. // The same fields are also added to the terraform ignore_changes hook, to // avoid updating them after creation. This is useful for fields that are // required on creation, but we do not desire to update them after creation, // for example because of an external controller is managing them, like an // autoscaler. InitProvider SecretInitParameters `json:"initProvider,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 { v1.ResourceStatus `json:",inline"` AtProvider SecretObservation `json:"atProvider,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.