Package software.amazon.awscdk.services.backup

Interface CfnBackupSelection.BackupSelectionResourceTypeProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBackupSelection.BackupSelectionResourceTypeProperty.Jsii$Proxy

Enclosing class:

CfnBackupSelection

@Stability(Stable)
public static interface CfnBackupSelection.BackupSelectionResourceTypeProperty
extends software.amazon.jsii.JsiiSerializable

Specifies an object containing properties used to assign a set of resources to a backup plan.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.backup.*;
 Object conditions;
 BackupSelectionResourceTypeProperty backupSelectionResourceTypeProperty = BackupSelectionResourceTypeProperty.builder()
         .iamRoleArn("iamRoleArn")
         .selectionName("selectionName")
         // the properties below are optional
         .conditions(conditions)
         .listOfTags(List.of(ConditionResourceTypeProperty.builder()
                 .conditionKey("conditionKey")
                 .conditionType("conditionType")
                 .conditionValue("conditionValue")
                 .build()))
         .notResources(List.of("notResources"))
         .resources(List.of("resources"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-backupselectionresourcetype.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnBackupSelection.BackupSelectionResourceTypeProperty.Builder	A builder for CfnBackupSelection.BackupSelectionResourceTypeProperty
static final class	CfnBackupSelection.BackupSelectionResourceTypeProperty.Jsii$Proxy	An implementation for CfnBackupSelection.BackupSelectionResourceTypeProperty

Method Summary

Modifier and Type	Method	Description
static CfnBackupSelection.BackupSelectionResourceTypeProperty.Builder	builder()
default Object	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 AWS Backup uses to authenticate when backing up the target resource;
default Object	getListOfTags()	A list of conditions that you define to assign resources to your backup plans using tags.
default List<String>	getNotResources()	A list of Amazon Resource Names (ARNs) to exclude from a backup plan.
default List<String>	getResources()	An array of strings that contain Amazon Resource Names (ARNs) of resources to assign to a backup plan.
String	getSelectionName()	The display name of a resource selection document.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getIamRoleArn

@Stability(Stable)
@NotNull
String getIamRoleArn()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-backupselectionresourcetype.html#cfn-backup-backupselection-backupselectionresourcetype-iamrolearn

getSelectionName

@Stability(Stable)
@NotNull
String getSelectionName()

The display name of a resource selection document.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-backupselectionresourcetype.html#cfn-backup-backupselection-backupselectionresourcetype-selectionname

getConditions

@Stability(Stable)
@Nullable
default Object getConditions()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-backupselectionresourcetype.html#cfn-backup-backupselection-backupselectionresourcetype-conditions

getListOfTags

@Stability(Stable)
@Nullable
default Object getListOfTags()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-backupselectionresourcetype.html#cfn-backup-backupselection-backupselectionresourcetype-listoftags

getNotResources

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-backupselectionresourcetype.html#cfn-backup-backupselection-backupselectionresourcetype-notresources

getResources

@Stability(Stable)
@Nullable
default List<String> getResources()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-backupselectionresourcetype.html#cfn-backup-backupselection-backupselectionresourcetype-resources

builder

@Stability(Stable)
static CfnBackupSelection.BackupSelectionResourceTypeProperty.Builder builder()

Returns:

a CfnBackupSelection.BackupSelectionResourceTypeProperty.Builder of CfnBackupSelection.BackupSelectionResourceTypeProperty