Setup configuration

Add Setup for AWS RDS Instances

1. Choose "Settings" from the navigation bar.

2. Choose "Setups" tab and click "Create new" button.

3. Type custom Setup name and select aws-rds-instances from "Resource type" field.

4. Enter the rest of the required fields and click "Save" button.

   Property	Required	Description
   Setup name	Yes	Name of a setup.
   Resource type	Yes	Type of resource you want to create a setup for.
   Prehook	No	AWS Lambda or HTTP endpoint which will be called before a backup attempt.
   - Hook type	Yes	AWS Lambda or HTTP endpoint.
   - Hook endpoint	Yes	AWS Lambda ARN or HTTP endpoint URL.
   Posthook	No	AWS Lambda or HTTP endpoint which will be called after a backup attempt.
   - Hook type	Yes	AWS Lambda or HTTP endpoint.
   - Hook endpoint	Yes	Lambda ARN or HTTP endpoint URL.
   Replication enabled	No	Boolean flag determining if RDS instance snapshots should be replicated to vault account.
   Replication region	Yes, if replication is enabled	An AWS region in which snapshots replicas will be stored.
   Share snapshot back	No	Causes snapshots replicas stored in a VAULT account to be shared with a PROTECTED account.
   Replicas encryption KMS key ARN or alias	No	Alias or ARN of a KMS key which will be used to encrypt snapshots replicas in VAULT account. Key must exist in replication region. Correct value is a string without alias/ prefix or ARN. For KMS key in ARN format and different replication region, it is required to provide the Default KMS key replacement setting.
   Default KMS key replacement	No	If a snapshot located in a PROTECTED account, is going to be re-encrypted in source account and copied into VAULT account (e.g. source snapshot is encrypted by a default AWS managed KMS key) then you need to provide a custom KMS key (alias, ARN or key id) that will be used to re-encrypt the snapshot before replication.
   Vault account id	Yes, if replication region is enabled	ID of a vault account used for storing snapshots replicas.
   Force encryption of unencrypted resources replicas	No	Forces snapshot's replica to be encrypted using KMS key specified in Replicas encryption KMS key setting, even if original resource is unencrypted.

Add Setup for AWS RDS Clusters

1. Choose "Settings" from the navigation bar.

2. Choose "Setups" tab and click "Create new" button.

3. Type custom Setup name and select aws-rds-clusters from "Resource type" field.

4. Enter the rest of the required fields and click "Save" button.

   Property	Required	Description
   Setup name	Yes	Name of a setup.
   Resource type	Yes	Type of resource you want to create a setup for.
   Prehook	No	AWS Lambda or HTTP endpoint which will be called before a backup attempt.
   - Hook type	Yes	AWS Lambda or HTTP endpoint.
   - Hook endpoint	Yes	AWS Lambda ARN or HTTP endpoint URL.
   Posthook	No	AWS Lambda or HTTP endpoint which will be called after a backup attempt.
   - Hook type	Yes	AWS Lambda or HTTP endpoint.
   - Hook endpoint	Yes	Lambda ARN or HTTP endpoint URL.
   Replication enabled	No	Boolean flag determining if RDS cluster snapshots should be replicated to vault account.
   Replication region	Yes, if replication is enabled	An AWS region in which snapshots replicas will be stored.
   Share snapshot back	No	Causes snapshots replicas stored in a VAULT account to be shared with a PROTECTED account.
   Replicas encryption KMS key ARN or alias	No	Alias or ARN of a KMS key which will be used to encrypt snapshots replicas in VAULT account. Key must exist in replication region. Correct value is a string without alias/ prefix or ARN. For KMS key in ARN format and different replication region, it is required to provide the Default KMS key replacement setting.
   Default KMS key replacement	No	If a snapshot located in a PROTECTED account, is going to be re-encrypted in source account and copied into VAULT account (e.g. source snapshot is encrypted by a default AWS managed KMS key) then you need to provide a custom KMS key (alias, ARN or key id) that will be used to re-encrypt the snapshot before replication.
   Vault account id	Yes, if replication is enabled	ID of a vault account used for storing snapshots replicas.

Add Setup for AWS S3

1. Choose "Settings" from the navigation bar.

2. Choose "Setups" tab and click "Create new" button.

3. Type custom Setup name and select aws-s3 from "Resource type" field.

4. Enter the rest of the required fields and click "Save" button.

   Property	Required	Description
   Setup name	Yes	Name of a setup.
   Resource type	Yes	Type of resource you want to create a setup for.
   Prehook	No	AWS Lambda or HTTP endpoint which will be called before a backup attempt.
   - Hook type	Yes	AWS Lambda or HTTP endpoint.
   - Hook endpoint	Yes	AWS Lambda ARN or HTTP endpoint URL.
   Posthook	No	AWS Lambda or HTTP endpoint which will be called after a backup attempt.
   - Hook type	Yes	AWS Lambda or HTTP endpoint.
   - Hook endpoint	Yes	Lambda ARN or HTTP endpoint URL.
   Replication region	No	An AWS region in which S3 objects replicas storing bucket will be created.
   Vault account id	Yes, if replication region is provided	Id of vault account used for storing objects replicas.
   Replication role ARN	Yes, if replication region is provided	ARN of a role which will be used by AWS to perform cross/same-region replication.
   Replicated prefixes	No	Prefixes of S3 objects which will be replicated. If empty then all objects stored in an S3 bucket will be replicated. The list should be JSON-encoded, e.g. ["pref1", "pref2"]
   Replicas encryption KMS key ARN or alias	No	Alias or ARN of a KMS key which will be used to encrypt S3 objects replicas. Key must exist in replication region. Correct value is a string without alias/ prefix or ARN.
   Override replica owner	No	If true then the owner of replicated objects is set to VAULT account.
   Replication enabled	Yes, if replication region is provided	If true then replication for bucket is enabled.
   Replicas storing bucket name	No	Name of an S3 bucket which will store replicas of snapshots. If this value is not provided AutoBackup will create bucket.

Add Setup for AWS Route53

1. Choose "Settings" from the navigation bar.

2. Choose "Setups" tab and click "Create new" button.

3. Type custom Setup name and select aws-route53 from "Resource type" field.

4. Enter rest of the required fields and click "Save" button.

   Property	Required	Description
   Setup name	Yes	Name of a setup.
   Resource type	Yes	Type of resource you want to create a setup for.
   Prehook	No	AWS Lambda or HTTP endpoint which will be called before a backup attempt.
   - Hook type	Yes	AWS Lambda or HTTP endpoint.
   - Hook endpoint	Yes	AWS Lambda ARN or HTTP endpoint URL.
   Posthook	No	AWS Lambda or HTTP endpoint which will be called after a backup attempt.
   - Hook type	Yes	AWS Lambda or HTTP endpoint.
   - Hook endpoint	Yes	Lambda ARN or HTTP endpoint URL.
   Storing bucket name	Yes	Name of an S3 bucket which will be used to store information about backed up Route53 settings.
   Replication enabled	No	If true then replication for Route53 snapshots is enabled.
   Replication region	Yes, if replication is enabled	The region in which backup replica is stored.
   Replicas storing bucket name	Yes, if replication is enabled	Name of an S3 bucket which will store replicas of snapshots .
   Vault account id	Yes, if replication is enabled	Id of vault account used for storing backup replicas.
   Replicas encryption KMS key ARN or alias	No	Alias or ARN of a KMS key which will be used to encrypt a snapshot replica. Key must exist in replication region. Correct value is a string without alias/ prefix or ARN.
   Force encryption of unencrypted resources replicas	No	Forces snapshot's replica to be encrypted using KMS key specified in Replicas encryption KMS key setting, even if original resource is unencrypted.

Add Setup for AWS DynamoDB

1. Choose "Settings" from the navigation bar.

2. Choose "Setups" tab and click "Create new" button.

3. Type custom Setup name and select aws-dynamodb from "Resource type" field.

4. Enter rest required fields to the setup form and click "Save" button.

   Property	Required	Description
   Setup name	Yes	Name of a setup.
   Resource type	Yes	Type of resource you want to create a setup for.
   Prehook	No	AWS Lambda or HTTP endpoint which will be called before a backup attempt.
   - Hook type	Yes	AWS Lambda or HTTP endpoint.
   - Hook endpoint	Yes	AWS Lambda ARN or HTTP endpoint URL.
   Posthook	No	AWS Lambda or HTTP endpoint which will be called after a backup attempt.
   - Hook type	Yes	AWS Lambda or HTTP endpoint.
   - Hook endpoint	Yes	Lambda ARN or HTTP endpoint URL.
   Replication region	No	The region in which backup replica is stored. If is not specified, then backup replica is not created.
   Vault account id	Yes, if replication region is provided	Id of vault account used for storing backup replicas.
   Replicas storing bucket name	Yes, if replication region is provided	Name of an S3 bucket which will store replicas of snapshots .
   Temporary DynamoDB table read capacity units	No	Decides how many DynamoDB table read capacity units will be used during replication. If this setting is omitted then the table will be read in ON DEMAND mode.

Add Setup for AWS EFS

1. Choose "Settings" from the navigation bar.

2. Choose "Setups" tab and click "Create new" button.

3. Type custom Setup name and select aws-efs from "Resource type" field.

4. Enter rest required fields to the setup form and click "Save" button.

   Property	Required	Description
   Setup name	Yes	Name of a setup.
   Resource type	Yes	Type of resource you want to create a setup for.
   Prehook	No	AWS Lambda or HTTP endpoint which will be called before a backup attempt.
   - Hook type	Yes	AWS Lambda or HTTP endpoint.
   - Hook endpoint	Yes	AWS Lambda ARN or HTTP endpoint URL.
   Posthook	No	AWS Lambda or HTTP endpoint which will be called after a backup attempt.
   - Hook type	Yes	AWS Lambda or HTTP endpoint.
   - Hook endpoint	Yes	Lambda ARN or HTTP endpoint URL.
   Skip creating primary snapshot through AWS Backup	No (deprecated)	Skip creating primary snapshot.
   Backup vault name	Yes	Name of AWS Backup vault used to make EFS snapshots.
   ARN of role for backup vault	Yes	ARN of a role which will be passed to AWS Backup to execute EFS backup job.
   Replicas storing bucket name	No (deprecated)	Name of a bucket used to store EFS filesystem replicas.
   Subnet ID	No (deprecated)	ID of a subnet in which an EC2 instance copying data from EFS to S3 will be launched.
   Security group ID	No (deprecated)	ID of a security group which will be attached to an EC2 instance copying data from EFS to S3.
   ARN of an instance profile	No (deprecated)	ARN of an EC2 instance profile which will be used to launch an EC2 instance copying data from EFS to S3.
   Replication enabled	No	Boolean flag determining if EFS snapshots should be replicated to vault account.
   Vault account id	Yes, if replication is enabled	Id of vault account used for storing backup replicas.
   Replication region	Yes, if replication is enabled	An AWS region in which snapshot replicas will be stored.
   ARN of a replica backup vault	Yes, if replication is enabled	An ARN of a AWS Backup Vault used to replicate EFS snapshot.

Add Setup for AWS EC2

1. Choose "Settings" from the navigation bar.

2. Choose "Setups" tab and click "Create new" button.

3. Type custom Setup name and select aws-ec2 from "Resource type" field.

4. Enter rest required fields to the setup form and click "Save" button.

   Property	Required	Description
   Setup name	Yes	Name of a setup.
   Resource type	Yes	Type of resource you want to create a setup for.
   Prehook	No	AWS Lambda or HTTP endpoint which will be called before a backup attempt.
   - Hook type	Yes	AWS Lambda or HTTP endpoint.
   - Hook endpoint	Yes	AWS Lambda ARN or HTTP endpoint URL.
   Posthook	No	AWS Lambda or HTTP endpoint which will be called after a backup attempt.
   - Hook type	Yes	AWS Lambda or HTTP endpoint.
   - Hook endpoint	Yes	Lambda ARN or HTTP endpoint URL.
   Replication enabled	No	Boolean flag determining if EC2 snapshots should be replicated to vault account.
   Replication region	Yes, if replication is enabled	An AWS region in which snapshot replicas will be stored.
   Share snapshot back	No	Causes snapshots replicas stored in a VAULT account to be shared with a PROTECTED account.
   Replicas encryption KMS key ARN or alias	No	Alias or ARN of a KMS key which will be used to encrypt snapshots replicas in VAULT account. Key must exist in replication region. Correct value is a string without alias/ prefix or ARN.
   Default KMS key replacement	No	If a snapshot located in a PROTECTED account, is going to be re-encrypted in source account and copied into VAULT account (e.g. source snapshot is encrypted by a default AWS managed KMS key) then you need to provide a custom KMS key (alias, ARN or key id) that will be used to re-encrypt the snapshot before replication.
   Vault account id	Yes, if replication is enabled	ID of a vault account used for storing snapshot replicas.
   Force encryption of unencrypted resources replicas	No	Forces snapshot's replica to be encrypted using KMS key specified in Replicas encryption KMS key setting, even if original resource is unencrypted.

Add Setup for AWS EBS

1. Choose "Settings" from the navigation bar.

2. Choose "Setups" tab and click "Create new" button.

3. Type custom Setup name and select aws-ebs from "Resource type" field.

4. Enter rest required fields to the setup form and click "Save" button.

   Property	Required	Description
   Setup name	Yes	Name of a setup.
   Resource type	Yes	Type of resource you want to create a setup for.
   Prehook	No	AWS Lambda or HTTP endpoint which will be called before a backup attempt.
   - Hook type	Yes	AWS Lambda or HTTP endpoint.
   - Hook endpoint	Yes	AWS Lambda ARN or HTTP endpoint URL.
   Posthook	No	AWS Lambda or HTTP endpoint which will be called after a backup attempt.
   - Hook type	Yes	AWS Lambda or HTTP endpoint.
   - Hook endpoint	Yes	Lambda ARN or HTTP endpoint URL.
   Replication enabled	No	Boolean flag determining if EBS snapshots should be replicated to vault account.
   Replication region	Yes, if replication is enabled	An AWS region in which snapshot replicas will be stored. If not specified then snapshots will not be replicated.
   Share snapshot back	No	Causes snapshots replicas stored in a VAULT account to be shared with a PROTECTED account.
   Replicas encryption KMS key ARN or alias	No	Alias or ARN of a KMS key which will be used to encrypt snapshots replicas in VAULT account. Key must exist in replication region. Correct value is a string without alias/ prefix or ARN.
   Default KMS key replacement	No	If a snapshot located in a PROTECTED account, is going to be re-encrypted in source account and copied into VAULT account (e.g. source snapshot is encrypted by a default AWS managed KMS key) then you need to provide a custom KMS key (alias, ARN or key id) that will be used to re-encrypt the snapshot before replication.
   Vault account id	Yes, if replication is enabled	ID of a vault account used for storing snapshot replicas.
   Force encryption of unencrypted resources replicas	No	Forces snapshot's replica to be encrypted using KMS key specified in Replicas encryption KMS key setting, even if original resource is unencrypted.

Add Setup for AWS Redshift

1. Choose "Settings" from the navigation bar.

2. Choose "Setups" tab and click "Create new" button.

3. Type custom Setup name and select aws-redshift from "Resource type" field.

4. Enter rest required fields to the setup form and click "Save" button.

   Property	Required	Description
   Setup name	Yes	Name of a setup.
   Resource type	Yes	Type of resource you want to create a setup for.
   Prehook	No	AWS Lambda or HTTP endpoint which will be called before a backup attempt.
   - Hook type	Yes	AWS Lambda or HTTP endpoint.
   - Hook endpoint	Yes	AWS Lambda ARN or HTTP endpoint URL.
   Posthook	No	AWS Lambda or HTTP endpoint which will be called after a backup attempt.
   - Hook type	Yes	AWS Lambda or HTTP endpoint.
   - Hook endpoint	Yes	Lambda ARN or HTTP endpoint URL.

Add Setup for AWS China RDS Instances

1. Choose "Settings" from the navigation bar.

2. Choose "Setups" tab and click "Create new" button.

3. Type custom Setup name and select aws-cn-rds-instances from "Resource type" field.

4. Enter rest required fields to the setup form and click "Save" button.

   Property	Required	Description
   Setup name	Yes	Name of a setup.
   Resource type	Yes	Type of resource you want to create a setup for.
   Prehook	No	AWS Lambda or HTTP endpoint which will be called before a backup attempt.
   - Hook type	Yes	AWS Lambda or HTTP endpoint.
   - Hook endpoint	Yes	AWS Lambda ARN or HTTP endpoint URL.
   Posthook	No	AWS Lambda or HTTP endpoint which will be called after a backup attempt.
   - Hook type	Yes	AWS Lambda or HTTP endpoint.
   - Hook endpoint	Yes	Lambda ARN or HTTP endpoint URL.
   Replication enabled	No	Boolean flag determining if RDS instance snapshots should be replicated to vault account.
   Replication region	Yes, if replication is enabled	An AWS region in which snapshots replicas will be stored.
   Share snapshot back	Yes, if replication region is provided	Causes snapshots replicas stored in a VAULT account to be shared with a PROTECTED account.
   Replicas encryption KMS key ARN or alias	No	Alias or ARN of a KMS key which will be used to encrypt snapshots replicas in VAULT account. Key must exist in replication region. Correct value is a string without alias/ prefix or ARN.
   Default KMS key replacement	No	If a snapshot located in a PROTECTED account, is going to be re-encrypted in source account and copied into VAULT account (e.g. source snapshot is encrypted by a default AWS managed KMS key) or for resources in Beijing region (sharing encrypted snapshot is not supported in this region) then you need to provide a custom KMS key (alias, ARN or key id) that will be used to re-encrypt the snapshot before replication.
   Vault account id	Yes, if replication is enabled	ID of a vault account used for storing snapshots replicas.
   Force encryption of unencrypted resources replicas	No	Forces snapshot's replica to be encrypted using KMS key specified in Replicas encryption KMS key setting, even if original resource is unencrypted.

Add Setup for AWS China RDS Clusters

1. Choose "Settings" from the navigation bar.

2. Choose "Setups" tab and click "Create new" button.

3. Type custom Setup name and select aws-cn-rds-clusters from "Resource type" field.

4. Enter rest required fields to the setup form and click "Save" button.

   Property	Required	Description
   Setup name	Yes	Name of a setup.
   Resource type	Yes	Type of resource you want to create a setup for.
   Prehook	No	AWS Lambda or HTTP endpoint which will be called before a backup attempt.
   - Hook type	Yes	AWS Lambda or HTTP endpoint.
   - Hook endpoint	Yes	AWS Lambda ARN or HTTP endpoint URL.
   Posthook	No	AWS Lambda or HTTP endpoint which will be called after a backup attempt.
   - Hook type	Yes	AWS Lambda or HTTP endpoint.
   - Hook endpoint	Yes	Lambda ARN or HTTP endpoint URL.
   Replication enabled	No	Boolean flag determining if RDS cluster snapshots should be replicated to vault account.
   Replication region	Yes, if replication is enabled	An AWS region in which snapshots replicas will be stored.
   Share snapshot back	No	Causes snapshots replicas stored in a VAULT account to be shared with a PROTECTED account.
   Replicas encryption KMS key ARN or alias	No	Alias or ARN of a KMS key which will be used to encrypt snapshots replicas in VAULT account. Key must exist in replication region. Correct value is a string without alias/ prefix or ARN.
   Default KMS key replacement	No	If a snapshot located in a PROTECTED account, is going to be re-encrypted in source account and copied into VAULT account (e.g. source snapshot is encrypted by a default AWS managed KMS key) or for resources in Beijing region (sharing encrypted snapshot is not supported in this region) then you need to provide a custom KMS key (alias, ARN or key id) that will be used to re-encrypt the snapshot before replication.
   Vault account id	Yes, if replication is enabled	ID of a vault account used for storing snapshots replicas.

Add Setup for AWS China S3

1. Choose "Settings" from the navigation bar.

2. Choose "Setups" tab and click "Create new" button.

3. Type custom Setup name and select aws-cn-s3 from "Resource type" field.

4. Enter rest required fields to the setup form and click "Save" button.

   Property	Required	Description
   Setup name	Yes	Name of a setup.
   Resource type	Yes	Type of resource you want to create a setup for.
   Prehook	No	AWS Lambda or HTTP endpoint which will be called before a backup attempt.
   - Hook type	Yes	AWS Lambda or HTTP endpoint.
   - Hook endpoint	Yes	AWS Lambda ARN or HTTP endpoint URL.
   Posthook	No	AWS Lambda or HTTP endpoint which will be called after a backup attempt.
   - Hook type	Yes	AWS Lambda or HTTP endpoint.
   - Hook endpoint	Yes	Lambda ARN or HTTP endpoint URL.
   Replication region	No	An AWS region in which S3 objects replicas storing bucket will be created.
   Vault account id	Yes, if replication region is provided	Id of vault account used for storing objects replicas.
   Replication role ARN	Yes, if replication region is provided	ARN of a role which will be used by AWS to perform cross/same-region replication.
   Replicated prefixes	No	Prefixes of S3 objects which will be replicated. If empty then all objects stored in an S3 bucket will be replicated.
   Replicas encryption KMS key ARN or alias	No	Alias or ARN of a KMS key which will be used to encrypt S3 objects replicas. Key must exist in replication region. Correct value is a string without alias/ prefix or ARN.
   Override replica owner	No	If true then the owner of replicated objects is set to VAULT account.
   Replication enabled	Yes, if replication region is provided	If true then replication for bucket is enabled.
   Replicas storing bucket name	No	Name of an S3 bucket which will store replicas of snapshots. If this value is not provided AutoBackup will create bucket.

Add Setup for AWS China DynamoDB

1. Choose "Settings" from the navigation bar.

2. Choose "Setups" tab and click "Create new" button.

3. Type custom Setup name and select aws-cn-dynamodb from "Resource type" field.

4. Enter rest required fields to the setup form and click "Save" button.

   Property	Required	Description
   Setup name	Yes	Name of a setup.
   Resource type	Yes	Type of resource you want to create a setup for.
   Prehook	No	AWS Lambda or HTTP endpoint which will be called before a backup attempt.
   - Hook type	Yes	AWS Lambda or HTTP endpoint.
   - Hook endpoint	Yes	AWS Lambda ARN or HTTP endpoint URL.
   Posthook	No	AWS Lambda or HTTP endpoint which will be called after a backup attempt.
   - Hook type	Yes	AWS Lambda or HTTP endpoint.
   - Hook endpoint	Yes	Lambda ARN or HTTP endpoint URL.
   Replication region	No	The region in which backup replica is stored. If is not specified, then backup replica is not created.
   Vault account id	Yes, if replication region is provided	Id of vault account used for storing backup replicas.
   Replicas storing bucket name	Yes, if replication region is provided	Name of an S3 bucket which will store replicas of snapshots .
   Temporary DynamoDB table read capacity units	No	Decides how many DynamoDB table read capacity units will be used during replication. If this setting is omitted then the table will be read in ON DEMAND mode.

Add Setup for AWS China EFS

1. Choose "Settings" from the navigation bar.

2. Choose "Setups" tab and click "Create new" button.

3. Type custom Setup name and select aws-cn-efs from "Resource type" field.

4. Enter rest required fields to the setup form and click "Save" button.

   Property	Required	Description
   Setup name	Yes	Name of a setup.
   Resource type	Yes	Type of resource you want to create a setup for.
   Prehook	No	AWS Lambda or HTTP endpoint which will be called before a backup attempt.
   - Hook type	Yes	AWS Lambda or HTTP endpoint.
   - Hook endpoint	Yes	AWS Lambda ARN or HTTP endpoint URL.
   Posthook	No	AWS Lambda or HTTP endpoint which will be called after a backup attempt.
   - Hook type	Yes	AWS Lambda or HTTP endpoint.
   - Hook endpoint	Yes	Lambda ARN or HTTP endpoint URL.
   Skip creating primary snapshot through AWS Backup	No (deprecated)	Skip creating primary snapshot.
   Backup vault name	Yes	Name of AWS Backup vault used to make EFS snapshots.
   ARN of role for backup vault	Yes	ARN of a role which will be passed to AWS Backup to execute EFS backup job.
   Replicas storing bucket name	No (deprecated)	Name of a bucket used to store EFS filesystem replicas.
   Subnet ID	No (deprecated)	ID of a subnet in which an EC2 instance copying data from EFS to S3 will be launched.
   Security group ID	No (deprecated)	ID of a security group which will be attached to an EC2 instance copying data from EFS to S3.
   ARN of an instance profile	No (deprecated)	ARN of an EC2 instance profile which will be used to launch an EC2 instance copying data from EFS to S3.
   Replication enabled	No	Boolean flag determining if EFS snapshots should be replicated to vault account.
   Vault account id	Yes, if replication is enabled	Id of vault account used for storing backup replicas.
   Replication region	Yes, if replication is enabled	An AWS region in which snapshot replicas will be stored.
   ARN of a replica backup vault	Yes, if replication is enabled	An ARN of a AWS Backup Vault used to replicate EFS snapshot.

Add Setup for AWS China EC2

1. Choose "Settings" from the navigation bar.

2. Choose "Setups" tab and click "Create new" button.

3. Type custom Setup name and select ws-cn-ec2 from "Resource type" field.

4. Enter rest required fields to the setup form and click "Save" button.

   Property	Required	Description
   Setup name	Yes	Name of a setup.
   Resource type	Yes	Type of resource you want to create a setup for.
   Prehook	No	AWS Lambda or HTTP endpoint which will be called before a backup attempt.
   - Hook type	Yes	AWS Lambda or HTTP endpoint.
   - Hook endpoint	Yes	AWS Lambda ARN or HTTP endpoint URL.
   Posthook	No	AWS Lambda or HTTP endpoint which will be called after a backup attempt.
   - Hook type	Yes	AWS Lambda or HTTP endpoint.
   - Hook endpoint	Yes	Lambda ARN or HTTP endpoint URL.
   Replication enabled	No	Boolean flag determining if EC2 snapshots should be replicated to vault account.
   Replication region	Yes, if replication is enabled	An AWS region in which snapshot replicas will be stored.
   Share snapshot back	No	Causes snapshots replicas stored in a VAULT account to be shared with a PROTECTED account.
   Replicas encryption KMS key ARN or alias	No	Alias or ARN of a KMS key which will be used to encrypt snapshots replicas in VAULT account. Key must exist in replication region. Correct value is a string without alias/ prefix or ARN.
   Default KMS key replacement	No	If a snapshot located in a PROTECTED account, is going to be re-encrypted in source account and copied into VAULT account (e.g. source snapshot is encrypted by a default AWS managed KMS key) or for resources in Beijing region (sharing encrypted snapshot is not supported in this region) then you need to provide a custom KMS key (alias, ARN or key id) that will be used to re-encrypt the snapshot before replication.
   Vault account id	Yes, if replication is enabled	ID of a vault account used for storing snapshot replicas.
   Force encryption of unencrypted resources replicas	No	Forces snapshot's replica to be encrypted using KMS key specified in Replicas encryption KMS key setting, even if original resource is unencrypted.

Add Setup for AWS China EBS

1. Choose "Settings" from the navigation bar.

2. Choose "Setups" tab and click "Create new" button.

3. Type custom Setup name and select aws-cn-ebs from "Resource type" field.

4. Enter rest required fields to the setup form and click "Save" button.

   Property	Required	Description
   Setup name	Yes	Name of a setup.
   Resource type	Yes	Type of resource you want to create a setup for.
   Prehook	No	AWS Lambda or HTTP endpoint which will be called before a backup attempt.
   - Hook type	Yes	AWS Lambda or HTTP endpoint.
   - Hook endpoint	Yes	AWS Lambda ARN or HTTP endpoint URL.
   Posthook	No	AWS Lambda or HTTP endpoint which will be called after a backup attempt.
   - Hook type	Yes	AWS Lambda or HTTP endpoint.
   - Hook endpoint	Yes	Lambda ARN or HTTP endpoint URL.
   Replication enabled	No	Boolean flag determining if EBS snapshots should be replicated to vault account.
   Replication region	Yes, if replication is enabled	An AWS region in which snapshot replicas will be stored. If not specified then snapshots will not be replicated.
   Share snapshot back	No	Causes snapshots replicas stored in a VAULT account to be shared with a PROTECTED account.
   Replicas encryption KMS key ARN or alias	No	Alias or ARN of a KMS key which will be used to encrypt snapshots replicas in VAULT account. Key must exist in replication region. Correct value is a string without alias/ prefix or ARN.
   Default KMS key replacement	No	If a snapshot located in a PROTECTED account, is going to be re-encrypted in source account and copied into VAULT account (e.g. source snapshot is encrypted by a default AWS managed KMS key) or for resources in Beijing region (sharing encrypted snapshot is not supported in this region) then you need to provide a custom KMS key (alias, ARN or key id) that will be used to re-encrypt the snapshot before replication.
   Vault account id	Yes, if replication is enabled	ID of a vault account used for storing snapshot replicas.

Add Setup for AWS China Redshift

1. Choose "Settings" from the navigation bar.

2. Choose "Setups" tab and click "Create new" button.

3. Type custom Setup name and select aws-cn-redshift from "Resource type" field.

4. Enter rest required fields to the setup form and click "Save" button.

   Property	Required	Description
   Setup name	Yes	Name of a setup.
   Resource type	Yes	Type of resource you want to create a setup for.
   Prehook	No	AWS Lambda or HTTP endpoint which will be called before a backup attempt.
   - Hook type	Yes	AWS Lambda or HTTP endpoint.
   - Hook endpoint	Yes	AWS Lambda ARN or HTTP endpoint URL.
   Posthook	No	AWS Lambda or HTTP endpoint which will be called after a backup attempt.
   - Hook type	Yes	AWS Lambda or HTTP endpoint.
   - Hook endpoint	Yes	Lambda ARN or HTTP endpoint URL.

Add Setup for Azure VM

1. Choose "Settings" from the navigation bar.

2. Choose "Setups" tab and click "Create new" button.

3. Type custom Setup name and select azure-vm from "Resource type" field.

4. Enter rest required fields to the setup form and click "Save" button.

   Property	Required	Description
   Setup name	Yes	Name of a setup.
   Resource type	Yes	Type of resource you want to create a setup for.
   Prehook	No	AWS Lambda or HTTP endpoint which will be called before a backup attempt.
   - Hook type	Yes	AWS Lambda or HTTP endpoint.
   - Hook endpoint	Yes	AWS Lambda ARN or HTTP endpoint URL.
   Posthook	No	AWS Lambda or HTTP endpoint which will be called after a backup attempt.
   - Hook type	Yes	AWS Lambda or HTTP endpoint.
   - Hook endpoint	Yes	Lambda ARN or HTTP endpoint URL.

Add Setup for Azure SAP HANA

1. Choose "Settings" from the navigation bar.

2. Choose "Setups" tab and click "Create new" button.

3. Type custom Setup name and select azure-sap-hana from "Resource type" field.

4. Enter rest required fields to the setup form and click "Save" button.

   Property	Required	Description
   Setup name	Yes	Name of a setup.
   Resource type	Yes	Type of resource you want to create a setup for.
   Prehook	No	AWS Lambda or HTTP endpoint which will be called before a backup attempt.
   - Hook type	Yes	AWS Lambda or HTTP endpoint.
   - Hook endpoint	Yes	AWS Lambda ARN or HTTP endpoint URL.
   Posthook	No	AWS Lambda or HTTP endpoint which will be called after a backup attempt.
   - Hook type	Yes	AWS Lambda or HTTP endpoint.
   - Hook endpoint	Yes	Lambda ARN or HTTP endpoint URL.

Add Setup for GCP VM

1. Choose "Settings" from the navigation bar.

2. Choose "Setups" tab and click "Create new" button.

3. Type custom Setup name and select gcp-vm from "Resource type" field.

4. Enter rest required fields to the setup form and click "Save" button.

   Property	Required	Description
   Setup name	Yes	Name of a setup.
   Resource type	Yes	Type of resource you want to create a setup for.
   Prehook	No	AWS Lambda or HTTP endpoint which will be called before a backup attempt.
   - Hook type	Yes	AWS Lambda or HTTP endpoint.
   - Hook endpoint	Yes	AWS Lambda ARN or HTTP endpoint URL.
   Posthook	No	AWS Lambda or HTTP endpoint which will be called after a backup attempt.
   - Hook type	Yes	AWS Lambda or HTTP endpoint.
   - Hook endpoint	Yes	Lambda ARN or HTTP endpoint URL.
   Use Regional location for primary backup	No	Use Regional location (instance region) instead of Multi-Regional location to create primary snapshots.
   Replication enabled	No	Boolean flag determining if GCP VM snapshots should be replicated to vault account.
   Vault account id	Yes, if replication is enabled	ID of a vault account used for storing snapshot replicas.
   Replication multi-region	Yes, if replication is enabled and Use Regional location for replication is disabled	Name of a multi-region to which snapshots will be replicated
   Use Regional location for replication	No	Use Regional location instead of Multi-Regional location to create replica snapshots.
   Replication region	Yes, if Use Regional location for replication is enabled	A GCP region in which snapshot replicas will be stored.

Add Setup for IBM CLOUD VM

1. Choose "Settings" from the navigation bar.

2. Choose "Setups" tab and click "Create new" button.

3. Type custom Setup name and select ibmcloud-vm from "Resource type" field.

4. Enter rest required fields to the setup form and click "Save" button.

   Property	Required	Description
   Setup name	Yes	Name of a setup.
   Resource type	Yes	Type of resource you want to create a setup for.
   Prehook	No	AWS Lambda or HTTP endpoint which will be called before a backup attempt.
   - Hook type	Yes	AWS Lambda or HTTP endpoint.
   - Hook endpoint	Yes	AWS Lambda ARN or HTTP endpoint URL.
   Posthook	No	AWS Lambda or HTTP endpoint which will be called after a backup attempt.
   - Hook type	Yes	AWS Lambda or HTTP endpoint.
   - Hook endpoint	Yes	Lambda ARN or HTTP endpoint URL.