Class: Aws::Backup::Types::BackupSelection

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb

Overview

Note:

When making an API call, you may pass BackupSelection data as a hash:

{
  selection_name: "BackupSelectionName", # required
  iam_role_arn: "IAMRoleArn", # required
  resources: ["ARN"],
  list_of_tags: [
    {
      condition_type: "STRINGEQUALS", # required, accepts STRINGEQUALS
      condition_key: "ConditionKey", # required
      condition_value: "ConditionValue", # required
    },
  ],
  not_resources: ["ARN"],
  conditions: {
    string_equals: [
      {
        condition_key: "ConditionKey",
        condition_value: "ConditionValue",
      },
    ],
    string_not_equals: [
      {
        condition_key: "ConditionKey",
        condition_value: "ConditionValue",
      },
    ],
    string_like: [
      {
        condition_key: "ConditionKey",
        condition_value: "ConditionValue",
      },
    ],
    string_not_like: [
      {
        condition_key: "ConditionKey",
        condition_value: "ConditionValue",
      },
    ],
  },
}

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#conditionsTypes::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.

Returns:



777
778
779
780
781
782
783
784
785
786
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 777

class BackupSelection < Struct.new(
  :selection_name,
  :iam_role_arn,
  :resources,
  :list_of_tags,
  :not_resources,
  :conditions)
  SENSITIVE = []
  include Aws::Structure
end

#iam_role_arnString

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.

Returns:

  • (String)


777
778
779
780
781
782
783
784
785
786
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 777

class BackupSelection < Struct.new(
  :selection_name,
  :iam_role_arn,
  :resources,
  :list_of_tags,
  :not_resources,
  :conditions)
  SENSITIVE = []
  include Aws::Structure
end

#list_of_tagsArray<Types::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.

Returns:



777
778
779
780
781
782
783
784
785
786
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 777

class BackupSelection < Struct.new(
  :selection_name,
  :iam_role_arn,
  :resources,
  :list_of_tags,
  :not_resources,
  :conditions)
  SENSITIVE = []
  include Aws::Structure
end

#not_resourcesArray<String>

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.

Returns:

  • (Array<String>)


777
778
779
780
781
782
783
784
785
786
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 777

class BackupSelection < Struct.new(
  :selection_name,
  :iam_role_arn,
  :resources,
  :list_of_tags,
  :not_resources,
  :conditions)
  SENSITIVE = []
  include Aws::Structure
end

#resourcesArray<String>

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.

Returns:

  • (Array<String>)


777
778
779
780
781
782
783
784
785
786
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 777

class BackupSelection < Struct.new(
  :selection_name,
  :iam_role_arn,
  :resources,
  :list_of_tags,
  :not_resources,
  :conditions)
  SENSITIVE = []
  include Aws::Structure
end

#selection_nameString

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

Returns:

  • (String)


777
778
779
780
781
782
783
784
785
786
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 777

class BackupSelection < Struct.new(
  :selection_name,
  :iam_role_arn,
  :resources,
  :list_of_tags,
  :not_resources,
  :conditions)
  SENSITIVE = []
  include Aws::Structure
end