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.Cluster

Description

Synopsis

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]

Documentation

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.