Memorydb
This page documents function available when using the Memorydb
module, created with @service Memorydb
.
Index
Main.Memorydb.batch_update_cluster
Main.Memorydb.copy_snapshot
Main.Memorydb.create_acl
Main.Memorydb.create_cluster
Main.Memorydb.create_parameter_group
Main.Memorydb.create_snapshot
Main.Memorydb.create_subnet_group
Main.Memorydb.create_user
Main.Memorydb.delete_acl
Main.Memorydb.delete_cluster
Main.Memorydb.delete_parameter_group
Main.Memorydb.delete_snapshot
Main.Memorydb.delete_subnet_group
Main.Memorydb.delete_user
Main.Memorydb.describe_acls
Main.Memorydb.describe_clusters
Main.Memorydb.describe_engine_versions
Main.Memorydb.describe_events
Main.Memorydb.describe_parameter_groups
Main.Memorydb.describe_parameters
Main.Memorydb.describe_reserved_nodes
Main.Memorydb.describe_reserved_nodes_offerings
Main.Memorydb.describe_service_updates
Main.Memorydb.describe_snapshots
Main.Memorydb.describe_subnet_groups
Main.Memorydb.describe_users
Main.Memorydb.failover_shard
Main.Memorydb.list_allowed_node_type_updates
Main.Memorydb.list_tags
Main.Memorydb.purchase_reserved_nodes_offering
Main.Memorydb.reset_parameter_group
Main.Memorydb.tag_resource
Main.Memorydb.untag_resource
Main.Memorydb.update_acl
Main.Memorydb.update_cluster
Main.Memorydb.update_parameter_group
Main.Memorydb.update_subnet_group
Main.Memorydb.update_user
Documentation
Main.Memorydb.batch_update_cluster
— Methodbatch_update_cluster(cluster_names)
batch_update_cluster(cluster_names, params::Dict{String,<:Any})
Apply the service update to a list of clusters supplied. For more information on service updates and applying them, see Applying the service updates.
Arguments
cluster_names
: The cluster names to apply the updates.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"ServiceUpdate"
: The unique ID of the service update
Main.Memorydb.copy_snapshot
— Methodcopy_snapshot(source_snapshot_name, target_snapshot_name)
copy_snapshot(source_snapshot_name, target_snapshot_name, params::Dict{String,<:Any})
Makes a copy of an existing snapshot.
Arguments
source_snapshot_name
: The name of an existing snapshot from which to make a copy.target_snapshot_name
: 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.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"KmsKeyId"
: The ID of the KMS key used to encrypt the target snapshot."Tags"
: 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."TargetBucket"
: 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.
Main.Memorydb.create_acl
— Methodcreate_acl(aclname)
create_acl(aclname, params::Dict{String,<:Any})
Creates an Access Control List. For more information, see Authenticating users with Access Contol Lists (ACLs).
Arguments
aclname
: The name of the Access Control List.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Tags"
: 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."UserNames"
: The list of users that belong to the Access Control List.
Main.Memorydb.create_cluster
— Methodcreate_cluster(aclname, cluster_name, node_type)
create_cluster(aclname, cluster_name, node_type, params::Dict{String,<:Any})
Creates a cluster. All nodes in the cluster run the same protocol-compliant engine software.
Arguments
aclname
: The name of the Access Control List to associate with the cluster.cluster_name
: The name of the cluster. This value must be unique as it also serves as the cluster identifier.node_type
: The compute and memory capacity of the nodes in the cluster.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"AutoMinorVersionUpgrade"
: When set to true, the cluster will automatically receive minor engine version upgrades after launch."DataTiering"
: 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."Description"
: An optional description of the cluster."EngineVersion"
: The version number of the Redis engine to be used for the cluster."KmsKeyId"
: The ID of the KMS key used to encrypt the cluster."MaintenanceWindow"
: 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"NumReplicasPerShard"
: The number of replicas to apply to each shard. The default value is 1. The maximum is 5."NumShards"
: The number of shards the cluster will contain. The default value is 1."ParameterGroupName"
: The name of the parameter group associated with the cluster."Port"
: The port number on which each of the nodes accepts connections."SecurityGroupIds"
: A list of security group names to associate with this cluster."SnapshotArns"
: 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."SnapshotName"
: 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."SnapshotRetentionLimit"
: 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."SnapshotWindow"
: 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."SnsTopicArn"
: The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent."SubnetGroupName"
: The name of the subnet group to be used for the cluster."TLSEnabled"
: A flag to enable in-transit encryption on the cluster."Tags"
: 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.
Main.Memorydb.create_parameter_group
— Methodcreate_parameter_group(family, parameter_group_name)
create_parameter_group(family, parameter_group_name, params::Dict{String,<:Any})
Creates a new MemoryDB parameter group. A parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster. For more information, see Configuring engine parameters using parameter groups.
Arguments
family
: The name of the parameter group family that the parameter group can be used with.parameter_group_name
: The name of the parameter group.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Description"
: An optional description of the parameter group."Tags"
: 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.
Main.Memorydb.create_snapshot
— Methodcreate_snapshot(cluster_name, snapshot_name)
create_snapshot(cluster_name, snapshot_name, params::Dict{String,<:Any})
Creates a copy of an entire cluster at a specific moment in time.
Arguments
cluster_name
: The snapshot is created from this cluster.snapshot_name
: A name for the snapshot being created.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"KmsKeyId"
: The ID of the KMS key used to encrypt the snapshot."Tags"
: 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.
Main.Memorydb.create_subnet_group
— Methodcreate_subnet_group(subnet_group_name, subnet_ids)
create_subnet_group(subnet_group_name, subnet_ids, params::Dict{String,<:Any})
Creates a subnet group. A subnet group is a collection of subnets (typically private) that you can designate for your clusters running in an Amazon Virtual Private Cloud (VPC) environment. When you create a cluster in an Amazon VPC, you must specify a subnet group. MemoryDB uses that subnet group to choose a subnet and IP addresses within that subnet to associate with your nodes. For more information, see Subnets and subnet groups.
Arguments
subnet_group_name
: The name of the subnet group.subnet_ids
: A list of VPC subnet IDs for the subnet group.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Description"
: A description for the subnet group."Tags"
: 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.
Main.Memorydb.create_user
— Methodcreate_user(access_string, authentication_mode, user_name)
create_user(access_string, authentication_mode, user_name, params::Dict{String,<:Any})
Creates a MemoryDB user. For more information, see Authenticating users with Access Contol Lists (ACLs).
Arguments
access_string
: Access permissions string used for this user.authentication_mode
: Denotes the user's authentication properties, such as whether it requires a password to authenticate.user_name
: The name of the user. This value must be unique as it also serves as the user identifier.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Tags"
: 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.
Main.Memorydb.delete_acl
— Methoddelete_acl(aclname)
delete_acl(aclname, params::Dict{String,<:Any})
Deletes an Access Control List. The ACL must first be disassociated from the cluster before it can be deleted. For more information, see Authenticating users with Access Contol Lists (ACLs).
Arguments
aclname
: The name of the Access Control List to delete
Main.Memorydb.delete_cluster
— Methoddelete_cluster(cluster_name)
delete_cluster(cluster_name, params::Dict{String,<:Any})
Deletes a cluster. It also deletes all associated nodes and node endpoints
Arguments
cluster_name
: The name of the cluster to be deleted
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"FinalSnapshotName"
: 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.
Main.Memorydb.delete_parameter_group
— Methoddelete_parameter_group(parameter_group_name)
delete_parameter_group(parameter_group_name, params::Dict{String,<:Any})
Deletes the specified parameter group. You cannot delete a parameter group if it is associated with any clusters. You cannot delete the default parameter groups in your account.
Arguments
parameter_group_name
: The name of the parameter group to delete.
Main.Memorydb.delete_snapshot
— Methoddelete_snapshot(snapshot_name)
delete_snapshot(snapshot_name, params::Dict{String,<:Any})
Deletes an existing snapshot. When you receive a successful response from this operation, MemoryDB immediately begins deleting the snapshot; you cannot cancel or revert this operation.
Arguments
snapshot_name
: The name of the snapshot to delete
Main.Memorydb.delete_subnet_group
— Methoddelete_subnet_group(subnet_group_name)
delete_subnet_group(subnet_group_name, params::Dict{String,<:Any})
Deletes a subnet group. You cannot delete a default subnet group or one that is associated with any clusters.
Arguments
subnet_group_name
: The name of the subnet group to delete
Main.Memorydb.delete_user
— Methoddelete_user(user_name)
delete_user(user_name, params::Dict{String,<:Any})
Deletes a user. The user will be removed from all ACLs and in turn removed from all clusters.
Arguments
user_name
: The name of the user to delete
Main.Memorydb.describe_acls
— Methoddescribe_acls()
describe_acls(params::Dict{String,<:Any})
Returns a list of ACLs
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"ACLName"
: The name of the ACL"MaxResults"
: 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."NextToken"
: 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.
Main.Memorydb.describe_clusters
— Methoddescribe_clusters()
describe_clusters(params::Dict{String,<:Any})
Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cluster if a cluster name is supplied.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"ClusterName"
: The name of the cluster"MaxResults"
: 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."NextToken"
: 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."ShowShardDetails"
: An optional flag that can be included in the request to retrieve information about the individual shard(s).
Main.Memorydb.describe_engine_versions
— Methoddescribe_engine_versions()
describe_engine_versions(params::Dict{String,<:Any})
Returns a list of the available Redis engine versions.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DefaultOnly"
: If true, specifies that only the default version of the specified engine or engine and major version combination is to be returned."EngineVersion"
: The Redis engine version"MaxResults"
: 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."NextToken"
: 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."ParameterGroupFamily"
: The name of a specific parameter group family to return details for.
Main.Memorydb.describe_events
— Methoddescribe_events()
describe_events(params::Dict{String,<:Any})
Returns events related to clusters, security groups, and parameter groups. You can obtain events specific to a particular cluster, security group, or parameter group by providing the name as a parameter. By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Duration"
: The number of minutes worth of events to retrieve."EndTime"
: The end of the time interval for which to retrieve events, specified in ISO 8601 format. Example: 2017-03-30T07:03:49.555Z"MaxResults"
: 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."NextToken"
: 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."SourceName"
: The identifier of the event source for which events are returned. If not specified, all sources are included in the response."SourceType"
: The event source to retrieve events for. If no value is specified, all events are returned."StartTime"
: The beginning of the time interval to retrieve events for, specified in ISO 8601 format. Example: 2017-03-30T07:03:49.555Z
Main.Memorydb.describe_parameter_groups
— Methoddescribe_parameter_groups()
describe_parameter_groups(params::Dict{String,<:Any})
Returns a list of parameter group descriptions. If a parameter group name is specified, the list contains only the descriptions for that group.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"MaxResults"
: 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."NextToken"
: 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."ParameterGroupName"
: The name of a specific parameter group to return details for.
Main.Memorydb.describe_parameters
— Methoddescribe_parameters(parameter_group_name)
describe_parameters(parameter_group_name, params::Dict{String,<:Any})
Returns the detailed parameter list for a particular parameter group.
Arguments
parameter_group_name
: he name of a specific parameter group to return details for.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"MaxResults"
: 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."NextToken"
: 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.
Main.Memorydb.describe_reserved_nodes
— Methoddescribe_reserved_nodes()
describe_reserved_nodes(params::Dict{String,<:Any})
Returns information about reserved nodes for this account, or about a specified reserved node.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Duration"
: The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this duration."MaxResults"
: 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."NextToken"
: 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."NodeType"
: 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."OfferingType"
: 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""ReservationId"
: The reserved node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID."ReservedNodesOfferingId"
: The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.
Main.Memorydb.describe_reserved_nodes_offerings
— Methoddescribe_reserved_nodes_offerings()
describe_reserved_nodes_offerings(params::Dict{String,<:Any})
Lists available reserved node offerings.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Duration"
: Duration filter value, specified in years or seconds. Use this parameter to show only reservations for a given duration."MaxResults"
: 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."NextToken"
: 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."NodeType"
: The node type for the reserved nodes. For more information, see Supported node types."OfferingType"
: 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""ReservedNodesOfferingId"
: The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.
Main.Memorydb.describe_service_updates
— Methoddescribe_service_updates()
describe_service_updates(params::Dict{String,<:Any})
Returns details of the service updates
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"ClusterNames"
: The list of cluster names to identify service updates to apply"MaxResults"
: 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."NextToken"
: 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."ServiceUpdateName"
: The unique ID of the service update to describe."Status"
: The status(es) of the service updates to filter on
Main.Memorydb.describe_snapshots
— Methoddescribe_snapshots()
describe_snapshots(params::Dict{String,<:Any})
Returns information about cluster snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cluster.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"ClusterName"
: A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described."MaxResults"
: 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."NextToken"
: 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."ShowDetail"
: A Boolean value which if true, the shard configuration is included in the snapshot description."SnapshotName"
: A user-supplied name of the snapshot. If this parameter is specified, only this named snapshot is described."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.
Main.Memorydb.describe_subnet_groups
— Methoddescribe_subnet_groups()
describe_subnet_groups(params::Dict{String,<:Any})
Returns a list of subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"MaxResults"
: 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."NextToken"
: 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."SubnetGroupName"
: The name of the subnet group to return details for.
Main.Memorydb.describe_users
— Methoddescribe_users()
describe_users(params::Dict{String,<:Any})
Returns a list of users.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Filters"
: Filter to determine the list of users to return."MaxResults"
: 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."NextToken"
: 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."UserName"
: The name of the user
Main.Memorydb.failover_shard
— Methodfailover_shard(cluster_name, shard_name)
failover_shard(cluster_name, shard_name, params::Dict{String,<:Any})
Used to failover a shard. This API is designed for testing the behavior of your application in case of MemoryDB failover. It is not designed to be used as a production-level tool for initiating a failover to overcome a problem you may have with the cluster. Moreover, in certain conditions such as large scale operational events, Amazon may block this API.
Arguments
cluster_name
: The cluster being failed overshard_name
: The name of the shard
Main.Memorydb.list_allowed_node_type_updates
— Methodlist_allowed_node_type_updates(cluster_name)
list_allowed_node_type_updates(cluster_name, params::Dict{String,<:Any})
Lists all available node types that you can scale to from your cluster's current node type. When you use the UpdateCluster operation to scale your cluster, the value of the NodeType parameter must be one of the node types returned by this operation.
Arguments
cluster_name
: 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.
Main.Memorydb.list_tags
— Methodlist_tags(resource_arn)
list_tags(resource_arn, params::Dict{String,<:Any})
Lists all tags currently on a named resource. A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track your MemoryDB resources. For more information, see Tagging your MemoryDB resources
Arguments
resource_arn
: The Amazon Resource Name (ARN) of the resource for which you want the list of tags
Main.Memorydb.purchase_reserved_nodes_offering
— Methodpurchase_reserved_nodes_offering(reserved_nodes_offering_id)
purchase_reserved_nodes_offering(reserved_nodes_offering_id, params::Dict{String,<:Any})
Allows you to purchase a reserved node offering. Reserved nodes are not eligible for cancellation and are non-refundable.
Arguments
reserved_nodes_offering_id
: The ID of the reserved node offering to purchase.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"NodeCount"
: The number of node instances to reserve."ReservationId"
: A customer-specified identifier to track this reservation."Tags"
: 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.
Main.Memorydb.reset_parameter_group
— Methodreset_parameter_group(parameter_group_name)
reset_parameter_group(parameter_group_name, params::Dict{String,<:Any})
Modifies the parameters of a parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire parameter group, specify the AllParameters and ParameterGroupName parameters.
Arguments
parameter_group_name
: The name of the parameter group to reset.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"AllParameters"
: 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."ParameterNames"
: 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.
Main.Memorydb.tag_resource
— Methodtag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your MemoryDB resources. When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. For more information, see Resource-level permissions. For example, you can use cost-allocation tags to your MemoryDB resources, Amazon generates a cost allocation report as a comma-separated value (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories (such as cost centers, application names, or owners) to organize your costs across multiple services. For more information, see Using Cost Allocation Tags.
Arguments
resource_arn
: The Amazon Resource Name (ARN) of the resource to which the tags are to be addedtags
: 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.
Main.Memorydb.untag_resource
— Methoduntag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Use this operation to remove tags on a resource
Arguments
resource_arn
: The Amazon Resource Name (ARN) of the resource to which the tags are to be removedtag_keys
: The list of keys of the tags that are to be removed
Main.Memorydb.update_acl
— Methodupdate_acl(aclname)
update_acl(aclname, params::Dict{String,<:Any})
Changes the list of users that belong to the Access Control List.
Arguments
aclname
: The name of the Access Control List
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"UserNamesToAdd"
: The list of users to add to the Access Control List"UserNamesToRemove"
: The list of users to remove from the Access Control List
Main.Memorydb.update_cluster
— Methodupdate_cluster(cluster_name)
update_cluster(cluster_name, params::Dict{String,<:Any})
Modifies the settings for a cluster. You can use this operation to change one or more cluster configuration settings by specifying the settings and the new values.
Arguments
cluster_name
: The name of the cluster to update
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"ACLName"
: The Access Control List that is associated with the cluster"Description"
: The description of the cluster to update"EngineVersion"
: 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."MaintenanceWindow"
: 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"NodeType"
: A valid node type that you want to scale this cluster up or down to."ParameterGroupName"
: The name of the parameter group to update"ReplicaConfiguration"
: The number of replicas that will reside in each shard"SecurityGroupIds"
: The SecurityGroupIds to update"ShardConfiguration"
: The number of shards in the cluster"SnapshotRetentionLimit"
: 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."SnapshotWindow"
: The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster."SnsTopicArn"
: The SNS topic ARN to update"SnsTopicStatus"
: The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.
Main.Memorydb.update_parameter_group
— Methodupdate_parameter_group(parameter_group_name, parameter_name_values)
update_parameter_group(parameter_group_name, parameter_name_values, params::Dict{String,<:Any})
Updates the parameters of a parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.
Arguments
parameter_group_name
: The name of the parameter group to update.parameter_name_values
: 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.
Main.Memorydb.update_subnet_group
— Methodupdate_subnet_group(subnet_group_name)
update_subnet_group(subnet_group_name, params::Dict{String,<:Any})
Updates a subnet group. For more information, see Updating a subnet group
Arguments
subnet_group_name
: The name of the subnet group
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Description"
: A description of the subnet group"SubnetIds"
: The EC2 subnet IDs for the subnet group.
Main.Memorydb.update_user
— Methodupdate_user(user_name)
update_user(user_name, params::Dict{String,<:Any})
Changes user password(s) and/or access string.
Arguments
user_name
: The name of the user
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"AccessString"
: Access permissions string used for this user."AuthenticationMode"
: Denotes the user's authentication properties, such as whether it requires a password to authenticate.