amazonka-backup-2.0: Amazon Backup SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Backup.Types.AdvancedBackupSetting

Description

 
Synopsis

Documentation

data AdvancedBackupSetting Source #

A list of backup options for each resource type.

See: newAdvancedBackupSetting smart constructor.

Constructors

AdvancedBackupSetting' 

Fields

  • backupOptions :: Maybe (HashMap Text Text)

    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.

  • resourceType :: Maybe Text

    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.

Instances

Instances details
FromJSON AdvancedBackupSetting Source # 
Instance details

Defined in Amazonka.Backup.Types.AdvancedBackupSetting

ToJSON AdvancedBackupSetting Source # 
Instance details

Defined in Amazonka.Backup.Types.AdvancedBackupSetting

Generic AdvancedBackupSetting Source # 
Instance details

Defined in Amazonka.Backup.Types.AdvancedBackupSetting

Associated Types

type Rep AdvancedBackupSetting :: Type -> Type #

Read AdvancedBackupSetting Source # 
Instance details

Defined in Amazonka.Backup.Types.AdvancedBackupSetting

Show AdvancedBackupSetting Source # 
Instance details

Defined in Amazonka.Backup.Types.AdvancedBackupSetting

NFData AdvancedBackupSetting Source # 
Instance details

Defined in Amazonka.Backup.Types.AdvancedBackupSetting

Methods

rnf :: AdvancedBackupSetting -> () #

Eq AdvancedBackupSetting Source # 
Instance details

Defined in Amazonka.Backup.Types.AdvancedBackupSetting

Hashable AdvancedBackupSetting Source # 
Instance details

Defined in Amazonka.Backup.Types.AdvancedBackupSetting

type Rep AdvancedBackupSetting Source # 
Instance details

Defined in Amazonka.Backup.Types.AdvancedBackupSetting

type Rep AdvancedBackupSetting = D1 ('MetaData "AdvancedBackupSetting" "Amazonka.Backup.Types.AdvancedBackupSetting" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "AdvancedBackupSetting'" 'PrefixI 'True) (S1 ('MetaSel ('Just "backupOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newAdvancedBackupSetting :: AdvancedBackupSetting Source #

Create a value of AdvancedBackupSetting with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:backupOptions:AdvancedBackupSetting', advancedBackupSetting_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.

$sel:resourceType:AdvancedBackupSetting', advancedBackupSetting_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.

advancedBackupSetting_backupOptions :: Lens' AdvancedBackupSetting (Maybe (HashMap Text Text)) Source #

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.

advancedBackupSetting_resourceType :: Lens' AdvancedBackupSetting (Maybe Text) Source #

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.