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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a cluster. All nodes in the cluster run the same protocol-compliant engine software.

Synopsis

data CreateCluster = CreateCluster' {
- engineVersion :: Maybe Text
- securityGroupIds :: Maybe [Text]
- snapshotArns :: Maybe [Text]
- autoMinorVersionUpgrade :: Maybe Bool
- snsTopicArn :: Maybe Text
- snapshotWindow :: Maybe Text
- subnetGroupName :: Maybe Text
- tLSEnabled :: Maybe Bool
- numShards :: Maybe Int
- maintenanceWindow :: Maybe Text
- kmsKeyId :: Maybe Text
- snapshotRetentionLimit :: Maybe Int
- snapshotName :: Maybe Text
- description :: Maybe Text
- numReplicasPerShard :: Maybe Int
- tags :: Maybe [Tag]
- port :: Maybe Int
- parameterGroupName :: Maybe Text
- clusterName :: Text
- nodeType :: Text
- aCLName :: Text
}
newCreateCluster :: Text -> Text -> Text -> CreateCluster
createCluster_engineVersion :: Lens' CreateCluster (Maybe Text)
createCluster_securityGroupIds :: Lens' CreateCluster (Maybe [Text])
createCluster_snapshotArns :: Lens' CreateCluster (Maybe [Text])
createCluster_autoMinorVersionUpgrade :: Lens' CreateCluster (Maybe Bool)
createCluster_snsTopicArn :: Lens' CreateCluster (Maybe Text)
createCluster_snapshotWindow :: Lens' CreateCluster (Maybe Text)
createCluster_subnetGroupName :: Lens' CreateCluster (Maybe Text)
createCluster_tLSEnabled :: Lens' CreateCluster (Maybe Bool)
createCluster_numShards :: Lens' CreateCluster (Maybe Int)
createCluster_maintenanceWindow :: Lens' CreateCluster (Maybe Text)
createCluster_kmsKeyId :: Lens' CreateCluster (Maybe Text)
createCluster_snapshotRetentionLimit :: Lens' CreateCluster (Maybe Int)
createCluster_snapshotName :: Lens' CreateCluster (Maybe Text)
createCluster_description :: Lens' CreateCluster (Maybe Text)
createCluster_numReplicasPerShard :: Lens' CreateCluster (Maybe Int)
createCluster_tags :: Lens' CreateCluster (Maybe [Tag])
createCluster_port :: Lens' CreateCluster (Maybe Int)
createCluster_parameterGroupName :: Lens' CreateCluster (Maybe Text)
createCluster_clusterName :: Lens' CreateCluster Text
createCluster_nodeType :: Lens' CreateCluster Text
createCluster_aCLName :: Lens' CreateCluster Text
data CreateClusterResponse = CreateClusterResponse' {
- cluster :: Maybe Cluster
- httpStatus :: Int
}
newCreateClusterResponse :: Int -> CreateClusterResponse
createClusterResponse_cluster :: Lens' CreateClusterResponse (Maybe Cluster)
createClusterResponse_httpStatus :: Lens' CreateClusterResponse Int

Creating a Request

data CreateCluster Source #

See: newCreateCluster smart constructor.

Constructors

CreateCluster'

Fields

engineVersion :: Maybe Text
The version number of the Redis engine to be used for the cluster.
securityGroupIds :: Maybe [Text]
A list of security group names to associate with this cluster.
snapshotArns :: Maybe [Text]
A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new cluster. The Amazon S3 object name in the ARN cannot contain any commas.
autoMinorVersionUpgrade :: Maybe Bool
When set to true, the cluster will automatically receive minor engine version upgrades after launch.
snsTopicArn :: Maybe Text
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
snapshotWindow :: Maybe Text
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.
Example: 05:00-09:00
If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.
subnetGroupName :: Maybe Text
The name of the subnet group to be used for the cluster.
tLSEnabled :: Maybe Bool
A flag to enable in-transit encryption on the cluster.
numShards :: Maybe Int
The number of shards the cluster will contain. The default value is 1.
maintenanceWindow :: Maybe Text
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
kmsKeyId :: Maybe Text
The ID of the KMS key used to encrypt the cluster.
snapshotRetentionLimit :: Maybe Int
The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
snapshotName :: Maybe Text
The name of a snapshot from which to restore data into the new cluster. The snapshot status changes to restoring while the new cluster is being created.
description :: Maybe Text
An optional description of the cluster.
numReplicasPerShard :: Maybe Int
The number of replicas to apply to each shard. The default value is 1. The maximum is 5.
tags :: Maybe [Tag]
A list of tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue.
port :: Maybe Int
The port number on which each of the nodes accepts connections.
parameterGroupName :: Maybe Text
The name of the parameter group associated with the cluster.
clusterName :: Text
The name of the cluster. This value must be unique as it also serves as the cluster identifier.
nodeType :: Text
The compute and memory capacity of the nodes in the cluster.
aCLName :: Text
The name of the Access Control List to associate with the cluster.

Instances

Instances details

Eq CreateCluster Source #
Instance details Defined in Amazonka.MemoryDb.CreateCluster Methods (==) :: CreateCluster -> CreateCluster -> Bool # (/=) :: CreateCluster -> CreateCluster -> Bool #
Read CreateCluster Source #
Instance details Defined in Amazonka.MemoryDb.CreateCluster Methods readsPrec :: Int -> ReadS CreateCluster # readList :: ReadS [CreateCluster] # readPrec :: ReadPrec CreateCluster # readListPrec :: ReadPrec [CreateCluster] #
Show CreateCluster Source #
Instance details Defined in Amazonka.MemoryDb.CreateCluster Methods showsPrec :: Int -> CreateCluster -> ShowS # show :: CreateCluster -> String # showList :: [CreateCluster] -> ShowS #
Generic CreateCluster Source #
Instance details Defined in Amazonka.MemoryDb.CreateCluster Associated Types type Rep CreateCluster :: Type -> Type # Methods from :: CreateCluster -> Rep CreateCluster x # to :: Rep CreateCluster x -> CreateCluster #
NFData CreateCluster Source #
Instance details Defined in Amazonka.MemoryDb.CreateCluster Methods rnf :: CreateCluster -> () #
Hashable CreateCluster Source #
Instance details Defined in Amazonka.MemoryDb.CreateCluster Methods hashWithSalt :: Int -> CreateCluster -> Int # hash :: CreateCluster -> Int #
ToJSON CreateCluster Source #
Instance details Defined in Amazonka.MemoryDb.CreateCluster Methods toJSON :: CreateCluster -> Value # toEncoding :: CreateCluster -> Encoding # toJSONList :: [CreateCluster] -> Value # toEncodingList :: [CreateCluster] -> Encoding #
AWSRequest CreateCluster Source #
Instance details Defined in Amazonka.MemoryDb.CreateCluster Associated Types type AWSResponse CreateCluster # Methods request :: CreateCluster -> Request CreateCluster # response :: MonadResource m => Logger -> Service -> Proxy CreateCluster -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateCluster))) #
ToHeaders CreateCluster Source #
Instance details Defined in Amazonka.MemoryDb.CreateCluster Methods toHeaders :: CreateCluster -> [Header] #
ToPath CreateCluster Source #
Instance details Defined in Amazonka.MemoryDb.CreateCluster Methods toPath :: CreateCluster -> ByteString #
ToQuery CreateCluster Source #
Instance details Defined in Amazonka.MemoryDb.CreateCluster Methods toQuery :: CreateCluster -> QueryString #
type Rep CreateCluster Source #
Instance details Defined in Amazonka.MemoryDb.CreateCluster type Rep CreateCluster = D1 ('MetaData "CreateCluster" "Amazonka.MemoryDb.CreateCluster" "libZSservicesZSamazonka-memorydbZSamazonka-memorydb" 'False) (C1 ('MetaCons "CreateCluster'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "securityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "snapshotArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "autoMinorVersionUpgrade") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "snsTopicArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "snapshotWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "subnetGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "tLSEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "numShards") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "maintenanceWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :: (((S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "snapshotRetentionLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "snapshotName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "numReplicasPerShard") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))) :: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: (S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "parameterGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "clusterName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "nodeType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "aCLName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))))
type AWSResponse CreateCluster Source #
Instance details Defined in Amazonka.MemoryDb.CreateCluster type AWSResponse CreateCluster = CreateClusterResponse

newCreateCluster Source #

Arguments

:: Text	`$sel:clusterName:CreateCluster'`
-> Text	`$sel:nodeType:CreateCluster'`
-> Text	`$sel:aCLName: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:engineVersion:CreateCluster', createCluster_engineVersion - The version number of the Redis engine to be used for the cluster.

$sel:securityGroupIds:CreateCluster', createCluster_securityGroupIds - A list of security group names to associate with this cluster.

$sel:snapshotArns:CreateCluster', createCluster_snapshotArns - A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new cluster. The Amazon S3 object name in the ARN cannot contain any commas.

$sel:autoMinorVersionUpgrade:CreateCluster', createCluster_autoMinorVersionUpgrade - When set to true, the cluster will automatically receive minor engine version upgrades after launch.

$sel:snsTopicArn:CreateCluster', createCluster_snsTopicArn - The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.

$sel:snapshotWindow:CreateCluster', createCluster_snapshotWindow - The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.

Example: 05:00-09:00

If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.

$sel:subnetGroupName:CreateCluster', createCluster_subnetGroupName - The name of the subnet group to be used for the cluster.

$sel:tLSEnabled:CreateCluster', createCluster_tLSEnabled - A flag to enable in-transit encryption on the cluster.

$sel:numShards:CreateCluster', createCluster_numShards - The number of shards the cluster will contain. The default value is 1.

$sel:maintenanceWindow:CreateCluster', createCluster_maintenanceWindow - Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

$sel:kmsKeyId:CreateCluster', createCluster_kmsKeyId - The ID of the KMS key used to encrypt the cluster.

$sel:snapshotRetentionLimit:CreateCluster', createCluster_snapshotRetentionLimit - The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

$sel:snapshotName:CreateCluster', createCluster_snapshotName - The name of a snapshot from which to restore data into the new cluster. The snapshot status changes to restoring while the new cluster is being created.

$sel:description:CreateCluster', createCluster_description - An optional description of the cluster.

$sel:numReplicasPerShard:CreateCluster', createCluster_numReplicasPerShard - The number of replicas to apply to each shard. The default value is 1. The maximum is 5.

$sel:tags:CreateCluster', createCluster_tags - A list of tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue.

$sel:port:CreateCluster', createCluster_port - The port number on which each of the nodes accepts connections.

$sel:parameterGroupName:CreateCluster', createCluster_parameterGroupName - The name of the parameter group associated with the cluster.

$sel:clusterName:CreateCluster', createCluster_clusterName - The name of the cluster. This value must be unique as it also serves as the cluster identifier.

$sel:nodeType:CreateCluster', createCluster_nodeType - The compute and memory capacity of the nodes in the cluster.

$sel:aCLName:CreateCluster', createCluster_aCLName - The name of the Access Control List to associate with the cluster.

Request Lenses

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

The version number of the Redis engine to be used for the cluster.

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

A list of security group names to associate with this cluster.

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

A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new cluster. The Amazon S3 object name in the ARN cannot contain any commas.

createCluster_autoMinorVersionUpgrade :: Lens' CreateCluster (Maybe Bool) Source #

When set to true, the cluster will automatically receive minor engine version upgrades after launch.

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

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.

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

The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.

Example: 05:00-09:00

If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.

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

The name of the subnet group to be used for the cluster.

createCluster_tLSEnabled :: Lens' CreateCluster (Maybe Bool) Source #

A flag to enable in-transit encryption on the cluster.

createCluster_numShards :: Lens' CreateCluster (Maybe Int) Source #

The number of shards the cluster will contain. The default value is 1.

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

Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

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

The ID of the KMS key used to encrypt the cluster.

createCluster_snapshotRetentionLimit :: Lens' CreateCluster (Maybe Int) Source #

The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

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

The name of a snapshot from which to restore data into the new cluster. The snapshot status changes to restoring while the new cluster is being created.

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

An optional description of the cluster.

createCluster_numReplicasPerShard :: Lens' CreateCluster (Maybe Int) Source #

The number of replicas to apply to each shard. The default value is 1. The maximum is 5.

createCluster_tags :: Lens' CreateCluster (Maybe [Tag]) Source #

A list of tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue.

createCluster_port :: Lens' CreateCluster (Maybe Int) Source #

The port number on which each of the nodes accepts connections.

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

The name of the parameter group associated with the cluster.

createCluster_clusterName :: Lens' CreateCluster Text Source #

The name of the cluster. This value must be unique as it also serves as the cluster identifier.

createCluster_nodeType :: Lens' CreateCluster Text Source #

The compute and memory capacity of the nodes in the cluster.

createCluster_aCLName :: Lens' CreateCluster Text Source #

The name of the Access Control List to associate with the cluster.

Destructuring the Response

data CreateClusterResponse Source #

See: newCreateClusterResponse smart constructor.

Constructors

CreateClusterResponse'
Fields cluster :: Maybe Cluster The newly-created cluster. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateClusterResponse Source #

Arguments

:: Int	`$sel:httpStatus: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:cluster:CreateClusterResponse', createClusterResponse_cluster - The newly-created cluster.

$sel:httpStatus:CreateClusterResponse', createClusterResponse_httpStatus - The response's http status code.

Response Lenses

createClusterResponse_cluster :: Lens' CreateClusterResponse (Maybe Cluster) Source #

The newly-created cluster.

createClusterResponse_httpStatus :: Lens' CreateClusterResponse Int Source #

The response's http status code.