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

Contents

Service Configuration
Errors
Auth
Status
Cluster
ClusterInList
ClusterSnapshot
ClusterSnapshotInList

Description

Synopsis

defaultService :: Service
_AccessDeniedException :: AsError a => Fold a ServiceError
_ConflictException :: AsError a => Fold a ServiceError
_InternalServerException :: AsError a => Fold a ServiceError
_ResourceNotFoundException :: AsError a => Fold a ServiceError
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError
_ThrottlingException :: AsError a => Fold a ServiceError
_ValidationException :: AsError a => Fold a ServiceError
newtype Auth where
- Auth' {
  - fromAuth :: Text
  }
- pattern Auth_PLAIN_TEXT :: Auth
- pattern Auth_SECRET_ARN :: Auth
newtype Status where
- Status' {
  - fromStatus :: Text
  }
- pattern Status_ACTIVE :: Status
- pattern Status_CREATING :: Status
- pattern Status_DELETING :: Status
- pattern Status_INACCESSIBLE_ENCRYPTION_CREDS :: Status
- pattern Status_INVALID_SECURITY_GROUP_ID :: Status
- pattern Status_INVALID_SUBNET_ID :: Status
- pattern Status_IP_ADDRESS_LIMIT_EXCEEDED :: Status
- pattern Status_UPDATING :: Status
- pattern Status_VPC_ENDPOINT_LIMIT_EXCEEDED :: Status
data Cluster = Cluster' {
- adminUserName :: Text
- authType :: Auth
- clusterArn :: Text
- clusterEndpoint :: Text
- clusterName :: Text
- createTime :: Text
- kmsKeyId :: Text
- preferredMaintenanceWindow :: Text
- shardCapacity :: Int
- shardCount :: Int
- status :: Status
- subnetIds :: [Text]
- vpcSecurityGroupIds :: [Text]
}
newCluster :: Text -> Auth -> Text -> Text -> Text -> Text -> Text -> Text -> Int -> Int -> Status -> Cluster
cluster_adminUserName :: Lens' Cluster Text
cluster_authType :: Lens' Cluster Auth
cluster_clusterArn :: Lens' Cluster Text
cluster_clusterEndpoint :: Lens' Cluster Text
cluster_clusterName :: Lens' Cluster Text
cluster_createTime :: Lens' Cluster Text
cluster_kmsKeyId :: Lens' Cluster Text
cluster_preferredMaintenanceWindow :: Lens' Cluster Text
cluster_shardCapacity :: Lens' Cluster Int
cluster_shardCount :: Lens' Cluster Int
cluster_status :: Lens' Cluster Status
cluster_subnetIds :: Lens' Cluster [Text]
cluster_vpcSecurityGroupIds :: Lens' Cluster [Text]
data ClusterInList = ClusterInList' {
- clusterArn :: Text
- clusterName :: Text
- status :: Status
}
newClusterInList :: Text -> Text -> Status -> ClusterInList
clusterInList_clusterArn :: Lens' ClusterInList Text
clusterInList_clusterName :: Lens' ClusterInList Text
clusterInList_status :: Lens' ClusterInList Status
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]
data ClusterSnapshotInList = ClusterSnapshotInList' {
- clusterArn :: Text
- snapshotArn :: Text
- snapshotCreationTime :: Text
- snapshotName :: Text
- status :: Status
}
newClusterSnapshotInList :: Text -> Text -> Text -> Text -> Status -> ClusterSnapshotInList
clusterSnapshotInList_clusterArn :: Lens' ClusterSnapshotInList Text
clusterSnapshotInList_snapshotArn :: Lens' ClusterSnapshotInList Text
clusterSnapshotInList_snapshotCreationTime :: Lens' ClusterSnapshotInList Text
clusterSnapshotInList_snapshotName :: Lens' ClusterSnapshotInList Text
clusterSnapshotInList_status :: Lens' ClusterSnapshotInList Status

Service Configuration

defaultService :: Service Source #

API version 2022-11-28 of the Amazon DocumentDB Elastic Clusters SDK configuration.

Errors

_AccessDeniedException :: AsError a => Fold a ServiceError Source #

An exception that occurs when there are not sufficient permissions to perform an action.

_ConflictException :: AsError a => Fold a ServiceError Source #

There was an access conflict.

_InternalServerException :: AsError a => Fold a ServiceError Source #

There was an internal server error.

_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #

The specified resource could not be located.

_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #

The service quota for the action was exceeded.

_ThrottlingException :: AsError a => Fold a ServiceError Source #

ThrottlingException will be thrown when request was denied due to request throttling.

_ValidationException :: AsError a => Fold a ServiceError Source #

A structure defining a validation exception.

Auth

newtype Auth Source #

Constructors

Auth'
Fields fromAuth :: Text

Bundled Patterns

pattern Auth_PLAIN_TEXT :: Auth
pattern Auth_SECRET_ARN :: Auth

Instances

Instances details

FromJSON Auth Source #
Instance details Defined in Amazonka.DocDbElastic.Types.Auth Methods parseJSON :: Value -> Parser Auth # parseJSONList :: Value -> Parser [Auth] #
FromJSONKey Auth Source #
Instance details Defined in Amazonka.DocDbElastic.Types.Auth Methods fromJSONKey :: FromJSONKeyFunction Auth # fromJSONKeyList :: FromJSONKeyFunction [Auth] #
ToJSON Auth Source #
Instance details Defined in Amazonka.DocDbElastic.Types.Auth Methods toJSON :: Auth -> Value # toEncoding :: Auth -> Encoding # toJSONList :: [Auth] -> Value # toEncodingList :: [Auth] -> Encoding #
ToJSONKey Auth Source #
Instance details Defined in Amazonka.DocDbElastic.Types.Auth Methods toJSONKey :: ToJSONKeyFunction Auth # toJSONKeyList :: ToJSONKeyFunction [Auth] #
ToByteString Auth Source #
Instance details Defined in Amazonka.DocDbElastic.Types.Auth Methods toBS :: Auth -> ByteString #
ToHeader Auth Source #
Instance details Defined in Amazonka.DocDbElastic.Types.Auth Methods toHeader :: HeaderName -> Auth -> [Header] #
ToLog Auth Source #
Instance details Defined in Amazonka.DocDbElastic.Types.Auth Methods build :: Auth -> ByteStringBuilder #
ToQuery Auth Source #
Instance details Defined in Amazonka.DocDbElastic.Types.Auth Methods toQuery :: Auth -> QueryString #
FromText Auth Source #
Instance details Defined in Amazonka.DocDbElastic.Types.Auth Methods fromText :: Text -> Either String Auth #
ToText Auth Source #
Instance details Defined in Amazonka.DocDbElastic.Types.Auth Methods toText :: Auth -> Text #
FromXML Auth Source #
Instance details Defined in Amazonka.DocDbElastic.Types.Auth Methods parseXML :: [Node] -> Either String Auth #
ToXML Auth Source #
Instance details Defined in Amazonka.DocDbElastic.Types.Auth Methods toXML :: Auth -> XML #
Generic Auth Source #
Instance details Defined in Amazonka.DocDbElastic.Types.Auth Associated Types type Rep Auth :: Type -> Type # Methods from :: Auth -> Rep Auth x # to :: Rep Auth x -> Auth #
Read Auth Source #
Instance details Defined in Amazonka.DocDbElastic.Types.Auth Methods readsPrec :: Int -> ReadS Auth # readList :: ReadS [Auth] # readPrec :: ReadPrec Auth # readListPrec :: ReadPrec [Auth] #
Show Auth Source #
Instance details Defined in Amazonka.DocDbElastic.Types.Auth Methods showsPrec :: Int -> Auth -> ShowS # show :: Auth -> String # showList :: [Auth] -> ShowS #
NFData Auth Source #
Instance details Defined in Amazonka.DocDbElastic.Types.Auth Methods rnf :: Auth -> () #
Eq Auth Source #
Instance details Defined in Amazonka.DocDbElastic.Types.Auth Methods (==) :: Auth -> Auth -> Bool # (/=) :: Auth -> Auth -> Bool #
Ord Auth Source #
Instance details Defined in Amazonka.DocDbElastic.Types.Auth Methods compare :: Auth -> Auth -> Ordering # (<) :: Auth -> Auth -> Bool # (<=) :: Auth -> Auth -> Bool # (>) :: Auth -> Auth -> Bool # (>=) :: Auth -> Auth -> Bool # max :: Auth -> Auth -> Auth # min :: Auth -> Auth -> Auth #
Hashable Auth Source #
Instance details Defined in Amazonka.DocDbElastic.Types.Auth Methods hashWithSalt :: Int -> Auth -> Int # hash :: Auth -> Int #
type Rep Auth Source #
Instance details Defined in Amazonka.DocDbElastic.Types.Auth type Rep Auth = D1 ('MetaData "Auth" "Amazonka.DocDbElastic.Types.Auth" "amazonka-docdb-elastic-2.0-7oyCcw7MbTKKNwZE62fvl3" 'True) (C1 ('MetaCons "Auth'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromAuth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Status

newtype Status Source #

Constructors

Status'
Fields fromStatus :: Text

Bundled Patterns

pattern Status_ACTIVE :: Status
pattern Status_CREATING :: Status
pattern Status_DELETING :: Status
pattern Status_INACCESSIBLE_ENCRYPTION_CREDS :: Status
pattern Status_INVALID_SECURITY_GROUP_ID :: Status
pattern Status_INVALID_SUBNET_ID :: Status
pattern Status_IP_ADDRESS_LIMIT_EXCEEDED :: Status
pattern Status_UPDATING :: Status
pattern Status_VPC_ENDPOINT_LIMIT_EXCEEDED :: Status

Instances

Instances details

FromJSON Status Source #
Instance details Defined in Amazonka.DocDbElastic.Types.Status Methods parseJSON :: Value -> Parser Status # parseJSONList :: Value -> Parser [Status] #
FromJSONKey Status Source #
Instance details Defined in Amazonka.DocDbElastic.Types.Status Methods fromJSONKey :: FromJSONKeyFunction Status # fromJSONKeyList :: FromJSONKeyFunction [Status] #
ToJSON Status Source #
Instance details Defined in Amazonka.DocDbElastic.Types.Status Methods toJSON :: Status -> Value # toEncoding :: Status -> Encoding # toJSONList :: [Status] -> Value # toEncodingList :: [Status] -> Encoding #
ToJSONKey Status Source #
Instance details Defined in Amazonka.DocDbElastic.Types.Status Methods toJSONKey :: ToJSONKeyFunction Status # toJSONKeyList :: ToJSONKeyFunction [Status] #
ToByteString Status Source #
Instance details Defined in Amazonka.DocDbElastic.Types.Status Methods toBS :: Status -> ByteString #
ToHeader Status Source #
Instance details Defined in Amazonka.DocDbElastic.Types.Status Methods toHeader :: HeaderName -> Status -> [Header] #
ToLog Status Source #
Instance details Defined in Amazonka.DocDbElastic.Types.Status Methods build :: Status -> ByteStringBuilder #
ToQuery Status Source #
Instance details Defined in Amazonka.DocDbElastic.Types.Status Methods toQuery :: Status -> QueryString #
FromText Status Source #
Instance details Defined in Amazonka.DocDbElastic.Types.Status Methods fromText :: Text -> Either String Status #
ToText Status Source #
Instance details Defined in Amazonka.DocDbElastic.Types.Status Methods toText :: Status -> Text #
FromXML Status Source #
Instance details Defined in Amazonka.DocDbElastic.Types.Status Methods parseXML :: [Node] -> Either String Status #
ToXML Status Source #
Instance details Defined in Amazonka.DocDbElastic.Types.Status Methods toXML :: Status -> XML #
Generic Status Source #
Instance details Defined in Amazonka.DocDbElastic.Types.Status Associated Types type Rep Status :: Type -> Type # Methods from :: Status -> Rep Status x # to :: Rep Status x -> Status #
Read Status Source #
Instance details Defined in Amazonka.DocDbElastic.Types.Status Methods readsPrec :: Int -> ReadS Status # readList :: ReadS [Status] # readPrec :: ReadPrec Status # readListPrec :: ReadPrec [Status] #
Show Status Source #
Instance details Defined in Amazonka.DocDbElastic.Types.Status Methods showsPrec :: Int -> Status -> ShowS # show :: Status -> String # showList :: [Status] -> ShowS #
NFData Status Source #
Instance details Defined in Amazonka.DocDbElastic.Types.Status Methods rnf :: Status -> () #
Eq Status Source #
Instance details Defined in Amazonka.DocDbElastic.Types.Status Methods (==) :: Status -> Status -> Bool # (/=) :: Status -> Status -> Bool #
Ord Status Source #
Instance details Defined in Amazonka.DocDbElastic.Types.Status Methods compare :: Status -> Status -> Ordering # (<) :: Status -> Status -> Bool # (<=) :: Status -> Status -> Bool # (>) :: Status -> Status -> Bool # (>=) :: Status -> Status -> Bool # max :: Status -> Status -> Status # min :: Status -> Status -> Status #
Hashable Status Source #
Instance details Defined in Amazonka.DocDbElastic.Types.Status Methods hashWithSalt :: Int -> Status -> Int # hash :: Status -> Int #
type Rep Status Source #
Instance details Defined in Amazonka.DocDbElastic.Types.Status type Rep Status = D1 ('MetaData "Status" "Amazonka.DocDbElastic.Types.Status" "amazonka-docdb-elastic-2.0-7oyCcw7MbTKKNwZE62fvl3" 'True) (C1 ('MetaCons "Status'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Cluster

data Cluster Source #

Returns information about a specific Elastic DocumentDB cluster.

See: newCluster smart constructor.

Constructors

Cluster'

Fields

adminUserName :: Text
The name of the Elastic DocumentDB cluster administrator.
authType :: Auth
The authentication type for the Elastic DocumentDB cluster.
clusterArn :: Text
The arn of the Elastic DocumentDB cluster.
clusterEndpoint :: Text
The URL used to connect to the Elastic DocumentDB cluster.
clusterName :: Text
The name of the Elastic DocumentDB cluster.
createTime :: 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.
preferredMaintenanceWindow :: Text
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
shardCapacity :: Int
The capacity of each shard in the Elastic DocumentDB cluster.
shardCount :: Int
The number of shards in the Elastic DocumentDB cluster.
status :: Status
The status of the Elastic DocumentDB cluster.
subnetIds :: [Text]
The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.
vpcSecurityGroupIds :: [Text]
A list of EC2 VPC security groups associated with this cluster.

Instances

Instances details

FromJSON Cluster Source #
Instance details Defined in Amazonka.DocDbElastic.Types.Cluster Methods parseJSON :: Value -> Parser Cluster # parseJSONList :: Value -> Parser [Cluster] #
Generic Cluster Source #
Instance details Defined in Amazonka.DocDbElastic.Types.Cluster Associated Types type Rep Cluster :: Type -> Type # Methods from :: Cluster -> Rep Cluster x # to :: Rep Cluster x -> Cluster #
Read Cluster Source #
Instance details Defined in Amazonka.DocDbElastic.Types.Cluster Methods readsPrec :: Int -> ReadS Cluster # readList :: ReadS [Cluster] # readPrec :: ReadPrec Cluster # readListPrec :: ReadPrec [Cluster] #
Show Cluster Source #
Instance details Defined in Amazonka.DocDbElastic.Types.Cluster Methods showsPrec :: Int -> Cluster -> ShowS # show :: Cluster -> String # showList :: [Cluster] -> ShowS #
NFData Cluster Source #
Instance details Defined in Amazonka.DocDbElastic.Types.Cluster Methods rnf :: Cluster -> () #
Eq Cluster Source #
Instance details Defined in Amazonka.DocDbElastic.Types.Cluster Methods (==) :: Cluster -> Cluster -> Bool # (/=) :: Cluster -> Cluster -> Bool #
Hashable Cluster Source #
Instance details Defined in Amazonka.DocDbElastic.Types.Cluster Methods hashWithSalt :: Int -> Cluster -> Int # hash :: Cluster -> Int #
type Rep Cluster Source #
Instance details Defined in Amazonka.DocDbElastic.Types.Cluster type Rep Cluster = D1 ('MetaData "Cluster" "Amazonka.DocDbElastic.Types.Cluster" "amazonka-docdb-elastic-2.0-7oyCcw7MbTKKNwZE62fvl3" 'False) (C1 ('MetaCons "Cluster'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "adminUserName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "authType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Auth) :: S1 ('MetaSel ('Just "clusterArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: (S1 ('MetaSel ('Just "clusterEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "clusterName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "createTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) :: ((S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "preferredMaintenanceWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "shardCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) :: ((S1 ('MetaSel ('Just "shardCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: 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]))))))

newCluster Source #

Arguments

:: Text	`$sel:adminUserName:Cluster'`
-> Auth	`$sel:authType:Cluster'`
-> Text	`$sel:clusterArn:Cluster'`
-> Text	`$sel:clusterEndpoint:Cluster'`
-> Text	`$sel:clusterName:Cluster'`
-> Text	`$sel:createTime:Cluster'`
-> Text	`$sel:kmsKeyId:Cluster'`
-> Text	`$sel:preferredMaintenanceWindow:Cluster'`
-> Int	`$sel:shardCapacity:Cluster'`
-> Int	`$sel:shardCount:Cluster'`
-> Status	`$sel:status:Cluster'`
-> Cluster

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

$sel:authType:Cluster', cluster_authType - The authentication type for the Elastic DocumentDB cluster.

$sel:clusterArn:Cluster', cluster_clusterArn - The arn of the Elastic DocumentDB cluster.

$sel:clusterEndpoint:Cluster', cluster_clusterEndpoint - The URL used to connect to the Elastic DocumentDB cluster.

$sel:clusterName:Cluster', cluster_clusterName - The name of the Elastic DocumentDB cluster.

$sel:createTime:Cluster', cluster_createTime - The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC).

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

$sel:preferredMaintenanceWindow:Cluster', cluster_preferredMaintenanceWindow - The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

$sel:shardCapacity:Cluster', cluster_shardCapacity - The capacity of each shard in the Elastic DocumentDB cluster.

$sel:shardCount:Cluster', cluster_shardCount - The number of shards in the Elastic DocumentDB cluster.

$sel:status:Cluster', cluster_status - The status of the Elastic DocumentDB cluster.

$sel:subnetIds:Cluster', cluster_subnetIds - The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.

$sel:vpcSecurityGroupIds:Cluster', cluster_vpcSecurityGroupIds - A list of EC2 VPC security groups associated with this cluster.

cluster_adminUserName :: Lens' Cluster Text Source #

The name of the Elastic DocumentDB cluster administrator.

cluster_authType :: Lens' Cluster Auth Source #

The authentication type for the Elastic DocumentDB cluster.

cluster_clusterArn :: Lens' Cluster Text Source #

The arn of the Elastic DocumentDB cluster.

cluster_clusterEndpoint :: Lens' Cluster Text Source #

The URL used to connect to the Elastic DocumentDB cluster.

cluster_clusterName :: Lens' Cluster Text Source #

The name of the Elastic DocumentDB cluster.

cluster_createTime :: Lens' Cluster Text Source #

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

cluster_kmsKeyId :: Lens' Cluster Text Source #

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

cluster_preferredMaintenanceWindow :: Lens' Cluster Text Source #

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

cluster_shardCapacity :: Lens' Cluster Int Source #

The capacity of each shard in the Elastic DocumentDB cluster.

cluster_shardCount :: Lens' Cluster Int Source #

The number of shards in the Elastic DocumentDB cluster.

cluster_status :: Lens' Cluster Status Source #

The status of the Elastic DocumentDB cluster.

cluster_subnetIds :: Lens' Cluster [Text] Source #

The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.

cluster_vpcSecurityGroupIds :: Lens' Cluster [Text] Source #

A list of EC2 VPC security groups associated with this cluster.

ClusterInList

data ClusterInList Source #

A list of Elastic DocumentDB cluster.

See: newClusterInList smart constructor.

Constructors

ClusterInList'
Fields clusterArn :: Text The arn of the Elastic DocumentDB cluster. clusterName :: Text The name of the Elastic DocumentDB cluster. status :: Status The status of the Elastic DocumentDB cluster.

Instances

Instances details

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

newClusterInList Source #

Arguments

:: Text	`$sel:clusterArn:ClusterInList'`
-> Text	`$sel:clusterName:ClusterInList'`
-> Status	`$sel:status:ClusterInList'`
-> ClusterInList

Create a value of ClusterInList 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:clusterArn:ClusterInList', clusterInList_clusterArn - The arn of the Elastic DocumentDB cluster.

$sel:clusterName:ClusterInList', clusterInList_clusterName - The name of the Elastic DocumentDB cluster.

$sel:status:ClusterInList', clusterInList_status - The status of the Elastic DocumentDB cluster.

clusterInList_clusterArn :: Lens' ClusterInList Text Source #

The arn of the Elastic DocumentDB cluster.

clusterInList_clusterName :: Lens' ClusterInList Text Source #

The name of the Elastic DocumentDB cluster.

clusterInList_status :: Lens' ClusterInList Status Source #

The status of the Elastic DocumentDB cluster.

ClusterSnapshot

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.

ClusterSnapshotInList

data ClusterSnapshotInList Source #

A list of Elastic DocumentDB snapshots.

See: newClusterSnapshotInList smart constructor.

Constructors

ClusterSnapshotInList'
Fields clusterArn :: Text The arn of 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.

Instances

Instances details

FromJSON ClusterSnapshotInList Source #
Instance details Defined in Amazonka.DocDbElastic.Types.ClusterSnapshotInList Methods parseJSON :: Value -> Parser ClusterSnapshotInList # parseJSONList :: Value -> Parser [ClusterSnapshotInList] #
Generic ClusterSnapshotInList Source #
Instance details Defined in Amazonka.DocDbElastic.Types.ClusterSnapshotInList Associated Types type Rep ClusterSnapshotInList :: Type -> Type # Methods from :: ClusterSnapshotInList -> Rep ClusterSnapshotInList x # to :: Rep ClusterSnapshotInList x -> ClusterSnapshotInList #
Read ClusterSnapshotInList Source #
Instance details Defined in Amazonka.DocDbElastic.Types.ClusterSnapshotInList Methods readsPrec :: Int -> ReadS ClusterSnapshotInList # readList :: ReadS [ClusterSnapshotInList] # readPrec :: ReadPrec ClusterSnapshotInList # readListPrec :: ReadPrec [ClusterSnapshotInList] #
Show ClusterSnapshotInList Source #
Instance details Defined in Amazonka.DocDbElastic.Types.ClusterSnapshotInList Methods showsPrec :: Int -> ClusterSnapshotInList -> ShowS # show :: ClusterSnapshotInList -> String # showList :: [ClusterSnapshotInList] -> ShowS #
NFData ClusterSnapshotInList Source #
Instance details Defined in Amazonka.DocDbElastic.Types.ClusterSnapshotInList Methods rnf :: ClusterSnapshotInList -> () #
Eq ClusterSnapshotInList Source #
Instance details Defined in Amazonka.DocDbElastic.Types.ClusterSnapshotInList Methods (==) :: ClusterSnapshotInList -> ClusterSnapshotInList -> Bool # (/=) :: ClusterSnapshotInList -> ClusterSnapshotInList -> Bool #
Hashable ClusterSnapshotInList Source #
Instance details Defined in Amazonka.DocDbElastic.Types.ClusterSnapshotInList Methods hashWithSalt :: Int -> ClusterSnapshotInList -> Int # hash :: ClusterSnapshotInList -> Int #
type Rep ClusterSnapshotInList Source #
Instance details Defined in Amazonka.DocDbElastic.Types.ClusterSnapshotInList type Rep ClusterSnapshotInList = D1 ('MetaData "ClusterSnapshotInList" "Amazonka.DocDbElastic.Types.ClusterSnapshotInList" "amazonka-docdb-elastic-2.0-7oyCcw7MbTKKNwZE62fvl3" 'False) (C1 ('MetaCons "ClusterSnapshotInList'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clusterArn") '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)))))

newClusterSnapshotInList Source #

Arguments

:: Text	`$sel:clusterArn:ClusterSnapshotInList'`
-> Text	`$sel:snapshotArn:ClusterSnapshotInList'`
-> Text	`$sel:snapshotCreationTime:ClusterSnapshotInList'`
-> Text	`$sel:snapshotName:ClusterSnapshotInList'`
-> Status	`$sel:status:ClusterSnapshotInList'`
-> ClusterSnapshotInList

Create a value of ClusterSnapshotInList 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:clusterArn:ClusterSnapshotInList', clusterSnapshotInList_clusterArn - The arn of the Elastic DocumentDB cluster.

$sel:snapshotArn:ClusterSnapshotInList', clusterSnapshotInList_snapshotArn - The arn of the Elastic DocumentDB snapshot

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

$sel:snapshotName:ClusterSnapshotInList', clusterSnapshotInList_snapshotName - The name of the Elastic DocumentDB snapshot.

$sel:status:ClusterSnapshotInList', clusterSnapshotInList_status - The status of the Elastic DocumentDB snapshot.

clusterSnapshotInList_clusterArn :: Lens' ClusterSnapshotInList Text Source #

The arn of the Elastic DocumentDB cluster.

clusterSnapshotInList_snapshotArn :: Lens' ClusterSnapshotInList Text Source #

The arn of the Elastic DocumentDB snapshot

clusterSnapshotInList_snapshotCreationTime :: Lens' ClusterSnapshotInList Text Source #

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

clusterSnapshotInList_snapshotName :: Lens' ClusterSnapshotInList Text Source #

The name of the Elastic DocumentDB snapshot.

clusterSnapshotInList_status :: Lens' ClusterSnapshotInList Status Source #

The status of the Elastic DocumentDB snapshot.