| 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.Backup.Types
Contents
- Service Configuration
- Errors
- BackupJobState
- BackupVaultEvent
- ConditionType
- CopyJobState
- LegalHoldStatus
- RecoveryPointStatus
- RestoreJobStatus
- StorageClass
- AdvancedBackupSetting
- BackupJob
- BackupPlan
- BackupPlanInput
- BackupPlanTemplatesListMember
- BackupPlansListMember
- BackupRule
- BackupRuleInput
- BackupSelection
- BackupSelectionsListMember
- BackupVaultListMember
- CalculatedLifecycle
- Condition
- ConditionParameter
- Conditions
- ControlInputParameter
- ControlScope
- CopyAction
- CopyJob
- DateRange
- Framework
- FrameworkControl
- LegalHold
- Lifecycle
- ProtectedResource
- RecoveryPointByBackupVault
- RecoveryPointByResource
- RecoveryPointCreator
- RecoveryPointMember
- RecoveryPointSelection
- ReportDeliveryChannel
- ReportDestination
- ReportJob
- ReportPlan
- ReportSetting
- RestoreJobsListMember
Description
Synopsis
- defaultService :: Service
- _AlreadyExistsException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _DependencyFailureException :: AsError a => Fold a ServiceError
- _InvalidParameterValueException :: AsError a => Fold a ServiceError
- _InvalidRequestException :: AsError a => Fold a ServiceError
- _InvalidResourceStateException :: AsError a => Fold a ServiceError
- _LimitExceededException :: AsError a => Fold a ServiceError
- _MissingParameterValueException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceUnavailableException :: AsError a => Fold a ServiceError
- newtype BackupJobState where
- BackupJobState' { }
- pattern BackupJobState_ABORTED :: BackupJobState
- pattern BackupJobState_ABORTING :: BackupJobState
- pattern BackupJobState_COMPLETED :: BackupJobState
- pattern BackupJobState_CREATED :: BackupJobState
- pattern BackupJobState_EXPIRED :: BackupJobState
- pattern BackupJobState_FAILED :: BackupJobState
- pattern BackupJobState_PARTIAL :: BackupJobState
- pattern BackupJobState_PENDING :: BackupJobState
- pattern BackupJobState_RUNNING :: BackupJobState
- newtype BackupVaultEvent where
- BackupVaultEvent' { }
- pattern BackupVaultEvent_BACKUP_JOB_COMPLETED :: BackupVaultEvent
- pattern BackupVaultEvent_BACKUP_JOB_EXPIRED :: BackupVaultEvent
- pattern BackupVaultEvent_BACKUP_JOB_FAILED :: BackupVaultEvent
- pattern BackupVaultEvent_BACKUP_JOB_STARTED :: BackupVaultEvent
- pattern BackupVaultEvent_BACKUP_JOB_SUCCESSFUL :: BackupVaultEvent
- pattern BackupVaultEvent_BACKUP_PLAN_CREATED :: BackupVaultEvent
- pattern BackupVaultEvent_BACKUP_PLAN_MODIFIED :: BackupVaultEvent
- pattern BackupVaultEvent_COPY_JOB_FAILED :: BackupVaultEvent
- pattern BackupVaultEvent_COPY_JOB_STARTED :: BackupVaultEvent
- pattern BackupVaultEvent_COPY_JOB_SUCCESSFUL :: BackupVaultEvent
- pattern BackupVaultEvent_RECOVERY_POINT_MODIFIED :: BackupVaultEvent
- pattern BackupVaultEvent_RESTORE_JOB_COMPLETED :: BackupVaultEvent
- pattern BackupVaultEvent_RESTORE_JOB_FAILED :: BackupVaultEvent
- pattern BackupVaultEvent_RESTORE_JOB_STARTED :: BackupVaultEvent
- pattern BackupVaultEvent_RESTORE_JOB_SUCCESSFUL :: BackupVaultEvent
- pattern BackupVaultEvent_S3_BACKUP_OBJECT_FAILED :: BackupVaultEvent
- pattern BackupVaultEvent_S3_RESTORE_OBJECT_FAILED :: BackupVaultEvent
- newtype ConditionType where
- ConditionType' { }
- pattern ConditionType_STRINGEQUALS :: ConditionType
- newtype CopyJobState where
- CopyJobState' { }
- pattern CopyJobState_COMPLETED :: CopyJobState
- pattern CopyJobState_CREATED :: CopyJobState
- pattern CopyJobState_FAILED :: CopyJobState
- pattern CopyJobState_PARTIAL :: CopyJobState
- pattern CopyJobState_RUNNING :: CopyJobState
- newtype LegalHoldStatus where
- LegalHoldStatus' { }
- pattern LegalHoldStatus_ACTIVE :: LegalHoldStatus
- pattern LegalHoldStatus_CANCELED :: LegalHoldStatus
- pattern LegalHoldStatus_CANCELING :: LegalHoldStatus
- pattern LegalHoldStatus_CREATING :: LegalHoldStatus
- newtype RecoveryPointStatus where
- newtype RestoreJobStatus where
- RestoreJobStatus' { }
- pattern RestoreJobStatus_ABORTED :: RestoreJobStatus
- pattern RestoreJobStatus_COMPLETED :: RestoreJobStatus
- pattern RestoreJobStatus_FAILED :: RestoreJobStatus
- pattern RestoreJobStatus_PENDING :: RestoreJobStatus
- pattern RestoreJobStatus_RUNNING :: RestoreJobStatus
- newtype StorageClass where
- StorageClass' { }
- pattern StorageClass_COLD :: StorageClass
- pattern StorageClass_DELETED :: StorageClass
- pattern StorageClass_WARM :: StorageClass
- data AdvancedBackupSetting = AdvancedBackupSetting' {
- backupOptions :: Maybe (HashMap Text Text)
- resourceType :: Maybe Text
- newAdvancedBackupSetting :: AdvancedBackupSetting
- advancedBackupSetting_backupOptions :: Lens' AdvancedBackupSetting (Maybe (HashMap Text Text))
- advancedBackupSetting_resourceType :: Lens' AdvancedBackupSetting (Maybe Text)
- data BackupJob = BackupJob' {
- accountId :: Maybe Text
- backupJobId :: Maybe Text
- backupOptions :: Maybe (HashMap Text Text)
- backupSizeInBytes :: Maybe Integer
- backupType :: Maybe Text
- backupVaultArn :: Maybe Text
- backupVaultName :: Maybe Text
- bytesTransferred :: Maybe Integer
- completionDate :: Maybe POSIX
- createdBy :: Maybe RecoveryPointCreator
- creationDate :: Maybe POSIX
- expectedCompletionDate :: Maybe POSIX
- iamRoleArn :: Maybe Text
- isParent :: Maybe Bool
- parentJobId :: Maybe Text
- percentDone :: Maybe Text
- recoveryPointArn :: Maybe Text
- resourceArn :: Maybe Text
- resourceType :: Maybe Text
- startBy :: Maybe POSIX
- state :: Maybe BackupJobState
- statusMessage :: Maybe Text
- newBackupJob :: BackupJob
- backupJob_accountId :: Lens' BackupJob (Maybe Text)
- backupJob_backupJobId :: Lens' BackupJob (Maybe Text)
- backupJob_backupOptions :: Lens' BackupJob (Maybe (HashMap Text Text))
- backupJob_backupSizeInBytes :: Lens' BackupJob (Maybe Integer)
- backupJob_backupType :: Lens' BackupJob (Maybe Text)
- backupJob_backupVaultArn :: Lens' BackupJob (Maybe Text)
- backupJob_backupVaultName :: Lens' BackupJob (Maybe Text)
- backupJob_bytesTransferred :: Lens' BackupJob (Maybe Integer)
- backupJob_completionDate :: Lens' BackupJob (Maybe UTCTime)
- backupJob_createdBy :: Lens' BackupJob (Maybe RecoveryPointCreator)
- backupJob_creationDate :: Lens' BackupJob (Maybe UTCTime)
- backupJob_expectedCompletionDate :: Lens' BackupJob (Maybe UTCTime)
- backupJob_iamRoleArn :: Lens' BackupJob (Maybe Text)
- backupJob_isParent :: Lens' BackupJob (Maybe Bool)
- backupJob_parentJobId :: Lens' BackupJob (Maybe Text)
- backupJob_percentDone :: Lens' BackupJob (Maybe Text)
- backupJob_recoveryPointArn :: Lens' BackupJob (Maybe Text)
- backupJob_resourceArn :: Lens' BackupJob (Maybe Text)
- backupJob_resourceType :: Lens' BackupJob (Maybe Text)
- backupJob_startBy :: Lens' BackupJob (Maybe UTCTime)
- backupJob_state :: Lens' BackupJob (Maybe BackupJobState)
- backupJob_statusMessage :: Lens' BackupJob (Maybe Text)
- data BackupPlan = BackupPlan' {}
- newBackupPlan :: Text -> BackupPlan
- backupPlan_advancedBackupSettings :: Lens' BackupPlan (Maybe [AdvancedBackupSetting])
- backupPlan_backupPlanName :: Lens' BackupPlan Text
- backupPlan_rules :: Lens' BackupPlan [BackupRule]
- data BackupPlanInput = BackupPlanInput' {}
- newBackupPlanInput :: Text -> BackupPlanInput
- backupPlanInput_advancedBackupSettings :: Lens' BackupPlanInput (Maybe [AdvancedBackupSetting])
- backupPlanInput_backupPlanName :: Lens' BackupPlanInput Text
- backupPlanInput_rules :: Lens' BackupPlanInput [BackupRuleInput]
- data BackupPlanTemplatesListMember = BackupPlanTemplatesListMember' {}
- newBackupPlanTemplatesListMember :: BackupPlanTemplatesListMember
- backupPlanTemplatesListMember_backupPlanTemplateId :: Lens' BackupPlanTemplatesListMember (Maybe Text)
- backupPlanTemplatesListMember_backupPlanTemplateName :: Lens' BackupPlanTemplatesListMember (Maybe Text)
- data BackupPlansListMember = BackupPlansListMember' {}
- newBackupPlansListMember :: BackupPlansListMember
- backupPlansListMember_advancedBackupSettings :: Lens' BackupPlansListMember (Maybe [AdvancedBackupSetting])
- backupPlansListMember_backupPlanArn :: Lens' BackupPlansListMember (Maybe Text)
- backupPlansListMember_backupPlanId :: Lens' BackupPlansListMember (Maybe Text)
- backupPlansListMember_backupPlanName :: Lens' BackupPlansListMember (Maybe Text)
- backupPlansListMember_creationDate :: Lens' BackupPlansListMember (Maybe UTCTime)
- backupPlansListMember_creatorRequestId :: Lens' BackupPlansListMember (Maybe Text)
- backupPlansListMember_deletionDate :: Lens' BackupPlansListMember (Maybe UTCTime)
- backupPlansListMember_lastExecutionDate :: Lens' BackupPlansListMember (Maybe UTCTime)
- backupPlansListMember_versionId :: Lens' BackupPlansListMember (Maybe Text)
- data BackupRule = BackupRule' {
- completionWindowMinutes :: Maybe Integer
- copyActions :: Maybe [CopyAction]
- enableContinuousBackup :: Maybe Bool
- lifecycle :: Maybe Lifecycle
- recoveryPointTags :: Maybe (Sensitive (HashMap Text Text))
- ruleId :: Maybe Text
- scheduleExpression :: Maybe Text
- startWindowMinutes :: Maybe Integer
- ruleName :: Text
- targetBackupVaultName :: Text
- newBackupRule :: Text -> Text -> BackupRule
- backupRule_completionWindowMinutes :: Lens' BackupRule (Maybe Integer)
- backupRule_copyActions :: Lens' BackupRule (Maybe [CopyAction])
- backupRule_enableContinuousBackup :: Lens' BackupRule (Maybe Bool)
- backupRule_lifecycle :: Lens' BackupRule (Maybe Lifecycle)
- backupRule_recoveryPointTags :: Lens' BackupRule (Maybe (HashMap Text Text))
- backupRule_ruleId :: Lens' BackupRule (Maybe Text)
- backupRule_scheduleExpression :: Lens' BackupRule (Maybe Text)
- backupRule_startWindowMinutes :: Lens' BackupRule (Maybe Integer)
- backupRule_ruleName :: Lens' BackupRule Text
- backupRule_targetBackupVaultName :: Lens' BackupRule Text
- data BackupRuleInput = BackupRuleInput' {
- completionWindowMinutes :: Maybe Integer
- copyActions :: Maybe [CopyAction]
- enableContinuousBackup :: Maybe Bool
- lifecycle :: Maybe Lifecycle
- recoveryPointTags :: Maybe (Sensitive (HashMap Text Text))
- scheduleExpression :: Maybe Text
- startWindowMinutes :: Maybe Integer
- ruleName :: Text
- targetBackupVaultName :: Text
- newBackupRuleInput :: Text -> Text -> BackupRuleInput
- backupRuleInput_completionWindowMinutes :: Lens' BackupRuleInput (Maybe Integer)
- backupRuleInput_copyActions :: Lens' BackupRuleInput (Maybe [CopyAction])
- backupRuleInput_enableContinuousBackup :: Lens' BackupRuleInput (Maybe Bool)
- backupRuleInput_lifecycle :: Lens' BackupRuleInput (Maybe Lifecycle)
- backupRuleInput_recoveryPointTags :: Lens' BackupRuleInput (Maybe (HashMap Text Text))
- backupRuleInput_scheduleExpression :: Lens' BackupRuleInput (Maybe Text)
- backupRuleInput_startWindowMinutes :: Lens' BackupRuleInput (Maybe Integer)
- backupRuleInput_ruleName :: Lens' BackupRuleInput Text
- backupRuleInput_targetBackupVaultName :: Lens' BackupRuleInput Text
- data BackupSelection = BackupSelection' {
- conditions :: Maybe Conditions
- listOfTags :: Maybe [Condition]
- notResources :: Maybe [Text]
- resources :: Maybe [Text]
- selectionName :: Text
- iamRoleArn :: Text
- newBackupSelection :: Text -> Text -> BackupSelection
- backupSelection_conditions :: Lens' BackupSelection (Maybe Conditions)
- backupSelection_listOfTags :: Lens' BackupSelection (Maybe [Condition])
- backupSelection_notResources :: Lens' BackupSelection (Maybe [Text])
- backupSelection_resources :: Lens' BackupSelection (Maybe [Text])
- backupSelection_selectionName :: Lens' BackupSelection Text
- backupSelection_iamRoleArn :: Lens' BackupSelection Text
- data BackupSelectionsListMember = BackupSelectionsListMember' {}
- newBackupSelectionsListMember :: BackupSelectionsListMember
- backupSelectionsListMember_backupPlanId :: Lens' BackupSelectionsListMember (Maybe Text)
- backupSelectionsListMember_creationDate :: Lens' BackupSelectionsListMember (Maybe UTCTime)
- backupSelectionsListMember_creatorRequestId :: Lens' BackupSelectionsListMember (Maybe Text)
- backupSelectionsListMember_iamRoleArn :: Lens' BackupSelectionsListMember (Maybe Text)
- backupSelectionsListMember_selectionId :: Lens' BackupSelectionsListMember (Maybe Text)
- backupSelectionsListMember_selectionName :: Lens' BackupSelectionsListMember (Maybe Text)
- data BackupVaultListMember = BackupVaultListMember' {}
- newBackupVaultListMember :: BackupVaultListMember
- backupVaultListMember_backupVaultArn :: Lens' BackupVaultListMember (Maybe Text)
- backupVaultListMember_backupVaultName :: Lens' BackupVaultListMember (Maybe Text)
- backupVaultListMember_creationDate :: Lens' BackupVaultListMember (Maybe UTCTime)
- backupVaultListMember_creatorRequestId :: Lens' BackupVaultListMember (Maybe Text)
- backupVaultListMember_encryptionKeyArn :: Lens' BackupVaultListMember (Maybe Text)
- backupVaultListMember_lockDate :: Lens' BackupVaultListMember (Maybe UTCTime)
- backupVaultListMember_locked :: Lens' BackupVaultListMember (Maybe Bool)
- backupVaultListMember_maxRetentionDays :: Lens' BackupVaultListMember (Maybe Integer)
- backupVaultListMember_minRetentionDays :: Lens' BackupVaultListMember (Maybe Integer)
- backupVaultListMember_numberOfRecoveryPoints :: Lens' BackupVaultListMember (Maybe Integer)
- data CalculatedLifecycle = CalculatedLifecycle' {}
- newCalculatedLifecycle :: CalculatedLifecycle
- calculatedLifecycle_deleteAt :: Lens' CalculatedLifecycle (Maybe UTCTime)
- calculatedLifecycle_moveToColdStorageAt :: Lens' CalculatedLifecycle (Maybe UTCTime)
- data Condition = Condition' {}
- newCondition :: ConditionType -> Text -> Text -> Condition
- condition_conditionType :: Lens' Condition ConditionType
- condition_conditionKey :: Lens' Condition Text
- condition_conditionValue :: Lens' Condition Text
- data ConditionParameter = ConditionParameter' {}
- newConditionParameter :: ConditionParameter
- conditionParameter_conditionKey :: Lens' ConditionParameter (Maybe Text)
- conditionParameter_conditionValue :: Lens' ConditionParameter (Maybe Text)
- data Conditions = Conditions' {}
- newConditions :: Conditions
- conditions_stringEquals :: Lens' Conditions (Maybe [ConditionParameter])
- conditions_stringLike :: Lens' Conditions (Maybe [ConditionParameter])
- conditions_stringNotEquals :: Lens' Conditions (Maybe [ConditionParameter])
- conditions_stringNotLike :: Lens' Conditions (Maybe [ConditionParameter])
- data ControlInputParameter = ControlInputParameter' {}
- newControlInputParameter :: ControlInputParameter
- controlInputParameter_parameterName :: Lens' ControlInputParameter (Maybe Text)
- controlInputParameter_parameterValue :: Lens' ControlInputParameter (Maybe Text)
- data ControlScope = ControlScope' {}
- newControlScope :: ControlScope
- controlScope_complianceResourceIds :: Lens' ControlScope (Maybe (NonEmpty Text))
- controlScope_complianceResourceTypes :: Lens' ControlScope (Maybe [Text])
- controlScope_tags :: Lens' ControlScope (Maybe (HashMap Text Text))
- data CopyAction = CopyAction' {}
- newCopyAction :: Text -> CopyAction
- copyAction_lifecycle :: Lens' CopyAction (Maybe Lifecycle)
- copyAction_destinationBackupVaultArn :: Lens' CopyAction Text
- data CopyJob = CopyJob' {
- accountId :: Maybe Text
- backupSizeInBytes :: Maybe Integer
- childJobsInState :: Maybe (HashMap CopyJobState Integer)
- completionDate :: Maybe POSIX
- compositeMemberIdentifier :: Maybe Text
- copyJobId :: Maybe Text
- createdBy :: Maybe RecoveryPointCreator
- creationDate :: Maybe POSIX
- destinationBackupVaultArn :: Maybe Text
- destinationRecoveryPointArn :: Maybe Text
- iamRoleArn :: Maybe Text
- isParent :: Maybe Bool
- numberOfChildJobs :: Maybe Integer
- parentJobId :: Maybe Text
- resourceArn :: Maybe Text
- resourceType :: Maybe Text
- sourceBackupVaultArn :: Maybe Text
- sourceRecoveryPointArn :: Maybe Text
- state :: Maybe CopyJobState
- statusMessage :: Maybe Text
- newCopyJob :: CopyJob
- copyJob_accountId :: Lens' CopyJob (Maybe Text)
- copyJob_backupSizeInBytes :: Lens' CopyJob (Maybe Integer)
- copyJob_childJobsInState :: Lens' CopyJob (Maybe (HashMap CopyJobState Integer))
- copyJob_completionDate :: Lens' CopyJob (Maybe UTCTime)
- copyJob_compositeMemberIdentifier :: Lens' CopyJob (Maybe Text)
- copyJob_copyJobId :: Lens' CopyJob (Maybe Text)
- copyJob_createdBy :: Lens' CopyJob (Maybe RecoveryPointCreator)
- copyJob_creationDate :: Lens' CopyJob (Maybe UTCTime)
- copyJob_destinationBackupVaultArn :: Lens' CopyJob (Maybe Text)
- copyJob_destinationRecoveryPointArn :: Lens' CopyJob (Maybe Text)
- copyJob_iamRoleArn :: Lens' CopyJob (Maybe Text)
- copyJob_isParent :: Lens' CopyJob (Maybe Bool)
- copyJob_numberOfChildJobs :: Lens' CopyJob (Maybe Integer)
- copyJob_parentJobId :: Lens' CopyJob (Maybe Text)
- copyJob_resourceArn :: Lens' CopyJob (Maybe Text)
- copyJob_resourceType :: Lens' CopyJob (Maybe Text)
- copyJob_sourceBackupVaultArn :: Lens' CopyJob (Maybe Text)
- copyJob_sourceRecoveryPointArn :: Lens' CopyJob (Maybe Text)
- copyJob_state :: Lens' CopyJob (Maybe CopyJobState)
- copyJob_statusMessage :: Lens' CopyJob (Maybe Text)
- data DateRange = DateRange' {}
- newDateRange :: UTCTime -> UTCTime -> DateRange
- dateRange_fromDate :: Lens' DateRange UTCTime
- dateRange_toDate :: Lens' DateRange UTCTime
- data Framework = Framework' {}
- newFramework :: Framework
- framework_creationTime :: Lens' Framework (Maybe UTCTime)
- framework_deploymentStatus :: Lens' Framework (Maybe Text)
- framework_frameworkArn :: Lens' Framework (Maybe Text)
- framework_frameworkDescription :: Lens' Framework (Maybe Text)
- framework_frameworkName :: Lens' Framework (Maybe Text)
- framework_numberOfControls :: Lens' Framework (Maybe Int)
- data FrameworkControl = FrameworkControl' {}
- newFrameworkControl :: Text -> FrameworkControl
- frameworkControl_controlInputParameters :: Lens' FrameworkControl (Maybe [ControlInputParameter])
- frameworkControl_controlScope :: Lens' FrameworkControl (Maybe ControlScope)
- frameworkControl_controlName :: Lens' FrameworkControl Text
- data LegalHold = LegalHold' {}
- newLegalHold :: LegalHold
- legalHold_cancellationDate :: Lens' LegalHold (Maybe UTCTime)
- legalHold_creationDate :: Lens' LegalHold (Maybe UTCTime)
- legalHold_description :: Lens' LegalHold (Maybe Text)
- legalHold_legalHoldArn :: Lens' LegalHold (Maybe Text)
- legalHold_legalHoldId :: Lens' LegalHold (Maybe Text)
- legalHold_status :: Lens' LegalHold (Maybe LegalHoldStatus)
- legalHold_title :: Lens' LegalHold (Maybe Text)
- data Lifecycle = Lifecycle' {}
- newLifecycle :: Lifecycle
- lifecycle_deleteAfterDays :: Lens' Lifecycle (Maybe Integer)
- lifecycle_moveToColdStorageAfterDays :: Lens' Lifecycle (Maybe Integer)
- data ProtectedResource = ProtectedResource' {}
- newProtectedResource :: ProtectedResource
- protectedResource_lastBackupTime :: Lens' ProtectedResource (Maybe UTCTime)
- protectedResource_resourceArn :: Lens' ProtectedResource (Maybe Text)
- protectedResource_resourceType :: Lens' ProtectedResource (Maybe Text)
- data RecoveryPointByBackupVault = RecoveryPointByBackupVault' {
- backupSizeInBytes :: Maybe Integer
- backupVaultArn :: Maybe Text
- backupVaultName :: Maybe Text
- calculatedLifecycle :: Maybe CalculatedLifecycle
- completionDate :: Maybe POSIX
- compositeMemberIdentifier :: Maybe Text
- createdBy :: Maybe RecoveryPointCreator
- creationDate :: Maybe POSIX
- encryptionKeyArn :: Maybe Text
- iamRoleArn :: Maybe Text
- isEncrypted :: Maybe Bool
- isParent :: Maybe Bool
- lastRestoreTime :: Maybe POSIX
- lifecycle :: Maybe Lifecycle
- parentRecoveryPointArn :: Maybe Text
- recoveryPointArn :: Maybe Text
- resourceArn :: Maybe Text
- resourceType :: Maybe Text
- sourceBackupVaultArn :: Maybe Text
- status :: Maybe RecoveryPointStatus
- statusMessage :: Maybe Text
- newRecoveryPointByBackupVault :: RecoveryPointByBackupVault
- recoveryPointByBackupVault_backupSizeInBytes :: Lens' RecoveryPointByBackupVault (Maybe Integer)
- recoveryPointByBackupVault_backupVaultArn :: Lens' RecoveryPointByBackupVault (Maybe Text)
- recoveryPointByBackupVault_backupVaultName :: Lens' RecoveryPointByBackupVault (Maybe Text)
- recoveryPointByBackupVault_calculatedLifecycle :: Lens' RecoveryPointByBackupVault (Maybe CalculatedLifecycle)
- recoveryPointByBackupVault_completionDate :: Lens' RecoveryPointByBackupVault (Maybe UTCTime)
- recoveryPointByBackupVault_compositeMemberIdentifier :: Lens' RecoveryPointByBackupVault (Maybe Text)
- recoveryPointByBackupVault_createdBy :: Lens' RecoveryPointByBackupVault (Maybe RecoveryPointCreator)
- recoveryPointByBackupVault_creationDate :: Lens' RecoveryPointByBackupVault (Maybe UTCTime)
- recoveryPointByBackupVault_encryptionKeyArn :: Lens' RecoveryPointByBackupVault (Maybe Text)
- recoveryPointByBackupVault_iamRoleArn :: Lens' RecoveryPointByBackupVault (Maybe Text)
- recoveryPointByBackupVault_isEncrypted :: Lens' RecoveryPointByBackupVault (Maybe Bool)
- recoveryPointByBackupVault_isParent :: Lens' RecoveryPointByBackupVault (Maybe Bool)
- recoveryPointByBackupVault_lastRestoreTime :: Lens' RecoveryPointByBackupVault (Maybe UTCTime)
- recoveryPointByBackupVault_lifecycle :: Lens' RecoveryPointByBackupVault (Maybe Lifecycle)
- recoveryPointByBackupVault_parentRecoveryPointArn :: Lens' RecoveryPointByBackupVault (Maybe Text)
- recoveryPointByBackupVault_recoveryPointArn :: Lens' RecoveryPointByBackupVault (Maybe Text)
- recoveryPointByBackupVault_resourceArn :: Lens' RecoveryPointByBackupVault (Maybe Text)
- recoveryPointByBackupVault_resourceType :: Lens' RecoveryPointByBackupVault (Maybe Text)
- recoveryPointByBackupVault_sourceBackupVaultArn :: Lens' RecoveryPointByBackupVault (Maybe Text)
- recoveryPointByBackupVault_status :: Lens' RecoveryPointByBackupVault (Maybe RecoveryPointStatus)
- recoveryPointByBackupVault_statusMessage :: Lens' RecoveryPointByBackupVault (Maybe Text)
- data RecoveryPointByResource = RecoveryPointByResource' {}
- newRecoveryPointByResource :: RecoveryPointByResource
- recoveryPointByResource_backupSizeBytes :: Lens' RecoveryPointByResource (Maybe Integer)
- recoveryPointByResource_backupVaultName :: Lens' RecoveryPointByResource (Maybe Text)
- recoveryPointByResource_creationDate :: Lens' RecoveryPointByResource (Maybe UTCTime)
- recoveryPointByResource_encryptionKeyArn :: Lens' RecoveryPointByResource (Maybe Text)
- recoveryPointByResource_isParent :: Lens' RecoveryPointByResource (Maybe Bool)
- recoveryPointByResource_parentRecoveryPointArn :: Lens' RecoveryPointByResource (Maybe Text)
- recoveryPointByResource_recoveryPointArn :: Lens' RecoveryPointByResource (Maybe Text)
- recoveryPointByResource_status :: Lens' RecoveryPointByResource (Maybe RecoveryPointStatus)
- recoveryPointByResource_statusMessage :: Lens' RecoveryPointByResource (Maybe Text)
- data RecoveryPointCreator = RecoveryPointCreator' {}
- newRecoveryPointCreator :: RecoveryPointCreator
- recoveryPointCreator_backupPlanArn :: Lens' RecoveryPointCreator (Maybe Text)
- recoveryPointCreator_backupPlanId :: Lens' RecoveryPointCreator (Maybe Text)
- recoveryPointCreator_backupPlanVersion :: Lens' RecoveryPointCreator (Maybe Text)
- recoveryPointCreator_backupRuleId :: Lens' RecoveryPointCreator (Maybe Text)
- data RecoveryPointMember = RecoveryPointMember' {}
- newRecoveryPointMember :: RecoveryPointMember
- recoveryPointMember_recoveryPointArn :: Lens' RecoveryPointMember (Maybe Text)
- data RecoveryPointSelection = RecoveryPointSelection' {
- dateRange :: Maybe DateRange
- resourceIdentifiers :: Maybe [Text]
- vaultNames :: Maybe [Text]
- newRecoveryPointSelection :: RecoveryPointSelection
- recoveryPointSelection_dateRange :: Lens' RecoveryPointSelection (Maybe DateRange)
- recoveryPointSelection_resourceIdentifiers :: Lens' RecoveryPointSelection (Maybe [Text])
- recoveryPointSelection_vaultNames :: Lens' RecoveryPointSelection (Maybe [Text])
- data ReportDeliveryChannel = ReportDeliveryChannel' {
- formats :: Maybe [Text]
- s3KeyPrefix :: Maybe Text
- s3BucketName :: Text
- newReportDeliveryChannel :: Text -> ReportDeliveryChannel
- reportDeliveryChannel_formats :: Lens' ReportDeliveryChannel (Maybe [Text])
- reportDeliveryChannel_s3KeyPrefix :: Lens' ReportDeliveryChannel (Maybe Text)
- reportDeliveryChannel_s3BucketName :: Lens' ReportDeliveryChannel Text
- data ReportDestination = ReportDestination' {}
- newReportDestination :: ReportDestination
- reportDestination_s3BucketName :: Lens' ReportDestination (Maybe Text)
- reportDestination_s3Keys :: Lens' ReportDestination (Maybe [Text])
- data ReportJob = ReportJob' {}
- newReportJob :: ReportJob
- reportJob_completionTime :: Lens' ReportJob (Maybe UTCTime)
- reportJob_creationTime :: Lens' ReportJob (Maybe UTCTime)
- reportJob_reportDestination :: Lens' ReportJob (Maybe ReportDestination)
- reportJob_reportJobId :: Lens' ReportJob (Maybe Text)
- reportJob_reportPlanArn :: Lens' ReportJob (Maybe Text)
- reportJob_reportTemplate :: Lens' ReportJob (Maybe Text)
- reportJob_status :: Lens' ReportJob (Maybe Text)
- reportJob_statusMessage :: Lens' ReportJob (Maybe Text)
- data ReportPlan = ReportPlan' {
- creationTime :: Maybe POSIX
- deploymentStatus :: Maybe Text
- lastAttemptedExecutionTime :: Maybe POSIX
- lastSuccessfulExecutionTime :: Maybe POSIX
- reportDeliveryChannel :: Maybe ReportDeliveryChannel
- reportPlanArn :: Maybe Text
- reportPlanDescription :: Maybe Text
- reportPlanName :: Maybe Text
- reportSetting :: Maybe ReportSetting
- newReportPlan :: ReportPlan
- reportPlan_creationTime :: Lens' ReportPlan (Maybe UTCTime)
- reportPlan_deploymentStatus :: Lens' ReportPlan (Maybe Text)
- reportPlan_lastAttemptedExecutionTime :: Lens' ReportPlan (Maybe UTCTime)
- reportPlan_lastSuccessfulExecutionTime :: Lens' ReportPlan (Maybe UTCTime)
- reportPlan_reportDeliveryChannel :: Lens' ReportPlan (Maybe ReportDeliveryChannel)
- reportPlan_reportPlanArn :: Lens' ReportPlan (Maybe Text)
- reportPlan_reportPlanDescription :: Lens' ReportPlan (Maybe Text)
- reportPlan_reportPlanName :: Lens' ReportPlan (Maybe Text)
- reportPlan_reportSetting :: Lens' ReportPlan (Maybe ReportSetting)
- data ReportSetting = ReportSetting' {
- accounts :: Maybe [Text]
- frameworkArns :: Maybe [Text]
- numberOfFrameworks :: Maybe Int
- organizationUnits :: Maybe [Text]
- regions :: Maybe [Text]
- reportTemplate :: Text
- newReportSetting :: Text -> ReportSetting
- reportSetting_accounts :: Lens' ReportSetting (Maybe [Text])
- reportSetting_frameworkArns :: Lens' ReportSetting (Maybe [Text])
- reportSetting_numberOfFrameworks :: Lens' ReportSetting (Maybe Int)
- reportSetting_organizationUnits :: Lens' ReportSetting (Maybe [Text])
- reportSetting_regions :: Lens' ReportSetting (Maybe [Text])
- reportSetting_reportTemplate :: Lens' ReportSetting Text
- data RestoreJobsListMember = RestoreJobsListMember' {
- accountId :: Maybe Text
- backupSizeInBytes :: Maybe Integer
- completionDate :: Maybe POSIX
- createdResourceArn :: Maybe Text
- creationDate :: Maybe POSIX
- expectedCompletionTimeMinutes :: Maybe Integer
- iamRoleArn :: Maybe Text
- percentDone :: Maybe Text
- recoveryPointArn :: Maybe Text
- resourceType :: Maybe Text
- restoreJobId :: Maybe Text
- status :: Maybe RestoreJobStatus
- statusMessage :: Maybe Text
- newRestoreJobsListMember :: RestoreJobsListMember
- restoreJobsListMember_accountId :: Lens' RestoreJobsListMember (Maybe Text)
- restoreJobsListMember_backupSizeInBytes :: Lens' RestoreJobsListMember (Maybe Integer)
- restoreJobsListMember_completionDate :: Lens' RestoreJobsListMember (Maybe UTCTime)
- restoreJobsListMember_createdResourceArn :: Lens' RestoreJobsListMember (Maybe Text)
- restoreJobsListMember_creationDate :: Lens' RestoreJobsListMember (Maybe UTCTime)
- restoreJobsListMember_expectedCompletionTimeMinutes :: Lens' RestoreJobsListMember (Maybe Integer)
- restoreJobsListMember_iamRoleArn :: Lens' RestoreJobsListMember (Maybe Text)
- restoreJobsListMember_percentDone :: Lens' RestoreJobsListMember (Maybe Text)
- restoreJobsListMember_recoveryPointArn :: Lens' RestoreJobsListMember (Maybe Text)
- restoreJobsListMember_resourceType :: Lens' RestoreJobsListMember (Maybe Text)
- restoreJobsListMember_restoreJobId :: Lens' RestoreJobsListMember (Maybe Text)
- restoreJobsListMember_status :: Lens' RestoreJobsListMember (Maybe RestoreJobStatus)
- restoreJobsListMember_statusMessage :: Lens' RestoreJobsListMember (Maybe Text)
Service Configuration
defaultService :: Service Source #
API version 2018-11-15 of the Amazon Backup SDK configuration.
Errors
_AlreadyExistsException :: AsError a => Fold a ServiceError Source #
The required resource already exists.
_ConflictException :: AsError a => Fold a ServiceError Source #
Backup can't perform the action that you requested until it finishes performing a previous action. Try again later.
_DependencyFailureException :: AsError a => Fold a ServiceError Source #
A dependent Amazon Web Services service or resource returned an error to the Backup service, and the action cannot be completed.
_InvalidParameterValueException :: AsError a => Fold a ServiceError Source #
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
_InvalidRequestException :: AsError a => Fold a ServiceError Source #
Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
_InvalidResourceStateException :: AsError a => Fold a ServiceError Source #
Backup is already performing an action on this recovery point. It can't perform the action you requested until the first action finishes. Try again later.
_LimitExceededException :: AsError a => Fold a ServiceError Source #
A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
_MissingParameterValueException :: AsError a => Fold a ServiceError Source #
Indicates that a required parameter is missing.
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
A resource that is required for the action doesn't exist.
_ServiceUnavailableException :: AsError a => Fold a ServiceError Source #
The request failed due to a temporary failure of the server.
BackupJobState
newtype BackupJobState Source #
Constructors
| BackupJobState' | |
Fields | |
Bundled Patterns
| pattern BackupJobState_ABORTED :: BackupJobState | |
| pattern BackupJobState_ABORTING :: BackupJobState | |
| pattern BackupJobState_COMPLETED :: BackupJobState | |
| pattern BackupJobState_CREATED :: BackupJobState | |
| pattern BackupJobState_EXPIRED :: BackupJobState | |
| pattern BackupJobState_FAILED :: BackupJobState | |
| pattern BackupJobState_PARTIAL :: BackupJobState | |
| pattern BackupJobState_PENDING :: BackupJobState | |
| pattern BackupJobState_RUNNING :: BackupJobState |
Instances
BackupVaultEvent
newtype BackupVaultEvent Source #
Constructors
| BackupVaultEvent' | |
Fields | |
Bundled Patterns
Instances
ConditionType
newtype ConditionType Source #
Constructors
| ConditionType' | |
Fields | |
Bundled Patterns
| pattern ConditionType_STRINGEQUALS :: ConditionType |
Instances
CopyJobState
newtype CopyJobState Source #
Constructors
| CopyJobState' | |
Fields | |
Bundled Patterns
| pattern CopyJobState_COMPLETED :: CopyJobState | |
| pattern CopyJobState_CREATED :: CopyJobState | |
| pattern CopyJobState_FAILED :: CopyJobState | |
| pattern CopyJobState_PARTIAL :: CopyJobState | |
| pattern CopyJobState_RUNNING :: CopyJobState |
Instances
LegalHoldStatus
newtype LegalHoldStatus Source #
Constructors
| LegalHoldStatus' | |
Fields | |
Bundled Patterns
| pattern LegalHoldStatus_ACTIVE :: LegalHoldStatus | |
| pattern LegalHoldStatus_CANCELED :: LegalHoldStatus | |
| pattern LegalHoldStatus_CANCELING :: LegalHoldStatus | |
| pattern LegalHoldStatus_CREATING :: LegalHoldStatus |
Instances
RecoveryPointStatus
newtype RecoveryPointStatus Source #
Constructors
| RecoveryPointStatus' | |
Fields | |
Bundled Patterns
| pattern RecoveryPointStatus_COMPLETED :: RecoveryPointStatus | |
| pattern RecoveryPointStatus_DELETING :: RecoveryPointStatus | |
| pattern RecoveryPointStatus_EXPIRED :: RecoveryPointStatus | |
| pattern RecoveryPointStatus_PARTIAL :: RecoveryPointStatus |
Instances
RestoreJobStatus
newtype RestoreJobStatus Source #
Constructors
| RestoreJobStatus' | |
Fields | |
Bundled Patterns
| pattern RestoreJobStatus_ABORTED :: RestoreJobStatus | |
| pattern RestoreJobStatus_COMPLETED :: RestoreJobStatus | |
| pattern RestoreJobStatus_FAILED :: RestoreJobStatus | |
| pattern RestoreJobStatus_PENDING :: RestoreJobStatus | |
| pattern RestoreJobStatus_RUNNING :: RestoreJobStatus |
Instances
StorageClass
newtype StorageClass Source #
Constructors
| StorageClass' | |
Fields | |
Bundled Patterns
| pattern StorageClass_COLD :: StorageClass | |
| pattern StorageClass_DELETED :: StorageClass | |
| pattern StorageClass_WARM :: StorageClass |
Instances
AdvancedBackupSetting
data AdvancedBackupSetting Source #
A list of backup options for each resource type.
See: newAdvancedBackupSetting smart constructor.
Constructors
| AdvancedBackupSetting' | |
Fields
| |
Instances
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.
BackupJob
Contains detailed information about a backup job.
See: newBackupJob smart constructor.
Constructors
| BackupJob' | |
Fields
| |
Instances
newBackupJob :: BackupJob Source #
Create a value of BackupJob 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:accountId:BackupJob', backupJob_accountId - The account ID that owns the backup job.
$sel:backupJobId:BackupJob', backupJob_backupJobId - Uniquely identifies a request to Backup to back up a resource.
$sel:backupOptions:BackupJob', backupJob_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 the
WindowsVSS backup option and create a Windows VSS backup. Set to
"WindowsVSS":"disabled" to create a regular backup. If you specify
an invalid option, you get an InvalidParameterValueException
exception.
$sel:backupSizeInBytes:BackupJob', backupJob_backupSizeInBytes - The size, in bytes, of a backup.
$sel:backupType:BackupJob', backupJob_backupType - Represents the type of backup for a backup job.
$sel:backupVaultArn:BackupJob', backupJob_backupVaultArn - An Amazon Resource Name (ARN) that uniquely identifies a backup vault;
for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
$sel:backupVaultName:BackupJob', backupJob_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.
$sel:bytesTransferred:BackupJob', backupJob_bytesTransferred - The size in bytes transferred to a backup vault at the time that the job
status was queried.
$sel:completionDate:BackupJob', backupJob_completionDate - The date and time a job to create a backup job is completed, in Unix
format and Coordinated Universal Time (UTC). The value of
CompletionDate is accurate to milliseconds. For example, the value
1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
$sel:createdBy:BackupJob', backupJob_createdBy - Contains identifying information about the creation of a backup job,
including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and
BackupRuleId of the backup plan used to create it.
$sel:creationDate:BackupJob', backupJob_creationDate - The date and time a backup job is created, in Unix format and
Coordinated Universal Time (UTC). The value of CreationDate is
accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
$sel:expectedCompletionDate:BackupJob', backupJob_expectedCompletionDate - The date and time a job to back up resources is expected to be
completed, in Unix format and Coordinated Universal Time (UTC). The
value of ExpectedCompletionDate is accurate to milliseconds. For
example, the value 1516925490.087 represents Friday, January 26, 2018
12:11:30.087 AM.
$sel:iamRoleArn:BackupJob', backupJob_iamRoleArn - Specifies the IAM role ARN used to create the target recovery point. IAM
roles other than the default role must include either AWSBackup or
AwsBackup in the role name. For example,
arn:aws:iam::123456789012:role/AWSBackupRDSAccess. Role names without
those strings lack permissions to perform backup jobs.
$sel:isParent:BackupJob', backupJob_isParent - This is a boolean value indicating this is a parent (composite) backup
job.
$sel:parentJobId:BackupJob', backupJob_parentJobId - This uniquely identifies a request to Backup to back up a resource. The
return will be the parent (composite) job ID.
$sel:percentDone:BackupJob', backupJob_percentDone - Contains an estimated percentage complete of a job at the time the job
status was queried.
$sel:recoveryPointArn:BackupJob', backupJob_recoveryPointArn - An ARN that uniquely identifies a recovery point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
$sel:resourceArn:BackupJob', backupJob_resourceArn - An ARN that uniquely identifies a resource. The format of the ARN
depends on the resource type.
$sel:resourceType:BackupJob', backupJob_resourceType - The type of Amazon Web Services resource to be backed up; for example,
an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon
Relational Database Service (Amazon RDS) database. For Windows Volume
Shadow Copy Service (VSS) backups, the only supported resource type is
Amazon EC2.
$sel:startBy:BackupJob', backupJob_startBy - Specifies the time in Unix format and Coordinated Universal Time (UTC)
when a backup job must be started before it is canceled. The value is
calculated by adding the start window to the scheduled time. So if the
scheduled time were 6:00 PM and the start window is 2 hours, the
StartBy time would be 8:00 PM on the date specified. The value of
StartBy is accurate to milliseconds. For example, the value
1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
$sel:state:BackupJob', backupJob_state - The current state of a resource recovery point.
$sel:statusMessage:BackupJob', backupJob_statusMessage - A detailed message explaining the status of the job to back up a
resource.
backupJob_accountId :: Lens' BackupJob (Maybe Text) Source #
The account ID that owns the backup job.
backupJob_backupJobId :: Lens' BackupJob (Maybe Text) Source #
Uniquely identifies a request to Backup to back up a resource.
backupJob_backupOptions :: Lens' BackupJob (Maybe (HashMap Text Text)) Source #
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 the
WindowsVSS backup option and create a Windows VSS backup. Set to
"WindowsVSS":"disabled" to create a regular backup. If you specify
an invalid option, you get an InvalidParameterValueException
exception.
backupJob_backupSizeInBytes :: Lens' BackupJob (Maybe Integer) Source #
The size, in bytes, of a backup.
backupJob_backupType :: Lens' BackupJob (Maybe Text) Source #
Represents the type of backup for a backup job.
backupJob_backupVaultArn :: Lens' BackupJob (Maybe Text) Source #
An Amazon Resource Name (ARN) that uniquely identifies a backup vault;
for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
backupJob_backupVaultName :: Lens' BackupJob (Maybe Text) Source #
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.
backupJob_bytesTransferred :: Lens' BackupJob (Maybe Integer) Source #
The size in bytes transferred to a backup vault at the time that the job status was queried.
backupJob_completionDate :: Lens' BackupJob (Maybe UTCTime) Source #
The date and time a job to create a backup job is completed, in Unix
format and Coordinated Universal Time (UTC). The value of
CompletionDate is accurate to milliseconds. For example, the value
1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
backupJob_createdBy :: Lens' BackupJob (Maybe RecoveryPointCreator) Source #
Contains identifying information about the creation of a backup job,
including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and
BackupRuleId of the backup plan used to create it.
backupJob_creationDate :: Lens' BackupJob (Maybe UTCTime) Source #
The date and time a backup job is created, in Unix format and
Coordinated Universal Time (UTC). The value of CreationDate is
accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
backupJob_expectedCompletionDate :: Lens' BackupJob (Maybe UTCTime) Source #
The date and time a job to back up resources is expected to be
completed, in Unix format and Coordinated Universal Time (UTC). The
value of ExpectedCompletionDate is accurate to milliseconds. For
example, the value 1516925490.087 represents Friday, January 26, 2018
12:11:30.087 AM.
backupJob_iamRoleArn :: Lens' BackupJob (Maybe Text) Source #
Specifies the IAM role ARN used to create the target recovery point. IAM
roles other than the default role must include either AWSBackup or
AwsBackup in the role name. For example,
arn:aws:iam::123456789012:role/AWSBackupRDSAccess. Role names without
those strings lack permissions to perform backup jobs.
backupJob_isParent :: Lens' BackupJob (Maybe Bool) Source #
This is a boolean value indicating this is a parent (composite) backup job.
backupJob_parentJobId :: Lens' BackupJob (Maybe Text) Source #
This uniquely identifies a request to Backup to back up a resource. The return will be the parent (composite) job ID.
backupJob_percentDone :: Lens' BackupJob (Maybe Text) Source #
Contains an estimated percentage complete of a job at the time the job status was queried.
backupJob_recoveryPointArn :: Lens' BackupJob (Maybe Text) Source #
An ARN that uniquely identifies a recovery point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
backupJob_resourceArn :: Lens' BackupJob (Maybe Text) Source #
An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
backupJob_resourceType :: Lens' BackupJob (Maybe Text) Source #
The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.
backupJob_startBy :: Lens' BackupJob (Maybe UTCTime) Source #
Specifies the time in Unix format and Coordinated Universal Time (UTC)
when a backup job must be started before it is canceled. The value is
calculated by adding the start window to the scheduled time. So if the
scheduled time were 6:00 PM and the start window is 2 hours, the
StartBy time would be 8:00 PM on the date specified. The value of
StartBy is accurate to milliseconds. For example, the value
1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
backupJob_state :: Lens' BackupJob (Maybe BackupJobState) Source #
The current state of a resource recovery point.
backupJob_statusMessage :: Lens' BackupJob (Maybe Text) Source #
A detailed message explaining the status of the job to back up a resource.
BackupPlan
data BackupPlan Source #
Contains an optional backup plan display name and an array of
BackupRule objects, each of which specifies a backup rule. Each rule
in a backup plan is a separate scheduled task and can back up a
different selection of Amazon Web Services resources.
See: newBackupPlan smart constructor.
Constructors
| BackupPlan' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> BackupPlan |
Create a value of BackupPlan 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:advancedBackupSettings:BackupPlan', backupPlan_advancedBackupSettings - Contains a list of BackupOptions for each resource type.
$sel:backupPlanName:BackupPlan', backupPlan_backupPlanName - The display name of a backup plan. Must contain 1 to 50 alphanumeric or
'-_.' characters.
$sel:rules:BackupPlan', backupPlan_rules - An array of BackupRule objects, each of which specifies a scheduled
task that is used to back up a selection of resources.
backupPlan_advancedBackupSettings :: Lens' BackupPlan (Maybe [AdvancedBackupSetting]) Source #
Contains a list of BackupOptions for each resource type.
backupPlan_backupPlanName :: Lens' BackupPlan Text Source #
The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-_.' characters.
backupPlan_rules :: Lens' BackupPlan [BackupRule] Source #
An array of BackupRule objects, each of which specifies a scheduled
task that is used to back up a selection of resources.
BackupPlanInput
data BackupPlanInput Source #
Contains an optional backup plan display name and an array of
BackupRule objects, each of which specifies a backup rule. Each rule
in a backup plan is a separate scheduled task.
See: newBackupPlanInput smart constructor.
Constructors
| BackupPlanInput' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> BackupPlanInput |
Create a value of BackupPlanInput 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:advancedBackupSettings:BackupPlanInput', backupPlanInput_advancedBackupSettings - Specifies a list of BackupOptions for each resource type. These
settings are only available for Windows Volume Shadow Copy Service (VSS)
backup jobs.
$sel:backupPlanName:BackupPlanInput', backupPlanInput_backupPlanName - The display name of a backup plan. Must contain 1 to 50 alphanumeric or
'-_.' characters.
$sel:rules:BackupPlanInput', backupPlanInput_rules - An array of BackupRule objects, each of which specifies a scheduled
task that is used to back up a selection of resources.
backupPlanInput_advancedBackupSettings :: Lens' BackupPlanInput (Maybe [AdvancedBackupSetting]) Source #
Specifies a list of BackupOptions for each resource type. These
settings are only available for Windows Volume Shadow Copy Service (VSS)
backup jobs.
backupPlanInput_backupPlanName :: Lens' BackupPlanInput Text Source #
The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-_.' characters.
backupPlanInput_rules :: Lens' BackupPlanInput [BackupRuleInput] Source #
An array of BackupRule objects, each of which specifies a scheduled
task that is used to back up a selection of resources.
BackupPlanTemplatesListMember
data BackupPlanTemplatesListMember Source #
An object specifying metadata associated with a backup plan template.
See: newBackupPlanTemplatesListMember smart constructor.
Constructors
| BackupPlanTemplatesListMember' | |
Fields
| |
Instances
newBackupPlanTemplatesListMember :: BackupPlanTemplatesListMember Source #
Create a value of BackupPlanTemplatesListMember 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:backupPlanTemplateId:BackupPlanTemplatesListMember', backupPlanTemplatesListMember_backupPlanTemplateId - Uniquely identifies a stored backup plan template.
$sel:backupPlanTemplateName:BackupPlanTemplatesListMember', backupPlanTemplatesListMember_backupPlanTemplateName - The optional display name of a backup plan template.
backupPlanTemplatesListMember_backupPlanTemplateId :: Lens' BackupPlanTemplatesListMember (Maybe Text) Source #
Uniquely identifies a stored backup plan template.
backupPlanTemplatesListMember_backupPlanTemplateName :: Lens' BackupPlanTemplatesListMember (Maybe Text) Source #
The optional display name of a backup plan template.
BackupPlansListMember
data BackupPlansListMember Source #
Contains metadata about a backup plan.
See: newBackupPlansListMember smart constructor.
Constructors
| BackupPlansListMember' | |
Fields
| |
Instances
newBackupPlansListMember :: BackupPlansListMember Source #
Create a value of BackupPlansListMember 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:advancedBackupSettings:BackupPlansListMember', backupPlansListMember_advancedBackupSettings - Contains a list of BackupOptions for a resource type.
$sel:backupPlanArn:BackupPlansListMember', backupPlansListMember_backupPlanArn - An Amazon Resource Name (ARN) that uniquely identifies a backup plan;
for example,
arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.
$sel:backupPlanId:BackupPlansListMember', backupPlansListMember_backupPlanId - Uniquely identifies a backup plan.
$sel:backupPlanName:BackupPlansListMember', backupPlansListMember_backupPlanName - The display name of a saved backup plan.
$sel:creationDate:BackupPlansListMember', backupPlansListMember_creationDate - The date and time a resource backup plan is created, in Unix format and
Coordinated Universal Time (UTC). The value of CreationDate is
accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
$sel:creatorRequestId:BackupPlansListMember', backupPlansListMember_creatorRequestId - A unique string that identifies the request and allows failed requests
to be retried without the risk of running the operation twice. This
parameter is optional.
If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
$sel:deletionDate:BackupPlansListMember', backupPlansListMember_deletionDate - The date and time a backup plan is deleted, in Unix format and
Coordinated Universal Time (UTC). The value of DeletionDate is
accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
$sel:lastExecutionDate:BackupPlansListMember', backupPlansListMember_lastExecutionDate - The last time a job to back up resources was run with this rule. A date
and time, in Unix format and Coordinated Universal Time (UTC). The value
of LastExecutionDate is accurate to milliseconds. For example, the
value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087
AM.
$sel:versionId:BackupPlansListMember', backupPlansListMember_versionId - Unique, randomly generated, Unicode, UTF-8 encoded strings that are at
most 1,024 bytes long. Version IDs cannot be edited.
backupPlansListMember_advancedBackupSettings :: Lens' BackupPlansListMember (Maybe [AdvancedBackupSetting]) Source #
Contains a list of BackupOptions for a resource type.
backupPlansListMember_backupPlanArn :: Lens' BackupPlansListMember (Maybe Text) Source #
An Amazon Resource Name (ARN) that uniquely identifies a backup plan;
for example,
arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.
backupPlansListMember_backupPlanId :: Lens' BackupPlansListMember (Maybe Text) Source #
Uniquely identifies a backup plan.
backupPlansListMember_backupPlanName :: Lens' BackupPlansListMember (Maybe Text) Source #
The display name of a saved backup plan.
backupPlansListMember_creationDate :: Lens' BackupPlansListMember (Maybe UTCTime) Source #
The date and time a resource backup plan is created, in Unix format and
Coordinated Universal Time (UTC). The value of CreationDate is
accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
backupPlansListMember_creatorRequestId :: Lens' BackupPlansListMember (Maybe Text) Source #
A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional.
If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
backupPlansListMember_deletionDate :: Lens' BackupPlansListMember (Maybe UTCTime) Source #
The date and time a backup plan is deleted, in Unix format and
Coordinated Universal Time (UTC). The value of DeletionDate is
accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
backupPlansListMember_lastExecutionDate :: Lens' BackupPlansListMember (Maybe UTCTime) Source #
The last time a job to back up resources was run with this rule. A date
and time, in Unix format and Coordinated Universal Time (UTC). The value
of LastExecutionDate is accurate to milliseconds. For example, the
value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087
AM.
backupPlansListMember_versionId :: Lens' BackupPlansListMember (Maybe Text) Source #
Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.
BackupRule
data BackupRule Source #
Specifies a scheduled task used to back up a selection of resources.
See: newBackupRule smart constructor.
Constructors
| BackupRule' | |
Fields
| |
Instances
Create a value of BackupRule 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:completionWindowMinutes:BackupRule', backupRule_completionWindowMinutes - A value in minutes after a backup job is successfully started before it
must be completed or it will be canceled by Backup. This value is
optional.
$sel:copyActions:BackupRule', backupRule_copyActions - An array of CopyAction objects, which contains the details of the copy
operation.
$sel:enableContinuousBackup:BackupRule', backupRule_enableContinuousBackup - Specifies whether Backup creates continuous backups. True causes Backup
to create continuous backups capable of point-in-time restore (PITR).
False (or not specified) causes Backup to create snapshot backups.
BackupRule, backupRule_lifecycle - The lifecycle defines when a protected resource is transitioned to cold
storage and when it expires. Backup transitions and expires 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.
$sel:recoveryPointTags:BackupRule', backupRule_recoveryPointTags - An array of key-value pair strings that are assigned to resources that
are associated with this rule when restored from backup.
$sel:ruleId:BackupRule', backupRule_ruleId - Uniquely identifies a rule that is used to schedule the backup of a
selection of resources.
$sel:scheduleExpression:BackupRule', backupRule_scheduleExpression - A cron expression in UTC specifying when Backup initiates a backup job.
For more information about Amazon Web Services cron expressions, see
Schedule Expressions for Rules
in the Amazon CloudWatch Events User Guide.. Two examples of Amazon
Web Services cron expressions are 15 * ? * * * (take a backup every
hour at 15 minutes past the hour) and 0 12 * * ? * (take a backup
every day at 12 noon UTC). For a table of examples, click the preceding
link and scroll down the page.
$sel:startWindowMinutes:BackupRule', backupRule_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. If
this value is included, it must be at least 60 minutes to avoid errors.
$sel:ruleName:BackupRule', backupRule_ruleName - A display name for a backup rule. Must contain 1 to 50 alphanumeric or
'-_.' characters.
$sel:targetBackupVaultName:BackupRule', backupRule_targetBackupVaultName - 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.
backupRule_completionWindowMinutes :: Lens' BackupRule (Maybe Integer) Source #
A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by Backup. This value is optional.
backupRule_copyActions :: Lens' BackupRule (Maybe [CopyAction]) Source #
An array of CopyAction objects, which contains the details of the copy
operation.
backupRule_enableContinuousBackup :: Lens' BackupRule (Maybe Bool) Source #
Specifies whether Backup creates continuous backups. True causes Backup to create continuous backups capable of point-in-time restore (PITR). False (or not specified) causes Backup to create snapshot backups.
backupRule_lifecycle :: Lens' BackupRule (Maybe Lifecycle) Source #
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires 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.
backupRule_recoveryPointTags :: Lens' BackupRule (Maybe (HashMap Text Text)) Source #
An array of key-value pair strings that are assigned to resources that are associated with this rule when restored from backup.
backupRule_ruleId :: Lens' BackupRule (Maybe Text) Source #
Uniquely identifies a rule that is used to schedule the backup of a selection of resources.
backupRule_scheduleExpression :: Lens' BackupRule (Maybe Text) Source #
A cron expression in UTC specifying when Backup initiates a backup job.
For more information about Amazon Web Services cron expressions, see
Schedule Expressions for Rules
in the Amazon CloudWatch Events User Guide.. Two examples of Amazon
Web Services cron expressions are 15 * ? * * * (take a backup every
hour at 15 minutes past the hour) and 0 12 * * ? * (take a backup
every day at 12 noon UTC). For a table of examples, click the preceding
link and scroll down the page.
backupRule_startWindowMinutes :: Lens' BackupRule (Maybe Integer) Source #
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. If this value is included, it must be at least 60 minutes to avoid errors.
backupRule_ruleName :: Lens' BackupRule Text Source #
A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters.
backupRule_targetBackupVaultName :: Lens' BackupRule Text Source #
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.
BackupRuleInput
data BackupRuleInput Source #
Specifies a scheduled task used to back up a selection of resources.
See: newBackupRuleInput smart constructor.
Constructors
| BackupRuleInput' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> BackupRuleInput |
Create a value of BackupRuleInput 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:completionWindowMinutes:BackupRuleInput', backupRuleInput_completionWindowMinutes - A value in minutes after a backup job is successfully started before it
must be completed or it will be canceled by Backup. This value is
optional.
$sel:copyActions:BackupRuleInput', backupRuleInput_copyActions - An array of CopyAction objects, which contains the details of the copy
operation.
$sel:enableContinuousBackup:BackupRuleInput', backupRuleInput_enableContinuousBackup - Specifies whether Backup creates continuous backups. True causes Backup
to create continuous backups capable of point-in-time restore (PITR).
False (or not specified) causes Backup to create snapshot backups.
BackupRuleInput, backupRuleInput_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.
$sel:recoveryPointTags:BackupRuleInput', backupRuleInput_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.
$sel:scheduleExpression:BackupRuleInput', backupRuleInput_scheduleExpression - A CRON expression in UTC specifying when Backup initiates a backup job.
$sel:startWindowMinutes:BackupRuleInput', backupRuleInput_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. If
this value is included, it must be at least 60 minutes to avoid errors.
$sel:ruleName:BackupRuleInput', backupRuleInput_ruleName - A display name for a backup rule. Must contain 1 to 50 alphanumeric or
'-_.' characters.
$sel:targetBackupVaultName:BackupRuleInput', backupRuleInput_targetBackupVaultName - 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.
backupRuleInput_completionWindowMinutes :: Lens' BackupRuleInput (Maybe Integer) Source #
A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by Backup. This value is optional.
backupRuleInput_copyActions :: Lens' BackupRuleInput (Maybe [CopyAction]) Source #
An array of CopyAction objects, which contains the details of the copy
operation.
backupRuleInput_enableContinuousBackup :: Lens' BackupRuleInput (Maybe Bool) Source #
Specifies whether Backup creates continuous backups. True causes Backup to create continuous backups capable of point-in-time restore (PITR). False (or not specified) causes Backup to create snapshot backups.
backupRuleInput_lifecycle :: Lens' BackupRuleInput (Maybe Lifecycle) Source #
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.
backupRuleInput_recoveryPointTags :: Lens' BackupRuleInput (Maybe (HashMap Text Text)) Source #
To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.
backupRuleInput_scheduleExpression :: Lens' BackupRuleInput (Maybe Text) Source #
A CRON expression in UTC specifying when Backup initiates a backup job.
backupRuleInput_startWindowMinutes :: Lens' BackupRuleInput (Maybe Integer) Source #
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. If this value is included, it must be at least 60 minutes to avoid errors.
backupRuleInput_ruleName :: Lens' BackupRuleInput Text Source #
A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters.
backupRuleInput_targetBackupVaultName :: Lens' BackupRuleInput Text Source #
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.
BackupSelection
data BackupSelection Source #
Used to specify a set of resources to a backup plan.
Specifying your desired Conditions, ListOfTags, NotResources,
and/or Resources is recommended. If none of these are specified,
Backup will attempt to select all supported and opted-in storage
resources, which could have unintended cost implications.
See: newBackupSelection smart constructor.
Constructors
| BackupSelection' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> BackupSelection |
Create a value of BackupSelection 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:conditions:BackupSelection', backupSelection_conditions - A list of conditions that you define to assign resources to your backup
plans using tags. For example,
"StringEquals": { "ConditionKey": "aws:ResourceTag/CreatedByCryo", "ConditionValue": "true" },.
Condition operators are case sensitive.
Conditions differs from ListOfTags as follows:
- When you specify more than one condition, you only assign the resources that match ALL conditions (using AND logic).
ConditionssupportsStringEquals,StringLike,StringNotEquals, andStringNotLike.ListOfTagsonly supportsStringEquals.
$sel:listOfTags:BackupSelection', backupSelection_listOfTags - A list of conditions that you define to assign resources to your backup
plans using tags. For example,
"StringEquals": { "ConditionKey": "aws:ResourceTag/CreatedByCryo", "ConditionValue": "true" },.
Condition operators are case sensitive.
ListOfTags differs from Conditions as follows:
- When you specify more than one condition, you assign all resources that match AT LEAST ONE condition (using OR logic).
ListOfTagsonly supportsStringEquals.ConditionssupportsStringEquals,StringLike,StringNotEquals, andStringNotLike.
$sel:notResources:BackupSelection', backupSelection_notResources - A list of Amazon Resource Names (ARNs) to exclude from a backup plan.
The maximum number of ARNs is 500 without wildcards, or 30 ARNs with
wildcards.
If you need to exclude many resources from a backup plan, consider a different resource selection strategy, such as assigning only one or a few resource types or refining your resource selection using tags.
$sel:resources:BackupSelection', backupSelection_resources - A list of Amazon Resource Names (ARNs) to assign to a backup plan. The
maximum number of ARNs is 500 without wildcards, or 30 ARNs with
wildcards.
If you need to assign many resources to a backup plan, consider a different resource selection strategy, such as assigning all resources of a resource type or refining your resource selection using tags.
$sel:selectionName:BackupSelection', backupSelection_selectionName - The display name of a resource selection document. Must contain 1 to 50
alphanumeric or '-_.' characters.
$sel:iamRoleArn:BackupSelection', backupSelection_iamRoleArn - The ARN of the IAM role that Backup uses to authenticate when backing up
the target resource; for example,
arn:aws:iam::123456789012:role/S3Access.
backupSelection_conditions :: Lens' BackupSelection (Maybe Conditions) Source #
A list of conditions that you define to assign resources to your backup
plans using tags. For example,
"StringEquals": { "ConditionKey": "aws:ResourceTag/CreatedByCryo", "ConditionValue": "true" },.
Condition operators are case sensitive.
Conditions differs from ListOfTags as follows:
- When you specify more than one condition, you only assign the resources that match ALL conditions (using AND logic).
ConditionssupportsStringEquals,StringLike,StringNotEquals, andStringNotLike.ListOfTagsonly supportsStringEquals.
backupSelection_listOfTags :: Lens' BackupSelection (Maybe [Condition]) Source #
A list of conditions that you define to assign resources to your backup
plans using tags. For example,
"StringEquals": { "ConditionKey": "aws:ResourceTag/CreatedByCryo", "ConditionValue": "true" },.
Condition operators are case sensitive.
ListOfTags differs from Conditions as follows:
- When you specify more than one condition, you assign all resources that match AT LEAST ONE condition (using OR logic).
ListOfTagsonly supportsStringEquals.ConditionssupportsStringEquals,StringLike,StringNotEquals, andStringNotLike.
backupSelection_notResources :: Lens' BackupSelection (Maybe [Text]) Source #
A list of Amazon Resource Names (ARNs) to exclude from a backup plan. The maximum number of ARNs is 500 without wildcards, or 30 ARNs with wildcards.
If you need to exclude many resources from a backup plan, consider a different resource selection strategy, such as assigning only one or a few resource types or refining your resource selection using tags.
backupSelection_resources :: Lens' BackupSelection (Maybe [Text]) Source #
A list of Amazon Resource Names (ARNs) to assign to a backup plan. The maximum number of ARNs is 500 without wildcards, or 30 ARNs with wildcards.
If you need to assign many resources to a backup plan, consider a different resource selection strategy, such as assigning all resources of a resource type or refining your resource selection using tags.
backupSelection_selectionName :: Lens' BackupSelection Text Source #
The display name of a resource selection document. Must contain 1 to 50 alphanumeric or '-_.' characters.
backupSelection_iamRoleArn :: Lens' BackupSelection Text Source #
The ARN of the IAM role that Backup uses to authenticate when backing up
the target resource; for example,
arn:aws:iam::123456789012:role/S3Access.
BackupSelectionsListMember
data BackupSelectionsListMember Source #
Contains metadata about a BackupSelection object.
See: newBackupSelectionsListMember smart constructor.
Constructors
| BackupSelectionsListMember' | |
Fields
| |
Instances
newBackupSelectionsListMember :: BackupSelectionsListMember Source #
Create a value of BackupSelectionsListMember 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:backupPlanId:BackupSelectionsListMember', backupSelectionsListMember_backupPlanId - Uniquely identifies a backup plan.
$sel:creationDate:BackupSelectionsListMember', backupSelectionsListMember_creationDate - The date and time a backup plan is created, in Unix format and
Coordinated Universal Time (UTC). The value of CreationDate is
accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
$sel:creatorRequestId:BackupSelectionsListMember', backupSelectionsListMember_creatorRequestId - A unique string that identifies the request and allows failed requests
to be retried without the risk of running the operation twice. This
parameter is optional.
If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
$sel:iamRoleArn:BackupSelectionsListMember', backupSelectionsListMember_iamRoleArn - Specifies the IAM role Amazon Resource Name (ARN) to create the target
recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
$sel:selectionId:BackupSelectionsListMember', backupSelectionsListMember_selectionId - Uniquely identifies a request to assign a set of resources to a backup
plan.
$sel:selectionName:BackupSelectionsListMember', backupSelectionsListMember_selectionName - The display name of a resource selection document.
backupSelectionsListMember_backupPlanId :: Lens' BackupSelectionsListMember (Maybe Text) Source #
Uniquely identifies a backup plan.
backupSelectionsListMember_creationDate :: Lens' BackupSelectionsListMember (Maybe UTCTime) Source #
The date and time a backup plan is created, in Unix format and
Coordinated Universal Time (UTC). The value of CreationDate is
accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
backupSelectionsListMember_creatorRequestId :: Lens' BackupSelectionsListMember (Maybe Text) Source #
A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional.
If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
backupSelectionsListMember_iamRoleArn :: Lens' BackupSelectionsListMember (Maybe Text) Source #
Specifies the IAM role Amazon Resource Name (ARN) to create the target
recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
backupSelectionsListMember_selectionId :: Lens' BackupSelectionsListMember (Maybe Text) Source #
Uniquely identifies a request to assign a set of resources to a backup plan.
backupSelectionsListMember_selectionName :: Lens' BackupSelectionsListMember (Maybe Text) Source #
The display name of a resource selection document.
BackupVaultListMember
data BackupVaultListMember Source #
Contains metadata about a backup vault.
See: newBackupVaultListMember smart constructor.
Constructors
| BackupVaultListMember' | |
Fields
| |
Instances
newBackupVaultListMember :: BackupVaultListMember Source #
Create a value of BackupVaultListMember 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:backupVaultArn:BackupVaultListMember', backupVaultListMember_backupVaultArn - An Amazon Resource Name (ARN) that uniquely identifies a backup vault;
for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
$sel:backupVaultName:BackupVaultListMember', backupVaultListMember_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.
$sel:creationDate:BackupVaultListMember', backupVaultListMember_creationDate - The date and time a resource backup is created, in Unix format and
Coordinated Universal Time (UTC). The value of CreationDate is
accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
$sel:creatorRequestId:BackupVaultListMember', backupVaultListMember_creatorRequestId - A unique string that identifies the request and allows failed requests
to be retried without the risk of running the operation twice. This
parameter is optional.
If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
$sel:encryptionKeyArn:BackupVaultListMember', backupVaultListMember_encryptionKeyArn - A server-side encryption key you can specify to encrypt your backups
from services that support full Backup management; for example,
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
If you specify a key, you must specify its ARN, not its alias. If you do
not specify a key, Backup creates a KMS key for you by default.
To learn which Backup services support full Backup management and how Backup handles encryption for backups from services that do not yet support full Backup, see Encryption for backups in Backup
$sel:lockDate:BackupVaultListMember', backupVaultListMember_lockDate - The date and time when Backup Vault Lock configuration becomes
immutable, meaning it cannot be changed or deleted.
If you applied Vault Lock to your vault without specifying a lock date, you can change your Vault Lock settings, or delete Vault Lock from the vault entirely, at any time.
This value is in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
$sel:locked:BackupVaultListMember', backupVaultListMember_locked - A Boolean value that indicates whether Backup Vault Lock applies to the
selected backup vault. If true, Vault Lock prevents delete and update
operations on the recovery points in the selected vault.
$sel:maxRetentionDays:BackupVaultListMember', backupVaultListMember_maxRetentionDays - The Backup Vault Lock setting that specifies the maximum retention
period that the vault retains its recovery points. If this parameter is
not specified, Vault Lock 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's 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. Recovery points already stored in the vault prior to Vault Lock are not affected.
$sel:minRetentionDays:BackupVaultListMember', backupVaultListMember_minRetentionDays - The Backup Vault Lock setting that specifies the minimum retention
period that the vault retains its recovery points. If this parameter is
not specified, Vault Lock does not enforce a minimum retention period.
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 the job's 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. Recovery points already stored in the vault prior to Vault Lock are not affected.
$sel:numberOfRecoveryPoints:BackupVaultListMember', backupVaultListMember_numberOfRecoveryPoints - The number of recovery points that are stored in a backup vault.
backupVaultListMember_backupVaultArn :: Lens' BackupVaultListMember (Maybe Text) Source #
An Amazon Resource Name (ARN) that uniquely identifies a backup vault;
for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
backupVaultListMember_backupVaultName :: Lens' BackupVaultListMember (Maybe Text) Source #
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.
backupVaultListMember_creationDate :: Lens' BackupVaultListMember (Maybe UTCTime) Source #
The date and time a resource backup is created, in Unix format and
Coordinated Universal Time (UTC). The value of CreationDate is
accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
backupVaultListMember_creatorRequestId :: Lens' BackupVaultListMember (Maybe Text) Source #
A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional.
If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
backupVaultListMember_encryptionKeyArn :: Lens' BackupVaultListMember (Maybe Text) Source #
A server-side encryption key you can specify to encrypt your backups
from services that support full Backup management; for example,
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
If you specify a key, you must specify its ARN, not its alias. If you do
not specify a key, Backup creates a KMS key for you by default.
To learn which Backup services support full Backup management and how Backup handles encryption for backups from services that do not yet support full Backup, see Encryption for backups in Backup
backupVaultListMember_lockDate :: Lens' BackupVaultListMember (Maybe UTCTime) Source #
The date and time when Backup Vault Lock configuration becomes immutable, meaning it cannot be changed or deleted.
If you applied Vault Lock to your vault without specifying a lock date, you can change your Vault Lock settings, or delete Vault Lock from the vault entirely, at any time.
This value is in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
backupVaultListMember_locked :: Lens' BackupVaultListMember (Maybe Bool) Source #
A Boolean value that indicates whether Backup Vault Lock applies to the
selected backup vault. If true, Vault Lock prevents delete and update
operations on the recovery points in the selected vault.
backupVaultListMember_maxRetentionDays :: Lens' BackupVaultListMember (Maybe Integer) Source #
The Backup Vault Lock setting that specifies the maximum retention period that the vault retains its recovery points. If this parameter is not specified, Vault Lock 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's 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. Recovery points already stored in the vault prior to Vault Lock are not affected.
backupVaultListMember_minRetentionDays :: Lens' BackupVaultListMember (Maybe Integer) Source #
The Backup Vault Lock setting that specifies the minimum retention period that the vault retains its recovery points. If this parameter is not specified, Vault Lock does not enforce a minimum retention period.
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 the job's 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. Recovery points already stored in the vault prior to Vault Lock are not affected.
backupVaultListMember_numberOfRecoveryPoints :: Lens' BackupVaultListMember (Maybe Integer) Source #
The number of recovery points that are stored in a backup vault.
CalculatedLifecycle
data CalculatedLifecycle Source #
Contains DeleteAt and MoveToColdStorageAt timestamps, which are used
to specify a lifecycle for a recovery point.
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires 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.
See: newCalculatedLifecycle smart constructor.
Constructors
| CalculatedLifecycle' | |
Instances
newCalculatedLifecycle :: CalculatedLifecycle Source #
Create a value of CalculatedLifecycle 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:deleteAt:CalculatedLifecycle', calculatedLifecycle_deleteAt - A timestamp that specifies when to delete a recovery point.
$sel:moveToColdStorageAt:CalculatedLifecycle', calculatedLifecycle_moveToColdStorageAt - A timestamp that specifies when to transition a recovery point to cold
storage.
calculatedLifecycle_deleteAt :: Lens' CalculatedLifecycle (Maybe UTCTime) Source #
A timestamp that specifies when to delete a recovery point.
calculatedLifecycle_moveToColdStorageAt :: Lens' CalculatedLifecycle (Maybe UTCTime) Source #
A timestamp that specifies when to transition a recovery point to cold storage.
Condition
Contains an array of triplets made up of a condition type (such as
StringEquals), a key, and a value. Used to filter resources using
their tags and assign them to a backup plan. Case sensitive.
See: newCondition smart constructor.
Constructors
| Condition' | |
Fields
| |
Instances
| FromJSON Condition Source # | |
| ToJSON Condition Source # | |
Defined in Amazonka.Backup.Types.Condition | |
| Generic Condition Source # | |
| Read Condition Source # | |
| Show Condition Source # | |
| NFData Condition Source # | |
Defined in Amazonka.Backup.Types.Condition | |
| Eq Condition Source # | |
| Hashable Condition Source # | |
Defined in Amazonka.Backup.Types.Condition | |
| type Rep Condition Source # | |
Defined in Amazonka.Backup.Types.Condition type Rep Condition = D1 ('MetaData "Condition" "Amazonka.Backup.Types.Condition" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "Condition'" 'PrefixI 'True) (S1 ('MetaSel ('Just "conditionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ConditionType) :*: (S1 ('MetaSel ('Just "conditionKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "conditionValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) | |
Arguments
| :: ConditionType | |
| -> Text | |
| -> Text | |
| -> Condition |
Create a value of Condition 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:conditionType:Condition', condition_conditionType - An operation applied to a key-value pair used to assign resources to
your backup plan. Condition only supports StringEquals. For more
flexible assignment options, including StringLike and the ability to
exclude resources from your backup plan, use Conditions (with an "s"
on the end) for your
BackupSelection
.
$sel:conditionKey:Condition', condition_conditionKey - The key in a key-value pair. For example, in the tag
Department: Accounting, Department is the key.
$sel:conditionValue:Condition', condition_conditionValue - The value in a key-value pair. For example, in the tag
Department: Accounting, Accounting is the value.
condition_conditionType :: Lens' Condition ConditionType Source #
An operation applied to a key-value pair used to assign resources to
your backup plan. Condition only supports StringEquals. For more
flexible assignment options, including StringLike and the ability to
exclude resources from your backup plan, use Conditions (with an "s"
on the end) for your
BackupSelection
.
condition_conditionKey :: Lens' Condition Text Source #
The key in a key-value pair. For example, in the tag
Department: Accounting, Department is the key.
condition_conditionValue :: Lens' Condition Text Source #
The value in a key-value pair. For example, in the tag
Department: Accounting, Accounting is the value.
ConditionParameter
data ConditionParameter Source #
Includes information about tags you define to assign tagged resources to a backup plan.
See: newConditionParameter smart constructor.
Constructors
| ConditionParameter' | |
Fields
| |
Instances
newConditionParameter :: ConditionParameter Source #
Create a value of ConditionParameter 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:conditionKey:ConditionParameter', conditionParameter_conditionKey - The key in a key-value pair. For example, in the tag
Department: Accounting, Department is the key.
$sel:conditionValue:ConditionParameter', conditionParameter_conditionValue - The value in a key-value pair. For example, in the tag
Department: Accounting, Accounting is the value.
conditionParameter_conditionKey :: Lens' ConditionParameter (Maybe Text) Source #
The key in a key-value pair. For example, in the tag
Department: Accounting, Department is the key.
conditionParameter_conditionValue :: Lens' ConditionParameter (Maybe Text) Source #
The value in a key-value pair. For example, in the tag
Department: Accounting, Accounting is the value.
Conditions
data Conditions Source #
Contains information about which resources to include or exclude from a backup plan using their tags. Conditions are case sensitive.
See: newConditions smart constructor.
Constructors
| Conditions' | |
Fields
| |
Instances
newConditions :: Conditions Source #
Create a value of Conditions 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:stringEquals:Conditions', conditions_stringEquals - Filters the values of your tagged resources for only those resources
that you tagged with the same value. Also called "exact matching."
$sel:stringLike:Conditions', conditions_stringLike - Filters the values of your tagged resources for matching tag values with
the use of a wildcard character (*) anywhere in the string. For example,
"prod*" or "*rod*" matches the tag value "production".
$sel:stringNotEquals:Conditions', conditions_stringNotEquals - Filters the values of your tagged resources for only those resources
that you tagged that do not have the same value. Also called "negated
matching."
$sel:stringNotLike:Conditions', conditions_stringNotLike - Filters the values of your tagged resources for non-matching tag values
with the use of a wildcard character (*) anywhere in the string.
conditions_stringEquals :: Lens' Conditions (Maybe [ConditionParameter]) Source #
Filters the values of your tagged resources for only those resources that you tagged with the same value. Also called "exact matching."
conditions_stringLike :: Lens' Conditions (Maybe [ConditionParameter]) Source #
Filters the values of your tagged resources for matching tag values with the use of a wildcard character (*) anywhere in the string. For example, "prod*" or "*rod*" matches the tag value "production".
conditions_stringNotEquals :: Lens' Conditions (Maybe [ConditionParameter]) Source #
Filters the values of your tagged resources for only those resources that you tagged that do not have the same value. Also called "negated matching."
conditions_stringNotLike :: Lens' Conditions (Maybe [ConditionParameter]) Source #
Filters the values of your tagged resources for non-matching tag values with the use of a wildcard character (*) anywhere in the string.
ControlInputParameter
data ControlInputParameter Source #
A list of parameters for a control. A control can have zero, one, or
more than one parameter. An example of a control with two parameters is:
"backup plan frequency is at least daily and the retention period is
at least 1 year". The first parameter is daily. The second
parameter is 1 year.
See: newControlInputParameter smart constructor.
Constructors
| ControlInputParameter' | |
Fields
| |
Instances
newControlInputParameter :: ControlInputParameter Source #
Create a value of ControlInputParameter 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:parameterName:ControlInputParameter', controlInputParameter_parameterName - The name of a parameter, for example, BackupPlanFrequency.
$sel:parameterValue:ControlInputParameter', controlInputParameter_parameterValue - The value of parameter, for example, hourly.
controlInputParameter_parameterName :: Lens' ControlInputParameter (Maybe Text) Source #
The name of a parameter, for example, BackupPlanFrequency.
controlInputParameter_parameterValue :: Lens' ControlInputParameter (Maybe Text) Source #
The value of parameter, for example, hourly.
ControlScope
data ControlScope Source #
A framework consists of one or more controls. Each control has its own control scope. The control scope can include one or more resource types, a combination of a tag key and value, or a combination of one resource type and one resource ID. If no scope is specified, evaluations for the rule are triggered when any resource in your recording group changes in configuration.
To set a control scope that includes all of a particular resource, leave
the ControlScope empty or do not pass it when calling
CreateFramework.
See: newControlScope smart constructor.
Constructors
| ControlScope' | |
Fields
| |
Instances
newControlScope :: ControlScope Source #
Create a value of ControlScope 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:complianceResourceIds:ControlScope', controlScope_complianceResourceIds - The ID of the only Amazon Web Services resource that you want your
control scope to contain.
$sel:complianceResourceTypes:ControlScope', controlScope_complianceResourceTypes - Describes whether the control scope includes one or more types of
resources, such as EFS or RDS.
$sel:tags:ControlScope', controlScope_tags - The tag key-value pair applied to those Amazon Web Services resources
that you want to trigger an evaluation for a rule. A maximum of one
key-value pair can be provided. The tag value is optional, but it cannot
be an empty string. The structure to assign a tag is:
[{"Key":"string","Value":"string"}].
controlScope_complianceResourceIds :: Lens' ControlScope (Maybe (NonEmpty Text)) Source #
The ID of the only Amazon Web Services resource that you want your control scope to contain.
controlScope_complianceResourceTypes :: Lens' ControlScope (Maybe [Text]) Source #
Describes whether the control scope includes one or more types of
resources, such as EFS or RDS.
controlScope_tags :: Lens' ControlScope (Maybe (HashMap Text Text)) Source #
The tag key-value pair applied to those Amazon Web Services resources
that you want to trigger an evaluation for a rule. A maximum of one
key-value pair can be provided. The tag value is optional, but it cannot
be an empty string. The structure to assign a tag is:
[{"Key":"string","Value":"string"}].
CopyAction
data CopyAction Source #
The details of the copy operation.
See: newCopyAction smart constructor.
Constructors
| CopyAction' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> CopyAction |
Create a value of CopyAction 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:lifecycle:CopyAction', copyAction_lifecycle - Undocumented member.
$sel:destinationBackupVaultArn:CopyAction', copyAction_destinationBackupVaultArn - An Amazon Resource Name (ARN) that uniquely identifies the destination
backup vault for the copied backup. For example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
copyAction_lifecycle :: Lens' CopyAction (Maybe Lifecycle) Source #
Undocumented member.
copyAction_destinationBackupVaultArn :: Lens' CopyAction Text Source #
An Amazon Resource Name (ARN) that uniquely identifies the destination
backup vault for the copied backup. For example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
CopyJob
Contains detailed information about a copy job.
See: newCopyJob smart constructor.
Constructors
| CopyJob' | |
Fields
| |
Instances
newCopyJob :: CopyJob Source #
Create a value of CopyJob 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:accountId:CopyJob', copyJob_accountId - The account ID that owns the copy job.
$sel:backupSizeInBytes:CopyJob', copyJob_backupSizeInBytes - The size, in bytes, of a copy job.
$sel:childJobsInState:CopyJob', copyJob_childJobsInState - This returns the statistics of the included child (nested) copy jobs.
$sel:completionDate:CopyJob', copyJob_completionDate - The date and time a copy job is completed, in Unix format and
Coordinated Universal Time (UTC). The value of CompletionDate is
accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
$sel:compositeMemberIdentifier:CopyJob', copyJob_compositeMemberIdentifier - This is the identifier of a resource within a composite group, such as
nested (child) recovery point belonging to a composite (parent) stack.
The ID is transferred from the
logical ID
within a stack.
$sel:copyJobId:CopyJob', copyJob_copyJobId - Uniquely identifies a copy job.
$sel:createdBy:CopyJob', copyJob_createdBy - Undocumented member.
$sel:creationDate:CopyJob', copyJob_creationDate - The date and time a copy job is created, in Unix format and Coordinated
Universal Time (UTC). The value of CreationDate is accurate to
milliseconds. For example, the value 1516925490.087 represents Friday,
January 26, 2018 12:11:30.087 AM.
$sel:destinationBackupVaultArn:CopyJob', copyJob_destinationBackupVaultArn - An Amazon Resource Name (ARN) that uniquely identifies a destination
copy vault; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
$sel:destinationRecoveryPointArn:CopyJob', copyJob_destinationRecoveryPointArn - An ARN that uniquely identifies a destination recovery point; for
example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
$sel:iamRoleArn:CopyJob', copyJob_iamRoleArn - Specifies the IAM role ARN used to copy the target recovery point; for
example, arn:aws:iam::123456789012:role/S3Access.
$sel:isParent:CopyJob', copyJob_isParent - This is a boolean value indicating this is a parent (composite) copy
job.
$sel:numberOfChildJobs:CopyJob', copyJob_numberOfChildJobs - This is the number of child (nested) copy jobs.
$sel:parentJobId:CopyJob', copyJob_parentJobId - This uniquely identifies a request to Backup to copy a resource. The
return will be the parent (composite) job ID.
$sel:resourceArn:CopyJob', copyJob_resourceArn - The Amazon Web Services resource to be copied; for example, an Amazon
Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database
Service (Amazon RDS) database.
$sel:resourceType:CopyJob', copyJob_resourceType - The type of Amazon Web Services resource to be copied; for example, an
Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational
Database Service (Amazon RDS) database.
$sel:sourceBackupVaultArn:CopyJob', copyJob_sourceBackupVaultArn - An Amazon Resource Name (ARN) that uniquely identifies a source copy
vault; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
$sel:sourceRecoveryPointArn:CopyJob', copyJob_sourceRecoveryPointArn - An ARN that uniquely identifies a source recovery point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
$sel:state:CopyJob', copyJob_state - The current state of a copy job.
$sel:statusMessage:CopyJob', copyJob_statusMessage - A detailed message explaining the status of the job to copy a resource.
copyJob_backupSizeInBytes :: Lens' CopyJob (Maybe Integer) Source #
The size, in bytes, of a copy job.
copyJob_childJobsInState :: Lens' CopyJob (Maybe (HashMap CopyJobState Integer)) Source #
This returns the statistics of the included child (nested) copy jobs.
copyJob_completionDate :: Lens' CopyJob (Maybe UTCTime) Source #
The date and time a copy job is completed, in Unix format and
Coordinated Universal Time (UTC). The value of CompletionDate is
accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
copyJob_compositeMemberIdentifier :: Lens' CopyJob (Maybe Text) Source #
This is the identifier of a resource within a composite group, such as nested (child) recovery point belonging to a composite (parent) stack. The ID is transferred from the logical ID within a stack.
copyJob_createdBy :: Lens' CopyJob (Maybe RecoveryPointCreator) Source #
Undocumented member.
copyJob_creationDate :: Lens' CopyJob (Maybe UTCTime) Source #
The date and time a copy job is created, in Unix format and Coordinated
Universal Time (UTC). The value of CreationDate is accurate to
milliseconds. For example, the value 1516925490.087 represents Friday,
January 26, 2018 12:11:30.087 AM.
copyJob_destinationBackupVaultArn :: Lens' CopyJob (Maybe Text) Source #
An Amazon Resource Name (ARN) that uniquely identifies a destination
copy vault; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
copyJob_destinationRecoveryPointArn :: Lens' CopyJob (Maybe Text) Source #
An ARN that uniquely identifies a destination recovery point; for
example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
copyJob_iamRoleArn :: Lens' CopyJob (Maybe Text) Source #
Specifies the IAM role ARN used to copy the target recovery point; for
example, arn:aws:iam::123456789012:role/S3Access.
copyJob_isParent :: Lens' CopyJob (Maybe Bool) Source #
This is a boolean value indicating this is a parent (composite) copy job.
copyJob_numberOfChildJobs :: Lens' CopyJob (Maybe Integer) Source #
This is the number of child (nested) copy jobs.
copyJob_parentJobId :: Lens' CopyJob (Maybe Text) Source #
This uniquely identifies a request to Backup to copy a resource. The return will be the parent (composite) job ID.
copyJob_resourceArn :: Lens' CopyJob (Maybe Text) Source #
The Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
copyJob_resourceType :: Lens' CopyJob (Maybe Text) Source #
The type of Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
copyJob_sourceBackupVaultArn :: Lens' CopyJob (Maybe Text) Source #
An Amazon Resource Name (ARN) that uniquely identifies a source copy
vault; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
copyJob_sourceRecoveryPointArn :: Lens' CopyJob (Maybe Text) Source #
An ARN that uniquely identifies a source recovery point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
copyJob_state :: Lens' CopyJob (Maybe CopyJobState) Source #
The current state of a copy job.
copyJob_statusMessage :: Lens' CopyJob (Maybe Text) Source #
A detailed message explaining the status of the job to copy a resource.
DateRange
This is a resource filter containing FromDate: DateTime and ToDate: DateTime. Both values are required. Future DateTime values are not permitted.
The date and time are in Unix format and Coordinated Universal Time (UTC), and it is accurate to milliseconds ((milliseconds are optional). For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
See: newDateRange smart constructor.
Constructors
| DateRange' | |
Fields
| |
Instances
| FromJSON DateRange Source # | |
| ToJSON DateRange Source # | |
Defined in Amazonka.Backup.Types.DateRange | |
| Generic DateRange Source # | |
| Read DateRange Source # | |
| Show DateRange Source # | |
| NFData DateRange Source # | |
Defined in Amazonka.Backup.Types.DateRange | |
| Eq DateRange Source # | |
| Hashable DateRange Source # | |
Defined in Amazonka.Backup.Types.DateRange | |
| type Rep DateRange Source # | |
Defined in Amazonka.Backup.Types.DateRange type Rep DateRange = D1 ('MetaData "DateRange" "Amazonka.Backup.Types.DateRange" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "DateRange'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "toDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX))) | |
Create a value of DateRange 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:fromDate:DateRange', dateRange_fromDate - This value is the beginning date, inclusive.
The date and time are in Unix format and Coordinated Universal Time (UTC), and it is accurate to milliseconds (milliseconds are optional).
$sel:toDate:DateRange', dateRange_toDate - This value is the end date, inclusive.
The date and time are in Unix format and Coordinated Universal Time (UTC), and it is accurate to milliseconds (milliseconds are optional).
dateRange_fromDate :: Lens' DateRange UTCTime Source #
This value is the beginning date, inclusive.
The date and time are in Unix format and Coordinated Universal Time (UTC), and it is accurate to milliseconds (milliseconds are optional).
dateRange_toDate :: Lens' DateRange UTCTime Source #
This value is the end date, inclusive.
The date and time are in Unix format and Coordinated Universal Time (UTC), and it is accurate to milliseconds (milliseconds are optional).
Framework
Contains detailed information about a framework. Frameworks contain controls, which evaluate and report on your backup events and resources. Frameworks generate daily compliance results.
See: newFramework smart constructor.
Constructors
| Framework' | |
Fields
| |
Instances
newFramework :: Framework Source #
Create a value of Framework 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:creationTime:Framework', framework_creationTime - The date and time that a framework is created, in ISO 8601
representation. The value of CreationTime is accurate to milliseconds.
For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July
2020 at 3:00 PM 8 hours behind UTC.
$sel:deploymentStatus:Framework', framework_deploymentStatus - The deployment status of a framework. The statuses are:
CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED
$sel:frameworkArn:Framework', framework_frameworkArn - An Amazon Resource Name (ARN) that uniquely identifies a resource. The
format of the ARN depends on the resource type.
$sel:frameworkDescription:Framework', framework_frameworkDescription - An optional description of the framework with a maximum 1,024
characters.
$sel:frameworkName:Framework', framework_frameworkName - The unique name of a framework. This name is between 1 and 256
characters, starting with a letter, and consisting of letters (a-z,
A-Z), numbers (0-9), and underscores (_).
$sel:numberOfControls:Framework', framework_numberOfControls - The number of controls contained by the framework.
framework_creationTime :: Lens' Framework (Maybe UTCTime) Source #
The date and time that a framework is created, in ISO 8601
representation. The value of CreationTime is accurate to milliseconds.
For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July
2020 at 3:00 PM 8 hours behind UTC.
framework_deploymentStatus :: Lens' Framework (Maybe Text) Source #
The deployment status of a framework. The statuses are:
CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED
framework_frameworkArn :: Lens' Framework (Maybe Text) Source #
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
framework_frameworkDescription :: Lens' Framework (Maybe Text) Source #
An optional description of the framework with a maximum 1,024 characters.
framework_frameworkName :: Lens' Framework (Maybe Text) Source #
The unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
framework_numberOfControls :: Lens' Framework (Maybe Int) Source #
The number of controls contained by the framework.
FrameworkControl
data FrameworkControl Source #
Contains detailed information about all of the controls of a framework. Each framework must contain at least one control.
See: newFrameworkControl smart constructor.
Constructors
| FrameworkControl' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> FrameworkControl |
Create a value of FrameworkControl 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:controlInputParameters:FrameworkControl', frameworkControl_controlInputParameters - A list of ParameterName and ParameterValue pairs.
$sel:controlScope:FrameworkControl', frameworkControl_controlScope - The scope of a control. The control scope defines what the control will
evaluate. Three examples of control scopes are: a specific backup plan,
all backup plans with a specific tag, or all backup plans. For more
information, see
ControlScope.
$sel:controlName:FrameworkControl', frameworkControl_controlName - The name of a control. This name is between 1 and 256 characters.
frameworkControl_controlInputParameters :: Lens' FrameworkControl (Maybe [ControlInputParameter]) Source #
A list of ParameterName and ParameterValue pairs.
frameworkControl_controlScope :: Lens' FrameworkControl (Maybe ControlScope) Source #
The scope of a control. The control scope defines what the control will evaluate. Three examples of control scopes are: a specific backup plan, all backup plans with a specific tag, or all backup plans. For more information, see ControlScope.
frameworkControl_controlName :: Lens' FrameworkControl Text Source #
The name of a control. This name is between 1 and 256 characters.
LegalHold
A legal hold is an administrative tool that helps prevent backups from being deleted while under a hold. While the hold is in place, backups under a hold cannot be deleted and lifecycle policies that would alter the backup status (such as transition to cold storage) are delayed until the legal hold is removed. A backup can have more than one legal hold. Legal holds are applied to one or more backups (also known as recovery points). These backups can be filtered by resource types and by resource IDs.
See: newLegalHold smart constructor.
Constructors
| LegalHold' | |
Fields
| |
Instances
newLegalHold :: LegalHold Source #
Create a value of LegalHold 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:cancellationDate:LegalHold', legalHold_cancellationDate - This is the time in number format when legal hold was cancelled.
$sel:creationDate:LegalHold', legalHold_creationDate - This is the time in number format when legal hold was created.
$sel:description:LegalHold', legalHold_description - This is the description of a legal hold.
$sel:legalHoldArn:LegalHold', legalHold_legalHoldArn - This is an Amazon Resource Number (ARN) that uniquely identifies the
legal hold; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
$sel:legalHoldId:LegalHold', legalHold_legalHoldId - ID of specific legal hold on one or more recovery points.
$sel:status:LegalHold', legalHold_status - This is the status of the legal hold. Statuses can be ACTIVE,
CREATING, CANCELED, and CANCELING.
$sel:title:LegalHold', legalHold_title - This is the title of a legal hold.
legalHold_cancellationDate :: Lens' LegalHold (Maybe UTCTime) Source #
This is the time in number format when legal hold was cancelled.
legalHold_creationDate :: Lens' LegalHold (Maybe UTCTime) Source #
This is the time in number format when legal hold was created.
legalHold_description :: Lens' LegalHold (Maybe Text) Source #
This is the description of a legal hold.
legalHold_legalHoldArn :: Lens' LegalHold (Maybe Text) Source #
This is an Amazon Resource Number (ARN) that uniquely identifies the
legal hold; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
legalHold_legalHoldId :: Lens' LegalHold (Maybe Text) Source #
ID of specific legal hold on one or more recovery points.
legalHold_status :: Lens' LegalHold (Maybe LegalHoldStatus) Source #
This is the status of the legal hold. Statuses can be ACTIVE,
CREATING, CANCELED, and CANCELING.
Lifecycle
Contains an array of Transition objects specifying how long in days
before a recovery point transitions to cold storage or is deleted.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, on the console, 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.
See: newLifecycle smart constructor.
Constructors
| Lifecycle' | |
Fields
| |
Instances
| FromJSON Lifecycle Source # | |
| ToJSON Lifecycle Source # | |
Defined in Amazonka.Backup.Types.Lifecycle | |
| Generic Lifecycle Source # | |
| Read Lifecycle Source # | |
| Show Lifecycle Source # | |
| NFData Lifecycle Source # | |
Defined in Amazonka.Backup.Types.Lifecycle | |
| Eq Lifecycle Source # | |
| Hashable Lifecycle Source # | |
Defined in Amazonka.Backup.Types.Lifecycle | |
| type Rep Lifecycle Source # | |
Defined in Amazonka.Backup.Types.Lifecycle type Rep Lifecycle = D1 ('MetaData "Lifecycle" "Amazonka.Backup.Types.Lifecycle" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "Lifecycle'" 'PrefixI 'True) (S1 ('MetaSel ('Just "deleteAfterDays") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "moveToColdStorageAfterDays") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))) | |
newLifecycle :: Lifecycle Source #
Create a value of Lifecycle 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:deleteAfterDays:Lifecycle', lifecycle_deleteAfterDays - Specifies the number of days after creation that a recovery point is
deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays.
$sel:moveToColdStorageAfterDays:Lifecycle', lifecycle_moveToColdStorageAfterDays - Specifies the number of days after creation that a recovery point is
moved to cold storage.
lifecycle_deleteAfterDays :: Lens' Lifecycle (Maybe Integer) Source #
Specifies the number of days after creation that a recovery point is
deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays.
lifecycle_moveToColdStorageAfterDays :: Lens' Lifecycle (Maybe Integer) Source #
Specifies the number of days after creation that a recovery point is moved to cold storage.
ProtectedResource
data ProtectedResource Source #
A structure that contains information about a backed-up resource.
See: newProtectedResource smart constructor.
Constructors
| ProtectedResource' | |
Fields
| |
Instances
newProtectedResource :: ProtectedResource Source #
Create a value of ProtectedResource 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:lastBackupTime:ProtectedResource', protectedResource_lastBackupTime - The date and time a resource was last backed up, in Unix format and
Coordinated Universal Time (UTC). The value of LastBackupTime is
accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
$sel:resourceArn:ProtectedResource', protectedResource_resourceArn - An Amazon Resource Name (ARN) that uniquely identifies a resource. The
format of the ARN depends on the resource type.
$sel:resourceType:ProtectedResource', protectedResource_resourceType - The type of Amazon Web Services resource; for example, an Amazon Elastic
Block Store (Amazon EBS) volume or an Amazon Relational Database Service
(Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS)
backups, the only supported resource type is Amazon EC2.
protectedResource_lastBackupTime :: Lens' ProtectedResource (Maybe UTCTime) Source #
The date and time a resource was last backed up, in Unix format and
Coordinated Universal Time (UTC). The value of LastBackupTime is
accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
protectedResource_resourceArn :: Lens' ProtectedResource (Maybe Text) Source #
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
protectedResource_resourceType :: Lens' ProtectedResource (Maybe Text) Source #
The type of Amazon Web Services resource; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.
RecoveryPointByBackupVault
data RecoveryPointByBackupVault Source #
Contains detailed information about the recovery points stored in a backup vault.
See: newRecoveryPointByBackupVault smart constructor.
Constructors
| RecoveryPointByBackupVault' | |
Fields
| |
Instances
newRecoveryPointByBackupVault :: RecoveryPointByBackupVault Source #
Create a value of RecoveryPointByBackupVault 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:backupSizeInBytes:RecoveryPointByBackupVault', recoveryPointByBackupVault_backupSizeInBytes - The size, in bytes, of a backup.
$sel:backupVaultArn:RecoveryPointByBackupVault', recoveryPointByBackupVault_backupVaultArn - An ARN that uniquely identifies a backup vault; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
$sel:backupVaultName:RecoveryPointByBackupVault', recoveryPointByBackupVault_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.
$sel:calculatedLifecycle:RecoveryPointByBackupVault', recoveryPointByBackupVault_calculatedLifecycle - A CalculatedLifecycle object containing DeleteAt and
MoveToColdStorageAt timestamps.
$sel:completionDate:RecoveryPointByBackupVault', recoveryPointByBackupVault_completionDate - The date and time a job to restore a recovery point is completed, in
Unix format and Coordinated Universal Time (UTC). The value of
CompletionDate is accurate to milliseconds. For example, the value
1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
$sel:compositeMemberIdentifier:RecoveryPointByBackupVault', recoveryPointByBackupVault_compositeMemberIdentifier - This is the identifier of a resource within a composite group, such as
nested (child) recovery point belonging to a composite (parent) stack.
The ID is transferred from the
logical ID
within a stack.
$sel:createdBy:RecoveryPointByBackupVault', recoveryPointByBackupVault_createdBy - Contains identifying information about the creation of a recovery point,
including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and
BackupRuleId of the backup plan that is used to create it.
$sel:creationDate:RecoveryPointByBackupVault', recoveryPointByBackupVault_creationDate - The date and time a recovery point is created, in Unix format and
Coordinated Universal Time (UTC). The value of CreationDate is
accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
$sel:encryptionKeyArn:RecoveryPointByBackupVault', recoveryPointByBackupVault_encryptionKeyArn - The server-side encryption key that is used to protect your backups; for
example,
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
$sel:iamRoleArn:RecoveryPointByBackupVault', recoveryPointByBackupVault_iamRoleArn - Specifies the IAM role ARN used to create the target recovery point; for
example, arn:aws:iam::123456789012:role/S3Access.
$sel:isEncrypted:RecoveryPointByBackupVault', recoveryPointByBackupVault_isEncrypted - A Boolean value that is returned as TRUE if the specified recovery
point is encrypted, or FALSE if the recovery point is not encrypted.
$sel:isParent:RecoveryPointByBackupVault', recoveryPointByBackupVault_isParent - This is a boolean value indicating this is a parent (composite) recovery
point.
$sel:lastRestoreTime:RecoveryPointByBackupVault', recoveryPointByBackupVault_lastRestoreTime - The date and time a recovery point was last restored, in Unix format and
Coordinated Universal Time (UTC). The value of LastRestoreTime is
accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
$sel:lifecycle:RecoveryPointByBackupVault', recoveryPointByBackupVault_lifecycle - The lifecycle defines when a protected resource is transitioned to cold
storage and when it expires. Backup transitions and expires 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.
$sel:parentRecoveryPointArn:RecoveryPointByBackupVault', recoveryPointByBackupVault_parentRecoveryPointArn - This is the Amazon Resource Name (ARN) of the parent (composite)
recovery point.
$sel:recoveryPointArn:RecoveryPointByBackupVault', recoveryPointByBackupVault_recoveryPointArn - An Amazon Resource Name (ARN) that uniquely identifies a recovery point;
for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
$sel:resourceArn:RecoveryPointByBackupVault', recoveryPointByBackupVault_resourceArn - An ARN that uniquely identifies a resource. The format of the ARN
depends on the resource type.
$sel:resourceType:RecoveryPointByBackupVault', recoveryPointByBackupVault_resourceType - The type of Amazon Web Services resource saved as a recovery point; for
example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon
Relational Database Service (Amazon RDS) database. For Windows Volume
Shadow Copy Service (VSS) backups, the only supported resource type is
Amazon EC2.
$sel:sourceBackupVaultArn:RecoveryPointByBackupVault', recoveryPointByBackupVault_sourceBackupVaultArn - The backup vault where the recovery point was originally copied from. If
the recovery point is restored to the same account this value will be
null.
$sel:status:RecoveryPointByBackupVault', recoveryPointByBackupVault_status - A status code specifying the state of the recovery point.
$sel:statusMessage:RecoveryPointByBackupVault', recoveryPointByBackupVault_statusMessage - A message explaining the reason of the recovery point deletion failure.
recoveryPointByBackupVault_backupSizeInBytes :: Lens' RecoveryPointByBackupVault (Maybe Integer) Source #
The size, in bytes, of a backup.
recoveryPointByBackupVault_backupVaultArn :: Lens' RecoveryPointByBackupVault (Maybe Text) Source #
An ARN that uniquely identifies a backup vault; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
recoveryPointByBackupVault_backupVaultName :: Lens' RecoveryPointByBackupVault (Maybe Text) Source #
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.
recoveryPointByBackupVault_calculatedLifecycle :: Lens' RecoveryPointByBackupVault (Maybe CalculatedLifecycle) Source #
A CalculatedLifecycle object containing DeleteAt and
MoveToColdStorageAt timestamps.
recoveryPointByBackupVault_completionDate :: Lens' RecoveryPointByBackupVault (Maybe UTCTime) Source #
The date and time a job to restore a recovery point is completed, in
Unix format and Coordinated Universal Time (UTC). The value of
CompletionDate is accurate to milliseconds. For example, the value
1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
recoveryPointByBackupVault_compositeMemberIdentifier :: Lens' RecoveryPointByBackupVault (Maybe Text) Source #
This is the identifier of a resource within a composite group, such as nested (child) recovery point belonging to a composite (parent) stack. The ID is transferred from the logical ID within a stack.
recoveryPointByBackupVault_createdBy :: Lens' RecoveryPointByBackupVault (Maybe RecoveryPointCreator) Source #
Contains identifying information about the creation of a recovery point,
including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and
BackupRuleId of the backup plan that is used to create it.
recoveryPointByBackupVault_creationDate :: Lens' RecoveryPointByBackupVault (Maybe UTCTime) Source #
The date and time a recovery point is created, in Unix format and
Coordinated Universal Time (UTC). The value of CreationDate is
accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
recoveryPointByBackupVault_encryptionKeyArn :: Lens' RecoveryPointByBackupVault (Maybe Text) Source #
The server-side encryption key that is used to protect your backups; for
example,
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
recoveryPointByBackupVault_iamRoleArn :: Lens' RecoveryPointByBackupVault (Maybe Text) Source #
Specifies the IAM role ARN used to create the target recovery point; for
example, arn:aws:iam::123456789012:role/S3Access.
recoveryPointByBackupVault_isEncrypted :: Lens' RecoveryPointByBackupVault (Maybe Bool) Source #
A Boolean value that is returned as TRUE if the specified recovery
point is encrypted, or FALSE if the recovery point is not encrypted.
recoveryPointByBackupVault_isParent :: Lens' RecoveryPointByBackupVault (Maybe Bool) Source #
This is a boolean value indicating this is a parent (composite) recovery point.
recoveryPointByBackupVault_lastRestoreTime :: Lens' RecoveryPointByBackupVault (Maybe UTCTime) Source #
The date and time a recovery point was last restored, in Unix format and
Coordinated Universal Time (UTC). The value of LastRestoreTime is
accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
recoveryPointByBackupVault_lifecycle :: Lens' RecoveryPointByBackupVault (Maybe Lifecycle) Source #
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires 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.
recoveryPointByBackupVault_parentRecoveryPointArn :: Lens' RecoveryPointByBackupVault (Maybe Text) Source #
This is the Amazon Resource Name (ARN) of the parent (composite) recovery point.
recoveryPointByBackupVault_recoveryPointArn :: Lens' RecoveryPointByBackupVault (Maybe Text) Source #
An Amazon Resource Name (ARN) that uniquely identifies a recovery point;
for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
recoveryPointByBackupVault_resourceArn :: Lens' RecoveryPointByBackupVault (Maybe Text) Source #
An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
recoveryPointByBackupVault_resourceType :: Lens' RecoveryPointByBackupVault (Maybe Text) Source #
The type of Amazon Web Services resource saved as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.
recoveryPointByBackupVault_sourceBackupVaultArn :: Lens' RecoveryPointByBackupVault (Maybe Text) Source #
The backup vault where the recovery point was originally copied from. If
the recovery point is restored to the same account this value will be
null.
recoveryPointByBackupVault_status :: Lens' RecoveryPointByBackupVault (Maybe RecoveryPointStatus) Source #
A status code specifying the state of the recovery point.
recoveryPointByBackupVault_statusMessage :: Lens' RecoveryPointByBackupVault (Maybe Text) Source #
A message explaining the reason of the recovery point deletion failure.
RecoveryPointByResource
data RecoveryPointByResource Source #
Contains detailed information about a saved recovery point.
See: newRecoveryPointByResource smart constructor.
Constructors
| RecoveryPointByResource' | |
Fields
| |
Instances
newRecoveryPointByResource :: RecoveryPointByResource Source #
Create a value of RecoveryPointByResource 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:backupSizeBytes:RecoveryPointByResource', recoveryPointByResource_backupSizeBytes - The size, in bytes, of a backup.
$sel:backupVaultName:RecoveryPointByResource', recoveryPointByResource_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.
$sel:creationDate:RecoveryPointByResource', recoveryPointByResource_creationDate - The date and time a recovery point is created, in Unix format and
Coordinated Universal Time (UTC). The value of CreationDate is
accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
$sel:encryptionKeyArn:RecoveryPointByResource', recoveryPointByResource_encryptionKeyArn - The server-side encryption key that is used to protect your backups; for
example,
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
$sel:isParent:RecoveryPointByResource', recoveryPointByResource_isParent - This is a boolean value indicating this is a parent (composite) recovery
point.
$sel:parentRecoveryPointArn:RecoveryPointByResource', recoveryPointByResource_parentRecoveryPointArn - This is the Amazon Resource Name (ARN) of the parent (composite)
recovery point.
$sel:recoveryPointArn:RecoveryPointByResource', recoveryPointByResource_recoveryPointArn - An Amazon Resource Name (ARN) that uniquely identifies a recovery point;
for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
$sel:status:RecoveryPointByResource', recoveryPointByResource_status - A status code specifying the state of the recovery point.
$sel:statusMessage:RecoveryPointByResource', recoveryPointByResource_statusMessage - A message explaining the reason of the recovery point deletion failure.
recoveryPointByResource_backupSizeBytes :: Lens' RecoveryPointByResource (Maybe Integer) Source #
The size, in bytes, of a backup.
recoveryPointByResource_backupVaultName :: Lens' RecoveryPointByResource (Maybe Text) Source #
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.
recoveryPointByResource_creationDate :: Lens' RecoveryPointByResource (Maybe UTCTime) Source #
The date and time a recovery point is created, in Unix format and
Coordinated Universal Time (UTC). The value of CreationDate is
accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
recoveryPointByResource_encryptionKeyArn :: Lens' RecoveryPointByResource (Maybe Text) Source #
The server-side encryption key that is used to protect your backups; for
example,
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
recoveryPointByResource_isParent :: Lens' RecoveryPointByResource (Maybe Bool) Source #
This is a boolean value indicating this is a parent (composite) recovery point.
recoveryPointByResource_parentRecoveryPointArn :: Lens' RecoveryPointByResource (Maybe Text) Source #
This is the Amazon Resource Name (ARN) of the parent (composite) recovery point.
recoveryPointByResource_recoveryPointArn :: Lens' RecoveryPointByResource (Maybe Text) Source #
An Amazon Resource Name (ARN) that uniquely identifies a recovery point;
for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
recoveryPointByResource_status :: Lens' RecoveryPointByResource (Maybe RecoveryPointStatus) Source #
A status code specifying the state of the recovery point.
recoveryPointByResource_statusMessage :: Lens' RecoveryPointByResource (Maybe Text) Source #
A message explaining the reason of the recovery point deletion failure.
RecoveryPointCreator
data RecoveryPointCreator Source #
Contains information about the backup plan and rule that Backup used to initiate the recovery point backup.
See: newRecoveryPointCreator smart constructor.
Constructors
| RecoveryPointCreator' | |
Fields
| |
Instances
newRecoveryPointCreator :: RecoveryPointCreator Source #
Create a value of RecoveryPointCreator 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:backupPlanArn:RecoveryPointCreator', recoveryPointCreator_backupPlanArn - An Amazon Resource Name (ARN) that uniquely identifies a backup plan;
for example,
arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.
$sel:backupPlanId:RecoveryPointCreator', recoveryPointCreator_backupPlanId - Uniquely identifies a backup plan.
$sel:backupPlanVersion:RecoveryPointCreator', recoveryPointCreator_backupPlanVersion - Version IDs are unique, randomly generated, Unicode, UTF-8 encoded
strings that are at most 1,024 bytes long. They cannot be edited.
$sel:backupRuleId:RecoveryPointCreator', recoveryPointCreator_backupRuleId - Uniquely identifies a rule used to schedule the backup of a selection of
resources.
recoveryPointCreator_backupPlanArn :: Lens' RecoveryPointCreator (Maybe Text) Source #
An Amazon Resource Name (ARN) that uniquely identifies a backup plan;
for example,
arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.
recoveryPointCreator_backupPlanId :: Lens' RecoveryPointCreator (Maybe Text) Source #
Uniquely identifies a backup plan.
recoveryPointCreator_backupPlanVersion :: Lens' RecoveryPointCreator (Maybe Text) Source #
Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited.
recoveryPointCreator_backupRuleId :: Lens' RecoveryPointCreator (Maybe Text) Source #
Uniquely identifies a rule used to schedule the backup of a selection of resources.
RecoveryPointMember
data RecoveryPointMember Source #
This is a recovery point which is a child (nested) recovery point of a parent (composite) recovery point. These recovery points can be disassociated from their parent (composite) recovery point, in which case they will no longer be a member.
See: newRecoveryPointMember smart constructor.
Constructors
| RecoveryPointMember' | |
Fields
| |
Instances
newRecoveryPointMember :: RecoveryPointMember Source #
Create a value of RecoveryPointMember 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:recoveryPointArn:RecoveryPointMember', recoveryPointMember_recoveryPointArn - This is the Amazon Resource Name (ARN) of the parent (composite)
recovery point.
recoveryPointMember_recoveryPointArn :: Lens' RecoveryPointMember (Maybe Text) Source #
This is the Amazon Resource Name (ARN) of the parent (composite) recovery point.
RecoveryPointSelection
data RecoveryPointSelection Source #
This specifies criteria to assign a set of resources, such as resource types or backup vaults.
See: newRecoveryPointSelection smart constructor.
Constructors
| RecoveryPointSelection' | |
Fields
| |
Instances
newRecoveryPointSelection :: RecoveryPointSelection Source #
Create a value of RecoveryPointSelection 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:dateRange:RecoveryPointSelection', recoveryPointSelection_dateRange - Undocumented member.
$sel:resourceIdentifiers:RecoveryPointSelection', recoveryPointSelection_resourceIdentifiers - These are the resources included in the resource selection (including
type of resources and vaults).
$sel:vaultNames:RecoveryPointSelection', recoveryPointSelection_vaultNames - These are the names of the vaults in which the selected recovery points
are contained.
recoveryPointSelection_dateRange :: Lens' RecoveryPointSelection (Maybe DateRange) Source #
Undocumented member.
recoveryPointSelection_resourceIdentifiers :: Lens' RecoveryPointSelection (Maybe [Text]) Source #
These are the resources included in the resource selection (including type of resources and vaults).
recoveryPointSelection_vaultNames :: Lens' RecoveryPointSelection (Maybe [Text]) Source #
These are the names of the vaults in which the selected recovery points are contained.
ReportDeliveryChannel
data ReportDeliveryChannel Source #
Contains information from your report plan about where to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
See: newReportDeliveryChannel smart constructor.
Constructors
| ReportDeliveryChannel' | |
Fields
| |
Instances
newReportDeliveryChannel Source #
Create a value of ReportDeliveryChannel 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:formats:ReportDeliveryChannel', reportDeliveryChannel_formats - A list of the format of your reports: CSV, JSON, or both. If not
specified, the default format is CSV.
$sel:s3KeyPrefix:ReportDeliveryChannel', reportDeliveryChannel_s3KeyPrefix - The prefix for where Backup Audit Manager delivers your reports to
Amazon S3. The prefix is this part of the following path:
s3://your-bucket-name/prefix/Backup/us-west-2/year/month/day/report-name.
If not specified, there is no prefix.
$sel:s3BucketName:ReportDeliveryChannel', reportDeliveryChannel_s3BucketName - The unique name of the S3 bucket that receives your reports.
reportDeliveryChannel_formats :: Lens' ReportDeliveryChannel (Maybe [Text]) Source #
A list of the format of your reports: CSV, JSON, or both. If not
specified, the default format is CSV.
reportDeliveryChannel_s3KeyPrefix :: Lens' ReportDeliveryChannel (Maybe Text) Source #
The prefix for where Backup Audit Manager delivers your reports to
Amazon S3. The prefix is this part of the following path:
s3://your-bucket-name/prefix/Backup/us-west-2/year/month/day/report-name.
If not specified, there is no prefix.
reportDeliveryChannel_s3BucketName :: Lens' ReportDeliveryChannel Text Source #
The unique name of the S3 bucket that receives your reports.
ReportDestination
data ReportDestination Source #
Contains information from your report job about your report destination.
See: newReportDestination smart constructor.
Constructors
| ReportDestination' | |
Instances
newReportDestination :: ReportDestination Source #
Create a value of ReportDestination 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:s3BucketName:ReportDestination', reportDestination_s3BucketName - The unique name of the Amazon S3 bucket that receives your reports.
$sel:s3Keys:ReportDestination', reportDestination_s3Keys - The object key that uniquely identifies your reports in your S3 bucket.
reportDestination_s3BucketName :: Lens' ReportDestination (Maybe Text) Source #
The unique name of the Amazon S3 bucket that receives your reports.
reportDestination_s3Keys :: Lens' ReportDestination (Maybe [Text]) Source #
The object key that uniquely identifies your reports in your S3 bucket.
ReportJob
Contains detailed information about a report job. A report job compiles a report based on a report plan and publishes it to Amazon S3.
See: newReportJob smart constructor.
Constructors
| ReportJob' | |
Fields
| |
Instances
newReportJob :: ReportJob Source #
Create a value of ReportJob 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:completionTime:ReportJob', reportJob_completionTime - The date and time that a report job is completed, in Unix format and
Coordinated Universal Time (UTC). The value of CompletionTime is
accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
$sel:creationTime:ReportJob', reportJob_creationTime - The date and time that a report job is created, in Unix format and
Coordinated Universal Time (UTC). The value of CreationTime is
accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
$sel:reportDestination:ReportJob', reportJob_reportDestination - The S3 bucket name and S3 keys for the destination where the report job
publishes the report.
$sel:reportJobId:ReportJob', reportJob_reportJobId - The identifier for a report job. A unique, randomly generated, Unicode,
UTF-8 encoded string that is at most 1,024 bytes long. Report job IDs
cannot be edited.
$sel:reportPlanArn:ReportJob', reportJob_reportPlanArn - An Amazon Resource Name (ARN) that uniquely identifies a resource. The
format of the ARN depends on the resource type.
$sel:reportTemplate:ReportJob', reportJob_reportTemplate - Identifies the report template for the report. Reports are built using a
report template. The report templates are:
RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
$sel:status:ReportJob', reportJob_status - The status of a report job. The statuses are:
CREATED | RUNNING | COMPLETED | FAILED
COMPLETED means that the report is available for your review at your
designated destination. If the status is FAILED, review the
StatusMessage for the reason.
$sel:statusMessage:ReportJob', reportJob_statusMessage - A message explaining the status of the report job.
reportJob_completionTime :: Lens' ReportJob (Maybe UTCTime) Source #
The date and time that a report job is completed, in Unix format and
Coordinated Universal Time (UTC). The value of CompletionTime is
accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
reportJob_creationTime :: Lens' ReportJob (Maybe UTCTime) Source #
The date and time that a report job is created, in Unix format and
Coordinated Universal Time (UTC). The value of CreationTime is
accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
reportJob_reportDestination :: Lens' ReportJob (Maybe ReportDestination) Source #
The S3 bucket name and S3 keys for the destination where the report job publishes the report.
reportJob_reportJobId :: Lens' ReportJob (Maybe Text) Source #
The identifier for a report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. Report job IDs cannot be edited.
reportJob_reportPlanArn :: Lens' ReportJob (Maybe Text) Source #
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
reportJob_reportTemplate :: Lens' ReportJob (Maybe Text) Source #
Identifies the report template for the report. Reports are built using a report template. The report templates are:
RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
reportJob_status :: Lens' ReportJob (Maybe Text) Source #
The status of a report job. The statuses are:
CREATED | RUNNING | COMPLETED | FAILED
COMPLETED means that the report is available for your review at your
designated destination. If the status is FAILED, review the
StatusMessage for the reason.
reportJob_statusMessage :: Lens' ReportJob (Maybe Text) Source #
A message explaining the status of the report job.
ReportPlan
data ReportPlan Source #
Contains detailed information about a report plan.
See: newReportPlan smart constructor.
Constructors
| ReportPlan' | |
Fields
| |
Instances
newReportPlan :: ReportPlan Source #
Create a value of ReportPlan 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:creationTime:ReportPlan', reportPlan_creationTime - The date and time that a report plan is created, in Unix format and
Coordinated Universal Time (UTC). The value of CreationTime is
accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
$sel:deploymentStatus:ReportPlan', reportPlan_deploymentStatus - The deployment status of a report plan. The statuses are:
CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED
$sel:lastAttemptedExecutionTime:ReportPlan', reportPlan_lastAttemptedExecutionTime - The date and time that a report job associated with this report plan
last attempted to run, in Unix format and Coordinated Universal Time
(UTC). The value of LastAttemptedExecutionTime is accurate to
milliseconds. For example, the value 1516925490.087 represents Friday,
January 26, 2018 12:11:30.087 AM.
$sel:lastSuccessfulExecutionTime:ReportPlan', reportPlan_lastSuccessfulExecutionTime - The date and time that a report job associated with this report plan
last successfully ran, in Unix format and Coordinated Universal Time
(UTC). The value of LastSuccessfulExecutionTime is accurate to
milliseconds. For example, the value 1516925490.087 represents Friday,
January 26, 2018 12:11:30.087 AM.
$sel:reportDeliveryChannel:ReportPlan', reportPlan_reportDeliveryChannel - Contains information about where and how to deliver your reports,
specifically your Amazon S3 bucket name, S3 key prefix, and the formats
of your reports.
$sel:reportPlanArn:ReportPlan', reportPlan_reportPlanArn - An Amazon Resource Name (ARN) that uniquely identifies a resource. The
format of the ARN depends on the resource type.
$sel:reportPlanDescription:ReportPlan', reportPlan_reportPlanDescription - An optional description of the report plan with a maximum 1,024
characters.
$sel:reportPlanName:ReportPlan', reportPlan_reportPlanName - The unique name of the report plan. This name is between 1 and 256
characters starting with a letter, and consisting of letters (a-z, A-Z),
numbers (0-9), and underscores (_).
$sel:reportSetting:ReportPlan', reportPlan_reportSetting - Identifies the report template for the report. Reports are built using a
report template. The report templates are:
RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
If the report template is RESOURCE_COMPLIANCE_REPORT or
CONTROL_COMPLIANCE_REPORT, this API resource also describes the report
coverage by Amazon Web Services Regions and frameworks.
reportPlan_creationTime :: Lens' ReportPlan (Maybe UTCTime) Source #
The date and time that a report plan is created, in Unix format and
Coordinated Universal Time (UTC). The value of CreationTime is
accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
reportPlan_deploymentStatus :: Lens' ReportPlan (Maybe Text) Source #
The deployment status of a report plan. The statuses are:
CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED
reportPlan_lastAttemptedExecutionTime :: Lens' ReportPlan (Maybe UTCTime) Source #
The date and time that a report job associated with this report plan
last attempted to run, in Unix format and Coordinated Universal Time
(UTC). The value of LastAttemptedExecutionTime is accurate to
milliseconds. For example, the value 1516925490.087 represents Friday,
January 26, 2018 12:11:30.087 AM.
reportPlan_lastSuccessfulExecutionTime :: Lens' ReportPlan (Maybe UTCTime) Source #
The date and time that a report job associated with this report plan
last successfully ran, in Unix format and Coordinated Universal Time
(UTC). The value of LastSuccessfulExecutionTime is accurate to
milliseconds. For example, the value 1516925490.087 represents Friday,
January 26, 2018 12:11:30.087 AM.
reportPlan_reportDeliveryChannel :: Lens' ReportPlan (Maybe ReportDeliveryChannel) Source #
Contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
reportPlan_reportPlanArn :: Lens' ReportPlan (Maybe Text) Source #
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
reportPlan_reportPlanDescription :: Lens' ReportPlan (Maybe Text) Source #
An optional description of the report plan with a maximum 1,024 characters.
reportPlan_reportPlanName :: Lens' ReportPlan (Maybe Text) Source #
The unique name of the report plan. This name is between 1 and 256 characters starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
reportPlan_reportSetting :: Lens' ReportPlan (Maybe ReportSetting) Source #
Identifies the report template for the report. Reports are built using a report template. The report templates are:
RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
If the report template is RESOURCE_COMPLIANCE_REPORT or
CONTROL_COMPLIANCE_REPORT, this API resource also describes the report
coverage by Amazon Web Services Regions and frameworks.
ReportSetting
data ReportSetting Source #
Contains detailed information about a report setting.
See: newReportSetting smart constructor.
Constructors
| ReportSetting' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> ReportSetting |
Create a value of ReportSetting 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:accounts:ReportSetting', reportSetting_accounts - These are the accounts to be included in the report.
$sel:frameworkArns:ReportSetting', reportSetting_frameworkArns - The Amazon Resource Names (ARNs) of the frameworks a report covers.
$sel:numberOfFrameworks:ReportSetting', reportSetting_numberOfFrameworks - The number of frameworks a report covers.
$sel:organizationUnits:ReportSetting', reportSetting_organizationUnits - These are the Organizational Units to be included in the report.
$sel:regions:ReportSetting', reportSetting_regions - These are the Regions to be included in the report.
$sel:reportTemplate:ReportSetting', reportSetting_reportTemplate - Identifies the report template for the report. Reports are built using a
report template. The report templates are:
RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
reportSetting_accounts :: Lens' ReportSetting (Maybe [Text]) Source #
These are the accounts to be included in the report.
reportSetting_frameworkArns :: Lens' ReportSetting (Maybe [Text]) Source #
The Amazon Resource Names (ARNs) of the frameworks a report covers.
reportSetting_numberOfFrameworks :: Lens' ReportSetting (Maybe Int) Source #
The number of frameworks a report covers.
reportSetting_organizationUnits :: Lens' ReportSetting (Maybe [Text]) Source #
These are the Organizational Units to be included in the report.
reportSetting_regions :: Lens' ReportSetting (Maybe [Text]) Source #
These are the Regions to be included in the report.
reportSetting_reportTemplate :: Lens' ReportSetting Text Source #
Identifies the report template for the report. Reports are built using a report template. The report templates are:
RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
RestoreJobsListMember
data RestoreJobsListMember Source #
Contains metadata about a restore job.
See: newRestoreJobsListMember smart constructor.
Constructors
| RestoreJobsListMember' | |
Fields
| |
Instances
newRestoreJobsListMember :: RestoreJobsListMember Source #
Create a value of RestoreJobsListMember 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:accountId:RestoreJobsListMember', restoreJobsListMember_accountId - The account ID that owns the restore job.
$sel:backupSizeInBytes:RestoreJobsListMember', restoreJobsListMember_backupSizeInBytes - The size, in bytes, of the restored resource.
$sel:completionDate:RestoreJobsListMember', restoreJobsListMember_completionDate - The date and time a job to restore a recovery point is completed, in
Unix format and Coordinated Universal Time (UTC). The value of
CompletionDate is accurate to milliseconds. For example, the value
1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
$sel:createdResourceArn:RestoreJobsListMember', restoreJobsListMember_createdResourceArn - An Amazon Resource Name (ARN) that uniquely identifies a resource. The
format of the ARN depends on the resource type.
$sel:creationDate:RestoreJobsListMember', restoreJobsListMember_creationDate - The date and time a restore job is created, in Unix format and
Coordinated Universal Time (UTC). The value of CreationDate is
accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
$sel:expectedCompletionTimeMinutes:RestoreJobsListMember', restoreJobsListMember_expectedCompletionTimeMinutes - The amount of time in minutes that a job restoring a recovery point is
expected to take.
$sel:iamRoleArn:RestoreJobsListMember', restoreJobsListMember_iamRoleArn - Specifies the IAM role ARN used to create the target recovery point; for
example, arn:aws:iam::123456789012:role/S3Access.
$sel:percentDone:RestoreJobsListMember', restoreJobsListMember_percentDone - Contains an estimated percentage complete of a job at the time the job
status was queried.
$sel:recoveryPointArn:RestoreJobsListMember', restoreJobsListMember_recoveryPointArn - An ARN that uniquely identifies a recovery point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
$sel:resourceType:RestoreJobsListMember', restoreJobsListMember_resourceType - The resource type of the listed restore jobs; for example, an Amazon
Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database
Service (Amazon RDS) database. For Windows Volume Shadow Copy Service
(VSS) backups, the only supported resource type is Amazon EC2.
$sel:restoreJobId:RestoreJobsListMember', restoreJobsListMember_restoreJobId - Uniquely identifies the job that restores a recovery point.
$sel:status:RestoreJobsListMember', restoreJobsListMember_status - A status code specifying the state of the job initiated by Backup to
restore a recovery point.
$sel:statusMessage:RestoreJobsListMember', restoreJobsListMember_statusMessage - A detailed message explaining the status of the job to restore a
recovery point.
restoreJobsListMember_accountId :: Lens' RestoreJobsListMember (Maybe Text) Source #
The account ID that owns the restore job.
restoreJobsListMember_backupSizeInBytes :: Lens' RestoreJobsListMember (Maybe Integer) Source #
The size, in bytes, of the restored resource.
restoreJobsListMember_completionDate :: Lens' RestoreJobsListMember (Maybe UTCTime) Source #
The date and time a job to restore a recovery point is completed, in
Unix format and Coordinated Universal Time (UTC). The value of
CompletionDate is accurate to milliseconds. For example, the value
1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
restoreJobsListMember_createdResourceArn :: Lens' RestoreJobsListMember (Maybe Text) Source #
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
restoreJobsListMember_creationDate :: Lens' RestoreJobsListMember (Maybe UTCTime) Source #
The date and time a restore job is created, in Unix format and
Coordinated Universal Time (UTC). The value of CreationDate is
accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
restoreJobsListMember_expectedCompletionTimeMinutes :: Lens' RestoreJobsListMember (Maybe Integer) Source #
The amount of time in minutes that a job restoring a recovery point is expected to take.
restoreJobsListMember_iamRoleArn :: Lens' RestoreJobsListMember (Maybe Text) Source #
Specifies the IAM role ARN used to create the target recovery point; for
example, arn:aws:iam::123456789012:role/S3Access.
restoreJobsListMember_percentDone :: Lens' RestoreJobsListMember (Maybe Text) Source #
Contains an estimated percentage complete of a job at the time the job status was queried.
restoreJobsListMember_recoveryPointArn :: Lens' RestoreJobsListMember (Maybe Text) Source #
An ARN that uniquely identifies a recovery point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
restoreJobsListMember_resourceType :: Lens' RestoreJobsListMember (Maybe Text) Source #
The resource type of the listed restore jobs; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.
restoreJobsListMember_restoreJobId :: Lens' RestoreJobsListMember (Maybe Text) Source #
Uniquely identifies the job that restores a recovery point.
restoreJobsListMember_status :: Lens' RestoreJobsListMember (Maybe RestoreJobStatus) Source #
A status code specifying the state of the job initiated by Backup to restore a recovery point.
restoreJobsListMember_statusMessage :: Lens' RestoreJobsListMember (Maybe Text) Source #
A detailed message explaining the status of the job to restore a recovery point.