Skip to content

BackupSelection

Source code in docs_src/capo_backup/types/backup_selection.py
class BackupSelection(TypedDict, closed=True):
    selection_name: "capo_backup.types.backup_selection_name.BackupSelectionName"
    """<p>The display name of a resource selection document. Must contain 1 to 50 alphanumeric or '-_.' characters.</p>"""
    iam_role_arn: "capo_backup.types.iam_role_arn.IAMRoleArn"
    """<p>The ARN of the IAM role that Backup uses to authenticate when backing up the target resource; for example, <code>arn:aws:iam::123456789012:role/S3Access</code>.</p>"""
    resources: NotRequired["capo_backup.types.resource_arns.ResourceArns"]
    """<p>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.</p> <p>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.</p> <p>If you specify multiple ARNs, the resources much match any of the ARNs (OR logic).</p> <note> <p>When using wildcards in ARN patterns for backup selections, the asterisk (*) must appear at the end of the ARN string (prefix pattern). For example, <code>arn:aws:s3:::my-bucket-*</code> is valid, but <code>arn:aws:s3:::*-logs</code> is not supported.</p> </note>"""
    list_of_tags: NotRequired["capo_backup.types.list_of_tags.ListOfTags"]
    """<p>The conditions that you define to assign resources to your backup plans using tags. For example, <code>"StringEquals": { "ConditionKey": "backup", "ConditionValue": "daily"}</code>.</p> <p> <code>ListOfTags</code> supports only <code>StringEquals</code>. Condition operators are case sensitive.</p> <p>If you specify multiple conditions, the resources much match any of the conditions (OR logic).</p>"""
    not_resources: NotRequired["capo_backup.types.resource_arns.ResourceArns"]
    """<p>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.</p> <p>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.</p>"""
    conditions: NotRequired["capo_backup.types.conditions.Conditions"]
    """<p>The conditions that you define to assign resources to your backup plans using tags. For example, <code>"StringEquals": { "ConditionKey": "aws:ResourceTag/backup", "ConditionValue": "daily" }</code>.</p> <p> <code>Conditions</code> supports <code>StringEquals</code>, <code>StringLike</code>, <code>StringNotEquals</code>, and <code>StringNotLike</code>. Condition operators are case sensitive.</p> <p>If you specify multiple conditions, the resources much match all conditions (AND logic).</p>"""

conditions instance-attribute

conditions: NotRequired[Conditions]

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).

iam_role_arn instance-attribute

iam_role_arn: 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.

list_of_tags instance-attribute

list_of_tags: NotRequired[ListOfTags]

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).

not_resources instance-attribute

not_resources: NotRequired[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.

resources instance-attribute

resources: NotRequired[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, but arn:aws:s3:::*-logs is not supported.

selection_name instance-attribute

selection_name: BackupSelectionName

The display name of a resource selection document. Must contain 1 to 50 alphanumeric or '-_.' characters.