Class BackupSelectionProps

Properties for a BackupSelection.

Inheritance

object

BackupSelectionProps

Implements

IBackupSelectionProps

IBackupSelectionOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Backup

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class BackupSelectionProps : IBackupSelectionProps, IBackupSelectionOptions

Syntax (vb)

Public Class BackupSelectionProps Implements IBackupSelectionProps, IBackupSelectionOptions

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK.AWS.Backup;
            using Amazon.CDK.AWS.IAM;

            BackupPlan backupPlan;
            BackupResource backupResource;
            Role role;

            var backupSelectionProps = new BackupSelectionProps {
                BackupPlan = backupPlan,
                Resources = new [] { backupResource },

                // the properties below are optional
                AllowRestores = false,
                BackupSelectionName = "backupSelectionName",
                DisableDefaultBackupPolicy = false,
                Role = role
            };

Synopsis

Constructors

BackupSelectionProps()

Properties for a BackupSelection.

Properties

AllowRestores	Whether to automatically give restores permissions to the role that AWS Backup uses.
BackupPlan	The backup plan for this selection.
BackupSelectionName	The name for this selection.
DisableDefaultBackupPolicy	Whether to disable automatically assigning default backup permissions to the role that AWS Backup uses.
Resources	The resources to backup.
Role	The role that AWS Backup uses to authenticate when backuping or restoring the resources.

Constructors

BackupSelectionProps()

Properties for a BackupSelection.

public BackupSelectionProps()

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK.AWS.Backup;
            using Amazon.CDK.AWS.IAM;

            BackupPlan backupPlan;
            BackupResource backupResource;
            Role role;

            var backupSelectionProps = new BackupSelectionProps {
                BackupPlan = backupPlan,
                Resources = new [] { backupResource },

                // the properties below are optional
                AllowRestores = false,
                BackupSelectionName = "backupSelectionName",
                DisableDefaultBackupPolicy = false,
                Role = role
            };

Properties

AllowRestores

Whether to automatically give restores permissions to the role that AWS Backup uses.

public bool? AllowRestores { get; set; }

Property Value

bool?

Remarks

If true, the AWSBackupServiceRolePolicyForRestores managed policy will be attached to the role.

Default: false

BackupPlan

The backup plan for this selection.

public IBackupPlan BackupPlan { get; set; }

Property Value

IBackupPlan

Remarks

ExampleMetadata: fixture=_generated

BackupSelectionName

The name for this selection.

public string? BackupSelectionName { get; set; }

Property Value

string

Remarks

Default: - a CDK generated name

DisableDefaultBackupPolicy

Whether to disable automatically assigning default backup permissions to the role that AWS Backup uses.

public bool? DisableDefaultBackupPolicy { get; set; }

Property Value

bool?

Remarks

If false, the AWSBackupServiceRolePolicyForBackup managed policy will be attached to the role.

Default: false

Resources

The resources to backup.

public BackupResource[] Resources { get; set; }

Property Value

BackupResource[]

Remarks

Use the helper static methods defined on BackupResource.

Role

The role that AWS Backup uses to authenticate when backuping or restoring the resources.

public IRole? Role { get; set; }

Property Value

IRole

Remarks

The AWSBackupServiceRolePolicyForBackup managed policy will be attached to this role unless disableDefaultBackupPolicy is set to true.

Default: - a new role will be created

Implements

IBackupSelectionProps

IBackupSelectionOptions