Network.AWS.DAX.CreateCluster

Creates a DAX cluster. All nodes in the cluster run the same DAX caching software.

Creating a Request

createCluster

Arguments

:: Text

ccClusterName

-> Text

ccNodeType

-> Int

ccReplicationFactor

-> Text

ccIAMRoleARN

-> CreateCluster

Creates a value of CreateCluster with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ccSecurityGroupIds - A list of security group IDs to be assigned to each node in the DAX cluster. (Each of the security group ID is system-generated.) If this parameter is not specified, DAX assigns the default VPC security group to each node.
• ccSubnetGroupName - The name of the subnet group to be used for the replication group. Important: DAX clusters can only run in an Amazon VPC environment. All of the subnets that you specify in a subnet group must exist in the same VPC.
• ccPreferredMaintenanceWindow - Specifies the weekly time range during which maintenance on the DAX 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:05:00-sun:09:00
• ccAvailabilityZones - The Availability Zones (AZs) in which the cluster nodes will be created. All nodes belonging to the cluster are placed in these Availability Zones. Use this parameter if you want to distribute the nodes across multiple AZs.
• ccDescription - A description of the cluster.
• ccNotificationTopicARN - The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.
• ccTags - A set of tags to associate with the DAX cluster.
• ccParameterGroupName - The parameter group to be associated with the DAX cluster.
• ccClusterName - The cluster identifier. This parameter is stored as a lowercase string. Constraints: * A name must contain from 1 to 20 alphanumeric characters or hyphens. * The first character must be a letter. * A name cannot end with a hyphen or contain two consecutive hyphens.
• ccNodeType - The compute and memory capacity of the nodes in the cluster.
• ccReplicationFactor - The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas. For additional fault tolerance, you can create a multiple node cluster with one or more read replicas. To do this, set ReplicationFactor to 2 or more.
• ccIAMRoleARN - A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.

data CreateCluster

See: createCluster smart constructor.

Instances

Eq CreateCluster

Methods

(==) :: CreateCluster -> CreateCluster -> Bool

(/=) :: CreateCluster -> CreateCluster -> Bool

Data CreateCluster

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateCluster -> c CreateCluster

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateCluster

toConstr :: CreateCluster -> Constr

dataTypeOf :: CreateCluster -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateCluster)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateCluster)

gmapT :: (forall b. Data b => b -> b) -> CreateCluster -> CreateCluster

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateCluster -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateCluster -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateCluster -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateCluster -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateCluster -> m CreateCluster

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateCluster -> m CreateCluster

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateCluster -> m CreateCluster

Read CreateCluster

Methods

readsPrec :: Int -> ReadS CreateCluster

readList :: ReadS [CreateCluster]

readPrec :: ReadPrec CreateCluster

readListPrec :: ReadPrec [CreateCluster]

Show CreateCluster

Methods

showsPrec :: Int -> CreateCluster -> ShowS

show :: CreateCluster -> String

showList :: [CreateCluster] -> ShowS

Generic CreateCluster

Associated Types

type Rep CreateCluster :: * -> *

Methods

from :: CreateCluster -> Rep CreateCluster x

to :: Rep CreateCluster x -> CreateCluster

Hashable CreateCluster

Methods

hashWithSalt :: Int -> CreateCluster -> Int

hash :: CreateCluster -> Int

ToJSON CreateCluster

Methods

toJSON :: CreateCluster -> Value

toEncoding :: CreateCluster -> Encoding

toJSONList :: [CreateCluster] -> Value

toEncodingList :: [CreateCluster] -> Encoding

NFData CreateCluster

Methods

rnf :: CreateCluster -> ()

AWSRequest CreateCluster

Associated Types

type Rs CreateCluster :: *

Methods

request :: CreateCluster -> Request CreateCluster

response :: MonadResource m => Logger -> Service -> Proxy * CreateCluster -> ClientResponse -> m (Response CreateCluster)

ToQuery CreateCluster

Methods

toQuery :: CreateCluster -> QueryString

ToPath CreateCluster

Methods

toPath :: CreateCluster -> ByteString

ToHeaders CreateCluster

Methods

toHeaders :: CreateCluster -> [Header]

type Rep CreateCluster

type Rep CreateCluster = D1 (MetaData "CreateCluster" "Network.AWS.DAX.CreateCluster" "amazonka-dynamodb-dax-1.5.0-JMry6GeWLPS2KkVhaaXmgc" False) (C1 (MetaCons "CreateCluster'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ccSecurityGroupIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) ((:*:) (S1 (MetaSel (Just Symbol "_ccSubnetGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ccPreferredMaintenanceWindow") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_ccAvailabilityZones") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) ((:*:) (S1 (MetaSel (Just Symbol "_ccDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ccNotificationTopicARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ccTags") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Tag]))) ((:*:) (S1 (MetaSel (Just Symbol "_ccParameterGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ccClusterName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_ccNodeType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) ((:*:) (S1 (MetaSel (Just Symbol "_ccReplicationFactor") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)) (S1 (MetaSel (Just Symbol "_ccIAMRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))))

type Rs CreateCluster

type Rs CreateCluster = CreateClusterResponse

Request Lenses

ccSecurityGroupIds :: Lens' CreateCluster [Text]

A list of security group IDs to be assigned to each node in the DAX cluster. (Each of the security group ID is system-generated.) If this parameter is not specified, DAX assigns the default VPC security group to each node.

ccSubnetGroupName :: Lens' CreateCluster (Maybe Text)

The name of the subnet group to be used for the replication group. Important: DAX clusters can only run in an Amazon VPC environment. All of the subnets that you specify in a subnet group must exist in the same VPC.

ccPreferredMaintenanceWindow :: Lens' CreateCluster (Maybe Text)

Specifies the weekly time range during which maintenance on the DAX 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:05:00-sun:09:00

ccAvailabilityZones :: Lens' CreateCluster [Text]

The Availability Zones (AZs) in which the cluster nodes will be created. All nodes belonging to the cluster are placed in these Availability Zones. Use this parameter if you want to distribute the nodes across multiple AZs.

ccDescription :: Lens' CreateCluster (Maybe Text)

A description of the cluster.

ccNotificationTopicARN :: Lens' CreateCluster (Maybe Text)

The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.

ccTags :: Lens' CreateCluster [Tag]

A set of tags to associate with the DAX cluster.

ccParameterGroupName :: Lens' CreateCluster (Maybe Text)

The parameter group to be associated with the DAX cluster.

ccClusterName :: Lens' CreateCluster Text

The cluster identifier. This parameter is stored as a lowercase string. Constraints: * A name must contain from 1 to 20 alphanumeric characters or hyphens. * The first character must be a letter. * A name cannot end with a hyphen or contain two consecutive hyphens.

ccNodeType :: Lens' CreateCluster Text

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

ccReplicationFactor :: Lens' CreateCluster Int

The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas. For additional fault tolerance, you can create a multiple node cluster with one or more read replicas. To do this, set ReplicationFactor to 2 or more.

ccIAMRoleARN :: Lens' CreateCluster Text

A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.

Destructuring the Response

createClusterResponse

Arguments

:: Int

ccrsResponseStatus

-> CreateClusterResponse

Creates a value of CreateClusterResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ccrsCluster - A description of the DAX cluster that you have created.
• ccrsResponseStatus - -- | The response status code.

data CreateClusterResponse

See: createClusterResponse smart constructor.

Instances

Eq CreateClusterResponse

Methods

(==) :: CreateClusterResponse -> CreateClusterResponse -> Bool

(/=) :: CreateClusterResponse -> CreateClusterResponse -> Bool

Data CreateClusterResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateClusterResponse -> c CreateClusterResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateClusterResponse

toConstr :: CreateClusterResponse -> Constr

dataTypeOf :: CreateClusterResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateClusterResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateClusterResponse)

gmapT :: (forall b. Data b => b -> b) -> CreateClusterResponse -> CreateClusterResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateClusterResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateClusterResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateClusterResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateClusterResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateClusterResponse -> m CreateClusterResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateClusterResponse -> m CreateClusterResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateClusterResponse -> m CreateClusterResponse

Read CreateClusterResponse

Methods

readsPrec :: Int -> ReadS CreateClusterResponse

readList :: ReadS [CreateClusterResponse]

readPrec :: ReadPrec CreateClusterResponse

readListPrec :: ReadPrec [CreateClusterResponse]

Show CreateClusterResponse

Methods

showsPrec :: Int -> CreateClusterResponse -> ShowS

show :: CreateClusterResponse -> String

showList :: [CreateClusterResponse] -> ShowS

Generic CreateClusterResponse

Associated Types

type Rep CreateClusterResponse :: * -> *

Methods

from :: CreateClusterResponse -> Rep CreateClusterResponse x

to :: Rep CreateClusterResponse x -> CreateClusterResponse

NFData CreateClusterResponse

Methods

rnf :: CreateClusterResponse -> ()

type Rep CreateClusterResponse

type Rep CreateClusterResponse = D1 (MetaData "CreateClusterResponse" "Network.AWS.DAX.CreateCluster" "amazonka-dynamodb-dax-1.5.0-JMry6GeWLPS2KkVhaaXmgc" False) (C1 (MetaCons "CreateClusterResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ccrsCluster") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Cluster))) (S1 (MetaSel (Just Symbol "_ccrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

ccrsCluster :: Lens' CreateClusterResponse (Maybe Cluster)

A description of the DAX cluster that you have created.

ccrsResponseStatus :: Lens' CreateClusterResponse Int

• - | The response status code.