software.amazon.awssdk.services.fsx.model

Interface Backup.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Backup.Builder,Backup>, SdkBuilder<Backup.Builder,Backup>, SdkPojo

Enclosing class:

Backup

public static interface Backup.Builder
extends SdkPojo, CopyableBuilder<Backup.Builder,Backup>

Method Summary

Modifier and Type	Method and Description
Backup.Builder	backupId(String backupId) The ID of the backup.
Backup.Builder	creationTime(Instant creationTime) The time when a particular backup was created.
Backup.Builder	directoryInformation(ActiveDirectoryBackupAttributes directoryInformation) The configuration of the self-managed Microsoft Active Directory (AD) to which the Windows File Server instance is joined.
default Backup.Builder	directoryInformation(Consumer<ActiveDirectoryBackupAttributes.Builder> directoryInformation) The configuration of the self-managed Microsoft Active Directory (AD) to which the Windows File Server instance is joined.
Backup.Builder	failureDetails(BackupFailureDetails failureDetails) Details explaining any failures that occur when creating a backup.
default Backup.Builder	failureDetails(Consumer<BackupFailureDetails.Builder> failureDetails) Details explaining any failures that occur when creating a backup.
default Backup.Builder	fileSystem(Consumer<FileSystem.Builder> fileSystem) Metadata of the file system associated with the backup.
Backup.Builder	fileSystem(FileSystem fileSystem) Metadata of the file system associated with the backup.
Backup.Builder	kmsKeyId(String kmsKeyId) The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the backup of the Amazon FSx file system's data at rest.
Backup.Builder	lifecycle(BackupLifecycle lifecycle) The lifecycle status of the backup.
Backup.Builder	lifecycle(String lifecycle) The lifecycle status of the backup.
Backup.Builder	ownerId(String ownerId) Sets the value of the OwnerId property for this object.
Backup.Builder	progressPercent(Integer progressPercent) Sets the value of the ProgressPercent property for this object.
Backup.Builder	resourceARN(String resourceARN) The Amazon Resource Name (ARN) for the backup resource.
Backup.Builder	sourceBackupId(String sourceBackupId) Sets the value of the SourceBackupId property for this object.
Backup.Builder	sourceBackupRegion(String sourceBackupRegion) The source Region of the backup.
Backup.Builder	tags(Collection<Tag> tags) Tags associated with a particular file system.
Backup.Builder	tags(Consumer<Tag.Builder>... tags) Tags associated with a particular file system.
Backup.Builder	tags(Tag... tags) Tags associated with a particular file system.
Backup.Builder	type(BackupType type) The type of the file system backup.
Backup.Builder	type(String type) The type of the file system backup.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

backupId

Backup.Builder backupId(String backupId)

The ID of the backup.

Parameters:

backupId - The ID of the backup.

Returns:

Returns a reference to this object so that method calls can be chained together.

lifecycle

Backup.Builder lifecycle(String lifecycle)

The lifecycle status of the backup.

• AVAILABLE - The backup is fully available.

• PENDING - For user-initiated backups on Lustre file systems only; Amazon FSx has not started creating the backup.

• CREATING - Amazon FSx is creating the backup.

• TRANSFERRING - For user-initiated backups on Lustre file systems only; Amazon FSx is transferring the backup to S3.

• COPYING - Amazon FSx is copying the backup.

• DELETED - Amazon FSx deleted the backup and it is no longer available.

• FAILED - Amazon FSx could not complete the backup.

Parameters:

lifecycle - The lifecycle status of the backup.

• AVAILABLE - The backup is fully available.

• PENDING - For user-initiated backups on Lustre file systems only; Amazon FSx has not started creating the backup.

• CREATING - Amazon FSx is creating the backup.

• TRANSFERRING - For user-initiated backups on Lustre file systems only; Amazon FSx is transferring the backup to S3.

• COPYING - Amazon FSx is copying the backup.

• DELETED - Amazon FSx deleted the backup and it is no longer available.

• FAILED - Amazon FSx could not complete the backup.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

BackupLifecycle, BackupLifecycle

lifecycle

Backup.Builder lifecycle(BackupLifecycle lifecycle)

The lifecycle status of the backup.

• AVAILABLE - The backup is fully available.

• PENDING - For user-initiated backups on Lustre file systems only; Amazon FSx has not started creating the backup.

• CREATING - Amazon FSx is creating the backup.

• TRANSFERRING - For user-initiated backups on Lustre file systems only; Amazon FSx is transferring the backup to S3.

• COPYING - Amazon FSx is copying the backup.

• DELETED - Amazon FSx deleted the backup and it is no longer available.

• FAILED - Amazon FSx could not complete the backup.

Parameters:

lifecycle - The lifecycle status of the backup.

• AVAILABLE - The backup is fully available.

• PENDING - For user-initiated backups on Lustre file systems only; Amazon FSx has not started creating the backup.

• CREATING - Amazon FSx is creating the backup.

• TRANSFERRING - For user-initiated backups on Lustre file systems only; Amazon FSx is transferring the backup to S3.

• COPYING - Amazon FSx is copying the backup.

• DELETED - Amazon FSx deleted the backup and it is no longer available.

• FAILED - Amazon FSx could not complete the backup.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

BackupLifecycle, BackupLifecycle

failureDetails

Backup.Builder failureDetails(BackupFailureDetails failureDetails)

Details explaining any failures that occur when creating a backup.

Parameters:

failureDetails - Details explaining any failures that occur when creating a backup.

Returns:

Returns a reference to this object so that method calls can be chained together.

failureDetails

default Backup.Builder failureDetails(Consumer<BackupFailureDetails.Builder> failureDetails)

Details explaining any failures that occur when creating a backup.

This is a convenience that creates an instance of the BackupFailureDetails.Builder avoiding the need to create one manually via BackupFailureDetails.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to failureDetails(BackupFailureDetails).

Parameters:

failureDetails - a consumer that will call methods on BackupFailureDetails.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

failureDetails(BackupFailureDetails)

type

Backup.Builder type(String type)

The type of the file system backup.

Parameters:

type - The type of the file system backup.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

BackupType, BackupType

type

Backup.Builder type(BackupType type)

The type of the file system backup.

Parameters:

type - The type of the file system backup.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

BackupType, BackupType

progressPercent

Backup.Builder progressPercent(Integer progressPercent)

Sets the value of the ProgressPercent property for this object.

Parameters:

progressPercent - The new value for the ProgressPercent property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

creationTime

Backup.Builder creationTime(Instant creationTime)

The time when a particular backup was created.

Parameters:

creationTime - The time when a particular backup was created.

Returns:

Returns a reference to this object so that method calls can be chained together.

kmsKeyId

Backup.Builder kmsKeyId(String kmsKeyId)

The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the backup of the Amazon FSx file system's data at rest.

Parameters:

kmsKeyId - The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the backup of the Amazon FSx file system's data at rest.

Returns:

Returns a reference to this object so that method calls can be chained together.

resourceARN

Backup.Builder resourceARN(String resourceARN)

The Amazon Resource Name (ARN) for the backup resource.

Parameters:

resourceARN - The Amazon Resource Name (ARN) for the backup resource.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

Backup.Builder tags(Collection<Tag> tags)

Tags associated with a particular file system.

Parameters:

tags - Tags associated with a particular file system.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

Backup.Builder tags(Tag... tags)

Tags associated with a particular file system.

Parameters:

tags - Tags associated with a particular file system.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

Backup.Builder tags(Consumer<Tag.Builder>... tags)

Tags associated with a particular file system.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#tags(List)

fileSystem

Backup.Builder fileSystem(FileSystem fileSystem)

Metadata of the file system associated with the backup. This metadata is persisted even if the file system is deleted.

Parameters:

fileSystem - Metadata of the file system associated with the backup. This metadata is persisted even if the file system is deleted.

Returns:

Returns a reference to this object so that method calls can be chained together.

fileSystem

default Backup.Builder fileSystem(Consumer<FileSystem.Builder> fileSystem)

Metadata of the file system associated with the backup. This metadata is persisted even if the file system is deleted.

This is a convenience that creates an instance of the FileSystem.Builder avoiding the need to create one manually via FileSystem.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to fileSystem(FileSystem).

Parameters:

fileSystem - a consumer that will call methods on FileSystem.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

fileSystem(FileSystem)

directoryInformation

Backup.Builder directoryInformation(ActiveDirectoryBackupAttributes directoryInformation)

The configuration of the self-managed Microsoft Active Directory (AD) to which the Windows File Server instance is joined.

Parameters:

directoryInformation - The configuration of the self-managed Microsoft Active Directory (AD) to which the Windows File Server instance is joined.

Returns:

Returns a reference to this object so that method calls can be chained together.

directoryInformation

default Backup.Builder directoryInformation(Consumer<ActiveDirectoryBackupAttributes.Builder> directoryInformation)

The configuration of the self-managed Microsoft Active Directory (AD) to which the Windows File Server instance is joined.

This is a convenience that creates an instance of the ActiveDirectoryBackupAttributes.Builder avoiding the need to create one manually via ActiveDirectoryBackupAttributes.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to directoryInformation(ActiveDirectoryBackupAttributes).

Parameters:

directoryInformation - a consumer that will call methods on ActiveDirectoryBackupAttributes.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

directoryInformation(ActiveDirectoryBackupAttributes)

ownerId

Backup.Builder ownerId(String ownerId)

Sets the value of the OwnerId property for this object.

Parameters:

ownerId - The new value for the OwnerId property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

sourceBackupId

Backup.Builder sourceBackupId(String sourceBackupId)

Sets the value of the SourceBackupId property for this object.

Parameters:

sourceBackupId - The new value for the SourceBackupId property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

sourceBackupRegion

Backup.Builder sourceBackupRegion(String sourceBackupRegion)

The source Region of the backup. Specifies the Region from where this backup is copied.

Parameters:

sourceBackupRegion - The source Region of the backup. Specifies the Region from where this backup is copied.

Returns:

Returns a reference to this object so that method calls can be chained together.