Class StartBackupJobRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.backup.model.BackupRequest
software.amazon.awssdk.services.backup.model.StartBackupJobRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartBackupJobRequest.Builder,StartBackupJobRequest>
@Generated("software.amazon.awssdk:codegen") public final class StartBackupJobRequest extends BackupRequest implements ToCopyableBuilder<StartBackupJobRequest.Builder,StartBackupJobRequest>

  • Method Details

    • backupVaultName

      public final 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.

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

    • resourceArn

      public final String resourceArn()

      An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

      Returns:
      An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

    • iamRoleArn

      public final String iamRoleArn()

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

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

    • idempotencyToken

      public final String idempotencyToken()

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

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

    • startWindowMinutes

      public final Long startWindowMinutes()

      A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional, and the default is 8 hours. If this value is included, it must be at least 60 minutes to avoid errors.

      This parameter has a maximum value of 100 years (52,560,000 minutes).

      During the start window, the backup job status remains in CREATED status until it has successfully begun or until the start window time has run out. If within the start window time Backup receives an error that allows the job to be retried, Backup will automatically retry to begin the job at least every 10 minutes until the backup successfully begins (the job status changes to RUNNING) or until the job status changes to EXPIRED (which is expected to occur when the start window time is over).

      Returns:
      A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional, and the default is 8 hours. If this value is included, it must be at least 60 minutes to avoid errors.

      This parameter has a maximum value of 100 years (52,560,000 minutes).

      During the start window, the backup job status remains in CREATED status until it has successfully begun or until the start window time has run out. If within the start window time Backup receives an error that allows the job to be retried, Backup will automatically retry to begin the job at least every 10 minutes until the backup successfully begins (the job status changes to RUNNING) or until the job status changes to EXPIRED (which is expected to occur when the start window time is over).

    • completeWindowMinutes

      public final Long completeWindowMinutes()

      A value in minutes during which a successfully started backup must complete, or else Backup will cancel the job. This value is optional. This value begins counting down from when the backup was scheduled. It does not add additional time for StartWindowMinutes, or if the backup started later than scheduled.

      Like StartWindowMinutes, this parameter has a maximum value of 100 years (52,560,000 minutes).

      Returns:
      A value in minutes during which a successfully started backup must complete, or else Backup will cancel the job. This value is optional. This value begins counting down from when the backup was scheduled. It does not add additional time for StartWindowMinutes, or if the backup started later than scheduled.

      Like StartWindowMinutes, this parameter has a maximum value of 100 years (52,560,000 minutes).

    • lifecycle

      public final Lifecycle lifecycle()

      The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup will transition and expire backups automatically according to the lifecycle that you define.

      Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

      Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types.

      This parameter has a maximum value of 100 years (36,500 days).

      Returns:
      The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup will transition and expire backups automatically according to the lifecycle that you define.

      Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

      Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types.

      This parameter has a maximum value of 100 years (36,500 days).

    • hasRecoveryPointTags

      public final boolean hasRecoveryPointTags()
      For responses, this returns true if the service returned a value for the RecoveryPointTags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • recoveryPointTags

      public final Map<String,String> recoveryPointTags()

      The tags to assign to the resources.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRecoveryPointTags() method.

      Returns:
      The tags to assign to the resources.

    • hasBackupOptions

      public final boolean hasBackupOptions()
      For responses, this returns true if the service returned a value for the BackupOptions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • backupOptions

      public final Map<String,String> backupOptions()

      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. The WindowsVSS option is not enabled by default.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasBackupOptions() method.

      Returns:
      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. The WindowsVSS option is not enabled by default.

    • index

      public final Index index()

      Include this parameter to enable index creation if your backup job has a resource type that supports backup indexes.

      Resource types that support backup indexes include:

      • EBS for Amazon Elastic Block Store

      • S3 for Amazon Simple Storage Service (Amazon S3)

      Index can have 1 of 2 possible values, either ENABLED or DISABLED.

      To create a backup index for an eligible ACTIVE recovery point that does not yet have a backup index, set value to ENABLED.

      To delete a backup index, set value to DISABLED.

      If the service returns an enum value that is not available in the current SDK version, index will return Index.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from indexAsString().

      Returns:
      Include this parameter to enable index creation if your backup job has a resource type that supports backup indexes.

      Resource types that support backup indexes include:

      • EBS for Amazon Elastic Block Store

      • S3 for Amazon Simple Storage Service (Amazon S3)

      Index can have 1 of 2 possible values, either ENABLED or DISABLED.

      To create a backup index for an eligible ACTIVE recovery point that does not yet have a backup index, set value to ENABLED.

      To delete a backup index, set value to DISABLED.

      See Also:

    • indexAsString

      public final String indexAsString()

      Include this parameter to enable index creation if your backup job has a resource type that supports backup indexes.

      Resource types that support backup indexes include:

      • EBS for Amazon Elastic Block Store

      • S3 for Amazon Simple Storage Service (Amazon S3)

      Index can have 1 of 2 possible values, either ENABLED or DISABLED.

      To create a backup index for an eligible ACTIVE recovery point that does not yet have a backup index, set value to ENABLED.

      To delete a backup index, set value to DISABLED.

      If the service returns an enum value that is not available in the current SDK version, index will return Index.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from indexAsString().

      Returns:
      Include this parameter to enable index creation if your backup job has a resource type that supports backup indexes.

      Resource types that support backup indexes include:

      • EBS for Amazon Elastic Block Store

      • S3 for Amazon Simple Storage Service (Amazon S3)

      Index can have 1 of 2 possible values, either ENABLED or DISABLED.

      To create a backup index for an eligible ACTIVE recovery point that does not yet have a backup index, set value to ENABLED.

      To delete a backup index, set value to DISABLED.

      See Also:

    • toBuilder

      public StartBackupJobRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<StartBackupJobRequest.Builder,StartBackupJobRequest>
      Specified by:
      toBuilder in class BackupRequest
      Returns:
      a builder for type T

    • builder

      public static StartBackupJobRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends StartBackupJobRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.