libZSservicesZSamazonka-rdsZSamazonka-rds
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.RDS.Types.DBInstanceAutomatedBackup

Description

 
Synopsis

Documentation

data DBInstanceAutomatedBackup Source #

An automated backup of a DB instance. It consists of system backups, transaction logs, and the database instance properties that existed at the time you deleted the source instance.

See: newDBInstanceAutomatedBackup smart constructor.

Constructors

DBInstanceAutomatedBackup' 

Fields

Instances

Instances details
Eq DBInstanceAutomatedBackup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstanceAutomatedBackup

Read DBInstanceAutomatedBackup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstanceAutomatedBackup

Show DBInstanceAutomatedBackup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstanceAutomatedBackup

Generic DBInstanceAutomatedBackup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstanceAutomatedBackup

Associated Types

type Rep DBInstanceAutomatedBackup :: Type -> Type #

NFData DBInstanceAutomatedBackup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstanceAutomatedBackup

Hashable DBInstanceAutomatedBackup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstanceAutomatedBackup

FromXML DBInstanceAutomatedBackup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstanceAutomatedBackup

type Rep DBInstanceAutomatedBackup Source # 
Instance details

Defined in Amazonka.RDS.Types.DBInstanceAutomatedBackup

type Rep DBInstanceAutomatedBackup = D1 ('MetaData "DBInstanceAutomatedBackup" "Amazonka.RDS.Types.DBInstanceAutomatedBackup" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "DBInstanceAutomatedBackup'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "restoreWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RestoreWindow)) :*: (S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "dbInstanceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "masterUsername") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "iAMDatabaseAuthenticationEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :*: ((S1 ('MetaSel ('Just "iops") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "vpcId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "instanceCreateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)))) :*: ((S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "encrypted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "licenseModel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dbInstanceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :*: (((S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "availabilityZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "backupRetentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: (S1 ('MetaSel ('Just "region") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "allocatedStorage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "dbiResourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "optionGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "timezone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tdeCredentialArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "dbInstanceAutomatedBackupsReplications") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DBInstanceAutomatedBackupsReplication])) :*: S1 ('MetaSel ('Just "dbInstanceAutomatedBackupsArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "storageType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))))

newDBInstanceAutomatedBackup :: DBInstanceAutomatedBackup Source #

Create a value of DBInstanceAutomatedBackup 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:restoreWindow:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_restoreWindow - Earliest and latest time an instance can be restored to.

$sel:engineVersion:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_engineVersion - The version of the database engine for the automated backup.

$sel:status:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_status - Provides a list of status information for an automated backup:

  • active - automated backups for current instances
  • retained - automated backups for deleted instances
  • creating - automated backups that are waiting for the first automated snapshot to be available.

$sel:dbInstanceArn:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_dbInstanceArn - The Amazon Resource Name (ARN) for the automated backups.

$sel:masterUsername:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_masterUsername - The license model of an automated backup.

$sel:iAMDatabaseAuthenticationEnabled:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_iAMDatabaseAuthenticationEnabled - True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

$sel:iops:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_iops - The IOPS (I/O operations per second) value for the automated backup.

$sel:vpcId:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_vpcId - Provides the VPC ID associated with the DB instance

$sel:instanceCreateTime:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_instanceCreateTime - Provides the date and time that the DB instance was created.

$sel:engine:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_engine - The name of the database engine for this automated backup.

$sel:encrypted:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_encrypted - Specifies whether the automated backup is encrypted.

$sel:licenseModel:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_licenseModel - License model information for the automated backup.

$sel:dbInstanceIdentifier:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_dbInstanceIdentifier - The customer id of the instance that is/was associated with the automated backup.

$sel:kmsKeyId:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_kmsKeyId - The Amazon Web Services KMS key ID for an automated backup.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).

$sel:availabilityZone:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_availabilityZone - The Availability Zone that the automated backup was created in. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.

$sel:backupRetentionPeriod:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_backupRetentionPeriod - The retention period for the automated backups.

$sel:region:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_region - The Amazon Web Services Region associated with the automated backup.

$sel:allocatedStorage:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_allocatedStorage - Specifies the allocated storage size in gibibytes (GiB).

$sel:dbiResourceId:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_dbiResourceId - The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.

$sel:optionGroupName:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_optionGroupName - The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used.

$sel:timezone:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_timezone - The time zone of the automated backup. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.

$sel:tdeCredentialArn:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_tdeCredentialArn - The ARN from the key store with which the automated backup is associated for TDE encryption.

$sel:dbInstanceAutomatedBackupsReplications:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_dbInstanceAutomatedBackupsReplications - The list of replications to different Amazon Web Services Regions associated with the automated backup.

$sel:dbInstanceAutomatedBackupsArn:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_dbInstanceAutomatedBackupsArn - The Amazon Resource Name (ARN) for the replicated automated backups.

$sel:port:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_port - The port number that the automated backup used for connections.

Default: Inherits from the source DB instance

Valid Values: 1150-65535

$sel:storageType:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_storageType - Specifies the storage type associated with the automated backup.

dbInstanceAutomatedBackup_restoreWindow :: Lens' DBInstanceAutomatedBackup (Maybe RestoreWindow) Source #

Earliest and latest time an instance can be restored to.

dbInstanceAutomatedBackup_engineVersion :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

The version of the database engine for the automated backup.

dbInstanceAutomatedBackup_status :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

Provides a list of status information for an automated backup:

  • active - automated backups for current instances
  • retained - automated backups for deleted instances
  • creating - automated backups that are waiting for the first automated snapshot to be available.

dbInstanceAutomatedBackup_dbInstanceArn :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

The Amazon Resource Name (ARN) for the automated backups.

dbInstanceAutomatedBackup_iAMDatabaseAuthenticationEnabled :: Lens' DBInstanceAutomatedBackup (Maybe Bool) Source #

True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

dbInstanceAutomatedBackup_iops :: Lens' DBInstanceAutomatedBackup (Maybe Int) Source #

The IOPS (I/O operations per second) value for the automated backup.

dbInstanceAutomatedBackup_vpcId :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

Provides the VPC ID associated with the DB instance

dbInstanceAutomatedBackup_instanceCreateTime :: Lens' DBInstanceAutomatedBackup (Maybe UTCTime) Source #

Provides the date and time that the DB instance was created.

dbInstanceAutomatedBackup_engine :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

The name of the database engine for this automated backup.

dbInstanceAutomatedBackup_encrypted :: Lens' DBInstanceAutomatedBackup (Maybe Bool) Source #

Specifies whether the automated backup is encrypted.

dbInstanceAutomatedBackup_licenseModel :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

License model information for the automated backup.

dbInstanceAutomatedBackup_dbInstanceIdentifier :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

The customer id of the instance that is/was associated with the automated backup.

dbInstanceAutomatedBackup_kmsKeyId :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

The Amazon Web Services KMS key ID for an automated backup.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).

dbInstanceAutomatedBackup_availabilityZone :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

The Availability Zone that the automated backup was created in. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.

dbInstanceAutomatedBackup_region :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

The Amazon Web Services Region associated with the automated backup.

dbInstanceAutomatedBackup_allocatedStorage :: Lens' DBInstanceAutomatedBackup (Maybe Int) Source #

Specifies the allocated storage size in gibibytes (GiB).

dbInstanceAutomatedBackup_dbiResourceId :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.

dbInstanceAutomatedBackup_optionGroupName :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used.

dbInstanceAutomatedBackup_timezone :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

The time zone of the automated backup. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.

dbInstanceAutomatedBackup_tdeCredentialArn :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

The ARN from the key store with which the automated backup is associated for TDE encryption.

dbInstanceAutomatedBackup_dbInstanceAutomatedBackupsReplications :: Lens' DBInstanceAutomatedBackup (Maybe [DBInstanceAutomatedBackupsReplication]) Source #

The list of replications to different Amazon Web Services Regions associated with the automated backup.

dbInstanceAutomatedBackup_dbInstanceAutomatedBackupsArn :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

The Amazon Resource Name (ARN) for the replicated automated backups.

dbInstanceAutomatedBackup_port :: Lens' DBInstanceAutomatedBackup (Maybe Int) Source #

The port number that the automated backup used for connections.

Default: Inherits from the source DB instance

Valid Values: 1150-65535

dbInstanceAutomatedBackup_storageType :: Lens' DBInstanceAutomatedBackup (Maybe Text) Source #

Specifies the storage type associated with the automated backup.