software.amazon.awscdk.services.backup

Class BackupResource

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.backup.BackupResource

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:51.611Z")
public class BackupResource
extends software.amazon.jsii.JsiiObject

A resource to backup.

Example:

 BackupPlan plan;
 ITable myTable = Table.fromTableName(this, "Table", "myTableName");
 Construct myCoolConstruct = new Construct(this, "MyCoolConstruct");
 plan.addSelection("Selection", BackupSelectionOptions.builder()
         .resources(List.of(BackupResource.fromDynamoDbTable(myTable), BackupResource.fromTag("stage", "prod"), BackupResource.fromConstruct(myCoolConstruct)))
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BackupResource.Builder A fluent builder for BackupResource.

Constructor Summary

Constructors

Modifier	Constructor and Description
	BackupResource()
protected	BackupResource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	BackupResource(software.amazon.jsii.JsiiObjectRef objRef)
	BackupResource(java.lang.String resource, TagCondition tagCondition)
	BackupResource(java.lang.String resource, TagCondition tagCondition, software.constructs.Construct construct)

Method Summary

Modifier and Type	Method and Description
static BackupResource	fromArn(java.lang.String arn) A list of ARNs or match patterns such as `arn:aws:ec2:us-east-1:123456789012:volume/*`.
static BackupResource	fromConstruct(software.constructs.Construct construct) Adds all supported resources in a construct.
static BackupResource	fromDynamoDbTable(ITable table) A DynamoDB table.
static BackupResource	fromEc2Instance(IInstance instance) An EC2 instance.
static BackupResource	fromEfsFileSystem(IFileSystem fileSystem) An EFS file system.
static BackupResource	fromRdsDatabaseInstance(IDatabaseInstance instance) A RDS database instance.
static BackupResource	fromTag(java.lang.String key, java.lang.String value) A tag condition.
static BackupResource	fromTag(java.lang.String key, java.lang.String value, TagOperation operation) A tag condition.
Construct	getConstruct() A construct.
java.lang.String	getResource() A resource.
TagCondition	getTagCondition() A condition on a tag.

Methods inherited from class java.lang.Object

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

Constructor Detail

BackupResource

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

BackupResource

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

BackupResource

public BackupResource(java.lang.String resource,
                      TagCondition tagCondition,
                      software.constructs.Construct construct)

Parameters:

resource -

tagCondition -

construct -

BackupResource

public BackupResource(java.lang.String resource,
                      TagCondition tagCondition)

Parameters:

resource -

tagCondition -

BackupResource

public BackupResource()

Method Detail

fromArn

public static BackupResource fromArn(java.lang.String arn)

A list of ARNs or match patterns such as `arn:aws:ec2:us-east-1:123456789012:volume/*`.

Parameters:

arn - This parameter is required.

fromConstruct

public static BackupResource fromConstruct(software.constructs.Construct construct)

Adds all supported resources in a construct.

Parameters:

construct - The construct containing resources to backup. This parameter is required.

fromDynamoDbTable

public static BackupResource fromDynamoDbTable(ITable table)

A DynamoDB table.

Parameters:

table - This parameter is required.

fromEc2Instance

public static BackupResource fromEc2Instance(IInstance instance)

An EC2 instance.

Parameters:

instance - This parameter is required.

fromEfsFileSystem

public static BackupResource fromEfsFileSystem(IFileSystem fileSystem)

An EFS file system.

Parameters:

fileSystem - This parameter is required.

fromRdsDatabaseInstance

public static BackupResource fromRdsDatabaseInstance(IDatabaseInstance instance)

A RDS database instance.

Parameters:

instance - This parameter is required.

fromTag

public static BackupResource fromTag(java.lang.String key,
                                     java.lang.String value,
                                     TagOperation operation)

A tag condition.

Parameters:

key - This parameter is required.

value - This parameter is required.

operation -

fromTag

public static BackupResource fromTag(java.lang.String key,
                                     java.lang.String value)

A tag condition.

Parameters:

key - This parameter is required.

value - This parameter is required.

getConstruct

public Construct getConstruct()

A construct.

getResource

public java.lang.String getResource()

A resource.

getTagCondition

public TagCondition getTagCondition()

A condition on a tag.