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

Class CreateLogicallyAirGappedBackupVaultRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateLogicallyAirGappedBackupVaultRequest.Builder,CreateLogicallyAirGappedBackupVaultRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateLogicallyAirGappedBackupVaultRequest
extends BackupRequest
implements ToCopyableBuilder<CreateLogicallyAirGappedBackupVaultRequest.Builder,CreateLogicallyAirGappedBackupVaultRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateLogicallyAirGappedBackupVaultRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	backupVaultName()	This is the name of the vault that is being created.
Map<String,String>	backupVaultTags()	These are the tags that will be included in the newly-created vault.
static CreateLogicallyAirGappedBackupVaultRequest.Builder	builder()
String	creatorRequestId()	This is the ID of the creation request.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasBackupVaultTags()	For responses, this returns true if the service returned a value for the BackupVaultTags property.
int	hashCode()
Long	maxRetentionDays()	This is the setting that specifies the maximum retention period that the vault retains its recovery points.
Long	minRetentionDays()	This setting specifies the minimum retention period that the vault retains its recovery points.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateLogicallyAirGappedBackupVaultRequest.Builder>	serializableBuilderClass()
CreateLogicallyAirGappedBackupVaultRequest.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()

This is the name of the vault that is being created.

Returns:

This is the name of the vault that is being created.

hasBackupVaultTags

public final boolean hasBackupVaultTags()

For responses, this returns true if the service returned a value for the BackupVaultTags 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.

backupVaultTags

public final Map<String,String> backupVaultTags()

These are the tags that will be included in the newly-created vault.

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 hasBackupVaultTags() method.

Returns:

These are the tags that will be included in the newly-created vault.

creatorRequestId

public final String creatorRequestId()

This is the ID of the creation request.

This parameter is optional. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

Returns:

This is the ID of the creation request.

This parameter is optional. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

minRetentionDays

public final Long minRetentionDays()

This setting specifies the minimum retention period that the vault retains its recovery points. If this parameter is not specified, no minimum retention period is enforced.

If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If a job retention period is shorter than that minimum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault.

Returns:

This setting specifies the minimum retention period that the vault retains its recovery points. If this parameter is not specified, no minimum retention period is enforced.

If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If a job retention period is shorter than that minimum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault.

maxRetentionDays

public final Long maxRetentionDays()

This is the setting that specifies the maximum retention period that the vault retains its recovery points. If this parameter is not specified, Backup does not enforce a maximum retention period on the recovery points in the vault (allowing indefinite storage).

If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period. If the job retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault.

Returns:

This is the setting that specifies the maximum retention period that the vault retains its recovery points. If this parameter is not specified, Backup does not enforce a maximum retention period on the recovery points in the vault (allowing indefinite storage).

If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period. If the job retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault.

toBuilder

public CreateLogicallyAirGappedBackupVaultRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateLogicallyAirGappedBackupVaultRequest.Builder,CreateLogicallyAirGappedBackupVaultRequest>

Specified by:

toBuilder in class BackupRequest

builder

public static CreateLogicallyAirGappedBackupVaultRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateLogicallyAirGappedBackupVaultRequest.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