Documentation
¶
Overview ¶
Package v1beta1 contains API Schema definitions for the secretmanager v1beta1 API group. +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/GoogleCloudPlatform/k8s-config-connector/pkg/clients/generated/pkg/apis/secretmanager +k8s:defaulter-gen=TypeMeta +groupName=secretmanager.cnrm.cloud.google.com
Index ¶
- Variables
- type SecretAuto
- type SecretCustomerManagedEncryption
- type SecretManagerSecret
- type SecretManagerSecretList
- type SecretManagerSecretSpec
- type SecretManagerSecretStatus
- type SecretManagerSecretVersion
- type SecretManagerSecretVersionList
- type SecretManagerSecretVersionSpec
- type SecretManagerSecretVersionStatus
- type SecretObservedStateStatus
- type SecretReplicas
- type SecretReplication
- type SecretRotation
- type SecretTopics
- type SecretUserManaged
- type SecretversionSecretData
- type SecretversionValueFrom
Constants ¶
This section is empty.
Variables ¶
var ( // SchemeGroupVersion is the group version used to register these objects. SchemeGroupVersion = schema.GroupVersion{Group: "secretmanager.cnrm.cloud.google.com", Version: "v1beta1"} // SchemeBuilder is used to add go types to the GroupVersionKind scheme. SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion} // AddToScheme is a global function that registers this API group & version to a scheme AddToScheme = SchemeBuilder.AddToScheme SecretManagerSecretGVK = schema.GroupVersionKind{ Group: SchemeGroupVersion.Group, Version: SchemeGroupVersion.Version, Kind: reflect.TypeOf(SecretManagerSecret{}).Name(), } SecretManagerSecretVersionGVK = schema.GroupVersionKind{ Group: SchemeGroupVersion.Group, Version: SchemeGroupVersion.Version, Kind: reflect.TypeOf(SecretManagerSecretVersion{}).Name(), } )
Functions ¶
This section is empty.
Types ¶
type SecretAuto ¶ added in v1.110.0
type SecretAuto struct {
/* Optional. The customer-managed encryption configuration of the
[Secret][google.cloud.secretmanager.v1.Secret]. If no configuration is
provided, Google-managed default encryption is used.
Updates to the [Secret][google.cloud.secretmanager.v1.Secret] encryption
configuration only apply to
[SecretVersions][google.cloud.secretmanager.v1.SecretVersion] added
afterwards. They do not apply retroactively to existing
[SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. */
// +optional
CustomerManagedEncryption *SecretCustomerManagedEncryption `json:"customerManagedEncryption,omitempty"`
}
func (*SecretAuto) DeepCopy ¶ added in v1.110.0
func (in *SecretAuto) DeepCopy() *SecretAuto
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SecretAuto.
func (*SecretAuto) DeepCopyInto ¶ added in v1.110.0
func (in *SecretAuto) DeepCopyInto(out *SecretAuto)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SecretCustomerManagedEncryption ¶
type SecretCustomerManagedEncryption struct {
/* Required. The resource name of the Cloud KMS CryptoKey used to encrypt
secret payloads.
For secrets using the
[UserManaged][google.cloud.secretmanager.v1.Replication.UserManaged]
replication policy type, Cloud KMS CryptoKeys must reside in the same
location as the [replica location][Secret.UserManaged.Replica.location].
For secrets using the
[Automatic][google.cloud.secretmanager.v1.Replication.Automatic]
replication policy type, Cloud KMS CryptoKeys must reside in `global`.
The expected format is `projects/* /locations/* /keyRings/* /cryptoKeys/*`. */
KmsKeyRef v1alpha1.ResourceRef `json:"kmsKeyRef"`
}
func (*SecretCustomerManagedEncryption) DeepCopy ¶
func (in *SecretCustomerManagedEncryption) DeepCopy() *SecretCustomerManagedEncryption
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SecretCustomerManagedEncryption.
func (*SecretCustomerManagedEncryption) DeepCopyInto ¶
func (in *SecretCustomerManagedEncryption) DeepCopyInto(out *SecretCustomerManagedEncryption)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SecretManagerSecret ¶
type SecretManagerSecret struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec SecretManagerSecretSpec `json:"spec,omitempty"`
Status SecretManagerSecretStatus `json:"status,omitempty"`
}
SecretManagerSecret is the Schema for the secretmanager API +k8s:openapi-gen=true
func (*SecretManagerSecret) DeepCopy ¶
func (in *SecretManagerSecret) DeepCopy() *SecretManagerSecret
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SecretManagerSecret.
func (*SecretManagerSecret) DeepCopyInto ¶
func (in *SecretManagerSecret) DeepCopyInto(out *SecretManagerSecret)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*SecretManagerSecret) DeepCopyObject ¶
func (in *SecretManagerSecret) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type SecretManagerSecretList ¶
type SecretManagerSecretList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []SecretManagerSecret `json:"items"`
}
SecretManagerSecretList contains a list of SecretManagerSecret
func (*SecretManagerSecretList) DeepCopy ¶
func (in *SecretManagerSecretList) DeepCopy() *SecretManagerSecretList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SecretManagerSecretList.
func (*SecretManagerSecretList) DeepCopyInto ¶
func (in *SecretManagerSecretList) DeepCopyInto(out *SecretManagerSecretList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*SecretManagerSecretList) DeepCopyObject ¶
func (in *SecretManagerSecretList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type SecretManagerSecretSpec ¶
type SecretManagerSecretSpec struct {
/* Optional. Custom metadata about the secret.
Annotations are distinct from various forms of labels.
Annotations exist to allow client tools to store their own state
information without requiring a database.
Annotation keys must be between 1 and 63 characters long, have a UTF-8
encoding of maximum 128 bytes, begin and end with an alphanumeric character
([a-z0-9A-Z]), and may have dashes (-), underscores (_), dots (.), and
alphanumerics in between these symbols.
The total size of annotation keys and values must be less than 16KiB. */
// +optional
Annotations map[string]string `json:"annotations,omitempty"`
/* Optional. Timestamp in UTC when the [Secret][google.cloud.secretmanager.v1.Secret] is scheduled to expire. This is always provided on output, regardless of what was sent on input. */
// +optional
ExpireTime *string `json:"expireTime,omitempty"`
/* Optional. Immutable. The replication policy of the secret data attached to
the [Secret][google.cloud.secretmanager.v1.Secret].
The replication policy cannot be changed after the Secret has been created. */
// +optional
Replication *SecretReplication `json:"replication,omitempty"`
/* Immutable. The SecretManagerSecret name. If not given, the metadata.name will be used. */
// +optional
ResourceID *string `json:"resourceID,omitempty"`
/* Optional. Rotation policy attached to the [Secret][google.cloud.secretmanager.v1.Secret]. May be excluded if there is no rotation policy. */
// +optional
Rotation *SecretRotation `json:"rotation,omitempty"`
/* Optional. A list of up to 10 Pub/Sub topics to which messages are published when control plane operations are called on the secret or its versions. */
// +optional
Topics []SecretTopics `json:"topics,omitempty"`
/* Input only. The TTL for the [Secret][google.cloud.secretmanager.v1.Secret]. */
// +optional
Ttl *string `json:"ttl,omitempty"`
/* Optional. Mapping from version alias to version name.
A version alias is a string with a maximum length of 63 characters and can
contain uppercase and lowercase letters, numerals, and the hyphen (`-`)
and underscore ('_') characters. An alias string must start with a
letter and cannot be the string 'latest' or 'NEW'.
No more than 50 aliases can be assigned to a given secret.
Version-Alias pairs will be viewable via GetSecret and modifiable via
UpdateSecret. Access by alias is only be supported on
GetSecretVersion and AccessSecretVersion. */
// +optional
VersionAliases map[string]string `json:"versionAliases,omitempty"`
}
func (*SecretManagerSecretSpec) DeepCopy ¶
func (in *SecretManagerSecretSpec) DeepCopy() *SecretManagerSecretSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SecretManagerSecretSpec.
func (*SecretManagerSecretSpec) DeepCopyInto ¶
func (in *SecretManagerSecretSpec) DeepCopyInto(out *SecretManagerSecretSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SecretManagerSecretStatus ¶
type SecretManagerSecretStatus struct {
/* Conditions represent the latest available observations of the
SecretManagerSecret's current state. */
Conditions []v1alpha1.Condition `json:"conditions,omitempty"`
/* A unique specifier for the SecretManagerSecret resource in GCP. */
// +optional
ExternalRef *string `json:"externalRef,omitempty"`
/* [DEPRECATED] Please read from `.status.externalRef` instead. Config Connector will remove the `.status.name` in v1 Version. */
// +optional
Name *string `json:"name,omitempty"`
/* ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource. */
// +optional
ObservedGeneration *int64 `json:"observedGeneration,omitempty"`
/* ObservedState is the state of the resource as most recently observed in GCP. */
// +optional
ObservedState *SecretObservedStateStatus `json:"observedState,omitempty"`
}
func (*SecretManagerSecretStatus) DeepCopy ¶
func (in *SecretManagerSecretStatus) DeepCopy() *SecretManagerSecretStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SecretManagerSecretStatus.
func (*SecretManagerSecretStatus) DeepCopyInto ¶
func (in *SecretManagerSecretStatus) DeepCopyInto(out *SecretManagerSecretStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SecretManagerSecretVersion ¶
type SecretManagerSecretVersion struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec SecretManagerSecretVersionSpec `json:"spec,omitempty"`
Status SecretManagerSecretVersionStatus `json:"status,omitempty"`
}
SecretManagerSecretVersion is the Schema for the secretmanager API +k8s:openapi-gen=true
func (*SecretManagerSecretVersion) DeepCopy ¶
func (in *SecretManagerSecretVersion) DeepCopy() *SecretManagerSecretVersion
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SecretManagerSecretVersion.
func (*SecretManagerSecretVersion) DeepCopyInto ¶
func (in *SecretManagerSecretVersion) DeepCopyInto(out *SecretManagerSecretVersion)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*SecretManagerSecretVersion) DeepCopyObject ¶
func (in *SecretManagerSecretVersion) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type SecretManagerSecretVersionList ¶
type SecretManagerSecretVersionList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []SecretManagerSecretVersion `json:"items"`
}
SecretManagerSecretVersionList contains a list of SecretManagerSecretVersion
func (*SecretManagerSecretVersionList) DeepCopy ¶
func (in *SecretManagerSecretVersionList) DeepCopy() *SecretManagerSecretVersionList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SecretManagerSecretVersionList.
func (*SecretManagerSecretVersionList) DeepCopyInto ¶
func (in *SecretManagerSecretVersionList) DeepCopyInto(out *SecretManagerSecretVersionList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*SecretManagerSecretVersionList) DeepCopyObject ¶
func (in *SecretManagerSecretVersionList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type SecretManagerSecretVersionSpec ¶
type SecretManagerSecretVersionSpec struct {
/* The deletion policy for the secret version. Setting 'ABANDON' allows the resource
to be abandoned rather than deleted. Setting 'DISABLE' allows the resource to be
disabled rather than deleted. Default is 'DELETE'. Possible values are:
* DELETE
* DISABLE
* ABANDON. */
// +optional
DeletionPolicy *string `json:"deletionPolicy,omitempty"`
/* The current state of the SecretVersion. */
// +optional
Enabled *bool `json:"enabled,omitempty"`
/* Immutable. If set to 'true', the secret data is expected to be base64-encoded string and would be sent as is. */
// +optional
IsSecretDataBase64 *bool `json:"isSecretDataBase64,omitempty"`
/* Immutable. Optional. The service-generated name of the resource. Used for acquisition only. Leave unset to create a new resource. */
// +optional
ResourceID *string `json:"resourceID,omitempty"`
/* Immutable. The secret data. Must be no larger than 64KiB. */
SecretData SecretversionSecretData `json:"secretData"`
/* Secret Manager secret resource */
SecretRef v1alpha1.ResourceRef `json:"secretRef"`
}
func (*SecretManagerSecretVersionSpec) DeepCopy ¶
func (in *SecretManagerSecretVersionSpec) DeepCopy() *SecretManagerSecretVersionSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SecretManagerSecretVersionSpec.
func (*SecretManagerSecretVersionSpec) DeepCopyInto ¶
func (in *SecretManagerSecretVersionSpec) DeepCopyInto(out *SecretManagerSecretVersionSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SecretManagerSecretVersionStatus ¶
type SecretManagerSecretVersionStatus struct {
/* Conditions represent the latest available observations of the
SecretManagerSecretVersion's current state. */
Conditions []v1alpha1.Condition `json:"conditions,omitempty"`
/* The time at which the Secret was created. */
// +optional
CreateTime *string `json:"createTime,omitempty"`
/* The time at which the Secret was destroyed. Only present if state is DESTROYED. */
// +optional
DestroyTime *string `json:"destroyTime,omitempty"`
/* The resource name of the SecretVersion. Format:
'projects/{{project}}/secrets/{{secret_id}}/versions/{{version}}'. */
// +optional
Name *string `json:"name,omitempty"`
/* ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource. */
// +optional
ObservedGeneration *int64 `json:"observedGeneration,omitempty"`
/* The version of the Secret. */
// +optional
Version *string `json:"version,omitempty"`
}
func (*SecretManagerSecretVersionStatus) DeepCopy ¶
func (in *SecretManagerSecretVersionStatus) DeepCopy() *SecretManagerSecretVersionStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SecretManagerSecretVersionStatus.
func (*SecretManagerSecretVersionStatus) DeepCopyInto ¶
func (in *SecretManagerSecretVersionStatus) DeepCopyInto(out *SecretManagerSecretVersionStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SecretObservedStateStatus ¶ added in v1.124.0
type SecretObservedStateStatus struct {
}
func (*SecretObservedStateStatus) DeepCopy ¶ added in v1.124.0
func (in *SecretObservedStateStatus) DeepCopy() *SecretObservedStateStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SecretObservedStateStatus.
func (*SecretObservedStateStatus) DeepCopyInto ¶ added in v1.124.0
func (in *SecretObservedStateStatus) DeepCopyInto(out *SecretObservedStateStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SecretReplicas ¶
type SecretReplicas struct {
/* Optional. The customer-managed encryption configuration of the
[User-Managed Replica][Replication.UserManaged.Replica]. If no
configuration is provided, Google-managed default encryption is used.
Updates to the [Secret][google.cloud.secretmanager.v1.Secret]
encryption configuration only apply to
[SecretVersions][google.cloud.secretmanager.v1.SecretVersion] added
afterwards. They do not apply retroactively to existing
[SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. */
// +optional
CustomerManagedEncryption *SecretCustomerManagedEncryption `json:"customerManagedEncryption,omitempty"`
/* The canonical IDs of the location to replicate data. For example: `"us-east1"`. */
Location string `json:"location"`
}
func (*SecretReplicas) DeepCopy ¶
func (in *SecretReplicas) DeepCopy() *SecretReplicas
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SecretReplicas.
func (*SecretReplicas) DeepCopyInto ¶
func (in *SecretReplicas) DeepCopyInto(out *SecretReplicas)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SecretReplication ¶
type SecretReplication struct {
/* The [Secret][google.cloud.secretmanager.v1.Secret] will automatically be replicated without any restrictions. */
// +optional
Auto *SecretAuto `json:"auto,omitempty"`
/* The Secret will automatically be replicated without any restrictions. */
// +optional
Automatic *bool `json:"automatic,omitempty"`
/* The [Secret][google.cloud.secretmanager.v1.Secret] will only be replicated into the locations specified. */
// +optional
UserManaged *SecretUserManaged `json:"userManaged,omitempty"`
}
func (*SecretReplication) DeepCopy ¶
func (in *SecretReplication) DeepCopy() *SecretReplication
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SecretReplication.
func (*SecretReplication) DeepCopyInto ¶
func (in *SecretReplication) DeepCopyInto(out *SecretReplication)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SecretRotation ¶
type SecretRotation struct {
/* Optional. Timestamp in UTC at which the
[Secret][google.cloud.secretmanager.v1.Secret] is scheduled to rotate.
Cannot be set to less than 300s (5 min) in the future and at most
3153600000s (100 years).
[next_rotation_time][google.cloud.secretmanager.v1.Rotation.next_rotation_time]
MUST be set if
[rotation_period][google.cloud.secretmanager.v1.Rotation.rotation_period]
is set. */
// +optional
NextRotationTime *string `json:"nextRotationTime,omitempty"`
/* Input only. The Duration between rotation notifications. Must be in seconds
and at least 3600s (1h) and at most 3153600000s (100 years).
If
[rotation_period][google.cloud.secretmanager.v1.Rotation.rotation_period]
is set,
[next_rotation_time][google.cloud.secretmanager.v1.Rotation.next_rotation_time]
must be set.
[next_rotation_time][google.cloud.secretmanager.v1.Rotation.next_rotation_time]
will be advanced by this period when the service automatically sends
rotation notifications. */
// +optional
RotationPeriod *string `json:"rotationPeriod,omitempty"`
}
func (*SecretRotation) DeepCopy ¶
func (in *SecretRotation) DeepCopy() *SecretRotation
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SecretRotation.
func (*SecretRotation) DeepCopyInto ¶
func (in *SecretRotation) DeepCopyInto(out *SecretRotation)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SecretTopics ¶ added in v1.85.0
type SecretTopics struct {
TopicRef v1alpha1.ResourceRef `json:"topicRef"`
}
func (*SecretTopics) DeepCopy ¶ added in v1.85.0
func (in *SecretTopics) DeepCopy() *SecretTopics
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SecretTopics.
func (*SecretTopics) DeepCopyInto ¶ added in v1.85.0
func (in *SecretTopics) DeepCopyInto(out *SecretTopics)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SecretUserManaged ¶
type SecretUserManaged struct {
/* Required. The list of Replicas for this
[Secret][google.cloud.secretmanager.v1.Secret].
Cannot be empty. */
Replicas []SecretReplicas `json:"replicas"`
}
func (*SecretUserManaged) DeepCopy ¶
func (in *SecretUserManaged) DeepCopy() *SecretUserManaged
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SecretUserManaged.
func (*SecretUserManaged) DeepCopyInto ¶
func (in *SecretUserManaged) DeepCopyInto(out *SecretUserManaged)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SecretversionSecretData ¶
type SecretversionSecretData struct {
/* Value of the field. Cannot be used if 'valueFrom' is specified. */
// +optional
Value *string `json:"value,omitempty"`
/* Source for the field's value. Cannot be used if 'value' is specified. */
// +optional
ValueFrom *SecretversionValueFrom `json:"valueFrom,omitempty"`
}
func (*SecretversionSecretData) DeepCopy ¶
func (in *SecretversionSecretData) DeepCopy() *SecretversionSecretData
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SecretversionSecretData.
func (*SecretversionSecretData) DeepCopyInto ¶
func (in *SecretversionSecretData) DeepCopyInto(out *SecretversionSecretData)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SecretversionValueFrom ¶
type SecretversionValueFrom struct {
/* Reference to a value with the given key in the given Secret in the resource's namespace. */
// +optional
SecretKeyRef *v1alpha1.SecretKeyRef `json:"secretKeyRef,omitempty"`
}
func (*SecretversionValueFrom) DeepCopy ¶
func (in *SecretversionValueFrom) DeepCopy() *SecretversionValueFrom
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SecretversionValueFrom.
func (*SecretversionValueFrom) DeepCopyInto ¶
func (in *SecretversionValueFrom) DeepCopyInto(out *SecretversionValueFrom)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.