Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Amazonka.DAX
Contents
- Service Configuration
- Errors
- SubnetQuotaExceededFault
- ParameterGroupNotFoundFault
- InvalidParameterGroupStateFault
- SubnetGroupInUseFault
- ParameterGroupAlreadyExistsFault
- InvalidSubnet
- TagQuotaPerResourceExceeded
- ClusterNotFoundFault
- TagNotFoundFault
- NodeQuotaForClusterExceededFault
- InvalidClusterStateFault
- ServiceLinkedRoleNotFoundFault
- InsufficientClusterCapacityFault
- NodeNotFoundFault
- ParameterGroupQuotaExceededFault
- InvalidParameterValueException
- InvalidVPCNetworkStateFault
- SubnetInUse
- ServiceQuotaExceededException
- ClusterQuotaForCustomerExceededFault
- SubnetGroupNotFoundFault
- SubnetGroupAlreadyExistsFault
- NodeQuotaForCustomerExceededFault
- SubnetGroupQuotaExceededFault
- ClusterAlreadyExistsFault
- InvalidARNFault
- InvalidParameterCombinationException
- Waiters
- Operations
- DescribeClusters (Paginated)
- DescribeParameters (Paginated)
- DescribeEvents (Paginated)
- IncreaseReplicationFactor
- CreateSubnetGroup
- DeleteCluster
- UpdateCluster
- CreateCluster
- DescribeDefaultParameters (Paginated)
- DeleteParameterGroup
- UpdateParameterGroup
- DescribeSubnetGroups (Paginated)
- CreateParameterGroup
- UpdateSubnetGroup
- DeleteSubnetGroup
- DescribeParameterGroups (Paginated)
- TagResource
- ListTags (Paginated)
- DecreaseReplicationFactor
- UntagResource
- RebootNode
- 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
- _SubnetQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _ParameterGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidParameterGroupStateFault :: AsError a => Getting (First ServiceError) a ServiceError
- _SubnetGroupInUseFault :: AsError a => Getting (First ServiceError) a ServiceError
- _ParameterGroupAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidSubnet :: AsError a => Getting (First ServiceError) a ServiceError
- _TagQuotaPerResourceExceeded :: AsError a => Getting (First ServiceError) a ServiceError
- _ClusterNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _TagNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _NodeQuotaForClusterExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidClusterStateFault :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceLinkedRoleNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InsufficientClusterCapacityFault :: AsError a => Getting (First ServiceError) a ServiceError
- _NodeNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _ParameterGroupQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidParameterValueException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidVPCNetworkStateFault :: AsError a => Getting (First ServiceError) a ServiceError
- _SubnetInUse :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceQuotaExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ClusterQuotaForCustomerExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _SubnetGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _SubnetGroupAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- _NodeQuotaForCustomerExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _SubnetGroupQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _ClusterAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidARNFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidParameterCombinationException :: AsError a => Getting (First ServiceError) a ServiceError
- data DescribeClusters = DescribeClusters' (Maybe [Text]) (Maybe Text) (Maybe Int)
- newDescribeClusters :: DescribeClusters
- data DescribeClustersResponse = DescribeClustersResponse' (Maybe Text) (Maybe [Cluster]) Int
- newDescribeClustersResponse :: Int -> DescribeClustersResponse
- data DescribeParameters = DescribeParameters' (Maybe Text) (Maybe Text) (Maybe Int) Text
- newDescribeParameters :: Text -> DescribeParameters
- data DescribeParametersResponse = DescribeParametersResponse' (Maybe Text) (Maybe [Parameter]) Int
- newDescribeParametersResponse :: Int -> DescribeParametersResponse
- data DescribeEvents = DescribeEvents' (Maybe Text) (Maybe POSIX) (Maybe SourceType) (Maybe Text) (Maybe POSIX) (Maybe Int) (Maybe Int)
- newDescribeEvents :: DescribeEvents
- data DescribeEventsResponse = DescribeEventsResponse' (Maybe Text) (Maybe [Event]) Int
- newDescribeEventsResponse :: Int -> DescribeEventsResponse
- data IncreaseReplicationFactor = IncreaseReplicationFactor' (Maybe [Text]) Text Int
- newIncreaseReplicationFactor :: Text -> Int -> IncreaseReplicationFactor
- data IncreaseReplicationFactorResponse = IncreaseReplicationFactorResponse' (Maybe Cluster) Int
- newIncreaseReplicationFactorResponse :: Int -> IncreaseReplicationFactorResponse
- data CreateSubnetGroup = CreateSubnetGroup' (Maybe Text) Text [Text]
- newCreateSubnetGroup :: Text -> CreateSubnetGroup
- data CreateSubnetGroupResponse = CreateSubnetGroupResponse' (Maybe SubnetGroup) Int
- newCreateSubnetGroupResponse :: Int -> CreateSubnetGroupResponse
- data DeleteCluster = DeleteCluster' Text
- newDeleteCluster :: Text -> DeleteCluster
- data DeleteClusterResponse = DeleteClusterResponse' (Maybe Cluster) Int
- newDeleteClusterResponse :: Int -> DeleteClusterResponse
- 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 CreateCluster = CreateCluster' (Maybe [Text]) (Maybe SSESpecification) (Maybe Text) (Maybe ClusterEndpointEncryptionType) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe [Tag]) (Maybe Text) Text Text Int Text
- newCreateCluster :: Text -> Text -> Int -> Text -> CreateCluster
- data CreateClusterResponse = CreateClusterResponse' (Maybe Cluster) Int
- newCreateClusterResponse :: Int -> CreateClusterResponse
- data DescribeDefaultParameters = DescribeDefaultParameters' (Maybe Text) (Maybe Int)
- newDescribeDefaultParameters :: DescribeDefaultParameters
- data DescribeDefaultParametersResponse = DescribeDefaultParametersResponse' (Maybe Text) (Maybe [Parameter]) Int
- newDescribeDefaultParametersResponse :: Int -> DescribeDefaultParametersResponse
- data DeleteParameterGroup = DeleteParameterGroup' Text
- newDeleteParameterGroup :: Text -> DeleteParameterGroup
- data DeleteParameterGroupResponse = DeleteParameterGroupResponse' (Maybe Text) Int
- newDeleteParameterGroupResponse :: Int -> DeleteParameterGroupResponse
- data UpdateParameterGroup = UpdateParameterGroup' Text [ParameterNameValue]
- newUpdateParameterGroup :: Text -> UpdateParameterGroup
- data UpdateParameterGroupResponse = UpdateParameterGroupResponse' (Maybe ParameterGroup) Int
- newUpdateParameterGroupResponse :: Int -> UpdateParameterGroupResponse
- data DescribeSubnetGroups = DescribeSubnetGroups' (Maybe [Text]) (Maybe Text) (Maybe Int)
- newDescribeSubnetGroups :: DescribeSubnetGroups
- data DescribeSubnetGroupsResponse = DescribeSubnetGroupsResponse' (Maybe [SubnetGroup]) (Maybe Text) Int
- newDescribeSubnetGroupsResponse :: Int -> DescribeSubnetGroupsResponse
- data CreateParameterGroup = CreateParameterGroup' (Maybe Text) Text
- newCreateParameterGroup :: Text -> CreateParameterGroup
- data CreateParameterGroupResponse = CreateParameterGroupResponse' (Maybe ParameterGroup) Int
- newCreateParameterGroupResponse :: Int -> CreateParameterGroupResponse
- data UpdateSubnetGroup = UpdateSubnetGroup' (Maybe [Text]) (Maybe Text) Text
- newUpdateSubnetGroup :: Text -> UpdateSubnetGroup
- data UpdateSubnetGroupResponse = UpdateSubnetGroupResponse' (Maybe SubnetGroup) Int
- newUpdateSubnetGroupResponse :: Int -> UpdateSubnetGroupResponse
- data DeleteSubnetGroup = DeleteSubnetGroup' Text
- newDeleteSubnetGroup :: Text -> DeleteSubnetGroup
- data DeleteSubnetGroupResponse = DeleteSubnetGroupResponse' (Maybe Text) Int
- newDeleteSubnetGroupResponse :: Int -> DeleteSubnetGroupResponse
- data DescribeParameterGroups = DescribeParameterGroups' (Maybe Text) (Maybe [Text]) (Maybe Int)
- newDescribeParameterGroups :: DescribeParameterGroups
- data DescribeParameterGroupsResponse = DescribeParameterGroupsResponse' (Maybe Text) (Maybe [ParameterGroup]) Int
- newDescribeParameterGroupsResponse :: Int -> DescribeParameterGroupsResponse
- data TagResource = TagResource' Text [Tag]
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' (Maybe [Tag]) Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data ListTags = ListTags' (Maybe Text) Text
- newListTags :: Text -> ListTags
- data ListTagsResponse = ListTagsResponse' (Maybe Text) (Maybe [Tag]) Int
- newListTagsResponse :: Int -> ListTagsResponse
- data DecreaseReplicationFactor = DecreaseReplicationFactor' (Maybe [Text]) (Maybe [Text]) Text Int
- newDecreaseReplicationFactor :: Text -> Int -> DecreaseReplicationFactor
- data DecreaseReplicationFactorResponse = DecreaseReplicationFactorResponse' (Maybe Cluster) Int
- newDecreaseReplicationFactorResponse :: Int -> DecreaseReplicationFactorResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' (Maybe [Tag]) Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data RebootNode = RebootNode' Text Text
- newRebootNode :: Text -> Text -> RebootNode
- data RebootNodeResponse = RebootNodeResponse' (Maybe Cluster) Int
- newRebootNodeResponse :: Int -> RebootNodeResponse
- 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 Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe [SecurityGroupMembership]) (Maybe NotificationConfiguration) (Maybe [Text]) (Maybe ClusterEndpointEncryptionType) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Node]) (Maybe Endpoint) (Maybe SSEDescription) (Maybe Text) (Maybe ParameterGroupStatus)
- newCluster :: Cluster
- data Endpoint = Endpoint' (Maybe Text) (Maybe Text) (Maybe Int)
- newEndpoint :: Endpoint
- data Event = Event' (Maybe Text) (Maybe SourceType) (Maybe POSIX) (Maybe Text)
- newEvent :: Event
- data Node = Node' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Endpoint) (Maybe POSIX)
- 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 ParameterType) (Maybe Text) (Maybe IsModifiable) (Maybe Text) (Maybe [NodeTypeSpecificValue]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ChangeType)
- 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 [Subnet]) (Maybe Text) (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
.
SubnetQuotaExceededFault
_SubnetQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request cannot be processed because it would exceed the allowed number of subnets in a subnet group.
ParameterGroupNotFoundFault
_ParameterGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified parameter group does not exist.
InvalidParameterGroupStateFault
_InvalidParameterGroupStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
One or more parameters in a parameter group are in an invalid state.
SubnetGroupInUseFault
_SubnetGroupInUseFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified subnet group is currently in use.
ParameterGroupAlreadyExistsFault
_ParameterGroupAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified parameter group already exists.
InvalidSubnet
_InvalidSubnet :: AsError a => Getting (First ServiceError) a ServiceError Source #
An invalid subnet identifier was specified.
TagQuotaPerResourceExceeded
_TagQuotaPerResourceExceeded :: AsError a => Getting (First ServiceError) a ServiceError Source #
You have exceeded the maximum number of tags for this DAX cluster.
ClusterNotFoundFault
_ClusterNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested cluster ID does not refer to an existing DAX cluster.
TagNotFoundFault
_TagNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The tag does not exist.
NodeQuotaForClusterExceededFault
_NodeQuotaForClusterExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
You have attempted to exceed the maximum number of nodes for a DAX cluster.
InvalidClusterStateFault
_InvalidClusterStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested DAX cluster is not in the available state.
ServiceLinkedRoleNotFoundFault
_ServiceLinkedRoleNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified service linked role (SLR) was not found.
InsufficientClusterCapacityFault
_InsufficientClusterCapacityFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
There are not enough system resources to create the cluster you requested (or to resize an already-existing cluster).
NodeNotFoundFault
_NodeNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
None of the nodes in the cluster have the given node ID.
ParameterGroupQuotaExceededFault
_ParameterGroupQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
You have attempted to exceed the maximum number of parameter groups.
InvalidParameterValueException
_InvalidParameterValueException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The value for a parameter is invalid.
InvalidVPCNetworkStateFault
_InvalidVPCNetworkStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The VPC network is in an invalid state.
SubnetInUse
_SubnetInUse :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested subnet is being used by another subnet group.
ServiceQuotaExceededException
_ServiceQuotaExceededException :: AsError a => Getting (First ServiceError) 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.
ClusterQuotaForCustomerExceededFault
_ClusterQuotaForCustomerExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
You have attempted to exceed the maximum number of DAX clusters for your AWS account.
SubnetGroupNotFoundFault
_SubnetGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested subnet group name does not refer to an existing subnet group.
SubnetGroupAlreadyExistsFault
_SubnetGroupAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified subnet group already exists.
NodeQuotaForCustomerExceededFault
_NodeQuotaForCustomerExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
You have attempted to exceed the maximum number of nodes for your AWS account.
SubnetGroupQuotaExceededFault
_SubnetGroupQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request cannot be processed because it would exceed the allowed number of subnets in a subnet group.
ClusterAlreadyExistsFault
_ClusterAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
You already have a DAX cluster with the given identifier.
InvalidARNFault
_InvalidARNFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The Amazon Resource Name (ARN) supplied in the request is not valid.
InvalidParameterCombinationException
_InvalidParameterCombinationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Two or more incompatible parameters were specified.
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.
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:nextToken: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
.
$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.
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:nextToken:DescribeClusters'
, describeClustersResponse_nextToken
- Provides an identifier to allow retrieval of paginated results.
$sel:clusters:DescribeClustersResponse'
, describeClustersResponse_clusters
- The descriptions of your DAX clusters, in response to a
DescribeClusters request.
$sel:httpStatus:DescribeClustersResponse'
, describeClustersResponse_httpStatus
- The response's http status code.
DescribeParameters (Paginated)
data DescribeParameters Source #
See: newDescribeParameters
smart constructor.
Instances
newDescribeParameters Source #
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:nextToken: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
.
$sel:source:DescribeParameters'
, describeParameters_source
- How the parameter is defined. For example, system
denotes a
system-defined parameter.
$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.
$sel:parameterGroupName: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:
$sel:nextToken: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.
DescribeEvents (Paginated)
data DescribeEvents Source #
See: newDescribeEvents
smart constructor.
Constructors
DescribeEvents' (Maybe Text) (Maybe POSIX) (Maybe SourceType) (Maybe Text) (Maybe POSIX) (Maybe Int) (Maybe Int) |
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:sourceName: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.
$sel:startTime:DescribeEvents'
, describeEvents_startTime
- The beginning of the time interval to retrieve events for, specified in
ISO 8601 format.
$sel:sourceType:DescribeEvents'
, describeEvents_sourceType
- The event source to retrieve events for. If no value is specified, all
events are returned.
$sel:nextToken: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
.
$sel:endTime:DescribeEvents'
, describeEvents_endTime
- The end of the time interval for which to retrieve events, specified in
ISO 8601 format.
$sel:duration:DescribeEvents'
, describeEvents_duration
- The number of minutes' worth of events to retrieve.
$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.
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:nextToken:DescribeEvents'
, describeEventsResponse_nextToken
- Provides an identifier to allow retrieval of paginated results.
$sel:events:DescribeEventsResponse'
, describeEventsResponse_events
- An array of events. Each element in the array represents one event.
$sel:httpStatus:DescribeEventsResponse'
, describeEventsResponse_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.
$sel:clusterName: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.
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:
$sel:description:CreateSubnetGroup'
, createSubnetGroup_description
- A description for the subnet group
$sel:subnetGroupName: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:
$sel:subnetGroup:CreateSubnetGroupResponse'
, createSubnetGroupResponse_subnetGroup
- Represents the output of a CreateSubnetGroup operation.
$sel:httpStatus:CreateSubnetGroupResponse'
, createSubnetGroupResponse_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:
$sel:clusterName: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.
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:
$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.
$sel:preferredMaintenanceWindow: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: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.
$sel:description: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:parameterGroupName:UpdateCluster'
, updateCluster_parameterGroupName
- The name of a parameter group for this cluster.
$sel:clusterName: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.
CreateCluster
data CreateCluster Source #
See: newCreateCluster
smart constructor.
Constructors
CreateCluster' (Maybe [Text]) (Maybe SSESpecification) (Maybe Text) (Maybe ClusterEndpointEncryptionType) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe [Tag]) (Maybe Text) 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: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.
$sel:sSESpecification:CreateCluster'
, createCluster_sSESpecification
- Represents the settings used to enable server-side encryption on the
cluster.
$sel:subnetGroupName: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:clusterEndpointEncryptionType:CreateCluster'
, createCluster_clusterEndpointEncryptionType
- The type of encryption the cluster's endpoint should support. Values
are:
NONE
for no encryptionTLS
for Transport Layer Security
$sel:preferredMaintenanceWindow: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: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.
$sel:description: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.
$sel:tags:CreateCluster'
, createCluster_tags
- A set of tags to associate with the DAX cluster.
$sel:parameterGroupName:CreateCluster'
, createCluster_parameterGroupName
- The parameter group to be associated with the DAX cluster.
$sel:clusterName: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.
$sel:nodeType: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.
$sel:iamRoleArn: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.
DescribeDefaultParameters (Paginated)
data DescribeDefaultParameters Source #
See: newDescribeDefaultParameters
smart constructor.
Constructors
DescribeDefaultParameters' (Maybe Text) (Maybe Int) |
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:nextToken: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
.
$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.
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:
$sel:nextToken: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.
DeleteParameterGroup
data DeleteParameterGroup Source #
See: newDeleteParameterGroup
smart constructor.
Constructors
DeleteParameterGroup' Text |
Instances
newDeleteParameterGroup Source #
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:
$sel:parameterGroupName: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.
UpdateParameterGroup
data UpdateParameterGroup Source #
See: newUpdateParameterGroup
smart constructor.
Constructors
UpdateParameterGroup' Text [ParameterNameValue] |
Instances
newUpdateParameterGroup Source #
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:
$sel:parameterGroupName: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:
$sel:parameterGroup:UpdateParameterGroupResponse'
, updateParameterGroupResponse_parameterGroup
- The parameter group that has been modified.
$sel:httpStatus:UpdateParameterGroupResponse'
, updateParameterGroupResponse_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:subnetGroupNames:DescribeSubnetGroups'
, describeSubnetGroups_subnetGroupNames
- The name of the subnet group.
$sel:nextToken: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: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.
data DescribeSubnetGroupsResponse Source #
See: newDescribeSubnetGroupsResponse
smart constructor.
Constructors
DescribeSubnetGroupsResponse' (Maybe [SubnetGroup]) (Maybe Text) 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:
$sel:subnetGroups:DescribeSubnetGroupsResponse'
, describeSubnetGroupsResponse_subnetGroups
- An array of subnet groups. Each element in the array represents a single
subnet group.
$sel:nextToken:DescribeSubnetGroups'
, describeSubnetGroupsResponse_nextToken
- Provides an identifier to allow retrieval of paginated results.
$sel:httpStatus:DescribeSubnetGroupsResponse'
, describeSubnetGroupsResponse_httpStatus
- The response's http status code.
CreateParameterGroup
data CreateParameterGroup Source #
See: newCreateParameterGroup
smart constructor.
Constructors
CreateParameterGroup' (Maybe Text) Text |
Instances
newCreateParameterGroup Source #
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:
$sel:description:CreateParameterGroup'
, createParameterGroup_description
- A description of the parameter group.
$sel:parameterGroupName: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:
$sel:parameterGroup:CreateParameterGroupResponse'
, createParameterGroupResponse_parameterGroup
- Represents the output of a CreateParameterGroup action.
$sel:httpStatus:CreateParameterGroupResponse'
, createParameterGroupResponse_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:
$sel:subnetIds:UpdateSubnetGroup'
, updateSubnetGroup_subnetIds
- A list of subnet IDs in the subnet group.
$sel:description:UpdateSubnetGroup'
, updateSubnetGroup_description
- A description of the subnet group.
$sel:subnetGroupName: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:
$sel:subnetGroup:UpdateSubnetGroupResponse'
, updateSubnetGroupResponse_subnetGroup
- The subnet group that has been modified.
$sel:httpStatus:UpdateSubnetGroupResponse'
, updateSubnetGroupResponse_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:
$sel:subnetGroupName: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.
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:nextToken: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.
$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.
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:
$sel:nextToken: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.
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.
$sel:tags: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:
$sel:tags: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.
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:
$sel:nextToken: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:
$sel:nextToken: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.
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:nodeIdsToRemove:DecreaseReplicationFactor'
, decreaseReplicationFactor_nodeIdsToRemove
- The unique identifiers of the nodes to be removed from the cluster.
$sel:availabilityZones:DecreaseReplicationFactor'
, decreaseReplicationFactor_availabilityZones
- The Availability Zone(s) from which to remove nodes.
$sel:clusterName: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.
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.
RebootNode
data RebootNode Source #
See: newRebootNode
smart constructor.
Constructors
RebootNode' Text Text |
Instances
Eq RebootNode Source # | |
Defined in Amazonka.DAX.RebootNode | |
Read RebootNode Source # | |
Defined in Amazonka.DAX.RebootNode Methods readsPrec :: Int -> ReadS RebootNode # readList :: ReadS [RebootNode] # readPrec :: ReadPrec RebootNode # readListPrec :: ReadPrec [RebootNode] # | |
Show RebootNode Source # | |
Defined in Amazonka.DAX.RebootNode Methods |