Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.DocumentDB.Types.DBClusterSnapshot

Description

Synopsis

data DBClusterSnapshot = DBClusterSnapshot' {
- engineVersion :: Maybe Text
- status :: Maybe Text
- storageEncrypted :: Maybe Bool
- dbClusterIdentifier :: Maybe Text
- masterUsername :: Maybe Text
- dbClusterSnapshotArn :: Maybe Text
- vpcId :: Maybe Text
- dbClusterSnapshotIdentifier :: Maybe Text
- engine :: Maybe Text
- availabilityZones :: Maybe [Text]
- snapshotType :: Maybe Text
- kmsKeyId :: Maybe Text
- snapshotCreateTime :: Maybe ISO8601
- sourceDBClusterSnapshotArn :: Maybe Text
- clusterCreateTime :: Maybe ISO8601
- percentProgress :: Maybe Int
- port :: Maybe Int
}
newDBClusterSnapshot :: DBClusterSnapshot
dbClusterSnapshot_engineVersion :: Lens' DBClusterSnapshot (Maybe Text)
dbClusterSnapshot_status :: Lens' DBClusterSnapshot (Maybe Text)
dbClusterSnapshot_storageEncrypted :: Lens' DBClusterSnapshot (Maybe Bool)
dbClusterSnapshot_dbClusterIdentifier :: Lens' DBClusterSnapshot (Maybe Text)
dbClusterSnapshot_masterUsername :: Lens' DBClusterSnapshot (Maybe Text)
dbClusterSnapshot_dbClusterSnapshotArn :: Lens' DBClusterSnapshot (Maybe Text)
dbClusterSnapshot_vpcId :: Lens' DBClusterSnapshot (Maybe Text)
dbClusterSnapshot_dbClusterSnapshotIdentifier :: Lens' DBClusterSnapshot (Maybe Text)
dbClusterSnapshot_engine :: Lens' DBClusterSnapshot (Maybe Text)
dbClusterSnapshot_availabilityZones :: Lens' DBClusterSnapshot (Maybe [Text])
dbClusterSnapshot_snapshotType :: Lens' DBClusterSnapshot (Maybe Text)
dbClusterSnapshot_kmsKeyId :: Lens' DBClusterSnapshot (Maybe Text)
dbClusterSnapshot_snapshotCreateTime :: Lens' DBClusterSnapshot (Maybe UTCTime)
dbClusterSnapshot_sourceDBClusterSnapshotArn :: Lens' DBClusterSnapshot (Maybe Text)
dbClusterSnapshot_clusterCreateTime :: Lens' DBClusterSnapshot (Maybe UTCTime)
dbClusterSnapshot_percentProgress :: Lens' DBClusterSnapshot (Maybe Int)
dbClusterSnapshot_port :: Lens' DBClusterSnapshot (Maybe Int)

Documentation

data DBClusterSnapshot Source #

Detailed information about a cluster snapshot.

See: newDBClusterSnapshot smart constructor.

Constructors

DBClusterSnapshot'

Fields

engineVersion :: Maybe Text
Provides the version of the database engine for this cluster snapshot.
status :: Maybe Text
Specifies the status of this cluster snapshot.
storageEncrypted :: Maybe Bool
Specifies whether the cluster snapshot is encrypted.
dbClusterIdentifier :: Maybe Text
Specifies the cluster identifier of the cluster that this cluster snapshot was created from.
masterUsername :: Maybe Text
Provides the master user name for the cluster snapshot.
dbClusterSnapshotArn :: Maybe Text
The Amazon Resource Name (ARN) for the cluster snapshot.
vpcId :: Maybe Text
Provides the virtual private cloud (VPC) ID that is associated with the cluster snapshot.
dbClusterSnapshotIdentifier :: Maybe Text
Specifies the identifier for the cluster snapshot.
engine :: Maybe Text
Specifies the name of the database engine.
availabilityZones :: Maybe [Text]
Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored in.
snapshotType :: Maybe Text
Provides the type of the cluster snapshot.
kmsKeyId :: Maybe Text
If StorageEncrypted is true, the KMS key identifier for the encrypted cluster snapshot.
snapshotCreateTime :: Maybe ISO8601
Provides the time when the snapshot was taken, in UTC.
sourceDBClusterSnapshotArn :: Maybe Text
If the cluster snapshot was copied from a source cluster snapshot, the ARN for the source cluster snapshot; otherwise, a null value.
clusterCreateTime :: Maybe ISO8601
Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
percentProgress :: Maybe Int
Specifies the percentage of the estimated data that has been transferred.
port :: Maybe Int
Specifies the port that the cluster was listening on at the time of the snapshot.

Instances

Instances details

Eq DBClusterSnapshot Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterSnapshot Methods (==) :: DBClusterSnapshot -> DBClusterSnapshot -> Bool # (/=) :: DBClusterSnapshot -> DBClusterSnapshot -> Bool #
Read DBClusterSnapshot Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterSnapshot Methods readsPrec :: Int -> ReadS DBClusterSnapshot # readList :: ReadS [DBClusterSnapshot] # readPrec :: ReadPrec DBClusterSnapshot # readListPrec :: ReadPrec [DBClusterSnapshot] #
Show DBClusterSnapshot Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterSnapshot Methods showsPrec :: Int -> DBClusterSnapshot -> ShowS # show :: DBClusterSnapshot -> String # showList :: [DBClusterSnapshot] -> ShowS #
Generic DBClusterSnapshot Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterSnapshot Associated Types type Rep DBClusterSnapshot :: Type -> Type # Methods from :: DBClusterSnapshot -> Rep DBClusterSnapshot x # to :: Rep DBClusterSnapshot x -> DBClusterSnapshot #
NFData DBClusterSnapshot Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterSnapshot Methods rnf :: DBClusterSnapshot -> () #
Hashable DBClusterSnapshot Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterSnapshot Methods hashWithSalt :: Int -> DBClusterSnapshot -> Int # hash :: DBClusterSnapshot -> Int #
FromXML DBClusterSnapshot Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterSnapshot Methods parseXML :: [Node] -> Either String DBClusterSnapshot #
type Rep DBClusterSnapshot Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterSnapshot type Rep DBClusterSnapshot = D1 ('MetaData "DBClusterSnapshot" "Amazonka.DocumentDB.Types.DBClusterSnapshot" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "DBClusterSnapshot'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "storageEncrypted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "masterUsername") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "dbClusterSnapshotArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "vpcId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "dbClusterSnapshotIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: (((S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "availabilityZones") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "snapshotType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "snapshotCreateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: S1 ('MetaSel ('Just "sourceDBClusterSnapshotArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "clusterCreateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: (S1 ('MetaSel ('Just "percentProgress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))))))

newDBClusterSnapshot :: DBClusterSnapshot Source #

Create a value of DBClusterSnapshot 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:engineVersion:DBClusterSnapshot', dbClusterSnapshot_engineVersion - Provides the version of the database engine for this cluster snapshot.

$sel:status:DBClusterSnapshot', dbClusterSnapshot_status - Specifies the status of this cluster snapshot.

$sel:storageEncrypted:DBClusterSnapshot', dbClusterSnapshot_storageEncrypted - Specifies whether the cluster snapshot is encrypted.

$sel:dbClusterIdentifier:DBClusterSnapshot', dbClusterSnapshot_dbClusterIdentifier - Specifies the cluster identifier of the cluster that this cluster snapshot was created from.

$sel:masterUsername:DBClusterSnapshot', dbClusterSnapshot_masterUsername - Provides the master user name for the cluster snapshot.

$sel:dbClusterSnapshotArn:DBClusterSnapshot', dbClusterSnapshot_dbClusterSnapshotArn - The Amazon Resource Name (ARN) for the cluster snapshot.

$sel:vpcId:DBClusterSnapshot', dbClusterSnapshot_vpcId - Provides the virtual private cloud (VPC) ID that is associated with the cluster snapshot.

$sel:dbClusterSnapshotIdentifier:DBClusterSnapshot', dbClusterSnapshot_dbClusterSnapshotIdentifier - Specifies the identifier for the cluster snapshot.

$sel:engine:DBClusterSnapshot', dbClusterSnapshot_engine - Specifies the name of the database engine.

$sel:availabilityZones:DBClusterSnapshot', dbClusterSnapshot_availabilityZones - Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored in.

$sel:snapshotType:DBClusterSnapshot', dbClusterSnapshot_snapshotType - Provides the type of the cluster snapshot.

$sel:kmsKeyId:DBClusterSnapshot', dbClusterSnapshot_kmsKeyId - If StorageEncrypted is true, the KMS key identifier for the encrypted cluster snapshot.

$sel:snapshotCreateTime:DBClusterSnapshot', dbClusterSnapshot_snapshotCreateTime - Provides the time when the snapshot was taken, in UTC.

$sel:sourceDBClusterSnapshotArn:DBClusterSnapshot', dbClusterSnapshot_sourceDBClusterSnapshotArn - If the cluster snapshot was copied from a source cluster snapshot, the ARN for the source cluster snapshot; otherwise, a null value.

$sel:clusterCreateTime:DBClusterSnapshot', dbClusterSnapshot_clusterCreateTime - Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).

$sel:percentProgress:DBClusterSnapshot', dbClusterSnapshot_percentProgress - Specifies the percentage of the estimated data that has been transferred.

$sel:port:DBClusterSnapshot', dbClusterSnapshot_port - Specifies the port that the cluster was listening on at the time of the snapshot.

dbClusterSnapshot_engineVersion :: Lens' DBClusterSnapshot (Maybe Text) Source #

Provides the version of the database engine for this cluster snapshot.

dbClusterSnapshot_status :: Lens' DBClusterSnapshot (Maybe Text) Source #

Specifies the status of this cluster snapshot.

dbClusterSnapshot_storageEncrypted :: Lens' DBClusterSnapshot (Maybe Bool) Source #

Specifies whether the cluster snapshot is encrypted.

dbClusterSnapshot_dbClusterIdentifier :: Lens' DBClusterSnapshot (Maybe Text) Source #

Specifies the cluster identifier of the cluster that this cluster snapshot was created from.

dbClusterSnapshot_masterUsername :: Lens' DBClusterSnapshot (Maybe Text) Source #

Provides the master user name for the cluster snapshot.

dbClusterSnapshot_dbClusterSnapshotArn :: Lens' DBClusterSnapshot (Maybe Text) Source #

The Amazon Resource Name (ARN) for the cluster snapshot.

dbClusterSnapshot_vpcId :: Lens' DBClusterSnapshot (Maybe Text) Source #

Provides the virtual private cloud (VPC) ID that is associated with the cluster snapshot.

dbClusterSnapshot_dbClusterSnapshotIdentifier :: Lens' DBClusterSnapshot (Maybe Text) Source #

Specifies the identifier for the cluster snapshot.

dbClusterSnapshot_engine :: Lens' DBClusterSnapshot (Maybe Text) Source #

Specifies the name of the database engine.

dbClusterSnapshot_availabilityZones :: Lens' DBClusterSnapshot (Maybe [Text]) Source #

Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored in.

dbClusterSnapshot_snapshotType :: Lens' DBClusterSnapshot (Maybe Text) Source #

Provides the type of the cluster snapshot.

dbClusterSnapshot_kmsKeyId :: Lens' DBClusterSnapshot (Maybe Text) Source #

If StorageEncrypted is true, the KMS key identifier for the encrypted cluster snapshot.

dbClusterSnapshot_snapshotCreateTime :: Lens' DBClusterSnapshot (Maybe UTCTime) Source #

Provides the time when the snapshot was taken, in UTC.

dbClusterSnapshot_sourceDBClusterSnapshotArn :: Lens' DBClusterSnapshot (Maybe Text) Source #

If the cluster snapshot was copied from a source cluster snapshot, the ARN for the source cluster snapshot; otherwise, a null value.

dbClusterSnapshot_clusterCreateTime :: Lens' DBClusterSnapshot (Maybe UTCTime) Source #

Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).

dbClusterSnapshot_percentProgress :: Lens' DBClusterSnapshot (Maybe Int) Source #

Specifies the percentage of the estimated data that has been transferred.

dbClusterSnapshot_port :: Lens' DBClusterSnapshot (Maybe Int) Source #

Specifies the port that the cluster was listening on at the time of the snapshot.