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 |
- Service Configuration
- Errors
- ChangeType
- ClusterEndpointEncryptionType
- IsModifiable
- ParameterType
- SSEStatus
- SourceType
- Cluster
- Endpoint
- Event
- Node
- NodeTypeSpecificValue
- NotificationConfiguration
- Parameter
- ParameterGroup
- ParameterGroupStatus
- ParameterNameValue
- SSEDescription
- SSESpecification
- SecurityGroupMembership
- Subnet
- SubnetGroup
- Tag
Synopsis
- defaultService :: Service
- _ClusterAlreadyExistsFault :: AsError a => Fold a ServiceError
- _ClusterNotFoundFault :: AsError a => Fold a ServiceError
- _ClusterQuotaForCustomerExceededFault :: AsError a => Fold a ServiceError
- _InsufficientClusterCapacityFault :: AsError a => Fold a ServiceError
- _InvalidARNFault :: AsError a => Fold a ServiceError
- _InvalidClusterStateFault :: AsError a => Fold a ServiceError
- _InvalidParameterCombinationException :: AsError a => Fold a ServiceError
- _InvalidParameterGroupStateFault :: AsError a => Fold a ServiceError
- _InvalidParameterValueException :: AsError a => Fold a ServiceError
- _InvalidSubnet :: AsError a => Fold a ServiceError
- _InvalidVPCNetworkStateFault :: AsError a => Fold a ServiceError
- _NodeNotFoundFault :: AsError a => Fold a ServiceError
- _NodeQuotaForClusterExceededFault :: AsError a => Fold a ServiceError
- _NodeQuotaForCustomerExceededFault :: AsError a => Fold a ServiceError
- _ParameterGroupAlreadyExistsFault :: AsError a => Fold a ServiceError
- _ParameterGroupNotFoundFault :: AsError a => Fold a ServiceError
- _ParameterGroupQuotaExceededFault :: AsError a => Fold a ServiceError
- _ServiceLinkedRoleNotFoundFault :: AsError a => Fold a ServiceError
- _ServiceQuotaExceededException :: AsError a => Fold a ServiceError
- _SubnetGroupAlreadyExistsFault :: AsError a => Fold a ServiceError
- _SubnetGroupInUseFault :: AsError a => Fold a ServiceError
- _SubnetGroupNotFoundFault :: AsError a => Fold a ServiceError
- _SubnetGroupQuotaExceededFault :: AsError a => Fold a ServiceError
- _SubnetInUse :: AsError a => Fold a ServiceError
- _SubnetQuotaExceededFault :: AsError a => Fold a ServiceError
- _TagNotFoundFault :: AsError a => Fold a ServiceError
- _TagQuotaPerResourceExceeded :: AsError a => Fold a ServiceError
- newtype ChangeType where
- ChangeType' { }
- pattern ChangeType_IMMEDIATE :: ChangeType
- pattern ChangeType_REQUIRES_REBOOT :: ChangeType
- newtype ClusterEndpointEncryptionType where
- newtype IsModifiable where
- IsModifiable' { }
- pattern IsModifiable_CONDITIONAL :: IsModifiable
- pattern IsModifiable_FALSE :: IsModifiable
- pattern IsModifiable_TRUE :: IsModifiable
- newtype ParameterType where
- ParameterType' { }
- pattern ParameterType_DEFAULT :: ParameterType
- pattern ParameterType_NODE_TYPE_SPECIFIC :: ParameterType
- newtype SSEStatus where
- SSEStatus' { }
- pattern SSEStatus_DISABLED :: SSEStatus
- pattern SSEStatus_DISABLING :: SSEStatus
- pattern SSEStatus_ENABLED :: SSEStatus
- pattern SSEStatus_ENABLING :: SSEStatus
- newtype SourceType where
- SourceType' { }
- pattern SourceType_CLUSTER :: SourceType
- pattern SourceType_PARAMETER_GROUP :: SourceType
- pattern SourceType_SUBNET_GROUP :: SourceType
- data Cluster = Cluster' {
- activeNodes :: Maybe Int
- clusterArn :: Maybe Text
- clusterDiscoveryEndpoint :: Maybe Endpoint
- clusterEndpointEncryptionType :: Maybe ClusterEndpointEncryptionType
- clusterName :: Maybe Text
- description :: Maybe Text
- iamRoleArn :: Maybe Text
- nodeIdsToRemove :: Maybe [Text]
- nodeType :: Maybe Text
- nodes :: Maybe [Node]
- notificationConfiguration :: Maybe NotificationConfiguration
- parameterGroup :: Maybe ParameterGroupStatus
- preferredMaintenanceWindow :: Maybe Text
- sSEDescription :: Maybe SSEDescription
- securityGroups :: Maybe [SecurityGroupMembership]
- status :: Maybe Text
- subnetGroup :: Maybe Text
- totalNodes :: Maybe Int
- newCluster :: Cluster
- cluster_activeNodes :: Lens' Cluster (Maybe Int)
- cluster_clusterArn :: Lens' Cluster (Maybe Text)
- cluster_clusterDiscoveryEndpoint :: Lens' Cluster (Maybe Endpoint)
- cluster_clusterEndpointEncryptionType :: Lens' Cluster (Maybe ClusterEndpointEncryptionType)
- cluster_clusterName :: Lens' Cluster (Maybe Text)
- cluster_description :: Lens' Cluster (Maybe Text)
- cluster_iamRoleArn :: Lens' Cluster (Maybe Text)
- cluster_nodeIdsToRemove :: Lens' Cluster (Maybe [Text])
- cluster_nodeType :: Lens' Cluster (Maybe Text)
- cluster_nodes :: Lens' Cluster (Maybe [Node])
- cluster_notificationConfiguration :: Lens' Cluster (Maybe NotificationConfiguration)
- cluster_parameterGroup :: Lens' Cluster (Maybe ParameterGroupStatus)
- cluster_preferredMaintenanceWindow :: Lens' Cluster (Maybe Text)
- cluster_sSEDescription :: Lens' Cluster (Maybe SSEDescription)
- cluster_securityGroups :: Lens' Cluster (Maybe [SecurityGroupMembership])
- cluster_status :: Lens' Cluster (Maybe Text)
- cluster_subnetGroup :: Lens' Cluster (Maybe Text)
- cluster_totalNodes :: Lens' Cluster (Maybe Int)
- data Endpoint = Endpoint' {}
- newEndpoint :: Endpoint
- endpoint_address :: Lens' Endpoint (Maybe Text)
- endpoint_port :: Lens' Endpoint (Maybe Int)
- endpoint_url :: Lens' Endpoint (Maybe Text)
- data Event = Event' {
- date :: Maybe POSIX
- message :: Maybe Text
- sourceName :: Maybe Text
- sourceType :: Maybe SourceType
- newEvent :: Event
- event_date :: Lens' Event (Maybe UTCTime)
- event_message :: Lens' Event (Maybe Text)
- event_sourceName :: Lens' Event (Maybe Text)
- event_sourceType :: Lens' Event (Maybe SourceType)
- data Node = Node' {}
- newNode :: Node
- node_availabilityZone :: Lens' Node (Maybe Text)
- node_endpoint :: Lens' Node (Maybe Endpoint)
- node_nodeCreateTime :: Lens' Node (Maybe UTCTime)
- node_nodeId :: Lens' Node (Maybe Text)
- node_nodeStatus :: Lens' Node (Maybe Text)
- node_parameterGroupStatus :: Lens' Node (Maybe Text)
- data NodeTypeSpecificValue = NodeTypeSpecificValue' {}
- newNodeTypeSpecificValue :: NodeTypeSpecificValue
- nodeTypeSpecificValue_nodeType :: Lens' NodeTypeSpecificValue (Maybe Text)
- nodeTypeSpecificValue_value :: Lens' NodeTypeSpecificValue (Maybe Text)
- data NotificationConfiguration = NotificationConfiguration' {}
- newNotificationConfiguration :: NotificationConfiguration
- notificationConfiguration_topicArn :: Lens' NotificationConfiguration (Maybe Text)
- notificationConfiguration_topicStatus :: Lens' NotificationConfiguration (Maybe Text)
- data Parameter = Parameter' {
- allowedValues :: Maybe Text
- changeType :: Maybe ChangeType
- dataType :: Maybe Text
- description :: Maybe Text
- isModifiable :: Maybe IsModifiable
- nodeTypeSpecificValues :: Maybe [NodeTypeSpecificValue]
- parameterName :: Maybe Text
- parameterType :: Maybe ParameterType
- parameterValue :: Maybe Text
- source :: Maybe Text
- newParameter :: Parameter
- parameter_allowedValues :: Lens' Parameter (Maybe Text)
- parameter_changeType :: Lens' Parameter (Maybe ChangeType)
- parameter_dataType :: Lens' Parameter (Maybe Text)
- parameter_description :: Lens' Parameter (Maybe Text)
- parameter_isModifiable :: Lens' Parameter (Maybe IsModifiable)
- parameter_nodeTypeSpecificValues :: Lens' Parameter (Maybe [NodeTypeSpecificValue])
- parameter_parameterName :: Lens' Parameter (Maybe Text)
- parameter_parameterType :: Lens' Parameter (Maybe ParameterType)
- parameter_parameterValue :: Lens' Parameter (Maybe Text)
- parameter_source :: Lens' Parameter (Maybe Text)
- data ParameterGroup = ParameterGroup' {}
- newParameterGroup :: ParameterGroup
- parameterGroup_description :: Lens' ParameterGroup (Maybe Text)
- parameterGroup_parameterGroupName :: Lens' ParameterGroup (Maybe Text)
- data ParameterGroupStatus = ParameterGroupStatus' {}
- newParameterGroupStatus :: ParameterGroupStatus
- parameterGroupStatus_nodeIdsToReboot :: Lens' ParameterGroupStatus (Maybe [Text])
- parameterGroupStatus_parameterApplyStatus :: Lens' ParameterGroupStatus (Maybe Text)
- parameterGroupStatus_parameterGroupName :: Lens' ParameterGroupStatus (Maybe Text)
- data ParameterNameValue = ParameterNameValue' {}
- newParameterNameValue :: ParameterNameValue
- parameterNameValue_parameterName :: Lens' ParameterNameValue (Maybe Text)
- parameterNameValue_parameterValue :: Lens' ParameterNameValue (Maybe Text)
- data SSEDescription = SSEDescription' {}
- newSSEDescription :: SSEDescription
- sSEDescription_status :: Lens' SSEDescription (Maybe SSEStatus)
- data SSESpecification = SSESpecification' {}
- newSSESpecification :: Bool -> SSESpecification
- sSESpecification_enabled :: Lens' SSESpecification Bool
- data SecurityGroupMembership = SecurityGroupMembership' {}
- newSecurityGroupMembership :: SecurityGroupMembership
- securityGroupMembership_securityGroupIdentifier :: Lens' SecurityGroupMembership (Maybe Text)
- securityGroupMembership_status :: Lens' SecurityGroupMembership (Maybe Text)
- data Subnet = Subnet' {}
- newSubnet :: Subnet
- subnet_subnetAvailabilityZone :: Lens' Subnet (Maybe Text)
- subnet_subnetIdentifier :: Lens' Subnet (Maybe Text)
- data SubnetGroup = SubnetGroup' {}
- newSubnetGroup :: SubnetGroup
- subnetGroup_description :: Lens' SubnetGroup (Maybe Text)
- subnetGroup_subnetGroupName :: Lens' SubnetGroup (Maybe Text)
- subnetGroup_subnets :: Lens' SubnetGroup (Maybe [Subnet])
- subnetGroup_vpcId :: Lens' SubnetGroup (Maybe Text)
- data Tag = Tag' {}
- newTag :: Tag
- tag_key :: Lens' Tag (Maybe Text)
- tag_value :: Lens' Tag (Maybe Text)
Service Configuration
defaultService :: Service Source #
API version 2017-04-19
of the Amazon DynamoDB Accelerator (DAX) SDK configuration.
Errors
_ClusterAlreadyExistsFault :: AsError a => Fold a ServiceError Source #
You already have a DAX cluster with the given identifier.
_ClusterNotFoundFault :: AsError a => Fold a ServiceError Source #
The requested cluster ID does not refer to an existing DAX cluster.
_ClusterQuotaForCustomerExceededFault :: AsError a => Fold a ServiceError Source #
You have attempted to exceed the maximum number of DAX clusters for your AWS account.
_InsufficientClusterCapacityFault :: AsError a => Fold a ServiceError Source #
There are not enough system resources to create the cluster you requested (or to resize an already-existing cluster).
_InvalidARNFault :: AsError a => Fold a ServiceError Source #
The Amazon Resource Name (ARN) supplied in the request is not valid.
_InvalidClusterStateFault :: AsError a => Fold a ServiceError Source #
The requested DAX cluster is not in the available state.
_InvalidParameterCombinationException :: AsError a => Fold a ServiceError Source #
Two or more incompatible parameters were specified.
_InvalidParameterGroupStateFault :: AsError a => Fold a ServiceError Source #
One or more parameters in a parameter group are in an invalid state.
_InvalidParameterValueException :: AsError a => Fold a ServiceError Source #
The value for a parameter is invalid.
_InvalidSubnet :: AsError a => Fold a ServiceError Source #
An invalid subnet identifier was specified.
_InvalidVPCNetworkStateFault :: AsError a => Fold a ServiceError Source #
The VPC network is in an invalid state.
_NodeNotFoundFault :: AsError a => Fold a ServiceError Source #
None of the nodes in the cluster have the given node ID.
_NodeQuotaForClusterExceededFault :: AsError a => Fold a ServiceError Source #
You have attempted to exceed the maximum number of nodes for a DAX cluster.
_NodeQuotaForCustomerExceededFault :: AsError a => Fold a ServiceError Source #
You have attempted to exceed the maximum number of nodes for your AWS account.
_ParameterGroupAlreadyExistsFault :: AsError a => Fold a ServiceError Source #
The specified parameter group already exists.
_ParameterGroupNotFoundFault :: AsError a => Fold a ServiceError Source #
The specified parameter group does not exist.
_ParameterGroupQuotaExceededFault :: AsError a => Fold a ServiceError Source #
You have attempted to exceed the maximum number of parameter groups.
_ServiceLinkedRoleNotFoundFault :: AsError a => Fold a ServiceError Source #
The specified service linked role (SLR) was not found.
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
You have reached the maximum number of x509 certificates that can be created for encrypted clusters in a 30 day period. Contact AWS customer support to discuss options for continuing to create encrypted clusters.
_SubnetGroupAlreadyExistsFault :: AsError a => Fold a ServiceError Source #
The specified subnet group already exists.
_SubnetGroupInUseFault :: AsError a => Fold a ServiceError Source #
The specified subnet group is currently in use.
_SubnetGroupNotFoundFault :: AsError a => Fold a ServiceError Source #
The requested subnet group name does not refer to an existing subnet group.
_SubnetGroupQuotaExceededFault :: AsError a => Fold a ServiceError Source #
The request cannot be processed because it would exceed the allowed number of subnets in a subnet group.
_SubnetInUse :: AsError a => Fold a ServiceError Source #
The requested subnet is being used by another subnet group.
_SubnetQuotaExceededFault :: AsError a => Fold a ServiceError Source #
The request cannot be processed because it would exceed the allowed number of subnets in a subnet group.
_TagNotFoundFault :: AsError a => Fold a ServiceError Source #
The tag does not exist.
_TagQuotaPerResourceExceeded :: AsError a => Fold a ServiceError Source #
You have exceeded the maximum number of tags for this DAX cluster.
ChangeType
newtype ChangeType Source #
pattern ChangeType_IMMEDIATE :: ChangeType | |
pattern ChangeType_REQUIRES_REBOOT :: ChangeType |
Instances
ClusterEndpointEncryptionType
newtype ClusterEndpointEncryptionType Source #
pattern ClusterEndpointEncryptionType_NONE :: ClusterEndpointEncryptionType | |
pattern ClusterEndpointEncryptionType_TLS :: ClusterEndpointEncryptionType |
Instances
IsModifiable
newtype IsModifiable Source #
pattern IsModifiable_CONDITIONAL :: IsModifiable | |
pattern IsModifiable_FALSE :: IsModifiable | |
pattern IsModifiable_TRUE :: IsModifiable |
Instances
ParameterType
newtype ParameterType Source #
pattern ParameterType_DEFAULT :: ParameterType | |
pattern ParameterType_NODE_TYPE_SPECIFIC :: ParameterType |
Instances
SSEStatus
pattern SSEStatus_DISABLED :: SSEStatus | |
pattern SSEStatus_DISABLING :: SSEStatus | |
pattern SSEStatus_ENABLED :: SSEStatus | |
pattern SSEStatus_ENABLING :: SSEStatus |
Instances
SourceType
newtype SourceType Source #
pattern SourceType_CLUSTER :: SourceType | |
pattern SourceType_PARAMETER_GROUP :: SourceType | |
pattern SourceType_SUBNET_GROUP :: SourceType |
Instances
Cluster
Contains all of the attributes of a specific DAX cluster.
See: newCluster
smart constructor.
Cluster' | |
|
Instances
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 encryptionTLS
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 encryptionTLS
for Transport Layer Security
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_subnetGroup :: Lens' Cluster (Maybe Text) Source #
The subnet group where the DAX cluster is running.
Endpoint
Represents the information required for client programs to connect to the endpoint for a DAX cluster.
See: newEndpoint
smart constructor.
Endpoint' | |
|
Instances
FromJSON Endpoint Source # | |
Generic Endpoint Source # | |
Read Endpoint Source # | |
Show Endpoint Source # | |
NFData Endpoint Source # | |
Defined in Amazonka.DAX.Types.Endpoint | |
Eq Endpoint Source # | |
Hashable Endpoint Source # | |
Defined in Amazonka.DAX.Types.Endpoint | |
type Rep Endpoint Source # | |
Defined in Amazonka.DAX.Types.Endpoint type Rep Endpoint = D1 ('MetaData "Endpoint" "Amazonka.DAX.Types.Endpoint" "amazonka-dynamodb-dax-2.0-FwsdPL1z9NS2dTys8oHQ2n" 'False) (C1 ('MetaCons "Endpoint'" 'PrefixI 'True) (S1 ('MetaSel ('Just "address") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) |
newEndpoint :: Endpoint Source #
Create a value of Endpoint
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:address:Endpoint'
, endpoint_address
- The DNS hostname of the endpoint.
$sel:port:Endpoint'
, endpoint_port
- The port number that applications should use to connect to the endpoint.
$sel:url:Endpoint'
, endpoint_url
- The URL that applications should use to connect to the endpoint. The
default ports are 8111 for the "dax" protocol and 9111 for the
"daxs" protocol.
endpoint_port :: Lens' Endpoint (Maybe Int) Source #
The port number that applications should use to connect to the endpoint.
endpoint_url :: Lens' Endpoint (Maybe Text) Source #
The URL that applications should use to connect to the endpoint. The default ports are 8111 for the "dax" protocol and 9111 for the "daxs" protocol.
Event
Represents a single occurrence of something interesting within the system. Some examples of events are creating a DAX cluster, adding or removing a node, or rebooting a node.
See: newEvent
smart constructor.
Event' | |
|
Instances
FromJSON Event Source # | |
Generic Event Source # | |
Read Event Source # | |
Show Event Source # | |
NFData Event Source # | |
Defined in Amazonka.DAX.Types.Event | |
Eq Event Source # | |
Hashable Event Source # | |
Defined in Amazonka.DAX.Types.Event | |
type Rep Event Source # | |
Defined in Amazonka.DAX.Types.Event type Rep Event = D1 ('MetaData "Event" "Amazonka.DAX.Types.Event" "amazonka-dynamodb-dax-2.0-FwsdPL1z9NS2dTys8oHQ2n" 'False) (C1 ('MetaCons "Event'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "date") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "sourceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SourceType))))) |
Create a value of Event
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:date:Event'
, event_date
- The date and time when the event occurred.
$sel:message:Event'
, event_message
- A user-defined message associated with the event.
$sel:sourceName:Event'
, event_sourceName
- The source of the event. For example, if the event occurred at the node
level, the source would be the node ID.
$sel:sourceType:Event'
, event_sourceType
- Specifies the origin of this event - a cluster, a parameter group, a
node ID, etc.
event_sourceName :: Lens' Event (Maybe Text) Source #
The source of the event. For example, if the event occurred at the node level, the source would be the node ID.
event_sourceType :: Lens' Event (Maybe SourceType) Source #
Specifies the origin of this event - a cluster, a parameter group, a node ID, etc.
Node
Represents an individual node within a DAX cluster.
See: newNode
smart constructor.
Node' | |
|
Instances
Create a value of Node
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:availabilityZone:Node'
, node_availabilityZone
- The Availability Zone (AZ) in which the node has been deployed.
$sel:endpoint:Node'
, node_endpoint
- The endpoint for the node, consisting of a DNS name and a port number.
Client applications can connect directly to a node endpoint, if desired
(as an alternative to allowing DAX client software to intelligently
route requests and responses to nodes in the DAX cluster.
$sel:nodeCreateTime:Node'
, node_nodeCreateTime
- The date and time (in UNIX epoch format) when the node was launched.
$sel:nodeId:Node'
, node_nodeId
- A system-generated identifier for the node.
$sel:nodeStatus:Node'
, node_nodeStatus
- The current status of the node. For example: available
.
$sel:parameterGroupStatus:Node'
, node_parameterGroupStatus
- The status of the parameter group associated with this node. For
example, in-sync
.
node_availabilityZone :: Lens' Node (Maybe Text) Source #
The Availability Zone (AZ) in which the node has been deployed.
node_endpoint :: Lens' Node (Maybe Endpoint) Source #
The endpoint for the node, consisting of a DNS name and a port number. Client applications can connect directly to a node endpoint, if desired (as an alternative to allowing DAX client software to intelligently route requests and responses to nodes in the DAX cluster.
node_nodeCreateTime :: Lens' Node (Maybe UTCTime) Source #
The date and time (in UNIX epoch format) when the node was launched.
node_nodeStatus :: Lens' Node (Maybe Text) Source #
The current status of the node. For example: available
.
node_parameterGroupStatus :: Lens' Node (Maybe Text) Source #
The status of the parameter group associated with this node. For
example, in-sync
.
NodeTypeSpecificValue
data NodeTypeSpecificValue Source #
Represents a parameter value that is applicable to a particular node type.
See: newNodeTypeSpecificValue
smart constructor.
Instances
newNodeTypeSpecificValue :: NodeTypeSpecificValue Source #
Create a value of NodeTypeSpecificValue
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:nodeType:NodeTypeSpecificValue'
, nodeTypeSpecificValue_nodeType
- A node type to which the parameter value applies.
$sel:value:NodeTypeSpecificValue'
, nodeTypeSpecificValue_value
- The parameter value for this node type.
nodeTypeSpecificValue_nodeType :: Lens' NodeTypeSpecificValue (Maybe Text) Source #
A node type to which the parameter value applies.
nodeTypeSpecificValue_value :: Lens' NodeTypeSpecificValue (Maybe Text) Source #
The parameter value for this node type.
NotificationConfiguration
data 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).
See: newNotificationConfiguration
smart constructor.
Instances
newNotificationConfiguration :: NotificationConfiguration Source #
Create a value of NotificationConfiguration
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:topicArn:NotificationConfiguration'
, notificationConfiguration_topicArn
- The Amazon Resource Name (ARN) that identifies the topic.
$sel:topicStatus:NotificationConfiguration'
, notificationConfiguration_topicStatus
- The current state of the topic. A value of “active” means that
notifications will be sent to the topic. A value of “inactive” means
that notifications will not be sent to the topic.
notificationConfiguration_topicArn :: Lens' NotificationConfiguration (Maybe Text) Source #
The Amazon Resource Name (ARN) that identifies the topic.
notificationConfiguration_topicStatus :: Lens' NotificationConfiguration (Maybe Text) Source #
The current state of the topic. A value of “active” means that notifications will be sent to the topic. A value of “inactive” means that notifications will not be sent to the topic.
Parameter
Describes an individual setting that controls some aspect of DAX behavior.
See: newParameter
smart constructor.
Parameter' | |
|
Instances
newParameter :: Parameter Source #
Create a value of Parameter
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:allowedValues:Parameter'
, parameter_allowedValues
- A range of values within which the parameter can be set.
$sel:changeType:Parameter'
, parameter_changeType
- The conditions under which changes to this parameter can be applied. For
example, requires-reboot
indicates that a new value for this parameter
will only take effect if a node is rebooted.
$sel:dataType:Parameter'
, parameter_dataType
- The data type of the parameter. For example, integer
:
$sel:description:Parameter'
, parameter_description
- A description of the parameter
$sel:isModifiable:Parameter'
, parameter_isModifiable
- Whether the customer is allowed to modify the parameter.
$sel:nodeTypeSpecificValues:Parameter'
, parameter_nodeTypeSpecificValues
- A list of node types, and specific parameter values for each node.
$sel:parameterName:Parameter'
, parameter_parameterName
- The name of the parameter.
$sel:parameterType:Parameter'
, parameter_parameterType
- Determines whether the parameter can be applied to any nodes, or only
nodes of a particular type.
$sel:parameterValue:Parameter'
, parameter_parameterValue
- The value for the parameter.
$sel:source:Parameter'
, parameter_source
- How the parameter is defined. For example, system
denotes a
system-defined parameter.
parameter_allowedValues :: Lens' Parameter (Maybe Text) Source #
A range of values within which the parameter can be set.
parameter_changeType :: Lens' Parameter (Maybe ChangeType) Source #
The conditions under which changes to this parameter can be applied. For
example, requires-reboot
indicates that a new value for this parameter
will only take effect if a node is rebooted.
parameter_dataType :: Lens' Parameter (Maybe Text) Source #
The data type of the parameter. For example, integer
:
parameter_isModifiable :: Lens' Parameter (Maybe IsModifiable) Source #
Whether the customer is allowed to modify the parameter.
parameter_nodeTypeSpecificValues :: Lens' Parameter (Maybe [NodeTypeSpecificValue]) Source #
A list of node types, and specific parameter values for each node.
parameter_parameterType :: Lens' Parameter (Maybe ParameterType) Source #
Determines whether the parameter can be applied to any nodes, or only nodes of a particular type.
parameter_source :: Lens' Parameter (Maybe Text) Source #
How the parameter is defined. For example, system
denotes a
system-defined parameter.
ParameterGroup
data ParameterGroup Source #
A named set of parameters that are applied to all of the nodes in a DAX cluster.
See: newParameterGroup
smart constructor.
ParameterGroup' | |
|
Instances
newParameterGroup :: ParameterGroup Source #
Create a value of ParameterGroup
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:description:ParameterGroup'
, parameterGroup_description
- A description of the parameter group.
$sel:parameterGroupName:ParameterGroup'
, parameterGroup_parameterGroupName
- The name of the parameter group.
parameterGroup_description :: Lens' ParameterGroup (Maybe Text) Source #
A description of the parameter group.
parameterGroup_parameterGroupName :: Lens' ParameterGroup (Maybe Text) Source #
The name of the parameter group.
ParameterGroupStatus
data ParameterGroupStatus Source #
The status of a parameter group.
See: newParameterGroupStatus
smart constructor.
ParameterGroupStatus' | |
|
Instances
newParameterGroupStatus :: ParameterGroupStatus Source #
Create a value of ParameterGroupStatus
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:nodeIdsToReboot:ParameterGroupStatus'
, parameterGroupStatus_nodeIdsToReboot
- The node IDs of one or more nodes to be rebooted.
$sel:parameterApplyStatus:ParameterGroupStatus'
, parameterGroupStatus_parameterApplyStatus
- The status of parameter updates.
$sel:parameterGroupName:ParameterGroupStatus'
, parameterGroupStatus_parameterGroupName
- The name of the parameter group.
parameterGroupStatus_nodeIdsToReboot :: Lens' ParameterGroupStatus (Maybe [Text]) Source #
The node IDs of one or more nodes to be rebooted.
parameterGroupStatus_parameterApplyStatus :: Lens' ParameterGroupStatus (Maybe Text) Source #
The status of parameter updates.
parameterGroupStatus_parameterGroupName :: Lens' ParameterGroupStatus (Maybe Text) Source #
The name of the parameter group.
ParameterNameValue
data ParameterNameValue Source #
An individual DAX parameter.
See: newParameterNameValue
smart constructor.
ParameterNameValue' | |
|
Instances
newParameterNameValue :: ParameterNameValue Source #
Create a value of ParameterNameValue
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:parameterName:ParameterNameValue'
, parameterNameValue_parameterName
- The name of the parameter.
$sel:parameterValue:ParameterNameValue'
, parameterNameValue_parameterValue
- The value of the parameter.
parameterNameValue_parameterName :: Lens' ParameterNameValue (Maybe Text) Source #
The name of the parameter.
parameterNameValue_parameterValue :: Lens' ParameterNameValue (Maybe Text) Source #
The value of the parameter.
SSEDescription
data SSEDescription Source #
The description of the server-side encryption status on the specified DAX cluster.
See: newSSEDescription
smart constructor.
Instances
newSSEDescription :: SSEDescription Source #
Create a value of SSEDescription
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:status:SSEDescription'
, sSEDescription_status
- The current state of server-side encryption:
ENABLING
- Server-side encryption is being enabled.ENABLED
- Server-side encryption is enabled.DISABLING
- Server-side encryption is being disabled.DISABLED
- Server-side encryption is disabled.
sSEDescription_status :: Lens' SSEDescription (Maybe SSEStatus) Source #
The current state of server-side encryption:
ENABLING
- Server-side encryption is being enabled.ENABLED
- Server-side encryption is enabled.DISABLING
- Server-side encryption is being disabled.DISABLED
- Server-side encryption is disabled.
SSESpecification
data SSESpecification Source #
Represents the settings used to enable server-side encryption.
See: newSSESpecification
smart constructor.
Instances
Create a value of SSESpecification
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:enabled:SSESpecification'
, sSESpecification_enabled
- Indicates whether server-side encryption is enabled (true) or disabled
(false) on the cluster.
sSESpecification_enabled :: Lens' SSESpecification Bool Source #
Indicates whether server-side encryption is enabled (true) or disabled (false) on the cluster.
SecurityGroupMembership
data SecurityGroupMembership Source #
An individual VPC security group and its status.
See: newSecurityGroupMembership
smart constructor.
Instances
newSecurityGroupMembership :: SecurityGroupMembership Source #
Create a value of SecurityGroupMembership
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:securityGroupIdentifier:SecurityGroupMembership'
, securityGroupMembership_securityGroupIdentifier
- The unique ID for this security group.
$sel:status:SecurityGroupMembership'
, securityGroupMembership_status
- The status of this security group.
securityGroupMembership_securityGroupIdentifier :: Lens' SecurityGroupMembership (Maybe Text) Source #
The unique ID for this security group.
securityGroupMembership_status :: Lens' SecurityGroupMembership (Maybe Text) Source #
The status of this security group.
Subnet
Represents the subnet associated with a DAX cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with DAX.
See: newSubnet
smart constructor.
Subnet' | |
|
Instances
FromJSON Subnet Source # | |
Generic Subnet Source # | |
Read Subnet Source # | |
Show Subnet Source # | |
NFData Subnet Source # | |
Defined in Amazonka.DAX.Types.Subnet | |
Eq Subnet Source # | |
Hashable Subnet Source # | |
Defined in Amazonka.DAX.Types.Subnet | |
type Rep Subnet Source # | |
Defined in Amazonka.DAX.Types.Subnet type Rep Subnet = D1 ('MetaData "Subnet" "Amazonka.DAX.Types.Subnet" "amazonka-dynamodb-dax-2.0-FwsdPL1z9NS2dTys8oHQ2n" 'False) (C1 ('MetaCons "Subnet'" 'PrefixI 'True) (S1 ('MetaSel ('Just "subnetAvailabilityZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "subnetIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) |
Create a value of Subnet
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:subnetAvailabilityZone:Subnet'
, subnet_subnetAvailabilityZone
- The Availability Zone (AZ) for the subnet.
$sel:subnetIdentifier:Subnet'
, subnet_subnetIdentifier
- The system-assigned identifier for the subnet.
subnet_subnetAvailabilityZone :: Lens' Subnet (Maybe Text) Source #
The Availability Zone (AZ) for the subnet.
subnet_subnetIdentifier :: Lens' Subnet (Maybe Text) Source #
The system-assigned identifier for the subnet.
SubnetGroup
data SubnetGroup Source #
Represents the output of one of the following actions:
- CreateSubnetGroup
- ModifySubnetGroup
See: newSubnetGroup
smart constructor.
Instances
newSubnetGroup :: SubnetGroup Source #
Create a value of SubnetGroup
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:description:SubnetGroup'
, subnetGroup_description
- The description of the subnet group.
$sel:subnetGroupName:SubnetGroup'
, subnetGroup_subnetGroupName
- The name of the subnet group.
$sel:subnets:SubnetGroup'
, subnetGroup_subnets
- A list of subnets associated with the subnet group.
$sel:vpcId:SubnetGroup'
, subnetGroup_vpcId
- The Amazon Virtual Private Cloud identifier (VPC ID) of the subnet
group.
subnetGroup_description :: Lens' SubnetGroup (Maybe Text) Source #
The description of the subnet group.
subnetGroup_subnetGroupName :: Lens' SubnetGroup (Maybe Text) Source #
The name of the subnet group.
subnetGroup_subnets :: Lens' SubnetGroup (Maybe [Subnet]) Source #
A list of subnets associated with the subnet group.
subnetGroup_vpcId :: Lens' SubnetGroup (Maybe Text) Source #
The Amazon Virtual Private Cloud identifier (VPC ID) of the subnet group.
Tag
A description of a tag. Every tag is a key-value pair. You can add up to 50 tags to a single DAX cluster.
AWS-assigned tag names and values are automatically assigned the aws:
prefix, which the user cannot assign. AWS-assigned tag names do not
count towards the tag limit of 50. User-assigned tag names have the
prefix user:
.
You cannot backdate the application of a tag.
See: newTag
smart constructor.
Tag' | |
|
Instances
FromJSON Tag Source # | |
ToJSON Tag Source # | |
Defined in Amazonka.DAX.Types.Tag | |
Generic Tag Source # | |
Read Tag Source # | |
Show Tag Source # | |
NFData Tag Source # | |
Defined in Amazonka.DAX.Types.Tag | |
Eq Tag Source # | |
Hashable Tag Source # | |
Defined in Amazonka.DAX.Types.Tag | |
type Rep Tag Source # | |
Defined in Amazonka.DAX.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.DAX.Types.Tag" "amazonka-dynamodb-dax-2.0-FwsdPL1z9NS2dTys8oHQ2n" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) |
Create a value of Tag
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:key:Tag'
, tag_key
- The key for the tag. Tag keys are case sensitive. Every DAX cluster can
only have one tag with the same key. If you try to add an existing tag
(same key), the existing tag value will be updated to the new value.
$sel:value:Tag'
, tag_value
- The value of the tag. Tag values are case-sensitive and can be null.