Package 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 Details

    • 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 hasn't 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 Amazon S3.

      • COPYING - Amazon FSx is copying the backup.

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

      • FAILED - Amazon FSx couldn't finish 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 hasn't 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 Amazon S3.

      • COPYING - Amazon FSx is copying the backup.

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

      • FAILED - Amazon FSx couldn't finish the backup.

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

    • 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 hasn't 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 Amazon S3.

      • COPYING - Amazon FSx is copying the backup.

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

      • FAILED - Amazon FSx couldn't finish 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 hasn't 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 Amazon S3.

      • COPYING - Amazon FSx is copying the backup.

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

      • FAILED - Amazon FSx couldn't finish the backup.

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

    • failureDetails

      Backup.Builder failureDetails(BackupFailureDetails failureDetails)

      Details explaining any failures that occurred when creating a backup.

      Parameters:
      failureDetails - Details explaining any failures that occurred 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 occurred when creating a backup.

      This is a convenience method 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:

    • 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:

    • 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:

    • 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 Key Management Service (KMS) key used to encrypt the backup of the Amazon FSx file system's data at rest.

      Parameters:
      kmsKeyId - The ID of the Key Management Service (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)

      The tags associated with a particular file system.

      Parameters:
      tags - The 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)

      The tags associated with a particular file system.

      Parameters:
      tags - The 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)

      The tags associated with a particular file system.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • fileSystem

      Backup.Builder fileSystem(FileSystem fileSystem)

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

      Parameters:
      fileSystem - The 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)

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

      This is a convenience method 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:

    • directoryInformation

      Backup.Builder directoryInformation(ActiveDirectoryBackupAttributes directoryInformation)

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

      Parameters:
      directoryInformation - The configuration of the self-managed Microsoft Active Directory directory 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 directory to which the Windows File Server instance is joined.

      This is a convenience method 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:

    • 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.

    • resourceType

      Backup.Builder resourceType(String resourceType)

      Specifies the resource type that's backed up.

      Parameters:
      resourceType - Specifies the resource type that's backed up.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • resourceType

      Backup.Builder resourceType(ResourceType resourceType)

      Specifies the resource type that's backed up.

      Parameters:
      resourceType - Specifies the resource type that's backed up.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • volume

      Backup.Builder volume(Volume volume)
      Sets the value of the Volume property for this object.
      Parameters:
      volume - The new value for the Volume property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • volume

      default Backup.Builder volume(Consumer<Volume.Builder> volume)
      Sets the value of the Volume property for this object. This is a convenience method that creates an instance of the Volume.Builder avoiding the need to create one manually via Volume.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to volume(Volume).

      Parameters:
      volume - a consumer that will call methods on Volume.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: