BackupSelection

backup.services.k8s.aws/v1alpha1

TypeLink
GoDocbackup-controller/apis/v1alpha1#BackupSelection

Metadata

PropertyValue
ScopeNamespaced
KindBackupSelection
ListKindBackupSelectionList
Pluralbackupselections
Singularbackupselection

Spec

backupPlanID: string
backupPlanRef: 
  from: 
    name: string
    namespace: string
conditions: 
  stringEquals:
  - conditionKey: string
    conditionValue: string
  stringLike:
  - conditionKey: string
    conditionValue: string
  stringNotEquals:
  - conditionKey: string
    conditionValue: string
  stringNotLike:
  - conditionKey: string
    conditionValue: string
iamRoleARN: string
iamRoleRef: 
  from: 
    name: string
    namespace: string
listOfTags:
- conditionKey: string
  conditionType: string
  conditionValue: string
name: string
notResources:
- string
resources:
- string
FieldDescription
backupPlanID
Optional
string
backupPlanRef
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
backupPlanRef.from
Optional
object
AWSResourceReference provides all the values necessary to reference another
k8s resource for finding the identifier(Id/ARN/Name)
backupPlanRef.from.name
Optional
string
backupPlanRef.from.namespace
Optional
string
conditions
Optional
object
The conditions that you define to assign resources to your backup plans using
tags. For example, “StringEquals”: { “ConditionKey”: “aws:ResourceTag/backup”,
“ConditionValue”: “daily” }.

Conditions supports StringEquals, StringLike, StringNotEquals, and StringNotLike.
Condition operators are case sensitive.

If you specify multiple conditions, the resources much match all conditions
(AND logic).
conditions.stringEquals
Optional
array
conditions.stringEquals.[]
Required
object
Includes information about tags you define to assign tagged resources to
a backup plan.

Include the prefix aws:ResourceTag in your tags. For example, “aws:ResourceTag/TagKey1”: “Value1”. || conditions.stringEquals.[].conditionKey
Optional | string
| | conditions.stringEquals.[].conditionValue
Optional | string
| | conditions.stringLike
Optional | array
| | conditions.stringLike.[]
Required | object
Includes information about tags you define to assign tagged resources to a backup plan.

Include the prefix aws:ResourceTag in your tags. For example, “aws:ResourceTag/TagKey1”: “Value1”. || conditions.stringLike.[].conditionKey
Optional | string
| | conditions.stringLike.[].conditionValue
Optional | string
| | conditions.stringNotEquals
Optional | array
| | conditions.stringNotEquals.[]
Required | object
Includes information about tags you define to assign tagged resources to a backup plan.

Include the prefix aws:ResourceTag in your tags. For example, “aws:ResourceTag/TagKey1”: “Value1”. || conditions.stringNotEquals.[].conditionKey
Optional | string
| | conditions.stringNotEquals.[].conditionValue
Optional | string
| | conditions.stringNotLike
Optional | array
| | conditions.stringNotLike.[]
Required | object
Includes information about tags you define to assign tagged resources to a backup plan.

Include the prefix aws:ResourceTag in your tags. For example, “aws:ResourceTag/TagKey1”: “Value1”. || conditions.stringNotLike.[].conditionKey
Optional | string
| | conditions.stringNotLike.[].conditionValue
Optional | string
| | iamRoleARN
Optional | string
The ARN of the IAM role that Backup uses to authenticate when backing up
the target resource; for example, arn:aws:iam::123456789012:role/S3Access. | | iamRoleRef
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 | | iamRoleRef.from
Optional | object
AWSResourceReference provides all the values necessary to reference another
k8s resource for finding the identifier(Id/ARN/Name) | | iamRoleRef.from.name
Optional | string
| | iamRoleRef.from.namespace
Optional | string
| | listOfTags
Optional | array
The conditions that you define to assign resources to your backup plans using
tags. For example, “StringEquals”: { “ConditionKey”: “backup”, “ConditionValue”:
“daily”}.

ListOfTags supports only StringEquals. Condition operators are case sensitive.

If you specify multiple conditions, the resources much match any of the conditions
(OR logic). | | listOfTags.[]
Required | object
Contains an array of triplets made up of a condition type (such as StringEquals), a key, and a value. Used to filter resources using their tags and assign them to a backup plan. Case sensitive. || listOfTags.[].conditionKey
Optional | string
| | listOfTags.[].conditionType
Optional | string
| | listOfTags.[].conditionValue
Optional | string
| | name
Optional | string
The display name of a resource selection document. Must contain 1 to 50 alphanumeric
or ‘-_.’ characters.

Regex Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$ | | notResources
Optional | array
The Amazon Resource Names (ARNs) of the resources to exclude from a backup
plan. The maximum number of ARNs is 500 without wildcards, or 30 ARNs with
wildcards.

If you need to exclude many resources from a backup plan, consider a different
resource selection strategy, such as assigning only one or a few resource
types or refining your resource selection using tags. | | notResources.[]
Required | string
|| resources
Optional | array
The Amazon Resource Names (ARNs) of the resources to assign to a backup plan.
The maximum number of ARNs is 500 without wildcards, or 30 ARNs with wildcards.

If you need to assign many resources to a backup plan, consider a different
resource selection strategy, such as assigning all resources of a resource
type or refining your resource selection using tags.

If you specify multiple ARNs, the resources much match any of the ARNs (OR
logic).

When using wildcards in ARN patterns for backup selections, the asterisk
(
) must appear at the end of the ARN string (prefix pattern). For example,
arn:aws:s3:::my-bucket-* is valid, but arn:aws:s3:::*-logs is not supported. | | **resources.[]**
Required | **string**
|

Status

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  partition: string
  region: string
backupPlanID: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
creationDate: string
id: 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.
backupPlanID
Optional
string
The ID of the backup plan.
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 selection 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
Uniquely identifies the body of a request to assign a set of resources to
a backup plan.