aws-sdk-neptune 1.19.0 → 1.24.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +5 -5
- data/lib/aws-sdk-neptune.rb +7 -4
- data/lib/aws-sdk-neptune/client.rb +382 -104
- data/lib/aws-sdk-neptune/client_api.rb +164 -0
- data/lib/aws-sdk-neptune/errors.rb +671 -0
- data/lib/aws-sdk-neptune/resource.rb +1 -0
- data/lib/aws-sdk-neptune/types.rb +601 -110
- data/lib/aws-sdk-neptune/waiters.rb +62 -0
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: bfe278311a41dd3c37c1c63bc725d1367c59bc7810f037819304e87dd856d6a9
|
4
|
+
data.tar.gz: f9ae2fc2e7f08370d1499f3e306a0f5d7055728c70458365e3a9feae361c58e2
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 8d0c8eb3a6b5f03bb451504cf573760af023b97ed125e78943872618220bd95fd82bd2a1803a36fc56804101e17a48e31311937fb83225969970cf7ab1e71216
|
7
|
+
data.tar.gz: d6b792123b4fba942019d5cae89128bcd1a0a74e22048df9badb5e5317f6877da3e1e9acd92b7c65b7879749c02abf8dda700ca4b840b978f79e7f2e41fa76f6
|
data/lib/aws-sdk-neptune.rb
CHANGED
@@ -25,17 +25,20 @@ require_relative 'aws-sdk-neptune/customizations'
|
|
25
25
|
# methods each accept a hash of request parameters and return a response
|
26
26
|
# structure.
|
27
27
|
#
|
28
|
+
# neptune = Aws::Neptune::Client.new
|
29
|
+
# resp = neptune.add_role_to_db_cluster(params)
|
30
|
+
#
|
28
31
|
# See {Client} for more information.
|
29
32
|
#
|
30
33
|
# # Errors
|
31
34
|
#
|
32
|
-
# Errors returned from Amazon Neptune
|
33
|
-
# extend {Errors::ServiceError}.
|
35
|
+
# Errors returned from Amazon Neptune are defined in the
|
36
|
+
# {Errors} module and all extend {Errors::ServiceError}.
|
34
37
|
#
|
35
38
|
# begin
|
36
39
|
# # do stuff
|
37
40
|
# rescue Aws::Neptune::Errors::ServiceError
|
38
|
-
# # rescues all
|
41
|
+
# # rescues all Amazon Neptune API errors
|
39
42
|
# end
|
40
43
|
#
|
41
44
|
# See {Errors} for more information.
|
@@ -43,6 +46,6 @@ require_relative 'aws-sdk-neptune/customizations'
|
|
43
46
|
# @service
|
44
47
|
module Aws::Neptune
|
45
48
|
|
46
|
-
GEM_VERSION = '1.
|
49
|
+
GEM_VERSION = '1.24.0'
|
47
50
|
|
48
51
|
end
|
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/query.rb'
|
|
30
30
|
Aws::Plugins::GlobalConfiguration.add_identifier(:neptune)
|
31
31
|
|
32
32
|
module Aws::Neptune
|
33
|
+
# An API client for Neptune. To construct a client, you need to configure a `:region` and `:credentials`.
|
34
|
+
#
|
35
|
+
# client = Aws::Neptune::Client.new(
|
36
|
+
# region: region_name,
|
37
|
+
# credentials: credentials,
|
38
|
+
# # ...
|
39
|
+
# )
|
40
|
+
#
|
41
|
+
# For details on configuring region and credentials see
|
42
|
+
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
43
|
+
#
|
44
|
+
# See {#initialize} for a full list of supported configuration options.
|
33
45
|
class Client < Seahorse::Client::Base
|
34
46
|
|
35
47
|
include Aws::ClientStubs
|
@@ -93,7 +105,7 @@ module Aws::Neptune
|
|
93
105
|
# @option options [required, String] :region
|
94
106
|
# The AWS region to connect to. The configured `:region` is
|
95
107
|
# used to determine the service `:endpoint`. When not passed,
|
96
|
-
# a default `:region` is
|
108
|
+
# a default `:region` is searched for in the following locations:
|
97
109
|
#
|
98
110
|
# * `Aws.config[:region]`
|
99
111
|
# * `ENV['AWS_REGION']`
|
@@ -108,6 +120,12 @@ module Aws::Neptune
|
|
108
120
|
# When set to `true`, a thread polling for endpoints will be running in
|
109
121
|
# the background every 60 secs (default). Defaults to `false`.
|
110
122
|
#
|
123
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
124
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
125
|
+
# until there is sufficent client side capacity to retry the request.
|
126
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
127
|
+
# not retry instead of sleeping.
|
128
|
+
#
|
111
129
|
# @option options [Boolean] :client_side_monitoring (false)
|
112
130
|
# When `true`, client-side metrics will be collected for all API requests from
|
113
131
|
# this client.
|
@@ -132,6 +150,10 @@ module Aws::Neptune
|
|
132
150
|
# When `true`, an attempt is made to coerce request parameters into
|
133
151
|
# the required types.
|
134
152
|
#
|
153
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
154
|
+
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
155
|
+
# a clock skew correction and retry requests with skewed client clocks.
|
156
|
+
#
|
135
157
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
136
158
|
# Set to true to disable SDK automatically adding host prefix
|
137
159
|
# to default service endpoint when available.
|
@@ -139,7 +161,7 @@ module Aws::Neptune
|
|
139
161
|
# @option options [String] :endpoint
|
140
162
|
# The client endpoint is normally constructed from the `:region`
|
141
163
|
# option. You should only configure an `:endpoint` when connecting
|
142
|
-
# to test endpoints. This should be
|
164
|
+
# to test endpoints. This should be a valid HTTP(S) URI.
|
143
165
|
#
|
144
166
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
145
167
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -154,7 +176,7 @@ module Aws::Neptune
|
|
154
176
|
# requests fetching endpoints information. Defaults to 60 sec.
|
155
177
|
#
|
156
178
|
# @option options [Boolean] :endpoint_discovery (false)
|
157
|
-
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
179
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
158
180
|
#
|
159
181
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
160
182
|
# The log formatter.
|
@@ -166,15 +188,29 @@ module Aws::Neptune
|
|
166
188
|
# The Logger instance to send log messages to. If this option
|
167
189
|
# is not set, logging will be disabled.
|
168
190
|
#
|
191
|
+
# @option options [Integer] :max_attempts (3)
|
192
|
+
# An integer representing the maximum number attempts that will be made for
|
193
|
+
# a single request, including the initial attempt. For example,
|
194
|
+
# setting this value to 5 will result in a request being retried up to
|
195
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
196
|
+
#
|
169
197
|
# @option options [String] :profile ("default")
|
170
198
|
# Used when loading credentials from the shared credentials file
|
171
199
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
172
200
|
#
|
201
|
+
# @option options [Proc] :retry_backoff
|
202
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
203
|
+
# This option is only used in the `legacy` retry mode.
|
204
|
+
#
|
173
205
|
# @option options [Float] :retry_base_delay (0.3)
|
174
|
-
# The base delay in seconds used by the default backoff function.
|
206
|
+
# The base delay in seconds used by the default backoff function. This option
|
207
|
+
# is only used in the `legacy` retry mode.
|
175
208
|
#
|
176
209
|
# @option options [Symbol] :retry_jitter (:none)
|
177
|
-
# A delay randomiser function used by the default backoff function.
|
210
|
+
# A delay randomiser function used by the default backoff function.
|
211
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
212
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
213
|
+
# in the `legacy` retry mode.
|
178
214
|
#
|
179
215
|
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
180
216
|
#
|
@@ -182,11 +218,30 @@ module Aws::Neptune
|
|
182
218
|
# The maximum number of times to retry failed requests. Only
|
183
219
|
# ~ 500 level server errors and certain ~ 400 level client errors
|
184
220
|
# are retried. Generally, these are throttling errors, data
|
185
|
-
# checksum errors, networking errors, timeout errors
|
186
|
-
# errors from expired credentials.
|
221
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
222
|
+
# endpoint discovery, and errors from expired credentials.
|
223
|
+
# This option is only used in the `legacy` retry mode.
|
187
224
|
#
|
188
225
|
# @option options [Integer] :retry_max_delay (0)
|
189
|
-
# The maximum number of seconds to delay between retries (0 for no limit)
|
226
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
227
|
+
# used by the default backoff function. This option is only used in the
|
228
|
+
# `legacy` retry mode.
|
229
|
+
#
|
230
|
+
# @option options [String] :retry_mode ("legacy")
|
231
|
+
# Specifies which retry algorithm to use. Values are:
|
232
|
+
#
|
233
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
234
|
+
# no retry mode is provided.
|
235
|
+
#
|
236
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
237
|
+
# This includes support for retry quotas, which limit the number of
|
238
|
+
# unsuccessful retries a client can make.
|
239
|
+
#
|
240
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
241
|
+
# functionality of `standard` mode along with automatic client side
|
242
|
+
# throttling. This is a provisional mode that may change behavior
|
243
|
+
# in the future.
|
244
|
+
#
|
190
245
|
#
|
191
246
|
# @option options [String] :secret_access_key
|
192
247
|
#
|
@@ -209,16 +264,15 @@ module Aws::Neptune
|
|
209
264
|
# requests through. Formatted like 'http://proxy.com:123'.
|
210
265
|
#
|
211
266
|
# @option options [Float] :http_open_timeout (15) The number of
|
212
|
-
# seconds to wait when opening a HTTP session before
|
267
|
+
# seconds to wait when opening a HTTP session before raising a
|
213
268
|
# `Timeout::Error`.
|
214
269
|
#
|
215
270
|
# @option options [Integer] :http_read_timeout (60) The default
|
216
271
|
# number of seconds to wait for response data. This value can
|
217
|
-
# safely be set
|
218
|
-
# per-request on the session yeidled by {#session_for}.
|
272
|
+
# safely be set per-request on the session.
|
219
273
|
#
|
220
274
|
# @option options [Float] :http_idle_timeout (5) The number of
|
221
|
-
# seconds a connection is allowed to sit
|
275
|
+
# seconds a connection is allowed to sit idle before it is
|
222
276
|
# considered stale. Stale connections are closed and removed
|
223
277
|
# from the pool before making a request.
|
224
278
|
#
|
@@ -227,7 +281,7 @@ module Aws::Neptune
|
|
227
281
|
# request body. This option has no effect unless the request has
|
228
282
|
# "Expect" header set to "100-continue". Defaults to `nil` which
|
229
283
|
# disables this behaviour. This value can safely be set per
|
230
|
-
# request on the session
|
284
|
+
# request on the session.
|
231
285
|
#
|
232
286
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
233
287
|
# HTTP debug output will be sent to the `:logger`.
|
@@ -530,8 +584,6 @@ module Aws::Neptune
|
|
530
584
|
# snapshot, `SourceDBClusterSnapshotIdentifier` must be the Amazon
|
531
585
|
# Resource Name (ARN) of the shared DB cluster snapshot.
|
532
586
|
#
|
533
|
-
# You can't copy from one AWS Region to another.
|
534
|
-
#
|
535
587
|
# @option params [required, String] :source_db_cluster_snapshot_identifier
|
536
588
|
# The identifier of the DB cluster snapshot to copy. This parameter is
|
537
589
|
# not case-sensitive.
|
@@ -565,10 +617,6 @@ module Aws::Neptune
|
|
565
617
|
# key ID is the Amazon Resource Name (ARN), KMS key identifier, or the
|
566
618
|
# KMS key alias for the KMS encryption key.
|
567
619
|
#
|
568
|
-
# If you copy an unencrypted DB cluster snapshot and specify a value for
|
569
|
-
# the `KmsKeyId` parameter, Amazon Neptune encrypts the target DB
|
570
|
-
# cluster snapshot using the specified KMS encryption key.
|
571
|
-
#
|
572
620
|
# If you copy an encrypted DB cluster snapshot from your AWS account,
|
573
621
|
# you can specify a value for `KmsKeyId` to encrypt the copy with a new
|
574
622
|
# KMS encryption key. If you don't specify a value for `KmsKeyId`, then
|
@@ -582,6 +630,10 @@ module Aws::Neptune
|
|
582
630
|
# created in, and you can't use encryption keys from one AWS Region in
|
583
631
|
# another AWS Region.
|
584
632
|
#
|
633
|
+
# You cannot encrypt an unencrypted DB cluster snapshot when you copy
|
634
|
+
# it. If you try to copy an unencrypted DB cluster snapshot and specify
|
635
|
+
# a value for the KmsKeyId parameter, an error is returned.
|
636
|
+
#
|
585
637
|
# @option params [String] :pre_signed_url
|
586
638
|
# Not currently supported.
|
587
639
|
#
|
@@ -724,6 +776,12 @@ module Aws::Neptune
|
|
724
776
|
# DB cluster as a Read Replica of another DB cluster or Amazon Neptune
|
725
777
|
# DB instance.
|
726
778
|
#
|
779
|
+
# Note that when you create a new cluster using `CreateDBCluster`
|
780
|
+
# directly, deletion protection is disabled by default (when you create
|
781
|
+
# a new production cluster in the console, deletion protection is
|
782
|
+
# enabled by default). You can only delete a DB cluster if its
|
783
|
+
# `DeletionProtection` field is set to `false`.
|
784
|
+
#
|
727
785
|
# @option params [Array<String>] :availability_zones
|
728
786
|
# A list of EC2 Availability Zones that instances in the DB cluster can
|
729
787
|
# be created in.
|
@@ -741,8 +799,7 @@ module Aws::Neptune
|
|
741
799
|
# ^
|
742
800
|
#
|
743
801
|
# @option params [String] :character_set_name
|
744
|
-
#
|
745
|
-
# the specified CharacterSet.
|
802
|
+
# *(Not supported by Neptune)*
|
746
803
|
#
|
747
804
|
# @option params [String] :database_name
|
748
805
|
# The name for your database of up to 64 alpha-numeric characters. If
|
@@ -791,7 +848,8 @@ module Aws::Neptune
|
|
791
848
|
# Valid Values: `neptune`
|
792
849
|
#
|
793
850
|
# @option params [String] :engine_version
|
794
|
-
# The version number of the database engine to use.
|
851
|
+
# The version number of the database engine to use. Currently, setting
|
852
|
+
# this parameter has no effect.
|
795
853
|
#
|
796
854
|
# Example: `1.0.1`
|
797
855
|
#
|
@@ -819,12 +877,7 @@ module Aws::Neptune
|
|
819
877
|
# Constraints: Must contain from 8 to 41 characters.
|
820
878
|
#
|
821
879
|
# @option params [String] :option_group_name
|
822
|
-
#
|
823
|
-
# the specified option group.
|
824
|
-
#
|
825
|
-
# Permanent options can't be removed from an option group. The option
|
826
|
-
# group can't be removed from a DB cluster once it is associated with a
|
827
|
-
# DB cluster.
|
880
|
+
# *(Not supported by Neptune)*
|
828
881
|
#
|
829
882
|
# @option params [String] :preferred_backup_window
|
830
883
|
# The daily time range during which automated backups are created if
|
@@ -921,6 +974,11 @@ module Aws::Neptune
|
|
921
974
|
# The list of log types that need to be enabled for exporting to
|
922
975
|
# CloudWatch Logs.
|
923
976
|
#
|
977
|
+
# @option params [Boolean] :deletion_protection
|
978
|
+
# A value that indicates whether the DB cluster has deletion protection
|
979
|
+
# enabled. The database can't be deleted when deletion protection is
|
980
|
+
# enabled. By default, deletion protection is enabled.
|
981
|
+
#
|
924
982
|
# @return [Types::CreateDBClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
925
983
|
#
|
926
984
|
# * {Types::CreateDBClusterResult#db_cluster #db_cluster} => Types::DBCluster
|
@@ -956,6 +1014,7 @@ module Aws::Neptune
|
|
956
1014
|
# pre_signed_url: "String",
|
957
1015
|
# enable_iam_database_authentication: false,
|
958
1016
|
# enable_cloudwatch_logs_exports: ["String"],
|
1017
|
+
# deletion_protection: false,
|
959
1018
|
# })
|
960
1019
|
#
|
961
1020
|
# @example Response structure
|
@@ -1009,6 +1068,7 @@ module Aws::Neptune
|
|
1009
1068
|
# resp.db_cluster.cluster_create_time #=> Time
|
1010
1069
|
# resp.db_cluster.enabled_cloudwatch_logs_exports #=> Array
|
1011
1070
|
# resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String
|
1071
|
+
# resp.db_cluster.deletion_protection #=> Boolean
|
1012
1072
|
#
|
1013
1073
|
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-2014-10-31/CreateDBCluster AWS API Documentation
|
1014
1074
|
#
|
@@ -1334,7 +1394,8 @@ module Aws::Neptune
|
|
1334
1394
|
# true.
|
1335
1395
|
#
|
1336
1396
|
# @option params [String] :engine_version
|
1337
|
-
# The version number of the database engine to use.
|
1397
|
+
# The version number of the database engine to use. Currently, setting
|
1398
|
+
# this parameter has no effect.
|
1338
1399
|
#
|
1339
1400
|
# @option params [Boolean] :auto_minor_version_upgrade
|
1340
1401
|
# Indicates that minor engine upgrades are applied automatically to the
|
@@ -1353,20 +1414,10 @@ module Aws::Neptune
|
|
1353
1414
|
# be initially allocated for the DB instance.
|
1354
1415
|
#
|
1355
1416
|
# @option params [String] :option_group_name
|
1356
|
-
#
|
1357
|
-
# option group.
|
1358
|
-
#
|
1359
|
-
# Permanent options, such as the TDE option for Oracle Advanced Security
|
1360
|
-
# TDE, can't be removed from an option group, and that option group
|
1361
|
-
# can't be removed from a DB instance once it is associated with a DB
|
1362
|
-
# instance
|
1417
|
+
# *(Not supported by Neptune)*
|
1363
1418
|
#
|
1364
1419
|
# @option params [String] :character_set_name
|
1365
|
-
#
|
1366
|
-
# CharacterSet.
|
1367
|
-
#
|
1368
|
-
# Not applicable. The character set is managed by the DB cluster. For
|
1369
|
-
# more information, see CreateDBCluster.
|
1420
|
+
# *(Not supported by Neptune)*
|
1370
1421
|
#
|
1371
1422
|
# @option params [Boolean] :publicly_accessible
|
1372
1423
|
# This flag should no longer be used.
|
@@ -1468,18 +1519,28 @@ module Aws::Neptune
|
|
1468
1519
|
# Default: `false`
|
1469
1520
|
#
|
1470
1521
|
# @option params [Boolean] :enable_performance_insights
|
1471
|
-
#
|
1472
|
-
# false.
|
1522
|
+
# *(Not supported by Neptune)*
|
1473
1523
|
#
|
1474
1524
|
# @option params [String] :performance_insights_kms_key_id
|
1475
|
-
#
|
1476
|
-
# data. The KMS key ID is the Amazon Resource Name (ARN), KMS key
|
1477
|
-
# identifier, or the KMS key alias for the KMS encryption key.
|
1525
|
+
# *(Not supported by Neptune)*
|
1478
1526
|
#
|
1479
1527
|
# @option params [Array<String>] :enable_cloudwatch_logs_exports
|
1480
1528
|
# The list of log types that need to be enabled for exporting to
|
1481
1529
|
# CloudWatch Logs.
|
1482
1530
|
#
|
1531
|
+
# @option params [Boolean] :deletion_protection
|
1532
|
+
# A value that indicates whether the DB instance has deletion protection
|
1533
|
+
# enabled. The database can't be deleted when deletion protection is
|
1534
|
+
# enabled. By default, deletion protection is disabled. See [Deleting a
|
1535
|
+
# DB Instance][1].
|
1536
|
+
#
|
1537
|
+
# DB instances in a DB cluster can be deleted even when deletion
|
1538
|
+
# protection is enabled in their parent DB cluster.
|
1539
|
+
#
|
1540
|
+
#
|
1541
|
+
#
|
1542
|
+
# [1]: https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html
|
1543
|
+
#
|
1483
1544
|
# @return [Types::CreateDBInstanceResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1484
1545
|
#
|
1485
1546
|
# * {Types::CreateDBInstanceResult#db_instance #db_instance} => Types::DBInstance
|
@@ -1534,6 +1595,7 @@ module Aws::Neptune
|
|
1534
1595
|
# enable_performance_insights: false,
|
1535
1596
|
# performance_insights_kms_key_id: "String",
|
1536
1597
|
# enable_cloudwatch_logs_exports: ["String"],
|
1598
|
+
# deletion_protection: false,
|
1537
1599
|
# })
|
1538
1600
|
#
|
1539
1601
|
# @example Response structure
|
@@ -1635,6 +1697,7 @@ module Aws::Neptune
|
|
1635
1697
|
# resp.db_instance.performance_insights_kms_key_id #=> String
|
1636
1698
|
# resp.db_instance.enabled_cloudwatch_logs_exports #=> Array
|
1637
1699
|
# resp.db_instance.enabled_cloudwatch_logs_exports[0] #=> String
|
1700
|
+
# resp.db_instance.deletion_protection #=> Boolean
|
1638
1701
|
#
|
1639
1702
|
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-2014-10-31/CreateDBInstance AWS API Documentation
|
1640
1703
|
#
|
@@ -1916,6 +1979,10 @@ module Aws::Neptune
|
|
1916
1979
|
# DB cluster are deleted and can't be recovered. Manual DB cluster
|
1917
1980
|
# snapshots of the specified DB cluster are not deleted.
|
1918
1981
|
#
|
1982
|
+
# Note that the DB Cluster cannot be deleted if deletion protection is
|
1983
|
+
# enabled. To delete it, you must first set its `DeletionProtection`
|
1984
|
+
# field to `False`.
|
1985
|
+
#
|
1919
1986
|
# @option params [required, String] :db_cluster_identifier
|
1920
1987
|
# The DB cluster identifier for the DB cluster to be deleted. This
|
1921
1988
|
# parameter isn't case-sensitive.
|
@@ -2019,6 +2086,7 @@ module Aws::Neptune
|
|
2019
2086
|
# resp.db_cluster.cluster_create_time #=> Time
|
2020
2087
|
# resp.db_cluster.enabled_cloudwatch_logs_exports #=> Array
|
2021
2088
|
# resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String
|
2089
|
+
# resp.db_cluster.deletion_protection #=> Boolean
|
2022
2090
|
#
|
2023
2091
|
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-2014-10-31/DeleteDBCluster AWS API Documentation
|
2024
2092
|
#
|
@@ -2135,7 +2203,7 @@ module Aws::Neptune
|
|
2135
2203
|
# `true`.
|
2136
2204
|
#
|
2137
2205
|
# You can't delete a DB instance if it is the only instance in the DB
|
2138
|
-
# cluster.
|
2206
|
+
# cluster, or if it has deletion protection enabled.
|
2139
2207
|
#
|
2140
2208
|
# @option params [required, String] :db_instance_identifier
|
2141
2209
|
# The DB instance identifier for the DB instance to be deleted. This
|
@@ -2297,6 +2365,7 @@ module Aws::Neptune
|
|
2297
2365
|
# resp.db_instance.performance_insights_kms_key_id #=> String
|
2298
2366
|
# resp.db_instance.enabled_cloudwatch_logs_exports #=> Array
|
2299
2367
|
# resp.db_instance.enabled_cloudwatch_logs_exports[0] #=> String
|
2368
|
+
# resp.db_instance.deletion_protection #=> Boolean
|
2300
2369
|
#
|
2301
2370
|
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-2014-10-31/DeleteDBInstance AWS API Documentation
|
2302
2371
|
#
|
@@ -2763,9 +2832,14 @@ module Aws::Neptune
|
|
2763
2832
|
req.send_request(options)
|
2764
2833
|
end
|
2765
2834
|
|
2766
|
-
# Returns information about provisioned DB clusters
|
2835
|
+
# Returns information about provisioned DB clusters, and supports
|
2767
2836
|
# pagination.
|
2768
2837
|
#
|
2838
|
+
# <note markdown="1"> This operation can also return information for Amazon RDS clusters and
|
2839
|
+
# Amazon DocDB clusters.
|
2840
|
+
#
|
2841
|
+
# </note>
|
2842
|
+
#
|
2769
2843
|
# @option params [String] :db_cluster_identifier
|
2770
2844
|
# The user-supplied DB cluster identifier. If this parameter is
|
2771
2845
|
# specified, information from only the specific DB cluster is returned.
|
@@ -2786,7 +2860,12 @@ module Aws::Neptune
|
|
2786
2860
|
# Amazon Resource Names (ARNs). The results list will only include
|
2787
2861
|
# information about the DB clusters identified by these ARNs.
|
2788
2862
|
#
|
2789
|
-
#
|
2863
|
+
# * `engine` - Accepts an engine name (such as `neptune`), and restricts
|
2864
|
+
# the results list to DB clusters created by that engine.
|
2865
|
+
#
|
2866
|
+
# For example, to invoke this API from the AWS CLI and filter so that
|
2867
|
+
# only Neptune DB clusters are returned, you could use the following
|
2868
|
+
# command:
|
2790
2869
|
#
|
2791
2870
|
# @option params [Integer] :max_records
|
2792
2871
|
# The maximum number of records to include in the response. If more
|
@@ -2875,6 +2954,7 @@ module Aws::Neptune
|
|
2875
2954
|
# resp.db_clusters[0].cluster_create_time #=> Time
|
2876
2955
|
# resp.db_clusters[0].enabled_cloudwatch_logs_exports #=> Array
|
2877
2956
|
# resp.db_clusters[0].enabled_cloudwatch_logs_exports[0] #=> String
|
2957
|
+
# resp.db_clusters[0].deletion_protection #=> Boolean
|
2878
2958
|
#
|
2879
2959
|
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-2014-10-31/DescribeDBClusters AWS API Documentation
|
2880
2960
|
#
|
@@ -2942,6 +3022,8 @@ module Aws::Neptune
|
|
2942
3022
|
# * {Types::DBEngineVersionMessage#marker #marker} => String
|
2943
3023
|
# * {Types::DBEngineVersionMessage#db_engine_versions #db_engine_versions} => Array<Types::DBEngineVersion>
|
2944
3024
|
#
|
3025
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3026
|
+
#
|
2945
3027
|
# @example Request syntax with placeholder values
|
2946
3028
|
#
|
2947
3029
|
# resp = client.describe_db_engine_versions({
|
@@ -2997,9 +3079,14 @@ module Aws::Neptune
|
|
2997
3079
|
req.send_request(options)
|
2998
3080
|
end
|
2999
3081
|
|
3000
|
-
# Returns information about provisioned instances
|
3082
|
+
# Returns information about provisioned instances, and supports
|
3001
3083
|
# pagination.
|
3002
3084
|
#
|
3085
|
+
# <note markdown="1"> This operation can also return information for Amazon RDS instances
|
3086
|
+
# and Amazon DocDB instances.
|
3087
|
+
#
|
3088
|
+
# </note>
|
3089
|
+
#
|
3003
3090
|
# @option params [String] :db_instance_identifier
|
3004
3091
|
# The user-supplied instance identifier. If this parameter is specified,
|
3005
3092
|
# information from only the specific DB instance is returned. This
|
@@ -3021,9 +3108,12 @@ module Aws::Neptune
|
|
3021
3108
|
# information about the DB instances associated with the DB clusters
|
3022
3109
|
# identified by these ARNs.
|
3023
3110
|
#
|
3024
|
-
# * `
|
3025
|
-
#
|
3026
|
-
#
|
3111
|
+
# * `engine` - Accepts an engine name (such as `neptune`), and restricts
|
3112
|
+
# the results list to DB instances created by that engine.
|
3113
|
+
#
|
3114
|
+
# For example, to invoke this API from the AWS CLI and filter so that
|
3115
|
+
# only Neptune DB instances are returned, you could use the following
|
3116
|
+
# command:
|
3027
3117
|
#
|
3028
3118
|
# @option params [Integer] :max_records
|
3029
3119
|
# The maximum number of records to include in the response. If more
|
@@ -3046,6 +3136,8 @@ module Aws::Neptune
|
|
3046
3136
|
# * {Types::DBInstanceMessage#marker #marker} => String
|
3047
3137
|
# * {Types::DBInstanceMessage#db_instances #db_instances} => Array<Types::DBInstance>
|
3048
3138
|
#
|
3139
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3140
|
+
#
|
3049
3141
|
# @example Request syntax with placeholder values
|
3050
3142
|
#
|
3051
3143
|
# resp = client.describe_db_instances({
|
@@ -3161,6 +3253,13 @@ module Aws::Neptune
|
|
3161
3253
|
# resp.db_instances[0].performance_insights_kms_key_id #=> String
|
3162
3254
|
# resp.db_instances[0].enabled_cloudwatch_logs_exports #=> Array
|
3163
3255
|
# resp.db_instances[0].enabled_cloudwatch_logs_exports[0] #=> String
|
3256
|
+
# resp.db_instances[0].deletion_protection #=> Boolean
|
3257
|
+
#
|
3258
|
+
#
|
3259
|
+
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
3260
|
+
#
|
3261
|
+
# * db_instance_available
|
3262
|
+
# * db_instance_deleted
|
3164
3263
|
#
|
3165
3264
|
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-2014-10-31/DescribeDBInstances AWS API Documentation
|
3166
3265
|
#
|
@@ -3209,6 +3308,8 @@ module Aws::Neptune
|
|
3209
3308
|
# * {Types::DBParameterGroupsMessage#marker #marker} => String
|
3210
3309
|
# * {Types::DBParameterGroupsMessage#db_parameter_groups #db_parameter_groups} => Array<Types::DBParameterGroup>
|
3211
3310
|
#
|
3311
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3312
|
+
#
|
3212
3313
|
# @example Request syntax with placeholder values
|
3213
3314
|
#
|
3214
3315
|
# resp = client.describe_db_parameter_groups({
|
@@ -3284,6 +3385,8 @@ module Aws::Neptune
|
|
3284
3385
|
# * {Types::DBParameterGroupDetails#parameters #parameters} => Array<Types::Parameter>
|
3285
3386
|
# * {Types::DBParameterGroupDetails#marker #marker} => String
|
3286
3387
|
#
|
3388
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3389
|
+
#
|
3287
3390
|
# @example Request syntax with placeholder values
|
3288
3391
|
#
|
3289
3392
|
# resp = client.describe_db_parameters({
|
@@ -3360,6 +3463,8 @@ module Aws::Neptune
|
|
3360
3463
|
# * {Types::DBSubnetGroupMessage#marker #marker} => String
|
3361
3464
|
# * {Types::DBSubnetGroupMessage#db_subnet_groups #db_subnet_groups} => Array<Types::DBSubnetGroup>
|
3362
3465
|
#
|
3466
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3467
|
+
#
|
3363
3468
|
# @example Request syntax with placeholder values
|
3364
3469
|
#
|
3365
3470
|
# resp = client.describe_db_subnet_groups({
|
@@ -3495,6 +3600,8 @@ module Aws::Neptune
|
|
3495
3600
|
#
|
3496
3601
|
# * {Types::DescribeEngineDefaultParametersResult#engine_defaults #engine_defaults} => Types::EngineDefaults
|
3497
3602
|
#
|
3603
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3604
|
+
#
|
3498
3605
|
# @example Request syntax with placeholder values
|
3499
3606
|
#
|
3500
3607
|
# resp = client.describe_engine_default_parameters({
|
@@ -3612,6 +3719,8 @@ module Aws::Neptune
|
|
3612
3719
|
# * {Types::EventSubscriptionsMessage#marker #marker} => String
|
3613
3720
|
# * {Types::EventSubscriptionsMessage#event_subscriptions_list #event_subscriptions_list} => Array<Types::EventSubscription>
|
3614
3721
|
#
|
3722
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3723
|
+
#
|
3615
3724
|
# @example Request syntax with placeholder values
|
3616
3725
|
#
|
3617
3726
|
# resp = client.describe_event_subscriptions({
|
@@ -3738,6 +3847,8 @@ module Aws::Neptune
|
|
3738
3847
|
# * {Types::EventsMessage#marker #marker} => String
|
3739
3848
|
# * {Types::EventsMessage#events #events} => Array<Types::Event>
|
3740
3849
|
#
|
3850
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3851
|
+
#
|
3741
3852
|
# @example Request syntax with placeholder values
|
3742
3853
|
#
|
3743
3854
|
# resp = client.describe_events({
|
@@ -3824,6 +3935,8 @@ module Aws::Neptune
|
|
3824
3935
|
# * {Types::OrderableDBInstanceOptionsMessage#orderable_db_instance_options #orderable_db_instance_options} => Array<Types::OrderableDBInstanceOption>
|
3825
3936
|
# * {Types::OrderableDBInstanceOptionsMessage#marker #marker} => String
|
3826
3937
|
#
|
3938
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3939
|
+
#
|
3827
3940
|
# @example Request syntax with placeholder values
|
3828
3941
|
#
|
3829
3942
|
# resp = client.describe_orderable_db_instance_options({
|
@@ -4088,6 +4201,7 @@ module Aws::Neptune
|
|
4088
4201
|
# resp.db_cluster.cluster_create_time #=> Time
|
4089
4202
|
# resp.db_cluster.enabled_cloudwatch_logs_exports #=> Array
|
4090
4203
|
# resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String
|
4204
|
+
# resp.db_cluster.deletion_protection #=> Boolean
|
4091
4205
|
#
|
4092
4206
|
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-2014-10-31/FailoverDBCluster AWS API Documentation
|
4093
4207
|
#
|
@@ -4220,18 +4334,7 @@ module Aws::Neptune
|
|
4220
4334
|
# Constraints: Must contain from 8 to 41 characters.
|
4221
4335
|
#
|
4222
4336
|
# @option params [String] :option_group_name
|
4223
|
-
#
|
4224
|
-
# the specified option group. Changing this parameter doesn't result in
|
4225
|
-
# an outage except in the following case, and the change is applied
|
4226
|
-
# during the next maintenance window unless the `ApplyImmediately`
|
4227
|
-
# parameter is set to `true` for this request. If the parameter change
|
4228
|
-
# results in an option group that enables OEM, this change can cause a
|
4229
|
-
# brief (sub-second) period during which new connections are rejected
|
4230
|
-
# but existing connections are not interrupted.
|
4231
|
-
#
|
4232
|
-
# Permanent options can't be removed from an option group. The option
|
4233
|
-
# group can't be removed from a DB cluster once it is associated with a
|
4234
|
-
# DB cluster.
|
4337
|
+
# *(Not supported by Neptune)*
|
4235
4338
|
#
|
4236
4339
|
# @option params [String] :preferred_backup_window
|
4237
4340
|
# The daily time range during which automated backups are created if
|
@@ -4276,14 +4379,18 @@ module Aws::Neptune
|
|
4276
4379
|
# to CloudWatch Logs for a specific DB cluster.
|
4277
4380
|
#
|
4278
4381
|
# @option params [String] :engine_version
|
4279
|
-
# The version number of the database engine
|
4280
|
-
#
|
4281
|
-
#
|
4282
|
-
# parameter is set to true.
|
4382
|
+
# The version number of the database engine. Currently, setting this
|
4383
|
+
# parameter has no effect. To upgrade your database engine to the most
|
4384
|
+
# recent release, use the ApplyPendingMaintenanceAction API.
|
4283
4385
|
#
|
4284
4386
|
# For a list of valid engine versions, see CreateDBInstance, or call
|
4285
4387
|
# DescribeDBEngineVersions.
|
4286
4388
|
#
|
4389
|
+
# @option params [Boolean] :deletion_protection
|
4390
|
+
# A value that indicates whether the DB cluster has deletion protection
|
4391
|
+
# enabled. The database can't be deleted when deletion protection is
|
4392
|
+
# enabled. By default, deletion protection is disabled.
|
4393
|
+
#
|
4287
4394
|
# @return [Types::ModifyDBClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4288
4395
|
#
|
4289
4396
|
# * {Types::ModifyDBClusterResult#db_cluster #db_cluster} => Types::DBCluster
|
@@ -4308,6 +4415,7 @@ module Aws::Neptune
|
|
4308
4415
|
# disable_log_types: ["String"],
|
4309
4416
|
# },
|
4310
4417
|
# engine_version: "String",
|
4418
|
+
# deletion_protection: false,
|
4311
4419
|
# })
|
4312
4420
|
#
|
4313
4421
|
# @example Response structure
|
@@ -4361,6 +4469,7 @@ module Aws::Neptune
|
|
4361
4469
|
# resp.db_cluster.cluster_create_time #=> Time
|
4362
4470
|
# resp.db_cluster.enabled_cloudwatch_logs_exports #=> Array
|
4363
4471
|
# resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String
|
4472
|
+
# resp.db_cluster.deletion_protection #=> Boolean
|
4364
4473
|
#
|
4365
4474
|
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-2014-10-31/ModifyDBCluster AWS API Documentation
|
4366
4475
|
#
|
@@ -4668,25 +4777,15 @@ module Aws::Neptune
|
|
4668
4777
|
# parameter is set to `true` for this request.
|
4669
4778
|
#
|
4670
4779
|
# @option params [String] :engine_version
|
4671
|
-
# The version number of the database engine to upgrade to.
|
4672
|
-
#
|
4673
|
-
#
|
4674
|
-
# to `true` for this request.
|
4675
|
-
#
|
4676
|
-
# For major version upgrades, if a nondefault DB parameter group is
|
4677
|
-
# currently in use, a new DB parameter group in the DB parameter group
|
4678
|
-
# family for the new engine version must be specified. The new DB
|
4679
|
-
# parameter group can be the default for that DB parameter group family.
|
4780
|
+
# The version number of the database engine to upgrade to. Currently,
|
4781
|
+
# setting this parameter has no effect. To upgrade your database engine
|
4782
|
+
# to the most recent release, use the ApplyPendingMaintenanceAction API.
|
4680
4783
|
#
|
4681
4784
|
# @option params [Boolean] :allow_major_version_upgrade
|
4682
4785
|
# Indicates that major version upgrades are allowed. Changing this
|
4683
4786
|
# parameter doesn't result in an outage and the change is
|
4684
4787
|
# asynchronously applied as soon as possible.
|
4685
4788
|
#
|
4686
|
-
# Constraints: This parameter must be set to true when specifying a
|
4687
|
-
# value for the EngineVersion parameter that is a different major
|
4688
|
-
# version than the DB instance's current version.
|
4689
|
-
#
|
4690
4789
|
# @option params [Boolean] :auto_minor_version_upgrade
|
4691
4790
|
# Indicates that minor version upgrades are applied automatically to the
|
4692
4791
|
# DB instance during the maintenance window. Changing this parameter
|
@@ -4710,19 +4809,7 @@ module Aws::Neptune
|
|
4710
4809
|
# Default: Uses existing setting
|
4711
4810
|
#
|
4712
4811
|
# @option params [String] :option_group_name
|
4713
|
-
#
|
4714
|
-
# option group. Changing this parameter doesn't result in an outage
|
4715
|
-
# except in the following case and the change is applied during the next
|
4716
|
-
# maintenance window unless the `ApplyImmediately` parameter is set to
|
4717
|
-
# `true` for this request. If the parameter change results in an option
|
4718
|
-
# group that enables OEM, this change can cause a brief (sub-second)
|
4719
|
-
# period during which new connections are rejected but existing
|
4720
|
-
# connections are not interrupted.
|
4721
|
-
#
|
4722
|
-
# Permanent options, such as the TDE option for Oracle Advanced Security
|
4723
|
-
# TDE, can't be removed from an option group, and that option group
|
4724
|
-
# can't be removed from a DB instance once it is associated with a DB
|
4725
|
-
# instance
|
4812
|
+
# *(Not supported by Neptune)*
|
4726
4813
|
#
|
4727
4814
|
# @option params [String] :new_db_instance_identifier
|
4728
4815
|
# The new DB instance identifier for the DB instance when renaming a DB
|
@@ -4821,15 +4908,25 @@ module Aws::Neptune
|
|
4821
4908
|
# Default: `false`
|
4822
4909
|
#
|
4823
4910
|
# @option params [Boolean] :enable_performance_insights
|
4824
|
-
# Not supported
|
4911
|
+
# *(Not supported by Neptune)*
|
4825
4912
|
#
|
4826
4913
|
# @option params [String] :performance_insights_kms_key_id
|
4827
|
-
# Not supported
|
4914
|
+
# *(Not supported by Neptune)*
|
4828
4915
|
#
|
4829
4916
|
# @option params [Types::CloudwatchLogsExportConfiguration] :cloudwatch_logs_export_configuration
|
4830
4917
|
# The configuration setting for the log types to be enabled for export
|
4831
4918
|
# to CloudWatch Logs for a specific DB instance or DB cluster.
|
4832
4919
|
#
|
4920
|
+
# @option params [Boolean] :deletion_protection
|
4921
|
+
# A value that indicates whether the DB instance has deletion protection
|
4922
|
+
# enabled. The database can't be deleted when deletion protection is
|
4923
|
+
# enabled. By default, deletion protection is disabled. See [Deleting a
|
4924
|
+
# DB Instance][1].
|
4925
|
+
#
|
4926
|
+
#
|
4927
|
+
#
|
4928
|
+
# [1]: https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html
|
4929
|
+
#
|
4833
4930
|
# @return [Types::ModifyDBInstanceResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4834
4931
|
#
|
4835
4932
|
# * {Types::ModifyDBInstanceResult#db_instance #db_instance} => Types::DBInstance
|
@@ -4876,6 +4973,7 @@ module Aws::Neptune
|
|
4876
4973
|
# enable_log_types: ["String"],
|
4877
4974
|
# disable_log_types: ["String"],
|
4878
4975
|
# },
|
4976
|
+
# deletion_protection: false,
|
4879
4977
|
# })
|
4880
4978
|
#
|
4881
4979
|
# @example Response structure
|
@@ -4977,6 +5075,7 @@ module Aws::Neptune
|
|
4977
5075
|
# resp.db_instance.performance_insights_kms_key_id #=> String
|
4978
5076
|
# resp.db_instance.enabled_cloudwatch_logs_exports #=> Array
|
4979
5077
|
# resp.db_instance.enabled_cloudwatch_logs_exports[0] #=> String
|
5078
|
+
# resp.db_instance.deletion_protection #=> Boolean
|
4980
5079
|
#
|
4981
5080
|
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-2014-10-31/ModifyDBInstance AWS API Documentation
|
4982
5081
|
#
|
@@ -5261,6 +5360,7 @@ module Aws::Neptune
|
|
5261
5360
|
# resp.db_cluster.cluster_create_time #=> Time
|
5262
5361
|
# resp.db_cluster.enabled_cloudwatch_logs_exports #=> Array
|
5263
5362
|
# resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String
|
5363
|
+
# resp.db_cluster.deletion_protection #=> Boolean
|
5264
5364
|
#
|
5265
5365
|
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-2014-10-31/PromoteReadReplicaDBCluster AWS API Documentation
|
5266
5366
|
#
|
@@ -5406,6 +5506,7 @@ module Aws::Neptune
|
|
5406
5506
|
# resp.db_instance.performance_insights_kms_key_id #=> String
|
5407
5507
|
# resp.db_instance.enabled_cloudwatch_logs_exports #=> Array
|
5408
5508
|
# resp.db_instance.enabled_cloudwatch_logs_exports[0] #=> String
|
5509
|
+
# resp.db_instance.deletion_protection #=> Boolean
|
5409
5510
|
#
|
5410
5511
|
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-2014-10-31/RebootDBInstance AWS API Documentation
|
5411
5512
|
#
|
@@ -5731,7 +5832,7 @@ module Aws::Neptune
|
|
5731
5832
|
# Not supported.
|
5732
5833
|
#
|
5733
5834
|
# @option params [String] :option_group_name
|
5734
|
-
#
|
5835
|
+
# *(Not supported by Neptune)*
|
5735
5836
|
#
|
5736
5837
|
# @option params [Array<String>] :vpc_security_group_ids
|
5737
5838
|
# A list of VPC security groups that the new DB cluster will belong to.
|
@@ -5780,6 +5881,11 @@ module Aws::Neptune
|
|
5780
5881
|
#
|
5781
5882
|
# ^
|
5782
5883
|
#
|
5884
|
+
# @option params [Boolean] :deletion_protection
|
5885
|
+
# A value that indicates whether the DB cluster has deletion protection
|
5886
|
+
# enabled. The database can't be deleted when deletion protection is
|
5887
|
+
# enabled. By default, deletion protection is disabled.
|
5888
|
+
#
|
5783
5889
|
# @return [Types::RestoreDBClusterFromSnapshotResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5784
5890
|
#
|
5785
5891
|
# * {Types::RestoreDBClusterFromSnapshotResult#db_cluster #db_cluster} => Types::DBCluster
|
@@ -5807,6 +5913,7 @@ module Aws::Neptune
|
|
5807
5913
|
# enable_iam_database_authentication: false,
|
5808
5914
|
# enable_cloudwatch_logs_exports: ["String"],
|
5809
5915
|
# db_cluster_parameter_group_name: "String",
|
5916
|
+
# deletion_protection: false,
|
5810
5917
|
# })
|
5811
5918
|
#
|
5812
5919
|
# @example Response structure
|
@@ -5860,6 +5967,7 @@ module Aws::Neptune
|
|
5860
5967
|
# resp.db_cluster.cluster_create_time #=> Time
|
5861
5968
|
# resp.db_cluster.enabled_cloudwatch_logs_exports #=> Array
|
5862
5969
|
# resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String
|
5970
|
+
# resp.db_cluster.deletion_protection #=> Boolean
|
5863
5971
|
#
|
5864
5972
|
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-2014-10-31/RestoreDBClusterFromSnapshot AWS API Documentation
|
5865
5973
|
#
|
@@ -5963,7 +6071,7 @@ module Aws::Neptune
|
|
5963
6071
|
# Example: `mySubnetgroup`
|
5964
6072
|
#
|
5965
6073
|
# @option params [String] :option_group_name
|
5966
|
-
#
|
6074
|
+
# *(Not supported by Neptune)*
|
5967
6075
|
#
|
5968
6076
|
# @option params [Array<String>] :vpc_security_group_ids
|
5969
6077
|
# A list of VPC security groups that the new DB cluster belongs to.
|
@@ -6020,6 +6128,11 @@ module Aws::Neptune
|
|
6020
6128
|
#
|
6021
6129
|
# ^
|
6022
6130
|
#
|
6131
|
+
# @option params [Boolean] :deletion_protection
|
6132
|
+
# A value that indicates whether the DB cluster has deletion protection
|
6133
|
+
# enabled. The database can't be deleted when deletion protection is
|
6134
|
+
# enabled. By default, deletion protection is disabled.
|
6135
|
+
#
|
6023
6136
|
# @return [Types::RestoreDBClusterToPointInTimeResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6024
6137
|
#
|
6025
6138
|
# * {Types::RestoreDBClusterToPointInTimeResult#db_cluster #db_cluster} => Types::DBCluster
|
@@ -6046,6 +6159,7 @@ module Aws::Neptune
|
|
6046
6159
|
# enable_iam_database_authentication: false,
|
6047
6160
|
# enable_cloudwatch_logs_exports: ["String"],
|
6048
6161
|
# db_cluster_parameter_group_name: "String",
|
6162
|
+
# deletion_protection: false,
|
6049
6163
|
# })
|
6050
6164
|
#
|
6051
6165
|
# @example Response structure
|
@@ -6099,6 +6213,7 @@ module Aws::Neptune
|
|
6099
6213
|
# resp.db_cluster.cluster_create_time #=> Time
|
6100
6214
|
# resp.db_cluster.enabled_cloudwatch_logs_exports #=> Array
|
6101
6215
|
# resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String
|
6216
|
+
# resp.db_cluster.deletion_protection #=> Boolean
|
6102
6217
|
#
|
6103
6218
|
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-2014-10-31/RestoreDBClusterToPointInTime AWS API Documentation
|
6104
6219
|
#
|
@@ -6109,6 +6224,169 @@ module Aws::Neptune
|
|
6109
6224
|
req.send_request(options)
|
6110
6225
|
end
|
6111
6226
|
|
6227
|
+
# Starts an Amazon Neptune DB cluster that was stopped using the AWS
|
6228
|
+
# console, the AWS CLI stop-db-cluster command, or the StopDBCluster
|
6229
|
+
# API.
|
6230
|
+
#
|
6231
|
+
# @option params [required, String] :db_cluster_identifier
|
6232
|
+
# The DB cluster identifier of the Neptune DB cluster to be started.
|
6233
|
+
# This parameter is stored as a lowercase string.
|
6234
|
+
#
|
6235
|
+
# @return [Types::StartDBClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6236
|
+
#
|
6237
|
+
# * {Types::StartDBClusterResult#db_cluster #db_cluster} => Types::DBCluster
|
6238
|
+
#
|
6239
|
+
# @example Request syntax with placeholder values
|
6240
|
+
#
|
6241
|
+
# resp = client.start_db_cluster({
|
6242
|
+
# db_cluster_identifier: "String", # required
|
6243
|
+
# })
|
6244
|
+
#
|
6245
|
+
# @example Response structure
|
6246
|
+
#
|
6247
|
+
# resp.db_cluster.allocated_storage #=> Integer
|
6248
|
+
# resp.db_cluster.availability_zones #=> Array
|
6249
|
+
# resp.db_cluster.availability_zones[0] #=> String
|
6250
|
+
# resp.db_cluster.backup_retention_period #=> Integer
|
6251
|
+
# resp.db_cluster.character_set_name #=> String
|
6252
|
+
# resp.db_cluster.database_name #=> String
|
6253
|
+
# resp.db_cluster.db_cluster_identifier #=> String
|
6254
|
+
# resp.db_cluster.db_cluster_parameter_group #=> String
|
6255
|
+
# resp.db_cluster.db_subnet_group #=> String
|
6256
|
+
# resp.db_cluster.status #=> String
|
6257
|
+
# resp.db_cluster.percent_progress #=> String
|
6258
|
+
# resp.db_cluster.earliest_restorable_time #=> Time
|
6259
|
+
# resp.db_cluster.endpoint #=> String
|
6260
|
+
# resp.db_cluster.reader_endpoint #=> String
|
6261
|
+
# resp.db_cluster.multi_az #=> Boolean
|
6262
|
+
# resp.db_cluster.engine #=> String
|
6263
|
+
# resp.db_cluster.engine_version #=> String
|
6264
|
+
# resp.db_cluster.latest_restorable_time #=> Time
|
6265
|
+
# resp.db_cluster.port #=> Integer
|
6266
|
+
# resp.db_cluster.master_username #=> String
|
6267
|
+
# resp.db_cluster.db_cluster_option_group_memberships #=> Array
|
6268
|
+
# resp.db_cluster.db_cluster_option_group_memberships[0].db_cluster_option_group_name #=> String
|
6269
|
+
# resp.db_cluster.db_cluster_option_group_memberships[0].status #=> String
|
6270
|
+
# resp.db_cluster.preferred_backup_window #=> String
|
6271
|
+
# resp.db_cluster.preferred_maintenance_window #=> String
|
6272
|
+
# resp.db_cluster.replication_source_identifier #=> String
|
6273
|
+
# resp.db_cluster.read_replica_identifiers #=> Array
|
6274
|
+
# resp.db_cluster.read_replica_identifiers[0] #=> String
|
6275
|
+
# resp.db_cluster.db_cluster_members #=> Array
|
6276
|
+
# resp.db_cluster.db_cluster_members[0].db_instance_identifier #=> String
|
6277
|
+
# resp.db_cluster.db_cluster_members[0].is_cluster_writer #=> Boolean
|
6278
|
+
# resp.db_cluster.db_cluster_members[0].db_cluster_parameter_group_status #=> String
|
6279
|
+
# resp.db_cluster.db_cluster_members[0].promotion_tier #=> Integer
|
6280
|
+
# resp.db_cluster.vpc_security_groups #=> Array
|
6281
|
+
# resp.db_cluster.vpc_security_groups[0].vpc_security_group_id #=> String
|
6282
|
+
# resp.db_cluster.vpc_security_groups[0].status #=> String
|
6283
|
+
# resp.db_cluster.hosted_zone_id #=> String
|
6284
|
+
# resp.db_cluster.storage_encrypted #=> Boolean
|
6285
|
+
# resp.db_cluster.kms_key_id #=> String
|
6286
|
+
# resp.db_cluster.db_cluster_resource_id #=> String
|
6287
|
+
# resp.db_cluster.db_cluster_arn #=> String
|
6288
|
+
# resp.db_cluster.associated_roles #=> Array
|
6289
|
+
# resp.db_cluster.associated_roles[0].role_arn #=> String
|
6290
|
+
# resp.db_cluster.associated_roles[0].status #=> String
|
6291
|
+
# resp.db_cluster.iam_database_authentication_enabled #=> Boolean
|
6292
|
+
# resp.db_cluster.clone_group_id #=> String
|
6293
|
+
# resp.db_cluster.cluster_create_time #=> Time
|
6294
|
+
# resp.db_cluster.enabled_cloudwatch_logs_exports #=> Array
|
6295
|
+
# resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String
|
6296
|
+
# resp.db_cluster.deletion_protection #=> Boolean
|
6297
|
+
#
|
6298
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-2014-10-31/StartDBCluster AWS API Documentation
|
6299
|
+
#
|
6300
|
+
# @overload start_db_cluster(params = {})
|
6301
|
+
# @param [Hash] params ({})
|
6302
|
+
def start_db_cluster(params = {}, options = {})
|
6303
|
+
req = build_request(:start_db_cluster, params)
|
6304
|
+
req.send_request(options)
|
6305
|
+
end
|
6306
|
+
|
6307
|
+
# Stops an Amazon Neptune DB cluster. When you stop a DB cluster,
|
6308
|
+
# Neptune retains the DB cluster's metadata, including its endpoints
|
6309
|
+
# and DB parameter groups.
|
6310
|
+
#
|
6311
|
+
# Neptune also retains the transaction logs so you can do a
|
6312
|
+
# point-in-time restore if necessary.
|
6313
|
+
#
|
6314
|
+
# @option params [required, String] :db_cluster_identifier
|
6315
|
+
# The DB cluster identifier of the Neptune DB cluster to be stopped.
|
6316
|
+
# This parameter is stored as a lowercase string.
|
6317
|
+
#
|
6318
|
+
# @return [Types::StopDBClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6319
|
+
#
|
6320
|
+
# * {Types::StopDBClusterResult#db_cluster #db_cluster} => Types::DBCluster
|
6321
|
+
#
|
6322
|
+
# @example Request syntax with placeholder values
|
6323
|
+
#
|
6324
|
+
# resp = client.stop_db_cluster({
|
6325
|
+
# db_cluster_identifier: "String", # required
|
6326
|
+
# })
|
6327
|
+
#
|
6328
|
+
# @example Response structure
|
6329
|
+
#
|
6330
|
+
# resp.db_cluster.allocated_storage #=> Integer
|
6331
|
+
# resp.db_cluster.availability_zones #=> Array
|
6332
|
+
# resp.db_cluster.availability_zones[0] #=> String
|
6333
|
+
# resp.db_cluster.backup_retention_period #=> Integer
|
6334
|
+
# resp.db_cluster.character_set_name #=> String
|
6335
|
+
# resp.db_cluster.database_name #=> String
|
6336
|
+
# resp.db_cluster.db_cluster_identifier #=> String
|
6337
|
+
# resp.db_cluster.db_cluster_parameter_group #=> String
|
6338
|
+
# resp.db_cluster.db_subnet_group #=> String
|
6339
|
+
# resp.db_cluster.status #=> String
|
6340
|
+
# resp.db_cluster.percent_progress #=> String
|
6341
|
+
# resp.db_cluster.earliest_restorable_time #=> Time
|
6342
|
+
# resp.db_cluster.endpoint #=> String
|
6343
|
+
# resp.db_cluster.reader_endpoint #=> String
|
6344
|
+
# resp.db_cluster.multi_az #=> Boolean
|
6345
|
+
# resp.db_cluster.engine #=> String
|
6346
|
+
# resp.db_cluster.engine_version #=> String
|
6347
|
+
# resp.db_cluster.latest_restorable_time #=> Time
|
6348
|
+
# resp.db_cluster.port #=> Integer
|
6349
|
+
# resp.db_cluster.master_username #=> String
|
6350
|
+
# resp.db_cluster.db_cluster_option_group_memberships #=> Array
|
6351
|
+
# resp.db_cluster.db_cluster_option_group_memberships[0].db_cluster_option_group_name #=> String
|
6352
|
+
# resp.db_cluster.db_cluster_option_group_memberships[0].status #=> String
|
6353
|
+
# resp.db_cluster.preferred_backup_window #=> String
|
6354
|
+
# resp.db_cluster.preferred_maintenance_window #=> String
|
6355
|
+
# resp.db_cluster.replication_source_identifier #=> String
|
6356
|
+
# resp.db_cluster.read_replica_identifiers #=> Array
|
6357
|
+
# resp.db_cluster.read_replica_identifiers[0] #=> String
|
6358
|
+
# resp.db_cluster.db_cluster_members #=> Array
|
6359
|
+
# resp.db_cluster.db_cluster_members[0].db_instance_identifier #=> String
|
6360
|
+
# resp.db_cluster.db_cluster_members[0].is_cluster_writer #=> Boolean
|
6361
|
+
# resp.db_cluster.db_cluster_members[0].db_cluster_parameter_group_status #=> String
|
6362
|
+
# resp.db_cluster.db_cluster_members[0].promotion_tier #=> Integer
|
6363
|
+
# resp.db_cluster.vpc_security_groups #=> Array
|
6364
|
+
# resp.db_cluster.vpc_security_groups[0].vpc_security_group_id #=> String
|
6365
|
+
# resp.db_cluster.vpc_security_groups[0].status #=> String
|
6366
|
+
# resp.db_cluster.hosted_zone_id #=> String
|
6367
|
+
# resp.db_cluster.storage_encrypted #=> Boolean
|
6368
|
+
# resp.db_cluster.kms_key_id #=> String
|
6369
|
+
# resp.db_cluster.db_cluster_resource_id #=> String
|
6370
|
+
# resp.db_cluster.db_cluster_arn #=> String
|
6371
|
+
# resp.db_cluster.associated_roles #=> Array
|
6372
|
+
# resp.db_cluster.associated_roles[0].role_arn #=> String
|
6373
|
+
# resp.db_cluster.associated_roles[0].status #=> String
|
6374
|
+
# resp.db_cluster.iam_database_authentication_enabled #=> Boolean
|
6375
|
+
# resp.db_cluster.clone_group_id #=> String
|
6376
|
+
# resp.db_cluster.cluster_create_time #=> Time
|
6377
|
+
# resp.db_cluster.enabled_cloudwatch_logs_exports #=> Array
|
6378
|
+
# resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String
|
6379
|
+
# resp.db_cluster.deletion_protection #=> Boolean
|
6380
|
+
#
|
6381
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-2014-10-31/StopDBCluster AWS API Documentation
|
6382
|
+
#
|
6383
|
+
# @overload stop_db_cluster(params = {})
|
6384
|
+
# @param [Hash] params ({})
|
6385
|
+
def stop_db_cluster(params = {}, options = {})
|
6386
|
+
req = build_request(:stop_db_cluster, params)
|
6387
|
+
req.send_request(options)
|
6388
|
+
end
|
6389
|
+
|
6112
6390
|
# @!endgroup
|
6113
6391
|
|
6114
6392
|
# @param params ({})
|
@@ -6122,7 +6400,7 @@ module Aws::Neptune
|
|
6122
6400
|
params: params,
|
6123
6401
|
config: config)
|
6124
6402
|
context[:gem_name] = 'aws-sdk-neptune'
|
6125
|
-
context[:gem_version] = '1.
|
6403
|
+
context[:gem_version] = '1.24.0'
|
6126
6404
|
Seahorse::Client::Request.new(handlers, context)
|
6127
6405
|
end
|
6128
6406
|
|
@@ -6188,10 +6466,10 @@ module Aws::Neptune
|
|
6188
6466
|
# The following table lists the valid waiter names, the operations they call,
|
6189
6467
|
# and the default `:delay` and `:max_attempts` values.
|
6190
6468
|
#
|
6191
|
-
# | waiter_name | params
|
6192
|
-
# | --------------------- |
|
6193
|
-
# | db_instance_available | {#describe_db_instances} | 30 | 60 |
|
6194
|
-
# | db_instance_deleted | {#describe_db_instances} | 30 | 60 |
|
6469
|
+
# | waiter_name | params | :delay | :max_attempts |
|
6470
|
+
# | --------------------- | ------------------------------ | -------- | ------------- |
|
6471
|
+
# | db_instance_available | {Client#describe_db_instances} | 30 | 60 |
|
6472
|
+
# | db_instance_deleted | {Client#describe_db_instances} | 30 | 60 |
|
6195
6473
|
#
|
6196
6474
|
# @raise [Errors::FailureStateError] Raised when the waiter terminates
|
6197
6475
|
# because the waiter has entered a state that it will not transition
|