amazonka-dynamodb-dax-2.0: Amazon DynamoDB Accelerator (DAX) 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.DAX.Types.Cluster

Description

 
Synopsis

Documentation

data Cluster Source #

Contains all of the attributes of a specific DAX cluster.

See: newCluster smart constructor.

Constructors

Cluster' 

Fields

Instances

Instances details
FromJSON Cluster Source # 
Instance details

Defined in Amazonka.DAX.Types.Cluster

Generic Cluster Source # 
Instance details

Defined in Amazonka.DAX.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.DAX.Types.Cluster

Show Cluster Source # 
Instance details

Defined in Amazonka.DAX.Types.Cluster

NFData Cluster Source # 
Instance details

Defined in Amazonka.DAX.Types.Cluster

Methods

rnf :: Cluster -> () #

Eq Cluster Source # 
Instance details

Defined in Amazonka.DAX.Types.Cluster

Methods

(==) :: Cluster -> Cluster -> Bool #

(/=) :: Cluster -> Cluster -> Bool #

Hashable Cluster Source # 
Instance details

Defined in Amazonka.DAX.Types.Cluster

Methods

hashWithSalt :: Int -> Cluster -> Int #

hash :: Cluster -> Int #

type Rep Cluster Source # 
Instance details

Defined in Amazonka.DAX.Types.Cluster

type Rep Cluster = D1 ('MetaData "Cluster" "Amazonka.DAX.Types.Cluster" "amazonka-dynamodb-dax-2.0-FwsdPL1z9NS2dTys8oHQ2n" 'False) (C1 ('MetaCons "Cluster'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "activeNodes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "clusterArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "clusterDiscoveryEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Endpoint)) :*: S1 ('MetaSel ('Just "clusterEndpointEncryptionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ClusterEndpointEncryptionType)))) :*: ((S1 ('MetaSel ('Just "clusterName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "iamRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "nodeIdsToRemove") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "nodeType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :*: (((S1 ('MetaSel ('Just "nodes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Node])) :*: S1 ('MetaSel ('Just "notificationConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NotificationConfiguration))) :*: (S1 ('MetaSel ('Just "parameterGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ParameterGroupStatus)) :*: S1 ('MetaSel ('Just "preferredMaintenanceWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "sSEDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SSEDescription)) :*: S1 ('MetaSel ('Just "securityGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SecurityGroupMembership]))) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "subnetGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "totalNodes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))))))

newCluster :: Cluster Source #

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:activeNodes:Cluster', cluster_activeNodes - The number of nodes in the cluster that are active (i.e., capable of serving requests).

$sel:clusterArn:Cluster', cluster_clusterArn - The Amazon Resource Name (ARN) that uniquely identifies the cluster.

$sel:clusterDiscoveryEndpoint:Cluster', cluster_clusterDiscoveryEndpoint - The endpoint for this DAX cluster, consisting of a DNS name, a port number, and a URL. Applications should use the URL to configure the DAX client to find their cluster.

$sel:clusterEndpointEncryptionType:Cluster', cluster_clusterEndpointEncryptionType - The type of encryption supported by the cluster's endpoint. Values are:

  • NONE for no encryption

    TLS for Transport Layer Security

$sel:clusterName:Cluster', cluster_clusterName - The name of the DAX cluster.

$sel:description:Cluster', cluster_description - The description of the cluster.

$sel:iamRoleArn:Cluster', cluster_iamRoleArn - 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.

$sel:nodeIdsToRemove:Cluster', cluster_nodeIdsToRemove - A list of nodes to be removed from the cluster.

$sel:nodeType:Cluster', cluster_nodeType - The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)

$sel:nodes:Cluster', cluster_nodes - A list of nodes that are currently in the cluster.

$sel:notificationConfiguration:Cluster', cluster_notificationConfiguration - Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).

$sel:parameterGroup:Cluster', cluster_parameterGroup - The parameter group being used by nodes in the cluster.

$sel:preferredMaintenanceWindow:Cluster', cluster_preferredMaintenanceWindow - A range of time when maintenance of DAX cluster software will be performed. For example: sun:01:00-sun:09:00. Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.

$sel:sSEDescription:Cluster', cluster_sSEDescription - The description of the server-side encryption status on the specified DAX cluster.

$sel:securityGroups:Cluster', cluster_securityGroups - A list of security groups, and the status of each, for the nodes in the cluster.

Cluster, cluster_status - The current status of the cluster.

$sel:subnetGroup:Cluster', cluster_subnetGroup - The subnet group where the DAX cluster is running.

$sel:totalNodes:Cluster', cluster_totalNodes - The total number of nodes in the cluster.

cluster_activeNodes :: Lens' Cluster (Maybe Int) Source #

The number of nodes in the cluster that are active (i.e., capable of serving requests).

cluster_clusterArn :: Lens' Cluster (Maybe Text) Source #

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

cluster_clusterDiscoveryEndpoint :: Lens' Cluster (Maybe Endpoint) Source #

The endpoint for this DAX cluster, consisting of a DNS name, a port number, and a URL. Applications should use the URL to configure the DAX client to find their cluster.

cluster_clusterEndpointEncryptionType :: Lens' Cluster (Maybe ClusterEndpointEncryptionType) Source #

The type of encryption supported by the cluster's endpoint. Values are:

  • NONE for no encryption

    TLS for Transport Layer Security

cluster_clusterName :: Lens' Cluster (Maybe Text) Source #

The name of the DAX cluster.

cluster_description :: Lens' Cluster (Maybe Text) Source #

The description of the cluster.

cluster_iamRoleArn :: Lens' Cluster (Maybe Text) Source #

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.

cluster_nodeIdsToRemove :: Lens' Cluster (Maybe [Text]) Source #

A list of nodes to be removed from the cluster.

cluster_nodeType :: Lens' Cluster (Maybe Text) Source #

The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)

cluster_nodes :: Lens' Cluster (Maybe [Node]) Source #

A list of nodes that are currently in the cluster.

cluster_notificationConfiguration :: Lens' Cluster (Maybe NotificationConfiguration) Source #

Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).

cluster_parameterGroup :: Lens' Cluster (Maybe ParameterGroupStatus) Source #

The parameter group being used by nodes in the cluster.

cluster_preferredMaintenanceWindow :: Lens' Cluster (Maybe Text) Source #

A range of time when maintenance of DAX cluster software will be performed. For example: sun:01:00-sun:09:00. Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.

cluster_sSEDescription :: Lens' Cluster (Maybe SSEDescription) Source #

The description of the server-side encryption status on the specified DAX cluster.

cluster_securityGroups :: Lens' Cluster (Maybe [SecurityGroupMembership]) Source #

A list of security groups, and the status of each, for the nodes in the cluster.

cluster_status :: Lens' Cluster (Maybe Text) Source #

The current status of the cluster.

cluster_subnetGroup :: Lens' Cluster (Maybe Text) Source #

The subnet group where the DAX cluster is running.

cluster_totalNodes :: Lens' Cluster (Maybe Int) Source #

The total number of nodes in the cluster.