amazonka-backup-2.0: Amazon Backup SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Backup.Types.BackupSelection

Description

 
Synopsis

Documentation

data BackupSelection Source #

Used to specify a set of resources to a backup plan.

Specifying your desired Conditions, ListOfTags, NotResources, and/or Resources is recommended. If none of these are specified, Backup will attempt to select all supported and opted-in storage resources, which could have unintended cost implications.

See: newBackupSelection smart constructor.

Constructors

BackupSelection' 

Fields

  • conditions :: Maybe Conditions

    A list of conditions that you define to assign resources to your backup plans using tags. For example, "StringEquals": { "ConditionKey": "aws:ResourceTag/CreatedByCryo", "ConditionValue": "true" },. Condition operators are case sensitive.

    Conditions differs from ListOfTags as follows:

    • When you specify more than one condition, you only assign the resources that match ALL conditions (using AND logic).
    • Conditions supports StringEquals, StringLike, StringNotEquals, and StringNotLike. ListOfTags only supports StringEquals.
  • listOfTags :: Maybe [Condition]

    A list of conditions that you define to assign resources to your backup plans using tags. For example, "StringEquals": { "ConditionKey": "aws:ResourceTag/CreatedByCryo", "ConditionValue": "true" },. Condition operators are case sensitive.

    ListOfTags differs from Conditions as follows:

    • When you specify more than one condition, you assign all resources that match AT LEAST ONE condition (using OR logic).
    • ListOfTags only supports StringEquals. Conditions supports StringEquals, StringLike, StringNotEquals, and StringNotLike.
  • notResources :: Maybe [Text]

    A list of Amazon Resource Names (ARNs) 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 :: Maybe [Text]

    A list of Amazon Resource Names (ARNs) 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.

  • selectionName :: Text

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

  • iamRoleArn :: Text

    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.

Instances

Instances details
FromJSON BackupSelection Source # 
Instance details

Defined in Amazonka.Backup.Types.BackupSelection

ToJSON BackupSelection Source # 
Instance details

Defined in Amazonka.Backup.Types.BackupSelection

Generic BackupSelection Source # 
Instance details

Defined in Amazonka.Backup.Types.BackupSelection

Associated Types

type Rep BackupSelection :: Type -> Type #

Read BackupSelection Source # 
Instance details

Defined in Amazonka.Backup.Types.BackupSelection

Show BackupSelection Source # 
Instance details

Defined in Amazonka.Backup.Types.BackupSelection

NFData BackupSelection Source # 
Instance details

Defined in Amazonka.Backup.Types.BackupSelection

Methods

rnf :: BackupSelection -> () #

Eq BackupSelection Source # 
Instance details

Defined in Amazonka.Backup.Types.BackupSelection

Hashable BackupSelection Source # 
Instance details

Defined in Amazonka.Backup.Types.BackupSelection

type Rep BackupSelection Source # 
Instance details

Defined in Amazonka.Backup.Types.BackupSelection

type Rep BackupSelection = D1 ('MetaData "BackupSelection" "Amazonka.Backup.Types.BackupSelection" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "BackupSelection'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "conditions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Conditions)) :*: (S1 ('MetaSel ('Just "listOfTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Condition])) :*: S1 ('MetaSel ('Just "notResources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :*: (S1 ('MetaSel ('Just "resources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "selectionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "iamRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newBackupSelection Source #

Create a value of BackupSelection with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:conditions:BackupSelection', backupSelection_conditions - A list of conditions that you define to assign resources to your backup plans using tags. For example, "StringEquals": { "ConditionKey": "aws:ResourceTag/CreatedByCryo", "ConditionValue": "true" },. Condition operators are case sensitive.

Conditions differs from ListOfTags as follows:

  • When you specify more than one condition, you only assign the resources that match ALL conditions (using AND logic).
  • Conditions supports StringEquals, StringLike, StringNotEquals, and StringNotLike. ListOfTags only supports StringEquals.

$sel:listOfTags:BackupSelection', backupSelection_listOfTags - A list of conditions that you define to assign resources to your backup plans using tags. For example, "StringEquals": { "ConditionKey": "aws:ResourceTag/CreatedByCryo", "ConditionValue": "true" },. Condition operators are case sensitive.

ListOfTags differs from Conditions as follows:

  • When you specify more than one condition, you assign all resources that match AT LEAST ONE condition (using OR logic).
  • ListOfTags only supports StringEquals. Conditions supports StringEquals, StringLike, StringNotEquals, and StringNotLike.

$sel:notResources:BackupSelection', backupSelection_notResources - A list of Amazon Resource Names (ARNs) 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.

$sel:resources:BackupSelection', backupSelection_resources - A list of Amazon Resource Names (ARNs) 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.

$sel:selectionName:BackupSelection', backupSelection_selectionName - The display name of a resource selection document. Must contain 1 to 50 alphanumeric or '-_.' characters.

$sel:iamRoleArn:BackupSelection', backupSelection_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.

backupSelection_conditions :: Lens' BackupSelection (Maybe Conditions) Source #

A list of conditions that you define to assign resources to your backup plans using tags. For example, "StringEquals": { "ConditionKey": "aws:ResourceTag/CreatedByCryo", "ConditionValue": "true" },. Condition operators are case sensitive.

Conditions differs from ListOfTags as follows:

  • When you specify more than one condition, you only assign the resources that match ALL conditions (using AND logic).
  • Conditions supports StringEquals, StringLike, StringNotEquals, and StringNotLike. ListOfTags only supports StringEquals.

backupSelection_listOfTags :: Lens' BackupSelection (Maybe [Condition]) Source #

A list of conditions that you define to assign resources to your backup plans using tags. For example, "StringEquals": { "ConditionKey": "aws:ResourceTag/CreatedByCryo", "ConditionValue": "true" },. Condition operators are case sensitive.

ListOfTags differs from Conditions as follows:

  • When you specify more than one condition, you assign all resources that match AT LEAST ONE condition (using OR logic).
  • ListOfTags only supports StringEquals. Conditions supports StringEquals, StringLike, StringNotEquals, and StringNotLike.

backupSelection_notResources :: Lens' BackupSelection (Maybe [Text]) Source #

A list of Amazon Resource Names (ARNs) 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.

backupSelection_resources :: Lens' BackupSelection (Maybe [Text]) Source #

A list of Amazon Resource Names (ARNs) 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.

backupSelection_selectionName :: Lens' BackupSelection Text Source #

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

backupSelection_iamRoleArn :: Lens' BackupSelection Text Source #

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.