software.amazon.awssdk.services.backup.model

Class BackupSelection

java.lang.Object

software.amazon.awssdk.services.backup.model.BackupSelection

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<BackupSelection.Builder,BackupSelection>

@Generated(value="software.amazon.awssdk:codegen")
public final class BackupSelection
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<BackupSelection.Builder,BackupSelection>

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BackupSelection.Builder

Method Summary

Modifier and Type	Method and Description
static BackupSelection.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasListOfTags() Returns true if the ListOfTags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasResources() Returns true if the Resources property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	iamRoleArn() The ARN of the IAM role that AWS Backup uses to authenticate when backing up the target resource; for example, arn:aws:iam::123456789012:role/S3Access.
List<Condition>	listOfTags() An array of conditions used to specify a set of resources to assign to a backup plan; for example, "StringEquals": {"ec2:ResourceTag/Department": "accounting".
List<String>	resources() An array of strings that contain Amazon Resource Names (ARNs) of resources to assign to a backup plan.
List<SdkField<?>>	sdkFields()
String	selectionName() The display name of a resource selection document.
static Class<? extends BackupSelection.Builder>	serializableBuilderClass()
BackupSelection.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

selectionName

public final String selectionName()

The display name of a resource selection document.

Returns:

The display name of a resource selection document.

iamRoleArn

public final String iamRoleArn()

The ARN of the IAM role that AWS 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 AWS Backup uses to authenticate when backing up the target resource; for example, arn:aws:iam::123456789012:role/S3Access.

hasResources

public final boolean hasResources()

Returns true if the Resources property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

resources

public final List<String> resources()

An array of strings that contain Amazon Resource Names (ARNs) of resources to assign to a backup plan.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasResources() to see if a value was sent in this field.

Returns:

An array of strings that contain Amazon Resource Names (ARNs) of resources to assign to a backup plan.

hasListOfTags

public final boolean hasListOfTags()

Returns true if the ListOfTags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

listOfTags

public final List<Condition> listOfTags()

An array of conditions used to specify a set of resources to assign to a backup plan; for example, "StringEquals": {"ec2:ResourceTag/Department": "accounting". Assigns the backup plan to every resource with at least one matching tag.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasListOfTags() to see if a value was sent in this field.

Returns:

An array of conditions used to specify a set of resources to assign to a backup plan; for example, "StringEquals": {"ec2:ResourceTag/Department": "accounting". Assigns the backup plan to every resource with at least one matching tag.

toBuilder

public BackupSelection.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BackupSelection.Builder,BackupSelection>

builder

public static BackupSelection.Builder builder()

serializableBuilderClass

public static Class<? extends BackupSelection.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo