Interface ScanJob.Builder

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

  • Method Details

    • accountId

      ScanJob.Builder accountId(String accountId)

      The account ID that owns the scan job.

      Parameters:
      accountId - The account ID that owns the scan job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • backupVaultArn

      ScanJob.Builder backupVaultArn(String backupVaultArn)

      An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

      Parameters:
      backupVaultArn - An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • backupVaultName

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

      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • completionDate

      ScanJob.Builder completionDate(Instant completionDate)

      The date and time that a scan job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      Parameters:
      completionDate - The date and time that a scan job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createdBy

      ScanJob.Builder createdBy(ScanJobCreator createdBy)

      Contains identifying information about the creation of a scan job.

      Parameters:
      createdBy - Contains identifying information about the creation of a scan job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createdBy

      default ScanJob.Builder createdBy(Consumer<ScanJobCreator.Builder> createdBy)

      Contains identifying information about the creation of a scan job.

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

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

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

    • creationDate

      ScanJob.Builder creationDate(Instant creationDate)

      The date and time that a scan job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      Parameters:
      creationDate - The date and time that a scan job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • iamRoleArn

      ScanJob.Builder iamRoleArn(String iamRoleArn)

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

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

    • malwareScanner

      ScanJob.Builder malwareScanner(String malwareScanner)

      The scanning engine used for the scan job. Currently only GUARDDUTY is supported.

      Parameters:
      malwareScanner - The scanning engine used for the scan job. Currently only GUARDDUTY is supported.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • malwareScanner

      ScanJob.Builder malwareScanner(MalwareScanner malwareScanner)

      The scanning engine used for the scan job. Currently only GUARDDUTY is supported.

      Parameters:
      malwareScanner - The scanning engine used for the scan job. Currently only GUARDDUTY is supported.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • recoveryPointArn

      ScanJob.Builder recoveryPointArn(String recoveryPointArn)

      An ARN that uniquely identifies the recovery point being scanned; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

      Parameters:
      recoveryPointArn - An ARN that uniquely identifies the recovery point being scanned; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45 .
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourceArn

      ScanJob.Builder resourceArn(String resourceArn)

      An ARN that uniquely identifies the source resource of the recovery point being scanned.

      Parameters:
      resourceArn - An ARN that uniquely identifies the source resource of the recovery point being scanned.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourceName

      ScanJob.Builder resourceName(String resourceName)

      The non-unique name of the resource that belongs to the specified backup.

      Parameters:
      resourceName - The non-unique name of the resource that belongs to the specified backup.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourceType

      ScanJob.Builder resourceType(String resourceType)

      The type of Amazon Web Services resource being scanned; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

      Parameters:
      resourceType - The type of Amazon Web Services resource being scanned; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • resourceType

      ScanJob.Builder resourceType(ScanResourceType resourceType)

      The type of Amazon Web Services resource being scanned; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

      Parameters:
      resourceType - The type of Amazon Web Services resource being scanned; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • scanBaseRecoveryPointArn

      ScanJob.Builder scanBaseRecoveryPointArn(String scanBaseRecoveryPointArn)

      An ARN that uniquely identifies the base recovery point for scanning. This field is populated when an incremental scan job has taken place.

      Parameters:
      scanBaseRecoveryPointArn - An ARN that uniquely identifies the base recovery point for scanning. This field is populated when an incremental scan job has taken place.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scanId

      ScanJob.Builder scanId(String scanId)

      The scan ID generated by the malware scanner for the corresponding scan job.

      Parameters:
      scanId - The scan ID generated by the malware scanner for the corresponding scan job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scanJobId

      ScanJob.Builder scanJobId(String scanJobId)

      The unique identifier that identifies the scan job request to Backup.

      Parameters:
      scanJobId - The unique identifier that identifies the scan job request to Backup.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scanMode

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

      ScanJob.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:

    • scanResult

      ScanJob.Builder scanResult(ScanResultInfo scanResult)

      Contains the scan results information, including the status of threats found during scanning.

      Parameters:
      scanResult - Contains the scan results information, including the status of threats found during scanning.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scanResult

      default ScanJob.Builder scanResult(Consumer<ScanResultInfo.Builder> scanResult)

      Contains the scan results information, including the status of threats found during scanning.

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

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

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

    • scannerRoleArn

      ScanJob.Builder scannerRoleArn(String scannerRoleArn)

      Specifies the scanner IAM role ARN used for the scan job.

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

    • state

      ScanJob.Builder state(String state)

      The current state of the scan job.

      Valid values: CREATED | RUNNING | COMPLETED | COMPLETED_WITH_ISSUES | FAILED | CANCELED.

      Parameters:
      state - The current state of the scan job.

      Valid values: CREATED | RUNNING | COMPLETED | COMPLETED_WITH_ISSUES | FAILED | CANCELED.

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

    • state

      ScanJob.Builder state(ScanState state)

      The current state of the scan job.

      Valid values: CREATED | RUNNING | COMPLETED | COMPLETED_WITH_ISSUES | FAILED | CANCELED.

      Parameters:
      state - The current state of the scan job.

      Valid values: CREATED | RUNNING | COMPLETED | COMPLETED_WITH_ISSUES | FAILED | CANCELED.

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

    • statusMessage

      ScanJob.Builder statusMessage(String statusMessage)

      A detailed message explaining the status of the scan job.

      Parameters:
      statusMessage - A detailed message explaining the status of the scan job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.