amazonka-memorydb-2.0: Amazon MemoryDB SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.MemoryDb.CreateCluster

Description

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

Synopsis

Creating a Request

data CreateCluster Source #

See: newCreateCluster smart constructor.

Constructors

CreateCluster' 

Fields

  • autoMinorVersionUpgrade :: Maybe Bool

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

  • dataTiering :: Maybe Bool

    Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.

  • description :: Maybe Text

    An optional description of the cluster.

  • engineVersion :: Maybe Text

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

  • kmsKeyId :: Maybe Text

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

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

    Valid values for ddd are:

    • sun
    • mon
    • tue
    • wed
    • thu
    • fri
    • sat

    Example: sun:23:00-mon:01:30

  • numReplicasPerShard :: Maybe Int

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

  • numShards :: Maybe Int

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

  • parameterGroupName :: Maybe Text

    The name of the parameter group associated with the cluster.

  • port :: Maybe Int

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

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

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

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

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

  • snsTopicArn :: Maybe Text

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

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

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

  • 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
ToJSON CreateCluster Source # 
Instance details

Defined in Amazonka.MemoryDb.CreateCluster

ToHeaders CreateCluster Source # 
Instance details

Defined in Amazonka.MemoryDb.CreateCluster

ToPath CreateCluster Source # 
Instance details

Defined in Amazonka.MemoryDb.CreateCluster

ToQuery CreateCluster Source # 
Instance details

Defined in Amazonka.MemoryDb.CreateCluster

AWSRequest CreateCluster Source # 
Instance details

Defined in Amazonka.MemoryDb.CreateCluster

Associated Types

type AWSResponse CreateCluster #

Generic CreateCluster Source # 
Instance details

Defined in Amazonka.MemoryDb.CreateCluster

Associated Types

type Rep CreateCluster :: Type -> Type #

Read CreateCluster Source # 
Instance details

Defined in Amazonka.MemoryDb.CreateCluster

Show CreateCluster Source # 
Instance details

Defined in Amazonka.MemoryDb.CreateCluster

NFData CreateCluster Source # 
Instance details

Defined in Amazonka.MemoryDb.CreateCluster

Methods

rnf :: CreateCluster -> () #

Eq CreateCluster Source # 
Instance details

Defined in Amazonka.MemoryDb.CreateCluster

Hashable CreateCluster Source # 
Instance details

Defined in Amazonka.MemoryDb.CreateCluster

type AWSResponse CreateCluster Source # 
Instance details

Defined in Amazonka.MemoryDb.CreateCluster

type Rep CreateCluster Source # 
Instance details

Defined in Amazonka.MemoryDb.CreateCluster

type Rep CreateCluster = D1 ('MetaData "CreateCluster" "Amazonka.MemoryDb.CreateCluster" "amazonka-memorydb-2.0-7JvPQiLpSKi6naAXiKMLiu" 'False) (C1 ('MetaCons "CreateCluster'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "autoMinorVersionUpgrade") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "dataTiering") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "maintenanceWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "numReplicasPerShard") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "numShards") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: (S1 ('MetaSel ('Just "parameterGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "securityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))) :*: (((S1 ('MetaSel ('Just "snapshotArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "snapshotName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "snapshotRetentionLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "snapshotWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "snsTopicArn") '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 "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])))) :*: (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)))))))

newCreateCluster Source #

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:

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

CreateCluster, createCluster_dataTiering - Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.

CreateCluster, createCluster_description - An optional description of the cluster.

CreateCluster, createCluster_engineVersion - The version number of the Redis engine to be used for the cluster.

CreateCluster, createCluster_kmsKeyId - The ID of the KMS key used to encrypt the cluster.

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.

Valid values for ddd are:

  • sun
  • mon
  • tue
  • wed
  • thu
  • fri
  • sat

Example: sun:23:00-mon:01:30

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

CreateCluster, createCluster_numShards - The number of shards the cluster will contain. The default value is 1.

CreateCluster, createCluster_parameterGroupName - The name of the parameter group associated with the cluster.

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

$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: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.

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.

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.

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

CreateCluster, createCluster_subnetGroupName - The name of the subnet group to be used for the cluster.

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

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

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

CreateCluster, createCluster_nodeType - The compute and memory capacity of the nodes in the cluster.

CreateCluster, createCluster_aCLName - The name of the Access Control List to associate with the cluster.

Request Lenses

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

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

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

Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.

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

An optional description of the cluster.

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

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

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

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

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.

Valid values for ddd are:

  • sun
  • mon
  • tue
  • wed
  • thu
  • fri
  • sat

Example: sun:23:00-mon:01:30

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_numShards :: Lens' CreateCluster (Maybe Int) Source #

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

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

The name of the parameter group associated with the cluster.

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

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

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_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_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_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_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_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_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_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

Instances

Instances details
Generic CreateClusterResponse Source # 
Instance details

Defined in Amazonka.MemoryDb.CreateCluster

Associated Types

type Rep CreateClusterResponse :: Type -> Type #

Read CreateClusterResponse Source # 
Instance details

Defined in Amazonka.MemoryDb.CreateCluster

Show CreateClusterResponse Source # 
Instance details

Defined in Amazonka.MemoryDb.CreateCluster

NFData CreateClusterResponse Source # 
Instance details

Defined in Amazonka.MemoryDb.CreateCluster

Methods

rnf :: CreateClusterResponse -> () #

Eq CreateClusterResponse Source # 
Instance details

Defined in Amazonka.MemoryDb.CreateCluster

type Rep CreateClusterResponse Source # 
Instance details

Defined in Amazonka.MemoryDb.CreateCluster

type Rep CreateClusterResponse = D1 ('MetaData "CreateClusterResponse" "Amazonka.MemoryDb.CreateCluster" "amazonka-memorydb-2.0-7JvPQiLpSKi6naAXiKMLiu" '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 #

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