Package software.amazon.awscdk.services.backup

Class CfnBackupSelection

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.backup.CfnBackupSelection

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
           date="2024-07-12T19:33:58.029Z")
@Stability(Stable)
public class CfnBackupSelection
extends CfnResource
implements IInspectable

Specifies a set of resources to assign to a backup plan.

For a sample AWS CloudFormation template, see the AWS Backup Developer Guide .

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;
 CfnBackupSelection cfnBackupSelection = CfnBackupSelection.Builder.create(this, "MyCfnBackupSelection")
         .backupPlanId("backupPlanId")
         .backupSelection(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())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnBackupSelection.BackupSelectionResourceTypeProperty	Specifies an object containing properties used to assign a set of resources to a backup plan.
static final class	CfnBackupSelection.Builder	A fluent builder for CfnBackupSelection.
static interface	CfnBackupSelection.ConditionParameterProperty	Includes information about tags you define to assign tagged resources to a backup plan.
static interface	CfnBackupSelection.ConditionResourceTypeProperty	Specifies an object that contains an array of triplets made up of a condition type (such as STRINGEQUALS ), a key, and a value.
static interface	CfnBackupSelection.ConditionsProperty	Contains information about which resources to include or exclude from a backup plan using their tags.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnBackupSelection(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnBackupSelection(software.amazon.jsii.JsiiObjectRef objRef)
	CfnBackupSelection(software.constructs.Construct scope, String id, CfnBackupSelectionProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrBackupPlanId()	Uniquely identifies a backup plan.
String	getAttrId()	Uniquely identifies the backup selection.
String	getAttrSelectionId()	Uniquely identifies a request to assign a set of resources to a backup plan.
String	getBackupPlanId()	Uniquely identifies a backup plan.
Object	getBackupSelection()	Specifies the body of a request to assign a set of resources to a backup plan.
protected Map<String,Object>	getCfnProperties()
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setBackupPlanId(String value)	Uniquely identifies a backup plan.
void	setBackupSelection(IResolvable value)	Specifies the body of a request to assign a set of resources to a backup plan.
void	setBackupSelection(CfnBackupSelection.BackupSelectionResourceTypeProperty value)	Specifies the body of a request to assign a set of resources to a backup plan.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnBackupSelection

protected CfnBackupSelection(software.amazon.jsii.JsiiObjectRef objRef)

CfnBackupSelection

protected CfnBackupSelection(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnBackupSelection

@Stability(Stable)
public CfnBackupSelection(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnBackupSelectionProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrBackupPlanId

@Stability(Stable)
@NotNull
public String getAttrBackupPlanId()

Uniquely identifies a backup plan.

getAttrId

@Stability(Stable)
@NotNull
public String getAttrId()

Uniquely identifies the backup selection.

getAttrSelectionId

@Stability(Stable)
@NotNull
public String getAttrSelectionId()

Uniquely identifies a request to assign a set of resources to a backup plan.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getBackupPlanId

@Stability(Stable)
@NotNull
public String getBackupPlanId()

Uniquely identifies a backup plan.

setBackupPlanId

@Stability(Stable)
public void setBackupPlanId(@NotNull
 String value)

Uniquely identifies a backup plan.

getBackupSelection

@Stability(Stable)
@NotNull
public Object getBackupSelection()

Specifies the body of a request to assign a set of resources to a backup plan.

setBackupSelection

@Stability(Stable)
public void setBackupSelection(@NotNull
 IResolvable value)

Specifies the body of a request to assign a set of resources to a backup plan.

setBackupSelection

@Stability(Stable)
public void setBackupSelection(@NotNull
 CfnBackupSelection.BackupSelectionResourceTypeProperty value)

Specifies the body of a request to assign a set of resources to a backup plan.