Class StartBackupJobRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<StartBackupJobRequest.Builder,
StartBackupJobRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionSpecifies the backup option for a selected resource.final String
The name of a logical container where backups are stored.builder()
final Long
A value in minutes during which a successfully started backup must complete, or else Backup will cancel the job.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the BackupOptions property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the RecoveryPointTags property.final String
Specifies the IAM role ARN used to create the target recovery point; for example,arn:aws:iam::123456789012:role/S3Access
.final String
A customer-chosen string that you can use to distinguish between otherwise identical calls toStartBackupJob
.final Lifecycle
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires.To help organize your resources, you can assign your own metadata to the resources that you create.final String
An Amazon Resource Name (ARN) that uniquely identifies a resource.static Class
<? extends StartBackupJobRequest.Builder> final Long
A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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:
- 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.
-
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
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
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
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 toRUNNING
) or until the job status changes toEXPIRED
(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 toRUNNING
) or until the job status changes toEXPIRED
(which is expected to occur when the start window time is over).
-
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
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 are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of 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 are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of 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 theisEmpty()
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
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.
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:
- 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()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 theisEmpty()
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
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 theWindowsVSS
backup option and create a Windows VSS backup. Set to"WindowsVSS""disabled"
to create a regular backup. TheWindowsVSS
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:
- 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 theWindowsVSS
backup option and create a Windows VSS backup. Set to"WindowsVSS""disabled"
to create a regular backup. TheWindowsVSS
option is not enabled by default.
-
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 interfaceToCopyableBuilder<StartBackupJobRequest.Builder,
StartBackupJobRequest> - Specified by:
toBuilder
in classBackupRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-