/AWS1/CL_BUPBACKUPSELECTION¶
Used to specify a set of resources to a backup plan.
We recommend that you specify conditions, tags, or resources to include or exclude. Otherwise, Backup attempts to select all supported and opted-in storage resources, which could have unintended cost implications.
For more information, see Assigning resources programmatically.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_selectionname TYPE /AWS1/BUPBACKUPSELECTIONNAME /AWS1/BUPBACKUPSELECTIONNAME¶
The display name of a resource selection document. Must contain 1 to 50 alphanumeric or '-_.' characters.
iv_iamrolearn TYPE /AWS1/BUPIAMROLEARN /AWS1/BUPIAMROLEARN¶
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.
Optional arguments:¶
it_resources TYPE /AWS1/CL_BUPRESOURCEARNS_W=>TT_RESOURCEARNS TT_RESOURCEARNS¶
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, butarn:aws:s3:::*-logsis not supported.
it_listoftags TYPE /AWS1/CL_BUPCONDITION=>TT_LISTOFTAGS TT_LISTOFTAGS¶
The conditions that you define to assign resources to your backup plans using tags. For example,
"StringEquals": { "ConditionKey": "backup", "ConditionValue": "daily"}.
ListOfTagssupports onlyStringEquals. Condition operators are case sensitive.If you specify multiple conditions, the resources much match any of the conditions (OR logic).
it_notresources TYPE /AWS1/CL_BUPRESOURCEARNS_W=>TT_RESOURCEARNS TT_RESOURCEARNS¶
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.
io_conditions TYPE REF TO /AWS1/CL_BUPCONDITIONS /AWS1/CL_BUPCONDITIONS¶
The conditions that you define to assign resources to your backup plans using tags. For example,
"StringEquals": { "ConditionKey": "aws:ResourceTag/backup", "ConditionValue": "daily" }.
ConditionssupportsStringEquals,StringLike,StringNotEquals, andStringNotLike. Condition operators are case sensitive.If you specify multiple conditions, the resources much match all conditions (AND logic).
Queryable Attributes¶
SelectionName¶
The display name of a resource selection document. Must contain 1 to 50 alphanumeric or '-_.' characters.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SELECTIONNAME() |
Getter for SELECTIONNAME, with configurable default |
ASK_SELECTIONNAME() |
Getter for SELECTIONNAME w/ exceptions if field has no value |
HAS_SELECTIONNAME() |
Determine if SELECTIONNAME has a value |
IamRoleArn¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_IAMROLEARN() |
Getter for IAMROLEARN, with configurable default |
ASK_IAMROLEARN() |
Getter for IAMROLEARN w/ exceptions if field has no value |
HAS_IAMROLEARN() |
Determine if IAMROLEARN has a value |
Resources¶
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, butarn:aws:s3:::*-logsis not supported.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RESOURCES() |
Getter for RESOURCES, with configurable default |
ASK_RESOURCES() |
Getter for RESOURCES w/ exceptions if field has no value |
HAS_RESOURCES() |
Determine if RESOURCES has a value |
ListOfTags¶
The conditions that you define to assign resources to your backup plans using tags. For example,
"StringEquals": { "ConditionKey": "backup", "ConditionValue": "daily"}.
ListOfTagssupports onlyStringEquals. Condition operators are case sensitive.If you specify multiple conditions, the resources much match any of the conditions (OR logic).
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LISTOFTAGS() |
Getter for LISTOFTAGS, with configurable default |
ASK_LISTOFTAGS() |
Getter for LISTOFTAGS w/ exceptions if field has no value |
HAS_LISTOFTAGS() |
Determine if LISTOFTAGS has a value |
NotResources¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NOTRESOURCES() |
Getter for NOTRESOURCES, with configurable default |
ASK_NOTRESOURCES() |
Getter for NOTRESOURCES w/ exceptions if field has no value |
HAS_NOTRESOURCES() |
Determine if NOTRESOURCES has a value |
Conditions¶
The conditions that you define to assign resources to your backup plans using tags. For example,
"StringEquals": { "ConditionKey": "aws:ResourceTag/backup", "ConditionValue": "daily" }.
ConditionssupportsStringEquals,StringLike,StringNotEquals, andStringNotLike. Condition operators are case sensitive.If you specify multiple conditions, the resources much match all conditions (AND logic).
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CONDITIONS() |
Getter for CONDITIONS |