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.DocDbElastic.Types.ClusterSnapshot

Description

Synopsis

data ClusterSnapshot = ClusterSnapshot' {
- adminUserName :: Text
- clusterArn :: Text
- clusterCreationTime :: Text
- kmsKeyId :: Text
- snapshotArn :: Text
- snapshotCreationTime :: Text
- snapshotName :: Text
- status :: Status
- subnetIds :: [Text]
- vpcSecurityGroupIds :: [Text]
}
newClusterSnapshot :: Text -> Text -> Text -> Text -> Text -> Text -> Text -> Status -> ClusterSnapshot
clusterSnapshot_adminUserName :: Lens' ClusterSnapshot Text
clusterSnapshot_clusterArn :: Lens' ClusterSnapshot Text
clusterSnapshot_clusterCreationTime :: Lens' ClusterSnapshot Text
clusterSnapshot_kmsKeyId :: Lens' ClusterSnapshot Text
clusterSnapshot_snapshotArn :: Lens' ClusterSnapshot Text
clusterSnapshot_snapshotCreationTime :: Lens' ClusterSnapshot Text
clusterSnapshot_snapshotName :: Lens' ClusterSnapshot Text
clusterSnapshot_status :: Lens' ClusterSnapshot Status
clusterSnapshot_subnetIds :: Lens' ClusterSnapshot [Text]
clusterSnapshot_vpcSecurityGroupIds :: Lens' ClusterSnapshot [Text]

Documentation

data ClusterSnapshot Source #

Returns information about a specific Elastic DocumentDB snapshot.

See: newClusterSnapshot smart constructor.

Constructors

ClusterSnapshot'

Fields

adminUserName :: Text
The name of the Elastic DocumentDB cluster administrator.
clusterArn :: Text
The arn of the Elastic DocumentDB cluster.
clusterCreationTime :: Text
The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC).
kmsKeyId :: Text
The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.
snapshotArn :: Text
The arn of the Elastic DocumentDB snapshot
snapshotCreationTime :: Text
The time when the Elastic DocumentDB snapshot was created in Universal Coordinated Time (UTC).
snapshotName :: Text
The name of the Elastic DocumentDB snapshot.
status :: Status
The status of the Elastic DocumentDB snapshot.
subnetIds :: [Text]
A list of the IDs of subnets associated with the DB cluster snapshot.
vpcSecurityGroupIds :: [Text]
A list of the IDs of the VPC security groups associated with the cluster snapshot.

Instances

Instances details

FromJSON ClusterSnapshot Source #
Instance details Defined in Amazonka.DocDbElastic.Types.ClusterSnapshot Methods parseJSON :: Value -> Parser ClusterSnapshot # parseJSONList :: Value -> Parser [ClusterSnapshot] #
Generic ClusterSnapshot Source #
Instance details Defined in Amazonka.DocDbElastic.Types.ClusterSnapshot Associated Types type Rep ClusterSnapshot :: Type -> Type # Methods from :: ClusterSnapshot -> Rep ClusterSnapshot x # to :: Rep ClusterSnapshot x -> ClusterSnapshot #
Read ClusterSnapshot Source #
Instance details Defined in Amazonka.DocDbElastic.Types.ClusterSnapshot Methods readsPrec :: Int -> ReadS ClusterSnapshot # readList :: ReadS [ClusterSnapshot] # readPrec :: ReadPrec ClusterSnapshot # readListPrec :: ReadPrec [ClusterSnapshot] #
Show ClusterSnapshot Source #
Instance details Defined in Amazonka.DocDbElastic.Types.ClusterSnapshot Methods showsPrec :: Int -> ClusterSnapshot -> ShowS # show :: ClusterSnapshot -> String # showList :: [ClusterSnapshot] -> ShowS #
NFData ClusterSnapshot Source #
Instance details Defined in Amazonka.DocDbElastic.Types.ClusterSnapshot Methods rnf :: ClusterSnapshot -> () #
Eq ClusterSnapshot Source #
Instance details Defined in Amazonka.DocDbElastic.Types.ClusterSnapshot Methods (==) :: ClusterSnapshot -> ClusterSnapshot -> Bool # (/=) :: ClusterSnapshot -> ClusterSnapshot -> Bool #
Hashable ClusterSnapshot Source #
Instance details Defined in Amazonka.DocDbElastic.Types.ClusterSnapshot Methods hashWithSalt :: Int -> ClusterSnapshot -> Int # hash :: ClusterSnapshot -> Int #
type Rep ClusterSnapshot Source #
Instance details Defined in Amazonka.DocDbElastic.Types.ClusterSnapshot type Rep ClusterSnapshot = D1 ('MetaData "ClusterSnapshot" "Amazonka.DocDbElastic.Types.ClusterSnapshot" "amazonka-docdb-elastic-2.0-7oyCcw7MbTKKNwZE62fvl3" 'False) (C1 ('MetaCons "ClusterSnapshot'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "adminUserName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "clusterArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "clusterCreationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "snapshotArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) :: ((S1 ('MetaSel ('Just "snapshotCreationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "snapshotName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Status) :: (S1 ('MetaSel ('Just "subnetIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]) :*: S1 ('MetaSel ('Just "vpcSecurityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]))))))

newClusterSnapshot Source #

Arguments

:: Text	`$sel:adminUserName:ClusterSnapshot'`
-> Text	`$sel:clusterArn:ClusterSnapshot'`
-> Text	`$sel:clusterCreationTime:ClusterSnapshot'`
-> Text	`$sel:kmsKeyId:ClusterSnapshot'`
-> Text	`$sel:snapshotArn:ClusterSnapshot'`
-> Text	`$sel:snapshotCreationTime:ClusterSnapshot'`
-> Text	`$sel:snapshotName:ClusterSnapshot'`
-> Status	`$sel:status:ClusterSnapshot'`
-> ClusterSnapshot

Create a value of ClusterSnapshot 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:adminUserName:ClusterSnapshot', clusterSnapshot_adminUserName - The name of the Elastic DocumentDB cluster administrator.

$sel:clusterArn:ClusterSnapshot', clusterSnapshot_clusterArn - The arn of the Elastic DocumentDB cluster.

$sel:clusterCreationTime:ClusterSnapshot', clusterSnapshot_clusterCreationTime - The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC).

$sel:kmsKeyId:ClusterSnapshot', clusterSnapshot_kmsKeyId - The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.

$sel:snapshotArn:ClusterSnapshot', clusterSnapshot_snapshotArn - The arn of the Elastic DocumentDB snapshot

$sel:snapshotCreationTime:ClusterSnapshot', clusterSnapshot_snapshotCreationTime - The time when the Elastic DocumentDB snapshot was created in Universal Coordinated Time (UTC).

$sel:snapshotName:ClusterSnapshot', clusterSnapshot_snapshotName - The name of the Elastic DocumentDB snapshot.

$sel:status:ClusterSnapshot', clusterSnapshot_status - The status of the Elastic DocumentDB snapshot.

$sel:subnetIds:ClusterSnapshot', clusterSnapshot_subnetIds - A list of the IDs of subnets associated with the DB cluster snapshot.

$sel:vpcSecurityGroupIds:ClusterSnapshot', clusterSnapshot_vpcSecurityGroupIds - A list of the IDs of the VPC security groups associated with the cluster snapshot.

clusterSnapshot_adminUserName :: Lens' ClusterSnapshot Text Source #

The name of the Elastic DocumentDB cluster administrator.

clusterSnapshot_clusterArn :: Lens' ClusterSnapshot Text Source #

The arn of the Elastic DocumentDB cluster.

clusterSnapshot_clusterCreationTime :: Lens' ClusterSnapshot Text Source #

The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC).

clusterSnapshot_kmsKeyId :: Lens' ClusterSnapshot Text Source #

The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.

clusterSnapshot_snapshotArn :: Lens' ClusterSnapshot Text Source #

The arn of the Elastic DocumentDB snapshot

clusterSnapshot_snapshotCreationTime :: Lens' ClusterSnapshot Text Source #

The time when the Elastic DocumentDB snapshot was created in Universal Coordinated Time (UTC).

clusterSnapshot_snapshotName :: Lens' ClusterSnapshot Text Source #

The name of the Elastic DocumentDB snapshot.

clusterSnapshot_status :: Lens' ClusterSnapshot Status Source #

The status of the Elastic DocumentDB snapshot.

clusterSnapshot_subnetIds :: Lens' ClusterSnapshot [Text] Source #

A list of the IDs of subnets associated with the DB cluster snapshot.

clusterSnapshot_vpcSecurityGroupIds :: Lens' ClusterSnapshot [Text] Source #

A list of the IDs of the VPC security groups associated with the cluster snapshot.