Package software.amazon.awssdk.services.backup.model

Interface BackupJob.Builder

    • Method Detail

      • accountId

        BackupJob.Builder accountId​(String accountId)

        The account ID that owns the backup job.

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

      • backupJobId

        BackupJob.Builder backupJobId​(String backupJobId)

        Uniquely identifies a request to Backup to back up a resource.

        Parameters:
        backupJobId - Uniquely identifies a request to Backup to back up a resource.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • backupVaultName

        BackupJob.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. They consist of lowercase letters, numbers, and hyphens.

        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. They consist of lowercase letters, numbers, and hyphens.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • backupVaultArn

        BackupJob.Builder backupVaultArn​(String backupVaultArn)

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

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

      • recoveryPointArn

        BackupJob.Builder recoveryPointArn​(String recoveryPointArn)

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

        Parameters:
        recoveryPointArn - An ARN that uniquely identifies a recovery point; 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

        BackupJob.Builder resourceArn​(String resourceArn)

        An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.

        Parameters:
        resourceArn - An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • creationDate

        BackupJob.Builder creationDate​(Instant creationDate)

        The date and time a backup 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 a backup 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.

      • completionDate

        BackupJob.Builder completionDate​(Instant completionDate)

        The date and time a job to create a backup 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 a job to create a backup 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.

      • state

        BackupJob.Builder state​(String state)

        The current state of a backup job.

        Parameters:
        state - The current state of a backup job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        BackupJobState, BackupJobState

      • statusMessage

        BackupJob.Builder statusMessage​(String statusMessage)

        A detailed message explaining the status of the job to back up a resource.

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

      • percentDone

        BackupJob.Builder percentDone​(String percentDone)

        Contains an estimated percentage complete of a job at the time the job status was queried.

        Parameters:
        percentDone - Contains an estimated percentage complete of a job at the time the job status was queried.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • backupSizeInBytes

        BackupJob.Builder backupSizeInBytes​(Long backupSizeInBytes)

        The size, in bytes, of a backup.

        Parameters:
        backupSizeInBytes - The size, in bytes, of a backup.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • iamRoleArn

        BackupJob.Builder iamRoleArn​(String iamRoleArn)

        Specifies the IAM role ARN used to create the target recovery point. IAM roles other than the default role must include either AWSBackup or AwsBackup in the role name. For example, arn:aws:iam::123456789012:role/AWSBackupRDSAccess. Role names without those strings lack permissions to perform backup jobs.

        Parameters:
        iamRoleArn - Specifies the IAM role ARN used to create the target recovery point. IAM roles other than the default role must include either AWSBackup or AwsBackup in the role name. For example, arn:aws:iam::123456789012:role/AWSBackupRDSAccess. Role names without those strings lack permissions to perform backup jobs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • createdBy

        BackupJob.Builder createdBy​(RecoveryPointCreator createdBy)

        Contains identifying information about the creation of a backup job, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan used to create it.

        Parameters:
        createdBy - Contains identifying information about the creation of a backup job, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan used to create it.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • expectedCompletionDate

        BackupJob.Builder expectedCompletionDate​(Instant expectedCompletionDate)

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

        Parameters:
        expectedCompletionDate - The date and time a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of ExpectedCompletionDate 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.

      • startBy

        BackupJob.Builder startBy​(Instant startBy)

        Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on the date specified. The value of StartBy is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        Parameters:
        startBy - Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on the date specified. The value of StartBy 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.

      • resourceType

        BackupJob.Builder resourceType​(String resourceType)

        The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.

        Parameters:
        resourceType - The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • bytesTransferred

        BackupJob.Builder bytesTransferred​(Long bytesTransferred)

        The size in bytes transferred to a backup vault at the time that the job status was queried.

        Parameters:
        bytesTransferred - The size in bytes transferred to a backup vault at the time that the job status was queried.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • backupOptions

        BackupJob.Builder backupOptions​(Map<String,​String> backupOptions)

        Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.

        Valid values: Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup. Set to "WindowsVSS":"disabled" to create a regular backup. If you specify an invalid option, you get an InvalidParameterValueException exception.

        Parameters:
        backupOptions - Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.

        Valid values: Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup. Set to "WindowsVSS":"disabled" to create a regular backup. If you specify an invalid option, you get an InvalidParameterValueException exception.

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

      • backupType

        BackupJob.Builder backupType​(String backupType)

        Represents the type of backup for a backup job.

        Parameters:
        backupType - Represents the type of backup for a backup job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • parentJobId

        BackupJob.Builder parentJobId​(String parentJobId)

        This uniquely identifies a request to Backup to back up a resource. The return will be the parent (composite) job ID.

        Parameters:
        parentJobId - This uniquely identifies a request to Backup to back up a resource. The return will be the parent (composite) job ID.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • isParent

        BackupJob.Builder isParent​(Boolean isParent)

        This is a boolean value indicating this is a parent (composite) backup job.

        Parameters:
        isParent - This is a boolean value indicating this is a parent (composite) backup job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • resourceName

        BackupJob.Builder resourceName​(String resourceName)

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

        Parameters:
        resourceName - This is 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.

      • initiationDate

        BackupJob.Builder initiationDate​(Instant initiationDate)

        This is the date on which the backup job was initiated.

        Parameters:
        initiationDate - This is the date on which the backup job was initiated.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • messageCategory

        BackupJob.Builder messageCategory​(String messageCategory)

        This parameter is the job count for the specified message category.

        Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and INVALIDPARAMETERS. See Monitoring for a list of MessageCategory strings.

        The the value ANY returns count of all message categories.

        AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.

        Parameters:
        messageCategory - This parameter is the job count for the specified message category.

        Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and INVALIDPARAMETERS. See Monitoring for a list of MessageCategory strings.

        The the value ANY returns count of all message categories.

        AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.

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