BackupPlan
backup.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | backup-controller/apis/v1alpha1#BackupPlan |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | BackupPlan |
| ListKind | BackupPlanList |
| Plural | backupplans |
| Singular | backupplan |
Spec
advancedBackupSettings:
backupOptions: {}
resourceType: string
name: string
rules:
- completionWindowMinutes: integer
copyActions:
- destinationBackupVaultARN: string
destinationBackupVaultRef:
from:
name: string
namespace: string
lifecycle:
deleteAfterDays: integer
deleteAfterEvent: string
moveToColdStorageAfterDays: integer
optInToArchiveForSupportedResources: boolean
enableContinuousBackup: boolean
indexActions:
resourceTypes:
- string
lifecycle:
deleteAfterDays: integer
deleteAfterEvent: string
moveToColdStorageAfterDays: integer
optInToArchiveForSupportedResources: boolean
recoveryPointTags: {}
ruleName: string
scanActions:
- malwareScanner: string
scanMode: string
scheduleExpression: string
scheduleExpressionTimezone: string
startWindowMinutes: integer
targetBackupVaultName: string
targetBackupVaultRef:
from:
name: string
namespace: string
targetLogicallyAirGappedBackupVaultARN: string
scanSettings:
- malwareScanner: string
resourceTypes:
- string
scannerRoleARN: string
tags: {}
| Field | Description |
|---|---|
| advancedBackupSettings Optional | array Specifies a list of BackupOptions for each resource type. These settings are only available for Windows Volume Shadow Copy Service (VSS) backup jobs. |
| advancedBackupSettings.[] Required | object The backup options for each resource type. |
| advancedBackupSettings.[].resourceType Optional | string |
| name Optional | string The display name of a backup plan. Must contain 1 to 50 alphanumeric or ‘-_.' characters. |
| rules Optional | array An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources. |
| rules.[] Required | object Specifies a scheduled task used to back up a selection of resources. |
| rules.[].copyActions Optional | array |
| rules.[].copyActions.[] Required | object The details of the copy operation. |
| rules.[].copyActions.[].destinationBackupVaultRef Optional | object Reference field for DestinationBackupVaultARN |
| rules.[].copyActions.[].destinationBackupVaultRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| rules.[].copyActions.[].destinationBackupVaultRef.from.name Optional | string |
| rules.[].copyActions.[].destinationBackupVaultRef.from.namespace Optional | string |
| rules.[].copyActions.[].lifecycle Optional | object Specifies the time period, in days, before a recovery point transitions to cold storage or is deleted. Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, on the console, the retention setting must be 90 days greater than the transition to cold after days setting. The transition to cold after days setting can’t be changed after a backup has been transitioned to cold. Resource types that can transition to cold storage are listed in the Feature availability by resource (https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource) table. Backup ignores this expression for other resource types. To remove the existing lifecycle and retention periods and keep your recovery points indefinitely, specify -1 for MoveToColdStorageAfterDays and DeleteAfterDays. |
| rules.[].copyActions.[].lifecycle.deleteAfterDays Optional | integer |
| rules.[].copyActions.[].lifecycle.deleteAfterEvent Optional | string |
| rules.[].copyActions.[].lifecycle.moveToColdStorageAfterDays Optional | integer |
| rules.[].copyActions.[].lifecycle.optInToArchiveForSupportedResources Optional | boolean |
| rules.[].enableContinuousBackup Optional | boolean |
| rules.[].indexActions Optional | array |
| rules.[].indexActions.[] Required | object This is an optional array within a BackupRule. |
IndexAction consists of one ResourceTypes. || rules.[].indexActions.[].resourceTypes
Optional | array
|
| rules.[].indexActions.[].resourceTypes.[]
Required | string
|| rules.[].lifecycle
Optional | object
Specifies the time period, in days, before a recovery point transitions to
cold storage or is deleted.
Backups transitioned to cold storage must be stored in cold storage for a
minimum of 90 days. Therefore, on the console, the retention setting must
be 90 days greater than the transition to cold after days setting. The transition
to cold after days setting can’t be changed after a backup has been transitioned
to cold.
Resource types that can transition to cold storage are listed in the Feature
availability by resource (https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource)
table. Backup ignores this expression for other resource types.
To remove the existing lifecycle and retention periods and keep your recovery
points indefinitely, specify -1 for MoveToColdStorageAfterDays and DeleteAfterDays. |
| rules.[].lifecycle.deleteAfterDays
Optional | integer
|
| rules.[].lifecycle.deleteAfterEvent
Optional | string
|
| rules.[].lifecycle.moveToColdStorageAfterDays
Optional | integer
|
| rules.[].lifecycle.optInToArchiveForSupportedResources
Optional | boolean
|
| rules.[].recoveryPointTags
Optional | object
|
| rules.[].ruleName
Optional | string
|
| rules.[].scanActions
Optional | array
|
| rules.[].scanActions.[]
Required | object
Defines a scanning action that specifies the malware scanner and scan mode
to use. || rules.[].scanActions.[].malwareScanner
Optional | string
|
| rules.[].scanActions.[].scanMode
Optional | string
|
| rules.[].scheduleExpression
Optional | string
|
| rules.[].scheduleExpressionTimezone
Optional | string
|
| rules.[].startWindowMinutes
Optional | integer
|
| rules.[].targetBackupVaultName
Optional | string
|
| rules.[].targetBackupVaultRef
Optional | object
Reference field for TargetBackupVaultName |
| rules.[].targetBackupVaultRef.from
Optional | object
AWSResourceReference provides all the values necessary to reference another
k8s resource for finding the identifier(Id/ARN/Name) |
| rules.[].targetBackupVaultRef.from.name
Optional | string
|
| rules.[].targetBackupVaultRef.from.namespace
Optional | string
|
| rules.[].targetLogicallyAirGappedBackupVaultARN
Optional | string
|
| scanSettings
Optional | array
Contains your scanning configuration for the backup rule and includes the
malware scanner, and scan mode of either full or incremental. |
| scanSettings.[]
Required | object
Contains configuration settings for malware scanning, including the scanner
type, target resource types, and scanner role. || scanSettings.[].malwareScanner
Optional | string
|
| scanSettings.[].resourceTypes
Optional | array
|
| scanSettings.[].resourceTypes.[]
Required | string
|| scanSettings.[].scannerRoleARN
Optional | string
|
| tags
Optional | object
|
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
partition: string
region: string
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
creationDate: string
id: string
lastExecutionDate: string
versionID: string
| Field | Description |
|---|---|
| ackResourceMetadata Optional | object All CRs managed by ACK have a common Status.ACKResourceMetadata memberthat 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 thatcontains a collection of ackv1alpha1.Condition objects that describethe 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 that a backup plan 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. |
| id Optional | string The ID of the backup plan. |
| lastExecutionDate Optional | string The last time this backup plan was run. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of LastExecutionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. |
| versionID Optional | string Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited. |