Interface StartScanJobRequest.Builder

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

  • Method Details

    • backupVaultName

      StartScanJobRequest.Builder backupVaultName(String backupVaultName)

      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.

      Pattern: ^[a-zA-Z0-9\-\_]{2,50}$

      Parameters:
      backupVaultName - The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.

      Pattern: ^[a-zA-Z0-9\-\_]{2,50}$

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

    • iamRoleArn

      StartScanJobRequest.Builder iamRoleArn(String iamRoleArn)

      Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

      Parameters:
      iamRoleArn - Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • idempotencyToken

      StartScanJobRequest.Builder idempotencyToken(String idempotencyToken)

      A customer-chosen string that you can use to distinguish between otherwise identical calls to StartScanJob. Retrying a successful request with the same idempotency token results in a success message with no action taken.

      Parameters:
      idempotencyToken - A customer-chosen string that you can use to distinguish between otherwise identical calls to StartScanJob. Retrying a successful request with the same idempotency token results in a success message with no action taken.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • malwareScanner

      StartScanJobRequest.Builder malwareScanner(String malwareScanner)

      Specifies the malware scanner used during the scan job. Currently only supports GUARDDUTY.

      Parameters:
      malwareScanner - Specifies the malware scanner used during the scan job. Currently only supports GUARDDUTY .
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • malwareScanner

      StartScanJobRequest.Builder malwareScanner(MalwareScanner malwareScanner)

      Specifies the malware scanner used during the scan job. Currently only supports GUARDDUTY.

      Parameters:
      malwareScanner - Specifies the malware scanner used during the scan job. Currently only supports GUARDDUTY .
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • recoveryPointArn

      StartScanJobRequest.Builder recoveryPointArn(String recoveryPointArn)

      An Amazon Resource Name (ARN) that uniquely identifies a recovery point. This is your target recovery point for a full scan. If you are running an incremental scan, this will be your a recovery point which has been created after your base recovery point selection.

      Parameters:
      recoveryPointArn - An Amazon Resource Name (ARN) that uniquely identifies a recovery point. This is your target recovery point for a full scan. If you are running an incremental scan, this will be your a recovery point which has been created after your base recovery point selection.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scanBaseRecoveryPointArn

      StartScanJobRequest.Builder scanBaseRecoveryPointArn(String scanBaseRecoveryPointArn)

      An ARN that uniquely identifies the base recovery point to be used for incremental scanning.

      Parameters:
      scanBaseRecoveryPointArn - An ARN that uniquely identifies the base recovery point to be used for incremental scanning.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scanMode

      StartScanJobRequest.Builder scanMode(String scanMode)

      Specifies the scan type use for the scan job.

      Includes:

      • FULL_SCAN will scan the entire data lineage within the backup.

      • INCREMENTAL_SCAN will scan the data difference between the target recovery point and base recovery point ARN.

      Parameters:
      scanMode - Specifies the scan type use for the scan job.

      Includes:

      • FULL_SCAN will scan the entire data lineage within the backup.

      • INCREMENTAL_SCAN will scan the data difference between the target recovery point and base recovery point ARN.

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

    • scanMode

      StartScanJobRequest.Builder scanMode(ScanMode scanMode)

      Specifies the scan type use for the scan job.

      Includes:

      • FULL_SCAN will scan the entire data lineage within the backup.

      • INCREMENTAL_SCAN will scan the data difference between the target recovery point and base recovery point ARN.

      Parameters:
      scanMode - Specifies the scan type use for the scan job.

      Includes:

      • FULL_SCAN will scan the entire data lineage within the backup.

      • INCREMENTAL_SCAN will scan the data difference between the target recovery point and base recovery point ARN.

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

    • scannerRoleArn

      StartScanJobRequest.Builder scannerRoleArn(String scannerRoleArn)

      Specified the IAM scanner role ARN.

      Parameters:
      scannerRoleArn - Specified the IAM scanner role ARN.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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