Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.OpsWorksCM.Types.Backup

Description

Synopsis

data Backup = Backup' {
- backupArn :: Maybe Text
- backupId :: Maybe Text
- backupType :: Maybe BackupType
- createdAt :: Maybe POSIX
- description :: Maybe Text
- engine :: Maybe Text
- engineModel :: Maybe Text
- engineVersion :: Maybe Text
- instanceProfileArn :: Maybe Text
- instanceType :: Maybe Text
- keyPair :: Maybe Text
- preferredBackupWindow :: Maybe Text
- preferredMaintenanceWindow :: Maybe Text
- s3DataSize :: Maybe Int
- s3DataUrl :: Maybe Text
- s3LogUrl :: Maybe Text
- securityGroupIds :: Maybe [Text]
- serverName :: Maybe Text
- serviceRoleArn :: Maybe Text
- status :: Maybe BackupStatus
- statusDescription :: Maybe Text
- subnetIds :: Maybe [Text]
- toolsVersion :: Maybe Text
- userArn :: Maybe Text
}
newBackup :: Backup
backup_backupArn :: Lens' Backup (Maybe Text)
backup_backupId :: Lens' Backup (Maybe Text)
backup_backupType :: Lens' Backup (Maybe BackupType)
backup_createdAt :: Lens' Backup (Maybe UTCTime)
backup_description :: Lens' Backup (Maybe Text)
backup_engine :: Lens' Backup (Maybe Text)
backup_engineModel :: Lens' Backup (Maybe Text)
backup_engineVersion :: Lens' Backup (Maybe Text)
backup_instanceProfileArn :: Lens' Backup (Maybe Text)
backup_instanceType :: Lens' Backup (Maybe Text)
backup_keyPair :: Lens' Backup (Maybe Text)
backup_preferredBackupWindow :: Lens' Backup (Maybe Text)
backup_preferredMaintenanceWindow :: Lens' Backup (Maybe Text)
backup_s3DataSize :: Lens' Backup (Maybe Int)
backup_s3DataUrl :: Lens' Backup (Maybe Text)
backup_s3LogUrl :: Lens' Backup (Maybe Text)
backup_securityGroupIds :: Lens' Backup (Maybe [Text])
backup_serverName :: Lens' Backup (Maybe Text)
backup_serviceRoleArn :: Lens' Backup (Maybe Text)
backup_status :: Lens' Backup (Maybe BackupStatus)
backup_statusDescription :: Lens' Backup (Maybe Text)
backup_subnetIds :: Lens' Backup (Maybe [Text])
backup_toolsVersion :: Lens' Backup (Maybe Text)
backup_userArn :: Lens' Backup (Maybe Text)

Documentation

data Backup Source #

Describes a single backup.

See: newBackup smart constructor.

Constructors

Backup'

Fields

backupArn :: Maybe Text
The ARN of the backup.
backupId :: Maybe Text
The generated ID of the backup. Example: myServerName-yyyyMMddHHmmssSSS
backupType :: Maybe BackupType
The backup type. Valid values are automated or manual.
createdAt :: Maybe POSIX
The time stamp when the backup was created in the database. Example: 2016-07-29T13:38:47.520Z
description :: Maybe Text
A user-provided description for a manual backup. This field is empty for automated backups.
engine :: Maybe Text
The engine type that is obtained from the server when the backup is created.
engineModel :: Maybe Text
The engine model that is obtained from the server when the backup is created.
engineVersion :: Maybe Text
The engine version that is obtained from the server when the backup is created.
instanceProfileArn :: Maybe Text
The EC2 instance profile ARN that is obtained from the server when the backup is created. Because this value is stored, you are not required to provide the InstanceProfileArn again if you restore a backup.
instanceType :: Maybe Text
The instance type that is obtained from the server when the backup is created.
keyPair :: Maybe Text
The key pair that is obtained from the server when the backup is created.
preferredBackupWindow :: Maybe Text
The preferred backup period that is obtained from the server when the backup is created.
preferredMaintenanceWindow :: Maybe Text
The preferred maintenance period that is obtained from the server when the backup is created.
s3DataSize :: Maybe Int
This field is deprecated and is no longer used.
s3DataUrl :: Maybe Text
This field is deprecated and is no longer used.
s3LogUrl :: Maybe Text
The Amazon S3 URL of the backup's log file.
securityGroupIds :: Maybe [Text]
The security group IDs that are obtained from the server when the backup is created.
serverName :: Maybe Text
The name of the server from which the backup was made.
serviceRoleArn :: Maybe Text
The service role ARN that is obtained from the server when the backup is created.
status :: Maybe BackupStatus
The status of a backup while in progress.
statusDescription :: Maybe Text
An informational message about backup status.
subnetIds :: Maybe [Text]
The subnet IDs that are obtained from the server when the backup is created.
toolsVersion :: Maybe Text
The version of AWS OpsWorks CM-specific tools that is obtained from the server when the backup is created.
userArn :: Maybe Text
The IAM user ARN of the requester for manual backups. This field is empty for automated backups.

Instances

Instances details

FromJSON Backup Source #
Instance details Defined in Amazonka.OpsWorksCM.Types.Backup Methods parseJSON :: Value -> Parser Backup # parseJSONList :: Value -> Parser [Backup] #
Generic Backup Source #
Instance details Defined in Amazonka.OpsWorksCM.Types.Backup Associated Types type Rep Backup :: Type -> Type # Methods from :: Backup -> Rep Backup x # to :: Rep Backup x -> Backup #
Read Backup Source #
Instance details Defined in Amazonka.OpsWorksCM.Types.Backup Methods readsPrec :: Int -> ReadS Backup # readList :: ReadS [Backup] # readPrec :: ReadPrec Backup # readListPrec :: ReadPrec [Backup] #
Show Backup Source #
Instance details Defined in Amazonka.OpsWorksCM.Types.Backup Methods showsPrec :: Int -> Backup -> ShowS # show :: Backup -> String # showList :: [Backup] -> ShowS #
NFData Backup Source #
Instance details Defined in Amazonka.OpsWorksCM.Types.Backup Methods rnf :: Backup -> () #
Eq Backup Source #
Instance details Defined in Amazonka.OpsWorksCM.Types.Backup Methods (==) :: Backup -> Backup -> Bool # (/=) :: Backup -> Backup -> Bool #
Hashable Backup Source #
Instance details Defined in Amazonka.OpsWorksCM.Types.Backup Methods hashWithSalt :: Int -> Backup -> Int # hash :: Backup -> Int #
type Rep Backup Source #
Instance details Defined in Amazonka.OpsWorksCM.Types.Backup type Rep Backup = D1 ('MetaData "Backup" "Amazonka.OpsWorksCM.Types.Backup" "amazonka-opsworks-cm-2.0-4eRKS676FdFBzYMnhnI9o" 'False) (C1 ('MetaCons "Backup'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "backupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "backupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "backupType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BackupType)))) :: (S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "engineModel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "instanceProfileArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "instanceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "keyPair") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "preferredBackupWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :: (((S1 ('MetaSel ('Just "preferredMaintenanceWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "s3DataSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "s3DataUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "s3LogUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "securityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "serverName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "serviceRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BackupStatus)) :: S1 ('MetaSel ('Just "statusDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "subnetIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "toolsVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "userArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))))

newBackup :: Backup Source #

Create a value of Backup 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:backupArn:Backup', backup_backupArn - The ARN of the backup.

$sel:backupId:Backup', backup_backupId - The generated ID of the backup. Example: myServerName-yyyyMMddHHmmssSSS

$sel:backupType:Backup', backup_backupType - The backup type. Valid values are automated or manual.

$sel:createdAt:Backup', backup_createdAt - The time stamp when the backup was created in the database. Example: 2016-07-29T13:38:47.520Z

$sel:description:Backup', backup_description - A user-provided description for a manual backup. This field is empty for automated backups.

$sel:engine:Backup', backup_engine - The engine type that is obtained from the server when the backup is created.

$sel:engineModel:Backup', backup_engineModel - The engine model that is obtained from the server when the backup is created.

$sel:engineVersion:Backup', backup_engineVersion - The engine version that is obtained from the server when the backup is created.

$sel:instanceProfileArn:Backup', backup_instanceProfileArn - The EC2 instance profile ARN that is obtained from the server when the backup is created. Because this value is stored, you are not required to provide the InstanceProfileArn again if you restore a backup.

$sel:instanceType:Backup', backup_instanceType - The instance type that is obtained from the server when the backup is created.

$sel:keyPair:Backup', backup_keyPair - The key pair that is obtained from the server when the backup is created.

$sel:preferredBackupWindow:Backup', backup_preferredBackupWindow - The preferred backup period that is obtained from the server when the backup is created.

$sel:preferredMaintenanceWindow:Backup', backup_preferredMaintenanceWindow - The preferred maintenance period that is obtained from the server when the backup is created.

$sel:s3DataSize:Backup', backup_s3DataSize - This field is deprecated and is no longer used.

$sel:s3DataUrl:Backup', backup_s3DataUrl - This field is deprecated and is no longer used.

$sel:s3LogUrl:Backup', backup_s3LogUrl - The Amazon S3 URL of the backup's log file.

$sel:securityGroupIds:Backup', backup_securityGroupIds - The security group IDs that are obtained from the server when the backup is created.

$sel:serverName:Backup', backup_serverName - The name of the server from which the backup was made.

$sel:serviceRoleArn:Backup', backup_serviceRoleArn - The service role ARN that is obtained from the server when the backup is created.

$sel:status:Backup', backup_status - The status of a backup while in progress.

$sel:statusDescription:Backup', backup_statusDescription - An informational message about backup status.

$sel:subnetIds:Backup', backup_subnetIds - The subnet IDs that are obtained from the server when the backup is created.

$sel:toolsVersion:Backup', backup_toolsVersion - The version of AWS OpsWorks CM-specific tools that is obtained from the server when the backup is created.

$sel:userArn:Backup', backup_userArn - The IAM user ARN of the requester for manual backups. This field is empty for automated backups.

backup_backupArn :: Lens' Backup (Maybe Text) Source #

The ARN of the backup.

backup_backupId :: Lens' Backup (Maybe Text) Source #

The generated ID of the backup. Example: myServerName-yyyyMMddHHmmssSSS

backup_backupType :: Lens' Backup (Maybe BackupType) Source #

The backup type. Valid values are automated or manual.

backup_createdAt :: Lens' Backup (Maybe UTCTime) Source #

The time stamp when the backup was created in the database. Example: 2016-07-29T13:38:47.520Z

backup_description :: Lens' Backup (Maybe Text) Source #

A user-provided description for a manual backup. This field is empty for automated backups.

backup_engine :: Lens' Backup (Maybe Text) Source #

The engine type that is obtained from the server when the backup is created.

backup_engineModel :: Lens' Backup (Maybe Text) Source #

The engine model that is obtained from the server when the backup is created.

backup_engineVersion :: Lens' Backup (Maybe Text) Source #

The engine version that is obtained from the server when the backup is created.

backup_instanceProfileArn :: Lens' Backup (Maybe Text) Source #

The EC2 instance profile ARN that is obtained from the server when the backup is created. Because this value is stored, you are not required to provide the InstanceProfileArn again if you restore a backup.

backup_instanceType :: Lens' Backup (Maybe Text) Source #

The instance type that is obtained from the server when the backup is created.

backup_keyPair :: Lens' Backup (Maybe Text) Source #

The key pair that is obtained from the server when the backup is created.

backup_preferredBackupWindow :: Lens' Backup (Maybe Text) Source #

The preferred backup period that is obtained from the server when the backup is created.

backup_preferredMaintenanceWindow :: Lens' Backup (Maybe Text) Source #

The preferred maintenance period that is obtained from the server when the backup is created.

backup_s3DataSize :: Lens' Backup (Maybe Int) Source #

This field is deprecated and is no longer used.

backup_s3DataUrl :: Lens' Backup (Maybe Text) Source #

This field is deprecated and is no longer used.

backup_s3LogUrl :: Lens' Backup (Maybe Text) Source #

The Amazon S3 URL of the backup's log file.

backup_securityGroupIds :: Lens' Backup (Maybe [Text]) Source #

The security group IDs that are obtained from the server when the backup is created.

backup_serverName :: Lens' Backup (Maybe Text) Source #

The name of the server from which the backup was made.

backup_serviceRoleArn :: Lens' Backup (Maybe Text) Source #

The service role ARN that is obtained from the server when the backup is created.

backup_status :: Lens' Backup (Maybe BackupStatus) Source #

The status of a backup while in progress.

backup_statusDescription :: Lens' Backup (Maybe Text) Source #

An informational message about backup status.

backup_subnetIds :: Lens' Backup (Maybe [Text]) Source #

The subnet IDs that are obtained from the server when the backup is created.

backup_toolsVersion :: Lens' Backup (Maybe Text) Source #

The version of AWS OpsWorks CM-specific tools that is obtained from the server when the backup is created.

backup_userArn :: Lens' Backup (Maybe Text) Source #

The IAM user ARN of the requester for manual backups. This field is empty for automated backups.