software.amazon.awssdk.services.backup.model

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(value="software.amazon.awssdk:codegen")
public final class StartBackupJobRequest
extends BackupRequest
implements ToCopyableBuilder<StartBackupJobRequest.Builder,StartBackupJobRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StartBackupJobRequest.Builder

Method Summary

Modifier and Type	Method and Description
Map<String,String>	backupOptions() Specifies the backup option for a selected resource.
String	backupVaultName() The name of a logical container where backups are stored.
static StartBackupJobRequest.Builder	builder()
Long	completeWindowMinutes() A value in minutes during which a successfully started backup must complete, or else AWS Backup will cancel the job.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasBackupOptions() Returns true if the BackupOptions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasRecoveryPointTags() Returns true if the RecoveryPointTags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	iamRoleArn() Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
String	idempotencyToken() A customer chosen string that can be used to distinguish between calls to StartBackupJob.
Lifecycle	lifecycle() The lifecycle defines when a protected resource is transitioned to cold storage and when it expires.
Map<String,String>	recoveryPointTags() To help organize your resources, you can assign your own metadata to the resources that you create.
String	resourceArn() An Amazon Resource Name (ARN) that uniquely identifies a resource.
List<SdkField<?>>	sdkFields()
static Class<? extends StartBackupJobRequest.Builder>	serializableBuilderClass()
Long	startWindowMinutes() A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully.
StartBackupJobRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

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 can be used to distinguish between calls to StartBackupJob.

Returns:

A customer chosen string that can be used to distinguish between calls to StartBackupJob.

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.

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.

completeWindowMinutes

public final Long completeWindowMinutes()

A value in minutes during which a successfully started backup must complete, or else AWS 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.

Returns:

A value in minutes during which a successfully started backup must complete, or else AWS 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.

lifecycle

public final Lifecycle lifecycle()

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS 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 “expire after days” 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.

Only Amazon EFS file system backups can be transitioned to cold storage.

Returns:

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS 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 “expire after days” 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.

Only Amazon EFS file system backups can be transitioned to cold storage.

hasRecoveryPointTags

public final boolean hasRecoveryPointTags()

Returns true if the RecoveryPointTags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

recoveryPointTags

public final Map<String,String> recoveryPointTags()

To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.

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

You can use hasRecoveryPointTags() to see if a value was sent in this field.

Returns:

To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.

hasBackupOptions

public final boolean hasBackupOptions()

Returns true if the BackupOptions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

backupOptions

public final Map<String,String> backupOptions()

Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.

Valid values: Set to "WindowsVSS”:“enabled" to enable WindowsVSS backup option and create a VSS Windows 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.

You can use hasBackupOptions() to see if a value was sent in this field.

Returns:

Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.

Valid values: Set to "WindowsVSS”:“enabled" to enable WindowsVSS backup option and create a VSS Windows backup. Set to “WindowsVSS”:”disabled” to create a regular backup. The WindowsVSS option is not enabled by default.

toBuilder

public StartBackupJobRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartBackupJobRequest.Builder,StartBackupJobRequest>

Specified by:

toBuilder in class BackupRequest

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo