BackupSelection (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.backup.model.BackupSelection

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class BackupSelection
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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 Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

BackupSelection()

Constructors
Constructor and Description
`BackupSelection()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BackupSelection`	`clone()`
`boolean`	`equals(Object obj)`
`Conditions`	`getConditions()` A list of conditions that you define to assign resources to your backup plans using tags.
`String`	`getIamRoleArn()` 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<Condition>`	`getListOfTags()` A list of conditions that you define to assign resources to your backup plans using tags.
`List<String>`	`getNotResources()` A list of Amazon Resource Names (ARNs) to exclude from a backup plan.
`List<String>`	`getResources()` A list of Amazon Resource Names (ARNs) to assign to a backup plan.
`String`	`getSelectionName()` The display name of a resource selection document.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setConditions(Conditions conditions)` A list of conditions that you define to assign resources to your backup plans using tags.
`void`	`setIamRoleArn(String 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`.
`void`	`setListOfTags(Collection<Condition> listOfTags)` A list of conditions that you define to assign resources to your backup plans using tags.
`void`	`setNotResources(Collection<String> notResources)` A list of Amazon Resource Names (ARNs) to exclude from a backup plan.
`void`	`setResources(Collection<String> resources)` A list of Amazon Resource Names (ARNs) to assign to a backup plan.
`void`	`setSelectionName(String selectionName)` The display name of a resource selection document.
`String`	`toString()` Returns a string representation of this object.
`BackupSelection`	`withConditions(Conditions conditions)` A list of conditions that you define to assign resources to your backup plans using tags.
`BackupSelection`	`withIamRoleArn(String 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`	`withListOfTags(Collection<Condition> listOfTags)` A list of conditions that you define to assign resources to your backup plans using tags.
`BackupSelection`	`withListOfTags(Condition... listOfTags)` A list of conditions that you define to assign resources to your backup plans using tags.
`BackupSelection`	`withNotResources(Collection<String> notResources)` A list of Amazon Resource Names (ARNs) to exclude from a backup plan.
`BackupSelection`	`withNotResources(String... notResources)` A list of Amazon Resource Names (ARNs) to exclude from a backup plan.
`BackupSelection`	`withResources(Collection<String> resources)` A list of Amazon Resource Names (ARNs) to assign to a backup plan.
`BackupSelection`	`withResources(String... resources)` A list of Amazon Resource Names (ARNs) to assign to a backup plan.
`BackupSelection`	`withSelectionName(String selectionName)` The display name of a resource selection document.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - BackupSelection
```
public BackupSelection()
```
- Method Detail
  - setSelectionName
```
public void setSelectionName(String selectionName)
```
    The display name of a resource selection document. Must contain 1 to 50 alphanumeric or '-_.' characters.
    
    Parameters:
    
    selectionName - The display name of a resource selection document. Must contain 1 to 50 alphanumeric or '-_.' characters.
  - getSelectionName
```
public String getSelectionName()
```
    The display name of a resource selection document. Must contain 1 to 50 alphanumeric or '-_.' characters.
    
    Returns:
    
    The display name of a resource selection document. Must contain 1 to 50 alphanumeric or '-_.' characters.
  - withSelectionName
```
public BackupSelection withSelectionName(String selectionName)
```
    The display name of a resource selection document. Must contain 1 to 50 alphanumeric or '-_.' characters.
    
    Parameters:
    
    selectionName - The display name of a resource selection document. Must contain 1 to 50 alphanumeric or '-_.' characters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIamRoleArn
```
public void setIamRoleArn(String 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.
    
    Parameters:
    
    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.
  - getIamRoleArn
```
public String getIamRoleArn()
```
    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:
    
    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.
  - withIamRoleArn
```
public BackupSelection withIamRoleArn(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getResources
```
public List<String> getResources()
```
    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:
    
    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.
  - setResources
```
public void setResources(Collection<String> 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.
    
    Parameters:
    
    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.
  - withResources
```
public BackupSelection withResources(String... 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.
    
    NOTE: This method appends the values to the existing list (if any). Use setResources(java.util.Collection) or withResources(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withResources
```
public BackupSelection withResources(Collection<String> 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getListOfTags
```
public List<Condition> getListOfTags()
```
    A list of conditions that you define to assign resources to your backup plans using tags. For example, "StringEquals": { "Key": "aws:ResourceTag/CreatedByCryo", "Value": "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:
    A list of conditions that you define to assign resources to your backup plans using tags. For example, "StringEquals": { "Key": "aws:ResourceTag/CreatedByCryo", "Value": "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.
  - setListOfTags
```
public void setListOfTags(Collection<Condition> listOfTags)
```
    A list of conditions that you define to assign resources to your backup plans using tags. For example, "StringEquals": { "Key": "aws:ResourceTag/CreatedByCryo", "Value": "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.
    Parameters:
    listOfTags - A list of conditions that you define to assign resources to your backup plans using tags. For example, "StringEquals": { "Key": "aws:ResourceTag/CreatedByCryo", "Value": "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.
  - withListOfTags
```
public BackupSelection withListOfTags(Condition... listOfTags)
```
    A list of conditions that you define to assign resources to your backup plans using tags. For example, "StringEquals": { "Key": "aws:ResourceTag/CreatedByCryo", "Value": "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.
    NOTE: This method appends the values to the existing list (if any). Use setListOfTags(java.util.Collection) or withListOfTags(java.util.Collection) if you want to override the existing values.
    Parameters:
    listOfTags - A list of conditions that you define to assign resources to your backup plans using tags. For example, "StringEquals": { "Key": "aws:ResourceTag/CreatedByCryo", "Value": "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:
    
    Returns a reference to this object so that method calls can be chained together.
  - withListOfTags
```
public BackupSelection withListOfTags(Collection<Condition> listOfTags)
```
    A list of conditions that you define to assign resources to your backup plans using tags. For example, "StringEquals": { "Key": "aws:ResourceTag/CreatedByCryo", "Value": "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.
    Parameters:
    listOfTags - A list of conditions that you define to assign resources to your backup plans using tags. For example, "StringEquals": { "Key": "aws:ResourceTag/CreatedByCryo", "Value": "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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getNotResources
```
public List<String> getNotResources()
```
    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:
    
    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.
  - setNotResources
```
public void setNotResources(Collection<String> 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.
    
    Parameters:
    
    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.
  - withNotResources
```
public BackupSelection withNotResources(String... 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.
    
    NOTE: This method appends the values to the existing list (if any). Use setNotResources(java.util.Collection) or withNotResources(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withNotResources
```
public BackupSelection withNotResources(Collection<String> 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setConditions
```
public void setConditions(Conditions conditions)
```
    A list of conditions that you define to assign resources to your backup plans using tags. For example, "StringEquals": { "Key": "aws:ResourceTag/CreatedByCryo", "Value": "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.
    Parameters:
    conditions - A list of conditions that you define to assign resources to your backup plans using tags. For example, "StringEquals": { "Key": "aws:ResourceTag/CreatedByCryo", "Value": "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.
  - getConditions
```
public Conditions getConditions()
```
    A list of conditions that you define to assign resources to your backup plans using tags. For example, "StringEquals": { "Key": "aws:ResourceTag/CreatedByCryo", "Value": "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:
    A list of conditions that you define to assign resources to your backup plans using tags. For example, "StringEquals": { "Key": "aws:ResourceTag/CreatedByCryo", "Value": "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.
  - withConditions
```
public BackupSelection withConditions(Conditions conditions)
```
    A list of conditions that you define to assign resources to your backup plans using tags. For example, "StringEquals": { "Key": "aws:ResourceTag/CreatedByCryo", "Value": "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.
    Parameters:
    conditions - A list of conditions that you define to assign resources to your backup plans using tags. For example, "StringEquals": { "Key": "aws:ResourceTag/CreatedByCryo", "Value": "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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public BackupSelection clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.780

Class BackupSelection

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BackupSelection

Method Detail

setSelectionName

getSelectionName

withSelectionName

setIamRoleArn

getIamRoleArn

withIamRoleArn

getResources

setResources

withResources

withResources

getListOfTags

setListOfTags

withListOfTags

withListOfTags

getNotResources

setNotResources

withNotResources

withNotResources

setConditions

getConditions

withConditions

toString

equals

hashCode

clone

marshall