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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new Elastic DocumentDB cluster and returns its Cluster structure.

Synopsis

data CreateCluster = CreateCluster' {
- clientToken :: Maybe Text
- kmsKeyId :: Maybe Text
- preferredMaintenanceWindow :: Maybe Text
- subnetIds :: Maybe [Text]
- tags :: Maybe (HashMap Text Text)
- vpcSecurityGroupIds :: Maybe [Text]
- adminUserName :: Text
- adminUserPassword :: Sensitive Text
- authType :: Auth
- clusterName :: Text
- shardCapacity :: Int
- shardCount :: Int
}
newCreateCluster :: Text -> Text -> Auth -> Text -> Int -> Int -> CreateCluster
createCluster_clientToken :: Lens' CreateCluster (Maybe Text)
createCluster_kmsKeyId :: Lens' CreateCluster (Maybe Text)
createCluster_preferredMaintenanceWindow :: Lens' CreateCluster (Maybe Text)
createCluster_subnetIds :: Lens' CreateCluster (Maybe [Text])
createCluster_tags :: Lens' CreateCluster (Maybe (HashMap Text Text))
createCluster_vpcSecurityGroupIds :: Lens' CreateCluster (Maybe [Text])
createCluster_adminUserName :: Lens' CreateCluster Text
createCluster_adminUserPassword :: Lens' CreateCluster Text
createCluster_authType :: Lens' CreateCluster Auth
createCluster_clusterName :: Lens' CreateCluster Text
createCluster_shardCapacity :: Lens' CreateCluster Int
createCluster_shardCount :: Lens' CreateCluster Int
data CreateClusterResponse = CreateClusterResponse' {
- httpStatus :: Int
- cluster :: Cluster
}
newCreateClusterResponse :: Int -> Cluster -> CreateClusterResponse
createClusterResponse_httpStatus :: Lens' CreateClusterResponse Int
createClusterResponse_cluster :: Lens' CreateClusterResponse Cluster

Creating a Request

data CreateCluster Source #

See: newCreateCluster smart constructor.

Constructors

CreateCluster'

Fields

clientToken :: Maybe Text
The client token for the Elastic DocumentDB cluster.
kmsKeyId :: Maybe Text
The KMS key identifier to use to encrypt the new Elastic DocumentDB cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key.
If an encryption key is not specified, Elastic DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.
preferredMaintenanceWindow :: Maybe Text
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
Default: a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
subnetIds :: Maybe [Text]
The Amazon EC2 subnet IDs for the new Elastic DocumentDB cluster.
tags :: Maybe (HashMap Text Text)
The tags to be assigned to the new Elastic DocumentDB cluster.
vpcSecurityGroupIds :: Maybe [Text]
A list of EC2 VPC security groups to associate with the new Elastic DocumentDB cluster.
adminUserName :: Text
The name of the Elastic DocumentDB cluster administrator.
Constraints:
- Must be from 1 to 63 letters or numbers.
- The first character must be a letter.
- Cannot be a reserved word.
adminUserPassword :: Sensitive Text
The password for the Elastic DocumentDB cluster administrator and can contain any printable ASCII characters.
Constraints:
- Must contain from 8 to 100 characters.
- Cannot contain a forward slash (/), double quote ("), or the "at" symbol (@).
authType :: Auth
The authentication type for the Elastic DocumentDB cluster.
clusterName :: Text
The name of the new Elastic DocumentDB cluster. This parameter is stored as a lowercase string.
Constraints:
- Must contain from 1 to 63 letters, numbers, or hyphens.
- The first character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
Example: my-cluster
shardCapacity :: Int
The capacity of each shard in the new Elastic DocumentDB cluster.
shardCount :: Int
The number of shards to create in the new Elastic DocumentDB cluster.

Instances

Instances details

ToJSON CreateCluster Source #
Instance details Defined in Amazonka.DocDbElastic.CreateCluster Methods toJSON :: CreateCluster -> Value # toEncoding :: CreateCluster -> Encoding # toJSONList :: [CreateCluster] -> Value # toEncodingList :: [CreateCluster] -> Encoding #
ToHeaders CreateCluster Source #
Instance details Defined in Amazonka.DocDbElastic.CreateCluster Methods toHeaders :: CreateCluster -> [Header] #
ToPath CreateCluster Source #
Instance details Defined in Amazonka.DocDbElastic.CreateCluster Methods toPath :: CreateCluster -> ByteString #
ToQuery CreateCluster Source #
Instance details Defined in Amazonka.DocDbElastic.CreateCluster Methods toQuery :: CreateCluster -> QueryString #
AWSRequest CreateCluster Source #
Instance details Defined in Amazonka.DocDbElastic.CreateCluster Associated Types type AWSResponse CreateCluster # Methods request :: (Service -> Service) -> CreateCluster -> Request CreateCluster # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateCluster -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateCluster))) #
Generic CreateCluster Source #
Instance details Defined in Amazonka.DocDbElastic.CreateCluster Associated Types type Rep CreateCluster :: Type -> Type # Methods from :: CreateCluster -> Rep CreateCluster x # to :: Rep CreateCluster x -> CreateCluster #
Show CreateCluster Source #
Instance details Defined in Amazonka.DocDbElastic.CreateCluster Methods showsPrec :: Int -> CreateCluster -> ShowS # show :: CreateCluster -> String # showList :: [CreateCluster] -> ShowS #
NFData CreateCluster Source #
Instance details Defined in Amazonka.DocDbElastic.CreateCluster Methods rnf :: CreateCluster -> () #
Eq CreateCluster Source #
Instance details Defined in Amazonka.DocDbElastic.CreateCluster Methods (==) :: CreateCluster -> CreateCluster -> Bool # (/=) :: CreateCluster -> CreateCluster -> Bool #
Hashable CreateCluster Source #
Instance details Defined in Amazonka.DocDbElastic.CreateCluster Methods hashWithSalt :: Int -> CreateCluster -> Int # hash :: CreateCluster -> Int #
type AWSResponse CreateCluster Source #
Instance details Defined in Amazonka.DocDbElastic.CreateCluster type AWSResponse CreateCluster = CreateClusterResponse
type Rep CreateCluster Source #
Instance details Defined in Amazonka.DocDbElastic.CreateCluster type Rep CreateCluster = D1 ('MetaData "CreateCluster" "Amazonka.DocDbElastic.CreateCluster" "amazonka-docdb-elastic-2.0-7oyCcw7MbTKKNwZE62fvl3" 'False) (C1 ('MetaCons "CreateCluster'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "preferredMaintenanceWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "subnetIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "vpcSecurityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))) :: ((S1 ('MetaSel ('Just "adminUserName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "adminUserPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :: S1 ('MetaSel ('Just "authType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Auth))) :: (S1 ('MetaSel ('Just "clusterName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "shardCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "shardCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newCreateCluster Source #

Arguments

:: Text	`CreateCluster`
-> Text	`$sel:adminUserPassword:CreateCluster'`
-> Auth	`CreateCluster`
-> Text	`CreateCluster`
-> Int	`CreateCluster`
-> Int	`CreateCluster`
-> CreateCluster

Create a value of CreateCluster 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:clientToken:CreateCluster', createCluster_clientToken - The client token for the Elastic DocumentDB cluster.

CreateCluster, createCluster_kmsKeyId - The KMS key identifier to use to encrypt the new Elastic DocumentDB cluster.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key.

If an encryption key is not specified, Elastic DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.

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

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

Default: a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

CreateCluster, createCluster_subnetIds - The Amazon EC2 subnet IDs for the new Elastic DocumentDB cluster.

$sel:tags:CreateCluster', createCluster_tags - The tags to be assigned to the new Elastic DocumentDB cluster.

CreateCluster, createCluster_vpcSecurityGroupIds - A list of EC2 VPC security groups to associate with the new Elastic DocumentDB cluster.

CreateCluster, createCluster_adminUserName - The name of the Elastic DocumentDB cluster administrator.

Constraints:

Must be from 1 to 63 letters or numbers.
The first character must be a letter.
Cannot be a reserved word.

$sel:adminUserPassword:CreateCluster', createCluster_adminUserPassword - The password for the Elastic DocumentDB cluster administrator and can contain any printable ASCII characters.

Constraints:

Must contain from 8 to 100 characters.
Cannot contain a forward slash (/), double quote ("), or the "at" symbol (@).

CreateCluster, createCluster_authType - The authentication type for the Elastic DocumentDB cluster.

CreateCluster, createCluster_clusterName - The name of the new Elastic DocumentDB cluster. This parameter is stored as a lowercase string.

Constraints:

Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster

CreateCluster, createCluster_shardCapacity - The capacity of each shard in the new Elastic DocumentDB cluster.

CreateCluster, createCluster_shardCount - The number of shards to create in the new Elastic DocumentDB cluster.

Request Lenses

createCluster_clientToken :: Lens' CreateCluster (Maybe Text) Source #

The client token for the Elastic DocumentDB cluster.

createCluster_kmsKeyId :: Lens' CreateCluster (Maybe Text) Source #

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

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key.

If an encryption key is not specified, Elastic DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.

createCluster_preferredMaintenanceWindow :: Lens' CreateCluster (Maybe Text) Source #

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

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

Default: a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

createCluster_subnetIds :: Lens' CreateCluster (Maybe [Text]) Source #

The Amazon EC2 subnet IDs for the new Elastic DocumentDB cluster.

createCluster_tags :: Lens' CreateCluster (Maybe (HashMap Text Text)) Source #

The tags to be assigned to the new Elastic DocumentDB cluster.

createCluster_vpcSecurityGroupIds :: Lens' CreateCluster (Maybe [Text]) Source #

A list of EC2 VPC security groups to associate with the new Elastic DocumentDB cluster.

createCluster_adminUserName :: Lens' CreateCluster Text Source #

The name of the Elastic DocumentDB cluster administrator.

Constraints:

Must be from 1 to 63 letters or numbers.
The first character must be a letter.
Cannot be a reserved word.

createCluster_adminUserPassword :: Lens' CreateCluster Text Source #

The password for the Elastic DocumentDB cluster administrator and can contain any printable ASCII characters.

Constraints:

Must contain from 8 to 100 characters.
Cannot contain a forward slash (/), double quote ("), or the "at" symbol (@).

createCluster_authType :: Lens' CreateCluster Auth Source #

The authentication type for the Elastic DocumentDB cluster.

createCluster_clusterName :: Lens' CreateCluster Text Source #

The name of the new Elastic DocumentDB cluster. This parameter is stored as a lowercase string.

Constraints:

Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster

createCluster_shardCapacity :: Lens' CreateCluster Int Source #

The capacity of each shard in the new Elastic DocumentDB cluster.

createCluster_shardCount :: Lens' CreateCluster Int Source #

The number of shards to create in the new Elastic DocumentDB cluster.

Destructuring the Response

data CreateClusterResponse Source #

See: newCreateClusterResponse smart constructor.

Constructors

CreateClusterResponse'
Fields httpStatus :: Int The response's http status code. cluster :: Cluster The new Elastic DocumentDB cluster that has been created.

Instances

Instances details

Generic CreateClusterResponse Source #
Instance details Defined in Amazonka.DocDbElastic.CreateCluster Associated Types type Rep CreateClusterResponse :: Type -> Type # Methods from :: CreateClusterResponse -> Rep CreateClusterResponse x # to :: Rep CreateClusterResponse x -> CreateClusterResponse #
Read CreateClusterResponse Source #
Instance details Defined in Amazonka.DocDbElastic.CreateCluster Methods readsPrec :: Int -> ReadS CreateClusterResponse # readList :: ReadS [CreateClusterResponse] # readPrec :: ReadPrec CreateClusterResponse # readListPrec :: ReadPrec [CreateClusterResponse] #
Show CreateClusterResponse Source #
Instance details Defined in Amazonka.DocDbElastic.CreateCluster Methods showsPrec :: Int -> CreateClusterResponse -> ShowS # show :: CreateClusterResponse -> String # showList :: [CreateClusterResponse] -> ShowS #
NFData CreateClusterResponse Source #
Instance details Defined in Amazonka.DocDbElastic.CreateCluster Methods rnf :: CreateClusterResponse -> () #
Eq CreateClusterResponse Source #
Instance details Defined in Amazonka.DocDbElastic.CreateCluster Methods (==) :: CreateClusterResponse -> CreateClusterResponse -> Bool # (/=) :: CreateClusterResponse -> CreateClusterResponse -> Bool #
type Rep CreateClusterResponse Source #
Instance details Defined in Amazonka.DocDbElastic.CreateCluster type Rep CreateClusterResponse = D1 ('MetaData "CreateClusterResponse" "Amazonka.DocDbElastic.CreateCluster" "amazonka-docdb-elastic-2.0-7oyCcw7MbTKKNwZE62fvl3" 'False) (C1 ('MetaCons "CreateClusterResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "cluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Cluster)))

newCreateClusterResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateClusterResponse'`
-> Cluster	`$sel:cluster:CreateClusterResponse'`
-> CreateClusterResponse

Create a value of CreateClusterResponse 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:httpStatus:CreateClusterResponse', createClusterResponse_httpStatus - The response's http status code.

$sel:cluster:CreateClusterResponse', createClusterResponse_cluster - The new Elastic DocumentDB cluster that has been created.

Response Lenses

createClusterResponse_httpStatus :: Lens' CreateClusterResponse Int Source #

The response's http status code.

createClusterResponse_cluster :: Lens' CreateClusterResponse Cluster Source #

The new Elastic DocumentDB cluster that has been created.