amazonka-memorydb-2.0: Amazon MemoryDB SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.MemoryDb.Lens

Description

 
Synopsis

Operations

BatchUpdateCluster

batchUpdateCluster_serviceUpdate :: Lens' BatchUpdateCluster (Maybe ServiceUpdateRequest) Source #

The unique ID of the service update

batchUpdateCluster_clusterNames :: Lens' BatchUpdateCluster [Text] Source #

The cluster names to apply the updates.

batchUpdateClusterResponse_processedClusters :: Lens' BatchUpdateClusterResponse (Maybe [Cluster]) Source #

The list of clusters that have been updated.

batchUpdateClusterResponse_unprocessedClusters :: Lens' BatchUpdateClusterResponse (Maybe [UnprocessedCluster]) Source #

The list of clusters where updates have not been applied.

batchUpdateClusterResponse_httpStatus :: Lens' BatchUpdateClusterResponse Int Source #

The response's http status code.

CopySnapshot

copySnapshot_kmsKeyId :: Lens' CopySnapshot (Maybe Text) Source #

The ID of the KMS key used to encrypt the target snapshot.

copySnapshot_tags :: Lens' CopySnapshot (Maybe [Tag]) Source #

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

copySnapshot_targetBucket :: Lens' CopySnapshot (Maybe Text) Source #

The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access. When using this parameter to export a snapshot, be sure MemoryDB has the needed permissions to this S3 bucket. For more information, see Step 2: Grant MemoryDB Access to Your Amazon S3 Bucket.

copySnapshot_sourceSnapshotName :: Lens' CopySnapshot Text Source #

The name of an existing snapshot from which to make a copy.

copySnapshot_targetSnapshotName :: Lens' CopySnapshot Text Source #

A name for the snapshot copy. MemoryDB does not permit overwriting a snapshot, therefore this name must be unique within its context - MemoryDB or an Amazon S3 bucket if exporting.

copySnapshotResponse_snapshot :: Lens' CopySnapshotResponse (Maybe Snapshot) Source #

Represents a copy of an entire cluster as of the time when the snapshot was taken.

copySnapshotResponse_httpStatus :: Lens' CopySnapshotResponse Int Source #

The response's http status code.

CreateACL

createACL_tags :: Lens' CreateACL (Maybe [Tag]) Source #

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

createACL_userNames :: Lens' CreateACL (Maybe (NonEmpty Text)) Source #

The list of users that belong to the Access Control List.

createACL_aCLName :: Lens' CreateACL Text Source #

The name of the Access Control List.

createACLResponse_acl :: Lens' CreateACLResponse (Maybe ACL) Source #

The newly-created Access Control List.

createACLResponse_httpStatus :: Lens' CreateACLResponse Int Source #

The response's http status code.

CreateCluster

createCluster_autoMinorVersionUpgrade :: Lens' CreateCluster (Maybe Bool) Source #

When set to true, the cluster will automatically receive minor engine version upgrades after launch.

createCluster_dataTiering :: Lens' CreateCluster (Maybe Bool) Source #

Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.

createCluster_description :: Lens' CreateCluster (Maybe Text) Source #

An optional description of the cluster.

createCluster_engineVersion :: Lens' CreateCluster (Maybe Text) Source #

The version number of the Redis engine to be used for the cluster.

createCluster_kmsKeyId :: Lens' CreateCluster (Maybe Text) Source #

The ID of the KMS key used to encrypt the cluster.

createCluster_maintenanceWindow :: Lens' CreateCluster (Maybe Text) Source #

Specifies the weekly time range during which maintenance on the 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:23:00-mon:01:30

createCluster_numReplicasPerShard :: Lens' CreateCluster (Maybe Int) Source #

The number of replicas to apply to each shard. The default value is 1. The maximum is 5.

createCluster_numShards :: Lens' CreateCluster (Maybe Int) Source #

The number of shards the cluster will contain. The default value is 1.

createCluster_parameterGroupName :: Lens' CreateCluster (Maybe Text) Source #

The name of the parameter group associated with the cluster.

createCluster_port :: Lens' CreateCluster (Maybe Int) Source #

The port number on which each of the nodes accepts connections.

createCluster_securityGroupIds :: Lens' CreateCluster (Maybe [Text]) Source #

A list of security group names to associate with this cluster.

createCluster_snapshotArns :: Lens' CreateCluster (Maybe [Text]) Source #

A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new cluster. The Amazon S3 object name in the ARN cannot contain any commas.

createCluster_snapshotName :: Lens' CreateCluster (Maybe Text) Source #

The name of a snapshot from which to restore data into the new cluster. The snapshot status changes to restoring while the new cluster is being created.

createCluster_snapshotRetentionLimit :: Lens' CreateCluster (Maybe Int) Source #

The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

createCluster_snapshotWindow :: Lens' CreateCluster (Maybe Text) Source #

The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.

Example: 05:00-09:00

If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.

createCluster_snsTopicArn :: Lens' CreateCluster (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.

createCluster_subnetGroupName :: Lens' CreateCluster (Maybe Text) Source #

The name of the subnet group to be used for the cluster.

createCluster_tLSEnabled :: Lens' CreateCluster (Maybe Bool) Source #

A flag to enable in-transit encryption on the cluster.

createCluster_tags :: Lens' CreateCluster (Maybe [Tag]) Source #

A list of tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue.

createCluster_clusterName :: Lens' CreateCluster Text Source #

The name of the cluster. This value must be unique as it also serves as the cluster identifier.

createCluster_nodeType :: Lens' CreateCluster Text Source #

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

createCluster_aCLName :: Lens' CreateCluster Text Source #

The name of the Access Control List to associate with the cluster.

createClusterResponse_cluster :: Lens' CreateClusterResponse (Maybe Cluster) Source #

The newly-created cluster.

createClusterResponse_httpStatus :: Lens' CreateClusterResponse Int Source #

The response's http status code.

CreateParameterGroup

createParameterGroup_description :: Lens' CreateParameterGroup (Maybe Text) Source #

An optional description of the parameter group.

createParameterGroup_tags :: Lens' CreateParameterGroup (Maybe [Tag]) Source #

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

createParameterGroup_parameterGroupName :: Lens' CreateParameterGroup Text Source #

The name of the parameter group.

createParameterGroup_family :: Lens' CreateParameterGroup Text Source #

The name of the parameter group family that the parameter group can be used with.

createParameterGroupResponse_parameterGroup :: Lens' CreateParameterGroupResponse (Maybe ParameterGroup) Source #

The newly-created parameter group.

createParameterGroupResponse_httpStatus :: Lens' CreateParameterGroupResponse Int Source #

The response's http status code.

CreateSnapshot

createSnapshot_kmsKeyId :: Lens' CreateSnapshot (Maybe Text) Source #

The ID of the KMS key used to encrypt the snapshot.

createSnapshot_tags :: Lens' CreateSnapshot (Maybe [Tag]) Source #

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

createSnapshot_clusterName :: Lens' CreateSnapshot Text Source #

The snapshot is created from this cluster.

createSnapshot_snapshotName :: Lens' CreateSnapshot Text Source #

A name for the snapshot being created.

createSnapshotResponse_snapshot :: Lens' CreateSnapshotResponse (Maybe Snapshot) Source #

The newly-created snapshot.

createSnapshotResponse_httpStatus :: Lens' CreateSnapshotResponse Int Source #

The response's http status code.

CreateSubnetGroup

createSubnetGroup_description :: Lens' CreateSubnetGroup (Maybe Text) Source #

A description for the subnet group.

createSubnetGroup_tags :: Lens' CreateSubnetGroup (Maybe [Tag]) Source #

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

createSubnetGroup_subnetGroupName :: Lens' CreateSubnetGroup Text Source #

The name of the subnet group.

createSubnetGroup_subnetIds :: Lens' CreateSubnetGroup [Text] Source #

A list of VPC subnet IDs for the subnet group.

createSubnetGroupResponse_subnetGroup :: Lens' CreateSubnetGroupResponse (Maybe SubnetGroup) Source #

The newly-created subnet group

createSubnetGroupResponse_httpStatus :: Lens' CreateSubnetGroupResponse Int Source #

The response's http status code.

CreateUser

createUser_tags :: Lens' CreateUser (Maybe [Tag]) Source #

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

createUser_userName :: Lens' CreateUser Text Source #

The name of the user. This value must be unique as it also serves as the user identifier.

createUser_authenticationMode :: Lens' CreateUser AuthenticationMode Source #

Denotes the user's authentication properties, such as whether it requires a password to authenticate.

createUser_accessString :: Lens' CreateUser Text Source #

Access permissions string used for this user.

createUserResponse_user :: Lens' CreateUserResponse (Maybe User) Source #

The newly-created user.

createUserResponse_httpStatus :: Lens' CreateUserResponse Int Source #

The response's http status code.

DeleteACL

deleteACL_aCLName :: Lens' DeleteACL Text Source #

The name of the Access Control List to delete

deleteACLResponse_acl :: Lens' DeleteACLResponse (Maybe ACL) Source #

The Access Control List object that has been deleted.

deleteACLResponse_httpStatus :: Lens' DeleteACLResponse Int Source #

The response's http status code.

DeleteCluster

deleteCluster_finalSnapshotName :: Lens' DeleteCluster (Maybe Text) Source #

The user-supplied name of a final cluster snapshot. This is the unique name that identifies the snapshot. MemoryDB creates the snapshot, and then deletes the cluster immediately afterward.

deleteCluster_clusterName :: Lens' DeleteCluster Text Source #

The name of the cluster to be deleted

deleteClusterResponse_cluster :: Lens' DeleteClusterResponse (Maybe Cluster) Source #

The cluster object that has been deleted

deleteClusterResponse_httpStatus :: Lens' DeleteClusterResponse Int Source #

The response's http status code.

DeleteParameterGroup

deleteParameterGroup_parameterGroupName :: Lens' DeleteParameterGroup Text Source #

The name of the parameter group to delete.

deleteParameterGroupResponse_parameterGroup :: Lens' DeleteParameterGroupResponse (Maybe ParameterGroup) Source #

The parameter group that has been deleted.

deleteParameterGroupResponse_httpStatus :: Lens' DeleteParameterGroupResponse Int Source #

The response's http status code.

DeleteSnapshot

deleteSnapshot_snapshotName :: Lens' DeleteSnapshot Text Source #

The name of the snapshot to delete

deleteSnapshotResponse_snapshot :: Lens' DeleteSnapshotResponse (Maybe Snapshot) Source #

The snapshot object that has been deleted.

deleteSnapshotResponse_httpStatus :: Lens' DeleteSnapshotResponse Int Source #

The response's http status code.

DeleteSubnetGroup

deleteSubnetGroup_subnetGroupName :: Lens' DeleteSubnetGroup Text Source #

The name of the subnet group to delete

deleteSubnetGroupResponse_subnetGroup :: Lens' DeleteSubnetGroupResponse (Maybe SubnetGroup) Source #

The subnet group object that has been deleted.

deleteSubnetGroupResponse_httpStatus :: Lens' DeleteSubnetGroupResponse Int Source #

The response's http status code.

DeleteUser

deleteUser_userName :: Lens' DeleteUser Text Source #

The name of the user to delete

deleteUserResponse_user :: Lens' DeleteUserResponse (Maybe User) Source #

The user object that has been deleted.

deleteUserResponse_httpStatus :: Lens' DeleteUserResponse Int Source #

The response's http status code.

DescribeACLs

describeACLs_aCLName :: Lens' DescribeACLs (Maybe Text) Source #

The name of the ACL

describeACLs_maxResults :: Lens' DescribeACLs (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

describeACLs_nextToken :: Lens' DescribeACLs (Maybe Text) Source #

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

describeACLsResponse_aCLs :: Lens' DescribeACLsResponse (Maybe [ACL]) Source #

The list of ACLs

describeACLsResponse_nextToken :: Lens' DescribeACLsResponse (Maybe Text) Source #

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

describeACLsResponse_httpStatus :: Lens' DescribeACLsResponse Int Source #

The response's http status code.

DescribeClusters

describeClusters_clusterName :: Lens' DescribeClusters (Maybe Text) Source #

The name of the cluster

describeClusters_maxResults :: Lens' DescribeClusters (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

describeClusters_nextToken :: Lens' DescribeClusters (Maybe Text) Source #

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

describeClusters_showShardDetails :: Lens' DescribeClusters (Maybe Bool) Source #

An optional flag that can be included in the request to retrieve information about the individual shard(s).

describeClustersResponse_clusters :: Lens' DescribeClustersResponse (Maybe [Cluster]) Source #

A list of clusters

describeClustersResponse_nextToken :: Lens' DescribeClustersResponse (Maybe Text) Source #

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

describeClustersResponse_httpStatus :: Lens' DescribeClustersResponse Int Source #

The response's http status code.

DescribeEngineVersions

describeEngineVersions_defaultOnly :: Lens' DescribeEngineVersions (Maybe Bool) Source #

If true, specifies that only the default version of the specified engine or engine and major version combination is to be returned.

describeEngineVersions_engineVersion :: Lens' DescribeEngineVersions (Maybe Text) Source #

The Redis engine version

describeEngineVersions_maxResults :: Lens' DescribeEngineVersions (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

describeEngineVersions_nextToken :: Lens' DescribeEngineVersions (Maybe Text) Source #

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

describeEngineVersions_parameterGroupFamily :: Lens' DescribeEngineVersions (Maybe Text) Source #

The name of a specific parameter group family to return details for.

describeEngineVersionsResponse_engineVersions :: Lens' DescribeEngineVersionsResponse (Maybe [EngineVersionInfo]) Source #

A list of engine version details. Each element in the list contains detailed information about one engine version.

describeEngineVersionsResponse_nextToken :: Lens' DescribeEngineVersionsResponse (Maybe Text) Source #

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

describeEngineVersionsResponse_httpStatus :: Lens' DescribeEngineVersionsResponse Int Source #

The response's http status code.

DescribeEvents

describeEvents_duration :: Lens' DescribeEvents (Maybe Int) Source #

The number of minutes worth of events to retrieve.

describeEvents_endTime :: Lens' DescribeEvents (Maybe UTCTime) Source #

The end of the time interval for which to retrieve events, specified in ISO 8601 format. Example: 2017-03-30T07:03:49.555Z

describeEvents_maxResults :: Lens' DescribeEvents (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

describeEvents_nextToken :: Lens' DescribeEvents (Maybe Text) Source #

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

describeEvents_sourceName :: Lens' DescribeEvents (Maybe Text) Source #

The identifier of the event source for which events are returned. If not specified, all sources are included in the response.

describeEvents_sourceType :: Lens' DescribeEvents (Maybe SourceType) Source #

The event source to retrieve events for. If no value is specified, all events are returned.

describeEvents_startTime :: Lens' DescribeEvents (Maybe UTCTime) Source #

The beginning of the time interval to retrieve events for, specified in ISO 8601 format. Example: 2017-03-30T07:03:49.555Z

describeEventsResponse_events :: Lens' DescribeEventsResponse (Maybe [Event]) Source #

A list of events. Each element in the list contains detailed information about one event.

describeEventsResponse_nextToken :: Lens' DescribeEventsResponse (Maybe Text) Source #

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

describeEventsResponse_httpStatus :: Lens' DescribeEventsResponse Int Source #

The response's http status code.

DescribeParameterGroups

describeParameterGroups_maxResults :: Lens' DescribeParameterGroups (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

describeParameterGroups_nextToken :: Lens' DescribeParameterGroups (Maybe Text) Source #

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

describeParameterGroups_parameterGroupName :: Lens' DescribeParameterGroups (Maybe Text) Source #

The name of a specific parameter group to return details for.

describeParameterGroupsResponse_nextToken :: Lens' DescribeParameterGroupsResponse (Maybe Text) Source #

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

describeParameterGroupsResponse_parameterGroups :: Lens' DescribeParameterGroupsResponse (Maybe [ParameterGroup]) Source #

A list of parameter groups. Each element in the list contains detailed information about one parameter group.

describeParameterGroupsResponse_httpStatus :: Lens' DescribeParameterGroupsResponse Int Source #

The response's http status code.

DescribeParameters

describeParameters_maxResults :: Lens' DescribeParameters (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

describeParameters_nextToken :: Lens' DescribeParameters (Maybe Text) Source #

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

describeParameters_parameterGroupName :: Lens' DescribeParameters Text Source #

he name of a specific parameter group to return details for.

describeParametersResponse_nextToken :: Lens' DescribeParametersResponse (Maybe Text) Source #

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

describeParametersResponse_parameters :: Lens' DescribeParametersResponse (Maybe [Parameter]) Source #

A list of parameters specific to a particular parameter group. Each element in the list contains detailed information about one parameter.

describeParametersResponse_httpStatus :: Lens' DescribeParametersResponse Int Source #

The response's http status code.

DescribeReservedNodes

describeReservedNodes_duration :: Lens' DescribeReservedNodes (Maybe Text) Source #

The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this duration.

describeReservedNodes_maxResults :: Lens' DescribeReservedNodes (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

describeReservedNodes_nextToken :: Lens' DescribeReservedNodes (Maybe Text) Source #

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeReservedNodes_nodeType :: Lens' DescribeReservedNodes (Maybe Text) Source #

The node type filter value. Use this parameter to show only those reservations matching the specified node type. For more information, see Supported node types.

describeReservedNodes_offeringType :: Lens' DescribeReservedNodes (Maybe Text) Source #

The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type. Valid values: "All Upfront"|"Partial Upfront"| "No Upfront"

describeReservedNodes_reservationId :: Lens' DescribeReservedNodes (Maybe Text) Source #

The reserved node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.

describeReservedNodes_reservedNodesOfferingId :: Lens' DescribeReservedNodes (Maybe Text) Source #

The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.

describeReservedNodesResponse_nextToken :: Lens' DescribeReservedNodesResponse (Maybe Text) Source #

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeReservedNodesResponse_reservedNodes :: Lens' DescribeReservedNodesResponse (Maybe [ReservedNode]) Source #

Returns information about reserved nodes for this account, or about a specified reserved node.

describeReservedNodesResponse_httpStatus :: Lens' DescribeReservedNodesResponse Int Source #

The response's http status code.

DescribeReservedNodesOfferings

describeReservedNodesOfferings_duration :: Lens' DescribeReservedNodesOfferings (Maybe Text) Source #

Duration filter value, specified in years or seconds. Use this parameter to show only reservations for a given duration.

describeReservedNodesOfferings_maxResults :: Lens' DescribeReservedNodesOfferings (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

describeReservedNodesOfferings_nextToken :: Lens' DescribeReservedNodesOfferings (Maybe Text) Source #

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeReservedNodesOfferings_nodeType :: Lens' DescribeReservedNodesOfferings (Maybe Text) Source #

The node type for the reserved nodes. For more information, see Supported node types.

describeReservedNodesOfferings_offeringType :: Lens' DescribeReservedNodesOfferings (Maybe Text) Source #

The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type. Valid values: "All Upfront"|"Partial Upfront"| "No Upfront"

describeReservedNodesOfferings_reservedNodesOfferingId :: Lens' DescribeReservedNodesOfferings (Maybe Text) Source #

The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.

describeReservedNodesOfferingsResponse_nextToken :: Lens' DescribeReservedNodesOfferingsResponse (Maybe Text) Source #

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeReservedNodesOfferingsResponse_reservedNodesOfferings :: Lens' DescribeReservedNodesOfferingsResponse (Maybe [ReservedNodesOffering]) Source #

Lists available reserved node offerings.

describeReservedNodesOfferingsResponse_httpStatus :: Lens' DescribeReservedNodesOfferingsResponse Int Source #

The response's http status code.

DescribeServiceUpdates

describeServiceUpdates_clusterNames :: Lens' DescribeServiceUpdates (Maybe [Text]) Source #

The list of cluster names to identify service updates to apply

describeServiceUpdates_maxResults :: Lens' DescribeServiceUpdates (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

describeServiceUpdates_nextToken :: Lens' DescribeServiceUpdates (Maybe Text) Source #

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

describeServiceUpdates_serviceUpdateName :: Lens' DescribeServiceUpdates (Maybe Text) Source #

The unique ID of the service update to describe.

describeServiceUpdates_status :: Lens' DescribeServiceUpdates (Maybe [ServiceUpdateStatus]) Source #

The status(es) of the service updates to filter on

describeServiceUpdatesResponse_nextToken :: Lens' DescribeServiceUpdatesResponse (Maybe Text) Source #

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

describeServiceUpdatesResponse_serviceUpdates :: Lens' DescribeServiceUpdatesResponse (Maybe [ServiceUpdate]) Source #

A list of service updates

describeServiceUpdatesResponse_httpStatus :: Lens' DescribeServiceUpdatesResponse Int Source #

The response's http status code.

DescribeSnapshots

describeSnapshots_clusterName :: Lens' DescribeSnapshots (Maybe Text) Source #

A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.

describeSnapshots_maxResults :: Lens' DescribeSnapshots (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

describeSnapshots_nextToken :: Lens' DescribeSnapshots (Maybe Text) Source #

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

describeSnapshots_showDetail :: Lens' DescribeSnapshots (Maybe Bool) Source #

A Boolean value which if true, the shard configuration is included in the snapshot description.

describeSnapshots_snapshotName :: Lens' DescribeSnapshots (Maybe Text) Source #

A user-supplied name of the snapshot. If this parameter is specified, only this named snapshot is described.

describeSnapshots_source :: Lens' DescribeSnapshots (Maybe Text) Source #

If set to system, the output shows snapshots that were automatically created by MemoryDB. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.

describeSnapshotsResponse_nextToken :: Lens' DescribeSnapshotsResponse (Maybe Text) Source #

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

describeSnapshotsResponse_snapshots :: Lens' DescribeSnapshotsResponse (Maybe [Snapshot]) Source #

A list of snapshots. Each item in the list contains detailed information about one snapshot.

describeSnapshotsResponse_httpStatus :: Lens' DescribeSnapshotsResponse Int Source #

The response's http status code.

DescribeSubnetGroups

describeSubnetGroups_maxResults :: Lens' DescribeSubnetGroups (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

describeSubnetGroups_nextToken :: Lens' DescribeSubnetGroups (Maybe Text) Source #

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

describeSubnetGroups_subnetGroupName :: Lens' DescribeSubnetGroups (Maybe Text) Source #

The name of the subnet group to return details for.

describeSubnetGroupsResponse_nextToken :: Lens' DescribeSubnetGroupsResponse (Maybe Text) Source #

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

describeSubnetGroupsResponse_subnetGroups :: Lens' DescribeSubnetGroupsResponse (Maybe [SubnetGroup]) Source #

A list of subnet groups. Each element in the list contains detailed information about one group.

describeSubnetGroupsResponse_httpStatus :: Lens' DescribeSubnetGroupsResponse Int Source #

The response's http status code.

DescribeUsers

describeUsers_filters :: Lens' DescribeUsers (Maybe [Filter]) Source #

Filter to determine the list of users to return.

describeUsers_maxResults :: Lens' DescribeUsers (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

describeUsers_nextToken :: Lens' DescribeUsers (Maybe Text) Source #

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

describeUsers_userName :: Lens' DescribeUsers (Maybe Text) Source #

The name of the user

describeUsersResponse_nextToken :: Lens' DescribeUsersResponse (Maybe Text) Source #

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

describeUsersResponse_users :: Lens' DescribeUsersResponse (Maybe [User]) Source #

A list of users.

describeUsersResponse_httpStatus :: Lens' DescribeUsersResponse Int Source #

The response's http status code.

FailoverShard

failoverShard_clusterName :: Lens' FailoverShard Text Source #

The cluster being failed over

failoverShard_shardName :: Lens' FailoverShard Text Source #

The name of the shard

failoverShardResponse_cluster :: Lens' FailoverShardResponse (Maybe Cluster) Source #

The cluster being failed over

failoverShardResponse_httpStatus :: Lens' FailoverShardResponse Int Source #

The response's http status code.

ListAllowedNodeTypeUpdates

listAllowedNodeTypeUpdates_clusterName :: Lens' ListAllowedNodeTypeUpdates Text Source #

The name of the cluster you want to scale. MemoryDB uses the cluster name to identify the current node type being used by this cluster, and from that to create a list of node types you can scale up to.

listAllowedNodeTypeUpdatesResponse_scaleDownNodeTypes :: Lens' ListAllowedNodeTypeUpdatesResponse (Maybe [Text]) Source #

A list node types which you can use to scale down your cluster.

listAllowedNodeTypeUpdatesResponse_scaleUpNodeTypes :: Lens' ListAllowedNodeTypeUpdatesResponse (Maybe [Text]) Source #

A list node types which you can use to scale up your cluster.

listAllowedNodeTypeUpdatesResponse_httpStatus :: Lens' ListAllowedNodeTypeUpdatesResponse Int Source #

The response's http status code.

ListTags

listTags_resourceArn :: Lens' ListTags Text Source #

The Amazon Resource Name (ARN) of the resource for which you want the list of tags

listTagsResponse_tagList :: Lens' ListTagsResponse (Maybe [Tag]) Source #

A list of tags as key-value pairs.

listTagsResponse_httpStatus :: Lens' ListTagsResponse Int Source #

The response's http status code.

PurchaseReservedNodesOffering

purchaseReservedNodesOffering_nodeCount :: Lens' PurchaseReservedNodesOffering (Maybe Int) Source #

The number of node instances to reserve.

purchaseReservedNodesOffering_reservationId :: Lens' PurchaseReservedNodesOffering (Maybe Text) Source #

A customer-specified identifier to track this reservation.

purchaseReservedNodesOffering_tags :: Lens' PurchaseReservedNodesOffering (Maybe [Tag]) Source #

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

purchaseReservedNodesOffering_reservedNodesOfferingId :: Lens' PurchaseReservedNodesOffering Text Source #

The ID of the reserved node offering to purchase.

purchaseReservedNodesOfferingResponse_reservedNode :: Lens' PurchaseReservedNodesOfferingResponse (Maybe ReservedNode) Source #

Represents the output of a PurchaseReservedNodesOffering operation.

purchaseReservedNodesOfferingResponse_httpStatus :: Lens' PurchaseReservedNodesOfferingResponse Int Source #

The response's http status code.

ResetParameterGroup

resetParameterGroup_allParameters :: Lens' ResetParameterGroup (Maybe Bool) Source #

If true, all parameters in the parameter group are reset to their default values. If false, only the parameters listed by ParameterNames are reset to their default values.

resetParameterGroup_parameterNames :: Lens' ResetParameterGroup (Maybe [Text]) Source #

An array of parameter names to reset to their default values. If AllParameters is true, do not use ParameterNames. If AllParameters is false, you must specify the name of at least one parameter to reset.

resetParameterGroup_parameterGroupName :: Lens' ResetParameterGroup Text Source #

The name of the parameter group to reset.

resetParameterGroupResponse_parameterGroup :: Lens' ResetParameterGroupResponse (Maybe ParameterGroup) Source #

The parameter group being reset.

resetParameterGroupResponse_httpStatus :: Lens' ResetParameterGroupResponse Int Source #

The response's http status code.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) of the resource to which the tags are to be added

tagResource_tags :: Lens' TagResource [Tag] Source #

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

tagResourceResponse_tagList :: Lens' TagResourceResponse (Maybe [Tag]) Source #

A list of tags as key-value pairs.

tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #

The response's http status code.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) of the resource to which the tags are to be removed

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

The list of keys of the tags that are to be removed

untagResourceResponse_tagList :: Lens' UntagResourceResponse (Maybe [Tag]) Source #

The list of tags removed

untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int Source #

The response's http status code.

UpdateACL

updateACL_userNamesToAdd :: Lens' UpdateACL (Maybe (NonEmpty Text)) Source #

The list of users to add to the Access Control List

updateACL_userNamesToRemove :: Lens' UpdateACL (Maybe (NonEmpty Text)) Source #

The list of users to remove from the Access Control List

updateACL_aCLName :: Lens' UpdateACL Text Source #

The name of the Access Control List

updateACLResponse_acl :: Lens' UpdateACLResponse (Maybe ACL) Source #

The updated Access Control List

updateACLResponse_httpStatus :: Lens' UpdateACLResponse Int Source #

The response's http status code.

UpdateCluster

updateCluster_aCLName :: Lens' UpdateCluster (Maybe Text) Source #

The Access Control List that is associated with the cluster

updateCluster_description :: Lens' UpdateCluster (Maybe Text) Source #

The description of the cluster to update

updateCluster_engineVersion :: Lens' UpdateCluster (Maybe Text) Source #

The upgraded version of the engine to be run on the nodes. You can upgrade to a newer engine version, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster and create it anew with the earlier engine version.

updateCluster_maintenanceWindow :: Lens' UpdateCluster (Maybe Text) Source #

Specifies the weekly time range during which maintenance on the 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:23:00-mon:01:30

updateCluster_nodeType :: Lens' UpdateCluster (Maybe Text) Source #

A valid node type that you want to scale this cluster up or down to.

updateCluster_parameterGroupName :: Lens' UpdateCluster (Maybe Text) Source #

The name of the parameter group to update

updateCluster_replicaConfiguration :: Lens' UpdateCluster (Maybe ReplicaConfigurationRequest) Source #

The number of replicas that will reside in each shard

updateCluster_securityGroupIds :: Lens' UpdateCluster (Maybe [Text]) Source #

The SecurityGroupIds to update

updateCluster_shardConfiguration :: Lens' UpdateCluster (Maybe ShardConfigurationRequest) Source #

The number of shards in the cluster

updateCluster_snapshotRetentionLimit :: Lens' UpdateCluster (Maybe Int) Source #

The number of days for which MemoryDB retains automatic cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

updateCluster_snapshotWindow :: Lens' UpdateCluster (Maybe Text) Source #

The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster.

updateCluster_snsTopicArn :: Lens' UpdateCluster (Maybe Text) Source #

The SNS topic ARN to update

updateCluster_snsTopicStatus :: Lens' UpdateCluster (Maybe Text) Source #

The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.

updateCluster_clusterName :: Lens' UpdateCluster Text Source #

The name of the cluster to update

updateClusterResponse_cluster :: Lens' UpdateClusterResponse (Maybe Cluster) Source #

The updated cluster

updateClusterResponse_httpStatus :: Lens' UpdateClusterResponse Int Source #

The response's http status code.

UpdateParameterGroup

updateParameterGroup_parameterGroupName :: Lens' UpdateParameterGroup Text Source #

The name of the parameter group to update.

updateParameterGroup_parameterNameValues :: Lens' UpdateParameterGroup [ParameterNameValue] Source #

An array of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional. A maximum of 20 parameters may be updated per request.

updateParameterGroupResponse_parameterGroup :: Lens' UpdateParameterGroupResponse (Maybe ParameterGroup) Source #

The updated parameter group

updateParameterGroupResponse_httpStatus :: Lens' UpdateParameterGroupResponse Int Source #

The response's http status code.

UpdateSubnetGroup

updateSubnetGroup_description :: Lens' UpdateSubnetGroup (Maybe Text) Source #

A description of the subnet group

updateSubnetGroup_subnetIds :: Lens' UpdateSubnetGroup (Maybe [Text]) Source #

The EC2 subnet IDs for the subnet group.

updateSubnetGroup_subnetGroupName :: Lens' UpdateSubnetGroup Text Source #

The name of the subnet group

updateSubnetGroupResponse_subnetGroup :: Lens' UpdateSubnetGroupResponse (Maybe SubnetGroup) Source #

The updated subnet group

updateSubnetGroupResponse_httpStatus :: Lens' UpdateSubnetGroupResponse Int Source #

The response's http status code.

UpdateUser

updateUser_accessString :: Lens' UpdateUser (Maybe Text) Source #

Access permissions string used for this user.

updateUser_authenticationMode :: Lens' UpdateUser (Maybe AuthenticationMode) Source #

Denotes the user's authentication properties, such as whether it requires a password to authenticate.

updateUser_userName :: Lens' UpdateUser Text Source #

The name of the user

updateUserResponse_user :: Lens' UpdateUserResponse (Maybe User) Source #

The updated user

updateUserResponse_httpStatus :: Lens' UpdateUserResponse Int Source #

The response's http status code.

Types

ACL

acl_arn :: Lens' ACL (Maybe Text) Source #

The Amazon Resource Name (ARN) of the ACL

acl_clusters :: Lens' ACL (Maybe [Text]) Source #

A list of clusters associated with the ACL.

acl_minimumEngineVersion :: Lens' ACL (Maybe Text) Source #

The minimum engine version supported for the ACL

acl_name :: Lens' ACL (Maybe Text) Source #

The name of the Access Control List

acl_pendingChanges :: Lens' ACL (Maybe ACLPendingChanges) Source #

A list of updates being applied to the ACL.

acl_status :: Lens' ACL (Maybe Text) Source #

Indicates ACL status. Can be "creating", "active", "modifying", "deleting".

acl_userNames :: Lens' ACL (Maybe [Text]) Source #

The list of user names that belong to the ACL.

ACLPendingChanges

aCLPendingChanges_userNamesToAdd :: Lens' ACLPendingChanges (Maybe [Text]) Source #

A list of users being added to the ACL

aCLPendingChanges_userNamesToRemove :: Lens' ACLPendingChanges (Maybe [Text]) Source #

A list of user names being removed from the ACL

ACLsUpdateStatus

aCLsUpdateStatus_aCLToApply :: Lens' ACLsUpdateStatus (Maybe Text) Source #

A list of ACLs pending to be applied.

Authentication

authentication_passwordCount :: Lens' Authentication (Maybe Int) Source #

The number of passwords belonging to the user. The maximum is two.

authentication_type :: Lens' Authentication (Maybe AuthenticationType) Source #

Indicates whether the user requires a password to authenticate.

AuthenticationMode

authenticationMode_passwords :: Lens' AuthenticationMode (Maybe (NonEmpty Text)) Source #

The password(s) used for authentication

authenticationMode_type :: Lens' AuthenticationMode (Maybe InputAuthenticationType) Source #

Indicates whether the user requires a password to authenticate. All newly-created users require a password.

AvailabilityZone

availabilityZone_name :: Lens' AvailabilityZone (Maybe Text) Source #

The name of the Availability Zone.

Cluster

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

The name of the Access Control List associated with this cluster.

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

The Amazon Resource Name (ARN) of the cluster.

cluster_autoMinorVersionUpgrade :: Lens' Cluster (Maybe Bool) Source #

When set to true, the cluster will automatically receive minor engine version upgrades after launch.

cluster_availabilityMode :: Lens' Cluster (Maybe AZStatus) Source #

Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).

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

The cluster's configuration endpoint

cluster_dataTiering :: Lens' Cluster (Maybe DataTieringStatus) Source #

Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.

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

A description of the cluster

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

The Redis engine patch version used by the cluster

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

The Redis engine version used by the cluster

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

The ID of the KMS key used to encrypt the cluster

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

Specifies the weekly time range during which maintenance on the 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.

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

The user-supplied name of the cluster. This identifier is a unique key that identifies a cluster.

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

The cluster's node type

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

The number of shards in the cluster

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

The name of the parameter group used by the cluster

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

The status of the parameter group used by the cluster, for example 'active' or 'applying'.

cluster_pendingUpdates :: Lens' Cluster (Maybe ClusterPendingUpdates) Source #

A group of settings that are currently being applied.

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

A list of security groups used by the cluster

cluster_shards :: Lens' Cluster (Maybe [Shard]) Source #

A list of shards that are members of the cluster.

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

The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

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

The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.

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

The Amazon Resource Name (ARN) of the SNS notification topic

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

The SNS topic must be in Active status to receive notifications

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

The status of the cluster. For example, Available, Updating, Creating.

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

The name of the subnet group used by the cluster

cluster_tLSEnabled :: Lens' Cluster (Maybe Bool) Source #

A flag to indicate if In-transit encryption is enabled

ClusterConfiguration

clusterConfiguration_description :: Lens' ClusterConfiguration (Maybe Text) Source #

The description of the cluster configuration

clusterConfiguration_engineVersion :: Lens' ClusterConfiguration (Maybe Text) Source #

The Redis engine version used by the cluster

clusterConfiguration_maintenanceWindow :: Lens' ClusterConfiguration (Maybe Text) Source #

The specified maintenance window for the cluster

clusterConfiguration_name :: Lens' ClusterConfiguration (Maybe Text) Source #

The name of the cluster

clusterConfiguration_nodeType :: Lens' ClusterConfiguration (Maybe Text) Source #

The node type used for the cluster

clusterConfiguration_numShards :: Lens' ClusterConfiguration (Maybe Int) Source #

The number of shards in the cluster

clusterConfiguration_parameterGroupName :: Lens' ClusterConfiguration (Maybe Text) Source #

The name of parameter group used by the cluster

clusterConfiguration_port :: Lens' ClusterConfiguration (Maybe Int) Source #

The port used by the cluster

clusterConfiguration_shards :: Lens' ClusterConfiguration (Maybe [ShardDetail]) Source #

The list of shards in the cluster

clusterConfiguration_snapshotRetentionLimit :: Lens' ClusterConfiguration (Maybe Int) Source #

The snapshot retention limit set by the cluster

clusterConfiguration_snapshotWindow :: Lens' ClusterConfiguration (Maybe Text) Source #

The snapshot window set by the cluster

clusterConfiguration_subnetGroupName :: Lens' ClusterConfiguration (Maybe Text) Source #

The name of the subnet group used by the cluster

clusterConfiguration_topicArn :: Lens' ClusterConfiguration (Maybe Text) Source #

The Amazon Resource Name (ARN) of the SNS notification topic for the cluster

clusterConfiguration_vpcId :: Lens' ClusterConfiguration (Maybe Text) Source #

The ID of the VPC the cluster belongs to

ClusterPendingUpdates

clusterPendingUpdates_aCLs :: Lens' ClusterPendingUpdates (Maybe ACLsUpdateStatus) Source #

A list of ACLs associated with the cluster that are being updated

clusterPendingUpdates_resharding :: Lens' ClusterPendingUpdates (Maybe ReshardingStatus) Source #

The status of an online resharding operation.

clusterPendingUpdates_serviceUpdates :: Lens' ClusterPendingUpdates (Maybe [PendingModifiedServiceUpdate]) Source #

A list of service updates being applied to the cluster

Endpoint

endpoint_address :: Lens' Endpoint (Maybe Text) Source #

The DNS hostname of the node.

endpoint_port :: Lens' Endpoint (Maybe Int) Source #

The port number that the engine is listening on.

EngineVersionInfo

engineVersionInfo_enginePatchVersion :: Lens' EngineVersionInfo (Maybe Text) Source #

The patched engine version

engineVersionInfo_engineVersion :: Lens' EngineVersionInfo (Maybe Text) Source #

The engine version

engineVersionInfo_parameterGroupFamily :: Lens' EngineVersionInfo (Maybe Text) Source #

Specifies the name of the parameter group family to which the engine default parameters apply.

Event

event_date :: Lens' Event (Maybe UTCTime) Source #

The date and time when the event occurred.

event_message :: Lens' Event (Maybe Text) Source #

The text of the event.

event_sourceName :: Lens' Event (Maybe Text) Source #

The name for the source of the event. For example, if the event occurred at the cluster level, the identifier would be the name of the cluster.

event_sourceType :: Lens' Event (Maybe SourceType) Source #

Specifies the origin of this event - a cluster, a parameter group, a security group, etc.

Filter

filter_name :: Lens' Filter Text Source #

The property being filtered. For example, UserName.

filter_values :: Lens' Filter (NonEmpty Text) Source #

The property values to filter on. For example, "user-123".

Node

node_availabilityZone :: Lens' Node (Maybe Text) Source #

The Availability Zone in which the node resides

node_createTime :: Lens' Node (Maybe UTCTime) Source #

The date and time when the node was created.

node_endpoint :: Lens' Node (Maybe Endpoint) Source #

The hostname for connecting to this node.

node_name :: Lens' Node (Maybe Text) Source #

The node identifier. A node name is a numeric identifier (0001, 0002, etc.). The combination of cluster name, shard name and node name uniquely identifies every node used in a customer's Amazon account.

node_status :: Lens' Node (Maybe Text) Source #

The status of the service update on the node

Parameter

parameter_allowedValues :: Lens' Parameter (Maybe Text) Source #

The valid range of values for the parameter.

parameter_dataType :: Lens' Parameter (Maybe Text) Source #

The parameter's data type

parameter_description :: Lens' Parameter (Maybe Text) Source #

A description of the parameter

parameter_minimumEngineVersion :: Lens' Parameter (Maybe Text) Source #

The earliest engine version to which the parameter can apply.

parameter_name :: Lens' Parameter (Maybe Text) Source #

The name of the parameter

parameter_value :: Lens' Parameter (Maybe Text) Source #

The value of the parameter

ParameterGroup

parameterGroup_arn :: Lens' ParameterGroup (Maybe Text) Source #

The Amazon Resource Name (ARN) of the parameter group

parameterGroup_description :: Lens' ParameterGroup (Maybe Text) Source #

A description of the parameter group

parameterGroup_family :: Lens' ParameterGroup (Maybe Text) Source #

The name of the parameter group family that this parameter group is compatible with.

parameterGroup_name :: Lens' ParameterGroup (Maybe Text) Source #

The name of the parameter group

ParameterNameValue

parameterNameValue_parameterName :: Lens' ParameterNameValue (Maybe Text) Source #

The name of the parameter

parameterNameValue_parameterValue :: Lens' ParameterNameValue (Maybe Text) Source #

The value of the parameter

PendingModifiedServiceUpdate

pendingModifiedServiceUpdate_serviceUpdateName :: Lens' PendingModifiedServiceUpdate (Maybe Text) Source #

The unique ID of the service update

pendingModifiedServiceUpdate_status :: Lens' PendingModifiedServiceUpdate (Maybe ServiceUpdateStatus) Source #

The status of the service update

RecurringCharge

recurringCharge_recurringChargeAmount :: Lens' RecurringCharge (Maybe Double) Source #

The amount of the recurring charge to run this reserved node.

recurringCharge_recurringChargeFrequency :: Lens' RecurringCharge (Maybe Text) Source #

The frequency of the recurring price charged to run this reserved node.

ReplicaConfigurationRequest

replicaConfigurationRequest_replicaCount :: Lens' ReplicaConfigurationRequest (Maybe Int) Source #

The number of replicas to scale up or down to

ReservedNode

reservedNode_arn :: Lens' ReservedNode (Maybe Text) Source #

The Amazon Resource Name (ARN) of the reserved node.

reservedNode_duration :: Lens' ReservedNode (Maybe Int) Source #

The duration of the reservation in seconds.

reservedNode_fixedPrice :: Lens' ReservedNode (Maybe Double) Source #

The fixed price charged for this reserved node.

reservedNode_nodeCount :: Lens' ReservedNode (Maybe Int) Source #

The number of nodes that have been reserved.

reservedNode_nodeType :: Lens' ReservedNode (Maybe Text) Source #

The node type for the reserved nodes.

reservedNode_offeringType :: Lens' ReservedNode (Maybe Text) Source #

The offering type of this reserved node.

reservedNode_recurringCharges :: Lens' ReservedNode (Maybe [RecurringCharge]) Source #

The recurring price charged to run this reserved node.

reservedNode_reservationId :: Lens' ReservedNode (Maybe Text) Source #

A customer-specified identifier to track this reservation.

reservedNode_reservedNodesOfferingId :: Lens' ReservedNode (Maybe Text) Source #

The ID of the reserved node offering to purchase.

reservedNode_startTime :: Lens' ReservedNode (Maybe UTCTime) Source #

The time the reservation started.

reservedNode_state :: Lens' ReservedNode (Maybe Text) Source #

The state of the reserved node.

ReservedNodesOffering

reservedNodesOffering_duration :: Lens' ReservedNodesOffering (Maybe Int) Source #

The duration of the reservation in seconds.

reservedNodesOffering_fixedPrice :: Lens' ReservedNodesOffering (Maybe Double) Source #

The fixed price charged for this reserved node.

reservedNodesOffering_nodeType :: Lens' ReservedNodesOffering (Maybe Text) Source #

The node type for the reserved nodes. For more information, see Supported node types.

reservedNodesOffering_offeringType :: Lens' ReservedNodesOffering (Maybe Text) Source #

The offering type of this reserved node.

reservedNodesOffering_recurringCharges :: Lens' ReservedNodesOffering (Maybe [RecurringCharge]) Source #

The recurring price charged to run this reserved node.

reservedNodesOffering_reservedNodesOfferingId :: Lens' ReservedNodesOffering (Maybe Text) Source #

The offering identifier.

ReshardingStatus

reshardingStatus_slotMigration :: Lens' ReshardingStatus (Maybe SlotMigration) Source #

The status of the online resharding slot migration

SecurityGroupMembership

securityGroupMembership_securityGroupId :: Lens' SecurityGroupMembership (Maybe Text) Source #

The identifier of the security group.

securityGroupMembership_status :: Lens' SecurityGroupMembership (Maybe Text) Source #

The status of the security group membership. The status changes whenever a security group is modified, or when the security groups assigned to a cluster are modified.

ServiceUpdate

serviceUpdate_autoUpdateStartDate :: Lens' ServiceUpdate (Maybe UTCTime) Source #

The date at which the service update will be automatically applied

serviceUpdate_clusterName :: Lens' ServiceUpdate (Maybe Text) Source #

The name of the cluster to which the service update applies

serviceUpdate_description :: Lens' ServiceUpdate (Maybe Text) Source #

Provides details of the service update

serviceUpdate_nodesUpdated :: Lens' ServiceUpdate (Maybe Text) Source #

A list of nodes updated by the service update

serviceUpdate_releaseDate :: Lens' ServiceUpdate (Maybe UTCTime) Source #

The date when the service update is initially available

serviceUpdate_serviceUpdateName :: Lens' ServiceUpdate (Maybe Text) Source #

The unique ID of the service update

serviceUpdate_status :: Lens' ServiceUpdate (Maybe ServiceUpdateStatus) Source #

The status of the service update

serviceUpdate_type :: Lens' ServiceUpdate (Maybe ServiceUpdateType) Source #

Reflects the nature of the service update

ServiceUpdateRequest

serviceUpdateRequest_serviceUpdateNameToApply :: Lens' ServiceUpdateRequest (Maybe Text) Source #

The unique ID of the service update

Shard

shard_name :: Lens' Shard (Maybe Text) Source #

The name of the shard

shard_nodes :: Lens' Shard (Maybe [Node]) Source #

A list containing information about individual nodes within the shard

shard_numberOfNodes :: Lens' Shard (Maybe Int) Source #

The number of nodes in the shard

shard_slots :: Lens' Shard (Maybe Text) Source #

The keyspace for this shard.

shard_status :: Lens' Shard (Maybe Text) Source #

The current state of this replication group - creating, available, modifying, deleting.

ShardConfiguration

shardConfiguration_replicaCount :: Lens' ShardConfiguration (Maybe Int) Source #

The number of read replica nodes in this shard.

shardConfiguration_slots :: Lens' ShardConfiguration (Maybe Text) Source #

A string that specifies the keyspace for a particular node group. Keyspaces range from 0 to 16,383. The string is in the format startkey-endkey.

ShardConfigurationRequest

shardConfigurationRequest_shardCount :: Lens' ShardConfigurationRequest (Maybe Int) Source #

The number of shards in the cluster

ShardDetail

shardDetail_configuration :: Lens' ShardDetail (Maybe ShardConfiguration) Source #

The configuration details of the shard

shardDetail_name :: Lens' ShardDetail (Maybe Text) Source #

The name of the shard

shardDetail_size :: Lens' ShardDetail (Maybe Text) Source #

The size of the shard's snapshot

shardDetail_snapshotCreationTime :: Lens' ShardDetail (Maybe UTCTime) Source #

The date and time that the shard's snapshot was created

SlotMigration

slotMigration_progressPercentage :: Lens' SlotMigration (Maybe Double) Source #

The percentage of the slot migration that is complete.

Snapshot

snapshot_arn :: Lens' Snapshot (Maybe Text) Source #

The ARN (Amazon Resource Name) of the snapshot.

snapshot_clusterConfiguration :: Lens' Snapshot (Maybe ClusterConfiguration) Source #

The configuration of the cluster from which the snapshot was taken

snapshot_dataTiering :: Lens' Snapshot (Maybe DataTieringStatus) Source #

Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.

snapshot_kmsKeyId :: Lens' Snapshot (Maybe Text) Source #

The ID of the KMS key used to encrypt the snapshot.

snapshot_name :: Lens' Snapshot (Maybe Text) Source #

The name of the snapshot

snapshot_source :: Lens' Snapshot (Maybe Text) Source #

Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).

snapshot_status :: Lens' Snapshot (Maybe Text) Source #

The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.

Subnet

subnet_availabilityZone :: Lens' Subnet (Maybe AvailabilityZone) Source #

The Availability Zone where the subnet resides

subnet_identifier :: Lens' Subnet (Maybe Text) Source #

The unique identifier for the subnet.

SubnetGroup

subnetGroup_arn :: Lens' SubnetGroup (Maybe Text) Source #

The ARN (Amazon Resource Name) of the subnet group.

subnetGroup_description :: Lens' SubnetGroup (Maybe Text) Source #

A description of the subnet group

subnetGroup_name :: Lens' SubnetGroup (Maybe Text) Source #

The name of the subnet group

subnetGroup_subnets :: Lens' SubnetGroup (Maybe [Subnet]) Source #

A list of subnets associated with the subnet group.

subnetGroup_vpcId :: Lens' SubnetGroup (Maybe Text) Source #

The Amazon Virtual Private Cloud identifier (VPC ID) of the subnet group.

Tag

tag_key :: Lens' Tag (Maybe Text) Source #

The key for the tag. May not be null.

tag_value :: Lens' Tag (Maybe Text) Source #

The tag's value. May be null.

UnprocessedCluster

unprocessedCluster_clusterName :: Lens' UnprocessedCluster (Maybe Text) Source #

The name of the cluster

unprocessedCluster_errorMessage :: Lens' UnprocessedCluster (Maybe Text) Source #

The error message associated with the update failure

unprocessedCluster_errorType :: Lens' UnprocessedCluster (Maybe Text) Source #

The error type associated with the update failure

User

user_aCLNames :: Lens' User (Maybe [Text]) Source #

The names of the Access Control Lists to which the user belongs

user_arn :: Lens' User (Maybe Text) Source #

The Amazon Resource Name (ARN) of the user.

user_accessString :: Lens' User (Maybe Text) Source #

Access permissions string used for this user.

user_authentication :: Lens' User (Maybe Authentication) Source #

Denotes whether the user requires a password to authenticate.

user_minimumEngineVersion :: Lens' User (Maybe Text) Source #

The minimum engine version supported for the user

user_name :: Lens' User (Maybe Text) Source #

The name of the user

user_status :: Lens' User (Maybe Text) Source #

Indicates the user status. Can be "active", "modifying" or "deleting".