Package software.amazon.awscdk.services.backup

Class BackupSelectionOptions.Builder

java.lang.Object

software.amazon.awscdk.services.backup.BackupSelectionOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<BackupSelectionOptions>

Enclosing interface:

BackupSelectionOptions

@Stability(Stable)
public static final class BackupSelectionOptions.Builder
extends Object
implements software.amazon.jsii.Builder<BackupSelectionOptions>

A builder for BackupSelectionOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
BackupSelectionOptions.Builder	allowRestores(Boolean allowRestores)	Sets the value of BackupSelectionOptions.getAllowRestores()
BackupSelectionOptions.Builder	backupSelectionName(String backupSelectionName)	Sets the value of BackupSelectionOptions.getBackupSelectionName()
BackupSelectionOptions	build()	Builds the configured instance.
BackupSelectionOptions.Builder	disableDefaultBackupPolicy(Boolean disableDefaultBackupPolicy)	Sets the value of BackupSelectionOptions.getDisableDefaultBackupPolicy()
BackupSelectionOptions.Builder	resources(List<? extends BackupResource> resources)	Sets the value of BackupSelectionOptions.getResources()
BackupSelectionOptions.Builder	role(IRole role)	Sets the value of BackupSelectionOptions.getRole()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

resources

@Stability(Stable)
public BackupSelectionOptions.Builder resources(List<? extends BackupResource> resources)

Sets the value of BackupSelectionOptions.getResources()

Parameters:

resources - The resources to backup. This parameter is required. Use the helper static methods defined on BackupResource.

Returns:

this

allowRestores

@Stability(Stable)
public BackupSelectionOptions.Builder allowRestores(Boolean allowRestores)

Sets the value of BackupSelectionOptions.getAllowRestores()

Parameters:

allowRestores - Whether to automatically give restores permissions to the role that AWS Backup uses. If true, the AWSBackupServiceRolePolicyForRestores managed policy will be attached to the role.

Returns:

this

backupSelectionName

@Stability(Stable)
public BackupSelectionOptions.Builder backupSelectionName(String backupSelectionName)

Sets the value of BackupSelectionOptions.getBackupSelectionName()

Parameters:

backupSelectionName - The name for this selection.

Returns:

this

disableDefaultBackupPolicy

@Stability(Stable)
public BackupSelectionOptions.Builder disableDefaultBackupPolicy(Boolean disableDefaultBackupPolicy)

Sets the value of BackupSelectionOptions.getDisableDefaultBackupPolicy()

Parameters:

disableDefaultBackupPolicy - Whether to disable automatically assigning default backup permissions to the role that AWS Backup uses. If false, the AWSBackupServiceRolePolicyForBackup managed policy will be attached to the role.

Returns:

this

role

@Stability(Stable)
public BackupSelectionOptions.Builder role(IRole role)

Sets the value of BackupSelectionOptions.getRole()

Parameters:

role - The role that AWS Backup uses to authenticate when backuping or restoring the resources. The AWSBackupServiceRolePolicyForBackup managed policy will be attached to this role unless disableDefaultBackupPolicy is set to true.

Returns:

this

build

@Stability(Stable)
public BackupSelectionOptions build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<BackupSelectionOptions>

Returns:

a new instance of BackupSelectionOptions

Throws:

NullPointerException - if any required attribute was not provided