Class: Aws::Neptune::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-neptune/client.rb,
sig/client.rbs

Overview

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

client = Aws::Neptune::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.

Defined Under Namespace

Modules: _AddSourceIdentifierToSubscriptionResponseSuccess, _ApplyPendingMaintenanceActionResponseSuccess, _CopyDBClusterParameterGroupResponseSuccess, _CopyDBClusterSnapshotResponseSuccess, _CopyDBParameterGroupResponseSuccess, _CreateDBClusterEndpointResponseSuccess, _CreateDBClusterParameterGroupResponseSuccess, _CreateDBClusterResponseSuccess, _CreateDBClusterSnapshotResponseSuccess, _CreateDBInstanceResponseSuccess, _CreateDBParameterGroupResponseSuccess, _CreateDBSubnetGroupResponseSuccess, _CreateEventSubscriptionResponseSuccess, _CreateGlobalClusterResponseSuccess, _DeleteDBClusterEndpointResponseSuccess, _DeleteDBClusterResponseSuccess, _DeleteDBClusterSnapshotResponseSuccess, _DeleteDBInstanceResponseSuccess, _DeleteEventSubscriptionResponseSuccess, _DeleteGlobalClusterResponseSuccess, _DescribeDBClusterEndpointsResponseSuccess, _DescribeDBClusterParameterGroupsResponseSuccess, _DescribeDBClusterParametersResponseSuccess, _DescribeDBClusterSnapshotAttributesResponseSuccess, _DescribeDBClusterSnapshotsResponseSuccess, _DescribeDBClustersResponseSuccess, _DescribeDBEngineVersionsResponseSuccess, _DescribeDBInstancesResponseSuccess, _DescribeDBParameterGroupsResponseSuccess, _DescribeDBParametersResponseSuccess, _DescribeDBSubnetGroupsResponseSuccess, _DescribeEngineDefaultClusterParametersResponseSuccess, _DescribeEngineDefaultParametersResponseSuccess, _DescribeEventCategoriesResponseSuccess, _DescribeEventSubscriptionsResponseSuccess, _DescribeEventsResponseSuccess, _DescribeGlobalClustersResponseSuccess, _DescribeOrderableDBInstanceOptionsResponseSuccess, _DescribePendingMaintenanceActionsResponseSuccess, _DescribeValidDBInstanceModificationsResponseSuccess, _FailoverDBClusterResponseSuccess, _FailoverGlobalClusterResponseSuccess, _ListTagsForResourceResponseSuccess, _ModifyDBClusterEndpointResponseSuccess, _ModifyDBClusterParameterGroupResponseSuccess, _ModifyDBClusterResponseSuccess, _ModifyDBClusterSnapshotAttributeResponseSuccess, _ModifyDBInstanceResponseSuccess, _ModifyDBParameterGroupResponseSuccess, _ModifyDBSubnetGroupResponseSuccess, _ModifyEventSubscriptionResponseSuccess, _ModifyGlobalClusterResponseSuccess, _PromoteReadReplicaDBClusterResponseSuccess, _RebootDBInstanceResponseSuccess, _RemoveFromGlobalClusterResponseSuccess, _RemoveSourceIdentifierFromSubscriptionResponseSuccess, _ResetDBClusterParameterGroupResponseSuccess, _ResetDBParameterGroupResponseSuccess, _RestoreDBClusterFromSnapshotResponseSuccess, _RestoreDBClusterToPointInTimeResponseSuccess, _StartDBClusterResponseSuccess, _StopDBClusterResponseSuccess, _SwitchoverGlobalClusterResponseSuccess

Constant Summary collapse

Params =

Returns:

  • (:parameter) 

      
    

  




  
Class Attribute Summary collapse

  




  
    

      API Operations
      collapse
    


    
    
  
    

      Class Method Summary
      collapse
    


    
    
  
    

      Instance Method Summary
      collapse
    


    
    
  


  
  

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

  








  

    
      


473
474
475

    		
    
      
# File 'lib/aws-sdk-neptune/client.rb', line 473

def initialize(*args)
  super
end

    		
  





  



  

    
Class Attribute Details

    
      
      
      

  

  
    .identifier  ⇒ Object  (readonly)
  

  

  




  

    

  This method is part of a private API.
  You should avoid using this method if possible, as it may be removed or be changed in the future.




  





  



  

    
      


8049
8050
8051

    		
    
      
# File 'lib/aws-sdk-neptune/client.rb', line 8049

def identifier
  @identifier
end

    		
  





    
  



  

    
Class Method Details


    
      

  

  
    .errors_module  ⇒ Object 
  

  

  




  

    

  This method is part of a private API.
  You should avoid using this method if possible, as it may be removed or be changed in the future.




  





  



  

    
      


8052
8053
8054

    		
    
      
# File 'lib/aws-sdk-neptune/client.rb', line 8052

def errors_module
  Errors
end

    		
  





    
      

  

  
    .new  ⇒ Object 
  

  

  




  

    
https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Neptune/Client.html#initialize-instance_method


  





  



  

    
      


14

    		
    
      
# File 'sig/client.rbs', line 14

def self.new: (

    		
  





    
  


  

    
Instance Method Details


    
      

  

  
    #add_role_to_db_cluster(params = {})  ⇒ Struct 
  

  

  




  

    
Associates an Identity and Access Management (IAM) role with an
Neptune DB cluster.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.add_role_to_db_cluster({
  db_cluster_identifier: "String", # required
  role_arn: "String", # required
  feature_name: "String",
})

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :db_cluster_identifier
          (required, String)
          
            
          
          
            — 
    The name of the DB cluster to associate the IAM role with.
    
          
        
    • 
      
        
  • 
          :role_arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the IAM role to associate with the
Neptune DB cluster, for example
arn:aws:iam::123456789012:role/NeptuneAccessRole.
    
          
        
    • 
      
        
  • 
          :feature_name
          (String)
          
            
          
          
            — 
    The name of the feature for the Neptune DB cluster that the IAM role
is to be associated with. For the list of supported feature names, see
DBEngineVersion.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
        (Struct)
      
      
      
        —
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


82

    		
    
      
# File 'sig/client.rbs', line 82

def add_role_to_db_cluster: (

    		
  





    
      

  

  
    #add_source_identifier_to_subscription(params = {})  ⇒ Types::AddSourceIdentifierToSubscriptionResult 
  

  

  




  

    
Adds a source identifier to an existing event notification
subscription.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.add_source_identifier_to_subscription({
  subscription_name: "String", # required
  source_identifier: "String", # required
})

    
      
        
Response structure

      
      

resp.event_subscription.customer_aws_id #=> String
resp.event_subscription.cust_subscription_id #=> String
resp.event_subscription.sns_topic_arn #=> String
resp.event_subscription.status #=> String
resp.event_subscription.subscription_creation_time #=> String
resp.event_subscription.source_type #=> String
resp.event_subscription.source_ids_list #=> Array
resp.event_subscription.source_ids_list[0] #=> String
resp.event_subscription.event_categories_list #=> Array
resp.event_subscription.event_categories_list[0] #=> String
resp.event_subscription.enabled #=> Boolean
resp.event_subscription.event_subscription_arn #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :subscription_name
          (required, String)
          
            
          
          
            — 
    The name of the event notification subscription you want to add a
source identifier to.
    
          
        
    • 
      
        
  • 
          :source_identifier
          (required, String)
          
            
          
          
            — 
    The identifier of the event source to be added.
    

    Constraints:
    

      

    • 

      If the source type is a DB instance, then a DBInstanceIdentifier
must be supplied.
      

      • 

    • 

      If the source type is a DB security group, a DBSecurityGroupName
must be supplied.
      

      • 

    • 

      If the source type is a DB parameter group, a DBParameterGroupName
must be supplied.
      

      • 

    • 

      If the source type is a DB snapshot, a DBSnapshotIdentifier must
be supplied.
      

      • 

    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


94

    		
    
      
# File 'sig/client.rbs', line 94

def add_source_identifier_to_subscription: (

    		
  





    
      

  

  
    #add_tags_to_resource(params = {})  ⇒ Struct 
  

  

  




  

    
Adds metadata tags to an Amazon Neptune resource. These tags can also
be used with cost allocation reporting to track cost associated with
Amazon Neptune resources, or used in a Condition statement in an IAM
policy for Amazon Neptune.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

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

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :resource_name
          (required, String)
          
            
          
          
            — 
    The Amazon Neptune resource that the tags are added to. This value is
an Amazon Resource Name (ARN). For information about creating an ARN,
see  Constructing an Amazon Resource Name (ARN).
    
          
        
    • 
      
        
  • 
          :tags
          (required, Array<Types::Tag>)
          
            
          
          
            — 
    The tags to be assigned to the Amazon Neptune resource.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
        (Struct)
      
      
      
        —
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


101

    		
    
      
# File 'sig/client.rbs', line 101

def add_tags_to_resource: (

    		
  





    
      

  

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

  

  




  

    
Applies a pending maintenance action to a resource (for example, to a
DB instance).


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.apply_pending_maintenance_action({
  resource_identifier: "String", # required
  apply_action: "String", # required
  opt_in_type: "String", # required
})

    
      
        
Response structure

      
      

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

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :resource_identifier
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the resource that the pending
maintenance action applies to. For information about creating an ARN,
see  Constructing an Amazon Resource Name (ARN).
    
          
        
    • 
      
        
  • 
          :apply_action
          (required, String)
          
            
          
          
            — 
    The pending maintenance action to apply to this resource.
    

    Valid values: system-update, db-upgrade
    
          
        
    • 
      
        
  • 
          :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.
    

    Valid values:
    

      

    • 

      immediate - Apply the maintenance action immediately.
      

      • 

    • 

      next-maintenance - Apply the maintenance action during the next
maintenance window for the resource.
      

      • 

    • 

      undo-opt-in - Cancel any existing next-maintenance opt-in
requests.
      

      • 

    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


117

    		
    
      
# File 'sig/client.rbs', line 117

def apply_pending_maintenance_action: (

    		
  





    
      

  

  
    #build_request(operation_name, params = {})  ⇒ Object 
  

  

  




  

    

  This method is part of a private API.
  You should avoid using this method if possible, as it may be removed or be changed in the future.




  





  
Parameters:


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






  

    
      


7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923

    		
    
      
# File 'lib/aws-sdk-neptune/client.rb', line 7907

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::Neptune')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-neptune'
  context[:gem_version] = '1.110.0'
  Seahorse::Client::Request.new(handlers, context)
end

    		
  





    
      

  

  
    #copy_db_cluster_parameter_group(params = {})  ⇒ Types::CopyDBClusterParameterGroupResult 
  

  

  




  

    
Copies the specified DB cluster parameter group.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.copy_db_cluster_parameter_group({
  source_db_cluster_parameter_group_identifier: "String", # required
  target_db_cluster_parameter_group_identifier: "String", # required
  target_db_cluster_parameter_group_description: "String", # required
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

    
      
        
Response structure

      
      

resp.db_cluster_parameter_group.db_cluster_parameter_group_name #=> String
resp.db_cluster_parameter_group.db_parameter_group_family #=> String
resp.db_cluster_parameter_group.description #=> String
resp.db_cluster_parameter_group.db_cluster_parameter_group_arn #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :source_db_cluster_parameter_group_identifier
          (required, String)
          
            
          
          
            — 
    The identifier or Amazon Resource Name (ARN) for the source DB cluster
parameter group. For information about creating an ARN, see 
Constructing an Amazon Resource Name (ARN).
    

    Constraints:
    

      

    • 

      Must specify a valid DB cluster parameter group.
      

      • 

    • 

      Must specify a valid DB cluster parameter group identifier, for
example my-db-cluster-param-group, or a valid ARN.
      

      • 

    • 

      The source DB cluster parameter group must be in the same Amazon
Region as the copy. Neptune does not support cross-Region copying of
parameter groups.
      

      • 

    
          
        
    • 
      
        
  • 
          :target_db_cluster_parameter_group_identifier
          (required, String)
          
            
          
          
            — 
    The identifier for the copied DB cluster parameter group.
    

    Constraints:
    

      

    • 

      Cannot be null, empty, or blank
      

      • 

    • 

      Must contain from 1 to 255 letters, numbers, or hyphens
      

      • 

    • 

      First character must be a letter
      

      • 

    • 

      Cannot end with a hyphen or contain two consecutive hyphens
      

      • 

    

    Example: my-cluster-param-group1
    
          
        
    • 
      
        
  • 
          :target_db_cluster_parameter_group_description
          (required, String)
          
            
          
          
            — 
    A description for the copied DB cluster parameter group.
    
          
        
    • 
      
        
  • 
          :tags
          (Array<Types::Tag>)
          
            
          
          
            — 
    The tags to be assigned to the copied DB cluster parameter group.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


129

    		
    
      
# File 'sig/client.rbs', line 129

def copy_db_cluster_parameter_group: (

    		
  





    
      

  

  
    #copy_db_cluster_snapshot(params = {})  ⇒ Types::CopyDBClusterSnapshotResult 
  

  

  




  

    
Copies a snapshot of a DB cluster.


To copy a DB cluster snapshot from a shared manual DB cluster
snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon
Resource Name (ARN) of the shared DB cluster snapshot.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.copy_db_cluster_snapshot({
  source_db_cluster_snapshot_identifier: "String", # required
  target_db_cluster_snapshot_identifier: "String", # required
  kms_key_id: "String",
  pre_signed_url: "String",
  copy_tags: false,
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
  source_region: "String",
})

    
      
        
Response structure

      
      

resp.db_cluster_snapshot.availability_zones #=> Array
resp.db_cluster_snapshot.availability_zones[0] #=> String
resp.db_cluster_snapshot.db_cluster_snapshot_identifier #=> String
resp.db_cluster_snapshot.db_cluster_identifier #=> String
resp.db_cluster_snapshot.snapshot_create_time #=> Time
resp.db_cluster_snapshot.engine #=> String
resp.db_cluster_snapshot.allocated_storage #=> Integer
resp.db_cluster_snapshot.status #=> String
resp.db_cluster_snapshot.port #=> Integer
resp.db_cluster_snapshot.vpc_id #=> String
resp.db_cluster_snapshot.cluster_create_time #=> Time
resp.db_cluster_snapshot.master_username #=> String
resp.db_cluster_snapshot.engine_version #=> String
resp.db_cluster_snapshot.license_model #=> String
resp.db_cluster_snapshot.snapshot_type #=> String
resp.db_cluster_snapshot.percent_progress #=> Integer
resp.db_cluster_snapshot.storage_encrypted #=> Boolean
resp.db_cluster_snapshot.kms_key_id #=> String
resp.db_cluster_snapshot.db_cluster_snapshot_arn #=> String
resp.db_cluster_snapshot.source_db_cluster_snapshot_arn #=> String
resp.db_cluster_snapshot.iam_database_authentication_enabled #=> Boolean
resp.db_cluster_snapshot.storage_type #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :source_db_cluster_snapshot_identifier
          (required, String)
          
            
          
          
            — 
    The identifier of the DB cluster snapshot to copy. This parameter is
not case-sensitive. If the source DB cluster snapshot is in a
different region or owned by another account, specify the snapshot
ARN.
    

    Constraints:
    

      

    • 

      Must specify a valid system snapshot in the "available" state.
      

      • 

    • 

      Specify a valid DB snapshot identifier.
      

      • 

    

    Example: my-cluster-snapshot1
    
          
        
    • 
      
        
  • 
          :target_db_cluster_snapshot_identifier
          (required, String)
          
            
          
          
            — 
    The identifier of the new DB cluster snapshot to create from the
source DB cluster snapshot. This parameter is not case-sensitive.
    

    Constraints:
    

      

    • 

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

      • 

    • 

      First character must be a letter.
      

      • 

    • 

      Cannot end with a hyphen or contain two consecutive hyphens.
      

      • 

    

    Example: my-cluster-snapshot2
    
          
        
    • 
      
        
  • 
          :kms_key_id
          (String)
          
            
          
          
            — 
    The Amazon KMS key ID for an encrypted DB cluster snapshot. The KMS
key ID is the Amazon Resource Name (ARN), KMS key identifier, or the
KMS key alias for the KMS encryption key.
    

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

    If you copy an encrypted DB cluster snapshot that is shared from
another Amazon account, then you must specify a value for KmsKeyId.
    

    KMS encryption keys are specific to the Amazon Region that they are
created in, and you can't use encryption keys from one Amazon Region
in another Amazon Region.
    

    You cannot encrypt an unencrypted DB cluster snapshot when you copy
it. If you try to copy an unencrypted DB cluster snapshot and specify
a value for the KmsKeyId parameter, an error is returned.
    
          
        
    • 
      
        
  • 
          :pre_signed_url
          (String)
          
            
          
          
            — 
    Not currently supported.
    
          
        
    • 
      
        
  • 
          :copy_tags
          (Boolean)
          
            
          
          
            — 
    True to copy all tags from the source DB cluster snapshot to the
target DB cluster snapshot, and otherwise false. The default is false.
    
          
        
    • 
      
        
  • 
          :tags
          (Array<Types::Tag>)
          
            
          
          
            — 
    The tags to assign to the new DB cluster snapshot copy.
    
          
        
    • 
      
        
  • 
          :source_region
          (String)
          
            
          
          
            — 
    The source region of the snapshot. This is only needed when the
shapshot is encrypted and in a different region.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


147

    		
    
      
# File 'sig/client.rbs', line 147

def copy_db_cluster_snapshot: (

    		
  





    
      

  

  
    #copy_db_parameter_group(params = {})  ⇒ Types::CopyDBParameterGroupResult 
  

  

  




  

    
Copies the specified DB parameter group.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.copy_db_parameter_group({
  source_db_parameter_group_identifier: "String", # required
  target_db_parameter_group_identifier: "String", # required
  target_db_parameter_group_description: "String", # required
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

    
      
        
Response structure

      
      

resp.db_parameter_group.db_parameter_group_name #=> String
resp.db_parameter_group.db_parameter_group_family #=> String
resp.db_parameter_group.description #=> String
resp.db_parameter_group.db_parameter_group_arn #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :source_db_parameter_group_identifier
          (required, String)
          
            
          
          
            — 
    The identifier or ARN for the source DB parameter group. For
information about creating an ARN, see  Constructing an Amazon
Resource Name (ARN).
    

    Constraints:
    

      

    • 

      Must specify a valid DB parameter group.
      

      • 

    • 

      Must specify a valid DB parameter group identifier, for example
my-db-param-group, or a valid ARN.
      

      • 

    • 

      The source DB parameter group must be in the same Amazon Region as
the copy. Neptune does not support cross-Region copying of parameter
groups.
      

      • 

    
          
        
    • 
      
        
  • 
          :target_db_parameter_group_identifier
          (required, String)
          
            
          
          
            — 
    The identifier for the copied DB parameter group.
    

    Constraints:
    

      

    • 

      Cannot be null, empty, or blank.
      

      • 

    • 

      Must contain from 1 to 255 letters, numbers, or hyphens.
      

      • 

    • 

      First character must be a letter.
      

      • 

    • 

      Cannot end with a hyphen or contain two consecutive hyphens.
      

      • 

    

    Example: my-db-parameter-group
    
          
        
    • 
      
        
  • 
          :target_db_parameter_group_description
          (required, String)
          
            
          
          
            — 
    A description for the copied DB parameter group.
    
          
        
    • 
      
        
  • 
          :tags
          (Array<Types::Tag>)
          
            
          
          
            — 
    The tags to be assigned to the copied DB parameter group.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


168

    		
    
      
# File 'sig/client.rbs', line 168

def copy_db_parameter_group: (

    		
  





    
      

  

  
    #create_db_cluster(params = {})  ⇒ Types::CreateDBClusterResult 
  

  

  




  

    
Creates a new Amazon Neptune DB cluster.


You can use the ReplicationSourceIdentifier parameter to create the
DB cluster as a Read Replica of another DB cluster or Amazon Neptune
DB instance.


Note that when you create a new cluster using CreateDBCluster
directly, deletion protection is disabled by default (when you create
a new production cluster in the console, deletion protection is
enabled by default). You can only delete a DB cluster if its
DeletionProtection field is set to false.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_db_cluster({
  availability_zones: ["String"],
  backup_retention_period: 1,
  character_set_name: "String",
  copy_tags_to_snapshot: false,
  database_name: "String",
  db_cluster_identifier: "String", # required
  db_cluster_parameter_group_name: "String",
  vpc_security_group_ids: ["String"],
  db_subnet_group_name: "String",
  engine: "String", # required
  engine_version: "String",
  port: 1,
  master_username: "String",
  master_user_password: "String",
  option_group_name: "String",
  preferred_backup_window: "String",
  preferred_maintenance_window: "String",
  replication_source_identifier: "String",
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
  storage_encrypted: false,
  kms_key_id: "String",
  pre_signed_url: "String",
  enable_iam_database_authentication: false,
  enable_cloudwatch_logs_exports: ["String"],
  deletion_protection: false,
  serverless_v2_scaling_configuration: {
    min_capacity: 1.0,
    max_capacity: 1.0,
  },
  global_cluster_identifier: "GlobalClusterIdentifier",
  storage_type: "String",
  network_type: "String",
  source_region: "String",
})

    
      
        
Response structure

      
      

resp.db_cluster.allocated_storage #=> Integer
resp.db_cluster.availability_zones #=> Array
resp.db_cluster.availability_zones[0] #=> String
resp.db_cluster.backup_retention_period #=> Integer
resp.db_cluster.character_set_name #=> String
resp.db_cluster.database_name #=> String
resp.db_cluster.db_cluster_identifier #=> String
resp.db_cluster.db_cluster_parameter_group #=> String
resp.db_cluster.db_subnet_group #=> String
resp.db_cluster.status #=> String
resp.db_cluster.percent_progress #=> String
resp.db_cluster.earliest_restorable_time #=> Time
resp.db_cluster.endpoint #=> String
resp.db_cluster.reader_endpoint #=> String
resp.db_cluster.multi_az #=> Boolean
resp.db_cluster.engine #=> String
resp.db_cluster.engine_version #=> String
resp.db_cluster.latest_restorable_time #=> Time
resp.db_cluster.port #=> Integer
resp.db_cluster.master_username #=> String
resp.db_cluster.db_cluster_option_group_memberships #=> Array
resp.db_cluster.db_cluster_option_group_memberships[0].db_cluster_option_group_name #=> String
resp.db_cluster.db_cluster_option_group_memberships[0].status #=> String
resp.db_cluster.preferred_backup_window #=> String
resp.db_cluster.preferred_maintenance_window #=> String
resp.db_cluster.replication_source_identifier #=> String
resp.db_cluster.read_replica_identifiers #=> Array
resp.db_cluster.read_replica_identifiers[0] #=> String
resp.db_cluster.db_cluster_members #=> Array
resp.db_cluster.db_cluster_members[0].db_instance_identifier #=> String
resp.db_cluster.db_cluster_members[0].is_cluster_writer #=> Boolean
resp.db_cluster.db_cluster_members[0].db_cluster_parameter_group_status #=> String
resp.db_cluster.db_cluster_members[0].promotion_tier #=> Integer
resp.db_cluster.vpc_security_groups #=> Array
resp.db_cluster.vpc_security_groups[0].vpc_security_group_id #=> String
resp.db_cluster.vpc_security_groups[0].status #=> String
resp.db_cluster.hosted_zone_id #=> String
resp.db_cluster.storage_encrypted #=> Boolean
resp.db_cluster.kms_key_id #=> String
resp.db_cluster.db_cluster_resource_id #=> String
resp.db_cluster.db_cluster_arn #=> String
resp.db_cluster.associated_roles #=> Array
resp.db_cluster.associated_roles[0].role_arn #=> String
resp.db_cluster.associated_roles[0].status #=> String
resp.db_cluster.associated_roles[0].feature_name #=> String
resp.db_cluster.iam_database_authentication_enabled #=> Boolean
resp.db_cluster.clone_group_id #=> String
resp.db_cluster.cluster_create_time #=> Time
resp.db_cluster.copy_tags_to_snapshot #=> Boolean
resp.db_cluster.enabled_cloudwatch_logs_exports #=> Array
resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String
resp.db_cluster.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_enable #=> Array
resp.db_cluster.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_enable[0] #=> String
resp.db_cluster.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_disable #=> Array
resp.db_cluster.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_disable[0] #=> String
resp.db_cluster.pending_modified_values.db_cluster_identifier #=> String
resp.db_cluster.pending_modified_values.iam_database_authentication_enabled #=> Boolean
resp.db_cluster.pending_modified_values.engine_version #=> String
resp.db_cluster.pending_modified_values.backup_retention_period #=> Integer
resp.db_cluster.pending_modified_values.storage_type #=> String
resp.db_cluster.pending_modified_values.allocated_storage #=> Integer
resp.db_cluster.pending_modified_values.iops #=> Integer
resp.db_cluster.pending_modified_values.network_type #=> String
resp.db_cluster.deletion_protection #=> Boolean
resp.db_cluster. #=> Boolean
resp.db_cluster.automatic_restart_time #=> Time
resp.db_cluster.serverless_v2_scaling_configuration.min_capacity #=> Float
resp.db_cluster.serverless_v2_scaling_configuration.max_capacity #=> Float
resp.db_cluster.global_cluster_identifier #=> String
resp.db_cluster.io_optimized_next_allowed_modification_time #=> Time
resp.db_cluster.storage_type #=> String
resp.db_cluster.network_type #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :availability_zones
          (Array<String>)
          
            
          
          
            — 
    A list of EC2 Availability Zones that instances in the DB cluster can
be created in.
    
          
        
    • 
      
        
  • 
          :backup_retention_period
          (Integer)
          
            
          
          
            — 
    The number of days for which automated backups are retained. You must
specify a minimum value of 1.
    

    Default: 1
    

    Constraints:
    

      

    • Must be a value from 1 to 35
      • 

    

    ^
    
          
        
    • 
      
        
  • 
          :character_set_name
          (String)
          
            
          
          
            — 
    (Not supported by Neptune)
    
          
        
    • 
      
        
  • 
          :copy_tags_to_snapshot
          (Boolean)
          
            
          
          
            — 
    If set to true, tags are copied to any snapshot of the DB cluster
that is created.
    
          
        
    • 
      
        
  • 
          :database_name
          (String)
          
            
          
          
            — 
    Not supported by Neptune.
    
          
        
    • 
      
        
  • 
          :db_cluster_identifier
          (required, String)
          
            
          
          
            — 
    The DB cluster identifier. This parameter is stored as a lowercase
string.
    

    Constraints:
    

      

    • 

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

      • 

    • 

      First character must be a letter.
      

      • 

    • 

      Cannot end with a hyphen or contain two consecutive hyphens.
      

      • 

    

    Example: my-cluster1
    
          
        
    • 
      
        
  • 
          :db_cluster_parameter_group_name
          (String)
          
            
          
          
            — 
    The name of the DB cluster parameter group to associate with this DB
cluster. If this argument is omitted, the default is used.
    

    Constraints:
    

      

    • If supplied, must match the name of an existing
DBClusterParameterGroup.
      • 

    

    ^
    
          
        
    • 
      
        
  • 
          :vpc_security_group_ids
          (Array<String>)
          
            
          
          
            — 
    A list of EC2 VPC security groups to associate with this DB cluster.
    
          
        
    • 
      
        
  • 
          :db_subnet_group_name
          (String)
          
            
          
          
            — 
    A DB subnet group to associate with this DB cluster.
    

    Constraints: Must match the name of an existing DBSubnetGroup. Must
not be default.
    

    Example: mySubnetgroup
    
          
        
    • 
      
        
  • 
          :engine
          (required, String)
          
            
          
          
            — 
    The name of the database engine to be used for this DB cluster.
    

    Valid Values: neptune
    
          
        
    • 
      
        
  • 
          :engine_version
          (String)
          
            
          
          
            — 
    The version number of the database engine to use for the new DB
cluster.
    

    Example: 1.2.1.0
    
          
        
    • 
      
        
  • 
          :port
          (Integer)
          
            
          
          
            — 
    The port number on which the instances in the DB cluster accept
connections.
    

    Default: 8182
    
          
        
    • 
      
        
  • 
          :master_username
          (String)
          
            
          
          
            — 
    Not supported by Neptune.
    
          
        
    • 
      
        
  • 
          :master_user_password
          (String)
          
            
          
          
            — 
    Not supported by Neptune.
    
          
        
    • 
      
        
  • 
          :option_group_name
          (String)
          
            
          
          
            — 
    (Not supported by Neptune)
    
          
        
    • 
      
        
  • 
          :preferred_backup_window
          (String)
          
            
          
          
            — 
    The daily time range during which automated backups are created if
automated backups are enabled using the BackupRetentionPeriod
parameter.
    

    The default is a 30-minute window selected at random from an 8-hour
block of time for each Amazon Region. To see the time blocks
available, see Neptune Maintenance Window in the Amazon Neptune
User Guide.
    

    Constraints:
    

      

    • 

      Must be in the format hh24:mi-hh24:mi.
      

      • 

    • 

      Must be in Universal Coordinated Time (UTC).
      

      • 

    • 

      Must not conflict with the preferred maintenance window.
      

      • 

    • 

      Must be at least 30 minutes.
      

      • 

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

    The default is a 30-minute window selected at random from an 8-hour
block of time for each Amazon Region, occurring on a random day of the
week. To see the time blocks available, see Neptune Maintenance
Window in the Amazon Neptune User Guide.
    

    Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
    

    Constraints: Minimum 30-minute window.
    
          
        
    • 
      
        
  • 
          :replication_source_identifier
          (String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the source DB instance or DB cluster
if this DB cluster is created as a Read Replica.
    
          
        
    • 
      
        
  • 
          :tags
          (Array<Types::Tag>)
          
            
          
          
            — 
    The tags to assign to the new DB cluster.
    
          
        
    • 
      
        
  • 
          :storage_encrypted
          (Boolean)
          
            
          
          
            — 
    Specifies whether the DB cluster is encrypted.
    
          
        
    • 
      
        
  • 
          :kms_key_id
          (String)
          
            
          
          
            — 
    The Amazon KMS key identifier for an encrypted DB cluster.
    

    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
encryption key. If you are creating a DB cluster with the same Amazon
account that owns the KMS encryption key used to encrypt the new DB
cluster, then you can use the KMS key alias instead of the ARN for the
KMS encryption key.
    

    If an encryption key is not specified in KmsKeyId:
    

      

    • 

      If ReplicationSourceIdentifier identifies an encrypted source,
then Amazon Neptune will use the encryption key used to encrypt the
source. Otherwise, Amazon Neptune will use your default encryption
key.
      

      • 

    • 

      If the StorageEncrypted parameter is true and
ReplicationSourceIdentifier is not specified, then Amazon Neptune
will use your default encryption key.
      

      • 

    

    Amazon KMS creates the default encryption key for your Amazon account.
Your Amazon account has a different default encryption key for each
Amazon Region.
    

    If you create a Read Replica of an encrypted DB cluster in another
Amazon Region, you must set KmsKeyId to a KMS key ID that is valid
in the destination Amazon Region. This key is used to encrypt the Read
Replica in that Amazon Region.
    
          
        
    • 
      
        
  • 
          :pre_signed_url
          (String)
          
            
          
          
            — 
    This parameter is not currently supported.
    
          
        
    • 
      
        
  • 
          :enable_iam_database_authentication
          (Boolean)
          
            
          
          
            — 
    If set to true, enables Amazon Identity and Access Management (IAM)
authentication for the entire DB cluster (this cannot be set at an
instance level).
    

    Default: false.
    
          
        
    • 
      
        
  • 
          :enable_cloudwatch_logs_exports
          (Array<String>)
          
            
          
          
            — 
    A list of the log types that this DB cluster should export to
CloudWatch Logs. Valid log types are: audit (to publish audit logs)
and slowquery (to publish slow-query logs). See Publishing Neptune
logs to Amazon CloudWatch logs.
    
          
        
    • 
      
        
  • 
          :deletion_protection
          (Boolean)
          
            
          
          
            — 
    A value that indicates whether the DB cluster has deletion protection
enabled. The database can't be deleted when deletion protection is
enabled. By default, deletion protection is enabled.
    
          
        
    • 
      
        
  • 
          :serverless_v2_scaling_configuration
          (Types::ServerlessV2ScalingConfiguration)
          
            
          
          
            — 
    Contains the scaling configuration of a Neptune Serverless DB cluster.
    

    For more information, see Using Amazon Neptune Serverless in the
Amazon Neptune User Guide.
    
          
        
    • 
      
        
  • 
          :global_cluster_identifier
          (String)
          
            
          
          
            — 
    The ID of the Neptune global database to which this new DB cluster
should be added.
    
          
        
    • 
      
        
  • 
          :storage_type
          (String)
          
            
          
          
            — 
    The storage type for the new DB cluster.
    

    Valid Values:
    

      

    • 

       standard    –   ( the default ) Configures
cost-effective database storage for applications with moderate to
small I/O usage. When set to standard, the storage type is not
returned in the response.
      

      • 

    • 

       iopt1    –   Enables I/O-Optimized storage
that's designed to meet the needs of I/O-intensive graph workloads
that require predictable pricing with low I/O latency and consistent
I/O throughput.
      

      Neptune I/O-Optimized storage is only available starting with engine
release 1.3.0.0.
      

      • 

    
          
        
    • 
      
        
  • 
          :network_type
          (String)
          
            
          
          
            — 
    The network type of the DB cluster.
    

    Valid Values:
    

      

    • 

       IPV4    –   ( the default ) The DB cluster
uses only IPv4 addresses for communication.
      

      • 

    • 

       DUAL    –   The DB cluster uses both IPv4 and
IPv6 addresses for communication. The DB subnet group associated
with the cluster must support IPv6.
      

      • 

    
          
        
    • 
      
        
  • 
          :source_region
          (String)
          
            
          
          
            — 
    The source region of the snapshot. This is only needed when the
shapshot is encrypted and in a different region.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


186

    		
    
      
# File 'sig/client.rbs', line 186

def create_db_cluster: (

    		
  





    
      

  

  
    #create_db_cluster_endpoint(params = {})  ⇒ Types::CreateDBClusterEndpointOutput 
  

  

  




  

    
Creates a new custom endpoint and associates it with an Amazon Neptune
DB cluster.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_db_cluster_endpoint({
  db_cluster_identifier: "String", # required
  db_cluster_endpoint_identifier: "String", # required
  endpoint_type: "String", # required
  static_members: ["String"],
  excluded_members: ["String"],
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

    
      
        
Response structure

      
      

resp.db_cluster_endpoint_identifier #=> String
resp.db_cluster_identifier #=> String
resp.db_cluster_endpoint_resource_identifier #=> String
resp.endpoint #=> String
resp.status #=> String
resp.endpoint_type #=> String
resp.custom_endpoint_type #=> String
resp.static_members #=> Array
resp.static_members[0] #=> String
resp.excluded_members #=> Array
resp.excluded_members[0] #=> String
resp.db_cluster_endpoint_arn #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :db_cluster_identifier
          (required, String)
          
            
          
          
            — 
    The DB cluster identifier of the DB cluster associated with the
endpoint. This parameter is stored as a lowercase string.
    
          
        
    • 
      
        
  • 
          :db_cluster_endpoint_identifier
          (required, String)
          
            
          
          
            — 
    The identifier to use for the new endpoint. This parameter is stored
as a lowercase string.
    
          
        
    • 
      
        
  • 
          :endpoint_type
          (required, String)
          
            
          
          
            — 
    The type of the endpoint. One of: READER, WRITER, ANY.
    
          
        
    • 
      
        
  • 
          :static_members
          (Array<String>)
          
            
          
          
            — 
    List of DB instance identifiers that are part of the custom endpoint
group.
    
          
        
    • 
      
        
  • 
          :excluded_members
          (Array<String>)
          
            
          
          
            — 
    List of DB instance identifiers that aren't part of the custom
endpoint group. All other eligible instances are reachable through the
custom endpoint. Only relevant if the list of static members is empty.
    
          
        
    • 
      
        
  • 
          :tags
          (Array<Types::Tag>)
          
            
          
          
            — 
    The tags to be assigned to the Amazon Neptune resource.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


242

    		
    
      
# File 'sig/client.rbs', line 242

def create_db_cluster_endpoint: (

    		
  





    
      

  

  
    #create_db_cluster_parameter_group(params = {})  ⇒ Types::CreateDBClusterParameterGroupResult 
  

  

  




  

    
Creates a new DB cluster parameter group.


Parameters in a DB cluster parameter group apply to all of the
instances in a DB cluster.


A DB cluster parameter group is initially created with the default
parameters for the database engine used by instances in the DB
cluster. To provide custom values for any of the parameters, you must
modify the group after creating it using
ModifyDBClusterParameterGroup. Once you've created a DB cluster
parameter group, you need to associate it with your DB cluster using
ModifyDBCluster. When you associate a new DB cluster parameter group
with a running DB cluster, you need to reboot the DB instances in the
DB cluster without failover for the new DB cluster parameter group and
associated settings to take effect.


After you create a DB cluster parameter group, you should wait at
least 5 minutes before creating your first DB cluster that uses that
DB cluster parameter group as the default parameter group. This allows
Amazon Neptune to fully complete the create action before the DB
cluster parameter group is used as the default for a new DB cluster.
This is especially important for parameters that are critical when
creating the default database for a DB cluster, such as the character
set for the default database defined by the character_set_database
parameter. You can use the Parameter Groups option of the Amazon
Neptune console or the DescribeDBClusterParameters command to
verify that your DB cluster parameter group has been created or
modified.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_db_cluster_parameter_group({
  db_cluster_parameter_group_name: "String", # required
  db_parameter_group_family: "String", # required
  description: "String", # required
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

    
      
        
Response structure

      
      

resp.db_cluster_parameter_group.db_cluster_parameter_group_name #=> String
resp.db_cluster_parameter_group.db_parameter_group_family #=> String
resp.db_cluster_parameter_group.description #=> String
resp.db_cluster_parameter_group.db_cluster_parameter_group_arn #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :db_cluster_parameter_group_name
          (required, String)
          
            
          
          
            — 
    The name of the DB cluster parameter group.
    

    Constraints:
    

      

    • Must match the name of an existing DBClusterParameterGroup.
      • 

    

    ^
    

     This value is stored as a lowercase string.
    
 
    
          
        
    • 
      
        
  • 
          :db_parameter_group_family
          (required, String)
          
            
          
          
            — 
    The DB cluster parameter group family name. A DB cluster parameter
group can be associated with one and only one DB cluster parameter
group family, and can be applied only to a DB cluster running a
database engine and engine version compatible with that DB cluster
parameter group family.
    
          
        
    • 
      
        
  • 
          :description
          (required, String)
          
            
          
          
            — 
    The description for the DB cluster parameter group.
    
          
        
    • 
      
        
  • 
          :tags
          (Array<Types::Tag>)
          
            
          
          
            — 
    The tags to be assigned to the new DB cluster parameter group.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


262

    		
    
      
# File 'sig/client.rbs', line 262

def create_db_cluster_parameter_group: (

    		
  





    
      

  

  
    #create_db_cluster_snapshot(params = {})  ⇒ Types::CreateDBClusterSnapshotResult 
  

  

  




  

    
Creates a snapshot of a DB cluster.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_db_cluster_snapshot({
  db_cluster_snapshot_identifier: "String", # required
  db_cluster_identifier: "String", # required
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

    
      
        
Response structure

      
      

resp.db_cluster_snapshot.availability_zones #=> Array
resp.db_cluster_snapshot.availability_zones[0] #=> String
resp.db_cluster_snapshot.db_cluster_snapshot_identifier #=> String
resp.db_cluster_snapshot.db_cluster_identifier #=> String
resp.db_cluster_snapshot.snapshot_create_time #=> Time
resp.db_cluster_snapshot.engine #=> String
resp.db_cluster_snapshot.allocated_storage #=> Integer
resp.db_cluster_snapshot.status #=> String
resp.db_cluster_snapshot.port #=> Integer
resp.db_cluster_snapshot.vpc_id #=> String
resp.db_cluster_snapshot.cluster_create_time #=> Time
resp.db_cluster_snapshot.master_username #=> String
resp.db_cluster_snapshot.engine_version #=> String
resp.db_cluster_snapshot.license_model #=> String
resp.db_cluster_snapshot.snapshot_type #=> String
resp.db_cluster_snapshot.percent_progress #=> Integer
resp.db_cluster_snapshot.storage_encrypted #=> Boolean
resp.db_cluster_snapshot.kms_key_id #=> String
resp.db_cluster_snapshot.db_cluster_snapshot_arn #=> String
resp.db_cluster_snapshot.source_db_cluster_snapshot_arn #=> String
resp.db_cluster_snapshot.iam_database_authentication_enabled #=> Boolean
resp.db_cluster_snapshot.storage_type #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :db_cluster_snapshot_identifier
          (required, String)
          
            
          
          
            — 
    The identifier of the DB cluster snapshot. This parameter is stored as
a lowercase string.
    

    Constraints:
    

      

    • 

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

      • 

    • 

      First character must be a letter.
      

      • 

    • 

      Cannot end with a hyphen or contain two consecutive hyphens.
      

      • 

    

    Example: my-cluster1-snapshot1
    
          
        
    • 
      
        
  • 
          :db_cluster_identifier
          (required, String)
          
            
          
          
            — 
    The identifier of the DB cluster to create a snapshot for. This
parameter is not case-sensitive.
    

    Constraints:
    

      

    • Must match the identifier of an existing DBCluster.
      • 

    

    ^
    

    Example: my-cluster1
    
          
        
    • 
      
        
  • 
          :tags
          (Array<Types::Tag>)
          
            
          
          
            — 
    The tags to be assigned to the DB cluster snapshot.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


280

    		
    
      
# File 'sig/client.rbs', line 280

def create_db_cluster_snapshot: (

    		
  





    
      

  

  
    #create_db_instance(params = {})  ⇒ Types::CreateDBInstanceResult 
  

  

  




  

    
Creates a new DB instance.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_db_instance({
  db_name: "String",
  db_instance_identifier: "String", # required
  allocated_storage: 1,
  db_instance_class: "String", # required
  engine: "String", # required
  master_username: "String",
  master_user_password: "String",
  db_security_groups: ["String"],
  vpc_security_group_ids: ["String"],
  availability_zone: "String",
  db_subnet_group_name: "String",
  preferred_maintenance_window: "String",
  db_parameter_group_name: "String",
  backup_retention_period: 1,
  preferred_backup_window: "String",
  port: 1,
  multi_az: false,
  engine_version: "String",
  auto_minor_version_upgrade: false,
  license_model: "String",
  iops: 1,
  option_group_name: "String",
  character_set_name: "String",
  publicly_accessible: false,
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
  db_cluster_identifier: "String", # required
  storage_type: "String",
  tde_credential_arn: "String",
  tde_credential_password: "SensitiveString",
  storage_encrypted: false,
  kms_key_id: "String",
  domain: "String",
  copy_tags_to_snapshot: false,
  monitoring_interval: 1,
  monitoring_role_arn: "String",
  domain_iam_role_name: "String",
  promotion_tier: 1,
  timezone: "String",
  enable_iam_database_authentication: false,
  enable_performance_insights: false,
  performance_insights_kms_key_id: "String",
  enable_cloudwatch_logs_exports: ["String"],
  deletion_protection: false,
})

    
      
        
Response structure

      
      

resp.db_instance.db_instance_identifier #=> String
resp.db_instance.db_instance_class #=> String
resp.db_instance.engine #=> String
resp.db_instance.db_instance_status #=> String
resp.db_instance.master_username #=> String
resp.db_instance.db_name #=> String
resp.db_instance.endpoint.address #=> String
resp.db_instance.endpoint.port #=> Integer
resp.db_instance.endpoint.hosted_zone_id #=> String
resp.db_instance.allocated_storage #=> Integer
resp.db_instance.instance_create_time #=> Time
resp.db_instance.preferred_backup_window #=> String
resp.db_instance.backup_retention_period #=> Integer
resp.db_instance.db_security_groups #=> Array
resp.db_instance.db_security_groups[0].db_security_group_name #=> String
resp.db_instance.db_security_groups[0].status #=> String
resp.db_instance.vpc_security_groups #=> Array
resp.db_instance.vpc_security_groups[0].vpc_security_group_id #=> String
resp.db_instance.vpc_security_groups[0].status #=> String
resp.db_instance.db_parameter_groups #=> Array
resp.db_instance.db_parameter_groups[0].db_parameter_group_name #=> String
resp.db_instance.db_parameter_groups[0].parameter_apply_status #=> String
resp.db_instance.availability_zone #=> String
resp.db_instance.db_subnet_group.db_subnet_group_name #=> String
resp.db_instance.db_subnet_group.db_subnet_group_description #=> String
resp.db_instance.db_subnet_group.vpc_id #=> String
resp.db_instance.db_subnet_group.subnet_group_status #=> String
resp.db_instance.db_subnet_group.subnets #=> Array
resp.db_instance.db_subnet_group.subnets[0].subnet_identifier #=> String
resp.db_instance.db_subnet_group.subnets[0].subnet_availability_zone.name #=> String
resp.db_instance.db_subnet_group.subnets[0].subnet_status #=> String
resp.db_instance.db_subnet_group.db_subnet_group_arn #=> String
resp.db_instance.db_subnet_group.supported_network_types #=> Array
resp.db_instance.db_subnet_group.supported_network_types[0] #=> String
resp.db_instance.preferred_maintenance_window #=> String
resp.db_instance.pending_modified_values.db_instance_class #=> String
resp.db_instance.pending_modified_values.allocated_storage #=> Integer
resp.db_instance.pending_modified_values.master_user_password #=> String
resp.db_instance.pending_modified_values.port #=> Integer
resp.db_instance.pending_modified_values.backup_retention_period #=> Integer
resp.db_instance.pending_modified_values.multi_az #=> Boolean
resp.db_instance.pending_modified_values.engine_version #=> String
resp.db_instance.pending_modified_values.license_model #=> String
resp.db_instance.pending_modified_values.iops #=> Integer
resp.db_instance.pending_modified_values.db_instance_identifier #=> String
resp.db_instance.pending_modified_values.storage_type #=> String
resp.db_instance.pending_modified_values.ca_certificate_identifier #=> String
resp.db_instance.pending_modified_values.db_subnet_group_name #=> String
resp.db_instance.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_enable #=> Array
resp.db_instance.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_enable[0] #=> String
resp.db_instance.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_disable #=> Array
resp.db_instance.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_disable[0] #=> String
resp.db_instance.latest_restorable_time #=> Time
resp.db_instance.multi_az #=> Boolean
resp.db_instance.engine_version #=> String
resp.db_instance.auto_minor_version_upgrade #=> Boolean
resp.db_instance.read_replica_source_db_instance_identifier #=> String
resp.db_instance.read_replica_db_instance_identifiers #=> Array
resp.db_instance.read_replica_db_instance_identifiers[0] #=> String
resp.db_instance.read_replica_db_cluster_identifiers #=> Array
resp.db_instance.read_replica_db_cluster_identifiers[0] #=> String
resp.db_instance.license_model #=> String
resp.db_instance.iops #=> Integer
resp.db_instance.option_group_memberships #=> Array
resp.db_instance.option_group_memberships[0].option_group_name #=> String
resp.db_instance.option_group_memberships[0].status #=> String
resp.db_instance.character_set_name #=> String
resp.db_instance.secondary_availability_zone #=> String
resp.db_instance.publicly_accessible #=> Boolean
resp.db_instance.status_infos #=> Array
resp.db_instance.status_infos[0].status_type #=> String
resp.db_instance.status_infos[0].normal #=> Boolean
resp.db_instance.status_infos[0].status #=> String
resp.db_instance.status_infos[0].message #=> String
resp.db_instance.storage_type #=> String
resp.db_instance.tde_credential_arn #=> String
resp.db_instance.db_instance_port #=> Integer
resp.db_instance.db_cluster_identifier #=> String
resp.db_instance.storage_encrypted #=> Boolean
resp.db_instance.kms_key_id #=> String
resp.db_instance.dbi_resource_id #=> String
resp.db_instance.ca_certificate_identifier #=> String
resp.db_instance.domain_memberships #=> Array
resp.db_instance.domain_memberships[0].domain #=> String
resp.db_instance.domain_memberships[0].status #=> String
resp.db_instance.domain_memberships[0].fqdn #=> String
resp.db_instance.domain_memberships[0].iam_role_name #=> String
resp.db_instance.copy_tags_to_snapshot #=> Boolean
resp.db_instance.monitoring_interval #=> Integer
resp.db_instance.enhanced_monitoring_resource_arn #=> String
resp.db_instance.monitoring_role_arn #=> String
resp.db_instance.promotion_tier #=> Integer
resp.db_instance.db_instance_arn #=> String
resp.db_instance.timezone #=> String
resp.db_instance.iam_database_authentication_enabled #=> Boolean
resp.db_instance.performance_insights_enabled #=> Boolean
resp.db_instance.performance_insights_kms_key_id #=> String
resp.db_instance.enabled_cloudwatch_logs_exports #=> Array
resp.db_instance.enabled_cloudwatch_logs_exports[0] #=> String
resp.db_instance.deletion_protection #=> Boolean
resp.db_instance.network_type #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :db_name
          (String)
          
            
          
          
            — 
    Not supported.
    
          
        
    • 
      
        
  • 
          :db_instance_identifier
          (required, String)
          
            
          
          
            — 
    The DB instance identifier. This parameter is stored as a lowercase
string.
    

    Constraints:
    

      

    • 

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

      • 

    • 

      First character must be a letter.
      

      • 

    • 

      Cannot end with a hyphen or contain two consecutive hyphens.
      

      • 

    

    Example: mydbinstance
    
          
        
    • 
      
        
  • 
          :allocated_storage
          (Integer)
          
            
          
          
            — 
    Not supported by Neptune.
    
          
        
    • 
      
        
  • 
          :db_instance_class
          (required, String)
          
            
          
          
            — 
    The compute and memory capacity of the DB instance, for example,
db.m4.large. Not all DB instance classes are available in all Amazon
Regions.
    
          
        
    • 
      
        
  • 
          :engine
          (required, String)
          
            
          
          
            — 
    The name of the database engine to be used for this instance.
    

    Valid Values: neptune
    
          
        
    • 
      
        
  • 
          :master_username
          (String)
          
            
          
          
            — 
    Not supported by Neptune.
    
          
        
    • 
      
        
  • 
          :master_user_password
          (String)
          
            
          
          
            — 
    Not supported by Neptune.
    
          
        
    • 
      
        
  • 
          :db_security_groups
          (Array<String>)
          
            
          
          
            — 
    A list of DB security groups to associate with this DB instance.
    

    Default: The default DB security group for the database engine.
    
          
        
    • 
      
        
  • 
          :vpc_security_group_ids
          (Array<String>)
          
            
          
          
            — 
    A list of EC2 VPC security groups to associate with this DB instance.
    

    Not applicable. The associated list of EC2 VPC security groups is
managed by the DB cluster. For more information, see CreateDBCluster.
    

    Default: The default EC2 VPC security group for the DB subnet group's
VPC.
    
          
        
    • 
      
        
  • 
          :availability_zone
          (String)
          
            
          
          
            — 
    The EC2 Availability Zone that the DB instance is created in
    

    Default: A random, system-chosen Availability Zone in the endpoint's
Amazon Region.
    

    Example: us-east-1d
    

    Constraint: The AvailabilityZone parameter can't be specified if the
MultiAZ parameter is set to true. The specified Availability Zone
must be in the same Amazon Region as the current endpoint.
    
          
        
    • 
      
        
  • 
          :db_subnet_group_name
          (String)
          
            
          
          
            — 
    A DB subnet group to associate with this DB instance.
    

    If there is no DB subnet group, then it is a non-VPC DB instance.
    
          
        
    • 
      
        
  • 
          :preferred_maintenance_window
          (String)
          
            
          
          
            — 
    The time range each week during which system maintenance can occur, in
Universal Coordinated Time (UTC).
    

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

    The default is a 30-minute window selected at random from an 8-hour
block of time for each Amazon Region, occurring on a random day of the
week.
    

    Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
    

    Constraints: Minimum 30-minute window.
    
          
        
    • 
      
        
  • 
          :db_parameter_group_name
          (String)
          
            
          
          
            — 
    The name of the DB parameter group to associate with this DB instance.
If this argument is omitted, the default DBParameterGroup for the
specified engine is used.
    

    Constraints:
    

      

    • 

      Must be 1 to 255 letters, numbers, or hyphens.
      

      • 

    • 

      First character must be a letter
      

      • 

    • 

      Cannot end with a hyphen or contain two consecutive hyphens
      

      • 

    
          
        
    • 
      
        
  • 
          :backup_retention_period
          (Integer)
          
            
          
          
            — 
    The number of days for which automated backups are retained.
    

    Not applicable. The retention period for automated backups is managed
by the DB cluster. For more information, see CreateDBCluster.
    

    Default: 1
    

    Constraints:
    

      

    • 

      Must be a value from 0 to 35
      

      • 

    • 

      Cannot be set to 0 if the DB instance is a source to Read Replicas
      

      • 

    
          
        
    • 
      
        
  • 
          :preferred_backup_window
          (String)
          
            
          
          
            — 
    The daily time range during which automated backups are created.
    

    Not applicable. The daily time range for creating automated backups is
managed by the DB cluster. For more information, see CreateDBCluster.
    
          
        
    • 
      
        
  • 
          :port
          (Integer)
          
            
          
          
            — 
    The port number on which the database accepts connections.
    

    Not applicable. The port is managed by the DB cluster. For more
information, see CreateDBCluster.
    

    Default: 8182
    

    Type: Integer
    
          
        
    • 
      
        
  • 
          :multi_az
          (Boolean)
          
            
          
          
            — 
    Specifies if the DB instance is a Multi-AZ deployment. You can't set
the AvailabilityZone parameter if the MultiAZ parameter is set to
true.
    
          
        
    • 
      
        
  • 
          :engine_version
          (String)
          
            
          
          
            — 
    The version number of the database engine to use. Currently, setting
this parameter has no effect.
    
          
        
    • 
      
        
  • 
          :auto_minor_version_upgrade
          (Boolean)
          
            
          
          
            — 
    Indicates that minor engine upgrades are applied automatically to the
DB instance during the maintenance window.
    

    Default: true
    
          
        
    • 
      
        
  • 
          :license_model
          (String)
          
            
          
          
            — 
    License model information for this DB instance.
    

    Valid values: license-included | bring-your-own-license |
general-public-license
    
          
        
    • 
      
        
  • 
          :iops
          (Integer)
          
            
          
          
            — 
    The amount of Provisioned IOPS (input/output operations per second) to
be initially allocated for the DB instance.
    
          
        
    • 
      
        
  • 
          :option_group_name
          (String)
          
            
          
          
            — 
    (Not supported by Neptune)
    
          
        
    • 
      
        
  • 
          :character_set_name
          (String)
          
            
          
          
            — 
    (Not supported by Neptune)
    
          
        
    • 
      
        
  • 
          :publicly_accessible
          (Boolean)
          
            
          
          
            — 
    Indicates whether the DB instance is publicly accessible.
    

    When the DB instance is publicly accessible and you connect from
outside of the DB instance's virtual private cloud (VPC), its Domain
Name System (DNS) endpoint resolves to the public IP address. When you
connect from within the same VPC as the DB instance, the endpoint
resolves to the private IP address. Access to the DB instance is
ultimately controlled by the security group it uses. That public
access isn't permitted if the security group assigned to the DB
cluster doesn't permit it.
    

    When the DB instance isn't publicly accessible, it is an internal DB
instance with a DNS name that resolves to a private IP address.
    
          
        
    • 
      
        
  • 
          :tags
          (Array<Types::Tag>)
          
            
          
          
            — 
    The tags to assign to the new instance.
    
          
        
    • 
      
        
  • 
          :db_cluster_identifier
          (required, String)
          
            
          
          
            — 
    The identifier of the DB cluster that the instance will belong to.
    

    For information on creating a DB cluster, see CreateDBCluster.
    

    Type: String
    
          
        
    • 
      
        
  • 
          :storage_type
          (String)
          
            
          
          
            — 
    Not applicable. In Neptune the storage type is managed at the DB
Cluster level.
    
          
        
    • 
      
        
  • 
          :tde_credential_arn
          (String)
          
            
          
          
            — 
    The ARN from the key store with which to associate the instance for
TDE encryption.
    
          
        
    • 
      
        
  • 
          :tde_credential_password
          (String)
          
            
          
          
            — 
    The password for the given ARN from the key store in order to access
the device.
    
          
        
    • 
      
        
  • 
          :storage_encrypted
          (Boolean)
          
            
          
          
            — 
    Specifies whether the DB instance is encrypted.
    

    Not applicable. The encryption for DB instances is managed by the DB
cluster. For more information, see CreateDBCluster.
    

    Default: false
    
          
        
    • 
      
        
  • 
          :kms_key_id
          (String)
          
            
          
          
            — 
    The Amazon KMS key identifier for an encrypted DB instance.
    

    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
encryption key. If you are creating a DB instance with the same Amazon
account that owns the KMS encryption key used to encrypt the new DB
instance, then you can use the KMS key alias instead of the ARN for
the KMS encryption key.
    

    Not applicable. The KMS key identifier is managed by the DB cluster.
For more information, see CreateDBCluster.
    

    If the StorageEncrypted parameter is true, and you do not specify a
value for the KmsKeyId parameter, then Amazon Neptune will use your
default encryption key. Amazon KMS creates the default encryption key
for your Amazon account. Your Amazon account has a different default
encryption key for each Amazon Region.
    
          
        
    • 
      
        
  • 
          :domain
          (String)
          
            
          
          
            — 
    Specify the Active Directory Domain to create the instance in.
    
          
        
    • 
      
        
  • 
          :copy_tags_to_snapshot
          (Boolean)
          
            
          
          
            — 
    True to copy all tags from the DB instance to snapshots of the DB
instance, and otherwise false. The default is false.
    
          
        
    • 
      
        
  • 
          :monitoring_interval
          (Integer)
          
            
          
          
            — 
    The interval, in seconds, between points when Enhanced Monitoring
metrics are collected for the DB instance. To disable collecting
Enhanced Monitoring metrics, specify 0. The default is 0.
    

    If MonitoringRoleArn is specified, then you must also set
MonitoringInterval to a value other than 0.
    

    Valid Values: 0, 1, 5, 10, 15, 30, 60
    
          
        
    • 
      
        
  • 
          :monitoring_role_arn
          (String)
          
            
          
          
            — 
    The ARN for the IAM role that permits Neptune to send enhanced
monitoring metrics to Amazon CloudWatch Logs. For example,
arn:aws:iam:123456789012:role/emaccess.
    

    If MonitoringInterval is set to a value other than 0, then you must
supply a MonitoringRoleArn value.
    
          
        
    • 
      
        
  • 
          :domain_iam_role_name
          (String)
          
            
          
          
            — 
    Specify the name of the IAM role to be used when making API calls to
the Directory Service.
    
          
        
    • 
      
        
  • 
          :promotion_tier
          (Integer)
          
            
          
          
            — 
    A value that specifies the order in which an Read Replica is promoted
to the primary instance after a failure of the existing primary
instance.
    

    Default: 1
    

    Valid Values: 0 - 15
    
          
        
    • 
      
        
  • 
          :timezone
          (String)
          
            
          
          
            — 
    The time zone of the DB instance.
    
          
        
    • 
      
        
  • 
          :enable_iam_database_authentication
          (Boolean)
          
            
          
          
            — 
    Not supported by Neptune (ignored).
    
          
        
    • 
      
        
  • 
          :enable_performance_insights
          (Boolean)
          
            
          
          
            — 
    (Not supported by Neptune)
    
          
        
    • 
      
        
  • 
          :performance_insights_kms_key_id
          (String)
          
            
          
          
            — 
    (Not supported by Neptune)
    
          
        
    • 
      
        
  • 
          :enable_cloudwatch_logs_exports
          (Array<String>)
          
            
          
          
            — 
    The list of log types that need to be enabled for exporting to
CloudWatch Logs.
    
          
        
    • 
      
        
  • 
          :deletion_protection
          (Boolean)
          
            
          
          
            — 
    A value that indicates whether the DB instance has deletion protection
enabled. The database can't be deleted when deletion protection is
enabled. By default, deletion protection is disabled. See Deleting a
DB Instance.
    

    DB instances in a DB cluster can be deleted even when deletion
protection is enabled in their parent DB cluster.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


297

    		
    
      
# File 'sig/client.rbs', line 297

def create_db_instance: (

    		
  





    
      

  

  
    #create_db_parameter_group(params = {})  ⇒ Types::CreateDBParameterGroupResult 
  

  

  




  

    
Creates a new DB parameter group.


A DB parameter group is initially created with the default parameters
for the database engine used by the DB instance. To provide custom
values for any of the parameters, you must modify the group after
creating it using ModifyDBParameterGroup. Once you've created a DB
parameter group, you need to associate it with your DB instance using
ModifyDBInstance. When you associate a new DB parameter group with a
running DB instance, you need to reboot the DB instance without
failover for the new DB parameter group and associated settings to
take effect.


After you create a DB parameter group, you should wait at least 5
minutes before creating your first DB instance that uses that DB
parameter group as the default parameter group. This allows Amazon
Neptune to fully complete the create action before the parameter group
is used as the default for a new DB instance. This is especially
important for parameters that are critical when creating the default
database for a DB instance, such as the character set for the default
database defined by the character_set_database parameter. You can
use the Parameter Groups option of the Amazon Neptune console or the
DescribeDBParameters command to verify that your DB parameter group
has been created or modified.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_db_parameter_group({
  db_parameter_group_name: "String", # required
  db_parameter_group_family: "String", # required
  description: "String", # required
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

    
      
        
Response structure

      
      

resp.db_parameter_group.db_parameter_group_name #=> String
resp.db_parameter_group.db_parameter_group_family #=> String
resp.db_parameter_group.description #=> String
resp.db_parameter_group.db_parameter_group_arn #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :db_parameter_group_name
          (required, String)
          
            
          
          
            — 
    The name of the DB parameter group.
    

    Constraints:
    

      

    • 

      Must be 1 to 255 letters, numbers, or hyphens.
      

      • 

    • 

      First character must be a letter
      

      • 

    • 

      Cannot end with a hyphen or contain two consecutive hyphens
      

      • 

    

     This value is stored as a lowercase string.
    
 
    
          
        
    • 
      
        
  • 
          :db_parameter_group_family
          (required, String)
          
            
          
          
            — 
    The DB parameter group family name. A DB parameter group can be
associated with one and only one DB parameter group family, and can be
applied only to a DB instance running a database engine and engine
version compatible with that DB parameter group family.
    
          
        
    • 
      
        
  • 
          :description
          (required, String)
          
            
          
          
            — 
    The description for the DB parameter group.
    
          
        
    • 
      
        
  • 
          :tags
          (Array<Types::Tag>)
          
            
          
          
            — 
    The tags to be assigned to the new DB parameter group.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


354

    		
    
      
# File 'sig/client.rbs', line 354

def create_db_parameter_group: (

    		
  





    
      

  

  
    #create_db_subnet_group(params = {})  ⇒ Types::CreateDBSubnetGroupResult 
  

  

  




  

    
Creates a new DB subnet group. DB subnet groups must contain at least
one subnet in at least two AZs in the Amazon Region.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_db_subnet_group({
  db_subnet_group_name: "String", # required
  db_subnet_group_description: "String", # required
  subnet_ids: ["String"], # required
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

    
      
        
Response structure

      
      

resp.db_subnet_group.db_subnet_group_name #=> String
resp.db_subnet_group.db_subnet_group_description #=> String
resp.db_subnet_group.vpc_id #=> String
resp.db_subnet_group.subnet_group_status #=> String
resp.db_subnet_group.subnets #=> Array
resp.db_subnet_group.subnets[0].subnet_identifier #=> String
resp.db_subnet_group.subnets[0].subnet_availability_zone.name #=> String
resp.db_subnet_group.subnets[0].subnet_status #=> String
resp.db_subnet_group.db_subnet_group_arn #=> String
resp.db_subnet_group.supported_network_types #=> Array
resp.db_subnet_group.supported_network_types[0] #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :db_subnet_group_name
          (required, String)
          
            
          
          
            — 
    The name for the DB subnet group. This value is stored as a lowercase
string.
    

    Constraints: Must contain no more than 255 letters, numbers, periods,
underscores, spaces, or hyphens. Must not be default.
    

    Example: mySubnetgroup
    
          
        
    • 
      
        
  • 
          :db_subnet_group_description
          (required, String)
          
            
          
          
            — 
    The description for the DB subnet group.
    
          
        
    • 
      
        
  • 
          :subnet_ids
          (required, Array<String>)
          
            
          
          
            — 
    The EC2 Subnet IDs for the DB subnet group.
    
          
        
    • 
      
        
  • 
          :tags
          (Array<Types::Tag>)
          
            
          
          
            — 
    The tags to be assigned to the new DB subnet group.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


372

    		
    
      
# File 'sig/client.rbs', line 372

def create_db_subnet_group: (

    		
  





    
      

  

  
    #create_event_subscription(params = {})  ⇒ Types::CreateEventSubscriptionResult 
  

  

  




  

    
Creates an event notification subscription. This action requires a
topic ARN (Amazon Resource Name) created by either the Neptune
console, the SNS console, or the SNS API. To obtain an ARN with SNS,
you must create a topic in Amazon SNS and subscribe to the topic. The
ARN is displayed in the SNS console.


You can specify the type of source (SourceType) you want to be
notified of, provide a list of Neptune sources (SourceIds) that
triggers the events, and provide a list of event categories
(EventCategories) for events you want to be notified of. For example,
you can specify SourceType = db-instance, SourceIds = mydbinstance1,
mydbinstance2 and EventCategories = Availability, Backup.


If you specify both the SourceType and SourceIds, such as SourceType =
db-instance and SourceIdentifier = myDBInstance1, you are notified of
all the db-instance events for the specified source. If you specify a
SourceType but do not specify a SourceIdentifier, you receive notice
of the events for that source type for all your Neptune sources. If
you do not specify either the SourceType nor the SourceIdentifier, you
are notified of events generated from all Neptune sources belonging to
your customer account.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_event_subscription({
  subscription_name: "String", # required
  sns_topic_arn: "String", # required
  source_type: "String",
  event_categories: ["String"],
  source_ids: ["String"],
  enabled: false,
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

    
      
        
Response structure

      
      

resp.event_subscription.customer_aws_id #=> String
resp.event_subscription.cust_subscription_id #=> String
resp.event_subscription.sns_topic_arn #=> String
resp.event_subscription.status #=> String
resp.event_subscription.subscription_creation_time #=> String
resp.event_subscription.source_type #=> String
resp.event_subscription.source_ids_list #=> Array
resp.event_subscription.source_ids_list[0] #=> String
resp.event_subscription.event_categories_list #=> Array
resp.event_subscription.event_categories_list[0] #=> String
resp.event_subscription.enabled #=> Boolean
resp.event_subscription.event_subscription_arn #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :subscription_name
          (required, String)
          
            
          
          
            — 
    The name of the subscription.
    

    Constraints: The name must be less than 255 characters.
    
          
        
    • 
      
        
  • 
          :sns_topic_arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the SNS topic created for event
notification. The ARN is created by Amazon SNS when you create a topic
and subscribe to it.
    
          
        
    • 
      
        
  • 
          :source_type
          (String)
          
            
          
          
            — 
    The type of source that is generating the events. For example, if you
want to be notified of events generated by a DB instance, you would
set this parameter to db-instance. if this value is not specified, all
events are returned.
    

    Valid values: db-instance | db-cluster | db-parameter-group |
db-security-group | db-snapshot | db-cluster-snapshot
    
          
        
    • 
      
        
  • 
          :event_categories
          (Array<String>)
          
            
          
          
            — 
    A list of event categories for a SourceType that you want to subscribe
to. You can see a list of the categories for a given SourceType by
using the DescribeEventCategories action.
    
          
        
    • 
      
        
  • 
          :source_ids
          (Array<String>)
          
            
          
          
            — 
    The list of identifiers of the event sources for which events are
returned. If not specified, then all sources are included in the
response. An identifier must begin with a letter and must contain only
ASCII letters, digits, and hyphens; it can't end with a hyphen or
contain two consecutive hyphens.
    

    Constraints:
    

      

    • 

      If SourceIds are supplied, SourceType must also be provided.
      

      • 

    • 

      If the source type is a DB instance, then a DBInstanceIdentifier
must be supplied.
      

      • 

    • 

      If the source type is a DB security group, a DBSecurityGroupName
must be supplied.
      

      • 

    • 

      If the source type is a DB parameter group, a DBParameterGroupName
must be supplied.
      

      • 

    • 

      If the source type is a DB snapshot, a DBSnapshotIdentifier must
be supplied.
      

      • 

    
          
        
    • 
      
        
  • 
          :enabled
          (Boolean)
          
            
          
          
            — 
    A Boolean value; set to true to activate the subscription, set to
false to create the subscription but not activate it.
    
          
        
    • 
      
        
  • 
          :tags
          (Array<Types::Tag>)
          
            
          
          
            — 
    The tags to be applied to the new event subscription.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


390

    		
    
      
# File 'sig/client.rbs', line 390

def create_event_subscription: (

    		
  





    
      

  

  
    #create_global_cluster(params = {})  ⇒ Types::CreateGlobalClusterResult 
  

  

  




  

    
Creates a Neptune global database spread across multiple Amazon
Regions. The global database contains a single primary cluster with
read-write capability, and read-only secondary clusters that receive
data from the primary cluster through high-speed replication performed
by the Neptune storage subsystem.


You can create a global database that is initially empty, and then add
a primary cluster and secondary clusters to it, or you can specify an
existing Neptune cluster during the create operation to become the
primary cluster of the global database.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.create_global_cluster({
  global_cluster_identifier: "GlobalClusterIdentifier", # required
  source_db_cluster_identifier: "String",
  engine: "String",
  engine_version: "String",
  deletion_protection: false,
  database_name: "String",
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
  storage_encrypted: false,
})

    
      
        
Response structure

      
      

resp.global_cluster.global_cluster_identifier #=> String
resp.global_cluster.global_cluster_resource_id #=> String
resp.global_cluster.global_cluster_arn #=> String
resp.global_cluster.status #=> String
resp.global_cluster.engine #=> String
resp.global_cluster.engine_version #=> String
resp.global_cluster.database_name #=> String
resp.global_cluster.storage_encrypted #=> Boolean
resp.global_cluster.deletion_protection #=> Boolean
resp.global_cluster.global_cluster_members #=> Array
resp.global_cluster.global_cluster_members[0].db_cluster_arn #=> String
resp.global_cluster.global_cluster_members[0].readers #=> Array
resp.global_cluster.global_cluster_members[0].readers[0] #=> String
resp.global_cluster.global_cluster_members[0].is_writer #=> Boolean
resp.global_cluster.failover_state.status #=> String, one of "pending", "failing-over", "cancelling"
resp.global_cluster.failover_state.from_db_cluster_arn #=> String
resp.global_cluster.failover_state.to_db_cluster_arn #=> String
resp.global_cluster.failover_state.is_data_loss_allowed #=> Boolean
resp.global_cluster.tag_list #=> Array
resp.global_cluster.tag_list[0].key #=> String
resp.global_cluster.tag_list[0].value #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :global_cluster_identifier
          (required, String)
          
            
          
          
            — 
    The cluster identifier of the new global database cluster.
    
          
        
    • 
      
        
  • 
          :source_db_cluster_identifier
          (String)
          
            
              — default:
              *Optional*
            
          
          
            — 
    The Amazon Resource Name (ARN) of an existing Neptune DB
cluster to use as the primary cluster of the new global database.
    
          
        
    • 
      
        
  • 
          :engine
          (String)
          
            
          
          
            — 
    The name of the database engine to be used in the global database.
    

    Valid values: neptune
    
          
        
    • 
      
        
  • 
          :engine_version
          (String)
          
            
          
          
            — 
    The Neptune engine version to be used by the global database.
    

    Valid values: 1.2.0.0 or above.
    
          
        
    • 
      
        
  • 
          :deletion_protection
          (Boolean)
          
            
          
          
            — 
    The deletion protection setting for the new global database. The
global database can't be deleted when deletion protection is enabled.
    
          
        
    • 
      
        
  • 
          :database_name
          (String)
          
            
          
          
            — 
    The name for the new global database (up to 64 alpha-numeric
characters).
    
          
        
    • 
      
        
  • 
          :tags
          (Array<Types::Tag>)
          
            
          
          
            — 
    Tags to assign to the global cluster.
    
          
        
    • 
      
        
  • 
          :storage_encrypted
          (Boolean)
          
            
          
          
            — 
    The storage encryption setting for the new global database cluster.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


411

    		
    
      
# File 'sig/client.rbs', line 411

def create_global_cluster: (

    		
  





    
      

  

  
    #delete_db_cluster(params = {})  ⇒ Types::DeleteDBClusterResult 
  

  

  




  

    
The DeleteDBCluster action deletes a previously provisioned DB
cluster. When you delete a DB cluster, all automated backups for that
DB cluster are deleted and can't be recovered. Manual DB cluster
snapshots of the specified DB cluster are not deleted.


Note that the DB Cluster cannot be deleted if deletion protection is
enabled. To delete it, you must first set its DeletionProtection
field to False.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_db_cluster({
  db_cluster_identifier: "String", # required
  skip_final_snapshot: false,
  final_db_snapshot_identifier: "String",
})

    
      
        
Response structure

      
      

resp.db_cluster.allocated_storage #=> Integer
resp.db_cluster.availability_zones #=> Array
resp.db_cluster.availability_zones[0] #=> String
resp.db_cluster.backup_retention_period #=> Integer
resp.db_cluster.character_set_name #=> String
resp.db_cluster.database_name #=> String
resp.db_cluster.db_cluster_identifier #=> String
resp.db_cluster.db_cluster_parameter_group #=> String
resp.db_cluster.db_subnet_group #=> String
resp.db_cluster.status #=> String
resp.db_cluster.percent_progress #=> String
resp.db_cluster.earliest_restorable_time #=> Time
resp.db_cluster.endpoint #=> String
resp.db_cluster.reader_endpoint #=> String
resp.db_cluster.multi_az #=> Boolean
resp.db_cluster.engine #=> String
resp.db_cluster.engine_version #=> String
resp.db_cluster.latest_restorable_time #=> Time
resp.db_cluster.port #=> Integer
resp.db_cluster.master_username #=> String
resp.db_cluster.db_cluster_option_group_memberships #=> Array
resp.db_cluster.db_cluster_option_group_memberships[0].db_cluster_option_group_name #=> String
resp.db_cluster.db_cluster_option_group_memberships[0].status #=> String
resp.db_cluster.preferred_backup_window #=> String
resp.db_cluster.preferred_maintenance_window #=> String
resp.db_cluster.replication_source_identifier #=> String
resp.db_cluster.read_replica_identifiers #=> Array
resp.db_cluster.read_replica_identifiers[0] #=> String
resp.db_cluster.db_cluster_members #=> Array
resp.db_cluster.db_cluster_members[0].db_instance_identifier #=> String
resp.db_cluster.db_cluster_members[0].is_cluster_writer #=> Boolean
resp.db_cluster.db_cluster_members[0].db_cluster_parameter_group_status #=> String
resp.db_cluster.db_cluster_members[0].promotion_tier #=> Integer
resp.db_cluster.vpc_security_groups #=> Array
resp.db_cluster.vpc_security_groups[0].vpc_security_group_id #=> String
resp.db_cluster.vpc_security_groups[0].status #=> String
resp.db_cluster.hosted_zone_id #=> String
resp.db_cluster.storage_encrypted #=> Boolean
resp.db_cluster.kms_key_id #=> String
resp.db_cluster.db_cluster_resource_id #=> String
resp.db_cluster.db_cluster_arn #=> String
resp.db_cluster.associated_roles #=> Array
resp.db_cluster.associated_roles[0].role_arn #=> String
resp.db_cluster.associated_roles[0].status #=> String
resp.db_cluster.associated_roles[0].feature_name #=> String
resp.db_cluster.iam_database_authentication_enabled #=> Boolean
resp.db_cluster.clone_group_id #=> String
resp.db_cluster.cluster_create_time #=> Time
resp.db_cluster.copy_tags_to_snapshot #=> Boolean
resp.db_cluster.enabled_cloudwatch_logs_exports #=> Array
resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String
resp.db_cluster.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_enable #=> Array
resp.db_cluster.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_enable[0] #=> String
resp.db_cluster.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_disable #=> Array
resp.db_cluster.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_disable[0] #=> String
resp.db_cluster.pending_modified_values.db_cluster_identifier #=> String
resp.db_cluster.pending_modified_values.iam_database_authentication_enabled #=> Boolean
resp.db_cluster.pending_modified_values.engine_version #=> String
resp.db_cluster.pending_modified_values.backup_retention_period #=> Integer
resp.db_cluster.pending_modified_values.storage_type #=> String
resp.db_cluster.pending_modified_values.allocated_storage #=> Integer
resp.db_cluster.pending_modified_values.iops #=> Integer
resp.db_cluster.pending_modified_values.network_type #=> String
resp.db_cluster.deletion_protection #=> Boolean
resp.db_cluster. #=> Boolean
resp.db_cluster.automatic_restart_time #=> Time
resp.db_cluster.serverless_v2_scaling_configuration.min_capacity #=> Float
resp.db_cluster.serverless_v2_scaling_configuration.max_capacity #=> Float
resp.db_cluster.global_cluster_identifier #=> String
resp.db_cluster.io_optimized_next_allowed_modification_time #=> Time
resp.db_cluster.storage_type #=> String
resp.db_cluster.network_type #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :db_cluster_identifier
          (required, String)
          
            
          
          
            — 
    The DB cluster identifier for the DB cluster to be deleted. This
parameter isn't case-sensitive.
    

    Constraints:
    

      

    • Must match an existing DBClusterIdentifier.
      • 

    

    ^
    
          
        
    • 
      
        
  • 
          :skip_final_snapshot
          (Boolean)
          
            
          
          
            — 
    Determines whether a final DB cluster snapshot is created before the
DB cluster is deleted. If true is specified, no DB cluster snapshot
is created. If false is specified, a DB cluster snapshot is created
before the DB cluster is deleted.
    

     You must specify a FinalDBSnapshotIdentifier parameter if
SkipFinalSnapshot is false.
    
 

    Default: false
    
          
        
    • 
      
        
  • 
          :final_db_snapshot_identifier
          (String)
          
            
          
          
            — 
    The DB cluster snapshot identifier of the new DB cluster snapshot
created when SkipFinalSnapshot is set to false.
    

     Specifying this parameter and also setting the SkipFinalSnapshot
parameter to true results in an error.
    
 

    Constraints:
    

      

    • 

      Must be 1 to 255 letters, numbers, or hyphens.
      

      • 

    • 

      First character must be a letter
      

      • 

    • 

      Cannot end with a hyphen or contain two consecutive hyphens
      

      • 

    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


433

    		
    
      
# File 'sig/client.rbs', line 433

def delete_db_cluster: (

    		
  





    
      

  

  
    #delete_db_cluster_endpoint(params = {})  ⇒ Types::DeleteDBClusterEndpointOutput 
  

  

  




  

    
Deletes a custom endpoint and removes it from an Amazon Neptune DB
cluster.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_db_cluster_endpoint({
  db_cluster_endpoint_identifier: "String", # required
})

    
      
        
Response structure

      
      

resp.db_cluster_endpoint_identifier #=> String
resp.db_cluster_identifier #=> String
resp.db_cluster_endpoint_resource_identifier #=> String
resp.endpoint #=> String
resp.status #=> String
resp.endpoint_type #=> String
resp.custom_endpoint_type #=> String
resp.static_members #=> Array
resp.static_members[0] #=> String
resp.excluded_members #=> Array
resp.excluded_members[0] #=> String
resp.db_cluster_endpoint_arn #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :db_cluster_endpoint_identifier
          (required, String)
          
            
          
          
            — 
    The identifier associated with the custom endpoint. This parameter is
stored as a lowercase string.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


454

    		
    
      
# File 'sig/client.rbs', line 454

def delete_db_cluster_endpoint: (

    		
  





    
      

  

  
    #delete_db_cluster_parameter_group(params = {})  ⇒ Struct 
  

  

  




  

    
Deletes a specified DB cluster parameter group. The DB cluster
parameter group to be deleted can't be associated with any DB
clusters.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_db_cluster_parameter_group({
  db_cluster_parameter_group_name: "String", # required
})

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :db_cluster_parameter_group_name
          (required, String)
          
            
          
          
            — 
    The name of the DB cluster parameter group.
    

    Constraints:
    

      

    • 

      Must be the name of an existing DB cluster parameter group.
      

      • 

    • 

      You can't delete a default DB cluster parameter group.
      

      • 

    • 

      Cannot be associated with any DB clusters.
      

      • 

    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
        (Struct)
      
      
      
        —
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


460

    		
    
      
# File 'sig/client.rbs', line 460

def delete_db_cluster_parameter_group: (

    		
  





    
      

  

  
    #delete_db_cluster_snapshot(params = {})  ⇒ Types::DeleteDBClusterSnapshotResult 
  

  

  




  

    
Deletes a DB cluster snapshot. If the snapshot is being copied, the
copy operation is terminated.


 The DB cluster snapshot must be in the available state to be
deleted.

 

  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_db_cluster_snapshot({
  db_cluster_snapshot_identifier: "String", # required
})

    
      
        
Response structure

      
      

resp.db_cluster_snapshot.availability_zones #=> Array
resp.db_cluster_snapshot.availability_zones[0] #=> String
resp.db_cluster_snapshot.db_cluster_snapshot_identifier #=> String
resp.db_cluster_snapshot.db_cluster_identifier #=> String
resp.db_cluster_snapshot.snapshot_create_time #=> Time
resp.db_cluster_snapshot.engine #=> String
resp.db_cluster_snapshot.allocated_storage #=> Integer
resp.db_cluster_snapshot.status #=> String
resp.db_cluster_snapshot.port #=> Integer
resp.db_cluster_snapshot.vpc_id #=> String
resp.db_cluster_snapshot.cluster_create_time #=> Time
resp.db_cluster_snapshot.master_username #=> String
resp.db_cluster_snapshot.engine_version #=> String
resp.db_cluster_snapshot.license_model #=> String
resp.db_cluster_snapshot.snapshot_type #=> String
resp.db_cluster_snapshot.percent_progress #=> Integer
resp.db_cluster_snapshot.storage_encrypted #=> Boolean
resp.db_cluster_snapshot.kms_key_id #=> String
resp.db_cluster_snapshot.db_cluster_snapshot_arn #=> String
resp.db_cluster_snapshot.source_db_cluster_snapshot_arn #=> String
resp.db_cluster_snapshot.iam_database_authentication_enabled #=> Boolean
resp.db_cluster_snapshot.storage_type #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :db_cluster_snapshot_identifier
          (required, String)
          
            
          
          
            — 
    The identifier of the DB cluster snapshot to delete.
    

    Constraints: Must be the name of an existing DB cluster snapshot in
the available state.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


470

    		
    
      
# File 'sig/client.rbs', line 470

def delete_db_cluster_snapshot: (

    		
  





    
      

  

  
    #delete_db_instance(params = {})  ⇒ Types::DeleteDBInstanceResult 
  

  

  




  

    
The DeleteDBInstance action deletes a previously provisioned DB
instance. When you delete a DB instance, all automated backups for
that instance are deleted and can't be recovered. Manual DB snapshots
of the DB instance to be deleted by DeleteDBInstance are not
deleted.


If you request a final DB snapshot the status of the Amazon Neptune DB
instance is deleting until the DB snapshot is created. The API
action DescribeDBInstance is used to monitor the status of this
operation. The action can't be canceled or reverted once submitted.


Note that when a DB instance is in a failure state and has a status of
failed, incompatible-restore, or incompatible-network, you can
only delete it when the SkipFinalSnapshot parameter is set to
true.


You can't delete a DB instance if it is the only instance in the DB
cluster, or if it has deletion protection enabled.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_db_instance({
  db_instance_identifier: "String", # required
  skip_final_snapshot: false,
  final_db_snapshot_identifier: "String",
})

    
      
        
Response structure

      
      

resp.db_instance.db_instance_identifier #=> String
resp.db_instance.db_instance_class #=> String
resp.db_instance.engine #=> String
resp.db_instance.db_instance_status #=> String
resp.db_instance.master_username #=> String
resp.db_instance.db_name #=> String
resp.db_instance.endpoint.address #=> String
resp.db_instance.endpoint.port #=> Integer
resp.db_instance.endpoint.hosted_zone_id #=> String
resp.db_instance.allocated_storage #=> Integer
resp.db_instance.instance_create_time #=> Time
resp.db_instance.preferred_backup_window #=> String
resp.db_instance.backup_retention_period #=> Integer
resp.db_instance.db_security_groups #=> Array
resp.db_instance.db_security_groups[0].db_security_group_name #=> String
resp.db_instance.db_security_groups[0].status #=> String
resp.db_instance.vpc_security_groups #=> Array
resp.db_instance.vpc_security_groups[0].vpc_security_group_id #=> String
resp.db_instance.vpc_security_groups[0].status #=> String
resp.db_instance.db_parameter_groups #=> Array
resp.db_instance.db_parameter_groups[0].db_parameter_group_name #=> String
resp.db_instance.db_parameter_groups[0].parameter_apply_status #=> String
resp.db_instance.availability_zone #=> String
resp.db_instance.db_subnet_group.db_subnet_group_name #=> String
resp.db_instance.db_subnet_group.db_subnet_group_description #=> String
resp.db_instance.db_subnet_group.vpc_id #=> String
resp.db_instance.db_subnet_group.subnet_group_status #=> String
resp.db_instance.db_subnet_group.subnets #=> Array
resp.db_instance.db_subnet_group.subnets[0].subnet_identifier #=> String
resp.db_instance.db_subnet_group.subnets[0].subnet_availability_zone.name #=> String
resp.db_instance.db_subnet_group.subnets[0].subnet_status #=> String
resp.db_instance.db_subnet_group.db_subnet_group_arn #=> String
resp.db_instance.db_subnet_group.supported_network_types #=> Array
resp.db_instance.db_subnet_group.supported_network_types[0] #=> String
resp.db_instance.preferred_maintenance_window #=> String
resp.db_instance.pending_modified_values.db_instance_class #=> String
resp.db_instance.pending_modified_values.allocated_storage #=> Integer
resp.db_instance.pending_modified_values.master_user_password #=> String
resp.db_instance.pending_modified_values.port #=> Integer
resp.db_instance.pending_modified_values.backup_retention_period #=> Integer
resp.db_instance.pending_modified_values.multi_az #=> Boolean
resp.db_instance.pending_modified_values.engine_version #=> String
resp.db_instance.pending_modified_values.license_model #=> String
resp.db_instance.pending_modified_values.iops #=> Integer
resp.db_instance.pending_modified_values.db_instance_identifier #=> String
resp.db_instance.pending_modified_values.storage_type #=> String
resp.db_instance.pending_modified_values.ca_certificate_identifier #=> String
resp.db_instance.pending_modified_values.db_subnet_group_name #=> String
resp.db_instance.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_enable #=> Array
resp.db_instance.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_enable[0] #=> String
resp.db_instance.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_disable #=> Array
resp.db_instance.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_disable[0] #=> String
resp.db_instance.latest_restorable_time #=> Time
resp.db_instance.multi_az #=> Boolean
resp.db_instance.engine_version #=> String
resp.db_instance.auto_minor_version_upgrade #=> Boolean
resp.db_instance.read_replica_source_db_instance_identifier #=> String
resp.db_instance.read_replica_db_instance_identifiers #=> Array
resp.db_instance.read_replica_db_instance_identifiers[0] #=> String
resp.db_instance.read_replica_db_cluster_identifiers #=> Array
resp.db_instance.read_replica_db_cluster_identifiers[0] #=> String
resp.db_instance.license_model #=> String
resp.db_instance.iops #=> Integer
resp.db_instance.option_group_memberships #=> Array
resp.db_instance.option_group_memberships[0].option_group_name #=> String
resp.db_instance.option_group_memberships[0].status #=> String
resp.db_instance.character_set_name #=> String
resp.db_instance.secondary_availability_zone #=> String
resp.db_instance.publicly_accessible #=> Boolean
resp.db_instance.status_infos #=> Array
resp.db_instance.status_infos[0].status_type #=> String
resp.db_instance.status_infos[0].normal #=> Boolean
resp.db_instance.status_infos[0].status #=> String
resp.db_instance.status_infos[0].message #=> String
resp.db_instance.storage_type #=> String
resp.db_instance.tde_credential_arn #=> String
resp.db_instance.db_instance_port #=> Integer
resp.db_instance.db_cluster_identifier #=> String
resp.db_instance.storage_encrypted #=> Boolean
resp.db_instance.kms_key_id #=> String
resp.db_instance.dbi_resource_id #=> String
resp.db_instance.ca_certificate_identifier #=> String
resp.db_instance.domain_memberships #=> Array
resp.db_instance.domain_memberships[0].domain #=> String
resp.db_instance.domain_memberships[0].status #=> String
resp.db_instance.domain_memberships[0].fqdn #=> String
resp.db_instance.domain_memberships[0].iam_role_name #=> String
resp.db_instance.copy_tags_to_snapshot #=> Boolean
resp.db_instance.monitoring_interval #=> Integer
resp.db_instance.enhanced_monitoring_resource_arn #=> String
resp.db_instance.monitoring_role_arn #=> String
resp.db_instance.promotion_tier #=> Integer
resp.db_instance.db_instance_arn #=> String
resp.db_instance.timezone #=> String
resp.db_instance.iam_database_authentication_enabled #=> Boolean
resp.db_instance.performance_insights_enabled #=> Boolean
resp.db_instance.performance_insights_kms_key_id #=> String
resp.db_instance.enabled_cloudwatch_logs_exports #=> Array
resp.db_instance.enabled_cloudwatch_logs_exports[0] #=> String
resp.db_instance.deletion_protection #=> Boolean
resp.db_instance.network_type #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :db_instance_identifier
          (required, String)
          
            
          
          
            — 
    The DB instance identifier for the DB instance to be deleted. This
parameter isn't case-sensitive.
    

    Constraints:
    

      

    • Must match the name of an existing DB instance.
      • 

    

    ^
    
          
        
    • 
      
        
  • 
          :skip_final_snapshot
          (Boolean)
          
            
          
          
            — 
    Determines whether a final DB snapshot is created before the DB
instance is deleted. If true is specified, no DBSnapshot is created.
If false is specified, a DB snapshot is created before the DB
instance is deleted.
    

    Note that when a DB instance is in a failure state and has a status of
'failed', 'incompatible-restore', or 'incompatible-network', it
can only be deleted when the SkipFinalSnapshot parameter is set to
"true".
    

    Specify true when deleting a Read Replica.
    

     The FinalDBSnapshotIdentifier parameter must be specified if
SkipFinalSnapshot is false.
    
 

    Default: false
    
          
        
    • 
      
        
  • 
          :final_db_snapshot_identifier
          (String)
          
            
          
          
            — 
    The DBSnapshotIdentifier of the new DBSnapshot created when
SkipFinalSnapshot is set to false.
    

     Specifying this parameter and also setting the SkipFinalSnapshot
parameter to true results in an error.
    
 

    Constraints:
    

      

    • 

      Must be 1 to 255 letters or numbers.
      

      • 

    • 

      First character must be a letter
      

      • 

    • 

      Cannot end with a hyphen or contain two consecutive hyphens
      

      • 

    • 

      Cannot be specified when deleting a Read Replica.
      

      • 

    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


480

    		
    
      
# File 'sig/client.rbs', line 480

def delete_db_instance: (

    		
  





    
      

  

  
    #delete_db_parameter_group(params = {})  ⇒ Struct 
  

  

  




  

    
Deletes a specified DBParameterGroup. The DBParameterGroup to be
deleted can't be associated with any DB instances.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_db_parameter_group({
  db_parameter_group_name: "String", # required
})

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :db_parameter_group_name
          (required, String)
          
            
          
          
            — 
    The name of the DB parameter group.
    

    Constraints:
    

      

    • 

      Must be the name of an existing DB parameter group
      

      • 

    • 

      You can't delete a default DB parameter group
      

      • 

    • 

      Cannot be associated with any DB instances
      

      • 

    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
        (Struct)
      
      
      
        —
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


488

    		
    
      
# File 'sig/client.rbs', line 488

def delete_db_parameter_group: (

    		
  





    
      

  

  
    #delete_db_subnet_group(params = {})  ⇒ Struct 
  

  

  




  

    
Deletes a DB subnet group.


 The specified database subnet group must not be associated with any DB
instances.

 

  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_db_subnet_group({
  db_subnet_group_name: "String", # required
})

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :db_subnet_group_name
          (required, String)
          
            
          
          
            — 
    The name of the database subnet group to delete.
    

     You can't delete the default subnet group.
    
 

    Constraints:
    

    Constraints: Must match the name of an existing DBSubnetGroup. Must
not be default.
    

    Example: mySubnetgroup
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
        (Struct)
      
      
      
        —
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


494

    		
    
      
# File 'sig/client.rbs', line 494

def delete_db_subnet_group: (

    		
  





    
      

  

  
    #delete_event_subscription(params = {})  ⇒ Types::DeleteEventSubscriptionResult 
  

  

  




  

    
Deletes an event notification subscription.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_event_subscription({
  subscription_name: "String", # required
})

    
      
        
Response structure

      
      

resp.event_subscription.customer_aws_id #=> String
resp.event_subscription.cust_subscription_id #=> String
resp.event_subscription.sns_topic_arn #=> String
resp.event_subscription.status #=> String
resp.event_subscription.subscription_creation_time #=> String
resp.event_subscription.source_type #=> String
resp.event_subscription.source_ids_list #=> Array
resp.event_subscription.source_ids_list[0] #=> String
resp.event_subscription.event_categories_list #=> Array
resp.event_subscription.event_categories_list[0] #=> String
resp.event_subscription.enabled #=> Boolean
resp.event_subscription.event_subscription_arn #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :subscription_name
          (required, String)
          
            
          
          
            — 
    The name of the event notification subscription you want to delete.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


504

    		
    
      
# File 'sig/client.rbs', line 504

def delete_event_subscription: (

    		
  





    
      

  

  
    #delete_global_cluster(params = {})  ⇒ Types::DeleteGlobalClusterResult 
  

  

  




  

    
Deletes a global database. The primary and all secondary clusters must
already be detached or deleted first.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.delete_global_cluster({
  global_cluster_identifier: "GlobalClusterIdentifier", # required
})

    
      
        
Response structure

      
      

resp.global_cluster.global_cluster_identifier #=> String
resp.global_cluster.global_cluster_resource_id #=> String
resp.global_cluster.global_cluster_arn #=> String
resp.global_cluster.status #=> String
resp.global_cluster.engine #=> String
resp.global_cluster.engine_version #=> String
resp.global_cluster.database_name #=> String
resp.global_cluster.storage_encrypted #=> Boolean
resp.global_cluster.deletion_protection #=> Boolean
resp.global_cluster.global_cluster_members #=> Array
resp.global_cluster.global_cluster_members[0].db_cluster_arn #=> String
resp.global_cluster.global_cluster_members[0].readers #=> Array
resp.global_cluster.global_cluster_members[0].readers[0] #=> String
resp.global_cluster.global_cluster_members[0].is_writer #=> Boolean
resp.global_cluster.failover_state.status #=> String, one of "pending", "failing-over", "cancelling"
resp.global_cluster.failover_state.from_db_cluster_arn #=> String
resp.global_cluster.failover_state.to_db_cluster_arn #=> String
resp.global_cluster.failover_state.is_data_loss_allowed #=> Boolean
resp.global_cluster.tag_list #=> Array
resp.global_cluster.tag_list[0].key #=> String
resp.global_cluster.tag_list[0].value #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :global_cluster_identifier
          (required, String)
          
            
          
          
            — 
    The cluster identifier of the global database cluster being deleted.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


514

    		
    
      
# File 'sig/client.rbs', line 514

def delete_global_cluster: (

    		
  





    
      

  

  
    #describe_db_cluster_endpoints(params = {})  ⇒ Types::DBClusterEndpointMessage 
  

  

  




  

    
Returns information about endpoints for an Amazon Neptune DB cluster.


 This operation can also return information for Amazon RDS clusters and
Amazon DocDB 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.describe_db_cluster_endpoints({
  db_cluster_identifier: "String",
  db_cluster_endpoint_identifier: "String",
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
  max_records: 1,
  marker: "String",
})

    
      
        
Response structure

      
      

resp.marker #=> String
resp.db_cluster_endpoints #=> Array
resp.db_cluster_endpoints[0].db_cluster_endpoint_identifier #=> String
resp.db_cluster_endpoints[0].db_cluster_identifier #=> String
resp.db_cluster_endpoints[0].db_cluster_endpoint_resource_identifier #=> String
resp.db_cluster_endpoints[0].endpoint #=> String
resp.db_cluster_endpoints[0].status #=> String
resp.db_cluster_endpoints[0].endpoint_type #=> String
resp.db_cluster_endpoints[0].custom_endpoint_type #=> String
resp.db_cluster_endpoints[0].static_members #=> Array
resp.db_cluster_endpoints[0].static_members[0] #=> String
resp.db_cluster_endpoints[0].excluded_members #=> Array
resp.db_cluster_endpoints[0].excluded_members[0] #=> String
resp.db_cluster_endpoints[0].db_cluster_endpoint_arn #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :db_cluster_identifier
          (String)
          
            
          
          
            — 
    The DB cluster identifier of the DB cluster associated with the
endpoint. This parameter is stored as a lowercase string.
    
          
        
    • 
      
        
  • 
          :db_cluster_endpoint_identifier
          (String)
          
            
          
          
            — 
    The identifier of the endpoint to describe. This parameter is stored
as a lowercase string.
    
          
        
    • 
      
        
  • 
          :filters
          (Array<Types::Filter>)
          
            
          
          
            — 
    A set of name-value pairs that define which endpoints to include in
the output. The filters are specified as name-value pairs, in the
format Name=endpoint_type,Values=endpoint_type1,endpoint_type2,....
Name can be one of: db-cluster-endpoint-type,
db-cluster-endpoint-custom-type, db-cluster-endpoint-id,
db-cluster-endpoint-status. Values for the  db-cluster-endpoint-type filter can be one or more of: reader,
writer, custom. Values for the db-cluster-endpoint-custom-type
filter can be one or more of: reader, any. Values for the
db-cluster-endpoint-status filter can be one or more of:
available, creating, deleting, inactive, modifying.
    
          
        
    • 
      
        
  • 
          :max_records
          (Integer)
          
            
          
          
            — 
    The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a pagination
token called a marker is included in the response so you can retrieve
the remaining results.
    

    Default: 100
    

    Constraints: Minimum 20, maximum 100.
    
          
        
    • 
      
        
  • 
          :marker
          (String)
          
            
          
          
            — 
    An optional pagination token provided by a previous
DescribeDBClusterEndpoints request. If this parameter is specified,
the response includes only records beyond the marker, up to the value
specified by MaxRecords.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


525

    		
    
      
# File 'sig/client.rbs', line 525

def describe_db_cluster_endpoints: (

    		
  





    
      

  

  
    #describe_db_cluster_parameter_groups(params = {})  ⇒ Types::DBClusterParameterGroupsMessage 
  

  

  




  

    
Returns a list of DBClusterParameterGroup descriptions. If a
DBClusterParameterGroupName parameter is specified, the list will
contain only the description of the specified DB cluster 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_db_cluster_parameter_groups({
  db_cluster_parameter_group_name: "String",
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
  max_records: 1,
  marker: "String",
})

    
      
        
Response structure

      
      

resp.marker #=> String
resp.db_cluster_parameter_groups #=> Array
resp.db_cluster_parameter_groups[0].db_cluster_parameter_group_name #=> String
resp.db_cluster_parameter_groups[0].db_parameter_group_family #=> String
resp.db_cluster_parameter_groups[0].description #=> String
resp.db_cluster_parameter_groups[0].db_cluster_parameter_group_arn #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :db_cluster_parameter_group_name
          (String)
          
            
          
          
            — 
    The name of a specific DB cluster parameter group to return details
for.
    

    Constraints:
    

      

    • If supplied, must match the name of an existing
DBClusterParameterGroup.
      • 

    

    ^
    
          
        
    • 
      
        
  • 
          :filters
          (Array<Types::Filter>)
          
            
          
          
            — 
    This parameter is not currently supported.
    
          
        
    • 
      
        
  • 
          :max_records
          (Integer)
          
            
          
          
            — 
    The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a pagination
token called a marker is included in the response so that the
remaining results can be retrieved.
    

    Default: 100
    

    Constraints: Minimum 20, maximum 100.
    
          
        
    • 
      
        
  • 
          :marker
          (String)
          
            
          
          
            — 
    An optional pagination token provided by a previous
DescribeDBClusterParameterGroups request. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


545

    		
    
      
# File 'sig/client.rbs', line 545

def describe_db_cluster_parameter_groups: (

    		
  





    
      

  

  
    #describe_db_cluster_parameters(params = {})  ⇒ Types::DBClusterParameterGroupDetails 
  

  

  




  

    
Returns the detailed parameter list for a particular DB cluster
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_db_cluster_parameters({
  db_cluster_parameter_group_name: "String", # required
  source: "String",
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
  max_records: 1,
  marker: "String",
})

    
      
        
Response structure

      
      

resp.parameters #=> Array
resp.parameters[0].parameter_name #=> String
resp.parameters[0].parameter_value #=> String
resp.parameters[0].description #=> String
resp.parameters[0].source #=> String
resp.parameters[0].apply_type #=> String
resp.parameters[0].data_type #=> String
resp.parameters[0].allowed_values #=> String
resp.parameters[0].is_modifiable #=> Boolean
resp.parameters[0].minimum_engine_version #=> String
resp.parameters[0].apply_method #=> String, one of "immediate", "pending-reboot"
resp.marker #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :db_cluster_parameter_group_name
          (required, String)
          
            
          
          
            — 
    The name of a specific DB cluster parameter group to return parameter
details for.
    

    Constraints:
    

      

    • If supplied, must match the name of an existing
DBClusterParameterGroup.
      • 

    

    ^
    
          
        
    • 
      
        
  • 
          :source
          (String)
          
            
          
          
            — 
    A value that indicates to return only parameters for a specific
source. Parameter sources can be engine, service, or customer.
    
          
        
    • 
      
        
  • 
          :filters
          (Array<Types::Filter>)
          
            
          
          
            — 
    This parameter is not currently supported.
    
          
        
    • 
      
        
  • 
          :max_records
          (Integer)
          
            
          
          
            — 
    The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a pagination
token called a marker is included in the response so that the
remaining results can be retrieved.
    

    Default: 100
    

    Constraints: Minimum 20, maximum 100.
    
          
        
    • 
      
        
  • 
          :marker
          (String)
          
            
          
          
            — 
    An optional pagination token provided by a previous
DescribeDBClusterParameters request. If this parameter is specified,
the response includes only records beyond the marker, up to the value
specified by MaxRecords.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


564

    		
    
      
# File 'sig/client.rbs', line 564

def describe_db_cluster_parameters: (

    		
  





    
      

  

  
    #describe_db_cluster_snapshot_attributes(params = {})  ⇒ Types::DescribeDBClusterSnapshotAttributesResult 
  

  

  




  

    
Returns a list of DB cluster snapshot attribute names and values for a
manual DB cluster snapshot.


When sharing snapshots with other Amazon accounts,
DescribeDBClusterSnapshotAttributes returns the restore attribute
and a list of IDs for the Amazon accounts that are authorized to copy
or restore the manual DB cluster snapshot. If all is included in the
list of values for the restore attribute, then the manual DB cluster
snapshot is public and can be copied or restored by all Amazon
accounts.


To add or remove access for an Amazon account to copy or restore a
manual DB cluster snapshot, or to make the manual DB cluster snapshot
public or private, use the ModifyDBClusterSnapshotAttribute API
action.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_db_cluster_snapshot_attributes({
  db_cluster_snapshot_identifier: "String", # required
})

    
      
        
Response structure

      
      

resp.db_cluster_snapshot_attributes_result.db_cluster_snapshot_identifier #=> String
resp.db_cluster_snapshot_attributes_result.db_cluster_snapshot_attributes #=> Array
resp.db_cluster_snapshot_attributes_result.db_cluster_snapshot_attributes[0].attribute_name #=> String
resp.db_cluster_snapshot_attributes_result.db_cluster_snapshot_attributes[0].attribute_values #=> Array
resp.db_cluster_snapshot_attributes_result.db_cluster_snapshot_attributes[0].attribute_values[0] #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :db_cluster_snapshot_identifier
          (required, String)
          
            
          
          
            — 
    The identifier for the DB cluster snapshot to describe the attributes
for.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


583

    		
    
      
# File 'sig/client.rbs', line 583

def describe_db_cluster_snapshot_attributes: (

    		
  





    
      

  

  
    #describe_db_cluster_snapshots(params = {})  ⇒ Types::DBClusterSnapshotMessage 
  

  

  




  

    
Returns information about DB cluster snapshots. This API action
supports pagination.


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_db_cluster_snapshots({
  db_cluster_identifier: "String",
  db_cluster_snapshot_identifier: "String",
  snapshot_type: "String",
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
  max_records: 1,
  marker: "String",
  include_shared: false,
  include_public: false,
})

    
      
        
Response structure

      
      

resp.marker #=> String
resp.db_cluster_snapshots #=> Array
resp.db_cluster_snapshots[0].availability_zones #=> Array
resp.db_cluster_snapshots[0].availability_zones[0] #=> String
resp.db_cluster_snapshots[0].db_cluster_snapshot_identifier #=> String
resp.db_cluster_snapshots[0].db_cluster_identifier #=> String
resp.db_cluster_snapshots[0].snapshot_create_time #=> Time
resp.db_cluster_snapshots[0].engine #=> String
resp.db_cluster_snapshots[0].allocated_storage #=> Integer
resp.db_cluster_snapshots[0].status #=> String
resp.db_cluster_snapshots[0].port #=> Integer
resp.db_cluster_snapshots[0].vpc_id #=> String
resp.db_cluster_snapshots[0].cluster_create_time #=> Time
resp.db_cluster_snapshots[0].master_username #=> String
resp.db_cluster_snapshots[0].engine_version #=> String
resp.db_cluster_snapshots[0].license_model #=> String
resp.db_cluster_snapshots[0].snapshot_type #=> String
resp.db_cluster_snapshots[0].percent_progress #=> Integer
resp.db_cluster_snapshots[0].storage_encrypted #=> Boolean
resp.db_cluster_snapshots[0].kms_key_id #=> String
resp.db_cluster_snapshots[0].db_cluster_snapshot_arn #=> String
resp.db_cluster_snapshots[0].source_db_cluster_snapshot_arn #=> String
resp.db_cluster_snapshots[0].iam_database_authentication_enabled #=> Boolean
resp.db_cluster_snapshots[0].storage_type #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :db_cluster_identifier
          (String)
          
            
          
          
            — 
    The ID of the DB cluster to retrieve the list of DB cluster snapshots
for. This parameter can't be used in conjunction with the
DBClusterSnapshotIdentifier parameter. This parameter is not
case-sensitive.
    

    Constraints:
    

      

    • If supplied, must match the identifier of an existing DBCluster.
      • 

    

    ^
    
          
        
    • 
      
        
  • 
          :db_cluster_snapshot_identifier
          (String)
          
            
          
          
            — 
    A specific DB cluster snapshot identifier to describe. This parameter
can't be used in conjunction with the DBClusterIdentifier
parameter. This value is stored as a lowercase string.
    

    Constraints:
    

      

    • 

      If supplied, must match the identifier of an existing
DBClusterSnapshot.
      

      • 

    • 

      If this identifier is for an automated snapshot, the SnapshotType
parameter must also be specified.
      

      • 

    
          
        
    • 
      
        
  • 
          :snapshot_type
          (String)
          
            
          
          
            — 
    The type of DB cluster snapshots to be returned. You can specify one
of the following values:
    

      

    • 

      automated - Return all DB cluster snapshots that have been
automatically taken by Amazon Neptune for my Amazon account.
      

      • 

    • 

      manual - Return all DB cluster snapshots that have been taken by
my Amazon account.
      

      • 

    • 

      shared - Return all manual DB cluster snapshots that have been
shared to my Amazon account.
      

      • 

    • 

      public - Return all DB cluster snapshots that have been marked as
public.
      

      • 

    

    If you don't specify a SnapshotType value, then both automated and
manual DB cluster snapshots are returned. You can include shared DB
cluster snapshots with these results by setting the IncludeShared
parameter to true. You can include public DB cluster snapshots with
these results by setting the IncludePublic parameter to true.
    

    The IncludeShared and IncludePublic parameters don't apply for
SnapshotType values of manual or automated. The IncludePublic
parameter doesn't apply when SnapshotType is set to shared. The
IncludeShared parameter doesn't apply when SnapshotType is set to
public.
    
          
        
    • 
      
        
  • 
          :filters
          (Array<Types::Filter>)
          
            
          
          
            — 
    This parameter is not currently supported.
    
          
        
    • 
      
        
  • 
          :max_records
          (Integer)
          
            
          
          
            — 
    The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a pagination
token called a marker is included in the response so that the
remaining results can be retrieved.
    

    Default: 100
    

    Constraints: Minimum 20, maximum 100.
    
          
        
    • 
      
        
  • 
          :marker
          (String)
          
            
          
          
            — 
    An optional pagination token provided by a previous
DescribeDBClusterSnapshots request. If this parameter is specified,
the response includes only records beyond the marker, up to the value
specified by MaxRecords.
    
          
        
    • 
      
        
  • 
          :include_shared
          (Boolean)
          
            
          
          
            — 
    True to include shared manual DB cluster snapshots from other Amazon
accounts that this Amazon account has been given permission to copy or
restore, and otherwise false. The default is false.
    

    You can give an Amazon account permission to restore a manual DB
cluster snapshot from another Amazon account by the
ModifyDBClusterSnapshotAttribute API action.
    
          
        
    • 
      
        
  • 
          :include_public
          (Boolean)
          
            
          
          
            — 
    True to include manual DB cluster snapshots that are public and can be
copied or restored by any Amazon account, and otherwise false. The
default is false. The default is false.
    

    You can share a manual DB cluster snapshot as public by using the
ModifyDBClusterSnapshotAttribute API action.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


594

    		
    
      
# File 'sig/client.rbs', line 594

def describe_db_cluster_snapshots: (

    		
  





    
      

  

  
    #describe_db_clusters(params = {})  ⇒ Types::DBClusterMessage 
  

  

  




  

    
Returns information about provisioned DB clusters, and supports
pagination.


 This operation can also return information for Amazon RDS clusters and
Amazon DocDB 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.describe_db_clusters({
  db_cluster_identifier: "String",
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
  max_records: 1,
  marker: "String",
})

    
      
        
Response structure

      
      

resp.marker #=> String
resp.db_clusters #=> Array
resp.db_clusters[0].allocated_storage #=> Integer
resp.db_clusters[0].availability_zones #=> Array
resp.db_clusters[0].availability_zones[0] #=> String
resp.db_clusters[0].backup_retention_period #=> Integer
resp.db_clusters[0].character_set_name #=> String
resp.db_clusters[0].database_name #=> String
resp.db_clusters[0].db_cluster_identifier #=> String
resp.db_clusters[0].db_cluster_parameter_group #=> String
resp.db_clusters[0].db_subnet_group #=> String
resp.db_clusters[0].status #=> String
resp.db_clusters[0].percent_progress #=> String
resp.db_clusters[0].earliest_restorable_time #=> Time
resp.db_clusters[0].endpoint #=> String
resp.db_clusters[0].reader_endpoint #=> String
resp.db_clusters[0].multi_az #=> Boolean
resp.db_clusters[0].engine #=> String
resp.db_clusters[0].engine_version #=> String
resp.db_clusters[0].latest_restorable_time #=> Time
resp.db_clusters[0].port #=> Integer
resp.db_clusters[0].master_username #=> String
resp.db_clusters[0].db_cluster_option_group_memberships #=> Array
resp.db_clusters[0].db_cluster_option_group_memberships[0].db_cluster_option_group_name #=> String
resp.db_clusters[0].db_cluster_option_group_memberships[0].status #=> String
resp.db_clusters[0].preferred_backup_window #=> String
resp.db_clusters[0].preferred_maintenance_window #=> String
resp.db_clusters[0].replication_source_identifier #=> String
resp.db_clusters[0].read_replica_identifiers #=> Array
resp.db_clusters[0].read_replica_identifiers[0] #=> String
resp.db_clusters[0].db_cluster_members #=> Array
resp.db_clusters[0].db_cluster_members[0].db_instance_identifier #=> String
resp.db_clusters[0].db_cluster_members[0].is_cluster_writer #=> Boolean
resp.db_clusters[0].db_cluster_members[0].db_cluster_parameter_group_status #=> String
resp.db_clusters[0].db_cluster_members[0].promotion_tier #=> Integer
resp.db_clusters[0].vpc_security_groups #=> Array
resp.db_clusters[0].vpc_security_groups[0].vpc_security_group_id #=> String
resp.db_clusters[0].vpc_security_groups[0].status #=> String
resp.db_clusters[0].hosted_zone_id #=> String
resp.db_clusters[0].storage_encrypted #=> Boolean
resp.db_clusters[0].kms_key_id #=> String
resp.db_clusters[0].db_cluster_resource_id #=> String
resp.db_clusters[0].db_cluster_arn #=> String
resp.db_clusters[0].associated_roles #=> Array
resp.db_clusters[0].associated_roles[0].role_arn #=> String
resp.db_clusters[0].associated_roles[0].status #=> String
resp.db_clusters[0].associated_roles[0].feature_name #=> String
resp.db_clusters[0].iam_database_authentication_enabled #=> Boolean
resp.db_clusters[0].clone_group_id #=> String
resp.db_clusters[0].cluster_create_time #=> Time
resp.db_clusters[0].copy_tags_to_snapshot #=> Boolean
resp.db_clusters[0].enabled_cloudwatch_logs_exports #=> Array
resp.db_clusters[0].enabled_cloudwatch_logs_exports[0] #=> String
resp.db_clusters[0].pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_enable #=> Array
resp.db_clusters[0].pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_enable[0] #=> String
resp.db_clusters[0].pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_disable #=> Array
resp.db_clusters[0].pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_disable[0] #=> String
resp.db_clusters[0].pending_modified_values.db_cluster_identifier #=> String
resp.db_clusters[0].pending_modified_values.iam_database_authentication_enabled #=> Boolean
resp.db_clusters[0].pending_modified_values.engine_version #=> String
resp.db_clusters[0].pending_modified_values.backup_retention_period #=> Integer
resp.db_clusters[0].pending_modified_values.storage_type #=> String
resp.db_clusters[0].pending_modified_values.allocated_storage #=> Integer
resp.db_clusters[0].pending_modified_values.iops #=> Integer
resp.db_clusters[0].pending_modified_values.network_type #=> String
resp.db_clusters[0].deletion_protection #=> Boolean
resp.db_clusters[0]. #=> Boolean
resp.db_clusters[0].automatic_restart_time #=> Time
resp.db_clusters[0].serverless_v2_scaling_configuration.min_capacity #=> Float
resp.db_clusters[0].serverless_v2_scaling_configuration.max_capacity #=> Float
resp.db_clusters[0].global_cluster_identifier #=> String
resp.db_clusters[0].io_optimized_next_allowed_modification_time #=> Time
resp.db_clusters[0].storage_type #=> String
resp.db_clusters[0].network_type #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :db_cluster_identifier
          (String)
          
            
          
          
            — 
    The user-supplied DB cluster identifier. If this parameter is
specified, information from only the specific DB cluster is returned.
This parameter isn't case-sensitive.
    

    Constraints:
    

      

    • If supplied, must match an existing DBClusterIdentifier.
      • 

    

    ^
    
          
        
    • 
      
        
  • 
          :filters
          (Array<Types::Filter>)
          
            
          
          
            — 
    A filter that specifies one or more DB clusters to describe.
    

    Supported filters:
    

      

    • 

      db-cluster-id - Accepts DB cluster identifiers and DB cluster
Amazon Resource Names (ARNs). The results list will only include
information about the DB clusters identified by these ARNs.
      

      • 

    • 

      engine - Accepts an engine name (such as neptune), and restricts
the results list to DB clusters created by that engine.
      

      • 

    

    For example, to invoke this API from the Amazon CLI and filter so that
only Neptune DB clusters are returned, you could use the following
command:
    
          
        
    • 
      
        
  • 
          :max_records
          (Integer)
          
            
          
          
            — 
    The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a pagination
token called a marker is included in the response so that the
remaining results can be retrieved.
    

    Default: 100
    

    Constraints: Minimum 20, maximum 100.
    
          
        
    • 
      
        
  • 
          :marker
          (String)
          
            
          
          
            — 
    An optional pagination token provided by a previous DescribeDBClusters
request. If this parameter is specified, the response includes only
records beyond the marker, up to the value specified by MaxRecords.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


617

    		
    
      
# File 'sig/client.rbs', line 617

def describe_db_clusters: (

    		
  





    
      

  

  
    #describe_db_engine_versions(params = {})  ⇒ Types::DBEngineVersionMessage 
  

  

  




  

    
Returns a list of the available DB engines.


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_db_engine_versions({
  engine: "String",
  engine_version: "String",
  db_parameter_group_family: "String",
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
  max_records: 1,
  marker: "String",
  default_only: false,
  list_supported_character_sets: false,
  list_supported_timezones: false,
})

    
      
        
Response structure

      
      

resp.marker #=> String
resp.db_engine_versions #=> Array
resp.db_engine_versions[0].engine #=> String
resp.db_engine_versions[0].engine_version #=> String
resp.db_engine_versions[0].db_parameter_group_family #=> String
resp.db_engine_versions[0].db_engine_description #=> String
resp.db_engine_versions[0].db_engine_version_description #=> String
resp.db_engine_versions[0].default_character_set.character_set_name #=> String
resp.db_engine_versions[0].default_character_set.character_set_description #=> String
resp.db_engine_versions[0].supported_character_sets #=> Array
resp.db_engine_versions[0].supported_character_sets[0].character_set_name #=> String
resp.db_engine_versions[0].supported_character_sets[0].character_set_description #=> String
resp.db_engine_versions[0].valid_upgrade_target #=> Array
resp.db_engine_versions[0].valid_upgrade_target[0].engine #=> String
resp.db_engine_versions[0].valid_upgrade_target[0].engine_version #=> String
resp.db_engine_versions[0].valid_upgrade_target[0].description #=> String
resp.db_engine_versions[0].valid_upgrade_target[0].auto_upgrade #=> Boolean
resp.db_engine_versions[0].valid_upgrade_target[0].is_major_version_upgrade #=> Boolean
resp.db_engine_versions[0].valid_upgrade_target[0].supports_global_databases #=> Boolean
resp.db_engine_versions[0].supported_timezones #=> Array
resp.db_engine_versions[0].supported_timezones[0].timezone_name #=> String
resp.db_engine_versions[0].exportable_log_types #=> Array
resp.db_engine_versions[0].exportable_log_types[0] #=> String
resp.db_engine_versions[0].supports_log_exports_to_cloudwatch_logs #=> Boolean
resp.db_engine_versions[0].supports_read_replica #=> Boolean
resp.db_engine_versions[0].supports_global_databases #=> Boolean

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :engine
          (String)
          
            
          
          
            — 
    The database engine to return.
    
          
        
    • 
      
        
  • 
          :engine_version
          (String)
          
            
          
          
            — 
    The database engine version to return.
    

    Example: 5.1.49
    
          
        
    • 
      
        
  • 
          :db_parameter_group_family
          (String)
          
            
          
          
            — 
    The name of a specific DB parameter group family to return details
for.
    

    Constraints:
    

      

    • If supplied, must match an existing DBParameterGroupFamily.
      • 

    

    ^
    
          
        
    • 
      
        
  • 
          :filters
          (Array<Types::Filter>)
          
            
          
          
            — 
    Not currently supported.
    
          
        
    • 
      
        
  • 
          :max_records
          (Integer)
          
            
          
          
            — 
    The maximum number of records to include in the response. If more than
the MaxRecords value is available, a pagination token called a
marker is included in the response so that the following results can
be retrieved.
    

    Default: 100
    

    Constraints: Minimum 20, maximum 100.
    
          
        
    • 
      
        
  • 
          :marker
          (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 MaxRecords.
    
          
        
    • 
      
        
  • 
          :default_only
          (Boolean)
          
            
          
          
            — 
    Indicates that only the default version of the specified engine or
engine and major version combination is returned.
    
          
        
    • 
      
        
  • 
          :list_supported_character_sets
          (Boolean)
          
            
          
          
            — 
    If this parameter is specified and the requested engine supports the
CharacterSetName parameter for CreateDBInstance, the response
includes a list of supported character sets for each engine version.
    
          
        
    • 
      
        
  • 
          :list_supported_timezones
          (Boolean)
          
            
          
          
            — 
    If this parameter is specified and the requested engine supports the
TimeZone parameter for CreateDBInstance, the response includes a
list of supported time zones for each engine version.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


636

    		
    
      
# File 'sig/client.rbs', line 636

def describe_db_engine_versions: (

    		
  





    
      

  

  
    #describe_db_instances(params = {})  ⇒ Types::DBInstanceMessage 
  

  

  




  

    
Returns information about provisioned instances, and supports
pagination.


 This operation can also return information for Amazon RDS instances
and Amazon DocDB instances.

 

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


The following waiters are defined for this operation (see #wait_until for detailed usage):


* db_instance_available
* db_instance_deleted


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_db_instances({
  db_instance_identifier: "String",
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
  max_records: 1,
  marker: "String",
})

    
      
        
Response structure

      
      

resp.marker #=> String
resp.db_instances #=> Array
resp.db_instances[0].db_instance_identifier #=> String
resp.db_instances[0].db_instance_class #=> String
resp.db_instances[0].engine #=> String
resp.db_instances[0].db_instance_status #=> String
resp.db_instances[0].master_username #=> String
resp.db_instances[0].db_name #=> String
resp.db_instances[0].endpoint.address #=> String
resp.db_instances[0].endpoint.port #=> Integer
resp.db_instances[0].endpoint.hosted_zone_id #=> String
resp.db_instances[0].allocated_storage #=> Integer
resp.db_instances[0].instance_create_time #=> Time
resp.db_instances[0].preferred_backup_window #=> String
resp.db_instances[0].backup_retention_period #=> Integer
resp.db_instances[0].db_security_groups #=> Array
resp.db_instances[0].db_security_groups[0].db_security_group_name #=> String
resp.db_instances[0].db_security_groups[0].status #=> String
resp.db_instances[0].vpc_security_groups #=> Array
resp.db_instances[0].vpc_security_groups[0].vpc_security_group_id #=> String
resp.db_instances[0].vpc_security_groups[0].status #=> String
resp.db_instances[0].db_parameter_groups #=> Array
resp.db_instances[0].db_parameter_groups[0].db_parameter_group_name #=> String
resp.db_instances[0].db_parameter_groups[0].parameter_apply_status #=> String
resp.db_instances[0].availability_zone #=> String
resp.db_instances[0].db_subnet_group.db_subnet_group_name #=> String
resp.db_instances[0].db_subnet_group.db_subnet_group_description #=> String
resp.db_instances[0].db_subnet_group.vpc_id #=> String
resp.db_instances[0].db_subnet_group.subnet_group_status #=> String
resp.db_instances[0].db_subnet_group.subnets #=> Array
resp.db_instances[0].db_subnet_group.subnets[0].subnet_identifier #=> String
resp.db_instances[0].db_subnet_group.subnets[0].subnet_availability_zone.name #=> String
resp.db_instances[0].db_subnet_group.subnets[0].subnet_status #=> String
resp.db_instances[0].db_subnet_group.db_subnet_group_arn #=> String
resp.db_instances[0].db_subnet_group.supported_network_types #=> Array
resp.db_instances[0].db_subnet_group.supported_network_types[0] #=> String
resp.db_instances[0].preferred_maintenance_window #=> String
resp.db_instances[0].pending_modified_values.db_instance_class #=> String
resp.db_instances[0].pending_modified_values.allocated_storage #=> Integer
resp.db_instances[0].pending_modified_values.master_user_password #=> String
resp.db_instances[0].pending_modified_values.port #=> Integer
resp.db_instances[0].pending_modified_values.backup_retention_period #=> Integer
resp.db_instances[0].pending_modified_values.multi_az #=> Boolean
resp.db_instances[0].pending_modified_values.engine_version #=> String
resp.db_instances[0].pending_modified_values.license_model #=> String
resp.db_instances[0].pending_modified_values.iops #=> Integer
resp.db_instances[0].pending_modified_values.db_instance_identifier #=> String
resp.db_instances[0].pending_modified_values.storage_type #=> String
resp.db_instances[0].pending_modified_values.ca_certificate_identifier #=> String
resp.db_instances[0].pending_modified_values.db_subnet_group_name #=> String
resp.db_instances[0].pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_enable #=> Array
resp.db_instances[0].pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_enable[0] #=> String
resp.db_instances[0].pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_disable #=> Array
resp.db_instances[0].pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_disable[0] #=> String
resp.db_instances[0].latest_restorable_time #=> Time
resp.db_instances[0].multi_az #=> Boolean
resp.db_instances[0].engine_version #=> String
resp.db_instances[0].auto_minor_version_upgrade #=> Boolean
resp.db_instances[0].read_replica_source_db_instance_identifier #=> String
resp.db_instances[0].read_replica_db_instance_identifiers #=> Array
resp.db_instances[0].read_replica_db_instance_identifiers[0] #=> String
resp.db_instances[0].read_replica_db_cluster_identifiers #=> Array
resp.db_instances[0].read_replica_db_cluster_identifiers[0] #=> String
resp.db_instances[0].license_model #=> String
resp.db_instances[0].iops #=> Integer
resp.db_instances[0].option_group_memberships #=> Array
resp.db_instances[0].option_group_memberships[0].option_group_name #=> String
resp.db_instances[0].option_group_memberships[0].status #=> String
resp.db_instances[0].character_set_name #=> String
resp.db_instances[0].secondary_availability_zone #=> String
resp.db_instances[0].publicly_accessible #=> Boolean
resp.db_instances[0].status_infos #=> Array
resp.db_instances[0].status_infos[0].status_type #=> String
resp.db_instances[0].status_infos[0].normal #=> Boolean
resp.db_instances[0].status_infos[0].status #=> String
resp.db_instances[0].status_infos[0].message #=> String
resp.db_instances[0].storage_type #=> String
resp.db_instances[0].tde_credential_arn #=> String
resp.db_instances[0].db_instance_port #=> Integer
resp.db_instances[0].db_cluster_identifier #=> String
resp.db_instances[0].storage_encrypted #=> Boolean
resp.db_instances[0].kms_key_id #=> String
resp.db_instances[0].dbi_resource_id #=> String
resp.db_instances[0].ca_certificate_identifier #=> String
resp.db_instances[0].domain_memberships #=> Array
resp.db_instances[0].domain_memberships[0].domain #=> String
resp.db_instances[0].domain_memberships[0].status #=> String
resp.db_instances[0].domain_memberships[0].fqdn #=> String
resp.db_instances[0].domain_memberships[0].iam_role_name #=> String
resp.db_instances[0].copy_tags_to_snapshot #=> Boolean
resp.db_instances[0].monitoring_interval #=> Integer
resp.db_instances[0].enhanced_monitoring_resource_arn #=> String
resp.db_instances[0].monitoring_role_arn #=> String
resp.db_instances[0].promotion_tier #=> Integer
resp.db_instances[0].db_instance_arn #=> String
resp.db_instances[0].timezone #=> String
resp.db_instances[0].iam_database_authentication_enabled #=> Boolean
resp.db_instances[0].performance_insights_enabled #=> Boolean
resp.db_instances[0].performance_insights_kms_key_id #=> String
resp.db_instances[0].enabled_cloudwatch_logs_exports #=> Array
resp.db_instances[0].enabled_cloudwatch_logs_exports[0] #=> String
resp.db_instances[0].deletion_protection #=> Boolean
resp.db_instances[0].network_type #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :db_instance_identifier
          (String)
          
            
          
          
            — 
    The user-supplied instance identifier. If this parameter is specified,
information from only the specific DB instance is returned. This
parameter isn't case-sensitive.
    

    Constraints:
    

      

    • If supplied, must match the identifier of an existing DBInstance.
      • 

    

    ^
    
          
        
    • 
      
        
  • 
          :filters
          (Array<Types::Filter>)
          
            
          
          
            — 
    A filter that specifies one or more DB instances to describe.
    

    Supported filters:
    

      

    • 

      db-cluster-id - Accepts DB cluster identifiers and DB cluster
Amazon Resource Names (ARNs). The results list will only include
information about the DB instances associated with the DB clusters
identified by these ARNs.
      

      • 

    • 

      engine - Accepts an engine name (such as neptune), and restricts
the results list to DB instances created by that engine.
      

      • 

    

    For example, to invoke this API from the Amazon CLI and filter so that
only Neptune DB instances are returned, you could use the following
command:
    
          
        
    • 
      
        
  • 
          :max_records
          (Integer)
          
            
          
          
            — 
    The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a pagination
token called a marker is included in the response so that the
remaining results can be retrieved.
    

    Default: 100
    

    Constraints: Minimum 20, maximum 100.
    
          
        
    • 
      
        
  • 
          :marker
          (String)
          
            
          
          
            — 
    An optional pagination token provided by a previous
DescribeDBInstances request. If this parameter is specified, the
response includes only records beyond the marker, up to the value
specified by MaxRecords.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


660

    		
    
      
# File 'sig/client.rbs', line 660

def describe_db_instances: (

    		
  





    
      

  

  
    #describe_db_parameter_groups(params = {})  ⇒ Types::DBParameterGroupsMessage 
  

  

  




  

    
Returns a list of DBParameterGroup descriptions. If a
DBParameterGroupName is specified, the list will contain only the
description of the specified DB 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_db_parameter_groups({
  db_parameter_group_name: "String",
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
  max_records: 1,
  marker: "String",
})

    
      
        
Response structure

      
      

resp.marker #=> String
resp.db_parameter_groups #=> Array
resp.db_parameter_groups[0].db_parameter_group_name #=> String
resp.db_parameter_groups[0].db_parameter_group_family #=> String
resp.db_parameter_groups[0].description #=> String
resp.db_parameter_groups[0].db_parameter_group_arn #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :db_parameter_group_name
          (String)
          
            
          
          
            — 
    The name of a specific DB parameter group to return details for.
    

    Constraints:
    

      

    • If supplied, must match the name of an existing
DBClusterParameterGroup.
      • 

    

    ^
    
          
        
    • 
      
        
  • 
          :filters
          (Array<Types::Filter>)
          
            
          
          
            — 
    This parameter is not currently supported.
    
          
        
    • 
      
        
  • 
          :max_records
          (Integer)
          
            
          
          
            — 
    The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a pagination
token called a marker is included in the response so that the
remaining results can be retrieved.
    

    Default: 100
    

    Constraints: Minimum 20, maximum 100.
    
          
        
    • 
      
        
  • 
          :marker
          (String)
          
            
          
          
            — 
    An optional pagination token provided by a previous
DescribeDBParameterGroups request. If this parameter is specified,
the response includes only records beyond the marker, up to the value
specified by MaxRecords.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


679

    		
    
      
# File 'sig/client.rbs', line 679

def describe_db_parameter_groups: (

    		
  





    
      

  

  
    #describe_db_parameters(params = {})  ⇒ Types::DBParameterGroupDetails 
  

  

  




  

    
Returns the detailed parameter list for a particular DB 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_db_parameters({
  db_parameter_group_name: "String", # required
  source: "String",
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
  max_records: 1,
  marker: "String",
})

    
      
        
Response structure

      
      

resp.parameters #=> Array
resp.parameters[0].parameter_name #=> String
resp.parameters[0].parameter_value #=> String
resp.parameters[0].description #=> String
resp.parameters[0].source #=> String
resp.parameters[0].apply_type #=> String
resp.parameters[0].data_type #=> String
resp.parameters[0].allowed_values #=> String
resp.parameters[0].is_modifiable #=> Boolean
resp.parameters[0].minimum_engine_version #=> String
resp.parameters[0].apply_method #=> String, one of "immediate", "pending-reboot"
resp.marker #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :db_parameter_group_name
          (required, String)
          
            
          
          
            — 
    The name of a specific DB parameter group to return details for.
    

    Constraints:
    

      

    • If supplied, must match the name of an existing DBParameterGroup.
      • 

    

    ^
    
          
        
    • 
      
        
  • 
          :source
          (String)
          
            
          
          
            — 
    The parameter types to return.
    

    Default: All parameter types returned
    

    Valid Values: user | system | engine-default
    
          
        
    • 
      
        
  • 
          :filters
          (Array<Types::Filter>)
          
            
          
          
            — 
    This parameter is not currently supported.
    
          
        
    • 
      
        
  • 
          :max_records
          (Integer)
          
            
          
          
            — 
    The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a pagination
token called a marker is included in the response so that the
remaining results can be retrieved.
    

    Default: 100
    

    Constraints: Minimum 20, maximum 100.
    
          
        
    • 
      
        
  • 
          :marker
          (String)
          
            
          
          
            — 
    An optional pagination token provided by a previous
DescribeDBParameters request. If this parameter is specified, the
response includes only records beyond the marker, up to the value
specified by MaxRecords.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


698

    		
    
      
# File 'sig/client.rbs', line 698

def describe_db_parameters: (

    		
  





    
      

  

  
    #describe_db_subnet_groups(params = {})  ⇒ Types::DBSubnetGroupMessage 
  

  

  




  

    
Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName
is specified, the list will contain only the descriptions of the
specified DBSubnetGroup.


For an overview of CIDR ranges, go to the Wikipedia Tutorial.


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_db_subnet_groups({
  db_subnet_group_name: "String",
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
  max_records: 1,
  marker: "String",
})

    
      
        
Response structure

      
      

resp.marker #=> String
resp.db_subnet_groups #=> Array
resp.db_subnet_groups[0].db_subnet_group_name #=> String
resp.db_subnet_groups[0].db_subnet_group_description #=> String
resp.db_subnet_groups[0].vpc_id #=> String
resp.db_subnet_groups[0].subnet_group_status #=> String
resp.db_subnet_groups[0].subnets #=> Array
resp.db_subnet_groups[0].subnets[0].subnet_identifier #=> String
resp.db_subnet_groups[0].subnets[0].subnet_availability_zone.name #=> String
resp.db_subnet_groups[0].subnets[0].subnet_status #=> String
resp.db_subnet_groups[0].db_subnet_group_arn #=> String
resp.db_subnet_groups[0].supported_network_types #=> Array
resp.db_subnet_groups[0].supported_network_types[0] #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :db_subnet_group_name
          (String)
          
            
          
          
            — 
    The name of the DB subnet group to return details for.
    
          
        
    • 
      
        
  • 
          :filters
          (Array<Types::Filter>)
          
            
          
          
            — 
    This parameter is not currently supported.
    
          
        
    • 
      
        
  • 
          :max_records
          (Integer)
          
            
          
          
            — 
    The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a pagination
token called a marker is included in the response so that the
remaining results can be retrieved.
    

    Default: 100
    

    Constraints: Minimum 20, maximum 100.
    
          
        
    • 
      
        
  • 
          :marker
          (String)
          
            
          
          
            — 
    An optional pagination token provided by a previous
DescribeDBSubnetGroups request. If this parameter is specified, the
response includes only records beyond the marker, up to the value
specified by MaxRecords.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


718

    		
    
      
# File 'sig/client.rbs', line 718

def describe_db_subnet_groups: (

    		
  





    
      

  

  
    #describe_engine_default_cluster_parameters(params = {})  ⇒ Types::DescribeEngineDefaultClusterParametersResult 
  

  

  




  

    
Returns the default engine and system parameter information for the
cluster database engine.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_engine_default_cluster_parameters({
  db_parameter_group_family: "String", # required
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
  max_records: 1,
  marker: "String",
})

    
      
        
Response structure

      
      

resp.engine_defaults.db_parameter_group_family #=> String
resp.engine_defaults.marker #=> String
resp.engine_defaults.parameters #=> Array
resp.engine_defaults.parameters[0].parameter_name #=> String
resp.engine_defaults.parameters[0].parameter_value #=> String
resp.engine_defaults.parameters[0].description #=> String
resp.engine_defaults.parameters[0].source #=> String
resp.engine_defaults.parameters[0].apply_type #=> String
resp.engine_defaults.parameters[0].data_type #=> String
resp.engine_defaults.parameters[0].allowed_values #=> String
resp.engine_defaults.parameters[0].is_modifiable #=> Boolean
resp.engine_defaults.parameters[0].minimum_engine_version #=> String
resp.engine_defaults.parameters[0].apply_method #=> String, one of "immediate", "pending-reboot"

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :db_parameter_group_family
          (required, String)
          
            
          
          
            — 
    The name of the DB cluster parameter group family to return engine
parameter information for.
    
          
        
    • 
      
        
  • 
          :filters
          (Array<Types::Filter>)
          
            
          
          
            — 
    This parameter is not currently supported.
    
          
        
    • 
      
        
  • 
          :max_records
          (Integer)
          
            
          
          
            — 
    The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a pagination
token called a marker is included in the response so that the
remaining results can be retrieved.
    

    Default: 100
    

    Constraints: Minimum 20, maximum 100.
    
          
        
    • 
      
        
  • 
          :marker
          (String)
          
            
          
          
            — 
    An optional pagination token provided by a previous
DescribeEngineDefaultClusterParameters request. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


736

    		
    
      
# File 'sig/client.rbs', line 736

def describe_engine_default_cluster_parameters: (

    		
  





    
      

  

  
    #describe_engine_default_parameters(params = {})  ⇒ Types::DescribeEngineDefaultParametersResult 
  

  

  




  

    
Returns the default engine and system parameter information for the
specified database engine.


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_default_parameters({
  db_parameter_group_family: "String", # required
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
  max_records: 1,
  marker: "String",
})

    
      
        
Response structure

      
      

resp.engine_defaults.db_parameter_group_family #=> String
resp.engine_defaults.marker #=> String
resp.engine_defaults.parameters #=> Array
resp.engine_defaults.parameters[0].parameter_name #=> String
resp.engine_defaults.parameters[0].parameter_value #=> String
resp.engine_defaults.parameters[0].description #=> String
resp.engine_defaults.parameters[0].source #=> String
resp.engine_defaults.parameters[0].apply_type #=> String
resp.engine_defaults.parameters[0].data_type #=> String
resp.engine_defaults.parameters[0].allowed_values #=> String
resp.engine_defaults.parameters[0].is_modifiable #=> Boolean
resp.engine_defaults.parameters[0].minimum_engine_version #=> String
resp.engine_defaults.parameters[0].apply_method #=> String, one of "immediate", "pending-reboot"

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :db_parameter_group_family
          (required, String)
          
            
          
          
            — 
    The name of the DB parameter group family.
    
          
        
    • 
      
        
  • 
          :filters
          (Array<Types::Filter>)
          
            
          
          
            — 
    Not currently supported.
    
          
        
    • 
      
        
  • 
          :max_records
          (Integer)
          
            
          
          
            — 
    The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a pagination
token called a marker is included in the response so that the
remaining results can be retrieved.
    

    Default: 100
    

    Constraints: Minimum 20, maximum 100.
    
          
        
    • 
      
        
  • 
          :marker
          (String)
          
            
          
          
            — 
    An optional pagination token provided by a previous
DescribeEngineDefaultParameters request. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


754

    		
    
      
# File 'sig/client.rbs', line 754

def describe_engine_default_parameters: (

    		
  





    
      

  

  
    #describe_event_categories(params = {})  ⇒ Types::EventCategoriesMessage 
  

  

  




  

    
Displays a list of categories for all event source types, or, if
specified, for a specified source type.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_event_categories({
  source_type: "String",
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
})

    
      
        
Response structure

      
      

resp.event_categories_map_list #=> Array
resp.event_categories_map_list[0].source_type #=> String
resp.event_categories_map_list[0].event_categories #=> Array
resp.event_categories_map_list[0].event_categories[0] #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :source_type
          (String)
          
            
          
          
            — 
    The type of source that is generating the events.
    

    Valid values: db-instance | db-parameter-group | db-security-group
| db-snapshot
    
          
        
    • 
      
        
  • 
          :filters
          (Array<Types::Filter>)
          
            
          
          
            — 
    This parameter is not currently supported.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


772

    		
    
      
# File 'sig/client.rbs', line 772

def describe_event_categories: (

    		
  





    
      

  

  
    #describe_event_subscriptions(params = {})  ⇒ Types::EventSubscriptionsMessage 
  

  

  




  

    
Lists all the subscription descriptions for a customer account. The
description for a subscription includes SubscriptionName, SNSTopicARN,
CustomerID, SourceType, SourceID, CreationTime, and Status.


If you specify a SubscriptionName, lists the description for that
subscription.


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_event_subscriptions({
  subscription_name: "String",
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
  max_records: 1,
  marker: "String",
})

    
      
        
Response structure

      
      

resp.marker #=> String
resp.event_subscriptions_list #=> Array
resp.event_subscriptions_list[0].customer_aws_id #=> String
resp.event_subscriptions_list[0].cust_subscription_id #=> String
resp.event_subscriptions_list[0].sns_topic_arn #=> String
resp.event_subscriptions_list[0].status #=> String
resp.event_subscriptions_list[0].subscription_creation_time #=> String
resp.event_subscriptions_list[0].source_type #=> String
resp.event_subscriptions_list[0].source_ids_list #=> Array
resp.event_subscriptions_list[0].source_ids_list[0] #=> String
resp.event_subscriptions_list[0].event_categories_list #=> Array
resp.event_subscriptions_list[0].event_categories_list[0] #=> String
resp.event_subscriptions_list[0].enabled #=> Boolean
resp.event_subscriptions_list[0].event_subscription_arn #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :subscription_name
          (String)
          
            
          
          
            — 
    The name of the event notification subscription you want to describe.
    
          
        
    • 
      
        
  • 
          :filters
          (Array<Types::Filter>)
          
            
          
          
            — 
    This parameter is not currently supported.
    
          
        
    • 
      
        
  • 
          :max_records
          (Integer)
          
            
          
          
            — 
    The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a pagination
token called a marker is included in the response so that the
remaining results can be retrieved.
    

    Default: 100
    

    Constraints: Minimum 20, maximum 100.
    
          
        
    • 
      
        
  • 
          :marker
          (String)
          
            
          
          
            — 
    An optional pagination token provided by a previous
DescribeOrderableDBInstanceOptions request. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords .
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


789

    		
    
      
# File 'sig/client.rbs', line 789

def describe_event_subscriptions: (

    		
  





    
      

  

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

  

  




  

    
Returns events related to DB instances, DB security groups, DB
snapshots, and DB parameter groups for the past 14 days. Events
specific to a particular DB instance, DB security group, database
snapshot, or DB parameter group can be obtained by providing the name
as a parameter. By default, the past hour of events are returned.


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_identifier: "String",
  source_type: "db-instance", # accepts db-instance, db-parameter-group, db-security-group, db-snapshot, db-cluster, db-cluster-snapshot
  start_time: Time.now,
  end_time: Time.now,
  duration: 1,
  event_categories: ["String"],
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
  max_records: 1,
  marker: "String",
})

    
      
        
Response structure

      
      

resp.marker #=> String
resp.events #=> Array
resp.events[0].source_identifier #=> String
resp.events[0].source_type #=> String, one of "db-instance", "db-parameter-group", "db-security-group", "db-snapshot", "db-cluster", "db-cluster-snapshot"
resp.events[0].message #=> String
resp.events[0].event_categories #=> Array
resp.events[0].event_categories[0] #=> String
resp.events[0].date #=> Time
resp.events[0].source_arn #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :source_identifier
          (String)
          
            
          
          
            — 
    The identifier of the event source for which events are returned. If
not specified, then all sources are included in the response.
    

    Constraints:
    

      

    • 

      If SourceIdentifier is supplied, SourceType must also be provided.
      

      • 

    • 

      If the source type is DBInstance, then a DBInstanceIdentifier
must be supplied.
      

      • 

    • 

      If the source type is DBSecurityGroup, a DBSecurityGroupName
must be supplied.
      

      • 

    • 

      If the source type is DBParameterGroup, a DBParameterGroupName
must be supplied.
      

      • 

    • 

      If the source type is DBSnapshot, a DBSnapshotIdentifier must be
supplied.
      

      • 

    • 

      Cannot end with a hyphen or contain two consecutive hyphens.
      

      • 

    
          
        
    • 
      
        
  • 
          :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. For more information about ISO 8601, go to the
ISO8601 Wikipedia page.
    

    Example: 2009-07-08T18:00Z
    
          
        
    • 
      
        
  • 
          :end_time
          (Time, DateTime, Date, Integer, String)
          
            
          
          
            — 
    The end of the time interval for which to retrieve events, specified
in ISO 8601 format. For more information about ISO 8601, go to the
ISO8601 Wikipedia page.
    

    Example: 2009-07-08T18:00Z
    
          
        
    • 
      
        
  • 
          :duration
          (Integer)
          
            
          
          
            — 
    The number of minutes to retrieve events for.
    

    Default: 60
    
          
        
    • 
      
        
  • 
          :event_categories
          (Array<String>)
          
            
          
          
            — 
    A list of event categories that trigger notifications for a event
notification subscription.
    
          
        
    • 
      
        
  • 
          :filters
          (Array<Types::Filter>)
          
            
          
          
            — 
    This parameter is not currently supported.
    
          
        
    • 
      
        
  • 
          :max_records
          (Integer)
          
            
          
          
            — 
    The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a pagination
token called a marker is included in the response so that the
remaining results can be retrieved.
    

    Default: 100
    

    Constraints: Minimum 20, maximum 100.
    
          
        
    • 
      
        
  • 
          :marker
          (String)
          
            
          
          
            — 
    An optional pagination token provided by a previous DescribeEvents
request. If this parameter is specified, the response includes only
records beyond the marker, up to the value specified by MaxRecords.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


808

    		
    
      
# File 'sig/client.rbs', line 808

def describe_events: (

    		
  





    
      

  

  
    #describe_global_clusters(params = {})  ⇒ Types::GlobalClustersMessage 
  

  

  




  

    
Returns information about Neptune global database clusters. This API
supports pagination.


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_global_clusters({
  global_cluster_identifier: "GlobalClusterIdentifier",
  max_records: 1,
  marker: "String",
})

    
      
        
Response structure

      
      

resp.marker #=> String
resp.global_clusters #=> Array
resp.global_clusters[0].global_cluster_identifier #=> String
resp.global_clusters[0].global_cluster_resource_id #=> String
resp.global_clusters[0].global_cluster_arn #=> String
resp.global_clusters[0].status #=> String
resp.global_clusters[0].engine #=> String
resp.global_clusters[0].engine_version #=> String
resp.global_clusters[0].database_name #=> String
resp.global_clusters[0].storage_encrypted #=> Boolean
resp.global_clusters[0].deletion_protection #=> Boolean
resp.global_clusters[0].global_cluster_members #=> Array
resp.global_clusters[0].global_cluster_members[0].db_cluster_arn #=> String
resp.global_clusters[0].global_cluster_members[0].readers #=> Array
resp.global_clusters[0].global_cluster_members[0].readers[0] #=> String
resp.global_clusters[0].global_cluster_members[0].is_writer #=> Boolean
resp.global_clusters[0].failover_state.status #=> String, one of "pending", "failing-over", "cancelling"
resp.global_clusters[0].failover_state.from_db_cluster_arn #=> String
resp.global_clusters[0].failover_state.to_db_cluster_arn #=> String
resp.global_clusters[0].failover_state.is_data_loss_allowed #=> Boolean
resp.global_clusters[0].tag_list #=> Array
resp.global_clusters[0].tag_list[0].key #=> String
resp.global_clusters[0].tag_list[0].value #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :global_cluster_identifier
          (String)
          
            
          
          
            — 
    The user-supplied DB cluster identifier. If this parameter is
specified, only information about the specified DB cluster is
returned. This parameter is not case-sensitive.
    

    Constraints: If supplied, must match an existing DB cluster
identifier.
    
          
        
    • 
      
        
  • 
          :max_records
          (Integer)
          
            
          
          
            — 
    The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a pagination
marker token is included in the response that you can use to retrieve
the remaining results.
    

    Default: 100
    

    Constraints: Minimum 20, maximum 100.
    
          
        
    • 
      
        
  • 
          :marker
          (String)
          
            
              — default:
              *Optional*
            
          
          
            — 
    A pagination token returned by a previous call to
DescribeGlobalClusters. If this parameter is specified, the response
will only include records beyond the marker, up to the number
specified by MaxRecords.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


832

    		
    
      
# File 'sig/client.rbs', line 832

def describe_global_clusters: (

    		
  





    
      

  

  
    #describe_orderable_db_instance_options(params = {})  ⇒ Types::OrderableDBInstanceOptionsMessage 
  

  

  




  

    
Returns a list of orderable DB instance options for the specified
engine.


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_orderable_db_instance_options({
  engine: "String", # required
  engine_version: "String",
  db_instance_class: "String",
  license_model: "String",
  vpc: false,
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
  max_records: 1,
  marker: "String",
})

    
      
        
Response structure

      
      

resp.orderable_db_instance_options #=> Array
resp.orderable_db_instance_options[0].engine #=> String
resp.orderable_db_instance_options[0].engine_version #=> String
resp.orderable_db_instance_options[0].db_instance_class #=> String
resp.orderable_db_instance_options[0].license_model #=> String
resp.orderable_db_instance_options[0].availability_zones #=> Array
resp.orderable_db_instance_options[0].availability_zones[0].name #=> String
resp.orderable_db_instance_options[0].multi_az_capable #=> Boolean
resp.orderable_db_instance_options[0].read_replica_capable #=> Boolean
resp.orderable_db_instance_options[0].vpc #=> Boolean
resp.orderable_db_instance_options[0].supports_storage_encryption #=> Boolean
resp.orderable_db_instance_options[0].storage_type #=> String
resp.orderable_db_instance_options[0].supports_iops #=> Boolean
resp.orderable_db_instance_options[0].supports_enhanced_monitoring #=> Boolean
resp.orderable_db_instance_options[0].supports_iam_database_authentication #=> Boolean
resp.orderable_db_instance_options[0].supports_performance_insights #=> Boolean
resp.orderable_db_instance_options[0].min_storage_size #=> Integer
resp.orderable_db_instance_options[0].max_storage_size #=> Integer
resp.orderable_db_instance_options[0].min_iops_per_db_instance #=> Integer
resp.orderable_db_instance_options[0].max_iops_per_db_instance #=> Integer
resp.orderable_db_instance_options[0].min_iops_per_gib #=> Float
resp.orderable_db_instance_options[0].max_iops_per_gib #=> Float
resp.orderable_db_instance_options[0].supports_global_databases #=> Boolean
resp.orderable_db_instance_options[0].supported_network_types #=> Array
resp.orderable_db_instance_options[0].supported_network_types[0] #=> String
resp.marker #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :engine
          (required, String)
          
            
          
          
            — 
    The name of the engine to retrieve DB instance options for.
    
          
        
    • 
      
        
  • 
          :engine_version
          (String)
          
            
          
          
            — 
    The engine version filter value. Specify this parameter to show only
the available offerings matching the specified engine version.
    
          
        
    • 
      
        
  • 
          :db_instance_class
          (String)
          
            
          
          
            — 
    The DB instance class filter value. Specify this parameter to show
only the available offerings matching the specified DB instance class.
    
          
        
    • 
      
        
  • 
          :license_model
          (String)
          
            
          
          
            — 
    The license model filter value. Specify this parameter to show only
the available offerings matching the specified license model.
    
          
        
    • 
      
        
  • 
          :vpc
          (Boolean)
          
            
          
          
            — 
    The VPC filter value. Specify this parameter to show only the
available VPC or non-VPC offerings.
    
          
        
    • 
      
        
  • 
          :filters
          (Array<Types::Filter>)
          
            
          
          
            — 
    This parameter is not currently supported.
    
          
        
    • 
      
        
  • 
          :max_records
          (Integer)
          
            
          
          
            — 
    The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a pagination
token called a marker is included in the response so that the
remaining results can be retrieved.
    

    Default: 100
    

    Constraints: Minimum 20, maximum 100.
    
          
        
    • 
      
        
  • 
          :marker
          (String)
          
            
          
          
            — 
    An optional pagination token provided by a previous
DescribeOrderableDBInstanceOptions request. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords .
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


845

    		
    
      
# File 'sig/client.rbs', line 845

def describe_orderable_db_instance_options: (

    		
  





    
      

  

  
    #describe_pending_maintenance_actions(params = {})  ⇒ Types::PendingMaintenanceActionsMessage 
  

  

  




  

    
Returns a list of resources (for example, DB instances) that have at
least one pending maintenance action.


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_pending_maintenance_actions({
  resource_identifier: "String",
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
  marker: "String",
  max_records: 1,
})

    
      
        
Response structure

      
      

resp.pending_maintenance_actions #=> Array
resp.pending_maintenance_actions[0].resource_identifier #=> String
resp.pending_maintenance_actions[0].pending_maintenance_action_details #=> Array
resp.pending_maintenance_actions[0].pending_maintenance_action_details[0].action #=> String
resp.pending_maintenance_actions[0].pending_maintenance_action_details[0].auto_applied_after_date #=> Time
resp.pending_maintenance_actions[0].pending_maintenance_action_details[0].forced_apply_date #=> Time
resp.pending_maintenance_actions[0].pending_maintenance_action_details[0].opt_in_status #=> String
resp.pending_maintenance_actions[0].pending_maintenance_action_details[0].current_apply_date #=> Time
resp.pending_maintenance_actions[0].pending_maintenance_action_details[0].description #=> String
resp.marker #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :resource_identifier
          (String)
          
            
          
          
            — 
    The ARN of a resource to return pending maintenance actions for.
    
          
        
    • 
      
        
  • 
          :filters
          (Array<Types::Filter>)
          
            
          
          
            — 
    A filter that specifies one or more resources to return pending
maintenance actions for.
    

    Supported filters:
    

      

    • 

      db-cluster-id - Accepts DB cluster identifiers and DB cluster
Amazon Resource Names (ARNs). The results list will only include
pending maintenance actions for the DB clusters identified by these
ARNs.
      

      • 

    • 

      db-instance-id - Accepts DB instance identifiers and DB instance
ARNs. The results list will only include pending maintenance actions
for the DB instances identified by these ARNs.
      

      • 

    
          
        
    • 
      
        
  • 
          :marker
          (String)
          
            
          
          
            — 
    An optional pagination token provided by a previous
DescribePendingMaintenanceActions request. If this parameter is
specified, the response includes only records beyond the marker, up to
a number of records specified by MaxRecords.
    
          
        
    • 
      
        
  • 
          :max_records
          (Integer)
          
            
          
          
            — 
    The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a pagination
token called a marker is included in the response so that the
remaining results can be retrieved.
    

    Default: 100
    

    Constraints: Minimum 20, maximum 100.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


868

    		
    
      
# File 'sig/client.rbs', line 868

def describe_pending_maintenance_actions: (

    		
  





    
      

  

  
    #describe_valid_db_instance_modifications(params = {})  ⇒ Types::DescribeValidDBInstanceModificationsResult 
  

  

  




  

    
You can call DescribeValidDBInstanceModifications to learn what
modifications you can make to your DB instance. You can use this
information when you call ModifyDBInstance.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.describe_valid_db_instance_modifications({
  db_instance_identifier: "String", # required
})

    
      
        
Response structure

      
      

resp.valid_db_instance_modifications_message.storage #=> Array
resp.valid_db_instance_modifications_message.storage[0].storage_type #=> String
resp.valid_db_instance_modifications_message.storage[0].storage_size #=> Array
resp.valid_db_instance_modifications_message.storage[0].storage_size[0].from #=> Integer
resp.valid_db_instance_modifications_message.storage[0].storage_size[0].to #=> Integer
resp.valid_db_instance_modifications_message.storage[0].storage_size[0].step #=> Integer
resp.valid_db_instance_modifications_message.storage[0].provisioned_iops #=> Array
resp.valid_db_instance_modifications_message.storage[0].provisioned_iops[0].from #=> Integer
resp.valid_db_instance_modifications_message.storage[0].provisioned_iops[0].to #=> Integer
resp.valid_db_instance_modifications_message.storage[0].provisioned_iops[0].step #=> Integer
resp.valid_db_instance_modifications_message.storage[0].iops_to_storage_ratio #=> Array
resp.valid_db_instance_modifications_message.storage[0].iops_to_storage_ratio[0].from #=> Float
resp.valid_db_instance_modifications_message.storage[0].iops_to_storage_ratio[0].to #=> Float

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :db_instance_identifier
          (required, String)
          
            
          
          
            — 
    The customer identifier or the ARN of your DB instance.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


886

    		
    
      
# File 'sig/client.rbs', line 886

def describe_valid_db_instance_modifications: (

    		
  





    
      

  

  
    #failover_db_cluster(params = {})  ⇒ Types::FailoverDBClusterResult 
  

  

  




  

    
Forces a failover for a DB cluster.


A failover for a DB cluster promotes one of the Read Replicas
(read-only instances) in the DB cluster to be the primary instance
(the cluster writer).


Amazon Neptune will automatically fail over to a Read Replica, if one
exists, when the primary instance fails. You can force a failover when
you want to simulate a failure of a primary instance for testing.
Because each instance in a DB cluster has its own endpoint address,
you will need to clean up and re-establish any existing connections
that use those endpoint addresses when the failover is complete.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.failover_db_cluster({
  db_cluster_identifier: "String",
  target_db_instance_identifier: "String",
})

    
      
        
Response structure

      
      

resp.db_cluster.allocated_storage #=> Integer
resp.db_cluster.availability_zones #=> Array
resp.db_cluster.availability_zones[0] #=> String
resp.db_cluster.backup_retention_period #=> Integer
resp.db_cluster.character_set_name #=> String
resp.db_cluster.database_name #=> String
resp.db_cluster.db_cluster_identifier #=> String
resp.db_cluster.db_cluster_parameter_group #=> String
resp.db_cluster.db_subnet_group #=> String
resp.db_cluster.status #=> String
resp.db_cluster.percent_progress #=> String
resp.db_cluster.earliest_restorable_time #=> Time
resp.db_cluster.endpoint #=> String
resp.db_cluster.reader_endpoint #=> String
resp.db_cluster.multi_az #=> Boolean
resp.db_cluster.engine #=> String
resp.db_cluster.engine_version #=> String
resp.db_cluster.latest_restorable_time #=> Time
resp.db_cluster.port #=> Integer
resp.db_cluster.master_username #=> String
resp.db_cluster.db_cluster_option_group_memberships #=> Array
resp.db_cluster.db_cluster_option_group_memberships[0].db_cluster_option_group_name #=> String
resp.db_cluster.db_cluster_option_group_memberships[0].status #=> String
resp.db_cluster.preferred_backup_window #=> String
resp.db_cluster.preferred_maintenance_window #=> String
resp.db_cluster.replication_source_identifier #=> String
resp.db_cluster.read_replica_identifiers #=> Array
resp.db_cluster.read_replica_identifiers[0] #=> String
resp.db_cluster.db_cluster_members #=> Array
resp.db_cluster.db_cluster_members[0].db_instance_identifier #=> String
resp.db_cluster.db_cluster_members[0].is_cluster_writer #=> Boolean
resp.db_cluster.db_cluster_members[0].db_cluster_parameter_group_status #=> String
resp.db_cluster.db_cluster_members[0].promotion_tier #=> Integer
resp.db_cluster.vpc_security_groups #=> Array
resp.db_cluster.vpc_security_groups[0].vpc_security_group_id #=> String
resp.db_cluster.vpc_security_groups[0].status #=> String
resp.db_cluster.hosted_zone_id #=> String
resp.db_cluster.storage_encrypted #=> Boolean
resp.db_cluster.kms_key_id #=> String
resp.db_cluster.db_cluster_resource_id #=> String
resp.db_cluster.db_cluster_arn #=> String
resp.db_cluster.associated_roles #=> Array
resp.db_cluster.associated_roles[0].role_arn #=> String
resp.db_cluster.associated_roles[0].status #=> String
resp.db_cluster.associated_roles[0].feature_name #=> String
resp.db_cluster.iam_database_authentication_enabled #=> Boolean
resp.db_cluster.clone_group_id #=> String
resp.db_cluster.cluster_create_time #=> Time
resp.db_cluster.copy_tags_to_snapshot #=> Boolean
resp.db_cluster.enabled_cloudwatch_logs_exports #=> Array
resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String
resp.db_cluster.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_enable #=> Array
resp.db_cluster.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_enable[0] #=> String
resp.db_cluster.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_disable #=> Array
resp.db_cluster.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_disable[0] #=> String
resp.db_cluster.pending_modified_values.db_cluster_identifier #=> String
resp.db_cluster.pending_modified_values.iam_database_authentication_enabled #=> Boolean
resp.db_cluster.pending_modified_values.engine_version #=> String
resp.db_cluster.pending_modified_values.backup_retention_period #=> Integer
resp.db_cluster.pending_modified_values.storage_type #=> String
resp.db_cluster.pending_modified_values.allocated_storage #=> Integer
resp.db_cluster.pending_modified_values.iops #=> Integer
resp.db_cluster.pending_modified_values.network_type #=> String
resp.db_cluster.deletion_protection #=> Boolean
resp.db_cluster. #=> Boolean
resp.db_cluster.automatic_restart_time #=> Time
resp.db_cluster.serverless_v2_scaling_configuration.min_capacity #=> Float
resp.db_cluster.serverless_v2_scaling_configuration.max_capacity #=> Float
resp.db_cluster.global_cluster_identifier #=> String
resp.db_cluster.io_optimized_next_allowed_modification_time #=> Time
resp.db_cluster.storage_type #=> String
resp.db_cluster.network_type #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :db_cluster_identifier
          (String)
          
            
          
          
            — 
    A DB cluster identifier to force a failover for. This parameter is not
case-sensitive.
    

    Constraints:
    

      

    • Must match the identifier of an existing DBCluster.
      • 

    

    ^
    
          
        
    • 
      
        
  • 
          :target_db_instance_identifier
          (String)
          
            
          
          
            — 
    The name of the instance to promote to the primary instance.
    

    You must specify the instance identifier for an Read Replica in the DB
cluster. For example, mydbcluster-replica1.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


896

    		
    
      
# File 'sig/client.rbs', line 896

def failover_db_cluster: (

    		
  





    
      

  

  
    #failover_global_cluster(params = {})  ⇒ Types::FailoverGlobalClusterResult 
  

  

  




  

    
Initiates the failover process for a Neptune global database.


A failover for a Neptune global database promotes one of secondary
read-only DB clusters to be the primary DB cluster and demotes the
primary DB cluster to being a secondary (read-only) DB cluster. In
other words, the role of the current primary DB cluster and the
selected target secondary DB cluster are switched. The selected
secondary DB cluster assumes full read/write capabilities for the
Neptune global database.


 This action applies only to Neptune global databases. This action
is only intended for use on healthy Neptune global databases with
healthy Neptune DB clusters and no region-wide outages, to test
disaster recovery scenarios or to reconfigure the global database
topology.

 

  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.failover_global_cluster({
  global_cluster_identifier: "GlobalClusterIdentifier", # required
  target_db_cluster_identifier: "String", # required
  allow_data_loss: false,
  switchover: false,
})

    
      
        
Response structure

      
      

resp.global_cluster.global_cluster_identifier #=> String
resp.global_cluster.global_cluster_resource_id #=> String
resp.global_cluster.global_cluster_arn #=> String
resp.global_cluster.status #=> String
resp.global_cluster.engine #=> String
resp.global_cluster.engine_version #=> String
resp.global_cluster.database_name #=> String
resp.global_cluster.storage_encrypted #=> Boolean
resp.global_cluster.deletion_protection #=> Boolean
resp.global_cluster.global_cluster_members #=> Array
resp.global_cluster.global_cluster_members[0].db_cluster_arn #=> String
resp.global_cluster.global_cluster_members[0].readers #=> Array
resp.global_cluster.global_cluster_members[0].readers[0] #=> String
resp.global_cluster.global_cluster_members[0].is_writer #=> Boolean
resp.global_cluster.failover_state.status #=> String, one of "pending", "failing-over", "cancelling"
resp.global_cluster.failover_state.from_db_cluster_arn #=> String
resp.global_cluster.failover_state.to_db_cluster_arn #=> String
resp.global_cluster.failover_state.is_data_loss_allowed #=> Boolean
resp.global_cluster.tag_list #=> Array
resp.global_cluster.tag_list[0].key #=> String
resp.global_cluster.tag_list[0].value #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :global_cluster_identifier
          (required, String)
          
            
          
          
            — 
    Identifier of the Neptune global database that should be failed over.
The identifier is the unique key assigned by the user when the Neptune
global database was created. In other words, it's the name of the
global database that you want to fail over.
    

    Constraints: Must match the identifier of an existing Neptune global
database.
    
          
        
    • 
      
        
  • 
          :target_db_cluster_identifier
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the secondary Neptune DB cluster
that you want to promote to primary for the global database.
    
          
        
    • 
      
        
  • 
          :allow_data_loss
          (Boolean)
          
            
          
          
            — 
    Specifies whether to allow data loss for this global database cluster
operation. Allowing data loss triggers a global failover operation.
    

    If you don't specify AllowDataLoss, the global database cluster
operation defaults to a switchover.
    

    Constraints: Can't be specified together with the Switchover
parameter.
    
          
        
    • 
      
        
  • 
          :switchover
          (Boolean)
          
            
          
          
            — 
    Specifies whether to switch over this global database cluster.
    

    Constraints: Can't be specified together with the AllowDataLoss
parameter.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


907

    		
    
      
# File 'sig/client.rbs', line 907

def failover_global_cluster: (

    		
  





    
      

  

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

  

  




  

    
Lists all tags on an Amazon Neptune resource.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.list_tags_for_resource({
  resource_name: "String", # required
  filters: [
    {
      name: "String", # required
      values: ["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_name
          (required, String)
          
            
          
          
            — 
    The Amazon Neptune resource with tags to be listed. This value is an
Amazon Resource Name (ARN). For information about creating an ARN, see
 Constructing an Amazon Resource Name (ARN).
    
          
        
    • 
      
        
  • 
          :filters
          (Array<Types::Filter>)
          
            
          
          
            — 
    This parameter is not currently supported.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


920

    		
    
      
# File 'sig/client.rbs', line 920

def list_tags_for_resource: (

    		
  





    
      

  

  
    #modify_db_cluster(params = {})  ⇒ Types::ModifyDBClusterResult 
  

  

  




  

    
Modify a setting for a DB cluster. You can change one or more database
configuration parameters by specifying these parameters and the new
values in the request.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.modify_db_cluster({
  db_cluster_identifier: "String", # required
  new_db_cluster_identifier: "String",
  apply_immediately: false,
  backup_retention_period: 1,
  db_cluster_parameter_group_name: "String",
  vpc_security_group_ids: ["String"],
  port: 1,
  master_user_password: "String",
  option_group_name: "String",
  preferred_backup_window: "String",
  preferred_maintenance_window: "String",
  enable_iam_database_authentication: false,
  cloudwatch_logs_export_configuration: {
    enable_log_types: ["String"],
    disable_log_types: ["String"],
  },
  engine_version: "String",
  allow_major_version_upgrade: false,
  db_instance_parameter_group_name: "String",
  deletion_protection: false,
  copy_tags_to_snapshot: false,
  serverless_v2_scaling_configuration: {
    min_capacity: 1.0,
    max_capacity: 1.0,
  },
  storage_type: "String",
  network_type: "String",
})

    
      
        
Response structure

      
      

resp.db_cluster.allocated_storage #=> Integer
resp.db_cluster.availability_zones #=> Array
resp.db_cluster.availability_zones[0] #=> String
resp.db_cluster.backup_retention_period #=> Integer
resp.db_cluster.character_set_name #=> String
resp.db_cluster.database_name #=> String
resp.db_cluster.db_cluster_identifier #=> String
resp.db_cluster.db_cluster_parameter_group #=> String
resp.db_cluster.db_subnet_group #=> String
resp.db_cluster.status #=> String
resp.db_cluster.percent_progress #=> String
resp.db_cluster.earliest_restorable_time #=> Time
resp.db_cluster.endpoint #=> String
resp.db_cluster.reader_endpoint #=> String
resp.db_cluster.multi_az #=> Boolean
resp.db_cluster.engine #=> String
resp.db_cluster.engine_version #=> String
resp.db_cluster.latest_restorable_time #=> Time
resp.db_cluster.port #=> Integer
resp.db_cluster.master_username #=> String
resp.db_cluster.db_cluster_option_group_memberships #=> Array
resp.db_cluster.db_cluster_option_group_memberships[0].db_cluster_option_group_name #=> String
resp.db_cluster.db_cluster_option_group_memberships[0].status #=> String
resp.db_cluster.preferred_backup_window #=> String
resp.db_cluster.preferred_maintenance_window #=> String
resp.db_cluster.replication_source_identifier #=> String
resp.db_cluster.read_replica_identifiers #=> Array
resp.db_cluster.read_replica_identifiers[0] #=> String
resp.db_cluster.db_cluster_members #=> Array
resp.db_cluster.db_cluster_members[0].db_instance_identifier #=> String
resp.db_cluster.db_cluster_members[0].is_cluster_writer #=> Boolean
resp.db_cluster.db_cluster_members[0].db_cluster_parameter_group_status #=> String
resp.db_cluster.db_cluster_members[0].promotion_tier #=> Integer
resp.db_cluster.vpc_security_groups #=> Array
resp.db_cluster.vpc_security_groups[0].vpc_security_group_id #=> String
resp.db_cluster.vpc_security_groups[0].status #=> String
resp.db_cluster.hosted_zone_id #=> String
resp.db_cluster.storage_encrypted #=> Boolean
resp.db_cluster.kms_key_id #=> String
resp.db_cluster.db_cluster_resource_id #=> String
resp.db_cluster.db_cluster_arn #=> String
resp.db_cluster.associated_roles #=> Array
resp.db_cluster.associated_roles[0].role_arn #=> String
resp.db_cluster.associated_roles[0].status #=> String
resp.db_cluster.associated_roles[0].feature_name #=> String
resp.db_cluster.iam_database_authentication_enabled #=> Boolean
resp.db_cluster.clone_group_id #=> String
resp.db_cluster.cluster_create_time #=> Time
resp.db_cluster.copy_tags_to_snapshot #=> Boolean
resp.db_cluster.enabled_cloudwatch_logs_exports #=> Array
resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String
resp.db_cluster.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_enable #=> Array
resp.db_cluster.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_enable[0] #=> String
resp.db_cluster.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_disable #=> Array
resp.db_cluster.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_disable[0] #=> String
resp.db_cluster.pending_modified_values.db_cluster_identifier #=> String
resp.db_cluster.pending_modified_values.iam_database_authentication_enabled #=> Boolean
resp.db_cluster.pending_modified_values.engine_version #=> String
resp.db_cluster.pending_modified_values.backup_retention_period #=> Integer
resp.db_cluster.pending_modified_values.storage_type #=> String
resp.db_cluster.pending_modified_values.allocated_storage #=> Integer
resp.db_cluster.pending_modified_values.iops #=> Integer
resp.db_cluster.pending_modified_values.network_type #=> String
resp.db_cluster.deletion_protection #=> Boolean
resp.db_cluster. #=> Boolean
resp.db_cluster.automatic_restart_time #=> Time
resp.db_cluster.serverless_v2_scaling_configuration.min_capacity #=> Float
resp.db_cluster.serverless_v2_scaling_configuration.max_capacity #=> Float
resp.db_cluster.global_cluster_identifier #=> String
resp.db_cluster.io_optimized_next_allowed_modification_time #=> Time
resp.db_cluster.storage_type #=> String
resp.db_cluster.network_type #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :db_cluster_identifier
          (required, String)
          
            
          
          
            — 
    The DB cluster identifier for the cluster being modified. This
parameter is not case-sensitive.
    

    Constraints:
    

      

    • Must match the identifier of an existing DBCluster.
      • 

    

    ^
    
          
        
    • 
      
        
  • 
          :new_db_cluster_identifier
          (String)
          
            
          
          
            — 
    The new DB cluster identifier for the DB cluster when renaming a DB
cluster. This value 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-cluster2
    
          
        
    • 
      
        
  • 
          :apply_immediately
          (Boolean)
          
            
          
          
            — 
    A value that specifies whether the modifications in this request and
any pending modifications are asynchronously applied as soon as
possible, regardless of the PreferredMaintenanceWindow setting for
the DB cluster. If this parameter is set to false, changes to the DB
cluster are applied during the next maintenance window.
    

    The ApplyImmediately parameter only affects NewDBClusterIdentifier
values. If you set the ApplyImmediately parameter value to false,
then changes to NewDBClusterIdentifier values are applied during the
next maintenance window. All other changes are applied immediately,
regardless of the value of the ApplyImmediately parameter.
    

    Default: false
    
          
        
    • 
      
        
  • 
          :backup_retention_period
          (Integer)
          
            
          
          
            — 
    The number of days for which automated backups are retained. You must
specify a minimum value of 1.
    

    Default: 1
    

    Constraints:
    

      

    • Must be a value from 1 to 35
      • 

    

    ^
    
          
        
    • 
      
        
  • 
          :db_cluster_parameter_group_name
          (String)
          
            
          
          
            — 
    The name of the DB cluster parameter group to use for the DB cluster.
    
          
        
    • 
      
        
  • 
          :vpc_security_group_ids
          (Array<String>)
          
            
          
          
            — 
    A list of VPC security groups that the DB cluster will belong to.
    
          
        
    • 
      
        
  • 
          :port
          (Integer)
          
            
          
          
            — 
    The port number on which the DB cluster accepts connections.
    

    Constraints: Value must be 1150-65535
    

    Default: The same port as the original DB cluster.
    
          
        
    • 
      
        
  • 
          :master_user_password
          (String)
          
            
          
          
            — 
    Not supported by Neptune.
    
          
        
    • 
      
        
  • 
          :option_group_name
          (String)
          
            
          
          
            — 
    Not supported by Neptune.
    
          
        
    • 
      
        
  • 
          :preferred_backup_window
          (String)
          
            
          
          
            — 
    The daily time range during which automated backups are created if
automated backups are enabled, using the BackupRetentionPeriod
parameter.
    

    The default is a 30-minute window selected at random from an 8-hour
block of time for each Amazon Region.
    

    Constraints:
    

      

    • 

      Must be in the format hh24:mi-hh24:mi.
      

      • 

    • 

      Must be in Universal Coordinated Time (UTC).
      

      • 

    • 

      Must not conflict with the preferred maintenance window.
      

      • 

    • 

      Must be at least 30 minutes.
      

      • 

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

    The default is a 30-minute window selected at random from an 8-hour
block of time for each Amazon Region, occurring on a random day of the
week.
    

    Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
    

    Constraints: Minimum 30-minute window.
    
          
        
    • 
      
        
  • 
          :enable_iam_database_authentication
          (Boolean)
          
            
          
          
            — 
    True to enable mapping of Amazon Identity and Access Management (IAM)
accounts to database accounts, and otherwise false.
    

    Default: false
    
          
        
    • 
      
        
  • 
          :cloudwatch_logs_export_configuration
          (Types::CloudwatchLogsExportConfiguration)
          
            
          
          
            — 
    The configuration setting for the log types to be enabled for export
to CloudWatch Logs for a specific DB cluster. See Using the CLI to
publish Neptune audit logs to CloudWatch Logs.
    
          
        
    • 
      
        
  • 
          :engine_version
          (String)
          
            
          
          
            — 
    The version number of the database engine to which you want to
upgrade. Changing this parameter results in an outage. The change is
applied during the next maintenance window unless the
ApplyImmediately parameter is set to true.
    

    For a list of valid engine versions, see Engine Releases for Amazon
Neptune, or call DescribeDBEngineVersions.
    
          
        
    • 
      
        
  • 
          :allow_major_version_upgrade
          (Boolean)
          
            
          
          
            — 
    A value that indicates whether upgrades between different major
versions are allowed.
    

    Constraints: You must set the allow-major-version-upgrade flag when
providing an EngineVersion parameter that uses a different major
version than the DB cluster's current version.
    
          
        
    • 
      
        
  • 
          :db_instance_parameter_group_name
          (String)
          
            
          
          
            — 
    The name of the DB parameter group to apply to all instances of the DB
cluster.
    

     When you apply a parameter group using DBInstanceParameterGroupName,
parameter changes aren't applied during the next maintenance window
but instead are applied immediately.
    
 

    Default: The existing name setting
    

    Constraints:
    

      

    • 

      The DB parameter group must be in the same DB parameter group family
as the target DB cluster version.
      

      • 

    • 

      The DBInstanceParameterGroupName parameter is only valid in
combination with the AllowMajorVersionUpgrade parameter.
      

      • 

    
          
        
    • 
      
        
  • 
          :deletion_protection
          (Boolean)
          
            
          
          
            — 
    A value that indicates whether the DB cluster has deletion protection
enabled. The database can't be deleted when deletion protection is
enabled. By default, deletion protection is disabled.
    
          
        
    • 
      
        
  • 
          :copy_tags_to_snapshot
          (Boolean)
          
            
          
          
            — 
    If set to true, tags are copied to any snapshot of the DB cluster
that is created.
    
          
        
    • 
      
        
  • 
          :serverless_v2_scaling_configuration
          (Types::ServerlessV2ScalingConfiguration)
          
            
          
          
            — 
    Contains the scaling configuration of a Neptune Serverless DB cluster.
    

    For more information, see Using Amazon Neptune Serverless in the
Amazon Neptune User Guide.
    
          
        
    • 
      
        
  • 
          :storage_type
          (String)
          
            
          
          
            — 
    The storage type to associate with the DB cluster.
    

    Valid Values:
    

      

    • 

       standard    –   ( the default ) Configures
cost-effective database storage for applications with moderate to
small I/O usage.
      

      • 

    • 

       iopt1    –   Enables I/O-Optimized storage
that's designed to meet the needs of I/O-intensive graph workloads
that require predictable pricing with low I/O latency and consistent
I/O throughput.
      

      Neptune I/O-Optimized storage is only available starting with engine
release 1.3.0.0.
      

      • 

    
          
        
    • 
      
        
  • 
          :network_type
          (String)
          
            
          
          
            — 
    The network type of the DB cluster.
    

    Valid Values:
    

      

    • 

       IPV4    –   The DB cluster uses only IPv4
addresses for communication.
      

      • 

    • 

       DUAL    –   The DB cluster uses both IPv4 and
IPv6 addresses for communication. The DB subnet group associated
with the cluster must support IPv6.
      

      • 

    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


936

    		
    
      
# File 'sig/client.rbs', line 936

def modify_db_cluster: (

    		
  





    
      

  

  
    #modify_db_cluster_endpoint(params = {})  ⇒ Types::ModifyDBClusterEndpointOutput 
  

  

  




  

    
Modifies the properties of an endpoint in an Amazon Neptune DB
cluster.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.modify_db_cluster_endpoint({
  db_cluster_endpoint_identifier: "String", # required
  endpoint_type: "String",
  static_members: ["String"],
  excluded_members: ["String"],
})

    
      
        
Response structure

      
      

resp.db_cluster_endpoint_identifier #=> String
resp.db_cluster_identifier #=> String
resp.db_cluster_endpoint_resource_identifier #=> String
resp.endpoint #=> String
resp.status #=> String
resp.endpoint_type #=> String
resp.custom_endpoint_type #=> String
resp.static_members #=> Array
resp.static_members[0] #=> String
resp.excluded_members #=> Array
resp.excluded_members[0] #=> String
resp.db_cluster_endpoint_arn #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :db_cluster_endpoint_identifier
          (required, String)
          
            
          
          
            — 
    The identifier of the endpoint to modify. This parameter is stored as
a lowercase string.
    
          
        
    • 
      
        
  • 
          :endpoint_type
          (String)
          
            
          
          
            — 
    The type of the endpoint. One of: READER, WRITER, ANY.
    
          
        
    • 
      
        
  • 
          :static_members
          (Array<String>)
          
            
          
          
            — 
    List of DB instance identifiers that are part of the custom endpoint
group.
    
          
        
    • 
      
        
  • 
          :excluded_members
          (Array<String>)
          
            
          
          
            — 
    List of DB instance identifiers that aren't part of the custom
endpoint group. All other eligible instances are reachable through the
custom endpoint. Only relevant if the list of static members is empty.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


981

    		
    
      
# File 'sig/client.rbs', line 981

def modify_db_cluster_endpoint: (

    		
  





    
      

  

  
    #modify_db_cluster_parameter_group(params = {})  ⇒ Types::DBClusterParameterGroupNameMessage 
  

  

  




  

    
Modifies the parameters of a DB cluster parameter group. To modify
more than one parameter, submit a list of the following:
ParameterName, ParameterValue, and ApplyMethod. A maximum of 20
parameters can be modified in a single request.


 Changes to dynamic parameters are applied immediately. Changes to
static parameters require a reboot without failover to the DB cluster
associated with the parameter group before the change can take effect.

 

After you create a DB cluster parameter group, you should wait at
least 5 minutes before creating your first DB cluster that uses that
DB cluster parameter group as the default parameter group. This allows
Amazon Neptune to fully complete the create action before the
parameter group is used as the default for a new DB cluster. This is
especially important for parameters that are critical when creating
the default database for a DB cluster, such as the character set for
the default database defined by the character_set_database
parameter. You can use the Parameter Groups option of the Amazon
Neptune console or the DescribeDBClusterParameters command to verify
that your DB cluster parameter group has been created or modified.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.modify_db_cluster_parameter_group({
  db_cluster_parameter_group_name: "String", # required
  parameters: [ # required
    {
      parameter_name: "String",
      parameter_value: "String",
      description: "String",
      source: "String",
      apply_type: "String",
      data_type: "String",
      allowed_values: "String",
      is_modifiable: false,
      minimum_engine_version: "String",
      apply_method: "immediate", # accepts immediate, pending-reboot
    },
  ],
})

    
      
        
Response structure

      
      

resp.db_cluster_parameter_group_name #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :db_cluster_parameter_group_name
          (required, String)
          
            
          
          
            — 
    The name of the DB cluster parameter group to modify.
    
          
        
    • 
      
        
  • 
          :parameters
          (required, Array<Types::Parameter>)
          
            
          
          
            — 
    A list of parameters in the DB cluster parameter group to modify.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


994

    		
    
      
# File 'sig/client.rbs', line 994

def modify_db_cluster_parameter_group: (

    		
  





    
      

  

  
    #modify_db_cluster_snapshot_attribute(params = {})  ⇒ Types::ModifyDBClusterSnapshotAttributeResult 
  

  

  




  

    
Adds an attribute and values to, or removes an attribute and values
from, a manual DB cluster snapshot.


To share a manual DB cluster snapshot with other Amazon accounts,
specify restore as the AttributeName and use the ValuesToAdd
parameter to add a list of IDs of the Amazon accounts that are
authorized to restore the manual DB cluster snapshot. Use the value
all to make the manual DB cluster snapshot public, which means that
it can be copied or restored by all Amazon accounts. Do not add the
all value for any manual DB cluster snapshots that contain private
information that you don't want available to all Amazon accounts. If
a manual DB cluster snapshot is encrypted, it can be shared, but only
by specifying a list of authorized Amazon account IDs for the
ValuesToAdd parameter. You can't use all as a value for that
parameter in this case.


To view which Amazon accounts have access to copy or restore a manual
DB cluster snapshot, or whether a manual DB cluster snapshot public or
private, use the DescribeDBClusterSnapshotAttributes API action.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.modify_db_cluster_snapshot_attribute({
  db_cluster_snapshot_identifier: "String", # required
  attribute_name: "String", # required
  values_to_add: ["String"],
  values_to_remove: ["String"],
})

    
      
        
Response structure

      
      

resp.db_cluster_snapshot_attributes_result.db_cluster_snapshot_identifier #=> String
resp.db_cluster_snapshot_attributes_result.db_cluster_snapshot_attributes #=> Array
resp.db_cluster_snapshot_attributes_result.db_cluster_snapshot_attributes[0].attribute_name #=> String
resp.db_cluster_snapshot_attributes_result.db_cluster_snapshot_attributes[0].attribute_values #=> Array
resp.db_cluster_snapshot_attributes_result.db_cluster_snapshot_attributes[0].attribute_values[0] #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :db_cluster_snapshot_identifier
          (required, String)
          
            
          
          
            — 
    The identifier for the DB cluster snapshot to modify the attributes
for.
    
          
        
    • 
      
        
  • 
          :attribute_name
          (required, String)
          
            
          
          
            — 
    The name of the DB cluster snapshot attribute to modify.
    

    To manage authorization for other Amazon accounts to copy or restore a
manual DB cluster snapshot, set this value to restore.
    
          
        
    • 
      
        
  • 
          :values_to_add
          (Array<String>)
          
            
          
          
            — 
    A list of DB cluster snapshot attributes to add to the attribute
specified by AttributeName.
    

    To authorize other Amazon accounts to copy or restore a manual DB
cluster snapshot, set this list to include one or more Amazon account
IDs, or all to make the manual DB cluster snapshot restorable by any
Amazon account. Do not add the all value for any manual DB cluster
snapshots that contain private information that you don't want
available to all Amazon accounts.
    
          
        
    • 
      
        
  • 
          :values_to_remove
          (Array<String>)
          
            
          
          
            — 
    A list of DB cluster snapshot attributes to remove from the attribute
specified by AttributeName.
    

    To remove authorization for other Amazon accounts to copy or restore a
manual DB cluster snapshot, set this list to include one or more
Amazon account identifiers, or all to remove authorization for any
Amazon account to copy or restore the DB cluster snapshot. If you
specify all, an Amazon account whose account ID is explicitly added
to the restore attribute can still copy or restore a manual DB
cluster snapshot.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1007

    		
    
      
# File 'sig/client.rbs', line 1007

def modify_db_cluster_snapshot_attribute: (

    		
  





    
      

  

  
    #modify_db_instance(params = {})  ⇒ Types::ModifyDBInstanceResult 
  

  

  




  

    
Modifies settings for a DB instance. You can change one or more
database configuration parameters by specifying these parameters and
the new values in the request. To learn what modifications you can
make to your DB instance, call DescribeValidDBInstanceModifications
before you call ModifyDBInstance.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.modify_db_instance({
  db_instance_identifier: "String", # required
  allocated_storage: 1,
  db_instance_class: "String",
  db_subnet_group_name: "String",
  db_security_groups: ["String"],
  vpc_security_group_ids: ["String"],
  apply_immediately: false,
  master_user_password: "String",
  db_parameter_group_name: "String",
  backup_retention_period: 1,
  preferred_backup_window: "String",
  preferred_maintenance_window: "String",
  multi_az: false,
  engine_version: "String",
  allow_major_version_upgrade: false,
  auto_minor_version_upgrade: false,
  license_model: "String",
  iops: 1,
  option_group_name: "String",
  new_db_instance_identifier: "String",
  storage_type: "String",
  tde_credential_arn: "String",
  tde_credential_password: "SensitiveString",
  ca_certificate_identifier: "String",
  domain: "String",
  copy_tags_to_snapshot: false,
  monitoring_interval: 1,
  db_port_number: 1,
  publicly_accessible: false,
  monitoring_role_arn: "String",
  domain_iam_role_name: "String",
  promotion_tier: 1,
  enable_iam_database_authentication: false,
  enable_performance_insights: false,
  performance_insights_kms_key_id: "String",
  cloudwatch_logs_export_configuration: {
    enable_log_types: ["String"],
    disable_log_types: ["String"],
  },
  deletion_protection: false,
})

    
      
        
Response structure

      
      

resp.db_instance.db_instance_identifier #=> String
resp.db_instance.db_instance_class #=> String
resp.db_instance.engine #=> String
resp.db_instance.db_instance_status #=> String
resp.db_instance.master_username #=> String
resp.db_instance.db_name #=> String
resp.db_instance.endpoint.address #=> String
resp.db_instance.endpoint.port #=> Integer
resp.db_instance.endpoint.hosted_zone_id #=> String
resp.db_instance.allocated_storage #=> Integer
resp.db_instance.instance_create_time #=> Time
resp.db_instance.preferred_backup_window #=> String
resp.db_instance.backup_retention_period #=> Integer
resp.db_instance.db_security_groups #=> Array
resp.db_instance.db_security_groups[0].db_security_group_name #=> String
resp.db_instance.db_security_groups[0].status #=> String
resp.db_instance.vpc_security_groups #=> Array
resp.db_instance.vpc_security_groups[0].vpc_security_group_id #=> String
resp.db_instance.vpc_security_groups[0].status #=> String
resp.db_instance.db_parameter_groups #=> Array
resp.db_instance.db_parameter_groups[0].db_parameter_group_name #=> String
resp.db_instance.db_parameter_groups[0].parameter_apply_status #=> String
resp.db_instance.availability_zone #=> String
resp.db_instance.db_subnet_group.db_subnet_group_name #=> String
resp.db_instance.db_subnet_group.db_subnet_group_description #=> String
resp.db_instance.db_subnet_group.vpc_id #=> String
resp.db_instance.db_subnet_group.subnet_group_status #=> String
resp.db_instance.db_subnet_group.subnets #=> Array
resp.db_instance.db_subnet_group.subnets[0].subnet_identifier #=> String
resp.db_instance.db_subnet_group.subnets[0].subnet_availability_zone.name #=> String
resp.db_instance.db_subnet_group.subnets[0].subnet_status #=> String
resp.db_instance.db_subnet_group.db_subnet_group_arn #=> String
resp.db_instance.db_subnet_group.supported_network_types #=> Array
resp.db_instance.db_subnet_group.supported_network_types[0] #=> String
resp.db_instance.preferred_maintenance_window #=> String
resp.db_instance.pending_modified_values.db_instance_class #=> String
resp.db_instance.pending_modified_values.allocated_storage #=> Integer
resp.db_instance.pending_modified_values.master_user_password #=> String
resp.db_instance.pending_modified_values.port #=> Integer
resp.db_instance.pending_modified_values.backup_retention_period #=> Integer
resp.db_instance.pending_modified_values.multi_az #=> Boolean
resp.db_instance.pending_modified_values.engine_version #=> String
resp.db_instance.pending_modified_values.license_model #=> String
resp.db_instance.pending_modified_values.iops #=> Integer
resp.db_instance.pending_modified_values.db_instance_identifier #=> String
resp.db_instance.pending_modified_values.storage_type #=> String
resp.db_instance.pending_modified_values.ca_certificate_identifier #=> String
resp.db_instance.pending_modified_values.db_subnet_group_name #=> String
resp.db_instance.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_enable #=> Array
resp.db_instance.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_enable[0] #=> String
resp.db_instance.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_disable #=> Array
resp.db_instance.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_disable[0] #=> String
resp.db_instance.latest_restorable_time #=> Time
resp.db_instance.multi_az #=> Boolean
resp.db_instance.engine_version #=> String
resp.db_instance.auto_minor_version_upgrade #=> Boolean
resp.db_instance.read_replica_source_db_instance_identifier #=> String
resp.db_instance.read_replica_db_instance_identifiers #=> Array
resp.db_instance.read_replica_db_instance_identifiers[0] #=> String
resp.db_instance.read_replica_db_cluster_identifiers #=> Array
resp.db_instance.read_replica_db_cluster_identifiers[0] #=> String
resp.db_instance.license_model #=> String
resp.db_instance.iops #=> Integer
resp.db_instance.option_group_memberships #=> Array
resp.db_instance.option_group_memberships[0].option_group_name #=> String
resp.db_instance.option_group_memberships[0].status #=> String
resp.db_instance.character_set_name #=> String
resp.db_instance.secondary_availability_zone #=> String
resp.db_instance.publicly_accessible #=> Boolean
resp.db_instance.status_infos #=> Array
resp.db_instance.status_infos[0].status_type #=> String
resp.db_instance.status_infos[0].normal #=> Boolean
resp.db_instance.status_infos[0].status #=> String
resp.db_instance.status_infos[0].message #=> String
resp.db_instance.storage_type #=> String
resp.db_instance.tde_credential_arn #=> String
resp.db_instance.db_instance_port #=> Integer
resp.db_instance.db_cluster_identifier #=> String
resp.db_instance.storage_encrypted #=> Boolean
resp.db_instance.kms_key_id #=> String
resp.db_instance.dbi_resource_id #=> String
resp.db_instance.ca_certificate_identifier #=> String
resp.db_instance.domain_memberships #=> Array
resp.db_instance.domain_memberships[0].domain #=> String
resp.db_instance.domain_memberships[0].status #=> String
resp.db_instance.domain_memberships[0].fqdn #=> String
resp.db_instance.domain_memberships[0].iam_role_name #=> String
resp.db_instance.copy_tags_to_snapshot #=> Boolean
resp.db_instance.monitoring_interval #=> Integer
resp.db_instance.enhanced_monitoring_resource_arn #=> String
resp.db_instance.monitoring_role_arn #=> String
resp.db_instance.promotion_tier #=> Integer
resp.db_instance.db_instance_arn #=> String
resp.db_instance.timezone #=> String
resp.db_instance.iam_database_authentication_enabled #=> Boolean
resp.db_instance.performance_insights_enabled #=> Boolean
resp.db_instance.performance_insights_kms_key_id #=> String
resp.db_instance.enabled_cloudwatch_logs_exports #=> Array
resp.db_instance.enabled_cloudwatch_logs_exports[0] #=> String
resp.db_instance.deletion_protection #=> Boolean
resp.db_instance.network_type #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :db_instance_identifier
          (required, String)
          
            
          
          
            — 
    The DB instance identifier. This value is stored as a lowercase
string.
    

    Constraints:
    

      

    • Must match the identifier of an existing DBInstance.
      • 

    

    ^
    
          
        
    • 
      
        
  • 
          :allocated_storage
          (Integer)
          
            
          
          
            — 
    Not supported by Neptune.
    
          
        
    • 
      
        
  • 
          :db_instance_class
          (String)
          
            
          
          
            — 
    The new compute and memory capacity of the DB instance, for example,
db.m4.large. Not all DB instance classes are available in all Amazon
Regions.
    

    If you modify the DB instance class, an outage occurs during the
change. The change is applied during the next maintenance window,
unless ApplyImmediately is specified as true for this request.
    

    Default: Uses existing setting
    
          
        
    • 
      
        
  • 
          :db_subnet_group_name
          (String)
          
            
          
          
            — 
    The new DB subnet group for the DB instance. You can use this
parameter to move your DB instance to a different VPC.
    

    Changing the subnet group causes an outage during the change. The
change is applied during the next maintenance window, unless you
specify true for the ApplyImmediately parameter.
    

    Constraints: If supplied, must match the name of an existing
DBSubnetGroup.
    

    Example: mySubnetGroup
    
          
        
    • 
      
        
  • 
          :db_security_groups
          (Array<String>)
          
            
          
          
            — 
    A list of DB security groups to authorize on this DB instance.
Changing this setting doesn't result in an outage and the change is
asynchronously applied as soon as possible.
    

    Constraints:
    

      

    • If supplied, must match existing DBSecurityGroups.
      • 

    

    ^
    
          
        
    • 
      
        
  • 
          :vpc_security_group_ids
          (Array<String>)
          
            
          
          
            — 
    A list of EC2 VPC security groups to authorize on this DB instance.
This change is asynchronously applied as soon as possible.
    

    Not applicable. The associated list of EC2 VPC security groups is
managed by the DB cluster. For more information, see ModifyDBCluster.
    

    Constraints:
    

      

    • If supplied, must match existing VpcSecurityGroupIds.
      • 

    

    ^
    
          
        
    • 
      
        
  • 
          :apply_immediately
          (Boolean)
          
            
          
          
            — 
    Specifies whether the modifications in this request and any pending
modifications are asynchronously applied as soon as possible,
regardless of the PreferredMaintenanceWindow setting for the DB
instance.
    

    If this parameter is set to false, changes to the DB instance are
applied during the next maintenance window. Some parameter changes can
cause an outage and are applied on the next call to RebootDBInstance,
or the next failure reboot.
    

    Default: false
    
          
        
    • 
      
        
  • 
          :master_user_password
          (String)
          
            
          
          
            — 
    Not supported by Neptune.
    
          
        
    • 
      
        
  • 
          :db_parameter_group_name
          (String)
          
            
          
          
            — 
    The name of the DB parameter group to apply to the DB instance.
Changing this setting doesn't result in an outage. The parameter
group name itself is changed immediately, but the actual parameter
changes are not applied until you reboot the instance without
failover. The db instance will NOT be rebooted automatically and the
parameter changes will NOT be applied during the next maintenance
window.
    

    Default: Uses existing setting
    

    Constraints: The DB parameter group must be in the same DB parameter
group family as this DB instance.
    
          
        
    • 
      
        
  • 
          :backup_retention_period
          (Integer)
          
            
          
          
            — 
    Not applicable. The retention period for automated backups is managed
by the DB cluster. For more information, see ModifyDBCluster.
    

    Default: Uses existing setting
    
          
        
    • 
      
        
  • 
          :preferred_backup_window
          (String)
          
            
          
          
            — 
    The daily time range during which automated backups are created if
automated backups are enabled.
    

    Not applicable. The daily time range for creating automated backups is
managed by the DB cluster. For more information, see ModifyDBCluster.
    

    Constraints:
    

      

    • 

      Must be in the format hh24:mi-hh24:mi
      

      • 

    • 

      Must be in Universal Time Coordinated (UTC)
      

      • 

    • 

      Must not conflict with the preferred maintenance window
      

      • 

    • 

      Must be at least 30 minutes
      

      • 

    
          
        
    • 
      
        
  • 
          :preferred_maintenance_window
          (String)
          
            
          
          
            — 
    The weekly time range (in UTC) during which system maintenance can
occur, which might result in an outage. Changing this parameter
doesn't result in an outage, except in the following situation, and
the change is asynchronously applied as soon as possible. If there are
pending actions that cause a reboot, and the maintenance window is
changed to include the current time, then changing this parameter will
cause a reboot of the DB instance. If moving this window to the
current time, there must be at least 30 minutes between the current
time and end of the window to ensure pending changes are applied.
    

    Default: Uses existing setting
    

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

    Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
    

    Constraints: Must be at least 30 minutes
    
          
        
    • 
      
        
  • 
          :multi_az
          (Boolean)
          
            
          
          
            — 
    Specifies if the DB instance is a Multi-AZ deployment. Changing this
parameter doesn't result in an outage and the change is applied
during the next maintenance window unless the ApplyImmediately
parameter is set to true for this request.
    
          
        
    • 
      
        
  • 
          :engine_version
          (String)
          
            
          
          
            — 
    The version number of the database engine to upgrade to. Currently,
setting this parameter has no effect. To upgrade your database engine
to the most recent release, use the ApplyPendingMaintenanceAction API.
    
          
        
    • 
      
        
  • 
          :allow_major_version_upgrade
          (Boolean)
          
            
          
          
            — 
    Indicates that major version upgrades are allowed. Changing this
parameter doesn't result in an outage and the change is
asynchronously applied as soon as possible.
    
          
        
    • 
      
        
  • 
          :auto_minor_version_upgrade
          (Boolean)
          
            
          
          
            — 
    Indicates that minor version upgrades are applied automatically to the
DB instance during the maintenance window. Changing this parameter
doesn't result in an outage except in the following case and the
change is asynchronously applied as soon as possible. An outage will
result if this parameter is set to true during the maintenance
window, and a newer minor version is available, and Neptune has
enabled auto patching for that engine version.
    
          
        
    • 
      
        
  • 
          :license_model
          (String)
          
            
          
          
            — 
    Not supported by Neptune.
    
          
        
    • 
      
        
  • 
          :iops
          (Integer)
          
            
          
          
            — 
    The new Provisioned IOPS (I/O operations per second) value for the
instance.
    

    Changing this setting doesn't result in an outage and the change is
applied during the next maintenance window unless the
ApplyImmediately parameter is set to true for this request.
    

    Default: Uses existing setting
    
          
        
    • 
      
        
  • 
          :option_group_name
          (String)
          
            
          
          
            — 
    (Not supported by Neptune)
    
          
        
    • 
      
        
  • 
          :new_db_instance_identifier
          (String)
          
            
          
          
            — 
    The new DB instance identifier for the DB instance when renaming a DB
instance. When you change the DB instance identifier, an instance
reboot will occur immediately if you set Apply Immediately to true,
or will occur during the next maintenance window if Apply Immediately to false. This value 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: mydbinstance
    
          
        
    • 
      
        
  • 
          :storage_type
          (String)
          
            
          
          
            — 
    Not applicable. In Neptune the storage type is managed at the DB
Cluster level.
    
          
        
    • 
      
        
  • 
          :tde_credential_arn
          (String)
          
            
          
          
            — 
    The ARN from the key store with which to associate the instance for
TDE encryption.
    
          
        
    • 
      
        
  • 
          :tde_credential_password
          (String)
          
            
          
          
            — 
    The password for the given ARN from the key store in order to access
the device.
    
          
        
    • 
      
        
  • 
          :ca_certificate_identifier
          (String)
          
            
          
          
            — 
    Indicates the certificate that needs to be associated with the
instance.
    
          
        
    • 
      
        
  • 
          :domain
          (String)
          
            
          
          
            — 
    Not supported.
    
          
        
    • 
      
        
  • 
          :copy_tags_to_snapshot
          (Boolean)
          
            
          
          
            — 
    True to copy all tags from the DB instance to snapshots of the DB
instance, and otherwise false. The default is false.
    
          
        
    • 
      
        
  • 
          :monitoring_interval
          (Integer)
          
            
          
          
            — 
    The interval, in seconds, between points when Enhanced Monitoring
metrics are collected for the DB instance. To disable collecting
Enhanced Monitoring metrics, specify 0. The default is 0.
    

    If MonitoringRoleArn is specified, then you must also set
MonitoringInterval to a value other than 0.
    

    Valid Values: 0, 1, 5, 10, 15, 30, 60
    
          
        
    • 
      
        
  • 
          :db_port_number
          (Integer)
          
            
          
          
            — 
    The port number on which the database accepts connections.
    

    The value of the DBPortNumber parameter must not match any of the
port values specified for options in the option group for the DB
instance.
    

    Your database will restart when you change the DBPortNumber value
regardless of the value of the ApplyImmediately parameter.
    

    Default: 8182
    
          
        
    • 
      
        
  • 
          :publicly_accessible
          (Boolean)
          
            
          
          
            — 
    Indicates whether the DB instance is publicly accessible.
    

    When the DB instance is publicly accessible and you connect from
outside of the DB instance's virtual private cloud (VPC), its Domain
Name System (DNS) endpoint resolves to the public IP address. When you
connect from within the same VPC as the DB instance, the endpoint
resolves to the private IP address. Access to the DB instance is
ultimately controlled by the security group it uses. That public
access isn't permitted if the security group assigned to the DB
cluster doesn't permit it.
    

    When the DB instance isn't publicly accessible, it is an internal DB
instance with a DNS name that resolves to a private IP address.
    
          
        
    • 
      
        
  • 
          :monitoring_role_arn
          (String)
          
            
          
          
            — 
    The ARN for the IAM role that permits Neptune to send enhanced
monitoring metrics to Amazon CloudWatch Logs. For example,
arn:aws:iam:123456789012:role/emaccess.
    

    If MonitoringInterval is set to a value other than 0, then you must
supply a MonitoringRoleArn value.
    
          
        
    • 
      
        
  • 
          :domain_iam_role_name
          (String)
          
            
          
          
            — 
    Not supported
    
          
        
    • 
      
        
  • 
          :promotion_tier
          (Integer)
          
            
          
          
            — 
    A value that specifies the order in which a Read Replica is promoted
to the primary instance after a failure of the existing primary
instance.
    

    Default: 1
    

    Valid Values: 0 - 15
    
          
        
    • 
      
        
  • 
          :enable_iam_database_authentication
          (Boolean)
          
            
          
          
            — 
    True to enable mapping of Amazon Identity and Access Management (IAM)
accounts to database accounts, and otherwise false.
    

    You can enable IAM database authentication for the following database
engines
    

    Not applicable. Mapping Amazon IAM accounts to database accounts is
managed by the DB cluster. For more information, see ModifyDBCluster.
    

    Default: false
    
          
        
    • 
      
        
  • 
          :enable_performance_insights
          (Boolean)
          
            
          
          
            — 
    (Not supported by Neptune)
    
          
        
    • 
      
        
  • 
          :performance_insights_kms_key_id
          (String)
          
            
          
          
            — 
    (Not supported by Neptune)
    
          
        
    • 
      
        
  • 
          :cloudwatch_logs_export_configuration
          (Types::CloudwatchLogsExportConfiguration)
          
            
          
          
            — 
    The configuration setting for the log types to be enabled for export
to CloudWatch Logs for a specific DB instance or DB cluster.
    
          
        
    • 
      
        
  • 
          :deletion_protection
          (Boolean)
          
            
          
          
            — 
    A value that indicates whether the DB instance has deletion protection
enabled. The database can't be deleted when deletion protection is
enabled. By default, deletion protection is disabled. See Deleting a
DB Instance.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1020

    		
    
      
# File 'sig/client.rbs', line 1020

def modify_db_instance: (

    		
  





    
      

  

  
    #modify_db_parameter_group(params = {})  ⇒ Types::DBParameterGroupNameMessage 
  

  

  




  

    
Modifies the parameters of a DB parameter group. To modify more than
one parameter, submit a list of the following: ParameterName,
ParameterValue, and ApplyMethod. A maximum of 20 parameters can be
modified in a single request.


 Changes to dynamic parameters are applied immediately. Changes to
static parameters require a reboot without failover to the DB instance
associated with the parameter group before the change can take effect.

 

After you modify a DB parameter group, you should wait at least 5
minutes before creating your first DB instance that uses that DB
parameter group as the default parameter group. This allows Amazon
Neptune to fully complete the modify action before the parameter group
is used as the default for a new DB instance. This is especially
important for parameters that are critical when creating the default
database for a DB instance, such as the character set for the default
database defined by the character_set_database parameter. You can
use the Parameter Groups option of the Amazon Neptune console or the
DescribeDBParameters command to verify that your DB parameter group
has been created or modified.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.modify_db_parameter_group({
  db_parameter_group_name: "String", # required
  parameters: [ # required
    {
      parameter_name: "String",
      parameter_value: "String",
      description: "String",
      source: "String",
      apply_type: "String",
      data_type: "String",
      allowed_values: "String",
      is_modifiable: false,
      minimum_engine_version: "String",
      apply_method: "immediate", # accepts immediate, pending-reboot
    },
  ],
})

    
      
        
Response structure

      
      

resp.db_parameter_group_name #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :db_parameter_group_name
          (required, String)
          
            
          
          
            — 
    The name of the DB parameter group.
    

    Constraints:
    

      

    • If supplied, must match the name of an existing DBParameterGroup.
      • 

    

    ^
    
          
        
    • 
      
        
  • 
          :parameters
          (required, Array<Types::Parameter>)
          
            
          
          
            — 
    An array of parameter names, values, and the apply method for the
parameter update. At least one parameter name, value, and apply method
must be supplied; subsequent arguments are optional. A maximum of 20
parameters can be modified in a single request.
    

    Valid Values (for the application method): immediate | pending-reboot
    

     You can use the immediate value with dynamic parameters only. You can
use the pending-reboot value for both dynamic and static parameters,
and changes are applied when you reboot the DB instance without
failover.
    
 
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1069

    		
    
      
# File 'sig/client.rbs', line 1069

def modify_db_parameter_group: (

    		
  





    
      

  

  
    #modify_db_subnet_group(params = {})  ⇒ Types::ModifyDBSubnetGroupResult 
  

  

  




  

    
Modifies an existing DB subnet group. DB subnet groups must contain at
least one subnet in at least two AZs in the Amazon Region.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.modify_db_subnet_group({
  db_subnet_group_name: "String", # required
  db_subnet_group_description: "String",
  subnet_ids: ["String"], # required
})

    
      
        
Response structure

      
      

resp.db_subnet_group.db_subnet_group_name #=> String
resp.db_subnet_group.db_subnet_group_description #=> String
resp.db_subnet_group.vpc_id #=> String
resp.db_subnet_group.subnet_group_status #=> String
resp.db_subnet_group.subnets #=> Array
resp.db_subnet_group.subnets[0].subnet_identifier #=> String
resp.db_subnet_group.subnets[0].subnet_availability_zone.name #=> String
resp.db_subnet_group.subnets[0].subnet_status #=> String
resp.db_subnet_group.db_subnet_group_arn #=> String
resp.db_subnet_group.supported_network_types #=> Array
resp.db_subnet_group.supported_network_types[0] #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :db_subnet_group_name
          (required, String)
          
            
          
          
            — 
    The name for the DB subnet group. This value is stored as a lowercase
string. You can't modify the default subnet group.
    

    Constraints: Must match the name of an existing DBSubnetGroup. Must
not be default.
    

    Example: mySubnetgroup
    
          
        
    • 
      
        
  • 
          :db_subnet_group_description
          (String)
          
            
          
          
            — 
    The description for the DB subnet group.
    
          
        
    • 
      
        
  • 
          :subnet_ids
          (required, Array<String>)
          
            
          
          
            — 
    The EC2 subnet IDs for the DB subnet group.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1082

    		
    
      
# File 'sig/client.rbs', line 1082

def modify_db_subnet_group: (

    		
  





    
      

  

  
    #modify_event_subscription(params = {})  ⇒ Types::ModifyEventSubscriptionResult 
  

  

  




  

    
Modifies an existing event notification subscription. Note that you
can't modify the source identifiers using this call; to change source
identifiers for a subscription, use the
AddSourceIdentifierToSubscription and
RemoveSourceIdentifierFromSubscription calls.


You can see a list of the event categories for a given SourceType by
using the DescribeEventCategories action.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.modify_event_subscription({
  subscription_name: "String", # required
  sns_topic_arn: "String",
  source_type: "String",
  event_categories: ["String"],
  enabled: false,
})

    
      
        
Response structure

      
      

resp.event_subscription.customer_aws_id #=> String
resp.event_subscription.cust_subscription_id #=> String
resp.event_subscription.sns_topic_arn #=> String
resp.event_subscription.status #=> String
resp.event_subscription.subscription_creation_time #=> String
resp.event_subscription.source_type #=> String
resp.event_subscription.source_ids_list #=> Array
resp.event_subscription.source_ids_list[0] #=> String
resp.event_subscription.event_categories_list #=> Array
resp.event_subscription.event_categories_list[0] #=> String
resp.event_subscription.enabled #=> Boolean
resp.event_subscription.event_subscription_arn #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :subscription_name
          (required, String)
          
            
          
          
            — 
    The name of the event notification subscription.
    
          
        
    • 
      
        
  • 
          :sns_topic_arn
          (String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the SNS topic created for event
notification. The ARN is created by Amazon SNS when you create a topic
and subscribe to it.
    
          
        
    • 
      
        
  • 
          :source_type
          (String)
          
            
          
          
            — 
    The type of source that is generating the events. For example, if you
want to be notified of events generated by a DB instance, you would
set this parameter to db-instance. if this value is not specified, all
events are returned.
    

    Valid values: db-instance | db-parameter-group | db-security-group
| db-snapshot
    
          
        
    • 
      
        
  • 
          :event_categories
          (Array<String>)
          
            
          
          
            — 
    A list of event categories for a SourceType that you want to subscribe
to. You can see a list of the categories for a given SourceType by
using the DescribeEventCategories action.
    
          
        
    • 
      
        
  • 
          :enabled
          (Boolean)
          
            
          
          
            — 
    A Boolean value; set to true to activate the subscription.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1094

    		
    
      
# File 'sig/client.rbs', line 1094

def modify_event_subscription: (

    		
  





    
      

  

  
    #modify_global_cluster(params = {})  ⇒ Types::ModifyGlobalClusterResult 
  

  

  




  

    
Modify a setting for an Amazon Neptune global cluster. You can change
one or more database configuration parameters by specifying these
parameters and their new values in the request.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.modify_global_cluster({
  global_cluster_identifier: "GlobalClusterIdentifier", # required
  new_global_cluster_identifier: "GlobalClusterIdentifier",
  deletion_protection: false,
  engine_version: "String",
  allow_major_version_upgrade: false,
})

    
      
        
Response structure

      
      

resp.global_cluster.global_cluster_identifier #=> String
resp.global_cluster.global_cluster_resource_id #=> String
resp.global_cluster.global_cluster_arn #=> String
resp.global_cluster.status #=> String
resp.global_cluster.engine #=> String
resp.global_cluster.engine_version #=> String
resp.global_cluster.database_name #=> String
resp.global_cluster.storage_encrypted #=> Boolean
resp.global_cluster.deletion_protection #=> Boolean
resp.global_cluster.global_cluster_members #=> Array
resp.global_cluster.global_cluster_members[0].db_cluster_arn #=> String
resp.global_cluster.global_cluster_members[0].readers #=> Array
resp.global_cluster.global_cluster_members[0].readers[0] #=> String
resp.global_cluster.global_cluster_members[0].is_writer #=> Boolean
resp.global_cluster.failover_state.status #=> String, one of "pending", "failing-over", "cancelling"
resp.global_cluster.failover_state.from_db_cluster_arn #=> String
resp.global_cluster.failover_state.to_db_cluster_arn #=> String
resp.global_cluster.failover_state.is_data_loss_allowed #=> Boolean
resp.global_cluster.tag_list #=> Array
resp.global_cluster.tag_list[0].key #=> String
resp.global_cluster.tag_list[0].value #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :global_cluster_identifier
          (required, String)
          
            
          
          
            — 
    The DB cluster identifier for the global cluster being modified. This
parameter is not case-sensitive.
    

    Constraints: Must match the identifier of an existing global database
cluster.
    
          
        
    • 
      
        
  • 
          :new_global_cluster_identifier
          (String)
          
            
          
          
            — 
    A new cluster identifier to assign to the global database. This value
is stored as a lowercase string.
    

    Constraints:
    

      

    • 

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

      • 

    • 

      The first character must be a letter.
      

      • 

    • 

      Can't end with a hyphen or contain two consecutive hyphens
      

      • 

    

    Example: my-cluster2
    
          
        
    • 
      
        
  • 
          :deletion_protection
          (Boolean)
          
            
          
          
            — 
    Indicates whether the global database has deletion protection enabled.
The global database cannot be deleted when deletion protection is
enabled.
    
          
        
    • 
      
        
  • 
          :engine_version
          (String)
          
            
          
          
            — 
    The version number of the database engine to which you want to
upgrade. Changing this parameter will result in an outage. The change
is applied during the next maintenance window unless
ApplyImmediately is enabled.
    

    To list all of the available Neptune engine versions, use the
following command:
    
          
        
    • 
      
        
  • 
          :allow_major_version_upgrade
          (Boolean)
          
            
          
          
            — 
    A value that indicates whether major version upgrades are allowed.
    

    Constraints: You must allow major version upgrades if you specify a
value for the EngineVersion parameter that is a different major
version than the DB cluster's current version.
    

    If you upgrade the major version of a global database, the cluster and
DB instance parameter groups are set to the default parameter groups
for the new version, so you will need to apply any custom parameter
groups after completing the upgrade.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1108

    		
    
      
# File 'sig/client.rbs', line 1108

def modify_global_cluster: (

    		
  





    
      

  

  
    #promote_read_replica_db_cluster(params = {})  ⇒ Types::PromoteReadReplicaDBClusterResult 
  

  

  




  

    
Not supported.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.promote_read_replica_db_cluster({
  db_cluster_identifier: "String", # required
})

    
      
        
Response structure

      
      

resp.db_cluster.allocated_storage #=> Integer
resp.db_cluster.availability_zones #=> Array
resp.db_cluster.availability_zones[0] #=> String
resp.db_cluster.backup_retention_period #=> Integer
resp.db_cluster.character_set_name #=> String
resp.db_cluster.database_name #=> String
resp.db_cluster.db_cluster_identifier #=> String
resp.db_cluster.db_cluster_parameter_group #=> String
resp.db_cluster.db_subnet_group #=> String
resp.db_cluster.status #=> String
resp.db_cluster.percent_progress #=> String
resp.db_cluster.earliest_restorable_time #=> Time
resp.db_cluster.endpoint #=> String
resp.db_cluster.reader_endpoint #=> String
resp.db_cluster.multi_az #=> Boolean
resp.db_cluster.engine #=> String
resp.db_cluster.engine_version #=> String
resp.db_cluster.latest_restorable_time #=> Time
resp.db_cluster.port #=> Integer
resp.db_cluster.master_username #=> String
resp.db_cluster.db_cluster_option_group_memberships #=> Array
resp.db_cluster.db_cluster_option_group_memberships[0].db_cluster_option_group_name #=> String
resp.db_cluster.db_cluster_option_group_memberships[0].status #=> String
resp.db_cluster.preferred_backup_window #=> String
resp.db_cluster.preferred_maintenance_window #=> String
resp.db_cluster.replication_source_identifier #=> String
resp.db_cluster.read_replica_identifiers #=> Array
resp.db_cluster.read_replica_identifiers[0] #=> String
resp.db_cluster.db_cluster_members #=> Array
resp.db_cluster.db_cluster_members[0].db_instance_identifier #=> String
resp.db_cluster.db_cluster_members[0].is_cluster_writer #=> Boolean
resp.db_cluster.db_cluster_members[0].db_cluster_parameter_group_status #=> String
resp.db_cluster.db_cluster_members[0].promotion_tier #=> Integer
resp.db_cluster.vpc_security_groups #=> Array
resp.db_cluster.vpc_security_groups[0].vpc_security_group_id #=> String
resp.db_cluster.vpc_security_groups[0].status #=> String
resp.db_cluster.hosted_zone_id #=> String
resp.db_cluster.storage_encrypted #=> Boolean
resp.db_cluster.kms_key_id #=> String
resp.db_cluster.db_cluster_resource_id #=> String
resp.db_cluster.db_cluster_arn #=> String
resp.db_cluster.associated_roles #=> Array
resp.db_cluster.associated_roles[0].role_arn #=> String
resp.db_cluster.associated_roles[0].status #=> String
resp.db_cluster.associated_roles[0].feature_name #=> String
resp.db_cluster.iam_database_authentication_enabled #=> Boolean
resp.db_cluster.clone_group_id #=> String
resp.db_cluster.cluster_create_time #=> Time
resp.db_cluster.copy_tags_to_snapshot #=> Boolean
resp.db_cluster.enabled_cloudwatch_logs_exports #=> Array
resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String
resp.db_cluster.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_enable #=> Array
resp.db_cluster.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_enable[0] #=> String
resp.db_cluster.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_disable #=> Array
resp.db_cluster.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_disable[0] #=> String
resp.db_cluster.pending_modified_values.db_cluster_identifier #=> String
resp.db_cluster.pending_modified_values.iam_database_authentication_enabled #=> Boolean
resp.db_cluster.pending_modified_values.engine_version #=> String
resp.db_cluster.pending_modified_values.backup_retention_period #=> Integer
resp.db_cluster.pending_modified_values.storage_type #=> String
resp.db_cluster.pending_modified_values.allocated_storage #=> Integer
resp.db_cluster.pending_modified_values.iops #=> Integer
resp.db_cluster.pending_modified_values.network_type #=> String
resp.db_cluster.deletion_protection #=> Boolean
resp.db_cluster. #=> Boolean
resp.db_cluster.automatic_restart_time #=> Time
resp.db_cluster.serverless_v2_scaling_configuration.min_capacity #=> Float
resp.db_cluster.serverless_v2_scaling_configuration.max_capacity #=> Float
resp.db_cluster.global_cluster_identifier #=> String
resp.db_cluster.io_optimized_next_allowed_modification_time #=> Time
resp.db_cluster.storage_type #=> String
resp.db_cluster.network_type #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :db_cluster_identifier
          (required, String)
          
            
          
          
            — 
    Not supported.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1122

    		
    
      
# File 'sig/client.rbs', line 1122

def promote_read_replica_db_cluster: (

    		
  





    
      

  

  
    #reboot_db_instance(params = {})  ⇒ Types::RebootDBInstanceResult 
  

  

  




  

    
You might need to reboot your DB instance, usually for maintenance
reasons. For example, if you make certain modifications, or if you
change the DB parameter group associated with the DB instance, you
must reboot the instance for the changes to take effect.


Rebooting a DB instance restarts the database engine service.
Rebooting a DB instance results in a momentary outage, during which
the DB instance status is set to rebooting.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.reboot_db_instance({
  db_instance_identifier: "String", # required
  force_failover: false,
})

    
      
        
Response structure

      
      

resp.db_instance.db_instance_identifier #=> String
resp.db_instance.db_instance_class #=> String
resp.db_instance.engine #=> String
resp.db_instance.db_instance_status #=> String
resp.db_instance.master_username #=> String
resp.db_instance.db_name #=> String
resp.db_instance.endpoint.address #=> String
resp.db_instance.endpoint.port #=> Integer
resp.db_instance.endpoint.hosted_zone_id #=> String
resp.db_instance.allocated_storage #=> Integer
resp.db_instance.instance_create_time #=> Time
resp.db_instance.preferred_backup_window #=> String
resp.db_instance.backup_retention_period #=> Integer
resp.db_instance.db_security_groups #=> Array
resp.db_instance.db_security_groups[0].db_security_group_name #=> String
resp.db_instance.db_security_groups[0].status #=> String
resp.db_instance.vpc_security_groups #=> Array
resp.db_instance.vpc_security_groups[0].vpc_security_group_id #=> String
resp.db_instance.vpc_security_groups[0].status #=> String
resp.db_instance.db_parameter_groups #=> Array
resp.db_instance.db_parameter_groups[0].db_parameter_group_name #=> String
resp.db_instance.db_parameter_groups[0].parameter_apply_status #=> String
resp.db_instance.availability_zone #=> String
resp.db_instance.db_subnet_group.db_subnet_group_name #=> String
resp.db_instance.db_subnet_group.db_subnet_group_description #=> String
resp.db_instance.db_subnet_group.vpc_id #=> String
resp.db_instance.db_subnet_group.subnet_group_status #=> String
resp.db_instance.db_subnet_group.subnets #=> Array
resp.db_instance.db_subnet_group.subnets[0].subnet_identifier #=> String
resp.db_instance.db_subnet_group.subnets[0].subnet_availability_zone.name #=> String
resp.db_instance.db_subnet_group.subnets[0].subnet_status #=> String
resp.db_instance.db_subnet_group.db_subnet_group_arn #=> String
resp.db_instance.db_subnet_group.supported_network_types #=> Array
resp.db_instance.db_subnet_group.supported_network_types[0] #=> String
resp.db_instance.preferred_maintenance_window #=> String
resp.db_instance.pending_modified_values.db_instance_class #=> String
resp.db_instance.pending_modified_values.allocated_storage #=> Integer
resp.db_instance.pending_modified_values.master_user_password #=> String
resp.db_instance.pending_modified_values.port #=> Integer
resp.db_instance.pending_modified_values.backup_retention_period #=> Integer
resp.db_instance.pending_modified_values.multi_az #=> Boolean
resp.db_instance.pending_modified_values.engine_version #=> String
resp.db_instance.pending_modified_values.license_model #=> String
resp.db_instance.pending_modified_values.iops #=> Integer
resp.db_instance.pending_modified_values.db_instance_identifier #=> String
resp.db_instance.pending_modified_values.storage_type #=> String
resp.db_instance.pending_modified_values.ca_certificate_identifier #=> String
resp.db_instance.pending_modified_values.db_subnet_group_name #=> String
resp.db_instance.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_enable #=> Array
resp.db_instance.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_enable[0] #=> String
resp.db_instance.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_disable #=> Array
resp.db_instance.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_disable[0] #=> String
resp.db_instance.latest_restorable_time #=> Time
resp.db_instance.multi_az #=> Boolean
resp.db_instance.engine_version #=> String
resp.db_instance.auto_minor_version_upgrade #=> Boolean
resp.db_instance.read_replica_source_db_instance_identifier #=> String
resp.db_instance.read_replica_db_instance_identifiers #=> Array
resp.db_instance.read_replica_db_instance_identifiers[0] #=> String
resp.db_instance.read_replica_db_cluster_identifiers #=> Array
resp.db_instance.read_replica_db_cluster_identifiers[0] #=> String
resp.db_instance.license_model #=> String
resp.db_instance.iops #=> Integer
resp.db_instance.option_group_memberships #=> Array
resp.db_instance.option_group_memberships[0].option_group_name #=> String
resp.db_instance.option_group_memberships[0].status #=> String
resp.db_instance.character_set_name #=> String
resp.db_instance.secondary_availability_zone #=> String
resp.db_instance.publicly_accessible #=> Boolean
resp.db_instance.status_infos #=> Array
resp.db_instance.status_infos[0].status_type #=> String
resp.db_instance.status_infos[0].normal #=> Boolean
resp.db_instance.status_infos[0].status #=> String
resp.db_instance.status_infos[0].message #=> String
resp.db_instance.storage_type #=> String
resp.db_instance.tde_credential_arn #=> String
resp.db_instance.db_instance_port #=> Integer
resp.db_instance.db_cluster_identifier #=> String
resp.db_instance.storage_encrypted #=> Boolean
resp.db_instance.kms_key_id #=> String
resp.db_instance.dbi_resource_id #=> String
resp.db_instance.ca_certificate_identifier #=> String
resp.db_instance.domain_memberships #=> Array
resp.db_instance.domain_memberships[0].domain #=> String
resp.db_instance.domain_memberships[0].status #=> String
resp.db_instance.domain_memberships[0].fqdn #=> String
resp.db_instance.domain_memberships[0].iam_role_name #=> String
resp.db_instance.copy_tags_to_snapshot #=> Boolean
resp.db_instance.monitoring_interval #=> Integer
resp.db_instance.enhanced_monitoring_resource_arn #=> String
resp.db_instance.monitoring_role_arn #=> String
resp.db_instance.promotion_tier #=> Integer
resp.db_instance.db_instance_arn #=> String
resp.db_instance.timezone #=> String
resp.db_instance.iam_database_authentication_enabled #=> Boolean
resp.db_instance.performance_insights_enabled #=> Boolean
resp.db_instance.performance_insights_kms_key_id #=> String
resp.db_instance.enabled_cloudwatch_logs_exports #=> Array
resp.db_instance.enabled_cloudwatch_logs_exports[0] #=> String
resp.db_instance.deletion_protection #=> Boolean
resp.db_instance.network_type #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :db_instance_identifier
          (required, String)
          
            
          
          
            — 
    The DB instance identifier. This parameter is stored as a lowercase
string.
    

    Constraints:
    

      

    • Must match the identifier of an existing DBInstance.
      • 

    

    ^
    
          
        
    • 
      
        
  • 
          :force_failover
          (Boolean)
          
            
          
          
            — 
    When true, the reboot is conducted through a MultiAZ failover.
    

    Constraint: You can't specify true if the instance is not
configured for MultiAZ.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1132

    		
    
      
# File 'sig/client.rbs', line 1132

def reboot_db_instance: (

    		
  





    
      

  

  
    #remove_from_global_cluster(params = {})  ⇒ Types::RemoveFromGlobalClusterResult 
  

  

  




  

    
Detaches a Neptune DB cluster from a Neptune global database. A
secondary cluster becomes a normal standalone cluster with read-write
capability instead of being read-only, and no longer receives data
from the primary cluster.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.remove_from_global_cluster({
  global_cluster_identifier: "GlobalClusterIdentifier", # required
  db_cluster_identifier: "String", # required
})

    
      
        
Response structure

      
      

resp.global_cluster.global_cluster_identifier #=> String
resp.global_cluster.global_cluster_resource_id #=> String
resp.global_cluster.global_cluster_arn #=> String
resp.global_cluster.status #=> String
resp.global_cluster.engine #=> String
resp.global_cluster.engine_version #=> String
resp.global_cluster.database_name #=> String
resp.global_cluster.storage_encrypted #=> Boolean
resp.global_cluster.deletion_protection #=> Boolean
resp.global_cluster.global_cluster_members #=> Array
resp.global_cluster.global_cluster_members[0].db_cluster_arn #=> String
resp.global_cluster.global_cluster_members[0].readers #=> Array
resp.global_cluster.global_cluster_members[0].readers[0] #=> String
resp.global_cluster.global_cluster_members[0].is_writer #=> Boolean
resp.global_cluster.failover_state.status #=> String, one of "pending", "failing-over", "cancelling"
resp.global_cluster.failover_state.from_db_cluster_arn #=> String
resp.global_cluster.failover_state.to_db_cluster_arn #=> String
resp.global_cluster.failover_state.is_data_loss_allowed #=> Boolean
resp.global_cluster.tag_list #=> Array
resp.global_cluster.tag_list[0].key #=> String
resp.global_cluster.tag_list[0].value #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :global_cluster_identifier
          (required, String)
          
            
          
          
            — 
    The identifier of the Neptune global database from which to detach the
specified Neptune DB cluster.
    
          
        
    • 
      
        
  • 
          :db_cluster_identifier
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) identifying the cluster to be detached
from the Neptune global database cluster.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1143

    		
    
      
# File 'sig/client.rbs', line 1143

def remove_from_global_cluster: (

    		
  





    
      

  

  
    #remove_role_from_db_cluster(params = {})  ⇒ Struct 
  

  

  




  

    
Disassociates an Identity and Access Management (IAM) role from a DB
cluster.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.remove_role_from_db_cluster({
  db_cluster_identifier: "String", # required
  role_arn: "String", # required
  feature_name: "String",
})

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :db_cluster_identifier
          (required, String)
          
            
          
          
            — 
    The name of the DB cluster to disassociate the IAM role from.
    
          
        
    • 
      
        
  • 
          :role_arn
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the IAM role to disassociate from
the DB cluster, for example
arn:aws:iam::123456789012:role/NeptuneAccessRole.
    
          
        
    • 
      
        
  • 
          :feature_name
          (String)
          
            
          
          
            — 
    The name of the feature for the DB cluster that the IAM role is to be
disassociated from. For the list of supported feature names, see
DescribeDBEngineVersions.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
        (Struct)
      
      
      
        —
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


1150

    		
    
      
# File 'sig/client.rbs', line 1150

def remove_role_from_db_cluster: (

    		
  





    
      

  

  
    #remove_source_identifier_from_subscription(params = {})  ⇒ Types::RemoveSourceIdentifierFromSubscriptionResult 
  

  

  




  

    
Removes a source identifier from an existing event notification
subscription.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.remove_source_identifier_from_subscription({
  subscription_name: "String", # required
  source_identifier: "String", # required
})

    
      
        
Response structure

      
      

resp.event_subscription.customer_aws_id #=> String
resp.event_subscription.cust_subscription_id #=> String
resp.event_subscription.sns_topic_arn #=> String
resp.event_subscription.status #=> String
resp.event_subscription.subscription_creation_time #=> String
resp.event_subscription.source_type #=> String
resp.event_subscription.source_ids_list #=> Array
resp.event_subscription.source_ids_list[0] #=> String
resp.event_subscription.event_categories_list #=> Array
resp.event_subscription.event_categories_list[0] #=> String
resp.event_subscription.enabled #=> Boolean
resp.event_subscription.event_subscription_arn #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :subscription_name
          (required, String)
          
            
          
          
            — 
    The name of the event notification subscription you want to remove a
source identifier from.
    
          
        
    • 
      
        
  • 
          :source_identifier
          (required, String)
          
            
          
          
            — 
    The source identifier to be removed from the subscription, such as the
DB instance identifier for a DB instance or the name of a security
group.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1162

    		
    
      
# File 'sig/client.rbs', line 1162

def remove_source_identifier_from_subscription: (

    		
  





    
      

  

  
    #remove_tags_from_resource(params = {})  ⇒ Struct 
  

  

  




  

    
Removes metadata tags from an Amazon Neptune resource.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

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

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :resource_name
          (required, String)
          
            
          
          
            — 
    The Amazon Neptune resource that the tags are removed from. This value
is an Amazon Resource Name (ARN). For information about creating an
ARN, see  Constructing an Amazon Resource Name (ARN).
    
          
        
    • 
      
        
  • 
          :tag_keys
          (required, Array<String>)
          
            
          
          
            — 
    The tag key (name) of the tag to be removed.
    
          
        
    • 
      
    

  
    
    


Returns:


    
  
    
  • 
      
      
        (Struct)
      
      
      
        —
        
    Returns an empty response.
    
      
    
    • 
  



  
See Also:

  



  

    
      


1169

    		
    
      
# File 'sig/client.rbs', line 1169

def remove_tags_from_resource: (

    		
  





    
      

  

  
    #reset_db_cluster_parameter_group(params = {})  ⇒ Types::DBClusterParameterGroupNameMessage 
  

  

  




  

    
Modifies the parameters of a DB cluster parameter group to the default
value. To reset specific parameters submit a list of the following:
ParameterName and ApplyMethod. To reset the entire DB cluster
parameter group, specify the DBClusterParameterGroupName and
ResetAllParameters parameters.


When resetting the entire group, dynamic parameters are updated
immediately and static parameters are set to pending-reboot to take
effect on the next DB instance restart or RebootDBInstance request.
You must call RebootDBInstance for every DB instance in your DB
cluster that you want the updated static parameter to apply to.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.reset_db_cluster_parameter_group({
  db_cluster_parameter_group_name: "String", # required
  reset_all_parameters: false,
  parameters: [
    {
      parameter_name: "String",
      parameter_value: "String",
      description: "String",
      source: "String",
      apply_type: "String",
      data_type: "String",
      allowed_values: "String",
      is_modifiable: false,
      minimum_engine_version: "String",
      apply_method: "immediate", # accepts immediate, pending-reboot
    },
  ],
})

    
      
        
Response structure

      
      

resp.db_cluster_parameter_group_name #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :db_cluster_parameter_group_name
          (required, String)
          
            
          
          
            — 
    The name of the DB cluster parameter group to reset.
    
          
        
    • 
      
        
  • 
          :reset_all_parameters
          (Boolean)
          
            
          
          
            — 
    A value that is set to true to reset all parameters in the DB
cluster parameter group to their default values, and false
otherwise. You can't use this parameter if there is a list of
parameter names specified for the Parameters parameter.
    
          
        
    • 
      
        
  • 
          :parameters
          (Array<Types::Parameter>)
          
            
          
          
            — 
    A list of parameter names in the DB cluster parameter group to reset
to the default values. You can't use this parameter if the
ResetAllParameters parameter is set to true.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1180

    		
    
      
# File 'sig/client.rbs', line 1180

def reset_db_cluster_parameter_group: (

    		
  





    
      

  

  
    #reset_db_parameter_group(params = {})  ⇒ Types::DBParameterGroupNameMessage 
  

  

  




  

    
Modifies the parameters of a DB parameter group to the engine/system
default value. To reset specific parameters, provide a list of the
following: ParameterName and ApplyMethod. To reset the entire DB
parameter group, specify the DBParameterGroup name and
ResetAllParameters parameters. When resetting the entire group,
dynamic parameters are updated immediately and static parameters are
set to pending-reboot to take effect on the next DB instance restart
or RebootDBInstance request.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.reset_db_parameter_group({
  db_parameter_group_name: "String", # required
  reset_all_parameters: false,
  parameters: [
    {
      parameter_name: "String",
      parameter_value: "String",
      description: "String",
      source: "String",
      apply_type: "String",
      data_type: "String",
      allowed_values: "String",
      is_modifiable: false,
      minimum_engine_version: "String",
      apply_method: "immediate", # accepts immediate, pending-reboot
    },
  ],
})

    
      
        
Response structure

      
      

resp.db_parameter_group_name #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :db_parameter_group_name
          (required, String)
          
            
          
          
            — 
    The name of the DB parameter group.
    

    Constraints:
    

      

    • Must match the name of an existing DBParameterGroup.
      • 

    

    ^
    
          
        
    • 
      
        
  • 
          :reset_all_parameters
          (Boolean)
          
            
          
          
            — 
    Specifies whether (true) or not (false) to reset all parameters in
the DB parameter group to default values.
    

    Default: true
    
          
        
    • 
      
        
  • 
          :parameters
          (Array<Types::Parameter>)
          
            
          
          
            — 
    To reset the entire DB parameter group, specify the DBParameterGroup
name and ResetAllParameters parameters. To reset specific
parameters, provide a list of the following: ParameterName and
ApplyMethod. A maximum of 20 parameters can be modified in a single
request.
    

    Valid Values (for Apply method): pending-reboot
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1194

    		
    
      
# File 'sig/client.rbs', line 1194

def reset_db_parameter_group: (

    		
  





    
      

  

  
    #restore_db_cluster_from_snapshot(params = {})  ⇒ Types::RestoreDBClusterFromSnapshotResult 
  

  

  




  

    
Creates a new DB cluster from a DB snapshot or DB cluster snapshot.


If a DB snapshot is specified, the target DB cluster is created from
the source DB snapshot with a default configuration and default
security group.


If a DB cluster snapshot is specified, the target DB cluster is
created from the source DB cluster restore point with the same
configuration as the original source DB cluster, except that the new
DB cluster is created with the default security group.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.restore_db_cluster_from_snapshot({
  availability_zones: ["String"],
  db_cluster_identifier: "String", # required
  snapshot_identifier: "String", # required
  engine: "String", # required
  engine_version: "String",
  port: 1,
  db_subnet_group_name: "String",
  database_name: "String",
  option_group_name: "String",
  vpc_security_group_ids: ["String"],
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
  kms_key_id: "String",
  enable_iam_database_authentication: false,
  enable_cloudwatch_logs_exports: ["String"],
  db_cluster_parameter_group_name: "String",
  deletion_protection: false,
  copy_tags_to_snapshot: false,
  serverless_v2_scaling_configuration: {
    min_capacity: 1.0,
    max_capacity: 1.0,
  },
  storage_type: "String",
  network_type: "String",
})

    
      
        
Response structure

      
      

resp.db_cluster.allocated_storage #=> Integer
resp.db_cluster.availability_zones #=> Array
resp.db_cluster.availability_zones[0] #=> String
resp.db_cluster.backup_retention_period #=> Integer
resp.db_cluster.character_set_name #=> String
resp.db_cluster.database_name #=> String
resp.db_cluster.db_cluster_identifier #=> String
resp.db_cluster.db_cluster_parameter_group #=> String
resp.db_cluster.db_subnet_group #=> String
resp.db_cluster.status #=> String
resp.db_cluster.percent_progress #=> String
resp.db_cluster.earliest_restorable_time #=> Time
resp.db_cluster.endpoint #=> String
resp.db_cluster.reader_endpoint #=> String
resp.db_cluster.multi_az #=> Boolean
resp.db_cluster.engine #=> String
resp.db_cluster.engine_version #=> String
resp.db_cluster.latest_restorable_time #=> Time
resp.db_cluster.port #=> Integer
resp.db_cluster.master_username #=> String
resp.db_cluster.db_cluster_option_group_memberships #=> Array
resp.db_cluster.db_cluster_option_group_memberships[0].db_cluster_option_group_name #=> String
resp.db_cluster.db_cluster_option_group_memberships[0].status #=> String
resp.db_cluster.preferred_backup_window #=> String
resp.db_cluster.preferred_maintenance_window #=> String
resp.db_cluster.replication_source_identifier #=> String
resp.db_cluster.read_replica_identifiers #=> Array
resp.db_cluster.read_replica_identifiers[0] #=> String
resp.db_cluster.db_cluster_members #=> Array
resp.db_cluster.db_cluster_members[0].db_instance_identifier #=> String
resp.db_cluster.db_cluster_members[0].is_cluster_writer #=> Boolean
resp.db_cluster.db_cluster_members[0].db_cluster_parameter_group_status #=> String
resp.db_cluster.db_cluster_members[0].promotion_tier #=> Integer
resp.db_cluster.vpc_security_groups #=> Array
resp.db_cluster.vpc_security_groups[0].vpc_security_group_id #=> String
resp.db_cluster.vpc_security_groups[0].status #=> String
resp.db_cluster.hosted_zone_id #=> String
resp.db_cluster.storage_encrypted #=> Boolean
resp.db_cluster.kms_key_id #=> String
resp.db_cluster.db_cluster_resource_id #=> String
resp.db_cluster.db_cluster_arn #=> String
resp.db_cluster.associated_roles #=> Array
resp.db_cluster.associated_roles[0].role_arn #=> String
resp.db_cluster.associated_roles[0].status #=> String
resp.db_cluster.associated_roles[0].feature_name #=> String
resp.db_cluster.iam_database_authentication_enabled #=> Boolean
resp.db_cluster.clone_group_id #=> String
resp.db_cluster.cluster_create_time #=> Time
resp.db_cluster.copy_tags_to_snapshot #=> Boolean
resp.db_cluster.enabled_cloudwatch_logs_exports #=> Array
resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String
resp.db_cluster.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_enable #=> Array
resp.db_cluster.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_enable[0] #=> String
resp.db_cluster.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_disable #=> Array
resp.db_cluster.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_disable[0] #=> String
resp.db_cluster.pending_modified_values.db_cluster_identifier #=> String
resp.db_cluster.pending_modified_values.iam_database_authentication_enabled #=> Boolean
resp.db_cluster.pending_modified_values.engine_version #=> String
resp.db_cluster.pending_modified_values.backup_retention_period #=> Integer
resp.db_cluster.pending_modified_values.storage_type #=> String
resp.db_cluster.pending_modified_values.allocated_storage #=> Integer
resp.db_cluster.pending_modified_values.iops #=> Integer
resp.db_cluster.pending_modified_values.network_type #=> String
resp.db_cluster.deletion_protection #=> Boolean
resp.db_cluster. #=> Boolean
resp.db_cluster.automatic_restart_time #=> Time
resp.db_cluster.serverless_v2_scaling_configuration.min_capacity #=> Float
resp.db_cluster.serverless_v2_scaling_configuration.max_capacity #=> Float
resp.db_cluster.global_cluster_identifier #=> String
resp.db_cluster.io_optimized_next_allowed_modification_time #=> Time
resp.db_cluster.storage_type #=> String
resp.db_cluster.network_type #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :availability_zones
          (Array<String>)
          
            
          
          
            — 
    Provides the list of EC2 Availability Zones that instances in the
restored DB cluster can be created in.
    
          
        
    • 
      
        
  • 
          :db_cluster_identifier
          (required, String)
          
            
          
          
            — 
    The name of the DB cluster to create from the DB snapshot or DB
cluster snapshot. This parameter isn't case-sensitive.
    

    Constraints:
    

      

    • 

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

      • 

    • 

      First character must be a letter
      

      • 

    • 

      Cannot end with a hyphen or contain two consecutive hyphens
      

      • 

    

    Example: my-snapshot-id
    
          
        
    • 
      
        
  • 
          :snapshot_identifier
          (required, String)
          
            
          
          
            — 
    The identifier for the DB snapshot or DB cluster snapshot to restore
from.
    

    You can use either the name or the Amazon Resource Name (ARN) to
specify a DB cluster snapshot. However, you can use only the ARN to
specify a DB snapshot.
    

    Constraints:
    

      

    • Must match the identifier of an existing Snapshot.
      • 

    

    ^
    
          
        
    • 
      
        
  • 
          :engine
          (required, String)
          
            
          
          
            — 
    The database engine to use for the new DB cluster.
    

    Default: The same as source
    

    Constraint: Must be compatible with the engine of the source
    
          
        
    • 
      
        
  • 
          :engine_version
          (String)
          
            
          
          
            — 
    The version of the database engine to use for the new DB cluster.
    
          
        
    • 
      
        
  • 
          :port
          (Integer)
          
            
          
          
            — 
    The port number on which the new DB cluster accepts connections.
    

    Constraints: Value must be 1150-65535
    

    Default: The same port as the original DB cluster.
    
          
        
    • 
      
        
  • 
          :db_subnet_group_name
          (String)
          
            
          
          
            — 
    The name of the DB subnet group to use for the new DB cluster.
    

    Constraints: If supplied, must match the name of an existing
DBSubnetGroup.
    

    Example: mySubnetgroup
    
          
        
    • 
      
        
  • 
          :database_name
          (String)
          
            
          
          
            — 
    Not supported.
    
          
        
    • 
      
        
  • 
          :option_group_name
          (String)
          
            
          
          
            — 
    (Not supported by Neptune)
    
          
        
    • 
      
        
  • 
          :vpc_security_group_ids
          (Array<String>)
          
            
          
          
            — 
    A list of VPC security groups that the new DB cluster will belong to.
    
          
        
    • 
      
        
  • 
          :tags
          (Array<Types::Tag>)
          
            
          
          
            — 
    The tags to be assigned to the restored DB cluster.
    
          
        
    • 
      
        
  • 
          :kms_key_id
          (String)
          
            
          
          
            — 
    The Amazon KMS key identifier to use when restoring an encrypted DB
cluster from a DB snapshot or DB cluster snapshot.
    

    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
encryption key. If you are restoring a DB cluster with the same Amazon
account that owns the KMS encryption key used to encrypt the new DB
cluster, then you can use the KMS key alias instead of the ARN for the
KMS encryption key.
    

    If you do not specify a value for the KmsKeyId parameter, then the
following will occur:
    

      

    • 

      If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is
encrypted, then the restored DB cluster is encrypted using the KMS
key that was used to encrypt the DB snapshot or DB cluster snapshot.
      

      • 

    • 

      If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is
not encrypted, then the restored DB cluster is not encrypted.
      

      • 

    
          
        
    • 
      
        
  • 
          :enable_iam_database_authentication
          (Boolean)
          
            
          
          
            — 
    True to enable mapping of Amazon Identity and Access Management (IAM)
accounts to database accounts, and otherwise false.
    

    Default: false
    
          
        
    • 
      
        
  • 
          :enable_cloudwatch_logs_exports
          (Array<String>)
          
            
          
          
            — 
    The list of logs that the restored DB cluster is to export to Amazon
CloudWatch Logs.
    
          
        
    • 
      
        
  • 
          :db_cluster_parameter_group_name
          (String)
          
            
          
          
            — 
    The name of the DB cluster parameter group to associate with the new
DB cluster.
    

    Constraints:
    

      

    • If supplied, must match the name of an existing
DBClusterParameterGroup.
      • 

    

    ^
    
          
        
    • 
      
        
  • 
          :deletion_protection
          (Boolean)
          
            
          
          
            — 
    A value that indicates whether the DB cluster has deletion protection
enabled. The database can't be deleted when deletion protection is
enabled. By default, deletion protection is disabled.
    
          
        
    • 
      
        
  • 
          :copy_tags_to_snapshot
          (Boolean)
          
            
          
          
            — 
    If set to true, tags are copied to any snapshot of the restored DB
cluster that is created.
    
          
        
    • 
      
        
  • 
          :serverless_v2_scaling_configuration
          (Types::ServerlessV2ScalingConfiguration)
          
            
          
          
            — 
    Contains the scaling configuration of a Neptune Serverless DB cluster.
    

    For more information, see Using Amazon Neptune Serverless in the
Amazon Neptune User Guide.
    
          
        
    • 
      
        
  • 
          :storage_type
          (String)
          
            
          
          
            — 
    Specifies the storage type to be associated with the DB cluster.
    

    Valid values: standard, iopt1
    

    Default: standard
    
          
        
    • 
      
        
  • 
          :network_type
          (String)
          
            
          
          
            — 
    The network type of the DB cluster.
    

    Valid Values:
    

      

    • 

       IPV4    –   ( the default ) The DB cluster
uses only IPv4 addresses for communication.
      

      • 

    • 

       DUAL    –   The DB cluster uses both IPv4 and
IPv6 addresses for communication. The DB subnet group associated
with the cluster must support IPv6.
      

      • 

    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1208

    		
    
      
# File 'sig/client.rbs', line 1208

def restore_db_cluster_from_snapshot: (

    		
  





    
      

  

  
    #restore_db_cluster_to_point_in_time(params = {})  ⇒ Types::RestoreDBClusterToPointInTimeResult 
  

  

  




  

    
Restores a DB cluster to an arbitrary point in time. Users can restore
to any point in time before LatestRestorableTime for up to
BackupRetentionPeriod days. The target DB cluster is created from
the source DB cluster with the same configuration as the original DB
cluster, except that the new DB cluster is created with the default DB
security group.


 This action only restores the DB cluster, not the DB instances for
that DB cluster. You must invoke the CreateDBInstance action to create
DB instances for the restored DB cluster, specifying the identifier of
the restored DB cluster in DBClusterIdentifier. You can create DB
instances only after the RestoreDBClusterToPointInTime action has
completed and the DB cluster is available.

 

  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.restore_db_cluster_to_point_in_time({
  db_cluster_identifier: "String", # required
  restore_type: "String",
  source_db_cluster_identifier: "String", # required
  restore_to_time: Time.now,
  use_latest_restorable_time: false,
  port: 1,
  db_subnet_group_name: "String",
  option_group_name: "String",
  vpc_security_group_ids: ["String"],
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
  kms_key_id: "String",
  enable_iam_database_authentication: false,
  enable_cloudwatch_logs_exports: ["String"],
  db_cluster_parameter_group_name: "String",
  deletion_protection: false,
  serverless_v2_scaling_configuration: {
    min_capacity: 1.0,
    max_capacity: 1.0,
  },
  storage_type: "String",
  network_type: "String",
})

    
      
        
Response structure

      
      

resp.db_cluster.allocated_storage #=> Integer
resp.db_cluster.availability_zones #=> Array
resp.db_cluster.availability_zones[0] #=> String
resp.db_cluster.backup_retention_period #=> Integer
resp.db_cluster.character_set_name #=> String
resp.db_cluster.database_name #=> String
resp.db_cluster.db_cluster_identifier #=> String
resp.db_cluster.db_cluster_parameter_group #=> String
resp.db_cluster.db_subnet_group #=> String
resp.db_cluster.status #=> String
resp.db_cluster.percent_progress #=> String
resp.db_cluster.earliest_restorable_time #=> Time
resp.db_cluster.endpoint #=> String
resp.db_cluster.reader_endpoint #=> String
resp.db_cluster.multi_az #=> Boolean
resp.db_cluster.engine #=> String
resp.db_cluster.engine_version #=> String
resp.db_cluster.latest_restorable_time #=> Time
resp.db_cluster.port #=> Integer
resp.db_cluster.master_username #=> String
resp.db_cluster.db_cluster_option_group_memberships #=> Array
resp.db_cluster.db_cluster_option_group_memberships[0].db_cluster_option_group_name #=> String
resp.db_cluster.db_cluster_option_group_memberships[0].status #=> String
resp.db_cluster.preferred_backup_window #=> String
resp.db_cluster.preferred_maintenance_window #=> String
resp.db_cluster.replication_source_identifier #=> String
resp.db_cluster.read_replica_identifiers #=> Array
resp.db_cluster.read_replica_identifiers[0] #=> String
resp.db_cluster.db_cluster_members #=> Array
resp.db_cluster.db_cluster_members[0].db_instance_identifier #=> String
resp.db_cluster.db_cluster_members[0].is_cluster_writer #=> Boolean
resp.db_cluster.db_cluster_members[0].db_cluster_parameter_group_status #=> String
resp.db_cluster.db_cluster_members[0].promotion_tier #=> Integer
resp.db_cluster.vpc_security_groups #=> Array
resp.db_cluster.vpc_security_groups[0].vpc_security_group_id #=> String
resp.db_cluster.vpc_security_groups[0].status #=> String
resp.db_cluster.hosted_zone_id #=> String
resp.db_cluster.storage_encrypted #=> Boolean
resp.db_cluster.kms_key_id #=> String
resp.db_cluster.db_cluster_resource_id #=> String
resp.db_cluster.db_cluster_arn #=> String
resp.db_cluster.associated_roles #=> Array
resp.db_cluster.associated_roles[0].role_arn #=> String
resp.db_cluster.associated_roles[0].status #=> String
resp.db_cluster.associated_roles[0].feature_name #=> String
resp.db_cluster.iam_database_authentication_enabled #=> Boolean
resp.db_cluster.clone_group_id #=> String
resp.db_cluster.cluster_create_time #=> Time
resp.db_cluster.copy_tags_to_snapshot #=> Boolean
resp.db_cluster.enabled_cloudwatch_logs_exports #=> Array
resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String
resp.db_cluster.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_enable #=> Array
resp.db_cluster.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_enable[0] #=> String
resp.db_cluster.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_disable #=> Array
resp.db_cluster.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_disable[0] #=> String
resp.db_cluster.pending_modified_values.db_cluster_identifier #=> String
resp.db_cluster.pending_modified_values.iam_database_authentication_enabled #=> Boolean
resp.db_cluster.pending_modified_values.engine_version #=> String
resp.db_cluster.pending_modified_values.backup_retention_period #=> Integer
resp.db_cluster.pending_modified_values.storage_type #=> String
resp.db_cluster.pending_modified_values.allocated_storage #=> Integer
resp.db_cluster.pending_modified_values.iops #=> Integer
resp.db_cluster.pending_modified_values.network_type #=> String
resp.db_cluster.deletion_protection #=> Boolean
resp.db_cluster. #=> Boolean
resp.db_cluster.automatic_restart_time #=> Time
resp.db_cluster.serverless_v2_scaling_configuration.min_capacity #=> Float
resp.db_cluster.serverless_v2_scaling_configuration.max_capacity #=> Float
resp.db_cluster.global_cluster_identifier #=> String
resp.db_cluster.io_optimized_next_allowed_modification_time #=> Time
resp.db_cluster.storage_type #=> String
resp.db_cluster.network_type #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :db_cluster_identifier
          (required, String)
          
            
          
          
            — 
    The name of the new DB cluster to be created.
    

    Constraints:
    

      

    • 

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

      • 

    • 

      First character must be a letter
      

      • 

    • 

      Cannot end with a hyphen or contain two consecutive hyphens
      

      • 

    
          
        
    • 
      
        
  • 
          :restore_type
          (String)
          
            
          
          
            — 
    The type of restore to be performed. You can specify one of the
following values:
    

      

    • 

      full-copy - The new DB cluster is restored as a full copy of the
source DB cluster.
      

      • 

    • 

      copy-on-write - The new DB cluster is restored as a clone of the
source DB cluster.
      

      • 

    

    If you don't specify a RestoreType value, then the new DB cluster
is restored as a full copy of the source DB cluster.
    
          
        
    • 
      
        
  • 
          :source_db_cluster_identifier
          (required, String)
          
            
          
          
            — 
    The identifier of the source DB cluster from which to restore.
    

    Constraints:
    

      

    • Must match the identifier of an existing DBCluster.
      • 

    

    ^
    
          
        
    • 
      
        
  • 
          :restore_to_time
          (Time, DateTime, Date, Integer, String)
          
            
          
          
            — 
    The date and time to restore the DB cluster to.
    

    Valid Values: Value must be a time in Universal Coordinated Time (UTC)
format
    

    Constraints:
    

      

    • 

      Must be before the latest restorable time for the DB instance
      

      • 

    • 

      Must be specified if UseLatestRestorableTime parameter is not
provided
      

      • 

    • 

      Cannot be specified if UseLatestRestorableTime parameter is true
      

      • 

    • 

      Cannot be specified if RestoreType parameter is copy-on-write
      

      • 

    

    Example: 2015-03-07T23:45:00Z
    
          
        
    • 
      
        
  • 
          :use_latest_restorable_time
          (Boolean)
          
            
          
          
            — 
    A value that is set to true to restore the DB cluster to the latest
restorable backup time, and false otherwise.
    

    Default: false
    

    Constraints: Cannot be specified if RestoreToTime parameter is
provided.
    
          
        
    • 
      
        
  • 
          :port
          (Integer)
          
            
          
          
            — 
    The port number on which the new DB cluster accepts connections.
    

    Constraints: Value must be 1150-65535
    

    Default: The same port as the original DB cluster.
    
          
        
    • 
      
        
  • 
          :db_subnet_group_name
          (String)
          
            
          
          
            — 
    The DB subnet group name to use for the new DB cluster.
    

    Constraints: If supplied, must match the name of an existing
DBSubnetGroup.
    

    Example: mySubnetgroup
    
          
        
    • 
      
        
  • 
          :option_group_name
          (String)
          
            
          
          
            — 
    (Not supported by Neptune)
    
          
        
    • 
      
        
  • 
          :vpc_security_group_ids
          (Array<String>)
          
            
          
          
            — 
    A list of VPC security groups that the new DB cluster belongs to.
    
          
        
    • 
      
        
  • 
          :tags
          (Array<Types::Tag>)
          
            
          
          
            — 
    The tags to be applied to the restored DB cluster.
    
          
        
    • 
      
        
  • 
          :kms_key_id
          (String)
          
            
          
          
            — 
    The Amazon KMS key identifier to use when restoring an encrypted DB
cluster from an encrypted DB cluster.
    

    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
encryption key. If you are restoring a DB cluster with the same Amazon
account that owns the KMS encryption key used to encrypt the new DB
cluster, then you can use the KMS key alias instead of the ARN for the
KMS encryption key.
    

    You can restore to a new DB cluster and encrypt the new DB cluster
with a KMS key that is different than the KMS key used to encrypt the
source DB cluster. The new DB cluster is encrypted with the KMS key
identified by the KmsKeyId parameter.
    

    If you do not specify a value for the KmsKeyId parameter, then the
following will occur:
    

      

    • 

      If the DB cluster is encrypted, then the restored DB cluster is
encrypted using the KMS key that was used to encrypt the source DB
cluster.
      

      • 

    • 

      If the DB cluster is not encrypted, then the restored DB cluster is
not encrypted.
      

      • 

    

    If DBClusterIdentifier refers to a DB cluster that is not encrypted,
then the restore request is rejected.
    
          
        
    • 
      
        
  • 
          :enable_iam_database_authentication
          (Boolean)
          
            
          
          
            — 
    True to enable mapping of Amazon Identity and Access Management (IAM)
accounts to database accounts, and otherwise false.
    

    Default: false
    
          
        
    • 
      
        
  • 
          :enable_cloudwatch_logs_exports
          (Array<String>)
          
            
          
          
            — 
    The list of logs that the restored DB cluster is to export to
CloudWatch Logs.
    
          
        
    • 
      
        
  • 
          :db_cluster_parameter_group_name
          (String)
          
            
          
          
            — 
    The name of the DB cluster parameter group to associate with the new
DB cluster.
    

    Constraints:
    

      

    • If supplied, must match the name of an existing
DBClusterParameterGroup.
      • 

    

    ^
    
          
        
    • 
      
        
  • 
          :deletion_protection
          (Boolean)
          
            
          
          
            — 
    A value that indicates whether the DB cluster has deletion protection
enabled. The database can't be deleted when deletion protection is
enabled. By default, deletion protection is disabled.
    
          
        
    • 
      
        
  • 
          :serverless_v2_scaling_configuration
          (Types::ServerlessV2ScalingConfiguration)
          
            
          
          
            — 
    Contains the scaling configuration of a Neptune Serverless DB cluster.
    

    For more information, see Using Amazon Neptune Serverless in the
Amazon Neptune User Guide.
    
          
        
    • 
      
        
  • 
          :storage_type
          (String)
          
            
          
          
            — 
    Specifies the storage type to be associated with the DB cluster.
    

    Valid values: standard, iopt1
    

    Default: standard
    
          
        
    • 
      
        
  • 
          :network_type
          (String)
          
            
          
          
            — 
    The network type of the DB cluster.
    

    Valid Values:
    

      

    • 

       IPV4    –   ( the default ) The DB cluster
uses only IPv4 addresses for communication.
      

      • 

    • 

       DUAL    –   The DB cluster uses both IPv4 and
IPv6 addresses for communication. The DB subnet group associated
with the cluster must support IPv6.
      

      • 

    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1245

    		
    
      
# File 'sig/client.rbs', line 1245

def restore_db_cluster_to_point_in_time: (

    		
  





    
      

  

  
    #start_db_cluster(params = {})  ⇒ Types::StartDBClusterResult 
  

  

  




  

    
Starts an Amazon Neptune DB cluster that was stopped using the Amazon
console, the Amazon CLI stop-db-cluster command, or the StopDBCluster
API.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.start_db_cluster({
  db_cluster_identifier: "String", # required
})

    
      
        
Response structure

      
      

resp.db_cluster.allocated_storage #=> Integer
resp.db_cluster.availability_zones #=> Array
resp.db_cluster.availability_zones[0] #=> String
resp.db_cluster.backup_retention_period #=> Integer
resp.db_cluster.character_set_name #=> String
resp.db_cluster.database_name #=> String
resp.db_cluster.db_cluster_identifier #=> String
resp.db_cluster.db_cluster_parameter_group #=> String
resp.db_cluster.db_subnet_group #=> String
resp.db_cluster.status #=> String
resp.db_cluster.percent_progress #=> String
resp.db_cluster.earliest_restorable_time #=> Time
resp.db_cluster.endpoint #=> String
resp.db_cluster.reader_endpoint #=> String
resp.db_cluster.multi_az #=> Boolean
resp.db_cluster.engine #=> String
resp.db_cluster.engine_version #=> String
resp.db_cluster.latest_restorable_time #=> Time
resp.db_cluster.port #=> Integer
resp.db_cluster.master_username #=> String
resp.db_cluster.db_cluster_option_group_memberships #=> Array
resp.db_cluster.db_cluster_option_group_memberships[0].db_cluster_option_group_name #=> String
resp.db_cluster.db_cluster_option_group_memberships[0].status #=> String
resp.db_cluster.preferred_backup_window #=> String
resp.db_cluster.preferred_maintenance_window #=> String
resp.db_cluster.replication_source_identifier #=> String
resp.db_cluster.read_replica_identifiers #=> Array
resp.db_cluster.read_replica_identifiers[0] #=> String
resp.db_cluster.db_cluster_members #=> Array
resp.db_cluster.db_cluster_members[0].db_instance_identifier #=> String
resp.db_cluster.db_cluster_members[0].is_cluster_writer #=> Boolean
resp.db_cluster.db_cluster_members[0].db_cluster_parameter_group_status #=> String
resp.db_cluster.db_cluster_members[0].promotion_tier #=> Integer
resp.db_cluster.vpc_security_groups #=> Array
resp.db_cluster.vpc_security_groups[0].vpc_security_group_id #=> String
resp.db_cluster.vpc_security_groups[0].status #=> String
resp.db_cluster.hosted_zone_id #=> String
resp.db_cluster.storage_encrypted #=> Boolean
resp.db_cluster.kms_key_id #=> String
resp.db_cluster.db_cluster_resource_id #=> String
resp.db_cluster.db_cluster_arn #=> String
resp.db_cluster.associated_roles #=> Array
resp.db_cluster.associated_roles[0].role_arn #=> String
resp.db_cluster.associated_roles[0].status #=> String
resp.db_cluster.associated_roles[0].feature_name #=> String
resp.db_cluster.iam_database_authentication_enabled #=> Boolean
resp.db_cluster.clone_group_id #=> String
resp.db_cluster.cluster_create_time #=> Time
resp.db_cluster.copy_tags_to_snapshot #=> Boolean
resp.db_cluster.enabled_cloudwatch_logs_exports #=> Array
resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String
resp.db_cluster.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_enable #=> Array
resp.db_cluster.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_enable[0] #=> String
resp.db_cluster.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_disable #=> Array
resp.db_cluster.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_disable[0] #=> String
resp.db_cluster.pending_modified_values.db_cluster_identifier #=> String
resp.db_cluster.pending_modified_values.iam_database_authentication_enabled #=> Boolean
resp.db_cluster.pending_modified_values.engine_version #=> String
resp.db_cluster.pending_modified_values.backup_retention_period #=> Integer
resp.db_cluster.pending_modified_values.storage_type #=> String
resp.db_cluster.pending_modified_values.allocated_storage #=> Integer
resp.db_cluster.pending_modified_values.iops #=> Integer
resp.db_cluster.pending_modified_values.network_type #=> String
resp.db_cluster.deletion_protection #=> Boolean
resp.db_cluster. #=> Boolean
resp.db_cluster.automatic_restart_time #=> Time
resp.db_cluster.serverless_v2_scaling_configuration.min_capacity #=> Float
resp.db_cluster.serverless_v2_scaling_configuration.max_capacity #=> Float
resp.db_cluster.global_cluster_identifier #=> String
resp.db_cluster.io_optimized_next_allowed_modification_time #=> Time
resp.db_cluster.storage_type #=> String
resp.db_cluster.network_type #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :db_cluster_identifier
          (required, String)
          
            
          
          
            — 
    The DB cluster identifier of the Neptune DB cluster to be started.
This parameter is stored as a lowercase string.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1280

    		
    
      
# File 'sig/client.rbs', line 1280

def start_db_cluster: (

    		
  





    
      

  

  
    #stop_db_cluster(params = {})  ⇒ Types::StopDBClusterResult 
  

  

  




  

    
Stops an Amazon Neptune DB cluster. When you stop a DB cluster,
Neptune retains the DB cluster's metadata, including its endpoints
and DB parameter groups.


Neptune also retains the transaction logs so you can do a
point-in-time restore if necessary.


  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.stop_db_cluster({
  db_cluster_identifier: "String", # required
})

    
      
        
Response structure

      
      

resp.db_cluster.allocated_storage #=> Integer
resp.db_cluster.availability_zones #=> Array
resp.db_cluster.availability_zones[0] #=> String
resp.db_cluster.backup_retention_period #=> Integer
resp.db_cluster.character_set_name #=> String
resp.db_cluster.database_name #=> String
resp.db_cluster.db_cluster_identifier #=> String
resp.db_cluster.db_cluster_parameter_group #=> String
resp.db_cluster.db_subnet_group #=> String
resp.db_cluster.status #=> String
resp.db_cluster.percent_progress #=> String
resp.db_cluster.earliest_restorable_time #=> Time
resp.db_cluster.endpoint #=> String
resp.db_cluster.reader_endpoint #=> String
resp.db_cluster.multi_az #=> Boolean
resp.db_cluster.engine #=> String
resp.db_cluster.engine_version #=> String
resp.db_cluster.latest_restorable_time #=> Time
resp.db_cluster.port #=> Integer
resp.db_cluster.master_username #=> String
resp.db_cluster.db_cluster_option_group_memberships #=> Array
resp.db_cluster.db_cluster_option_group_memberships[0].db_cluster_option_group_name #=> String
resp.db_cluster.db_cluster_option_group_memberships[0].status #=> String
resp.db_cluster.preferred_backup_window #=> String
resp.db_cluster.preferred_maintenance_window #=> String
resp.db_cluster.replication_source_identifier #=> String
resp.db_cluster.read_replica_identifiers #=> Array
resp.db_cluster.read_replica_identifiers[0] #=> String
resp.db_cluster.db_cluster_members #=> Array
resp.db_cluster.db_cluster_members[0].db_instance_identifier #=> String
resp.db_cluster.db_cluster_members[0].is_cluster_writer #=> Boolean
resp.db_cluster.db_cluster_members[0].db_cluster_parameter_group_status #=> String
resp.db_cluster.db_cluster_members[0].promotion_tier #=> Integer
resp.db_cluster.vpc_security_groups #=> Array
resp.db_cluster.vpc_security_groups[0].vpc_security_group_id #=> String
resp.db_cluster.vpc_security_groups[0].status #=> String
resp.db_cluster.hosted_zone_id #=> String
resp.db_cluster.storage_encrypted #=> Boolean
resp.db_cluster.kms_key_id #=> String
resp.db_cluster.db_cluster_resource_id #=> String
resp.db_cluster.db_cluster_arn #=> String
resp.db_cluster.associated_roles #=> Array
resp.db_cluster.associated_roles[0].role_arn #=> String
resp.db_cluster.associated_roles[0].status #=> String
resp.db_cluster.associated_roles[0].feature_name #=> String
resp.db_cluster.iam_database_authentication_enabled #=> Boolean
resp.db_cluster.clone_group_id #=> String
resp.db_cluster.cluster_create_time #=> Time
resp.db_cluster.copy_tags_to_snapshot #=> Boolean
resp.db_cluster.enabled_cloudwatch_logs_exports #=> Array
resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String
resp.db_cluster.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_enable #=> Array
resp.db_cluster.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_enable[0] #=> String
resp.db_cluster.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_disable #=> Array
resp.db_cluster.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_disable[0] #=> String
resp.db_cluster.pending_modified_values.db_cluster_identifier #=> String
resp.db_cluster.pending_modified_values.iam_database_authentication_enabled #=> Boolean
resp.db_cluster.pending_modified_values.engine_version #=> String
resp.db_cluster.pending_modified_values.backup_retention_period #=> Integer
resp.db_cluster.pending_modified_values.storage_type #=> String
resp.db_cluster.pending_modified_values.allocated_storage #=> Integer
resp.db_cluster.pending_modified_values.iops #=> Integer
resp.db_cluster.pending_modified_values.network_type #=> String
resp.db_cluster.deletion_protection #=> Boolean
resp.db_cluster. #=> Boolean
resp.db_cluster.automatic_restart_time #=> Time
resp.db_cluster.serverless_v2_scaling_configuration.min_capacity #=> Float
resp.db_cluster.serverless_v2_scaling_configuration.max_capacity #=> Float
resp.db_cluster.global_cluster_identifier #=> String
resp.db_cluster.io_optimized_next_allowed_modification_time #=> Time
resp.db_cluster.storage_type #=> String
resp.db_cluster.network_type #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :db_cluster_identifier
          (required, String)
          
            
          
          
            — 
    The DB cluster identifier of the Neptune DB cluster to be stopped.
This parameter is stored as a lowercase string.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1290

    		
    
      
# File 'sig/client.rbs', line 1290

def stop_db_cluster: (

    		
  





    
      

  

  
    #switchover_global_cluster(params = {})  ⇒ Types::SwitchoverGlobalClusterResult 
  

  

  




  

    
Switches over the specified secondary DB cluster to be the new primary
DB cluster in the global database cluster. Switchover operations were
previously called "managed planned failovers."


Promotes the specified secondary cluster to assume full read/write
capabilities and demotes the current primary cluster to a secondary
(read-only) cluster, maintaining the original replication topology.
All secondary clusters are synchronized with the primary at the
beginning of the process so the new primary continues operations for
the global database without losing any data. Your database is
unavailable for a short time while the primary and selected secondary
clusters are assuming their new roles.


 This operation is intended for controlled environments, for operations
such as "regional rotation" or to fall back to the original primary
after a global database failover.

 

  





  
  

    
Examples:

    
      
        
Request syntax with placeholder values

      
      

resp = client.switchover_global_cluster({
  global_cluster_identifier: "GlobalClusterIdentifier", # required
  target_db_cluster_identifier: "String", # required
})

    
      
        
Response structure

      
      

resp.global_cluster.global_cluster_identifier #=> String
resp.global_cluster.global_cluster_resource_id #=> String
resp.global_cluster.global_cluster_arn #=> String
resp.global_cluster.status #=> String
resp.global_cluster.engine #=> String
resp.global_cluster.engine_version #=> String
resp.global_cluster.database_name #=> String
resp.global_cluster.storage_encrypted #=> Boolean
resp.global_cluster.deletion_protection #=> Boolean
resp.global_cluster.global_cluster_members #=> Array
resp.global_cluster.global_cluster_members[0].db_cluster_arn #=> String
resp.global_cluster.global_cluster_members[0].readers #=> Array
resp.global_cluster.global_cluster_members[0].readers[0] #=> String
resp.global_cluster.global_cluster_members[0].is_writer #=> Boolean
resp.global_cluster.failover_state.status #=> String, one of "pending", "failing-over", "cancelling"
resp.global_cluster.failover_state.from_db_cluster_arn #=> String
resp.global_cluster.failover_state.to_db_cluster_arn #=> String
resp.global_cluster.failover_state.is_data_loss_allowed #=> Boolean
resp.global_cluster.tag_list #=> Array
resp.global_cluster.tag_list[0].key #=> String
resp.global_cluster.tag_list[0].value #=> String

    
  


  

Parameters:


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



  
    
    
    
Options Hash (params):

    
    
      
        
  • 
          :global_cluster_identifier
          (required, String)
          
            
          
          
            — 
    The identifier of the global database cluster to switch over. This
parameter isn't case-sensitive.
    

    Constraints: Must match the identifier of an existing global database
cluster.
    
          
        
    • 
      
        
  • 
          :target_db_cluster_identifier
          (required, String)
          
            
          
          
            — 
    The Amazon Resource Name (ARN) of the secondary Neptune DB cluster
that you want to promote to primary for the global database.
    
          
        
    • 
      
    

  
    
    


Returns:



  
See Also:

  



  

    
      


1300

    		
    
      
# File 'sig/client.rbs', line 1300

def switchover_global_cluster: (

    		
  





    
      

  

  
    #wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean 
  

  

  




  

    
Polls an API operation until a resource enters a desired state.


Basic Usage


A waiter will call an API operation until:


    

  • It is successful
    • 

  • It enters a terminal state
    • 

  • It makes the maximum number of attempts
    • 



In between attempts, the waiter will sleep.


# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)



Configuration


You can configure the maximum number of polling attempts, and the
delay (in seconds) between each polling attempt. You can pass
configuration as the final arguments hash.


# poll for ~25 seconds
client.wait_until(waiter_name, params, {
  max_attempts: 5,
  delay: 5,
})



Callbacks


You can be notified before each polling attempt and before each
delay. If you throw :success or :failure from these callbacks,
it will terminate the waiter.


started_at = Time.now
client.wait_until(waiter_name, params, {

  # disable max attempts
  max_attempts: nil,

  # poll for 1 hour, instead of a number of attempts
  before_wait: -> (attempts, response) do
    throw :failure if Time.now - started_at > 3600
  end
})



Handling Errors


When a waiter is unsuccessful, it will raise an error.
All of the failure errors extend from
Waiters::Errors::WaiterFailed.


begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end



Valid Waiters


The following table lists the valid waiter names, the operations they call,
and the default :delay and :max_attempts values.






waiter_name
params
:delay
:max_attempts






db_instance_available
#describe_db_instances
30
60




db_instance_deleted
#describe_db_instances
30
60






  





  
Parameters:


    
  
    
  • 
      
        waiter_name
      
      
        (Symbol)
      
      
      
    
    • 
  
    
  • 
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  
    
  • 
      
        options
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        
    ({})
    
      
    
    • 
  



  
    
    
    
    
    
    
    
Options Hash (options):

    
    
      
        
  • 
          :max_attempts
          (Integer)
          
            
          
          
        
    • 
      
        
  • 
          :delay
          (Integer)
          
            
          
          
        
    • 
      
        
  • 
          :before_attempt
          (Proc)
          
            
          
          
        
    • 
      
        
  • 
          :before_wait
          (Proc)
          
            
          
          
        
    • 
      
    

  


Yields:


    
  
    
  • 
      
      
        (w.waiter)
      
      
      
    
    • 
  



Returns:


    
  
    
  • 
      
      
        (Boolean)
      
      
      
        —
        
    Returns true if the waiter was successful.
    
      
    
    • 
  



Raises:


    
  
    
  • 
      
      
        (Errors::FailureStateError)
      
      
      
        —
        
    Raised when the waiter terminates
because the waiter has entered a state that it will not transition
out of, preventing success.
    
      
    
    • 
  
    
  • 
      
      
        (Errors::TooManyAttemptsError)
      
      
      
        —
        
    Raised when the configured
maximum number of attempts have been made, and the waiter is not
yet successful.
    
      
    
    • 
  
    
  • 
      
      
        (Errors::UnexpectedError)
      
      
      
        —
        
    Raised when an error is encounted
while polling for a resource that is not expected.
    
      
    
    • 
  
    
  • 
      
      
        (Errors::NoSuchWaiterError)
      
      
      
        —
        
    Raised when you request to wait
for an unknown state.
    
      
    
    • 
  





  

    
      


1307

    		
    
      
# File 'sig/client.rbs', line 1307

def wait_until: (:db_instance_available waiter_name,

    		
  





    
      

  

  
    #waiter_names  ⇒ Object 
  

  

  




  

    

  This method is part of a private API.
  You should avoid using this method if possible, as it may be removed or be changed in the future.



Deprecated. 



  





  



  

    
      


8022
8023
8024

    		
    
      
# File 'lib/aws-sdk-neptune/client.rb', line 8022

def waiter_names
  waiters.keys
end