Class: Aws::MemoryDB::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb

Overview

An API client for MemoryDB. To construct a client, you need to configure a :region and :credentials.

client = Aws::MemoryDB::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disables response data type conversions. The request parameters hash must be formatted exactly as the API expects.This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::MemoryDB::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::MemoryDB::EndpointParameters.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



451
452
453
 
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 451

def initialize(*args)
  super
end

Instance Method Details

#batch_update_cluster(params = {}) ⇒ Types::BatchUpdateClusterResponse

Apply the service update to a list of clusters supplied. For more information on service updates and applying them, see Applying the service updates.

Examples:

Request syntax with placeholder values


resp = client.batch_update_cluster({
  cluster_names: ["String"], # required
  service_update: {
    service_update_name_to_apply: "String",
  },
})

Response structure


resp.processed_clusters #=> Array
resp.processed_clusters[0].name #=> String
resp.processed_clusters[0].description #=> String
resp.processed_clusters[0].status #=> String
resp.processed_clusters[0].pending_updates.resharding.slot_migration.progress_percentage #=> Float
resp.processed_clusters[0].pending_updates.acls.acl_to_apply #=> String
resp.processed_clusters[0].pending_updates.service_updates #=> Array
resp.processed_clusters[0].pending_updates.service_updates[0].service_update_name #=> String
resp.processed_clusters[0].pending_updates.service_updates[0].status #=> String, one of "available", "in-progress", "complete", "scheduled"
resp.processed_clusters[0].number_of_shards #=> Integer
resp.processed_clusters[0].shards #=> Array
resp.processed_clusters[0].shards[0].name #=> String
resp.processed_clusters[0].shards[0].status #=> String
resp.processed_clusters[0].shards[0].slots #=> String
resp.processed_clusters[0].shards[0].nodes #=> Array
resp.processed_clusters[0].shards[0].nodes[0].name #=> String
resp.processed_clusters[0].shards[0].nodes[0].status #=> String
resp.processed_clusters[0].shards[0].nodes[0].availability_zone #=> String
resp.processed_clusters[0].shards[0].nodes[0].create_time #=> Time
resp.processed_clusters[0].shards[0].nodes[0].endpoint.address #=> String
resp.processed_clusters[0].shards[0].nodes[0].endpoint.port #=> Integer
resp.processed_clusters[0].shards[0].number_of_nodes #=> Integer
resp.processed_clusters[0].availability_mode #=> String, one of "singleaz", "multiaz"
resp.processed_clusters[0].cluster_endpoint.address #=> String
resp.processed_clusters[0].cluster_endpoint.port #=> Integer
resp.processed_clusters[0].node_type #=> String
resp.processed_clusters[0].engine_version #=> String
resp.processed_clusters[0].engine_patch_version #=> String
resp.processed_clusters[0].parameter_group_name #=> String
resp.processed_clusters[0].parameter_group_status #=> String
resp.processed_clusters[0].security_groups #=> Array
resp.processed_clusters[0].security_groups[0].security_group_id #=> String
resp.processed_clusters[0].security_groups[0].status #=> String
resp.processed_clusters[0].subnet_group_name #=> String
resp.processed_clusters[0].tls_enabled #=> Boolean
resp.processed_clusters[0].kms_key_id #=> String
resp.processed_clusters[0].arn #=> String
resp.processed_clusters[0].sns_topic_arn #=> String
resp.processed_clusters[0].sns_topic_status #=> String
resp.processed_clusters[0].snapshot_retention_limit #=> Integer
resp.processed_clusters[0].maintenance_window #=> String
resp.processed_clusters[0].snapshot_window #=> String
resp.processed_clusters[0].acl_name #=> String
resp.processed_clusters[0].auto_minor_version_upgrade #=> Boolean
resp.processed_clusters[0].data_tiering #=> String, one of "true", "false"
resp.unprocessed_clusters #=> Array
resp.unprocessed_clusters[0].cluster_name #=> String
resp.unprocessed_clusters[0].error_type #=> String
resp.unprocessed_clusters[0].error_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_names (required, Array<String>) —

    The cluster names to apply the updates.

  • :service_update (Types::ServiceUpdateRequest) —

    The unique ID of the service update

Returns:

See Also:



541
542
543
544
 
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 541

def batch_update_cluster(params = {}, options = {})
  req = build_request(:batch_update_cluster, params)
  req.send_request(options)
end

#copy_snapshot(params = {}) ⇒ Types::CopySnapshotResponse

Makes a copy of an existing snapshot.

Examples:

Request syntax with placeholder values


resp = client.copy_snapshot({
  source_snapshot_name: "String", # required
  target_snapshot_name: "String", # required
  target_bucket: "TargetBucket",
  kms_key_id: "KmsKeyId",
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Response structure


resp.snapshot.name #=> String
resp.snapshot.status #=> String
resp.snapshot.source #=> String
resp.snapshot.kms_key_id #=> String
resp.snapshot.arn #=> String
resp.snapshot.cluster_configuration.name #=> String
resp.snapshot.cluster_configuration.description #=> String
resp.snapshot.cluster_configuration.node_type #=> String
resp.snapshot.cluster_configuration.engine_version #=> String
resp.snapshot.cluster_configuration.maintenance_window #=> String
resp.snapshot.cluster_configuration.topic_arn #=> String
resp.snapshot.cluster_configuration.port #=> Integer
resp.snapshot.cluster_configuration.parameter_group_name #=> String
resp.snapshot.cluster_configuration.subnet_group_name #=> String
resp.snapshot.cluster_configuration.vpc_id #=> String
resp.snapshot.cluster_configuration.snapshot_retention_limit #=> Integer
resp.snapshot.cluster_configuration.snapshot_window #=> String
resp.snapshot.cluster_configuration.num_shards #=> Integer
resp.snapshot.cluster_configuration.shards #=> Array
resp.snapshot.cluster_configuration.shards[0].name #=> String
resp.snapshot.cluster_configuration.shards[0].configuration.slots #=> String
resp.snapshot.cluster_configuration.shards[0].configuration.replica_count #=> Integer
resp.snapshot.cluster_configuration.shards[0].size #=> String
resp.snapshot.cluster_configuration.shards[0].snapshot_creation_time #=> Time
resp.snapshot.data_tiering #=> String, one of "true", "false"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :source_snapshot_name (required, String) —

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

  • :target_snapshot_name (required, String) —

    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.

  • :target_bucket (String) —

    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.

  • :kms_key_id (String) —

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

  • :tags (Array<Types::Tag>) —

    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.

Returns:

See Also:



626
627
628
629
 
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 626

def copy_snapshot(params = {}, options = {})
  req = build_request(:copy_snapshot, params)
  req.send_request(options)
end

#create_acl(params = {}) ⇒ Types::CreateACLResponse

Creates an Access Control List. For more information, see Authenticating users with Access Contol Lists (ACLs).

Examples:

Request syntax with placeholder values


resp = client.create_acl({
  acl_name: "String", # required
  user_names: ["UserName"],
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Response structure


resp.acl.name #=> String
resp.acl.status #=> String
resp.acl.user_names #=> Array
resp.acl.user_names[0] #=> String
resp.acl.minimum_engine_version #=> String
resp.acl.pending_changes.user_names_to_remove #=> Array
resp.acl.pending_changes.user_names_to_remove[0] #=> String
resp.acl.pending_changes.user_names_to_add #=> Array
resp.acl.pending_changes.user_names_to_add[0] #=> String
resp.acl.clusters #=> Array
resp.acl.clusters[0] #=> String
resp.acl.arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :acl_name (required, String) —

    The name of the Access Control List.

  • :user_names (Array<String>) —

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

  • :tags (Array<Types::Tag>) —

    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.

Returns:

See Also:



685
686
687
688
 
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 685

def create_acl(params = {}, options = {})
  req = build_request(:create_acl, params)
  req.send_request(options)
end

#create_cluster(params = {}) ⇒ Types::CreateClusterResponse

Creates a cluster. All nodes in the cluster run the same protocol-compliant engine software.

Examples:

Request syntax with placeholder values


resp = client.create_cluster({
  cluster_name: "String", # required
  node_type: "String", # required
  parameter_group_name: "String",
  description: "String",
  num_shards: 1,
  num_replicas_per_shard: 1,
  subnet_group_name: "String",
  security_group_ids: ["String"],
  maintenance_window: "String",
  port: 1,
  sns_topic_arn: "String",
  tls_enabled: false,
  kms_key_id: "String",
  snapshot_arns: ["String"],
  snapshot_name: "String",
  snapshot_retention_limit: 1,
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
  snapshot_window: "String",
  acl_name: "ACLName", # required
  engine_version: "String",
  auto_minor_version_upgrade: false,
  data_tiering: false,
})

Response structure


resp.cluster.name #=> String
resp.cluster.description #=> String
resp.cluster.status #=> String
resp.cluster.pending_updates.resharding.slot_migration.progress_percentage #=> Float
resp.cluster.pending_updates.acls.acl_to_apply #=> String
resp.cluster.pending_updates.service_updates #=> Array
resp.cluster.pending_updates.service_updates[0].service_update_name #=> String
resp.cluster.pending_updates.service_updates[0].status #=> String, one of "available", "in-progress", "complete", "scheduled"
resp.cluster.number_of_shards #=> Integer
resp.cluster.shards #=> Array
resp.cluster.shards[0].name #=> String
resp.cluster.shards[0].status #=> String
resp.cluster.shards[0].slots #=> String
resp.cluster.shards[0].nodes #=> Array
resp.cluster.shards[0].nodes[0].name #=> String
resp.cluster.shards[0].nodes[0].status #=> String
resp.cluster.shards[0].nodes[0].availability_zone #=> String
resp.cluster.shards[0].nodes[0].create_time #=> Time
resp.cluster.shards[0].nodes[0].endpoint.address #=> String
resp.cluster.shards[0].nodes[0].endpoint.port #=> Integer
resp.cluster.shards[0].number_of_nodes #=> Integer
resp.cluster.availability_mode #=> String, one of "singleaz", "multiaz"
resp.cluster.cluster_endpoint.address #=> String
resp.cluster.cluster_endpoint.port #=> Integer
resp.cluster.node_type #=> String
resp.cluster.engine_version #=> String
resp.cluster.engine_patch_version #=> String
resp.cluster.parameter_group_name #=> String
resp.cluster.parameter_group_status #=> String
resp.cluster.security_groups #=> Array
resp.cluster.security_groups[0].security_group_id #=> String
resp.cluster.security_groups[0].status #=> String
resp.cluster.subnet_group_name #=> String
resp.cluster.tls_enabled #=> Boolean
resp.cluster.kms_key_id #=> String
resp.cluster.arn #=> String
resp.cluster.sns_topic_arn #=> String
resp.cluster.sns_topic_status #=> String
resp.cluster.snapshot_retention_limit #=> Integer
resp.cluster.maintenance_window #=> String
resp.cluster.snapshot_window #=> String
resp.cluster.acl_name #=> String
resp.cluster.auto_minor_version_upgrade #=> Boolean
resp.cluster.data_tiering #=> String, one of "true", "false"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_name (required, String) —

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

  • :node_type (required, String) —

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

  • :parameter_group_name (String) —

    The name of the parameter group associated with the cluster.

  • :description (String) —

    An optional description of the cluster.

  • :num_shards (Integer) —

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

  • :num_replicas_per_shard (Integer) —

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

  • :subnet_group_name (String) —

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

  • :security_group_ids (Array<String>) —

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

  • :maintenance_window (String) —

    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

  • :port (Integer) —

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

  • :sns_topic_arn (String) —

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

  • :tls_enabled (Boolean) —

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

  • :kms_key_id (String) —

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

  • :snapshot_arns (Array<String>) —

    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.

  • :snapshot_name (String) —

    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.

  • :snapshot_retention_limit (Integer) —

    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.

  • :tags (Array<Types::Tag>) —

    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.

  • :snapshot_window (String) —

    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.

  • :acl_name (required, String) —

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

  • :engine_version (String) —

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

  • :auto_minor_version_upgrade (Boolean) —

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

  • :data_tiering (Boolean) —

    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.

Returns:

See Also:



894
895
896
897
 
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 894

def create_cluster(params = {}, options = {})
  req = build_request(:create_cluster, params)
  req.send_request(options)
end

#create_parameter_group(params = {}) ⇒ Types::CreateParameterGroupResponse

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.

Examples:

Request syntax with placeholder values


resp = client.create_parameter_group({
  parameter_group_name: "String", # required
  family: "String", # required
  description: "String",
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Response structure


resp.parameter_group.name #=> String
resp.parameter_group.family #=> String
resp.parameter_group.description #=> String
resp.parameter_group.arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :parameter_group_name (required, String) —

    The name of the parameter group.

  • :family (required, String) —

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

  • :description (String) —

    An optional description of the parameter group.

  • :tags (Array<Types::Tag>) —

    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.

Returns:

See Also:



952
953
954
955
 
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 952

def create_parameter_group(params = {}, options = {})
  req = build_request(:create_parameter_group, params)
  req.send_request(options)
end

#create_snapshot(params = {}) ⇒ Types::CreateSnapshotResponse

Creates a copy of an entire cluster at a specific moment in time.

Examples:

Request syntax with placeholder values


resp = client.create_snapshot({
  cluster_name: "String", # required
  snapshot_name: "String", # required
  kms_key_id: "String",
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Response structure


resp.snapshot.name #=> String
resp.snapshot.status #=> String
resp.snapshot.source #=> String
resp.snapshot.kms_key_id #=> String
resp.snapshot.arn #=> String
resp.snapshot.cluster_configuration.name #=> String
resp.snapshot.cluster_configuration.description #=> String
resp.snapshot.cluster_configuration.node_type #=> String
resp.snapshot.cluster_configuration.engine_version #=> String
resp.snapshot.cluster_configuration.maintenance_window #=> String
resp.snapshot.cluster_configuration.topic_arn #=> String
resp.snapshot.cluster_configuration.port #=> Integer
resp.snapshot.cluster_configuration.parameter_group_name #=> String
resp.snapshot.cluster_configuration.subnet_group_name #=> String
resp.snapshot.cluster_configuration.vpc_id #=> String
resp.snapshot.cluster_configuration.snapshot_retention_limit #=> Integer
resp.snapshot.cluster_configuration.snapshot_window #=> String
resp.snapshot.cluster_configuration.num_shards #=> Integer
resp.snapshot.cluster_configuration.shards #=> Array
resp.snapshot.cluster_configuration.shards[0].name #=> String
resp.snapshot.cluster_configuration.shards[0].configuration.slots #=> String
resp.snapshot.cluster_configuration.shards[0].configuration.replica_count #=> Integer
resp.snapshot.cluster_configuration.shards[0].size #=> String
resp.snapshot.cluster_configuration.shards[0].snapshot_creation_time #=> Time
resp.snapshot.data_tiering #=> String, one of "true", "false"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_name (required, String) —

    The snapshot is created from this cluster.

  • :snapshot_name (required, String) —

    A name for the snapshot being created.

  • :kms_key_id (String) —

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

  • :tags (Array<Types::Tag>) —

    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.

Returns:

See Also:



1023
1024
1025
1026
 
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 1023

def create_snapshot(params = {}, options = {})
  req = build_request(:create_snapshot, params)
  req.send_request(options)
end

#create_subnet_group(params = {}) ⇒ Types::CreateSubnetGroupResponse

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.

Examples:

Request syntax with placeholder values


resp = client.create_subnet_group({
  subnet_group_name: "String", # required
  description: "String",
  subnet_ids: ["String"], # required
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Response structure


resp.subnet_group.name #=> String
resp.subnet_group.description #=> String
resp.subnet_group.vpc_id #=> String
resp.subnet_group.subnets #=> Array
resp.subnet_group.subnets[0].identifier #=> String
resp.subnet_group.subnets[0].availability_zone.name #=> String
resp.subnet_group.arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :subnet_group_name (required, String) —

    The name of the subnet group.

  • :description (String) —

    A description for the subnet group.

  • :subnet_ids (required, Array<String>) —

    A list of VPC subnet IDs for the subnet group.

  • :tags (Array<Types::Tag>) —

    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.

Returns:

See Also:



1086
1087
1088
1089
 
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 1086

def create_subnet_group(params = {}, options = {})
  req = build_request(:create_subnet_group, params)
  req.send_request(options)
end

#create_user(params = {}) ⇒ Types::CreateUserResponse

Creates a MemoryDB user. For more information, see Authenticating users with Access Contol Lists (ACLs).

Examples:

Request syntax with placeholder values


resp = client.create_user({
  user_name: "UserName", # required
  authentication_mode: { # required
    type: "password", # accepts password, iam
    passwords: ["String"],
  },
  access_string: "AccessString", # required
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Response structure


resp.user.name #=> String
resp.user.status #=> String
resp.user.access_string #=> String
resp.user.acl_names #=> Array
resp.user.acl_names[0] #=> String
resp.user.minimum_engine_version #=> String
resp.user.authentication.type #=> String, one of "password", "no-password", "iam"
resp.user.authentication.password_count #=> Integer
resp.user.arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_name (required, String) —

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

  • :authentication_mode (required, Types::AuthenticationMode) —

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

  • :access_string (required, String) —

    Access permissions string used for this user.

  • :tags (Array<Types::Tag>) —

    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.

Returns:

See Also:



1151
1152
1153
1154
 
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 1151

def create_user(params = {}, options = {})
  req = build_request(:create_user, params)
  req.send_request(options)
end

#delete_acl(params = {}) ⇒ Types::DeleteACLResponse

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).

Examples:

Request syntax with placeholder values


resp = client.delete_acl({
  acl_name: "String", # required
})

Response structure


resp.acl.name #=> String
resp.acl.status #=> String
resp.acl.user_names #=> Array
resp.acl.user_names[0] #=> String
resp.acl.minimum_engine_version #=> String
resp.acl.pending_changes.user_names_to_remove #=> Array
resp.acl.pending_changes.user_names_to_remove[0] #=> String
resp.acl.pending_changes.user_names_to_add #=> Array
resp.acl.pending_changes.user_names_to_add[0] #=> String
resp.acl.clusters #=> Array
resp.acl.clusters[0] #=> String
resp.acl.arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :acl_name (required, String) —

    The name of the Access Control List to delete

Returns:

See Also:



1196
1197
1198
1199
 
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 1196

def delete_acl(params = {}, options = {})
  req = build_request(:delete_acl, params)
  req.send_request(options)
end

#delete_cluster(params = {}) ⇒ Types::DeleteClusterResponse

Deletes a cluster. It also deletes all associated nodes and node endpoints

CreateSnapshot permission is required to create a final snapshot. Without this permission, the API call will fail with an Access Denied exception.

Examples:

Request syntax with placeholder values


resp = client.delete_cluster({
  cluster_name: "String", # required
  final_snapshot_name: "String",
})

Response structure


resp.cluster.name #=> String
resp.cluster.description #=> String
resp.cluster.status #=> String
resp.cluster.pending_updates.resharding.slot_migration.progress_percentage #=> Float
resp.cluster.pending_updates.acls.acl_to_apply #=> String
resp.cluster.pending_updates.service_updates #=> Array
resp.cluster.pending_updates.service_updates[0].service_update_name #=> String
resp.cluster.pending_updates.service_updates[0].status #=> String, one of "available", "in-progress", "complete", "scheduled"
resp.cluster.number_of_shards #=> Integer
resp.cluster.shards #=> Array
resp.cluster.shards[0].name #=> String
resp.cluster.shards[0].status #=> String
resp.cluster.shards[0].slots #=> String
resp.cluster.shards[0].nodes #=> Array
resp.cluster.shards[0].nodes[0].name #=> String
resp.cluster.shards[0].nodes[0].status #=> String
resp.cluster.shards[0].nodes[0].availability_zone #=> String
resp.cluster.shards[0].nodes[0].create_time #=> Time
resp.cluster.shards[0].nodes[0].endpoint.address #=> String
resp.cluster.shards[0].nodes[0].endpoint.port #=> Integer
resp.cluster.shards[0].number_of_nodes #=> Integer
resp.cluster.availability_mode #=> String, one of "singleaz", "multiaz"
resp.cluster.cluster_endpoint.address #=> String
resp.cluster.cluster_endpoint.port #=> Integer
resp.cluster.node_type #=> String
resp.cluster.engine_version #=> String
resp.cluster.engine_patch_version #=> String
resp.cluster.parameter_group_name #=> String
resp.cluster.parameter_group_status #=> String
resp.cluster.security_groups #=> Array
resp.cluster.security_groups[0].security_group_id #=> String
resp.cluster.security_groups[0].status #=> String
resp.cluster.subnet_group_name #=> String
resp.cluster.tls_enabled #=> Boolean
resp.cluster.kms_key_id #=> String
resp.cluster.arn #=> String
resp.cluster.sns_topic_arn #=> String
resp.cluster.sns_topic_status #=> String
resp.cluster.snapshot_retention_limit #=> Integer
resp.cluster.maintenance_window #=> String
resp.cluster.snapshot_window #=> String
resp.cluster.acl_name #=> String
resp.cluster.auto_minor_version_upgrade #=> Boolean
resp.cluster.data_tiering #=> String, one of "true", "false"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_name (required, String) —

    The name of the cluster to be deleted

  • :final_snapshot_name (String) —

    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.

Returns:

See Also:



1280
1281
1282
1283
 
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 1280

def delete_cluster(params = {}, options = {})
  req = build_request(:delete_cluster, params)
  req.send_request(options)
end

#delete_parameter_group(params = {}) ⇒ Types::DeleteParameterGroupResponse

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.

Examples:

Request syntax with placeholder values


resp = client.delete_parameter_group({
  parameter_group_name: "String", # required
})

Response structure


resp.parameter_group.name #=> String
resp.parameter_group.family #=> String
resp.parameter_group.description #=> String
resp.parameter_group.arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :parameter_group_name (required, String) —

    The name of the parameter group to delete.

Returns:

See Also:



1313
1314
1315
1316
 
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 1313

def delete_parameter_group(params = {}, options = {})
  req = build_request(:delete_parameter_group, params)
  req.send_request(options)
end

#delete_snapshot(params = {}) ⇒ Types::DeleteSnapshotResponse

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.

Examples:

Request syntax with placeholder values


resp = client.delete_snapshot({
  snapshot_name: "String", # required
})

Response structure


resp.snapshot.name #=> String
resp.snapshot.status #=> String
resp.snapshot.source #=> String
resp.snapshot.kms_key_id #=> String
resp.snapshot.arn #=> String
resp.snapshot.cluster_configuration.name #=> String
resp.snapshot.cluster_configuration.description #=> String
resp.snapshot.cluster_configuration.node_type #=> String
resp.snapshot.cluster_configuration.engine_version #=> String
resp.snapshot.cluster_configuration.maintenance_window #=> String
resp.snapshot.cluster_configuration.topic_arn #=> String
resp.snapshot.cluster_configuration.port #=> Integer
resp.snapshot.cluster_configuration.parameter_group_name #=> String
resp.snapshot.cluster_configuration.subnet_group_name #=> String
resp.snapshot.cluster_configuration.vpc_id #=> String
resp.snapshot.cluster_configuration.snapshot_retention_limit #=> Integer
resp.snapshot.cluster_configuration.snapshot_window #=> String
resp.snapshot.cluster_configuration.num_shards #=> Integer
resp.snapshot.cluster_configuration.shards #=> Array
resp.snapshot.cluster_configuration.shards[0].name #=> String
resp.snapshot.cluster_configuration.shards[0].configuration.slots #=> String
resp.snapshot.cluster_configuration.shards[0].configuration.replica_count #=> Integer
resp.snapshot.cluster_configuration.shards[0].size #=> String
resp.snapshot.cluster_configuration.shards[0].snapshot_creation_time #=> Time
resp.snapshot.data_tiering #=> String, one of "true", "false"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :snapshot_name (required, String) —

    The name of the snapshot to delete

Returns:

See Also:



1367
1368
1369
1370
 
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 1367

def delete_snapshot(params = {}, options = {})
  req = build_request(:delete_snapshot, params)
  req.send_request(options)
end

#delete_subnet_group(params = {}) ⇒ Types::DeleteSubnetGroupResponse

Deletes a subnet group. You cannot delete a default subnet group or one that is associated with any clusters.

Examples:

Request syntax with placeholder values


resp = client.delete_subnet_group({
  subnet_group_name: "String", # required
})

Response structure


resp.subnet_group.name #=> String
resp.subnet_group.description #=> String
resp.subnet_group.vpc_id #=> String
resp.subnet_group.subnets #=> Array
resp.subnet_group.subnets[0].identifier #=> String
resp.subnet_group.subnets[0].availability_zone.name #=> String
resp.subnet_group.arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :subnet_group_name (required, String) —

    The name of the subnet group to delete

Returns:

See Also:



1402
1403
1404
1405
 
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 1402

def delete_subnet_group(params = {}, options = {})
  req = build_request(:delete_subnet_group, params)
  req.send_request(options)
end

#delete_user(params = {}) ⇒ Types::DeleteUserResponse

Deletes a user. The user will be removed from all ACLs and in turn removed from all clusters.

Examples:

Request syntax with placeholder values


resp = client.delete_user({
  user_name: "UserName", # required
})

Response structure


resp.user.name #=> String
resp.user.status #=> String
resp.user.access_string #=> String
resp.user.acl_names #=> Array
resp.user.acl_names[0] #=> String
resp.user.minimum_engine_version #=> String
resp.user.authentication.type #=> String, one of "password", "no-password", "iam"
resp.user.authentication.password_count #=> Integer
resp.user.arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_name (required, String) —

    The name of the user to delete

Returns:

See Also:



1439
1440
1441
1442
 
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 1439

def delete_user(params = {}, options = {})
  req = build_request(:delete_user, params)
  req.send_request(options)
end

#describe_acls(params = {}) ⇒ Types::DescribeACLsResponse

Returns a list of ACLs

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_acls({
  acl_name: "String",
  max_results: 1,
  next_token: "String",
})

Response structure


resp.acls #=> Array
resp.acls[0].name #=> String
resp.acls[0].status #=> String
resp.acls[0].user_names #=> Array
resp.acls[0].user_names[0] #=> String
resp.acls[0].minimum_engine_version #=> String
resp.acls[0].pending_changes.user_names_to_remove #=> Array
resp.acls[0].pending_changes.user_names_to_remove[0] #=> String
resp.acls[0].pending_changes.user_names_to_add #=> Array
resp.acls[0].pending_changes.user_names_to_add[0] #=> String
resp.acls[0].clusters #=> Array
resp.acls[0].clusters[0] #=> String
resp.acls[0].arn #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :acl_name (String) —

    The name of the ACL

  • :max_results (Integer) —

    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.

  • :next_token (String) —

    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.

Returns:

See Also:



1497
1498
1499
1500
 
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 1497

def describe_acls(params = {}, options = {})
  req = build_request(:describe_acls, params)
  req.send_request(options)
end

#describe_clusters(params = {}) ⇒ Types::DescribeClustersResponse

Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cluster if a cluster name is supplied.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_clusters({
  cluster_name: "String",
  max_results: 1,
  next_token: "String",
  show_shard_details: false,
})

Response structure


resp.next_token #=> String
resp.clusters #=> Array
resp.clusters[0].name #=> String
resp.clusters[0].description #=> String
resp.clusters[0].status #=> String
resp.clusters[0].pending_updates.resharding.slot_migration.progress_percentage #=> Float
resp.clusters[0].pending_updates.acls.acl_to_apply #=> String
resp.clusters[0].pending_updates.service_updates #=> Array
resp.clusters[0].pending_updates.service_updates[0].service_update_name #=> String
resp.clusters[0].pending_updates.service_updates[0].status #=> String, one of "available", "in-progress", "complete", "scheduled"
resp.clusters[0].number_of_shards #=> Integer
resp.clusters[0].shards #=> Array
resp.clusters[0].shards[0].name #=> String
resp.clusters[0].shards[0].status #=> String
resp.clusters[0].shards[0].slots #=> String
resp.clusters[0].shards[0].nodes #=> Array
resp.clusters[0].shards[0].nodes[0].name #=> String
resp.clusters[0].shards[0].nodes[0].status #=> String
resp.clusters[0].shards[0].nodes[0].availability_zone #=> String
resp.clusters[0].shards[0].nodes[0].create_time #=> Time
resp.clusters[0].shards[0].nodes[0].endpoint.address #=> String
resp.clusters[0].shards[0].nodes[0].endpoint.port #=> Integer
resp.clusters[0].shards[0].number_of_nodes #=> Integer
resp.clusters[0].availability_mode #=> String, one of "singleaz", "multiaz"
resp.clusters[0].cluster_endpoint.address #=> String
resp.clusters[0].cluster_endpoint.port #=> Integer
resp.clusters[0].node_type #=> String
resp.clusters[0].engine_version #=> String
resp.clusters[0].engine_patch_version #=> String
resp.clusters[0].parameter_group_name #=> String
resp.clusters[0].parameter_group_status #=> String
resp.clusters[0].security_groups #=> Array
resp.clusters[0].security_groups[0].security_group_id #=> String
resp.clusters[0].security_groups[0].status #=> String
resp.clusters[0].subnet_group_name #=> String
resp.clusters[0].tls_enabled #=> Boolean
resp.clusters[0].kms_key_id #=> String
resp.clusters[0].arn #=> String
resp.clusters[0].sns_topic_arn #=> String
resp.clusters[0].sns_topic_status #=> String
resp.clusters[0].snapshot_retention_limit #=> Integer
resp.clusters[0].maintenance_window #=> String
resp.clusters[0].snapshot_window #=> String
resp.clusters[0].acl_name #=> String
resp.clusters[0].auto_minor_version_upgrade #=> Boolean
resp.clusters[0].data_tiering #=> String, one of "true", "false"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_name (String) —

    The name of the cluster

  • :max_results (Integer) —

    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.

  • :next_token (String) —

    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.

  • :show_shard_details (Boolean) —

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

Returns:

See Also:



1594
1595
1596
1597
 
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 1594

def describe_clusters(params = {}, options = {})
  req = build_request(:describe_clusters, params)
  req.send_request(options)
end

#describe_engine_versions(params = {}) ⇒ Types::DescribeEngineVersionsResponse

Returns a list of the available Redis OSS engine versions.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_engine_versions({
  engine_version: "String",
  parameter_group_family: "String",
  max_results: 1,
  next_token: "String",
  default_only: false,
})

Response structure


resp.next_token #=> String
resp.engine_versions #=> Array
resp.engine_versions[0].engine_version #=> String
resp.engine_versions[0].engine_patch_version #=> String
resp.engine_versions[0].parameter_group_family #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :engine_version (String) —

    The Redis OSS engine version

  • :parameter_group_family (String) —

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

  • :max_results (Integer) —

    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.

  • :next_token (String) —

    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.

  • :default_only (Boolean) —

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

Returns:

See Also:



1652
1653
1654
1655
 
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 1652

def describe_engine_versions(params = {}, options = {})
  req = build_request(:describe_engine_versions, params)
  req.send_request(options)
end

#describe_events(params = {}) ⇒ Types::DescribeEventsResponse

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_events({
  source_name: "String",
  source_type: "node", # accepts node, parameter-group, subnet-group, cluster, user, acl
  start_time: Time.now,
  end_time: Time.now,
  duration: 1,
  max_results: 1,
  next_token: "String",
})

Response structure


resp.next_token #=> String
resp.events #=> Array
resp.events[0].source_name #=> String
resp.events[0].source_type #=> String, one of "node", "parameter-group", "subnet-group", "cluster", "user", "acl"
resp.events[0].message #=> String
resp.events[0].date #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :source_name (String) —

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

  • :source_type (String) —

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

  • :start_time (Time, DateTime, Date, Integer, String) —

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

  • :end_time (Time, DateTime, Date, Integer, String) —

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

  • :duration (Integer) —

    The number of minutes worth of events to retrieve.

  • :max_results (Integer) —

    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.

  • :next_token (String) —

    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.

Returns:

See Also:



1727
1728
1729
1730
 
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 1727

def describe_events(params = {}, options = {})
  req = build_request(:describe_events, params)
  req.send_request(options)
end

#describe_parameter_groups(params = {}) ⇒ Types::DescribeParameterGroupsResponse

Returns a list of parameter group descriptions. If a parameter group name is specified, the list contains only the descriptions for that group.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_parameter_groups({
  parameter_group_name: "String",
  max_results: 1,
  next_token: "String",
})

Response structure


resp.next_token #=> String
resp.parameter_groups #=> Array
resp.parameter_groups[0].name #=> String
resp.parameter_groups[0].family #=> String
resp.parameter_groups[0].description #=> String
resp.parameter_groups[0].arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :parameter_group_name (String) —

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

  • :max_results (Integer) —

    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.

  • :next_token (String) —

    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.

Returns:

See Also:



1779
1780
1781
1782
 
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 1779

def describe_parameter_groups(params = {}, options = {})
  req = build_request(:describe_parameter_groups, params)
  req.send_request(options)
end

#describe_parameters(params = {}) ⇒ Types::DescribeParametersResponse

Returns the detailed parameter list for a particular parameter group.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_parameters({
  parameter_group_name: "String", # required
  max_results: 1,
  next_token: "String",
})

Response structure


resp.next_token #=> String
resp.parameters #=> Array
resp.parameters[0].name #=> String
resp.parameters[0].value #=> String
resp.parameters[0].description #=> String
resp.parameters[0].data_type #=> String
resp.parameters[0].allowed_values #=> String
resp.parameters[0].minimum_engine_version #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :parameter_group_name (required, String) —

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

  • :max_results (Integer) —

    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.

  • :next_token (String) —

    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.

Returns:

See Also:



1831
1832
1833
1834
 
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 1831

def describe_parameters(params = {}, options = {})
  req = build_request(:describe_parameters, params)
  req.send_request(options)
end

#describe_reserved_nodes(params = {}) ⇒ Types::DescribeReservedNodesResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_reserved_nodes({
  reservation_id: "String",
  reserved_nodes_offering_id: "String",
  node_type: "String",
  duration: "String",
  offering_type: "String",
  max_results: 1,
  next_token: "String",
})

Response structure


resp.next_token #=> String
resp.reserved_nodes #=> Array
resp.reserved_nodes[0].reservation_id #=> String
resp.reserved_nodes[0].reserved_nodes_offering_id #=> String
resp.reserved_nodes[0].node_type #=> String
resp.reserved_nodes[0].start_time #=> Time
resp.reserved_nodes[0].duration #=> Integer
resp.reserved_nodes[0].fixed_price #=> Float
resp.reserved_nodes[0].node_count #=> Integer
resp.reserved_nodes[0].offering_type #=> String
resp.reserved_nodes[0].state #=> String
resp.reserved_nodes[0].recurring_charges #=> Array
resp.reserved_nodes[0].recurring_charges[0].recurring_charge_amount #=> Float
resp.reserved_nodes[0].recurring_charges[0].recurring_charge_frequency #=> String
resp.reserved_nodes[0].arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :reservation_id (String) —

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

  • :reserved_nodes_offering_id (String) —

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

  • :node_type (String) —

    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.

  • :duration (String) —

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

  • :offering_type (String) —

    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"

  • :max_results (Integer) —

    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.

  • :next_token (String) —

    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.

Returns:

See Also:



1918
1919
1920
1921
 
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 1918

def describe_reserved_nodes(params = {}, options = {})
  req = build_request(:describe_reserved_nodes, params)
  req.send_request(options)
end

#describe_reserved_nodes_offerings(params = {}) ⇒ Types::DescribeReservedNodesOfferingsResponse

Lists available reserved node offerings.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_reserved_nodes_offerings({
  reserved_nodes_offering_id: "String",
  node_type: "String",
  duration: "String",
  offering_type: "String",
  max_results: 1,
  next_token: "String",
})

Response structure


resp.next_token #=> String
resp.reserved_nodes_offerings #=> Array
resp.reserved_nodes_offerings[0].reserved_nodes_offering_id #=> String
resp.reserved_nodes_offerings[0].node_type #=> String
resp.reserved_nodes_offerings[0].duration #=> Integer
resp.reserved_nodes_offerings[0].fixed_price #=> Float
resp.reserved_nodes_offerings[0].offering_type #=> String
resp.reserved_nodes_offerings[0].recurring_charges #=> Array
resp.reserved_nodes_offerings[0].recurring_charges[0].recurring_charge_amount #=> Float
resp.reserved_nodes_offerings[0].recurring_charges[0].recurring_charge_frequency #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :reserved_nodes_offering_id (String) —

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

  • :node_type (String) —

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

  • :duration (String) —

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

  • :offering_type (String) —

    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"

  • :max_results (Integer) —

    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.

  • :next_token (String) —

    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.

Returns:

See Also:



1994
1995
1996
1997
 
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 1994

def describe_reserved_nodes_offerings(params = {}, options = {})
  req = build_request(:describe_reserved_nodes_offerings, params)
  req.send_request(options)
end

#describe_service_updates(params = {}) ⇒ Types::DescribeServiceUpdatesResponse

Returns details of the service updates

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_service_updates({
  service_update_name: "String",
  cluster_names: ["String"],
  status: ["available"], # accepts available, in-progress, complete, scheduled
  max_results: 1,
  next_token: "String",
})

Response structure


resp.next_token #=> String
resp.service_updates #=> Array
resp.service_updates[0].cluster_name #=> String
resp.service_updates[0].service_update_name #=> String
resp.service_updates[0].release_date #=> Time
resp.service_updates[0].description #=> String
resp.service_updates[0].status #=> String, one of "available", "in-progress", "complete", "scheduled"
resp.service_updates[0].type #=> String, one of "security-update"
resp.service_updates[0].nodes_updated #=> String
resp.service_updates[0].auto_update_start_date #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :service_update_name (String) —

    The unique ID of the service update to describe.

  • :cluster_names (Array<String>) —

    The list of cluster names to identify service updates to apply

  • :status (Array<String>) —

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

  • :max_results (Integer) —

    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.

  • :next_token (String) —

    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.

Returns:

See Also:



2056
2057
2058
2059
 
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 2056

def describe_service_updates(params = {}, options = {})
  req = build_request(:describe_service_updates, params)
  req.send_request(options)
end

#describe_snapshots(params = {}) ⇒ Types::DescribeSnapshotsResponse

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_snapshots({
  cluster_name: "String",
  snapshot_name: "String",
  source: "String",
  next_token: "String",
  max_results: 1,
  show_detail: false,
})

Response structure


resp.next_token #=> String
resp.snapshots #=> Array
resp.snapshots[0].name #=> String
resp.snapshots[0].status #=> String
resp.snapshots[0].source #=> String
resp.snapshots[0].kms_key_id #=> String
resp.snapshots[0].arn #=> String
resp.snapshots[0].cluster_configuration.name #=> String
resp.snapshots[0].cluster_configuration.description #=> String
resp.snapshots[0].cluster_configuration.node_type #=> String
resp.snapshots[0].cluster_configuration.engine_version #=> String
resp.snapshots[0].cluster_configuration.maintenance_window #=> String
resp.snapshots[0].cluster_configuration.topic_arn #=> String
resp.snapshots[0].cluster_configuration.port #=> Integer
resp.snapshots[0].cluster_configuration.parameter_group_name #=> String
resp.snapshots[0].cluster_configuration.subnet_group_name #=> String
resp.snapshots[0].cluster_configuration.vpc_id #=> String
resp.snapshots[0].cluster_configuration.snapshot_retention_limit #=> Integer
resp.snapshots[0].cluster_configuration.snapshot_window #=> String
resp.snapshots[0].cluster_configuration.num_shards #=> Integer
resp.snapshots[0].cluster_configuration.shards #=> Array
resp.snapshots[0].cluster_configuration.shards[0].name #=> String
resp.snapshots[0].cluster_configuration.shards[0].configuration.slots #=> String
resp.snapshots[0].cluster_configuration.shards[0].configuration.replica_count #=> Integer
resp.snapshots[0].cluster_configuration.shards[0].size #=> String
resp.snapshots[0].cluster_configuration.shards[0].snapshot_creation_time #=> Time
resp.snapshots[0].data_tiering #=> String, one of "true", "false"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_name (String) —

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

  • :snapshot_name (String) —

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

  • :source (String) —

    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.

  • :next_token (String) —

    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.

  • :max_results (Integer) —

    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.

  • :show_detail (Boolean) —

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

Returns:

See Also:



2148
2149
2150
2151
 
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 2148

def describe_snapshots(params = {}, options = {})
  req = build_request(:describe_snapshots, params)
  req.send_request(options)
end

#describe_subnet_groups(params = {}) ⇒ Types::DescribeSubnetGroupsResponse

Returns a list of subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_subnet_groups({
  subnet_group_name: "String",
  max_results: 1,
  next_token: "String",
})

Response structure


resp.next_token #=> String
resp.subnet_groups #=> Array
resp.subnet_groups[0].name #=> String
resp.subnet_groups[0].description #=> String
resp.subnet_groups[0].vpc_id #=> String
resp.subnet_groups[0].subnets #=> Array
resp.subnet_groups[0].subnets[0].identifier #=> String
resp.subnet_groups[0].subnets[0].availability_zone.name #=> String
resp.subnet_groups[0].arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :subnet_group_name (String) —

    The name of the subnet group to return details for.

  • :max_results (Integer) —

    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.

  • :next_token (String) —

    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.

Returns:

See Also:



2202
2203
2204
2205
 
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 2202

def describe_subnet_groups(params = {}, options = {})
  req = build_request(:describe_subnet_groups, params)
  req.send_request(options)
end

#describe_users(params = {}) ⇒ Types::DescribeUsersResponse

Returns a list of users.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_users({
  user_name: "UserName",
  filters: [
    {
      name: "FilterName", # required
      values: ["FilterValue"], # required
    },
  ],
  max_results: 1,
  next_token: "String",
})

Response structure


resp.users #=> Array
resp.users[0].name #=> String
resp.users[0].status #=> String
resp.users[0].access_string #=> String
resp.users[0].acl_names #=> Array
resp.users[0].acl_names[0] #=> String
resp.users[0].minimum_engine_version #=> String
resp.users[0].authentication.type #=> String, one of "password", "no-password", "iam"
resp.users[0].authentication.password_count #=> Integer
resp.users[0].arn #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_name (String) —

    The name of the user

  • :filters (Array<Types::Filter>) —

    Filter to determine the list of users to return.

  • :max_results (Integer) —

    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.

  • :next_token (String) —

    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.

Returns:

See Also:



2266
2267
2268
2269
 
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 2266

def describe_users(params = {}, options = {})
  req = build_request(:describe_users, params)
  req.send_request(options)
end

#failover_shard(params = {}) ⇒ Types::FailoverShardResponse

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.

Examples:

Request syntax with placeholder values


resp = client.failover_shard({
  cluster_name: "String", # required
  shard_name: "String", # required
})

Response structure


resp.cluster.name #=> String
resp.cluster.description #=> String
resp.cluster.status #=> String
resp.cluster.pending_updates.resharding.slot_migration.progress_percentage #=> Float
resp.cluster.pending_updates.acls.acl_to_apply #=> String
resp.cluster.pending_updates.service_updates #=> Array
resp.cluster.pending_updates.service_updates[0].service_update_name #=> String
resp.cluster.pending_updates.service_updates[0].status #=> String, one of "available", "in-progress", "complete", "scheduled"
resp.cluster.number_of_shards #=> Integer
resp.cluster.shards #=> Array
resp.cluster.shards[0].name #=> String
resp.cluster.shards[0].status #=> String
resp.cluster.shards[0].slots #=> String
resp.cluster.shards[0].nodes #=> Array
resp.cluster.shards[0].nodes[0].name #=> String
resp.cluster.shards[0].nodes[0].status #=> String
resp.cluster.shards[0].nodes[0].availability_zone #=> String
resp.cluster.shards[0].nodes[0].create_time #=> Time
resp.cluster.shards[0].nodes[0].endpoint.address #=> String
resp.cluster.shards[0].nodes[0].endpoint.port #=> Integer
resp.cluster.shards[0].number_of_nodes #=> Integer
resp.cluster.availability_mode #=> String, one of "singleaz", "multiaz"
resp.cluster.cluster_endpoint.address #=> String
resp.cluster.cluster_endpoint.port #=> Integer
resp.cluster.node_type #=> String
resp.cluster.engine_version #=> String
resp.cluster.engine_patch_version #=> String
resp.cluster.parameter_group_name #=> String
resp.cluster.parameter_group_status #=> String
resp.cluster.security_groups #=> Array
resp.cluster.security_groups[0].security_group_id #=> String
resp.cluster.security_groups[0].status #=> String
resp.cluster.subnet_group_name #=> String
resp.cluster.tls_enabled #=> Boolean
resp.cluster.kms_key_id #=> String
resp.cluster.arn #=> String
resp.cluster.sns_topic_arn #=> String
resp.cluster.sns_topic_status #=> String
resp.cluster.snapshot_retention_limit #=> Integer
resp.cluster.maintenance_window #=> String
resp.cluster.snapshot_window #=> String
resp.cluster.acl_name #=> String
resp.cluster.auto_minor_version_upgrade #=> Boolean
resp.cluster.data_tiering #=> String, one of "true", "false"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_name (required, String) —

    The cluster being failed over

  • :shard_name (required, String) —

    The name of the shard

Returns:

See Also:



2346
2347
2348
2349
 
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 2346

def failover_shard(params = {}, options = {})
  req = build_request(:failover_shard, params)
  req.send_request(options)
end

#list_allowed_node_type_updates(params = {}) ⇒ Types::ListAllowedNodeTypeUpdatesResponse

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.

Examples:

Request syntax with placeholder values


resp = client.list_allowed_node_type_updates({
  cluster_name: "String", # required
})

Response structure


resp.scale_up_node_types #=> Array
resp.scale_up_node_types[0] #=> String
resp.scale_down_node_types #=> Array
resp.scale_down_node_types[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_name (required, String) —

    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.

Returns:

See Also:



2383
2384
2385
2386
 
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 2383

def list_allowed_node_type_updates(params = {}, options = {})
  req = build_request(:list_allowed_node_type_updates, params)
  req.send_request(options)
end

#list_tags(params = {}) ⇒ Types::ListTagsResponse

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

Examples:

Request syntax with placeholder values


resp = client.list_tags({
  resource_arn: "String", # required
})

Response structure


resp.tag_list #=> Array
resp.tag_list[0].key #=> String
resp.tag_list[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

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

Returns:

See Also:



2421
2422
2423
2424
 
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 2421

def list_tags(params = {}, options = {})
  req = build_request(:list_tags, params)
  req.send_request(options)
end

#purchase_reserved_nodes_offering(params = {}) ⇒ Types::PurchaseReservedNodesOfferingResponse

Allows you to purchase a reserved node offering. Reserved nodes are not eligible for cancellation and are non-refundable.

Examples:

Request syntax with placeholder values


resp = client.purchase_reserved_nodes_offering({
  reserved_nodes_offering_id: "String", # required
  reservation_id: "String",
  node_count: 1,
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Response structure


resp.reserved_node.reservation_id #=> String
resp.reserved_node.reserved_nodes_offering_id #=> String
resp.reserved_node.node_type #=> String
resp.reserved_node.start_time #=> Time
resp.reserved_node.duration #=> Integer
resp.reserved_node.fixed_price #=> Float
resp.reserved_node.node_count #=> Integer
resp.reserved_node.offering_type #=> String
resp.reserved_node.state #=> String
resp.reserved_node.recurring_charges #=> Array
resp.reserved_node.recurring_charges[0].recurring_charge_amount #=> Float
resp.reserved_node.recurring_charges[0].recurring_charge_frequency #=> String
resp.reserved_node.arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :reserved_nodes_offering_id (required, String) —

    The ID of the reserved node offering to purchase.

  • :reservation_id (String) —

    A customer-specified identifier to track this reservation.

  • :node_count (Integer) —

    The number of node instances to reserve.

  • :tags (Array<Types::Tag>) —

    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.

Returns:

See Also:



2481
2482
2483
2484
 
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 2481

def purchase_reserved_nodes_offering(params = {}, options = {})
  req = build_request(:purchase_reserved_nodes_offering, params)
  req.send_request(options)
end

#reset_parameter_group(params = {}) ⇒ Types::ResetParameterGroupResponse

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.

Examples:

Request syntax with placeholder values


resp = client.reset_parameter_group({
  parameter_group_name: "String", # required
  all_parameters: false,
  parameter_names: ["String"],
})

Response structure


resp.parameter_group.name #=> String
resp.parameter_group.family #=> String
resp.parameter_group.description #=> String
resp.parameter_group.arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :parameter_group_name (required, String) —

    The name of the parameter group to reset.

  • :all_parameters (Boolean) —

    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.

  • :parameter_names (Array<String>) —

    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.

Returns:

See Also:



2527
2528
2529
2530
 
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 2527

def reset_parameter_group(params = {}, options = {})
  req = build_request(:reset_parameter_group, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Types::TagResourceResponse

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.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "String", # required
  tags: [ # required
    {
      key: "String",
      value: "String",
    },
  ],
})

Response structure


resp.tag_list #=> Array
resp.tag_list[0].key #=> String
resp.tag_list[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

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

  • :tags (required, Array<Types::Tag>) —

    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.

Returns:

See Also:



2586
2587
2588
2589
 
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 2586

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Types::UntagResourceResponse

Use this operation to remove tags on a resource

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "String", # required
  tag_keys: ["String"], # required
})

Response structure


resp.tag_list #=> Array
resp.tag_list[0].key #=> String
resp.tag_list[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

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

  • :tag_keys (required, Array<String>) —

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

Returns:

See Also:



2621
2622
2623
2624
 
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 2621

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_acl(params = {}) ⇒ Types::UpdateACLResponse

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

Examples:

Request syntax with placeholder values


resp = client.update_acl({
  acl_name: "String", # required
  user_names_to_add: ["UserName"],
  user_names_to_remove: ["UserName"],
})

Response structure


resp.acl.name #=> String
resp.acl.status #=> String
resp.acl.user_names #=> Array
resp.acl.user_names[0] #=> String
resp.acl.minimum_engine_version #=> String
resp.acl.pending_changes.user_names_to_remove #=> Array
resp.acl.pending_changes.user_names_to_remove[0] #=> String
resp.acl.pending_changes.user_names_to_add #=> Array
resp.acl.pending_changes.user_names_to_add[0] #=> String
resp.acl.clusters #=> Array
resp.acl.clusters[0] #=> String
resp.acl.arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :acl_name (required, String) —

    The name of the Access Control List

  • :user_names_to_add (Array<String>) —

    The list of users to add to the Access Control List

  • :user_names_to_remove (Array<String>) —

    The list of users to remove from the Access Control List

Returns:

See Also:



2668
2669
2670
2671
 
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 2668

def update_acl(params = {}, options = {})
  req = build_request(:update_acl, params)
  req.send_request(options)
end

#update_cluster(params = {}) ⇒ Types::UpdateClusterResponse

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.

Examples:

Request syntax with placeholder values


resp = client.update_cluster({
  cluster_name: "String", # required
  description: "String",
  security_group_ids: ["String"],
  maintenance_window: "String",
  sns_topic_arn: "String",
  sns_topic_status: "String",
  parameter_group_name: "String",
  snapshot_window: "String",
  snapshot_retention_limit: 1,
  node_type: "String",
  engine_version: "String",
  replica_configuration: {
    replica_count: 1,
  },
  shard_configuration: {
    shard_count: 1,
  },
  acl_name: "ACLName",
})

Response structure


resp.cluster.name #=> String
resp.cluster.description #=> String
resp.cluster.status #=> String
resp.cluster.pending_updates.resharding.slot_migration.progress_percentage #=> Float
resp.cluster.pending_updates.acls.acl_to_apply #=> String
resp.cluster.pending_updates.service_updates #=> Array
resp.cluster.pending_updates.service_updates[0].service_update_name #=> String
resp.cluster.pending_updates.service_updates[0].status #=> String, one of "available", "in-progress", "complete", "scheduled"
resp.cluster.number_of_shards #=> Integer
resp.cluster.shards #=> Array
resp.cluster.shards[0].name #=> String
resp.cluster.shards[0].status #=> String
resp.cluster.shards[0].slots #=> String
resp.cluster.shards[0].nodes #=> Array
resp.cluster.shards[0].nodes[0].name #=> String
resp.cluster.shards[0].nodes[0].status #=> String
resp.cluster.shards[0].nodes[0].availability_zone #=> String
resp.cluster.shards[0].nodes[0].create_time #=> Time
resp.cluster.shards[0].nodes[0].endpoint.address #=> String
resp.cluster.shards[0].nodes[0].endpoint.port #=> Integer
resp.cluster.shards[0].number_of_nodes #=> Integer
resp.cluster.availability_mode #=> String, one of "singleaz", "multiaz"
resp.cluster.cluster_endpoint.address #=> String
resp.cluster.cluster_endpoint.port #=> Integer
resp.cluster.node_type #=> String
resp.cluster.engine_version #=> String
resp.cluster.engine_patch_version #=> String
resp.cluster.parameter_group_name #=> String
resp.cluster.parameter_group_status #=> String
resp.cluster.security_groups #=> Array
resp.cluster.security_groups[0].security_group_id #=> String
resp.cluster.security_groups[0].status #=> String
resp.cluster.subnet_group_name #=> String
resp.cluster.tls_enabled #=> Boolean
resp.cluster.kms_key_id #=> String
resp.cluster.arn #=> String
resp.cluster.sns_topic_arn #=> String
resp.cluster.sns_topic_status #=> String
resp.cluster.snapshot_retention_limit #=> Integer
resp.cluster.maintenance_window #=> String
resp.cluster.snapshot_window #=> String
resp.cluster.acl_name #=> String
resp.cluster.auto_minor_version_upgrade #=> Boolean
resp.cluster.data_tiering #=> String, one of "true", "false"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_name (required, String) —

    The name of the cluster to update

  • :description (String) —

    The description of the cluster to update

  • :security_group_ids (Array<String>) —

    The SecurityGroupIds to update

  • :maintenance_window (String) —

    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

  • :sns_topic_arn (String) —

    The SNS topic ARN to update

  • :sns_topic_status (String) —

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

  • :parameter_group_name (String) —

    The name of the parameter group to update

  • :snapshot_window (String) —

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

  • :snapshot_retention_limit (Integer) —

    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.

  • :node_type (String) —

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

  • :engine_version (String) —

    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.

  • :replica_configuration (Types::ReplicaConfigurationRequest) —

    The number of replicas that will reside in each shard

  • :shard_configuration (Types::ShardConfigurationRequest) —

    The number of shards in the cluster

  • :acl_name (String) —

    The Access Control List that is associated with the cluster

Returns:

See Also:



2827
2828
2829
2830
 
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 2827

def update_cluster(params = {}, options = {})
  req = build_request(:update_cluster, params)
  req.send_request(options)
end

#update_parameter_group(params = {}) ⇒ Types::UpdateParameterGroupResponse

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.

Examples:

Request syntax with placeholder values


resp = client.update_parameter_group({
  parameter_group_name: "String", # required
  parameter_name_values: [ # required
    {
      parameter_name: "String",
      parameter_value: "String",
    },
  ],
})

Response structure


resp.parameter_group.name #=> String
resp.parameter_group.family #=> String
resp.parameter_group.description #=> String
resp.parameter_group.arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :parameter_group_name (required, String) —

    The name of the parameter group to update.

  • :parameter_name_values (required, Array<Types::ParameterNameValue>) —

    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.

Returns:

See Also:



2872
2873
2874
2875
 
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 2872

def update_parameter_group(params = {}, options = {})
  req = build_request(:update_parameter_group, params)
  req.send_request(options)
end

#update_subnet_group(params = {}) ⇒ Types::UpdateSubnetGroupResponse

Updates a subnet group. For more information, see Updating a subnet group

Examples:

Request syntax with placeholder values


resp = client.update_subnet_group({
  subnet_group_name: "String", # required
  description: "String",
  subnet_ids: ["String"],
})

Response structure


resp.subnet_group.name #=> String
resp.subnet_group.description #=> String
resp.subnet_group.vpc_id #=> String
resp.subnet_group.subnets #=> Array
resp.subnet_group.subnets[0].identifier #=> String
resp.subnet_group.subnets[0].availability_zone.name #=> String
resp.subnet_group.arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :subnet_group_name (required, String) —

    The name of the subnet group

  • :description (String) —

    A description of the subnet group

  • :subnet_ids (Array<String>) —

    The EC2 subnet IDs for the subnet group.

Returns:

See Also:



2919
2920
2921
2922
 
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 2919

def update_subnet_group(params = {}, options = {})
  req = build_request(:update_subnet_group, params)
  req.send_request(options)
end

#update_user(params = {}) ⇒ Types::UpdateUserResponse

Changes user password(s) and/or access string.

Examples:

Request syntax with placeholder values


resp = client.update_user({
  user_name: "UserName", # required
  authentication_mode: {
    type: "password", # accepts password, iam
    passwords: ["String"],
  },
  access_string: "AccessString",
})

Response structure


resp.user.name #=> String
resp.user.status #=> String
resp.user.access_string #=> String
resp.user.acl_names #=> Array
resp.user.acl_names[0] #=> String
resp.user.minimum_engine_version #=> String
resp.user.authentication.type #=> String, one of "password", "no-password", "iam"
resp.user.authentication.password_count #=> Integer
resp.user.arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :user_name (required, String) —

    The name of the user

  • :authentication_mode (Types::AuthenticationMode) —

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

  • :access_string (String) —

    Access permissions string used for this user.

Returns:

See Also:



2967
2968
2969
2970
 
# File 'gems/aws-sdk-memorydb/lib/aws-sdk-memorydb/client.rb', line 2967

def update_user(params = {}, options = {})
  req = build_request(:update_user, params)
  req.send_request(options)
end