class BackupResource

Language	Type name
.NET	Amazon.CDK.AWS.Backup.BackupResource
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsbackup#BackupResource
Java	software.amazon.awscdk.services.backup.BackupResource
Python	aws_cdk.aws_backup.BackupResource
TypeScript (source)	aws-cdk-lib » aws_backup » BackupResource

A resource to backup.

Example

declare const plan: backup.BackupPlan;
declare const vpc: ec2.Vpc;
const myTable = dynamodb.Table.fromTableName(this, 'Table', 'myTableName');
const myDatabaseInstance = new rds.DatabaseInstance(this, 'DatabaseInstance', {
  engine: rds.DatabaseInstanceEngine.mysql({ version: rds.MysqlEngineVersion.VER_8_0_26 }),
  vpc,
});
const myDatabaseCluster = new rds.DatabaseCluster(this, 'DatabaseCluster', {
  engine: rds.DatabaseClusterEngine.auroraMysql({ version: rds.AuroraMysqlEngineVersion.VER_2_08_1 }),
  credentials: rds.Credentials.fromGeneratedSecret('clusteradmin'),
  instanceProps: {
    vpc,
  },
});
const myServerlessCluster = new rds.ServerlessCluster(this, 'ServerlessCluster', {
  engine: rds.DatabaseClusterEngine.AURORA_POSTGRESQL,
  parameterGroup: rds.ParameterGroup.fromParameterGroupName(this, 'ParameterGroup', 'default.aurora-postgresql11'),
  vpc,
});
const myCoolConstruct = new Construct(this, 'MyCoolConstruct');

plan.addSelection('Selection', {
  resources: [
    backup.BackupResource.fromDynamoDbTable(myTable), // A DynamoDB table
    backup.BackupResource.fromRdsDatabaseInstance(myDatabaseInstance), // A RDS instance
    backup.BackupResource.fromRdsDatabaseCluster(myDatabaseCluster), // A RDS database cluster
    backup.BackupResource.fromRdsServerlessCluster(myServerlessCluster), // An Aurora Serverless cluster
    backup.BackupResource.fromTag('stage', 'prod'), // All resources that are tagged stage=prod in the region/account
    backup.BackupResource.fromConstruct(myCoolConstruct), // All backupable resources in `myCoolConstruct`
  ]
})

Initializer

new BackupResource(resource?: string, tagCondition?: TagCondition, construct?: Construct)

Parameters

• resource string
• tagCondition TagCondition
• construct Construct

Properties

Name	Type	Description
construct?	Construct	A construct.
resource?	string	A resource.
tagCondition?	TagCondition	A condition on a tag.

---

construct?

Type: Construct (optional)

A construct.

---

resource?

Type: string (optional)

A resource.

---

tagCondition?

Type: TagCondition (optional)

A condition on a tag.

Methods

Name	Description
static fromArn(arn)	A list of ARNs or match patterns such as arn:aws:ec2:us-east-1:123456789012:volume/*.
static fromConstruct(construct)	Adds all supported resources in a construct.
static fromDynamoDbTable(table)	A DynamoDB table.
static fromEc2Instance(instance)	An EC2 instance.
static fromEfsFileSystem(fileSystem)	An EFS file system.
static fromRdsDatabaseCluster(cluster)	A RDS database cluter.
static fromRdsDatabaseInstance(instance)	A RDS database instance.
static fromRdsServerlessCluster(cluster)	An Aurora database instance.
static fromTag(key, value, operation?)	A tag condition.

---

static fromArn(arn)

public static fromArn(arn: string): BackupResource

Parameters

• arn string

Returns

• BackupResource

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

---

static fromConstruct(construct)

public static fromConstruct(construct: Construct): BackupResource

Parameters

• construct Construct — The construct containing resources to backup.

Returns

• BackupResource

Adds all supported resources in a construct.

---

static fromDynamoDbTable(table)

public static fromDynamoDbTable(table: ITable): BackupResource

Parameters

• table ITable

Returns

• BackupResource

A DynamoDB table.

---

static fromEc2Instance(instance)

public static fromEc2Instance(instance: IInstance): BackupResource

Parameters

• instance IInstance

Returns

• BackupResource

An EC2 instance.

---

static fromEfsFileSystem(fileSystem)

public static fromEfsFileSystem(fileSystem: IFileSystem): BackupResource

Parameters

• fileSystem IFileSystem

Returns

• BackupResource

An EFS file system.

---

static fromRdsDatabaseCluster(cluster)

public static fromRdsDatabaseCluster(cluster: IDatabaseCluster): BackupResource

Parameters

• cluster IDatabaseCluster

Returns

• BackupResource

A RDS database cluter.

---

static fromRdsDatabaseInstance(instance)

public static fromRdsDatabaseInstance(instance: IDatabaseInstance): BackupResource

Parameters

• instance IDatabaseInstance

Returns

• BackupResource

A RDS database instance.

---

static fromRdsServerlessCluster(cluster)

public static fromRdsServerlessCluster(cluster: IServerlessCluster): BackupResource

Parameters

• cluster IServerlessCluster

Returns

• BackupResource

An Aurora database instance.

---

static fromTag(key, value, operation?)

public static fromTag(key: string, value: string, operation?: TagOperation): BackupResource

Parameters

• key string
• value string
• operation TagOperation

Returns

• BackupResource

A tag condition.