BackupVault

backup.services.k8s.aws/v1alpha1

TypeLink
GoDocbackup-controller/apis/v1alpha1#BackupVault

Metadata

PropertyValue
ScopeNamespaced
KindBackupVault
ListKindBackupVaultList
Pluralbackupvaults
Singularbackupvault

Spec

encryptionKeyARN: string
encryptionKeyRef: 
  from: 
    name: string
    namespace: string
name: string
tags: {}
FieldDescription
encryptionKeyARN
Optional		string
The server-side encryption key that is used to protect your backups; for
example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
encryptionKeyRef
Optional		object
AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference
type to provide more user friendly syntax for references using ‘from’ field
Ex:
APIIDRef:

from:
name: my-api
encryptionKeyRef.from
Optional		object
AWSResourceReference provides all the values necessary to reference another
k8s resource for finding the identifier(Id/ARN/Name)
encryptionKeyRef.from.name
Optional		string
encryptionKeyRef.from.namespace
Optional		string
name
Required		string
The name of a logical container where backups are stored. Backup vaults are
identified by names that are unique to the account used to create them and
the Amazon Web Services Region where they are created. They consist of letters,
numbers, and hyphens.

Regex Pattern: ^[a-zA-Z0-9\-\_]{2,50}$
tags
Optional		object
The tags to assign to the backup vault.

Status

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  partition: string
  region: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
creationDate: string
encryptionKeyType: string
lockDate: string
locked: boolean
maxRetentionDays: integer
minRetentionDays: integer
numberOfRecoveryPoints: integer
vaultType: string
FieldDescription
ackResourceMetadata
Optional		object
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
ackResourceMetadata.arn
Optional		string
ARN is the Amazon Resource Name for the resource. This is a
globally-unique identifier and is set only by the ACK service controller
once the controller has orchestrated the creation of the resource OR
when it has verified that an “adopted” resource (a resource where the
ARN annotation was set by the Kubernetes user on the CR) exists and
matches the supplied CR’s Spec field values.
https://github.com/aws/aws-controllers-k8s/issues/270
ackResourceMetadata.ownerAccountID
Required		string
OwnerAccountID is the AWS Account ID of the account that owns the
backend AWS service API resource.
ackResourceMetadata.partition
Optional		string
Partition is the AWS partition in which the resource exists or will exist
ackResourceMetadata.region
Required		string
Region is the AWS region in which the resource exists or will exist.
conditions
Optional		array
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
conditions.[]
Required		object
Condition is the common struct used by all CRDs managed by ACK service
controllers to indicate terminal states of the CR and its backend AWS
service API resource
conditions.[].message
Optional		string
A human readable message indicating details about the transition.
conditions.[].reason
Optional		string
The reason for the condition’s last transition.
conditions.[].status
Optional		string
Status of the condition, one of True, False, Unknown.
conditions.[].type
Optional		string
Type is the type of the Condition
creationDate
Optional		string
The date and time a backup vault is created, in Unix format and Coordinated
Universal Time (UTC). The value of CreationDate is accurate to milliseconds.
For example, the value 1516925490.087 represents Friday, January 26, 2018
12:11:30.087 AM.
encryptionKeyType
Optional		string
The type of encryption key used for the backup vault. Valid values are CUSTOMER_MANAGED_KMS_KEY
for customer-managed keys or Amazon Web Services_OWNED_KMS_KEY for Amazon
Web Services-owned keys.
lockDate
Optional		string
The date and time when Backup Vault Lock configuration cannot be changed
or deleted.

If you applied Vault Lock to your vault without specifying a lock date, you
can change any of your Vault Lock settings, or delete Vault Lock from the
vault entirely, at any time.

This value is in Unix format, Coordinated Universal Time (UTC), and accurate
to milliseconds. For example, the value 1516925490.087 represents Friday,
January 26, 2018 12:11:30.087 AM.
locked
Optional		boolean
A Boolean that indicates whether Backup Vault Lock is currently protecting
the backup vault. True means that Vault Lock causes delete or update operations
on the recovery points stored in the vault to fail.
maxRetentionDays
Optional		integer
The Backup Vault Lock setting that specifies the maximum retention period
that the vault retains its recovery points. If this parameter is not specified,
Vault Lock does not enforce a maximum retention period on the recovery points
in the vault (allowing indefinite storage).

If specified, any backup or copy job to the vault must have a lifecycle policy
with a retention period equal to or shorter than the maximum retention period.
If the job’s retention period is longer than that maximum retention period,
then the vault fails the backup or copy job, and you should either modify
your lifecycle settings or use a different vault. Recovery points already
stored in the vault prior to Vault Lock are not affected.
minRetentionDays
Optional		integer
The Backup Vault Lock setting that specifies the minimum retention period
that the vault retains its recovery points. If this parameter is not specified,
Vault Lock will not enforce a minimum retention period.

If specified, any backup or copy job to the vault must have a lifecycle policy
with a retention period equal to or longer than the minimum retention period.
If the job’s retention period is shorter than that minimum retention period,
then the vault fails the backup or copy job, and you should either modify
your lifecycle settings or use a different vault. Recovery points already
stored in the vault prior to Vault Lock are not affected.
numberOfRecoveryPoints
Optional		integer
The number of recovery points that are stored in a backup vault.

Recovery point count value displayed in the console can be an approximation.
Use ListRecoveryPointsByBackupVault (https://docs.aws.amazon.com/aws-backup/latest/devguide/API_ListRecoveryPointsByBackupVault.html)
API to obtain the exact count.
vaultType
Optional		string
The type of vault described.