Interface CreateBackupRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateBackupRequest.Builder,CreateBackupRequest>, FSxRequest.Builder, SdkBuilder<CreateBackupRequest.Builder,CreateBackupRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateBackupRequest
@Mutable @NotThreadSafe public static interface CreateBackupRequest.Builder extends FSxRequest.Builder, SdkPojo, CopyableBuilder<CreateBackupRequest.Builder,CreateBackupRequest>

  • Method Details

    • fileSystemId

      CreateBackupRequest.Builder fileSystemId(String fileSystemId)

      The ID of the file system to back up.

      Parameters:
      fileSystemId - The ID of the file system to back up.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientRequestToken

      CreateBackupRequest.Builder clientRequestToken(String clientRequestToken)

      (Optional) A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

      Parameters:
      clientRequestToken - (Optional) A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateBackupRequest.Builder tags(Collection<Tag> tags)

      (Optional) The tags to apply to the backup at backup creation. The key value of the Name tag appears in the console as the backup name. If you have set CopyTagsToBackups to true, and you specify one or more tags using the CreateBackup operation, no existing file system tags are copied from the file system to the backup.

      Parameters:
      tags - (Optional) The tags to apply to the backup at backup creation. The key value of the Name tag appears in the console as the backup name. If you have set CopyTagsToBackups to true, and you specify one or more tags using the CreateBackup operation, no existing file system tags are copied from the file system to the backup.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateBackupRequest.Builder tags(Tag... tags)

      (Optional) The tags to apply to the backup at backup creation. The key value of the Name tag appears in the console as the backup name. If you have set CopyTagsToBackups to true, and you specify one or more tags using the CreateBackup operation, no existing file system tags are copied from the file system to the backup.

      Parameters:
      tags - (Optional) The tags to apply to the backup at backup creation. The key value of the Name tag appears in the console as the backup name. If you have set CopyTagsToBackups to true, and you specify one or more tags using the CreateBackup operation, no existing file system tags are copied from the file system to the backup.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

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

      (Optional) The tags to apply to the backup at backup creation. The key value of the Name tag appears in the console as the backup name. If you have set CopyTagsToBackups to true, and you specify one or more tags using the CreateBackup operation, no existing file system tags are copied from the file system to the backup.

      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:

    • volumeId

      CreateBackupRequest.Builder volumeId(String volumeId)

      (Optional) The ID of the FSx for ONTAP volume to back up.

      Parameters:
      volumeId - (Optional) The ID of the FSx for ONTAP volume to back up.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateBackupRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateBackupRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.