| 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 |
Amazonka.DAX
Contents
- Service Configuration
- Errors
- ClusterAlreadyExistsFault
- ClusterNotFoundFault
- ClusterQuotaForCustomerExceededFault
- InsufficientClusterCapacityFault
- InvalidARNFault
- InvalidClusterStateFault
- InvalidParameterCombinationException
- InvalidParameterGroupStateFault
- InvalidParameterValueException
- InvalidSubnet
- InvalidVPCNetworkStateFault
- NodeNotFoundFault
- NodeQuotaForClusterExceededFault
- NodeQuotaForCustomerExceededFault
- ParameterGroupAlreadyExistsFault
- ParameterGroupNotFoundFault
- ParameterGroupQuotaExceededFault
- ServiceLinkedRoleNotFoundFault
- ServiceQuotaExceededException
- SubnetGroupAlreadyExistsFault
- SubnetGroupInUseFault
- SubnetGroupNotFoundFault
- SubnetGroupQuotaExceededFault
- SubnetInUse
- SubnetQuotaExceededFault
- TagNotFoundFault
- TagQuotaPerResourceExceeded
- Waiters
- Operations
- CreateCluster
- CreateParameterGroup
- CreateSubnetGroup
- DecreaseReplicationFactor
- DeleteCluster
- DeleteParameterGroup
- DeleteSubnetGroup
- DescribeClusters (Paginated)
- DescribeDefaultParameters (Paginated)
- DescribeEvents (Paginated)
- DescribeParameterGroups (Paginated)
- DescribeParameters (Paginated)
- DescribeSubnetGroups (Paginated)
- IncreaseReplicationFactor
- ListTags (Paginated)
- RebootNode
- TagResource
- UntagResource
- UpdateCluster
- UpdateParameterGroup
- UpdateSubnetGroup
- Types
Description
Derived from API version 2017-04-19 of the AWS service descriptions, licensed under Apache 2.0.
DAX is a managed caching service engineered for Amazon DynamoDB. DAX dramatically speeds up database reads by caching frequently-accessed data from DynamoDB, so applications can access that data with sub-millisecond latency. You can create a DAX cluster easily, using the AWS Management Console. With a few simple modifications to your code, your application can begin taking advantage of the DAX cluster and realize significant improvements in read performance.
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
- data CreateCluster = CreateCluster' (Maybe [Text]) (Maybe ClusterEndpointEncryptionType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe SSESpecification) (Maybe [Text]) (Maybe Text) (Maybe [Tag]) Text Text Int Text
- newCreateCluster :: Text -> Text -> Int -> Text -> CreateCluster
- data CreateClusterResponse = CreateClusterResponse' (Maybe Cluster) Int
- newCreateClusterResponse :: Int -> CreateClusterResponse
- data CreateParameterGroup = CreateParameterGroup' (Maybe Text) Text
- newCreateParameterGroup :: Text -> CreateParameterGroup
- data CreateParameterGroupResponse = CreateParameterGroupResponse' (Maybe ParameterGroup) Int
- newCreateParameterGroupResponse :: Int -> CreateParameterGroupResponse
- data CreateSubnetGroup = CreateSubnetGroup' (Maybe Text) Text [Text]
- newCreateSubnetGroup :: Text -> CreateSubnetGroup
- data CreateSubnetGroupResponse = CreateSubnetGroupResponse' (Maybe SubnetGroup) Int
- newCreateSubnetGroupResponse :: Int -> CreateSubnetGroupResponse
- data DecreaseReplicationFactor = DecreaseReplicationFactor' (Maybe [Text]) (Maybe [Text]) Text Int
- newDecreaseReplicationFactor :: Text -> Int -> DecreaseReplicationFactor
- data DecreaseReplicationFactorResponse = DecreaseReplicationFactorResponse' (Maybe Cluster) Int
- newDecreaseReplicationFactorResponse :: Int -> DecreaseReplicationFactorResponse
- data DeleteCluster = DeleteCluster' Text
- newDeleteCluster :: Text -> DeleteCluster
- data DeleteClusterResponse = DeleteClusterResponse' (Maybe Cluster) Int
- newDeleteClusterResponse :: Int -> DeleteClusterResponse
- data DeleteParameterGroup = DeleteParameterGroup' Text
- newDeleteParameterGroup :: Text -> DeleteParameterGroup
- data DeleteParameterGroupResponse = DeleteParameterGroupResponse' (Maybe Text) Int
- newDeleteParameterGroupResponse :: Int -> DeleteParameterGroupResponse
- data DeleteSubnetGroup = DeleteSubnetGroup' Text
- newDeleteSubnetGroup :: Text -> DeleteSubnetGroup
- data DeleteSubnetGroupResponse = DeleteSubnetGroupResponse' (Maybe Text) Int
- newDeleteSubnetGroupResponse :: Int -> DeleteSubnetGroupResponse
- data DescribeClusters = DescribeClusters' (Maybe [Text]) (Maybe Int) (Maybe Text)
- newDescribeClusters :: DescribeClusters
- data DescribeClustersResponse = DescribeClustersResponse' (Maybe [Cluster]) (Maybe Text) Int
- newDescribeClustersResponse :: Int -> DescribeClustersResponse
- data DescribeDefaultParameters = DescribeDefaultParameters' (Maybe Int) (Maybe Text)
- newDescribeDefaultParameters :: DescribeDefaultParameters
- data DescribeDefaultParametersResponse = DescribeDefaultParametersResponse' (Maybe Text) (Maybe [Parameter]) Int
- newDescribeDefaultParametersResponse :: Int -> DescribeDefaultParametersResponse
- data DescribeEvents = DescribeEvents' (Maybe Int) (Maybe POSIX) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe SourceType) (Maybe POSIX)
- newDescribeEvents :: DescribeEvents
- data DescribeEventsResponse = DescribeEventsResponse' (Maybe [Event]) (Maybe Text) Int
- newDescribeEventsResponse :: Int -> DescribeEventsResponse
- data DescribeParameterGroups = DescribeParameterGroups' (Maybe Int) (Maybe Text) (Maybe [Text])
- newDescribeParameterGroups :: DescribeParameterGroups
- data DescribeParameterGroupsResponse = DescribeParameterGroupsResponse' (Maybe Text) (Maybe [ParameterGroup]) Int
- newDescribeParameterGroupsResponse :: Int -> DescribeParameterGroupsResponse
- data DescribeParameters = DescribeParameters' (Maybe Int) (Maybe Text) (Maybe Text) Text
- newDescribeParameters :: Text -> DescribeParameters
- data DescribeParametersResponse = DescribeParametersResponse' (Maybe Text) (Maybe [Parameter]) Int
- newDescribeParametersResponse :: Int -> DescribeParametersResponse
- data DescribeSubnetGroups = DescribeSubnetGroups' (Maybe Int) (Maybe Text) (Maybe [Text])
- newDescribeSubnetGroups :: DescribeSubnetGroups
- data DescribeSubnetGroupsResponse = DescribeSubnetGroupsResponse' (Maybe Text) (Maybe [SubnetGroup]) Int
- newDescribeSubnetGroupsResponse :: Int -> DescribeSubnetGroupsResponse
- data IncreaseReplicationFactor = IncreaseReplicationFactor' (Maybe [Text]) Text Int
- newIncreaseReplicationFactor :: Text -> Int -> IncreaseReplicationFactor
- data IncreaseReplicationFactorResponse = IncreaseReplicationFactorResponse' (Maybe Cluster) Int
- newIncreaseReplicationFactorResponse :: Int -> IncreaseReplicationFactorResponse
- data ListTags = ListTags' (Maybe Text) Text
- newListTags :: Text -> ListTags
- data ListTagsResponse = ListTagsResponse' (Maybe Text) (Maybe [Tag]) Int
- newListTagsResponse :: Int -> ListTagsResponse
- data RebootNode = RebootNode' Text Text
- newRebootNode :: Text -> Text -> RebootNode
- data RebootNodeResponse = RebootNodeResponse' (Maybe Cluster) Int
- newRebootNodeResponse :: Int -> RebootNodeResponse
- data TagResource = TagResource' Text [Tag]
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' (Maybe [Tag]) Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' (Maybe [Tag]) Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateCluster = UpdateCluster' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) Text
- newUpdateCluster :: Text -> UpdateCluster
- data UpdateClusterResponse = UpdateClusterResponse' (Maybe Cluster) Int
- newUpdateClusterResponse :: Int -> UpdateClusterResponse
- data UpdateParameterGroup = UpdateParameterGroup' Text [ParameterNameValue]
- newUpdateParameterGroup :: Text -> UpdateParameterGroup
- data UpdateParameterGroupResponse = UpdateParameterGroupResponse' (Maybe ParameterGroup) Int
- newUpdateParameterGroupResponse :: Int -> UpdateParameterGroupResponse
- data UpdateSubnetGroup = UpdateSubnetGroup' (Maybe Text) (Maybe [Text]) Text
- newUpdateSubnetGroup :: Text -> UpdateSubnetGroup
- data UpdateSubnetGroupResponse = UpdateSubnetGroupResponse' (Maybe SubnetGroup) Int
- newUpdateSubnetGroupResponse :: Int -> UpdateSubnetGroupResponse
- 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' (Maybe Int) (Maybe Text) (Maybe Endpoint) (Maybe ClusterEndpointEncryptionType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe [Node]) (Maybe NotificationConfiguration) (Maybe ParameterGroupStatus) (Maybe Text) (Maybe SSEDescription) (Maybe [SecurityGroupMembership]) (Maybe Text) (Maybe Text) (Maybe Int)
- newCluster :: Cluster
- data Endpoint = Endpoint' (Maybe Text) (Maybe Int) (Maybe Text)
- newEndpoint :: Endpoint
- data Event = Event' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe SourceType)
- newEvent :: Event
- data Node = Node' (Maybe Text) (Maybe Endpoint) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text)
- newNode :: Node
- data NodeTypeSpecificValue = NodeTypeSpecificValue' (Maybe Text) (Maybe Text)
- newNodeTypeSpecificValue :: NodeTypeSpecificValue
- data NotificationConfiguration = NotificationConfiguration' (Maybe Text) (Maybe Text)
- newNotificationConfiguration :: NotificationConfiguration
- data Parameter = Parameter' (Maybe Text) (Maybe ChangeType) (Maybe Text) (Maybe Text) (Maybe IsModifiable) (Maybe [NodeTypeSpecificValue]) (Maybe Text) (Maybe ParameterType) (Maybe Text) (Maybe Text)
- newParameter :: Parameter
- data ParameterGroup = ParameterGroup' (Maybe Text) (Maybe Text)
- newParameterGroup :: ParameterGroup
- data ParameterGroupStatus = ParameterGroupStatus' (Maybe [Text]) (Maybe Text) (Maybe Text)
- newParameterGroupStatus :: ParameterGroupStatus
- data ParameterNameValue = ParameterNameValue' (Maybe Text) (Maybe Text)
- newParameterNameValue :: ParameterNameValue
- data SSEDescription = SSEDescription' (Maybe SSEStatus)
- newSSEDescription :: SSEDescription
- data SSESpecification = SSESpecification' Bool
- newSSESpecification :: Bool -> SSESpecification
- data SecurityGroupMembership = SecurityGroupMembership' (Maybe Text) (Maybe Text)
- newSecurityGroupMembership :: SecurityGroupMembership
- data Subnet = Subnet' (Maybe Text) (Maybe Text)
- newSubnet :: Subnet
- data SubnetGroup = SubnetGroup' (Maybe Text) (Maybe Text) (Maybe [Subnet]) (Maybe Text)
- newSubnetGroup :: SubnetGroup
- data Tag = Tag' (Maybe Text) (Maybe Text)
- newTag :: Tag
Service Configuration
defaultService :: Service Source #
API version 2017-04-19 of the Amazon DynamoDB Accelerator (DAX) SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by DAX.
ClusterAlreadyExistsFault
_ClusterAlreadyExistsFault :: AsError a => Fold a ServiceError Source #
You already have a DAX cluster with the given identifier.
ClusterNotFoundFault
_ClusterNotFoundFault :: AsError a => Fold a ServiceError Source #
The requested cluster ID does not refer to an existing DAX cluster.
ClusterQuotaForCustomerExceededFault
_ClusterQuotaForCustomerExceededFault :: AsError a => Fold a ServiceError Source #
You have attempted to exceed the maximum number of DAX clusters for your AWS account.
InsufficientClusterCapacityFault
_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
_InvalidARNFault :: AsError a => Fold a ServiceError Source #
The Amazon Resource Name (ARN) supplied in the request is not valid.
InvalidClusterStateFault
_InvalidClusterStateFault :: AsError a => Fold a ServiceError Source #
The requested DAX cluster is not in the available state.
InvalidParameterCombinationException
_InvalidParameterCombinationException :: AsError a => Fold a ServiceError Source #
Two or more incompatible parameters were specified.
InvalidParameterGroupStateFault
_InvalidParameterGroupStateFault :: AsError a => Fold a ServiceError Source #
One or more parameters in a parameter group are in an invalid state.
InvalidParameterValueException
_InvalidParameterValueException :: AsError a => Fold a ServiceError Source #
The value for a parameter is invalid.
InvalidSubnet
_InvalidSubnet :: AsError a => Fold a ServiceError Source #
An invalid subnet identifier was specified.
InvalidVPCNetworkStateFault
_InvalidVPCNetworkStateFault :: AsError a => Fold a ServiceError Source #
The VPC network is in an invalid state.
NodeNotFoundFault
_NodeNotFoundFault :: AsError a => Fold a ServiceError Source #
None of the nodes in the cluster have the given node ID.
NodeQuotaForClusterExceededFault
_NodeQuotaForClusterExceededFault :: AsError a => Fold a ServiceError Source #
You have attempted to exceed the maximum number of nodes for a DAX cluster.
NodeQuotaForCustomerExceededFault
_NodeQuotaForCustomerExceededFault :: AsError a => Fold a ServiceError Source #
You have attempted to exceed the maximum number of nodes for your AWS account.
ParameterGroupAlreadyExistsFault
_ParameterGroupAlreadyExistsFault :: AsError a => Fold a ServiceError Source #
The specified parameter group already exists.
ParameterGroupNotFoundFault
_ParameterGroupNotFoundFault :: AsError a => Fold a ServiceError Source #
The specified parameter group does not exist.
ParameterGroupQuotaExceededFault
_ParameterGroupQuotaExceededFault :: AsError a => Fold a ServiceError Source #
You have attempted to exceed the maximum number of parameter groups.
ServiceLinkedRoleNotFoundFault
_ServiceLinkedRoleNotFoundFault :: AsError a => Fold a ServiceError Source #
The specified service linked role (SLR) was not found.
ServiceQuotaExceededException
_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
_SubnetGroupAlreadyExistsFault :: AsError a => Fold a ServiceError Source #
The specified subnet group already exists.
SubnetGroupInUseFault
_SubnetGroupInUseFault :: AsError a => Fold a ServiceError Source #
The specified subnet group is currently in use.
SubnetGroupNotFoundFault
_SubnetGroupNotFoundFault :: AsError a => Fold a ServiceError Source #
The requested subnet group name does not refer to an existing subnet group.
SubnetGroupQuotaExceededFault
_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
_SubnetInUse :: AsError a => Fold a ServiceError Source #
The requested subnet is being used by another subnet group.
SubnetQuotaExceededFault
_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
_TagNotFoundFault :: AsError a => Fold a ServiceError Source #
The tag does not exist.
TagQuotaPerResourceExceeded
_TagQuotaPerResourceExceeded :: AsError a => Fold a ServiceError Source #
You have exceeded the maximum number of tags for this DAX cluster.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CreateCluster
data CreateCluster Source #
See: newCreateCluster smart constructor.
Constructors
| CreateCluster' (Maybe [Text]) (Maybe ClusterEndpointEncryptionType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe SSESpecification) (Maybe [Text]) (Maybe Text) (Maybe [Tag]) Text Text Int Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Int | |
| -> Text | |
| -> 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:availabilityZones:CreateCluster', createCluster_availabilityZones - The Availability Zones (AZs) in which the cluster nodes will reside
after the cluster has been created or updated. If provided, the length
of this list must equal the ReplicationFactor parameter. If you omit
this parameter, DAX will spread the nodes across Availability Zones for
the highest availability.
CreateCluster, createCluster_clusterEndpointEncryptionType - The type of encryption the cluster's endpoint should support. Values
are:
NONEfor no encryptionTLSfor Transport Layer Security
CreateCluster, createCluster_description - A description of the cluster.
$sel:notificationTopicArn:CreateCluster', createCluster_notificationTopicArn - The Amazon Resource Name (ARN) of the Amazon SNS topic to which
notifications will be sent.
The Amazon SNS topic owner must be same as the DAX cluster owner.
CreateCluster, createCluster_parameterGroupName - The parameter group to be associated with the DAX cluster.
CreateCluster, createCluster_preferredMaintenanceWindow - 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
If you don't specify a preferred maintenance window when you create or modify a cache cluster, DAX assigns a 60-minute maintenance window on a randomly selected day of the week.
$sel:sSESpecification:CreateCluster', createCluster_sSESpecification - Represents the settings used to enable server-side encryption on the
cluster.
$sel:securityGroupIds:CreateCluster', createCluster_securityGroupIds - 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.
CreateCluster, createCluster_subnetGroupName - The name of the subnet group to be used for the replication group.
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.
$sel:tags:CreateCluster', createCluster_tags - A set of tags to associate with the DAX cluster.
CreateCluster, createCluster_clusterName - 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.
CreateCluster, createCluster_nodeType - The compute and memory capacity of the nodes in the cluster.
$sel:replicationFactor:CreateCluster', createCluster_replicationFactor - 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 a number between 3
(one primary and two read replicas) and 10 (one primary and nine read
replicas). If the AvailabilityZones parameter is provided, its length
must equal the ReplicationFactor.
AWS recommends that you have at least two read replicas per cluster.
CreateCluster, createCluster_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.
data CreateClusterResponse Source #
See: newCreateClusterResponse smart constructor.
Constructors
| CreateClusterResponse' (Maybe Cluster) Int |
Instances
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 - A description of the DAX cluster that you have created.
$sel:httpStatus:CreateClusterResponse', createClusterResponse_httpStatus - The response's http status code.
CreateParameterGroup
data CreateParameterGroup Source #
See: newCreateParameterGroup smart constructor.
Constructors
| CreateParameterGroup' (Maybe Text) Text |
Instances
newCreateParameterGroup Source #
Arguments
| :: Text | |
| -> CreateParameterGroup |
Create a value of CreateParameterGroup 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:
CreateParameterGroup, createParameterGroup_description - A description of the parameter group.
CreateParameterGroup, createParameterGroup_parameterGroupName - The name of the parameter group to apply to all of the clusters in this
replication group.
data CreateParameterGroupResponse Source #
See: newCreateParameterGroupResponse smart constructor.
Constructors
| CreateParameterGroupResponse' (Maybe ParameterGroup) Int |
Instances
newCreateParameterGroupResponse Source #
Create a value of CreateParameterGroupResponse 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:
CreateParameterGroupResponse, createParameterGroupResponse_parameterGroup - Represents the output of a CreateParameterGroup action.
$sel:httpStatus:CreateParameterGroupResponse', createParameterGroupResponse_httpStatus - The response's http status code.
CreateSubnetGroup
data CreateSubnetGroup Source #
See: newCreateSubnetGroup smart constructor.
Constructors
| CreateSubnetGroup' (Maybe Text) Text [Text] |
Instances
Arguments
| :: Text | |
| -> CreateSubnetGroup |
Create a value of CreateSubnetGroup 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:
CreateSubnetGroup, createSubnetGroup_description - A description for the subnet group
CreateSubnetGroup, createSubnetGroup_subnetGroupName - A name for the subnet group. This value is stored as a lowercase string.
$sel:subnetIds:CreateSubnetGroup', createSubnetGroup_subnetIds - A list of VPC subnet IDs for the subnet group.
data CreateSubnetGroupResponse Source #
See: newCreateSubnetGroupResponse smart constructor.
Constructors
| CreateSubnetGroupResponse' (Maybe SubnetGroup) Int |
Instances
newCreateSubnetGroupResponse Source #
Create a value of CreateSubnetGroupResponse 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:
CreateSubnetGroupResponse, createSubnetGroupResponse_subnetGroup - Represents the output of a CreateSubnetGroup operation.
$sel:httpStatus:CreateSubnetGroupResponse', createSubnetGroupResponse_httpStatus - The response's http status code.
DecreaseReplicationFactor
data DecreaseReplicationFactor Source #
See: newDecreaseReplicationFactor smart constructor.
Instances
newDecreaseReplicationFactor Source #
Arguments
| :: Text | |
| -> Int | |
| -> DecreaseReplicationFactor |
Create a value of DecreaseReplicationFactor 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:availabilityZones:DecreaseReplicationFactor', decreaseReplicationFactor_availabilityZones - The Availability Zone(s) from which to remove nodes.
DecreaseReplicationFactor, decreaseReplicationFactor_nodeIdsToRemove - The unique identifiers of the nodes to be removed from the cluster.
DecreaseReplicationFactor, decreaseReplicationFactor_clusterName - The name of the DAX cluster from which you want to remove nodes.
$sel:newReplicationFactor':DecreaseReplicationFactor', decreaseReplicationFactor_newReplicationFactor - The new number of nodes for the DAX cluster.
data DecreaseReplicationFactorResponse Source #
See: newDecreaseReplicationFactorResponse smart constructor.
Constructors
| DecreaseReplicationFactorResponse' (Maybe Cluster) Int |
Instances
newDecreaseReplicationFactorResponse Source #
Arguments
| :: Int | |
| -> DecreaseReplicationFactorResponse |
Create a value of DecreaseReplicationFactorResponse 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:DecreaseReplicationFactorResponse', decreaseReplicationFactorResponse_cluster - A description of the DAX cluster, after you have decreased its
replication factor.
$sel:httpStatus:DecreaseReplicationFactorResponse', decreaseReplicationFactorResponse_httpStatus - The response's http status code.
DeleteCluster
data DeleteCluster Source #
See: newDeleteCluster smart constructor.
Constructors
| DeleteCluster' Text |
Instances
Arguments
| :: Text | |
| -> DeleteCluster |
Create a value of DeleteCluster 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:
DeleteCluster, deleteCluster_clusterName - The name of the cluster to be deleted.
data DeleteClusterResponse Source #
See: newDeleteClusterResponse smart constructor.
Constructors
| DeleteClusterResponse' (Maybe Cluster) Int |
Instances
newDeleteClusterResponse Source #
Create a value of DeleteClusterResponse 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:DeleteClusterResponse', deleteClusterResponse_cluster - A description of the DAX cluster that is being deleted.
$sel:httpStatus:DeleteClusterResponse', deleteClusterResponse_httpStatus - The response's http status code.
DeleteParameterGroup
data DeleteParameterGroup Source #
See: newDeleteParameterGroup smart constructor.
Constructors
| DeleteParameterGroup' Text |
Instances
newDeleteParameterGroup Source #
Arguments
| :: Text | |
| -> DeleteParameterGroup |
Create a value of DeleteParameterGroup 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:
DeleteParameterGroup, deleteParameterGroup_parameterGroupName - The name of the parameter group to delete.
data DeleteParameterGroupResponse Source #
See: newDeleteParameterGroupResponse smart constructor.
Constructors
| DeleteParameterGroupResponse' (Maybe Text) Int |
Instances
newDeleteParameterGroupResponse Source #
Create a value of DeleteParameterGroupResponse 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:deletionMessage:DeleteParameterGroupResponse', deleteParameterGroupResponse_deletionMessage - A user-specified message for this action (i.e., a reason for deleting
the parameter group).
$sel:httpStatus:DeleteParameterGroupResponse', deleteParameterGroupResponse_httpStatus - The response's http status code.
DeleteSubnetGroup
data DeleteSubnetGroup Source #
See: newDeleteSubnetGroup smart constructor.
Constructors
| DeleteSubnetGroup' Text |
Instances
Arguments
| :: Text | |
| -> DeleteSubnetGroup |
Create a value of DeleteSubnetGroup 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:
DeleteSubnetGroup, deleteSubnetGroup_subnetGroupName - The name of the subnet group to delete.
data DeleteSubnetGroupResponse Source #
See: newDeleteSubnetGroupResponse smart constructor.
Constructors
| DeleteSubnetGroupResponse' (Maybe Text) Int |
Instances
newDeleteSubnetGroupResponse Source #
Create a value of DeleteSubnetGroupResponse 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:deletionMessage:DeleteSubnetGroupResponse', deleteSubnetGroupResponse_deletionMessage - A user-specified message for this action (i.e., a reason for deleting
the subnet group).
$sel:httpStatus:DeleteSubnetGroupResponse', deleteSubnetGroupResponse_httpStatus - The response's http status code.
DescribeClusters (Paginated)
data DescribeClusters Source #
See: newDescribeClusters smart constructor.
Instances
newDescribeClusters :: DescribeClusters Source #
Create a value of DescribeClusters 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:clusterNames:DescribeClusters', describeClusters_clusterNames - The names of the DAX clusters being described.
$sel:maxResults:DescribeClusters', describeClusters_maxResults - The maximum number of results to include in the response. If more
results exist than the specified MaxResults value, a token is included
in the response so that the remaining results can be retrieved.
The value for MaxResults must be between 20 and 100.
DescribeClusters, describeClusters_nextToken - An optional token returned from a prior request. Use this token for
pagination of results from this action. If this parameter is specified,
the response includes only results beyond the token, up to the value
specified by MaxResults.
data DescribeClustersResponse Source #
See: newDescribeClustersResponse smart constructor.
Instances
newDescribeClustersResponse Source #
Create a value of DescribeClustersResponse 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:clusters:DescribeClustersResponse', describeClustersResponse_clusters - The descriptions of your DAX clusters, in response to a
DescribeClusters request.
DescribeClusters, describeClustersResponse_nextToken - Provides an identifier to allow retrieval of paginated results.
$sel:httpStatus:DescribeClustersResponse', describeClustersResponse_httpStatus - The response's http status code.
DescribeDefaultParameters (Paginated)
data DescribeDefaultParameters Source #
See: newDescribeDefaultParameters smart constructor.
Constructors
| DescribeDefaultParameters' (Maybe Int) (Maybe Text) |
Instances
newDescribeDefaultParameters :: DescribeDefaultParameters Source #
Create a value of DescribeDefaultParameters 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:maxResults:DescribeDefaultParameters', describeDefaultParameters_maxResults - The maximum number of results to include in the response. If more
results exist than the specified MaxResults value, a token is included
in the response so that the remaining results can be retrieved.
The value for MaxResults must be between 20 and 100.
DescribeDefaultParameters, describeDefaultParameters_nextToken - An optional token returned from a prior request. Use this token for
pagination of results from this action. If this parameter is specified,
the response includes only results beyond the token, up to the value
specified by MaxResults.
data DescribeDefaultParametersResponse Source #
See: newDescribeDefaultParametersResponse smart constructor.
Instances
newDescribeDefaultParametersResponse Source #
Arguments
| :: Int | |
| -> DescribeDefaultParametersResponse |
Create a value of DescribeDefaultParametersResponse 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:
DescribeDefaultParameters, describeDefaultParametersResponse_nextToken - Provides an identifier to allow retrieval of paginated results.
$sel:parameters:DescribeDefaultParametersResponse', describeDefaultParametersResponse_parameters - A list of parameters. Each element in the list represents one parameter.
$sel:httpStatus:DescribeDefaultParametersResponse', describeDefaultParametersResponse_httpStatus - The response's http status code.
DescribeEvents (Paginated)
data DescribeEvents Source #
See: newDescribeEvents smart constructor.
Constructors
| DescribeEvents' (Maybe Int) (Maybe POSIX) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe SourceType) (Maybe POSIX) |
Instances
newDescribeEvents :: DescribeEvents Source #
Create a value of DescribeEvents 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:duration:DescribeEvents', describeEvents_duration - The number of minutes' worth of events to retrieve.
$sel:endTime:DescribeEvents', describeEvents_endTime - The end of the time interval for which to retrieve events, specified in
ISO 8601 format.
$sel:maxResults:DescribeEvents', describeEvents_maxResults - The maximum number of results to include in the response. If more
results exist than the specified MaxResults value, a token is included
in the response so that the remaining results can be retrieved.
The value for MaxResults must be between 20 and 100.
DescribeEvents, describeEvents_nextToken - An optional token returned from a prior request. Use this token for
pagination of results from this action. If this parameter is specified,
the response includes only results beyond the token, up to the value
specified by MaxResults.
DescribeEvents, describeEvents_sourceName - The identifier of the event source for which events will be returned. If
not specified, then all sources are included in the response.
DescribeEvents, describeEvents_sourceType - The event source to retrieve events for. If no value is specified, all
events are returned.
$sel:startTime:DescribeEvents', describeEvents_startTime - The beginning of the time interval to retrieve events for, specified in
ISO 8601 format.
data DescribeEventsResponse Source #
See: newDescribeEventsResponse smart constructor.
Instances
newDescribeEventsResponse Source #
Create a value of DescribeEventsResponse 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:events:DescribeEventsResponse', describeEventsResponse_events - An array of events. Each element in the array represents one event.
DescribeEvents, describeEventsResponse_nextToken - Provides an identifier to allow retrieval of paginated results.
$sel:httpStatus:DescribeEventsResponse', describeEventsResponse_httpStatus - The response's http status code.
DescribeParameterGroups (Paginated)
data DescribeParameterGroups Source #
See: newDescribeParameterGroups smart constructor.
Instances
newDescribeParameterGroups :: DescribeParameterGroups Source #
Create a value of DescribeParameterGroups 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:maxResults:DescribeParameterGroups', describeParameterGroups_maxResults - The maximum number of results to include in the response. If more
results exist than the specified MaxResults value, a token is included
in the response so that the remaining results can be retrieved.
The value for MaxResults must be between 20 and 100.
DescribeParameterGroups, describeParameterGroups_nextToken - An optional token returned from a prior request. Use this token for
pagination of results from this action. If this parameter is specified,
the response includes only results beyond the token, up to the value
specified by MaxResults.
$sel:parameterGroupNames:DescribeParameterGroups', describeParameterGroups_parameterGroupNames - The names of the parameter groups.
data DescribeParameterGroupsResponse Source #
See: newDescribeParameterGroupsResponse smart constructor.
Constructors
| DescribeParameterGroupsResponse' (Maybe Text) (Maybe [ParameterGroup]) Int |
Instances
newDescribeParameterGroupsResponse Source #
Create a value of DescribeParameterGroupsResponse 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:
DescribeParameterGroups, describeParameterGroupsResponse_nextToken - Provides an identifier to allow retrieval of paginated results.
$sel:parameterGroups:DescribeParameterGroupsResponse', describeParameterGroupsResponse_parameterGroups - An array of parameter groups. Each element in the array represents one
parameter group.
$sel:httpStatus:DescribeParameterGroupsResponse', describeParameterGroupsResponse_httpStatus - The response's http status code.
DescribeParameters (Paginated)
data DescribeParameters Source #
See: newDescribeParameters smart constructor.
Instances
newDescribeParameters Source #
Arguments
| :: Text | |
| -> DescribeParameters |
Create a value of DescribeParameters 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:maxResults:DescribeParameters', describeParameters_maxResults - The maximum number of results to include in the response. If more
results exist than the specified MaxResults value, a token is included
in the response so that the remaining results can be retrieved.
The value for MaxResults must be between 20 and 100.
DescribeParameters, describeParameters_nextToken - An optional token returned from a prior request. Use this token for
pagination of results from this action. If this parameter is specified,
the response includes only results beyond the token, up to the value
specified by MaxResults.
DescribeParameters, describeParameters_source - How the parameter is defined. For example, system denotes a
system-defined parameter.
DescribeParameters, describeParameters_parameterGroupName - The name of the parameter group.
data DescribeParametersResponse Source #
See: newDescribeParametersResponse smart constructor.
Instances
newDescribeParametersResponse Source #
Create a value of DescribeParametersResponse 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:
DescribeParameters, describeParametersResponse_nextToken - Provides an identifier to allow retrieval of paginated results.
$sel:parameters:DescribeParametersResponse', describeParametersResponse_parameters - A list of parameters within a parameter group. Each element in the list
represents one parameter.
$sel:httpStatus:DescribeParametersResponse', describeParametersResponse_httpStatus - The response's http status code.
DescribeSubnetGroups (Paginated)
data DescribeSubnetGroups Source #
See: newDescribeSubnetGroups smart constructor.
Instances
newDescribeSubnetGroups :: DescribeSubnetGroups Source #
Create a value of DescribeSubnetGroups 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:maxResults:DescribeSubnetGroups', describeSubnetGroups_maxResults - The maximum number of results to include in the response. If more
results exist than the specified MaxResults value, a token is included
in the response so that the remaining results can be retrieved.
The value for MaxResults must be between 20 and 100.
DescribeSubnetGroups, describeSubnetGroups_nextToken - An optional token returned from a prior request. Use this token for
pagination of results from this action. If this parameter is specified,
the response includes only results beyond the token, up to the value
specified by MaxResults.
$sel:subnetGroupNames:DescribeSubnetGroups', describeSubnetGroups_subnetGroupNames - The name of the subnet group.
data DescribeSubnetGroupsResponse Source #
See: newDescribeSubnetGroupsResponse smart constructor.
Constructors
| DescribeSubnetGroupsResponse' (Maybe Text) (Maybe [SubnetGroup]) Int |
Instances
newDescribeSubnetGroupsResponse Source #
Create a value of DescribeSubnetGroupsResponse 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:
DescribeSubnetGroups, describeSubnetGroupsResponse_nextToken - Provides an identifier to allow retrieval of paginated results.
$sel:subnetGroups:DescribeSubnetGroupsResponse', describeSubnetGroupsResponse_subnetGroups - An array of subnet groups. Each element in the array represents a single
subnet group.
$sel:httpStatus:DescribeSubnetGroupsResponse', describeSubnetGroupsResponse_httpStatus - The response's http status code.
IncreaseReplicationFactor
data IncreaseReplicationFactor Source #
See: newIncreaseReplicationFactor smart constructor.
Constructors
| IncreaseReplicationFactor' (Maybe [Text]) Text Int |
Instances
newIncreaseReplicationFactor Source #
Arguments
| :: Text | |
| -> Int | |
| -> IncreaseReplicationFactor |
Create a value of IncreaseReplicationFactor 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:availabilityZones:IncreaseReplicationFactor', increaseReplicationFactor_availabilityZones - 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.
IncreaseReplicationFactor, increaseReplicationFactor_clusterName - The name of the DAX cluster that will receive additional nodes.
$sel:newReplicationFactor':IncreaseReplicationFactor', increaseReplicationFactor_newReplicationFactor - The new number of nodes for the DAX cluster.
data IncreaseReplicationFactorResponse Source #
See: newIncreaseReplicationFactorResponse smart constructor.
Constructors
| IncreaseReplicationFactorResponse' (Maybe Cluster) Int |
Instances
newIncreaseReplicationFactorResponse Source #
Arguments
| :: Int | |
| -> IncreaseReplicationFactorResponse |
Create a value of IncreaseReplicationFactorResponse 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:IncreaseReplicationFactorResponse', increaseReplicationFactorResponse_cluster - A description of the DAX cluster. with its new replication factor.
$sel:httpStatus:IncreaseReplicationFactorResponse', increaseReplicationFactorResponse_httpStatus - The response's http status code.
ListTags (Paginated)
See: newListTags smart constructor.
Instances
Create a value of ListTags 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:
ListTags, listTags_nextToken - An optional token returned from a prior request. Use this token for
pagination of results from this action. If this parameter is specified,
the response includes only results beyond the token.
$sel:resourceName:ListTags', listTags_resourceName - The name of the DAX resource to which the tags belong.
data ListTagsResponse Source #
See: newListTagsResponse smart constructor.
Instances
Arguments
| :: Int | |
| -> ListTagsResponse |
Create a value of ListTagsResponse 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:
ListTags, listTagsResponse_nextToken - If this value is present, there are additional results to be displayed.
To retrieve them, call ListTags again, with NextToken set to this
value.
$sel:tags:ListTagsResponse', listTagsResponse_tags - A list of tags currently associated with the DAX cluster.
$sel:httpStatus:ListTagsResponse', listTagsResponse_httpStatus - The response's http status code.
RebootNode
data RebootNode Source #
See: newRebootNode smart constructor.
Constructors
| RebootNode' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> RebootNode |
Create a value of RebootNode 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:
RebootNode, rebootNode_clusterName - The name of the DAX cluster containing the node to be rebooted.
RebootNode, rebootNode_nodeId - The system-assigned ID of the node to be rebooted.
data RebootNodeResponse Source #
See: newRebootNodeResponse smart constructor.
Constructors
| RebootNodeResponse' (Maybe Cluster) Int |
Instances
newRebootNodeResponse Source #
Arguments
| :: Int | |
| -> RebootNodeResponse |
Create a value of RebootNodeResponse 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:RebootNodeResponse', rebootNodeResponse_cluster - A description of the DAX cluster after a node has been rebooted.
$sel:httpStatus:RebootNodeResponse', rebootNodeResponse_httpStatus - The response's http status code.
TagResource
data TagResource Source #
See: newTagResource smart constructor.
Constructors
| TagResource' Text [Tag] |
Instances
Arguments
| :: Text | |
| -> TagResource |
Create a value of TagResource 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:resourceName:TagResource', tagResource_resourceName - The name of the DAX resource to which tags should be added.
TagResource, tagResource_tags - The tags to be assigned to the DAX resource.
data TagResourceResponse Source #
See: newTagResourceResponse smart constructor.
Constructors
| TagResourceResponse' (Maybe [Tag]) Int |
Instances
newTagResourceResponse Source #
Arguments
| :: Int | |
| -> TagResourceResponse |
Create a value of TagResourceResponse 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:
TagResource, tagResourceResponse_tags - The list of tags that are associated with the DAX resource.
$sel:httpStatus:TagResourceResponse', tagResourceResponse_httpStatus - The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text [Text] |
Instances
Arguments
| :: Text | |
| -> UntagResource |
Create a value of UntagResource 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:resourceName:UntagResource', untagResource_resourceName - The name of the DAX resource from which the tags should be removed.
$sel:tagKeys:UntagResource', untagResource_tagKeys - A list of tag keys. If the DAX cluster has any tags with these keys,
then the tags are removed from the cluster.
data UntagResourceResponse Source #
See: newUntagResourceResponse smart constructor.
Constructors
| UntagResourceResponse' (Maybe [Tag]) Int |
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse 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:tags:UntagResourceResponse', untagResourceResponse_tags - The tag keys that have been removed from the cluster.
$sel:httpStatus:UntagResourceResponse', untagResourceResponse_httpStatus - The response's http status code.
UpdateCluster
data UpdateCluster Source #
See: newUpdateCluster smart constructor.
Constructors
| UpdateCluster' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) Text |
Instances
Arguments
| :: Text | |
| -> UpdateCluster |
Create a value of UpdateCluster 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:
UpdateCluster, updateCluster_description - A description of the changes being made to the cluster.
$sel:notificationTopicArn:UpdateCluster', updateCluster_notificationTopicArn - The Amazon Resource Name (ARN) that identifies the topic.
$sel:notificationTopicStatus:UpdateCluster', updateCluster_notificationTopicStatus - 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.
UpdateCluster, updateCluster_parameterGroupName - The name of a parameter group for this cluster.
UpdateCluster, updateCluster_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:securityGroupIds:UpdateCluster', updateCluster_securityGroupIds - A list of user-specified security group IDs to be assigned to each node
in the DAX cluster. If this parameter is not specified, DAX assigns the
default VPC security group to each node.
UpdateCluster, updateCluster_clusterName - The name of the DAX cluster to be modified.
data UpdateClusterResponse Source #
See: newUpdateClusterResponse smart constructor.
Constructors
| UpdateClusterResponse' (Maybe Cluster) Int |
Instances
newUpdateClusterResponse Source #
Create a value of UpdateClusterResponse 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:UpdateClusterResponse', updateClusterResponse_cluster - A description of the DAX cluster, after it has been modified.
$sel:httpStatus:UpdateClusterResponse', updateClusterResponse_httpStatus - The response's http status code.
UpdateParameterGroup
data UpdateParameterGroup Source #
See: newUpdateParameterGroup smart constructor.
Constructors
| UpdateParameterGroup' Text [ParameterNameValue] |
Instances
newUpdateParameterGroup Source #
Arguments
| :: Text | |
| -> UpdateParameterGroup |
Create a value of UpdateParameterGroup 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:
UpdateParameterGroup, updateParameterGroup_parameterGroupName - The name of the parameter group.
$sel:parameterNameValues:UpdateParameterGroup', updateParameterGroup_parameterNameValues - An array of name-value pairs for the parameters in the group. Each
element in the array represents a single parameter.
record-ttl-millis and query-ttl-millis are the only supported
parameter names. For more details, see
Configuring TTL Settings.
data UpdateParameterGroupResponse Source #
See: newUpdateParameterGroupResponse smart constructor.
Constructors
| UpdateParameterGroupResponse' (Maybe ParameterGroup) Int |
Instances
newUpdateParameterGroupResponse Source #
Create a value of UpdateParameterGroupResponse 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:
UpdateParameterGroupResponse, updateParameterGroupResponse_parameterGroup - The parameter group that has been modified.
$sel:httpStatus:UpdateParameterGroupResponse', updateParameterGroupResponse_httpStatus - The response's http status code.
UpdateSubnetGroup
data UpdateSubnetGroup Source #
See: newUpdateSubnetGroup smart constructor.
Instances
Arguments
| :: Text | |
| -> UpdateSubnetGroup |
Create a value of UpdateSubnetGroup 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:
UpdateSubnetGroup, updateSubnetGroup_description - A description of the subnet group.
$sel:subnetIds:UpdateSubnetGroup', updateSubnetGroup_subnetIds - A list of subnet IDs in the subnet group.
UpdateSubnetGroup, updateSubnetGroup_subnetGroupName - The name of the subnet group.
data UpdateSubnetGroupResponse Source #
See: newUpdateSubnetGroupResponse smart constructor.
Constructors
| UpdateSubnetGroupResponse' (Maybe SubnetGroup) Int |
Instances
newUpdateSubnetGroupResponse Source #
Create a value of UpdateSubnetGroupResponse 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:
UpdateSubnetGroupResponse, updateSubnetGroupResponse_subnetGroup - The subnet group that has been modified.
$sel:httpStatus:UpdateSubnetGroupResponse', updateSubnetGroupResponse_httpStatus - The response's http status code.
Types
ChangeType
newtype ChangeType Source #
Constructors
| ChangeType' | |
Fields | |
Bundled Patterns
| pattern ChangeType_IMMEDIATE :: ChangeType | |
| pattern ChangeType_REQUIRES_REBOOT :: ChangeType |
Instances
ClusterEndpointEncryptionType
newtype ClusterEndpointEncryptionType Source #
Constructors
| ClusterEndpointEncryptionType' | |
Fields | |
Bundled Patterns
| pattern ClusterEndpointEncryptionType_NONE :: ClusterEndpointEncryptionType | |
| pattern ClusterEndpointEncryptionType_TLS :: ClusterEndpointEncryptionType |
Instances
IsModifiable
newtype IsModifiable Source #
Constructors
| IsModifiable' | |
Fields | |
Bundled Patterns
| pattern IsModifiable_CONDITIONAL :: IsModifiable | |
| pattern IsModifiable_FALSE :: IsModifiable | |
| pattern IsModifiable_TRUE :: IsModifiable |
Instances
ParameterType
newtype ParameterType Source #
Constructors
| ParameterType' | |
Fields | |
Bundled Patterns
| pattern ParameterType_DEFAULT :: ParameterType | |
| pattern ParameterType_NODE_TYPE_SPECIFIC :: ParameterType |
Instances
SSEStatus
Constructors
| SSEStatus' | |
Fields | |
Bundled Patterns
| pattern SSEStatus_DISABLED :: SSEStatus | |
| pattern SSEStatus_DISABLING :: SSEStatus | |
| pattern SSEStatus_ENABLED :: SSEStatus | |
| pattern SSEStatus_ENABLING :: SSEStatus |
Instances
SourceType
newtype SourceType Source #
Constructors
| SourceType' | |
Fields | |
Bundled Patterns
| 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.
Constructors
| Cluster' (Maybe Int) (Maybe Text) (Maybe Endpoint) (Maybe ClusterEndpointEncryptionType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe [Node]) (Maybe NotificationConfiguration) (Maybe ParameterGroupStatus) (Maybe Text) (Maybe SSEDescription) (Maybe [SecurityGroupMembership]) (Maybe Text) (Maybe Text) (Maybe Int) |
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:
NONEfor no encryptionTLSfor 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.
Endpoint
Represents the information required for client programs to connect to the endpoint for a DAX cluster.
See: newEndpoint smart constructor.
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.
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.
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.
Node
Represents an individual node within a DAX cluster.
See: newNode smart constructor.
Constructors
| Node' (Maybe Text) (Maybe Endpoint) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) |
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.
NodeTypeSpecificValue
data NodeTypeSpecificValue Source #
Represents a parameter value that is applicable to a particular node type.
See: newNodeTypeSpecificValue smart constructor.
Constructors
| NodeTypeSpecificValue' (Maybe Text) (Maybe Text) |
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.
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.
Constructors
| NotificationConfiguration' (Maybe Text) (Maybe Text) |
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.
Parameter
Describes an individual setting that controls some aspect of DAX behavior.
See: newParameter smart constructor.
Constructors
| Parameter' (Maybe Text) (Maybe ChangeType) (Maybe Text) (Maybe Text) (Maybe IsModifiable) (Maybe [NodeTypeSpecificValue]) (Maybe Text) (Maybe ParameterType) (Maybe Text) (Maybe Text) |
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.
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.
Constructors
| ParameterGroup' (Maybe Text) (Maybe Text) |
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.
ParameterGroupStatus
data ParameterGroupStatus Source #
The status of a parameter group.
See: newParameterGroupStatus smart constructor.
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.
ParameterNameValue
data ParameterNameValue Source #
An individual DAX parameter.
See: newParameterNameValue smart constructor.
Constructors
| ParameterNameValue' (Maybe Text) (Maybe Text) |
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.
SSEDescription
data SSEDescription Source #
The description of the server-side encryption status on the specified DAX cluster.
See: newSSEDescription smart constructor.
Constructors
| SSEDescription' (Maybe SSEStatus) |
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.
SSESpecification
data SSESpecification Source #
Represents the settings used to enable server-side encryption.
See: newSSESpecification smart constructor.
Constructors
| SSESpecification' Bool |
Instances
Arguments
| :: Bool | |
| -> SSESpecification |
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.
SecurityGroupMembership
data SecurityGroupMembership Source #
An individual VPC security group and its status.
See: newSecurityGroupMembership smart constructor.
Constructors
| SecurityGroupMembership' (Maybe Text) (Maybe Text) |
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.
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.
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.
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.
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.
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.