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

Class AdvancedBackupSetting

java.lang.Object

software.amazon.awssdk.services.backup.model.AdvancedBackupSetting

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AdvancedBackupSetting.Builder,AdvancedBackupSetting>

@Generated("software.amazon.awssdk:codegen")
public final class AdvancedBackupSetting
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AdvancedBackupSetting.Builder,AdvancedBackupSetting>

A list of backup options for each resource type.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AdvancedBackupSetting.Builder

Method Summary

Modifier and Type	Method	Description
Map<String,String>	backupOptions()	Specifies the backup option for a selected resource.
static AdvancedBackupSetting.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasBackupOptions()	For responses, this returns true if the service returned a value for the BackupOptions property.
int	hashCode()
String	resourceType()	Specifies an object containing resource type and backup options.
List<SdkField<?>>	sdkFields()
static Class<? extends AdvancedBackupSetting.Builder>	serializableBuilderClass()
AdvancedBackupSetting.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

resourceType

public final String resourceType()

Specifies an object containing resource type and backup options. The only supported resource type is Amazon EC2 instances with Windows Volume Shadow Copy Service (VSS). For a CloudFormation example, see the sample CloudFormation template to enable Windows VSS in the Backup User Guide.

Valid values: EC2.

Returns:

Specifies an object containing resource type and backup options. The only supported resource type is Amazon EC2 instances with Windows Volume Shadow Copy Service (VSS). For a CloudFormation example, see the sample CloudFormation template to enable Windows VSS in the Backup User Guide.

Valid values: EC2.

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()

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

If you specify an invalid option, you get an InvalidParameterValueException exception.

For more information about Windows VSS backups, see Creating a VSS-Enabled Windows Backup.

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

If you specify an invalid option, you get an InvalidParameterValueException exception.

For more information about Windows VSS backups, see Creating a VSS-Enabled Windows Backup.

toBuilder

public AdvancedBackupSetting.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AdvancedBackupSetting.Builder,AdvancedBackupSetting>

builder

public static AdvancedBackupSetting.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo