Class: Aws::DocDBElastic::Client

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

Overview

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

client = Aws::DocDBElastic::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 used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or 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.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :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 Aws::DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :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_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :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.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :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 the 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 - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.

  • :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
  • :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) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or 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::DocDBElastic::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::DocDBElastic::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.



471
472
473
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/client.rb', line 471

def initialize(*args)
  super
end

Instance Method Details

#apply_pending_maintenance_action(params = {}) ⇒ Types::ApplyPendingMaintenanceActionOutput

The type of pending maintenance action to be applied to the resource.

Examples:

Request syntax with placeholder values


resp = client.apply_pending_maintenance_action({
  apply_action: "InputString", # required
  apply_on: "InputString",
  opt_in_type: "IMMEDIATE", # required, accepts IMMEDIATE, NEXT_MAINTENANCE, APPLY_ON, UNDO_OPT_IN
  resource_arn: "InputString", # required
})

Response structure


resp.resource_pending_maintenance_action.pending_maintenance_action_details #=> Array
resp.resource_pending_maintenance_action.pending_maintenance_action_details[0].action #=> String
resp.resource_pending_maintenance_action.pending_maintenance_action_details[0].auto_applied_after_date #=> String
resp.resource_pending_maintenance_action.pending_maintenance_action_details[0].current_apply_date #=> String
resp.resource_pending_maintenance_action.pending_maintenance_action_details[0].description #=> String
resp.resource_pending_maintenance_action.pending_maintenance_action_details[0].forced_apply_date #=> String
resp.resource_pending_maintenance_action.pending_maintenance_action_details[0].opt_in_status #=> String
resp.resource_pending_maintenance_action.resource_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :apply_action (required, String) —

    The pending maintenance action to apply to the resource.

    Valid actions are:

    • ENGINE_UPDATE

    • ENGINE_UPGRADE

    • SECURITY_UPDATE

    • OS_UPDATE

    • MASTER_USER_PASSWORD_UPDATE

  • :apply_on (String) —

    A specific date to apply the pending maintenance action. Required if opt-in-type is APPLY_ON. Format: yyyy/MM/dd HH:mm-yyyy/MM/dd HH:mm

  • :opt_in_type (required, String) —

    A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in request of type IMMEDIATE can't be undone.

  • :resource_arn (required, String) —

    The Amazon DocumentDB Amazon Resource Name (ARN) of the resource to which the pending maintenance action applies.

Returns:

See Also:



534
535
536
537
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/client.rb', line 534

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

#copy_cluster_snapshot(params = {}) ⇒ Types::CopyClusterSnapshotOutput

Copies a snapshot of an elastic cluster.

Examples:

Request syntax with placeholder values


resp = client.copy_cluster_snapshot({
  copy_tags: false,
  kms_key_id: "String",
  snapshot_arn: "String", # required
  tags: {
    "TagKey" => "TagValue",
  },
  target_snapshot_name: "CopyClusterSnapshotInputTargetSnapshotNameString", # required
})

Response structure


resp.snapshot.admin_user_name #=> String
resp.snapshot.cluster_arn #=> String
resp.snapshot.cluster_creation_time #=> String
resp.snapshot.kms_key_id #=> String
resp.snapshot.snapshot_arn #=> String
resp.snapshot.snapshot_creation_time #=> String
resp.snapshot.snapshot_name #=> String
resp.snapshot.snapshot_type #=> String, one of "MANUAL", "AUTOMATED"
resp.snapshot.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "VPC_ENDPOINT_LIMIT_EXCEEDED", "IP_ADDRESS_LIMIT_EXCEEDED", "INVALID_SECURITY_GROUP_ID", "INVALID_SUBNET_ID", "INACCESSIBLE_ENCRYPTION_CREDS", "INACCESSIBLE_SECRET_ARN", "INACCESSIBLE_VPC_ENDPOINT", "INCOMPATIBLE_NETWORK", "MERGING", "MODIFYING", "SPLITTING", "COPYING", "STARTING", "STOPPING", "STOPPED", "MAINTENANCE", "INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE"
resp.snapshot.subnet_ids #=> Array
resp.snapshot.subnet_ids[0] #=> String
resp.snapshot.vpc_security_group_ids #=> Array
resp.snapshot.vpc_security_group_ids[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :copy_tags (Boolean) —

    Set to true to copy all tags from the source cluster snapshot to the target elastic cluster snapshot. The default is false.

  • :kms_key_id (String) —

    The Amazon Web Services KMS key ID for an encrypted elastic cluster snapshot. The Amazon Web Services KMS key ID is the Amazon Resource Name (ARN), Amazon Web Services KMS key identifier, or the Amazon Web Services KMS key alias for the Amazon Web Services KMS encryption key.

    If you copy an encrypted elastic cluster snapshot from your Amazon Web Services account, you can specify a value for KmsKeyId to encrypt the copy with a new Amazon Web ServicesS KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the elastic cluster snapshot is encrypted with the same AWS KMS key as the source elastic cluster snapshot.

    To copy an encrypted elastic cluster snapshot to another Amazon Web Services region, set KmsKeyId to the Amazon Web Services KMS key ID that you want to use to encrypt the copy of the elastic cluster snapshot in the destination region. Amazon Web Services KMS encryption keys are specific to the Amazon Web Services region that they are created in, and you can't use encryption keys from one Amazon Web Services region in another Amazon Web Services region.

    If you copy an unencrypted elastic cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

  • :snapshot_arn (required, String) —

    The Amazon Resource Name (ARN) identifier of the elastic cluster snapshot.

  • :tags (Hash<String,String>) —

    The tags to be assigned to the elastic cluster snapshot.

  • :target_snapshot_name (required, String) —

    The identifier of the new elastic cluster snapshot to create from the source cluster snapshot. This parameter is not case sensitive.

    Constraints:

    • Must contain from 1 to 63 letters, numbers, or hyphens.

    • The first character must be a letter.

    • Cannot end with a hyphen or contain two consecutive hyphens.

    Example: elastic-cluster-snapshot-5

Returns:

See Also:



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

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

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

Creates a new Amazon DocumentDB elastic cluster and returns its cluster structure.

Examples:

Request syntax with placeholder values


resp = client.create_cluster({
  admin_user_name: "String", # required
  admin_user_password: "Password", # required
  auth_type: "PLAIN_TEXT", # required, accepts PLAIN_TEXT, SECRET_ARN
  backup_retention_period: 1,
  client_token: "String",
  cluster_name: "String", # required
  kms_key_id: "String",
  preferred_backup_window: "String",
  preferred_maintenance_window: "String",
  shard_capacity: 1, # required
  shard_count: 1, # required
  shard_instance_count: 1,
  subnet_ids: ["String"],
  tags: {
    "TagKey" => "TagValue",
  },
  vpc_security_group_ids: ["String"],
})

Response structure


resp.cluster.admin_user_name #=> String
resp.cluster.auth_type #=> String, one of "PLAIN_TEXT", "SECRET_ARN"
resp.cluster.backup_retention_period #=> Integer
resp.cluster.cluster_arn #=> String
resp.cluster.cluster_endpoint #=> String
resp.cluster.cluster_name #=> String
resp.cluster.create_time #=> String
resp.cluster.kms_key_id #=> String
resp.cluster.preferred_backup_window #=> String
resp.cluster.preferred_maintenance_window #=> String
resp.cluster.shard_capacity #=> Integer
resp.cluster.shard_count #=> Integer
resp.cluster.shard_instance_count #=> Integer
resp.cluster.shards #=> Array
resp.cluster.shards[0].create_time #=> String
resp.cluster.shards[0].shard_id #=> String
resp.cluster.shards[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "VPC_ENDPOINT_LIMIT_EXCEEDED", "IP_ADDRESS_LIMIT_EXCEEDED", "INVALID_SECURITY_GROUP_ID", "INVALID_SUBNET_ID", "INACCESSIBLE_ENCRYPTION_CREDS", "INACCESSIBLE_SECRET_ARN", "INACCESSIBLE_VPC_ENDPOINT", "INCOMPATIBLE_NETWORK", "MERGING", "MODIFYING", "SPLITTING", "COPYING", "STARTING", "STOPPING", "STOPPED", "MAINTENANCE", "INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE"
resp.cluster.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "VPC_ENDPOINT_LIMIT_EXCEEDED", "IP_ADDRESS_LIMIT_EXCEEDED", "INVALID_SECURITY_GROUP_ID", "INVALID_SUBNET_ID", "INACCESSIBLE_ENCRYPTION_CREDS", "INACCESSIBLE_SECRET_ARN", "INACCESSIBLE_VPC_ENDPOINT", "INCOMPATIBLE_NETWORK", "MERGING", "MODIFYING", "SPLITTING", "COPYING", "STARTING", "STOPPING", "STOPPED", "MAINTENANCE", "INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE"
resp.cluster.subnet_ids #=> Array
resp.cluster.subnet_ids[0] #=> String
resp.cluster.vpc_security_group_ids #=> Array
resp.cluster.vpc_security_group_ids[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :admin_user_name (required, String) —

    The name of the Amazon DocumentDB elastic clusters administrator.

    Constraints:

    • Must be from 1 to 63 letters or numbers.

    • The first character must be a letter.

    • Cannot be a reserved word.

  • :admin_user_password (required, String) —

    The password for the Amazon DocumentDB elastic clusters administrator. The password can contain any printable ASCII characters.

    Constraints:

    • Must contain from 8 to 100 characters.

    • Cannot contain a forward slash (/), double quote ("), or the "at" symbol (@).

  • :auth_type (required, String) —

    The authentication type used to determine where to fetch the password used for accessing the elastic cluster. Valid types are PLAIN_TEXT or SECRET_ARN.

  • :backup_retention_period (Integer) —

    The number of days for which automatic snapshots are retained.

  • :client_token (String) —

    The client token for the elastic cluster.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :cluster_name (required, String) —

    The name of the new elastic cluster. This parameter is stored as a lowercase string.

    Constraints:

    • Must contain from 1 to 63 letters, numbers, or hyphens.

    • The first character must be a letter.

    • Cannot end with a hyphen or contain two consecutive hyphens.

    Example: my-cluster

  • :kms_key_id (String) —

    The KMS key identifier to use to encrypt the new elastic cluster.

    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key.

    If an encryption key is not specified, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.

  • :preferred_backup_window (String) —

    The daily time range during which automated backups are created if automated backups are enabled, as determined by the backupRetentionPeriod.

  • :preferred_maintenance_window (String) —

    The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

    Format: ddd:hh24:mi-ddd:hh24:mi

    Default: a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.

    Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

    Constraints: Minimum 30-minute window.

  • :shard_capacity (required, Integer) —

    The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.

  • :shard_count (required, Integer) —

    The number of shards assigned to the elastic cluster. Maximum is 32.

  • :shard_instance_count (Integer) —

    The number of replica instances applying to all shards in the elastic cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

  • :subnet_ids (Array<String>) —

    The Amazon EC2 subnet IDs for the new elastic cluster.

  • :tags (Hash<String,String>) —

    The tags to be assigned to the new elastic cluster.

  • :vpc_security_group_ids (Array<String>) —

    A list of EC2 VPC security groups to associate with the new elastic cluster.

Returns:

See Also:



793
794
795
796
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/client.rb', line 793

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

#create_cluster_snapshot(params = {}) ⇒ Types::CreateClusterSnapshotOutput

Creates a snapshot of an elastic cluster.

Examples:

Request syntax with placeholder values


resp = client.create_cluster_snapshot({
  cluster_arn: "String", # required
  snapshot_name: "CreateClusterSnapshotInputSnapshotNameString", # required
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.snapshot.admin_user_name #=> String
resp.snapshot.cluster_arn #=> String
resp.snapshot.cluster_creation_time #=> String
resp.snapshot.kms_key_id #=> String
resp.snapshot.snapshot_arn #=> String
resp.snapshot.snapshot_creation_time #=> String
resp.snapshot.snapshot_name #=> String
resp.snapshot.snapshot_type #=> String, one of "MANUAL", "AUTOMATED"
resp.snapshot.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "VPC_ENDPOINT_LIMIT_EXCEEDED", "IP_ADDRESS_LIMIT_EXCEEDED", "INVALID_SECURITY_GROUP_ID", "INVALID_SUBNET_ID", "INACCESSIBLE_ENCRYPTION_CREDS", "INACCESSIBLE_SECRET_ARN", "INACCESSIBLE_VPC_ENDPOINT", "INCOMPATIBLE_NETWORK", "MERGING", "MODIFYING", "SPLITTING", "COPYING", "STARTING", "STOPPING", "STOPPED", "MAINTENANCE", "INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE"
resp.snapshot.subnet_ids #=> Array
resp.snapshot.subnet_ids[0] #=> String
resp.snapshot.vpc_security_group_ids #=> Array
resp.snapshot.vpc_security_group_ids[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :cluster_arn (required, String) —

    The ARN identifier of the elastic cluster of which you want to create a snapshot.

  • :snapshot_name (required, String) —

    The name of the new elastic cluster snapshot.

  • :tags (Hash<String,String>) —

    The tags to be assigned to the new elastic cluster snapshot.

Returns:

See Also:



844
845
846
847
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/client.rb', line 844

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

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

Delete an elastic cluster.

Examples:

Request syntax with placeholder values


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

Response structure


resp.cluster.admin_user_name #=> String
resp.cluster.auth_type #=> String, one of "PLAIN_TEXT", "SECRET_ARN"
resp.cluster.backup_retention_period #=> Integer
resp.cluster.cluster_arn #=> String
resp.cluster.cluster_endpoint #=> String
resp.cluster.cluster_name #=> String
resp.cluster.create_time #=> String
resp.cluster.kms_key_id #=> String
resp.cluster.preferred_backup_window #=> String
resp.cluster.preferred_maintenance_window #=> String
resp.cluster.shard_capacity #=> Integer
resp.cluster.shard_count #=> Integer
resp.cluster.shard_instance_count #=> Integer
resp.cluster.shards #=> Array
resp.cluster.shards[0].create_time #=> String
resp.cluster.shards[0].shard_id #=> String
resp.cluster.shards[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "VPC_ENDPOINT_LIMIT_EXCEEDED", "IP_ADDRESS_LIMIT_EXCEEDED", "INVALID_SECURITY_GROUP_ID", "INVALID_SUBNET_ID", "INACCESSIBLE_ENCRYPTION_CREDS", "INACCESSIBLE_SECRET_ARN", "INACCESSIBLE_VPC_ENDPOINT", "INCOMPATIBLE_NETWORK", "MERGING", "MODIFYING", "SPLITTING", "COPYING", "STARTING", "STOPPING", "STOPPED", "MAINTENANCE", "INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE"
resp.cluster.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "VPC_ENDPOINT_LIMIT_EXCEEDED", "IP_ADDRESS_LIMIT_EXCEEDED", "INVALID_SECURITY_GROUP_ID", "INVALID_SUBNET_ID", "INACCESSIBLE_ENCRYPTION_CREDS", "INACCESSIBLE_SECRET_ARN", "INACCESSIBLE_VPC_ENDPOINT", "INCOMPATIBLE_NETWORK", "MERGING", "MODIFYING", "SPLITTING", "COPYING", "STARTING", "STOPPING", "STOPPED", "MAINTENANCE", "INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE"
resp.cluster.subnet_ids #=> Array
resp.cluster.subnet_ids[0] #=> String
resp.cluster.vpc_security_group_ids #=> Array
resp.cluster.vpc_security_group_ids[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :cluster_arn (required, String) —

    The ARN identifier of the elastic cluster that is to be deleted.

Returns:

See Also:



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

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

#delete_cluster_snapshot(params = {}) ⇒ Types::DeleteClusterSnapshotOutput

Delete an elastic cluster snapshot.

Examples:

Request syntax with placeholder values


resp = client.delete_cluster_snapshot({
  snapshot_arn: "String", # required
})

Response structure


resp.snapshot.admin_user_name #=> String
resp.snapshot.cluster_arn #=> String
resp.snapshot.cluster_creation_time #=> String
resp.snapshot.kms_key_id #=> String
resp.snapshot.snapshot_arn #=> String
resp.snapshot.snapshot_creation_time #=> String
resp.snapshot.snapshot_name #=> String
resp.snapshot.snapshot_type #=> String, one of "MANUAL", "AUTOMATED"
resp.snapshot.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "VPC_ENDPOINT_LIMIT_EXCEEDED", "IP_ADDRESS_LIMIT_EXCEEDED", "INVALID_SECURITY_GROUP_ID", "INVALID_SUBNET_ID", "INACCESSIBLE_ENCRYPTION_CREDS", "INACCESSIBLE_SECRET_ARN", "INACCESSIBLE_VPC_ENDPOINT", "INCOMPATIBLE_NETWORK", "MERGING", "MODIFYING", "SPLITTING", "COPYING", "STARTING", "STOPPING", "STOPPED", "MAINTENANCE", "INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE"
resp.snapshot.subnet_ids #=> Array
resp.snapshot.subnet_ids[0] #=> String
resp.snapshot.vpc_security_group_ids #=> Array
resp.snapshot.vpc_security_group_ids[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :snapshot_arn (required, String) —

    The ARN identifier of the elastic cluster snapshot that is to be deleted.

Returns:

See Also:



934
935
936
937
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/client.rb', line 934

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

#get_cluster(params = {}) ⇒ Types::GetClusterOutput

Returns information about a specific elastic cluster.

Examples:

Request syntax with placeholder values


resp = client.get_cluster({
  cluster_arn: "String", # required
})

Response structure


resp.cluster.admin_user_name #=> String
resp.cluster.auth_type #=> String, one of "PLAIN_TEXT", "SECRET_ARN"
resp.cluster.backup_retention_period #=> Integer
resp.cluster.cluster_arn #=> String
resp.cluster.cluster_endpoint #=> String
resp.cluster.cluster_name #=> String
resp.cluster.create_time #=> String
resp.cluster.kms_key_id #=> String
resp.cluster.preferred_backup_window #=> String
resp.cluster.preferred_maintenance_window #=> String
resp.cluster.shard_capacity #=> Integer
resp.cluster.shard_count #=> Integer
resp.cluster.shard_instance_count #=> Integer
resp.cluster.shards #=> Array
resp.cluster.shards[0].create_time #=> String
resp.cluster.shards[0].shard_id #=> String
resp.cluster.shards[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "VPC_ENDPOINT_LIMIT_EXCEEDED", "IP_ADDRESS_LIMIT_EXCEEDED", "INVALID_SECURITY_GROUP_ID", "INVALID_SUBNET_ID", "INACCESSIBLE_ENCRYPTION_CREDS", "INACCESSIBLE_SECRET_ARN", "INACCESSIBLE_VPC_ENDPOINT", "INCOMPATIBLE_NETWORK", "MERGING", "MODIFYING", "SPLITTING", "COPYING", "STARTING", "STOPPING", "STOPPED", "MAINTENANCE", "INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE"
resp.cluster.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "VPC_ENDPOINT_LIMIT_EXCEEDED", "IP_ADDRESS_LIMIT_EXCEEDED", "INVALID_SECURITY_GROUP_ID", "INVALID_SUBNET_ID", "INACCESSIBLE_ENCRYPTION_CREDS", "INACCESSIBLE_SECRET_ARN", "INACCESSIBLE_VPC_ENDPOINT", "INCOMPATIBLE_NETWORK", "MERGING", "MODIFYING", "SPLITTING", "COPYING", "STARTING", "STOPPING", "STOPPED", "MAINTENANCE", "INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE"
resp.cluster.subnet_ids #=> Array
resp.cluster.subnet_ids[0] #=> String
resp.cluster.vpc_security_group_ids #=> Array
resp.cluster.vpc_security_group_ids[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :cluster_arn (required, String) —

    The ARN identifier of the elastic cluster.

Returns:

See Also:



983
984
985
986
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/client.rb', line 983

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

#get_cluster_snapshot(params = {}) ⇒ Types::GetClusterSnapshotOutput

Returns information about a specific elastic cluster snapshot

Examples:

Request syntax with placeholder values


resp = client.get_cluster_snapshot({
  snapshot_arn: "String", # required
})

Response structure


resp.snapshot.admin_user_name #=> String
resp.snapshot.cluster_arn #=> String
resp.snapshot.cluster_creation_time #=> String
resp.snapshot.kms_key_id #=> String
resp.snapshot.snapshot_arn #=> String
resp.snapshot.snapshot_creation_time #=> String
resp.snapshot.snapshot_name #=> String
resp.snapshot.snapshot_type #=> String, one of "MANUAL", "AUTOMATED"
resp.snapshot.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "VPC_ENDPOINT_LIMIT_EXCEEDED", "IP_ADDRESS_LIMIT_EXCEEDED", "INVALID_SECURITY_GROUP_ID", "INVALID_SUBNET_ID", "INACCESSIBLE_ENCRYPTION_CREDS", "INACCESSIBLE_SECRET_ARN", "INACCESSIBLE_VPC_ENDPOINT", "INCOMPATIBLE_NETWORK", "MERGING", "MODIFYING", "SPLITTING", "COPYING", "STARTING", "STOPPING", "STOPPED", "MAINTENANCE", "INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE"
resp.snapshot.subnet_ids #=> Array
resp.snapshot.subnet_ids[0] #=> String
resp.snapshot.vpc_security_group_ids #=> Array
resp.snapshot.vpc_security_group_ids[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :snapshot_arn (required, String) —

    The ARN identifier of the elastic cluster snapshot.

Returns:

See Also:



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

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

#get_pending_maintenance_action(params = {}) ⇒ Types::GetPendingMaintenanceActionOutput

Retrieves all maintenance actions that are pending.

Examples:

Request syntax with placeholder values


resp = client.get_pending_maintenance_action({
  resource_arn: "InputString", # required
})

Response structure


resp.resource_pending_maintenance_action.pending_maintenance_action_details #=> Array
resp.resource_pending_maintenance_action.pending_maintenance_action_details[0].action #=> String
resp.resource_pending_maintenance_action.pending_maintenance_action_details[0].auto_applied_after_date #=> String
resp.resource_pending_maintenance_action.pending_maintenance_action_details[0].current_apply_date #=> String
resp.resource_pending_maintenance_action.pending_maintenance_action_details[0].description #=> String
resp.resource_pending_maintenance_action.pending_maintenance_action_details[0].forced_apply_date #=> String
resp.resource_pending_maintenance_action.pending_maintenance_action_details[0].opt_in_status #=> String
resp.resource_pending_maintenance_action.resource_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    Retrieves pending maintenance actions for a specific Amazon Resource Name (ARN).

Returns:

See Also:



1059
1060
1061
1062
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/client.rb', line 1059

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

#list_cluster_snapshots(params = {}) ⇒ Types::ListClusterSnapshotsOutput

Returns information about snapshots for a specified elastic 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.list_cluster_snapshots({
  cluster_arn: "String",
  max_results: 1,
  next_token: "PaginationToken",
  snapshot_type: "String",
})

Response structure


resp.next_token #=> String
resp.snapshots #=> Array
resp.snapshots[0].cluster_arn #=> String
resp.snapshots[0].snapshot_arn #=> String
resp.snapshots[0].snapshot_creation_time #=> String
resp.snapshots[0].snapshot_name #=> String
resp.snapshots[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "VPC_ENDPOINT_LIMIT_EXCEEDED", "IP_ADDRESS_LIMIT_EXCEEDED", "INVALID_SECURITY_GROUP_ID", "INVALID_SUBNET_ID", "INACCESSIBLE_ENCRYPTION_CREDS", "INACCESSIBLE_SECRET_ARN", "INACCESSIBLE_VPC_ENDPOINT", "INCOMPATIBLE_NETWORK", "MERGING", "MODIFYING", "SPLITTING", "COPYING", "STARTING", "STOPPING", "STOPPED", "MAINTENANCE", "INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE"

Parameters:

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

    ({})

Options Hash (params):

  • :cluster_arn (String) —

    The ARN identifier of the elastic cluster.

  • :max_results (Integer) —

    The maximum number of elastic cluster snapshot results to receive in the response.

  • :next_token (String) —

    A pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond this token, up to the value specified by max-results.

    If there is no more data in the responce, the nextToken will not be returned.

  • :snapshot_type (String) —

    The type of cluster snapshots to be returned. You can specify one of the following values:

    • automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.

    • manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.

Returns:

See Also:



1121
1122
1123
1124
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/client.rb', line 1121

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

#list_clusters(params = {}) ⇒ Types::ListClustersOutput

Returns information about provisioned Amazon DocumentDB elastic clusters.

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

Examples:

Request syntax with placeholder values


resp = client.list_clusters({
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.clusters #=> Array
resp.clusters[0].cluster_arn #=> String
resp.clusters[0].cluster_name #=> String
resp.clusters[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "VPC_ENDPOINT_LIMIT_EXCEEDED", "IP_ADDRESS_LIMIT_EXCEEDED", "INVALID_SECURITY_GROUP_ID", "INVALID_SUBNET_ID", "INACCESSIBLE_ENCRYPTION_CREDS", "INACCESSIBLE_SECRET_ARN", "INACCESSIBLE_VPC_ENDPOINT", "INCOMPATIBLE_NETWORK", "MERGING", "MODIFYING", "SPLITTING", "COPYING", "STARTING", "STOPPING", "STOPPED", "MAINTENANCE", "INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of elastic cluster snapshot results to receive in the response.

  • :next_token (String) —

    A pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond this token, up to the value specified by max-results.

    If there is no more data in the responce, the nextToken will not be returned.

Returns:

See Also:



1167
1168
1169
1170
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/client.rb', line 1167

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

#list_pending_maintenance_actions(params = {}) ⇒ Types::ListPendingMaintenanceActionsOutput

Retrieves a list of all maintenance actions that are pending.

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

Examples:

Request syntax with placeholder values


resp = client.list_pending_maintenance_actions({
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.next_token #=> String
resp.resource_pending_maintenance_actions #=> Array
resp.resource_pending_maintenance_actions[0].pending_maintenance_action_details #=> Array
resp.resource_pending_maintenance_actions[0].pending_maintenance_action_details[0].action #=> String
resp.resource_pending_maintenance_actions[0].pending_maintenance_action_details[0].auto_applied_after_date #=> String
resp.resource_pending_maintenance_actions[0].pending_maintenance_action_details[0].current_apply_date #=> String
resp.resource_pending_maintenance_actions[0].pending_maintenance_action_details[0].description #=> String
resp.resource_pending_maintenance_actions[0].pending_maintenance_action_details[0].forced_apply_date #=> String
resp.resource_pending_maintenance_actions[0].pending_maintenance_action_details[0].opt_in_status #=> String
resp.resource_pending_maintenance_actions[0].resource_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

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

  • :next_token (String) —

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by maxResults.

Returns:

See Also:



1216
1217
1218
1219
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/client.rb', line 1216

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

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Lists all tags on a elastic cluster resource

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "Arn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN identifier of the elastic cluster resource.

Returns:

See Also:



1245
1246
1247
1248
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/client.rb', line 1245

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

#restore_cluster_from_snapshot(params = {}) ⇒ Types::RestoreClusterFromSnapshotOutput

Restores an elastic cluster from a snapshot.

Examples:

Request syntax with placeholder values


resp = client.restore_cluster_from_snapshot({
  cluster_name: "String", # required
  kms_key_id: "String",
  shard_capacity: 1,
  shard_instance_count: 1,
  snapshot_arn: "String", # required
  subnet_ids: ["String"],
  tags: {
    "TagKey" => "TagValue",
  },
  vpc_security_group_ids: ["String"],
})

Response structure


resp.cluster.admin_user_name #=> String
resp.cluster.auth_type #=> String, one of "PLAIN_TEXT", "SECRET_ARN"
resp.cluster.backup_retention_period #=> Integer
resp.cluster.cluster_arn #=> String
resp.cluster.cluster_endpoint #=> String
resp.cluster.cluster_name #=> String
resp.cluster.create_time #=> String
resp.cluster.kms_key_id #=> String
resp.cluster.preferred_backup_window #=> String
resp.cluster.preferred_maintenance_window #=> String
resp.cluster.shard_capacity #=> Integer
resp.cluster.shard_count #=> Integer
resp.cluster.shard_instance_count #=> Integer
resp.cluster.shards #=> Array
resp.cluster.shards[0].create_time #=> String
resp.cluster.shards[0].shard_id #=> String
resp.cluster.shards[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "VPC_ENDPOINT_LIMIT_EXCEEDED", "IP_ADDRESS_LIMIT_EXCEEDED", "INVALID_SECURITY_GROUP_ID", "INVALID_SUBNET_ID", "INACCESSIBLE_ENCRYPTION_CREDS", "INACCESSIBLE_SECRET_ARN", "INACCESSIBLE_VPC_ENDPOINT", "INCOMPATIBLE_NETWORK", "MERGING", "MODIFYING", "SPLITTING", "COPYING", "STARTING", "STOPPING", "STOPPED", "MAINTENANCE", "INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE"
resp.cluster.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "VPC_ENDPOINT_LIMIT_EXCEEDED", "IP_ADDRESS_LIMIT_EXCEEDED", "INVALID_SECURITY_GROUP_ID", "INVALID_SUBNET_ID", "INACCESSIBLE_ENCRYPTION_CREDS", "INACCESSIBLE_SECRET_ARN", "INACCESSIBLE_VPC_ENDPOINT", "INCOMPATIBLE_NETWORK", "MERGING", "MODIFYING", "SPLITTING", "COPYING", "STARTING", "STOPPING", "STOPPED", "MAINTENANCE", "INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE"
resp.cluster.subnet_ids #=> Array
resp.cluster.subnet_ids[0] #=> String
resp.cluster.vpc_security_group_ids #=> Array
resp.cluster.vpc_security_group_ids[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :cluster_name (required, String) —

    The name of the elastic cluster.

  • :kms_key_id (String) —

    The KMS key identifier to use to encrypt the new Amazon DocumentDB elastic clusters cluster.

    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key.

    If an encryption key is not specified here, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.

  • :shard_capacity (Integer) —

    The capacity of each shard in the new restored elastic cluster.

  • :shard_instance_count (Integer) —

    The number of replica instances applying to all shards in the elastic cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

  • :snapshot_arn (required, String) —

    The ARN identifier of the elastic cluster snapshot.

  • :subnet_ids (Array<String>) —

    The Amazon EC2 subnet IDs for the elastic cluster.

  • :tags (Hash<String,String>) —

    A list of the tag names to be assigned to the restored elastic cluster, in the form of an array of key-value pairs in which the key is the tag name and the value is the key value.

  • :vpc_security_group_ids (Array<String>) —

    A list of EC2 VPC security groups to associate with the elastic cluster.

Returns:

See Also:



1340
1341
1342
1343
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/client.rb', line 1340

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

#start_cluster(params = {}) ⇒ Types::StartClusterOutput

Restarts the stopped elastic cluster that is specified by clusterARN.

Examples:

Request syntax with placeholder values


resp = client.start_cluster({
  cluster_arn: "String", # required
})

Response structure


resp.cluster.admin_user_name #=> String
resp.cluster.auth_type #=> String, one of "PLAIN_TEXT", "SECRET_ARN"
resp.cluster.backup_retention_period #=> Integer
resp.cluster.cluster_arn #=> String
resp.cluster.cluster_endpoint #=> String
resp.cluster.cluster_name #=> String
resp.cluster.create_time #=> String
resp.cluster.kms_key_id #=> String
resp.cluster.preferred_backup_window #=> String
resp.cluster.preferred_maintenance_window #=> String
resp.cluster.shard_capacity #=> Integer
resp.cluster.shard_count #=> Integer
resp.cluster.shard_instance_count #=> Integer
resp.cluster.shards #=> Array
resp.cluster.shards[0].create_time #=> String
resp.cluster.shards[0].shard_id #=> String
resp.cluster.shards[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "VPC_ENDPOINT_LIMIT_EXCEEDED", "IP_ADDRESS_LIMIT_EXCEEDED", "INVALID_SECURITY_GROUP_ID", "INVALID_SUBNET_ID", "INACCESSIBLE_ENCRYPTION_CREDS", "INACCESSIBLE_SECRET_ARN", "INACCESSIBLE_VPC_ENDPOINT", "INCOMPATIBLE_NETWORK", "MERGING", "MODIFYING", "SPLITTING", "COPYING", "STARTING", "STOPPING", "STOPPED", "MAINTENANCE", "INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE"
resp.cluster.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "VPC_ENDPOINT_LIMIT_EXCEEDED", "IP_ADDRESS_LIMIT_EXCEEDED", "INVALID_SECURITY_GROUP_ID", "INVALID_SUBNET_ID", "INACCESSIBLE_ENCRYPTION_CREDS", "INACCESSIBLE_SECRET_ARN", "INACCESSIBLE_VPC_ENDPOINT", "INCOMPATIBLE_NETWORK", "MERGING", "MODIFYING", "SPLITTING", "COPYING", "STARTING", "STOPPING", "STOPPED", "MAINTENANCE", "INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE"
resp.cluster.subnet_ids #=> Array
resp.cluster.subnet_ids[0] #=> String
resp.cluster.vpc_security_group_ids #=> Array
resp.cluster.vpc_security_group_ids[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :cluster_arn (required, String) —

    The ARN identifier of the elastic cluster.

Returns:

See Also:



1390
1391
1392
1393
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/client.rb', line 1390

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

#stop_cluster(params = {}) ⇒ Types::StopClusterOutput

Stops the running elastic cluster that is specified by clusterArn. The elastic cluster must be in the available state.

Examples:

Request syntax with placeholder values


resp = client.stop_cluster({
  cluster_arn: "String", # required
})

Response structure


resp.cluster.admin_user_name #=> String
resp.cluster.auth_type #=> String, one of "PLAIN_TEXT", "SECRET_ARN"
resp.cluster.backup_retention_period #=> Integer
resp.cluster.cluster_arn #=> String
resp.cluster.cluster_endpoint #=> String
resp.cluster.cluster_name #=> String
resp.cluster.create_time #=> String
resp.cluster.kms_key_id #=> String
resp.cluster.preferred_backup_window #=> String
resp.cluster.preferred_maintenance_window #=> String
resp.cluster.shard_capacity #=> Integer
resp.cluster.shard_count #=> Integer
resp.cluster.shard_instance_count #=> Integer
resp.cluster.shards #=> Array
resp.cluster.shards[0].create_time #=> String
resp.cluster.shards[0].shard_id #=> String
resp.cluster.shards[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "VPC_ENDPOINT_LIMIT_EXCEEDED", "IP_ADDRESS_LIMIT_EXCEEDED", "INVALID_SECURITY_GROUP_ID", "INVALID_SUBNET_ID", "INACCESSIBLE_ENCRYPTION_CREDS", "INACCESSIBLE_SECRET_ARN", "INACCESSIBLE_VPC_ENDPOINT", "INCOMPATIBLE_NETWORK", "MERGING", "MODIFYING", "SPLITTING", "COPYING", "STARTING", "STOPPING", "STOPPED", "MAINTENANCE", "INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE"
resp.cluster.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "VPC_ENDPOINT_LIMIT_EXCEEDED", "IP_ADDRESS_LIMIT_EXCEEDED", "INVALID_SECURITY_GROUP_ID", "INVALID_SUBNET_ID", "INACCESSIBLE_ENCRYPTION_CREDS", "INACCESSIBLE_SECRET_ARN", "INACCESSIBLE_VPC_ENDPOINT", "INCOMPATIBLE_NETWORK", "MERGING", "MODIFYING", "SPLITTING", "COPYING", "STARTING", "STOPPING", "STOPPED", "MAINTENANCE", "INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE"
resp.cluster.subnet_ids #=> Array
resp.cluster.subnet_ids[0] #=> String
resp.cluster.vpc_security_group_ids #=> Array
resp.cluster.vpc_security_group_ids[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :cluster_arn (required, String) —

    The ARN identifier of the elastic cluster.

Returns:

See Also:



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

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

#tag_resource(params = {}) ⇒ Struct

Adds metadata tags to an elastic cluster resource

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "Arn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN identifier of the elastic cluster resource.

  • :tags (required, Hash<String,String>) —

    The tags that are assigned to the elastic cluster resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1468
1469
1470
1471
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/client.rb', line 1468

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

#untag_resource(params = {}) ⇒ Struct

Removes metadata tags from an elastic cluster resource

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN identifier of the elastic cluster resource.

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

    The tag keys to be removed from the elastic cluster resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1494
1495
1496
1497
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/client.rb', line 1494

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

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

Modifies an elastic cluster. This includes updating admin-username/password, upgrading the API version, and setting up a backup window and maintenance window

Examples:

Request syntax with placeholder values


resp = client.update_cluster({
  admin_user_password: "Password",
  auth_type: "PLAIN_TEXT", # accepts PLAIN_TEXT, SECRET_ARN
  backup_retention_period: 1,
  client_token: "String",
  cluster_arn: "String", # required
  preferred_backup_window: "String",
  preferred_maintenance_window: "String",
  shard_capacity: 1,
  shard_count: 1,
  shard_instance_count: 1,
  subnet_ids: ["String"],
  vpc_security_group_ids: ["String"],
})

Response structure


resp.cluster.admin_user_name #=> String
resp.cluster.auth_type #=> String, one of "PLAIN_TEXT", "SECRET_ARN"
resp.cluster.backup_retention_period #=> Integer
resp.cluster.cluster_arn #=> String
resp.cluster.cluster_endpoint #=> String
resp.cluster.cluster_name #=> String
resp.cluster.create_time #=> String
resp.cluster.kms_key_id #=> String
resp.cluster.preferred_backup_window #=> String
resp.cluster.preferred_maintenance_window #=> String
resp.cluster.shard_capacity #=> Integer
resp.cluster.shard_count #=> Integer
resp.cluster.shard_instance_count #=> Integer
resp.cluster.shards #=> Array
resp.cluster.shards[0].create_time #=> String
resp.cluster.shards[0].shard_id #=> String
resp.cluster.shards[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "VPC_ENDPOINT_LIMIT_EXCEEDED", "IP_ADDRESS_LIMIT_EXCEEDED", "INVALID_SECURITY_GROUP_ID", "INVALID_SUBNET_ID", "INACCESSIBLE_ENCRYPTION_CREDS", "INACCESSIBLE_SECRET_ARN", "INACCESSIBLE_VPC_ENDPOINT", "INCOMPATIBLE_NETWORK", "MERGING", "MODIFYING", "SPLITTING", "COPYING", "STARTING", "STOPPING", "STOPPED", "MAINTENANCE", "INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE"
resp.cluster.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "VPC_ENDPOINT_LIMIT_EXCEEDED", "IP_ADDRESS_LIMIT_EXCEEDED", "INVALID_SECURITY_GROUP_ID", "INVALID_SUBNET_ID", "INACCESSIBLE_ENCRYPTION_CREDS", "INACCESSIBLE_SECRET_ARN", "INACCESSIBLE_VPC_ENDPOINT", "INCOMPATIBLE_NETWORK", "MERGING", "MODIFYING", "SPLITTING", "COPYING", "STARTING", "STOPPING", "STOPPED", "MAINTENANCE", "INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE"
resp.cluster.subnet_ids #=> Array
resp.cluster.subnet_ids[0] #=> String
resp.cluster.vpc_security_group_ids #=> Array
resp.cluster.vpc_security_group_ids[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :admin_user_password (String) —

    The password associated with the elastic cluster administrator. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

    Constraints: Must contain from 8 to 100 characters.

  • :auth_type (String) —

    The authentication type used to determine where to fetch the password used for accessing the elastic cluster. Valid types are PLAIN_TEXT or SECRET_ARN.

  • :backup_retention_period (Integer) —

    The number of days for which automatic snapshots are retained.

  • :client_token (String) —

    The client token for the elastic cluster.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :cluster_arn (required, String) —

    The ARN identifier of the elastic cluster.

  • :preferred_backup_window (String) —

    The daily time range during which automated backups are created if automated backups are enabled, as determined by the backupRetentionPeriod.

  • :preferred_maintenance_window (String) —

    The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

    Format: ddd:hh24:mi-ddd:hh24:mi

    Default: a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.

    Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

    Constraints: Minimum 30-minute window.

  • :shard_capacity (Integer) —

    The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.

  • :shard_count (Integer) —

    The number of shards assigned to the elastic cluster. Maximum is 32.

  • :shard_instance_count (Integer) —

    The number of replica instances applying to all shards in the elastic cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

  • :subnet_ids (Array<String>) —

    The Amazon EC2 subnet IDs for the elastic cluster.

  • :vpc_security_group_ids (Array<String>) —

    A list of EC2 VPC security groups to associate with the elastic cluster.

Returns:

See Also:



1616
1617
1618
1619
 
# File 'gems/aws-sdk-docdbelastic/lib/aws-sdk-docdbelastic/client.rb', line 1616

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