aws-sdk-neptune 1.28.0 → 1.33.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-neptune.rb +2 -1
- data/lib/aws-sdk-neptune/client.rb +336 -13
- data/lib/aws-sdk-neptune/client_api.rb +161 -0
- data/lib/aws-sdk-neptune/errors.rb +44 -0
- data/lib/aws-sdk-neptune/plugins/cross_region_copying.rb +67 -0
- data/lib/aws-sdk-neptune/types.rb +637 -17
- metadata +5 -4
@@ -16,6 +16,7 @@ module Aws::Neptune
|
|
16
16
|
# {
|
17
17
|
# db_cluster_identifier: "String", # required
|
18
18
|
# role_arn: "String", # required
|
19
|
+
# feature_name: "String",
|
19
20
|
# }
|
20
21
|
#
|
21
22
|
# @!attribute [rw] db_cluster_identifier
|
@@ -28,11 +29,18 @@ module Aws::Neptune
|
|
28
29
|
# `arn:aws:iam::123456789012:role/NeptuneAccessRole`.
|
29
30
|
# @return [String]
|
30
31
|
#
|
32
|
+
# @!attribute [rw] feature_name
|
33
|
+
# The name of the feature for the Neptune DB cluster that the IAM role
|
34
|
+
# is to be associated with. For the list of supported feature names,
|
35
|
+
# see DBEngineVersion.
|
36
|
+
# @return [String]
|
37
|
+
#
|
31
38
|
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-2014-10-31/AddRoleToDBClusterMessage AWS API Documentation
|
32
39
|
#
|
33
40
|
class AddRoleToDBClusterMessage < Struct.new(
|
34
41
|
:db_cluster_identifier,
|
35
|
-
:role_arn
|
42
|
+
:role_arn,
|
43
|
+
:feature_name)
|
36
44
|
SENSITIVE = []
|
37
45
|
include Aws::Structure
|
38
46
|
end
|
@@ -373,6 +381,7 @@ module Aws::Neptune
|
|
373
381
|
# value: "String",
|
374
382
|
# },
|
375
383
|
# ],
|
384
|
+
# source_region: "String",
|
376
385
|
# }
|
377
386
|
#
|
378
387
|
# @!attribute [rw] source_db_cluster_snapshot_identifier
|
@@ -442,6 +451,11 @@ module Aws::Neptune
|
|
442
451
|
# The tags to assign to the new DB cluster snapshot copy.
|
443
452
|
# @return [Array<Types::Tag>]
|
444
453
|
#
|
454
|
+
# @!attribute [rw] source_region
|
455
|
+
# The source region of the snapshot. This is only needed when the
|
456
|
+
# shapshot is encrypted and in a different region.
|
457
|
+
# @return [String]
|
458
|
+
#
|
445
459
|
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-2014-10-31/CopyDBClusterSnapshotMessage AWS API Documentation
|
446
460
|
#
|
447
461
|
class CopyDBClusterSnapshotMessage < Struct.new(
|
@@ -450,7 +464,8 @@ module Aws::Neptune
|
|
450
464
|
:kms_key_id,
|
451
465
|
:pre_signed_url,
|
452
466
|
:copy_tags,
|
453
|
-
:tags
|
467
|
+
:tags,
|
468
|
+
:source_region)
|
454
469
|
SENSITIVE = []
|
455
470
|
include Aws::Structure
|
456
471
|
end
|
@@ -552,6 +567,150 @@ module Aws::Neptune
|
|
552
567
|
include Aws::Structure
|
553
568
|
end
|
554
569
|
|
570
|
+
# @note When making an API call, you may pass CreateDBClusterEndpointMessage
|
571
|
+
# data as a hash:
|
572
|
+
#
|
573
|
+
# {
|
574
|
+
# db_cluster_identifier: "String", # required
|
575
|
+
# db_cluster_endpoint_identifier: "String", # required
|
576
|
+
# endpoint_type: "String", # required
|
577
|
+
# static_members: ["String"],
|
578
|
+
# excluded_members: ["String"],
|
579
|
+
# tags: [
|
580
|
+
# {
|
581
|
+
# key: "String",
|
582
|
+
# value: "String",
|
583
|
+
# },
|
584
|
+
# ],
|
585
|
+
# }
|
586
|
+
#
|
587
|
+
# @!attribute [rw] db_cluster_identifier
|
588
|
+
# The DB cluster identifier of the DB cluster associated with the
|
589
|
+
# endpoint. This parameter is stored as a lowercase string.
|
590
|
+
# @return [String]
|
591
|
+
#
|
592
|
+
# @!attribute [rw] db_cluster_endpoint_identifier
|
593
|
+
# The identifier to use for the new endpoint. This parameter is stored
|
594
|
+
# as a lowercase string.
|
595
|
+
# @return [String]
|
596
|
+
#
|
597
|
+
# @!attribute [rw] endpoint_type
|
598
|
+
# The type of the endpoint. One of: `READER`, `WRITER`, `ANY`.
|
599
|
+
# @return [String]
|
600
|
+
#
|
601
|
+
# @!attribute [rw] static_members
|
602
|
+
# List of DB instance identifiers that are part of the custom endpoint
|
603
|
+
# group.
|
604
|
+
# @return [Array<String>]
|
605
|
+
#
|
606
|
+
# @!attribute [rw] excluded_members
|
607
|
+
# List of DB instance identifiers that aren't part of the custom
|
608
|
+
# endpoint group. All other eligible instances are reachable through
|
609
|
+
# the custom endpoint. Only relevant if the list of static members is
|
610
|
+
# empty.
|
611
|
+
# @return [Array<String>]
|
612
|
+
#
|
613
|
+
# @!attribute [rw] tags
|
614
|
+
# The tags to be assigned to the Amazon Neptune resource.
|
615
|
+
# @return [Array<Types::Tag>]
|
616
|
+
#
|
617
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-2014-10-31/CreateDBClusterEndpointMessage AWS API Documentation
|
618
|
+
#
|
619
|
+
class CreateDBClusterEndpointMessage < Struct.new(
|
620
|
+
:db_cluster_identifier,
|
621
|
+
:db_cluster_endpoint_identifier,
|
622
|
+
:endpoint_type,
|
623
|
+
:static_members,
|
624
|
+
:excluded_members,
|
625
|
+
:tags)
|
626
|
+
SENSITIVE = []
|
627
|
+
include Aws::Structure
|
628
|
+
end
|
629
|
+
|
630
|
+
# This data type represents the information you need to connect to an
|
631
|
+
# Amazon Neptune DB cluster. This data type is used as a response
|
632
|
+
# element in the following actions:
|
633
|
+
#
|
634
|
+
# * `CreateDBClusterEndpoint`
|
635
|
+
#
|
636
|
+
# * `DescribeDBClusterEndpoints`
|
637
|
+
#
|
638
|
+
# * `ModifyDBClusterEndpoint`
|
639
|
+
#
|
640
|
+
# * `DeleteDBClusterEndpoint`
|
641
|
+
#
|
642
|
+
# For the data structure that represents Amazon Neptune DB instance
|
643
|
+
# endpoints, see `Endpoint`.
|
644
|
+
#
|
645
|
+
# @!attribute [rw] db_cluster_endpoint_identifier
|
646
|
+
# The identifier associated with the endpoint. This parameter is
|
647
|
+
# stored as a lowercase string.
|
648
|
+
# @return [String]
|
649
|
+
#
|
650
|
+
# @!attribute [rw] db_cluster_identifier
|
651
|
+
# The DB cluster identifier of the DB cluster associated with the
|
652
|
+
# endpoint. This parameter is stored as a lowercase string.
|
653
|
+
# @return [String]
|
654
|
+
#
|
655
|
+
# @!attribute [rw] db_cluster_endpoint_resource_identifier
|
656
|
+
# A unique system-generated identifier for an endpoint. It remains the
|
657
|
+
# same for the whole life of the endpoint.
|
658
|
+
# @return [String]
|
659
|
+
#
|
660
|
+
# @!attribute [rw] endpoint
|
661
|
+
# The DNS address of the endpoint.
|
662
|
+
# @return [String]
|
663
|
+
#
|
664
|
+
# @!attribute [rw] status
|
665
|
+
# The current status of the endpoint. One of: `creating`, `available`,
|
666
|
+
# `deleting`, `inactive`, `modifying`. The `inactive` state applies to
|
667
|
+
# an endpoint that cannot be used for a certain kind of cluster, such
|
668
|
+
# as a `writer` endpoint for a read-only secondary cluster in a global
|
669
|
+
# database.
|
670
|
+
# @return [String]
|
671
|
+
#
|
672
|
+
# @!attribute [rw] endpoint_type
|
673
|
+
# The type of the endpoint. One of: `READER`, `WRITER`, `CUSTOM`.
|
674
|
+
# @return [String]
|
675
|
+
#
|
676
|
+
# @!attribute [rw] custom_endpoint_type
|
677
|
+
# The type associated with a custom endpoint. One of: `READER`,
|
678
|
+
# `WRITER`, `ANY`.
|
679
|
+
# @return [String]
|
680
|
+
#
|
681
|
+
# @!attribute [rw] static_members
|
682
|
+
# List of DB instance identifiers that are part of the custom endpoint
|
683
|
+
# group.
|
684
|
+
# @return [Array<String>]
|
685
|
+
#
|
686
|
+
# @!attribute [rw] excluded_members
|
687
|
+
# List of DB instance identifiers that aren't part of the custom
|
688
|
+
# endpoint group. All other eligible instances are reachable through
|
689
|
+
# the custom endpoint. Only relevant if the list of static members is
|
690
|
+
# empty.
|
691
|
+
# @return [Array<String>]
|
692
|
+
#
|
693
|
+
# @!attribute [rw] db_cluster_endpoint_arn
|
694
|
+
# The Amazon Resource Name (ARN) for the endpoint.
|
695
|
+
# @return [String]
|
696
|
+
#
|
697
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-2014-10-31/CreateDBClusterEndpointOutput AWS API Documentation
|
698
|
+
#
|
699
|
+
class CreateDBClusterEndpointOutput < Struct.new(
|
700
|
+
:db_cluster_endpoint_identifier,
|
701
|
+
:db_cluster_identifier,
|
702
|
+
:db_cluster_endpoint_resource_identifier,
|
703
|
+
:endpoint,
|
704
|
+
:status,
|
705
|
+
:endpoint_type,
|
706
|
+
:custom_endpoint_type,
|
707
|
+
:static_members,
|
708
|
+
:excluded_members,
|
709
|
+
:db_cluster_endpoint_arn)
|
710
|
+
SENSITIVE = []
|
711
|
+
include Aws::Structure
|
712
|
+
end
|
713
|
+
|
555
714
|
# @note When making an API call, you may pass CreateDBClusterMessage
|
556
715
|
# data as a hash:
|
557
716
|
#
|
@@ -585,6 +744,7 @@ module Aws::Neptune
|
|
585
744
|
# enable_iam_database_authentication: false,
|
586
745
|
# enable_cloudwatch_logs_exports: ["String"],
|
587
746
|
# deletion_protection: false,
|
747
|
+
# source_region: "String",
|
588
748
|
# }
|
589
749
|
#
|
590
750
|
# @!attribute [rw] availability_zones
|
@@ -662,10 +822,10 @@ module Aws::Neptune
|
|
662
822
|
# @return [String]
|
663
823
|
#
|
664
824
|
# @!attribute [rw] engine_version
|
665
|
-
# The version number of the database engine to use
|
666
|
-
#
|
825
|
+
# The version number of the database engine to use for the new DB
|
826
|
+
# cluster.
|
667
827
|
#
|
668
|
-
# Example: `1.0.1`
|
828
|
+
# Example: `1.0.2.1`
|
669
829
|
# @return [String]
|
670
830
|
#
|
671
831
|
# @!attribute [rw] port
|
@@ -791,10 +951,7 @@ module Aws::Neptune
|
|
791
951
|
# @return [String]
|
792
952
|
#
|
793
953
|
# @!attribute [rw] enable_iam_database_authentication
|
794
|
-
#
|
795
|
-
# accounts to database accounts, and otherwise false.
|
796
|
-
#
|
797
|
-
# Default: `false`
|
954
|
+
# Not supported by Neptune.
|
798
955
|
# @return [Boolean]
|
799
956
|
#
|
800
957
|
# @!attribute [rw] enable_cloudwatch_logs_exports
|
@@ -808,6 +965,11 @@ module Aws::Neptune
|
|
808
965
|
# protection is enabled. By default, deletion protection is enabled.
|
809
966
|
# @return [Boolean]
|
810
967
|
#
|
968
|
+
# @!attribute [rw] source_region
|
969
|
+
# The source region of the snapshot. This is only needed when the
|
970
|
+
# shapshot is encrypted and in a different region.
|
971
|
+
# @return [String]
|
972
|
+
#
|
811
973
|
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-2014-10-31/CreateDBClusterMessage AWS API Documentation
|
812
974
|
#
|
813
975
|
class CreateDBClusterMessage < Struct.new(
|
@@ -834,7 +996,8 @@ module Aws::Neptune
|
|
834
996
|
:pre_signed_url,
|
835
997
|
:enable_iam_database_authentication,
|
836
998
|
:enable_cloudwatch_logs_exports,
|
837
|
-
:deletion_protection
|
999
|
+
:deletion_protection,
|
1000
|
+
:source_region)
|
838
1001
|
SENSITIVE = []
|
839
1002
|
include Aws::Structure
|
840
1003
|
end
|
@@ -1938,6 +2101,130 @@ module Aws::Neptune
|
|
1938
2101
|
#
|
1939
2102
|
class DBClusterAlreadyExistsFault < Aws::EmptyStructure; end
|
1940
2103
|
|
2104
|
+
# This data type represents the information you need to connect to an
|
2105
|
+
# Amazon Neptune DB cluster. This data type is used as a response
|
2106
|
+
# element in the following actions:
|
2107
|
+
#
|
2108
|
+
# * `CreateDBClusterEndpoint`
|
2109
|
+
#
|
2110
|
+
# * `DescribeDBClusterEndpoints`
|
2111
|
+
#
|
2112
|
+
# * `ModifyDBClusterEndpoint`
|
2113
|
+
#
|
2114
|
+
# * `DeleteDBClusterEndpoint`
|
2115
|
+
#
|
2116
|
+
# For the data structure that represents Amazon Neptune DB instance
|
2117
|
+
# endpoints, see `Endpoint`.
|
2118
|
+
#
|
2119
|
+
# @!attribute [rw] db_cluster_endpoint_identifier
|
2120
|
+
# The identifier associated with the endpoint. This parameter is
|
2121
|
+
# stored as a lowercase string.
|
2122
|
+
# @return [String]
|
2123
|
+
#
|
2124
|
+
# @!attribute [rw] db_cluster_identifier
|
2125
|
+
# The DB cluster identifier of the DB cluster associated with the
|
2126
|
+
# endpoint. This parameter is stored as a lowercase string.
|
2127
|
+
# @return [String]
|
2128
|
+
#
|
2129
|
+
# @!attribute [rw] db_cluster_endpoint_resource_identifier
|
2130
|
+
# A unique system-generated identifier for an endpoint. It remains the
|
2131
|
+
# same for the whole life of the endpoint.
|
2132
|
+
# @return [String]
|
2133
|
+
#
|
2134
|
+
# @!attribute [rw] endpoint
|
2135
|
+
# The DNS address of the endpoint.
|
2136
|
+
# @return [String]
|
2137
|
+
#
|
2138
|
+
# @!attribute [rw] status
|
2139
|
+
# The current status of the endpoint. One of: `creating`, `available`,
|
2140
|
+
# `deleting`, `inactive`, `modifying`. The `inactive` state applies to
|
2141
|
+
# an endpoint that cannot be used for a certain kind of cluster, such
|
2142
|
+
# as a `writer` endpoint for a read-only secondary cluster in a global
|
2143
|
+
# database.
|
2144
|
+
# @return [String]
|
2145
|
+
#
|
2146
|
+
# @!attribute [rw] endpoint_type
|
2147
|
+
# The type of the endpoint. One of: `READER`, `WRITER`, `CUSTOM`.
|
2148
|
+
# @return [String]
|
2149
|
+
#
|
2150
|
+
# @!attribute [rw] custom_endpoint_type
|
2151
|
+
# The type associated with a custom endpoint. One of: `READER`,
|
2152
|
+
# `WRITER`, `ANY`.
|
2153
|
+
# @return [String]
|
2154
|
+
#
|
2155
|
+
# @!attribute [rw] static_members
|
2156
|
+
# List of DB instance identifiers that are part of the custom endpoint
|
2157
|
+
# group.
|
2158
|
+
# @return [Array<String>]
|
2159
|
+
#
|
2160
|
+
# @!attribute [rw] excluded_members
|
2161
|
+
# List of DB instance identifiers that aren't part of the custom
|
2162
|
+
# endpoint group. All other eligible instances are reachable through
|
2163
|
+
# the custom endpoint. Only relevant if the list of static members is
|
2164
|
+
# empty.
|
2165
|
+
# @return [Array<String>]
|
2166
|
+
#
|
2167
|
+
# @!attribute [rw] db_cluster_endpoint_arn
|
2168
|
+
# The Amazon Resource Name (ARN) for the endpoint.
|
2169
|
+
# @return [String]
|
2170
|
+
#
|
2171
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-2014-10-31/DBClusterEndpoint AWS API Documentation
|
2172
|
+
#
|
2173
|
+
class DBClusterEndpoint < Struct.new(
|
2174
|
+
:db_cluster_endpoint_identifier,
|
2175
|
+
:db_cluster_identifier,
|
2176
|
+
:db_cluster_endpoint_resource_identifier,
|
2177
|
+
:endpoint,
|
2178
|
+
:status,
|
2179
|
+
:endpoint_type,
|
2180
|
+
:custom_endpoint_type,
|
2181
|
+
:static_members,
|
2182
|
+
:excluded_members,
|
2183
|
+
:db_cluster_endpoint_arn)
|
2184
|
+
SENSITIVE = []
|
2185
|
+
include Aws::Structure
|
2186
|
+
end
|
2187
|
+
|
2188
|
+
# The specified custom endpoint cannot be created because it already
|
2189
|
+
# exists.
|
2190
|
+
#
|
2191
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-2014-10-31/DBClusterEndpointAlreadyExistsFault AWS API Documentation
|
2192
|
+
#
|
2193
|
+
class DBClusterEndpointAlreadyExistsFault < Aws::EmptyStructure; end
|
2194
|
+
|
2195
|
+
# @!attribute [rw] marker
|
2196
|
+
# An optional pagination token provided by a previous
|
2197
|
+
# `DescribeDBClusterEndpoints` request. If this parameter is
|
2198
|
+
# specified, the response includes only records beyond the marker, up
|
2199
|
+
# to the value specified by `MaxRecords`.
|
2200
|
+
# @return [String]
|
2201
|
+
#
|
2202
|
+
# @!attribute [rw] db_cluster_endpoints
|
2203
|
+
# Contains the details of the endpoints associated with the cluster
|
2204
|
+
# and matching any filter conditions.
|
2205
|
+
# @return [Array<Types::DBClusterEndpoint>]
|
2206
|
+
#
|
2207
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-2014-10-31/DBClusterEndpointMessage AWS API Documentation
|
2208
|
+
#
|
2209
|
+
class DBClusterEndpointMessage < Struct.new(
|
2210
|
+
:marker,
|
2211
|
+
:db_cluster_endpoints)
|
2212
|
+
SENSITIVE = []
|
2213
|
+
include Aws::Structure
|
2214
|
+
end
|
2215
|
+
|
2216
|
+
# The specified custom endpoint doesn't exist.
|
2217
|
+
#
|
2218
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-2014-10-31/DBClusterEndpointNotFoundFault AWS API Documentation
|
2219
|
+
#
|
2220
|
+
class DBClusterEndpointNotFoundFault < Aws::EmptyStructure; end
|
2221
|
+
|
2222
|
+
# The cluster already has the maximum number of custom endpoints.
|
2223
|
+
#
|
2224
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-2014-10-31/DBClusterEndpointQuotaExceededFault AWS API Documentation
|
2225
|
+
#
|
2226
|
+
class DBClusterEndpointQuotaExceededFault < Aws::EmptyStructure; end
|
2227
|
+
|
1941
2228
|
# Contains information about an instance that is part of a DB cluster.
|
1942
2229
|
#
|
1943
2230
|
# @!attribute [rw] db_instance_identifier
|
@@ -2149,11 +2436,18 @@ module Aws::Neptune
|
|
2149
2436
|
# access other AWS services on your behalf.
|
2150
2437
|
# @return [String]
|
2151
2438
|
#
|
2439
|
+
# @!attribute [rw] feature_name
|
2440
|
+
# The name of the feature associated with the AWS Identity and Access
|
2441
|
+
# Management (IAM) role. For the list of supported feature names, see
|
2442
|
+
# DBEngineVersion.
|
2443
|
+
# @return [String]
|
2444
|
+
#
|
2152
2445
|
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-2014-10-31/DBClusterRole AWS API Documentation
|
2153
2446
|
#
|
2154
2447
|
class DBClusterRole < Struct.new(
|
2155
2448
|
:role_arn,
|
2156
|
-
:status
|
2449
|
+
:status,
|
2450
|
+
:feature_name)
|
2157
2451
|
SENSITIVE = []
|
2158
2452
|
include Aws::Structure
|
2159
2453
|
end
|
@@ -3160,6 +3454,110 @@ module Aws::Neptune
|
|
3160
3454
|
#
|
3161
3455
|
class DBUpgradeDependencyFailureFault < Aws::EmptyStructure; end
|
3162
3456
|
|
3457
|
+
# @note When making an API call, you may pass DeleteDBClusterEndpointMessage
|
3458
|
+
# data as a hash:
|
3459
|
+
#
|
3460
|
+
# {
|
3461
|
+
# db_cluster_endpoint_identifier: "String", # required
|
3462
|
+
# }
|
3463
|
+
#
|
3464
|
+
# @!attribute [rw] db_cluster_endpoint_identifier
|
3465
|
+
# The identifier associated with the custom endpoint. This parameter
|
3466
|
+
# is stored as a lowercase string.
|
3467
|
+
# @return [String]
|
3468
|
+
#
|
3469
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-2014-10-31/DeleteDBClusterEndpointMessage AWS API Documentation
|
3470
|
+
#
|
3471
|
+
class DeleteDBClusterEndpointMessage < Struct.new(
|
3472
|
+
:db_cluster_endpoint_identifier)
|
3473
|
+
SENSITIVE = []
|
3474
|
+
include Aws::Structure
|
3475
|
+
end
|
3476
|
+
|
3477
|
+
# This data type represents the information you need to connect to an
|
3478
|
+
# Amazon Neptune DB cluster. This data type is used as a response
|
3479
|
+
# element in the following actions:
|
3480
|
+
#
|
3481
|
+
# * `CreateDBClusterEndpoint`
|
3482
|
+
#
|
3483
|
+
# * `DescribeDBClusterEndpoints`
|
3484
|
+
#
|
3485
|
+
# * `ModifyDBClusterEndpoint`
|
3486
|
+
#
|
3487
|
+
# * `DeleteDBClusterEndpoint`
|
3488
|
+
#
|
3489
|
+
# For the data structure that represents Amazon RDS DB instance
|
3490
|
+
# endpoints, see `Endpoint`.
|
3491
|
+
#
|
3492
|
+
# @!attribute [rw] db_cluster_endpoint_identifier
|
3493
|
+
# The identifier associated with the endpoint. This parameter is
|
3494
|
+
# stored as a lowercase string.
|
3495
|
+
# @return [String]
|
3496
|
+
#
|
3497
|
+
# @!attribute [rw] db_cluster_identifier
|
3498
|
+
# The DB cluster identifier of the DB cluster associated with the
|
3499
|
+
# endpoint. This parameter is stored as a lowercase string.
|
3500
|
+
# @return [String]
|
3501
|
+
#
|
3502
|
+
# @!attribute [rw] db_cluster_endpoint_resource_identifier
|
3503
|
+
# A unique system-generated identifier for an endpoint. It remains the
|
3504
|
+
# same for the whole life of the endpoint.
|
3505
|
+
# @return [String]
|
3506
|
+
#
|
3507
|
+
# @!attribute [rw] endpoint
|
3508
|
+
# The DNS address of the endpoint.
|
3509
|
+
# @return [String]
|
3510
|
+
#
|
3511
|
+
# @!attribute [rw] status
|
3512
|
+
# The current status of the endpoint. One of: `creating`, `available`,
|
3513
|
+
# `deleting`, `inactive`, `modifying`. The `inactive` state applies to
|
3514
|
+
# an endpoint that cannot be used for a certain kind of cluster, such
|
3515
|
+
# as a `writer` endpoint for a read-only secondary cluster in a global
|
3516
|
+
# database.
|
3517
|
+
# @return [String]
|
3518
|
+
#
|
3519
|
+
# @!attribute [rw] endpoint_type
|
3520
|
+
# The type of the endpoint. One of: `READER`, `WRITER`, `CUSTOM`.
|
3521
|
+
# @return [String]
|
3522
|
+
#
|
3523
|
+
# @!attribute [rw] custom_endpoint_type
|
3524
|
+
# The type associated with a custom endpoint. One of: `READER`,
|
3525
|
+
# `WRITER`, `ANY`.
|
3526
|
+
# @return [String]
|
3527
|
+
#
|
3528
|
+
# @!attribute [rw] static_members
|
3529
|
+
# List of DB instance identifiers that are part of the custom endpoint
|
3530
|
+
# group.
|
3531
|
+
# @return [Array<String>]
|
3532
|
+
#
|
3533
|
+
# @!attribute [rw] excluded_members
|
3534
|
+
# List of DB instance identifiers that aren't part of the custom
|
3535
|
+
# endpoint group. All other eligible instances are reachable through
|
3536
|
+
# the custom endpoint. Only relevant if the list of static members is
|
3537
|
+
# empty.
|
3538
|
+
# @return [Array<String>]
|
3539
|
+
#
|
3540
|
+
# @!attribute [rw] db_cluster_endpoint_arn
|
3541
|
+
# The Amazon Resource Name (ARN) for the endpoint.
|
3542
|
+
# @return [String]
|
3543
|
+
#
|
3544
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-2014-10-31/DeleteDBClusterEndpointOutput AWS API Documentation
|
3545
|
+
#
|
3546
|
+
class DeleteDBClusterEndpointOutput < Struct.new(
|
3547
|
+
:db_cluster_endpoint_identifier,
|
3548
|
+
:db_cluster_identifier,
|
3549
|
+
:db_cluster_endpoint_resource_identifier,
|
3550
|
+
:endpoint,
|
3551
|
+
:status,
|
3552
|
+
:endpoint_type,
|
3553
|
+
:custom_endpoint_type,
|
3554
|
+
:static_members,
|
3555
|
+
:excluded_members,
|
3556
|
+
:db_cluster_endpoint_arn)
|
3557
|
+
SENSITIVE = []
|
3558
|
+
include Aws::Structure
|
3559
|
+
end
|
3560
|
+
|
3163
3561
|
# @note When making an API call, you may pass DeleteDBClusterMessage
|
3164
3562
|
# data as a hash:
|
3165
3563
|
#
|
@@ -3476,6 +3874,78 @@ module Aws::Neptune
|
|
3476
3874
|
include Aws::Structure
|
3477
3875
|
end
|
3478
3876
|
|
3877
|
+
# @note When making an API call, you may pass DescribeDBClusterEndpointsMessage
|
3878
|
+
# data as a hash:
|
3879
|
+
#
|
3880
|
+
# {
|
3881
|
+
# db_cluster_identifier: "String",
|
3882
|
+
# db_cluster_endpoint_identifier: "String",
|
3883
|
+
# filters: [
|
3884
|
+
# {
|
3885
|
+
# name: "String", # required
|
3886
|
+
# values: ["String"], # required
|
3887
|
+
# },
|
3888
|
+
# ],
|
3889
|
+
# max_records: 1,
|
3890
|
+
# marker: "String",
|
3891
|
+
# }
|
3892
|
+
#
|
3893
|
+
# @!attribute [rw] db_cluster_identifier
|
3894
|
+
# The DB cluster identifier of the DB cluster associated with the
|
3895
|
+
# endpoint. This parameter is stored as a lowercase string.
|
3896
|
+
# @return [String]
|
3897
|
+
#
|
3898
|
+
# @!attribute [rw] db_cluster_endpoint_identifier
|
3899
|
+
# The identifier of the endpoint to describe. This parameter is stored
|
3900
|
+
# as a lowercase string.
|
3901
|
+
# @return [String]
|
3902
|
+
#
|
3903
|
+
# @!attribute [rw] filters
|
3904
|
+
# A set of name-value pairs that define which endpoints to include in
|
3905
|
+
# the output. The filters are specified as name-value pairs, in the
|
3906
|
+
# format
|
3907
|
+
# `Name=endpoint_type,Values=endpoint_type1,endpoint_type2,...`.
|
3908
|
+
# `Name` can be one of: `db-cluster-endpoint-type`,
|
3909
|
+
# `db-cluster-endpoint-custom-type`, `db-cluster-endpoint-id`,
|
3910
|
+
# `db-cluster-endpoint-status`. `Values` for the `
|
3911
|
+
# db-cluster-endpoint-type` filter can be one or more of: `reader`,
|
3912
|
+
# `writer`, `custom`. `Values` for the
|
3913
|
+
# `db-cluster-endpoint-custom-type` filter can be one or more of:
|
3914
|
+
# `reader`, `any`. `Values` for the `db-cluster-endpoint-status`
|
3915
|
+
# filter can be one or more of: `available`, `creating`, `deleting`,
|
3916
|
+
# `inactive`, `modifying`.
|
3917
|
+
# @return [Array<Types::Filter>]
|
3918
|
+
#
|
3919
|
+
# @!attribute [rw] max_records
|
3920
|
+
# The maximum number of records to include in the response. If more
|
3921
|
+
# records exist than the specified `MaxRecords` value, a pagination
|
3922
|
+
# token called a marker is included in the response so you can
|
3923
|
+
# retrieve the remaining results.
|
3924
|
+
#
|
3925
|
+
# Default: 100
|
3926
|
+
#
|
3927
|
+
# Constraints: Minimum 20, maximum 100.
|
3928
|
+
# @return [Integer]
|
3929
|
+
#
|
3930
|
+
# @!attribute [rw] marker
|
3931
|
+
# An optional pagination token provided by a previous
|
3932
|
+
# `DescribeDBClusterEndpoints` request. If this parameter is
|
3933
|
+
# specified, the response includes only records beyond the marker, up
|
3934
|
+
# to the value specified by `MaxRecords`.
|
3935
|
+
# @return [String]
|
3936
|
+
#
|
3937
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-2014-10-31/DescribeDBClusterEndpointsMessage AWS API Documentation
|
3938
|
+
#
|
3939
|
+
class DescribeDBClusterEndpointsMessage < Struct.new(
|
3940
|
+
:db_cluster_identifier,
|
3941
|
+
:db_cluster_endpoint_identifier,
|
3942
|
+
:filters,
|
3943
|
+
:max_records,
|
3944
|
+
:marker)
|
3945
|
+
SENSITIVE = []
|
3946
|
+
include Aws::Structure
|
3947
|
+
end
|
3948
|
+
|
3479
3949
|
# @note When making an API call, you may pass DescribeDBClusterParameterGroupsMessage
|
3480
3950
|
# data as a hash:
|
3481
3951
|
#
|
@@ -4771,6 +5241,9 @@ module Aws::Neptune
|
|
4771
5241
|
|
4772
5242
|
# Specifies a connection endpoint.
|
4773
5243
|
#
|
5244
|
+
# For the data structure that represents Amazon Neptune DB cluster
|
5245
|
+
# endpoints, see `DBClusterEndpoint`.
|
5246
|
+
#
|
4774
5247
|
# @!attribute [rw] address
|
4775
5248
|
# Specifies the DNS address of the DB instance.
|
4776
5249
|
# @return [String]
|
@@ -5118,6 +5591,13 @@ module Aws::Neptune
|
|
5118
5591
|
#
|
5119
5592
|
class InsufficientStorageClusterCapacityFault < Aws::EmptyStructure; end
|
5120
5593
|
|
5594
|
+
# The requested operation cannot be performed on the endpoint while the
|
5595
|
+
# endpoint is in this state.
|
5596
|
+
#
|
5597
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-2014-10-31/InvalidDBClusterEndpointStateFault AWS API Documentation
|
5598
|
+
#
|
5599
|
+
class InvalidDBClusterEndpointStateFault < Aws::EmptyStructure; end
|
5600
|
+
|
5121
5601
|
# The supplied value is not a valid DB cluster snapshot state.
|
5122
5602
|
#
|
5123
5603
|
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-2014-10-31/InvalidDBClusterSnapshotStateFault AWS API Documentation
|
@@ -5236,6 +5716,132 @@ module Aws::Neptune
|
|
5236
5716
|
include Aws::Structure
|
5237
5717
|
end
|
5238
5718
|
|
5719
|
+
# @note When making an API call, you may pass ModifyDBClusterEndpointMessage
|
5720
|
+
# data as a hash:
|
5721
|
+
#
|
5722
|
+
# {
|
5723
|
+
# db_cluster_endpoint_identifier: "String", # required
|
5724
|
+
# endpoint_type: "String",
|
5725
|
+
# static_members: ["String"],
|
5726
|
+
# excluded_members: ["String"],
|
5727
|
+
# }
|
5728
|
+
#
|
5729
|
+
# @!attribute [rw] db_cluster_endpoint_identifier
|
5730
|
+
# The identifier of the endpoint to modify. This parameter is stored
|
5731
|
+
# as a lowercase string.
|
5732
|
+
# @return [String]
|
5733
|
+
#
|
5734
|
+
# @!attribute [rw] endpoint_type
|
5735
|
+
# The type of the endpoint. One of: `READER`, `WRITER`, `ANY`.
|
5736
|
+
# @return [String]
|
5737
|
+
#
|
5738
|
+
# @!attribute [rw] static_members
|
5739
|
+
# List of DB instance identifiers that are part of the custom endpoint
|
5740
|
+
# group.
|
5741
|
+
# @return [Array<String>]
|
5742
|
+
#
|
5743
|
+
# @!attribute [rw] excluded_members
|
5744
|
+
# List of DB instance identifiers that aren't part of the custom
|
5745
|
+
# endpoint group. All other eligible instances are reachable through
|
5746
|
+
# the custom endpoint. Only relevant if the list of static members is
|
5747
|
+
# empty.
|
5748
|
+
# @return [Array<String>]
|
5749
|
+
#
|
5750
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-2014-10-31/ModifyDBClusterEndpointMessage AWS API Documentation
|
5751
|
+
#
|
5752
|
+
class ModifyDBClusterEndpointMessage < Struct.new(
|
5753
|
+
:db_cluster_endpoint_identifier,
|
5754
|
+
:endpoint_type,
|
5755
|
+
:static_members,
|
5756
|
+
:excluded_members)
|
5757
|
+
SENSITIVE = []
|
5758
|
+
include Aws::Structure
|
5759
|
+
end
|
5760
|
+
|
5761
|
+
# This data type represents the information you need to connect to an
|
5762
|
+
# Amazon Aurora DB cluster. This data type is used as a response element
|
5763
|
+
# in the following actions:
|
5764
|
+
#
|
5765
|
+
# * `CreateDBClusterEndpoint`
|
5766
|
+
#
|
5767
|
+
# * `DescribeDBClusterEndpoints`
|
5768
|
+
#
|
5769
|
+
# * `ModifyDBClusterEndpoint`
|
5770
|
+
#
|
5771
|
+
# * `DeleteDBClusterEndpoint`
|
5772
|
+
#
|
5773
|
+
# For the data structure that represents Amazon RDS DB instance
|
5774
|
+
# endpoints, see `Endpoint`.
|
5775
|
+
#
|
5776
|
+
# @!attribute [rw] db_cluster_endpoint_identifier
|
5777
|
+
# The identifier associated with the endpoint. This parameter is
|
5778
|
+
# stored as a lowercase string.
|
5779
|
+
# @return [String]
|
5780
|
+
#
|
5781
|
+
# @!attribute [rw] db_cluster_identifier
|
5782
|
+
# The DB cluster identifier of the DB cluster associated with the
|
5783
|
+
# endpoint. This parameter is stored as a lowercase string.
|
5784
|
+
# @return [String]
|
5785
|
+
#
|
5786
|
+
# @!attribute [rw] db_cluster_endpoint_resource_identifier
|
5787
|
+
# A unique system-generated identifier for an endpoint. It remains the
|
5788
|
+
# same for the whole life of the endpoint.
|
5789
|
+
# @return [String]
|
5790
|
+
#
|
5791
|
+
# @!attribute [rw] endpoint
|
5792
|
+
# The DNS address of the endpoint.
|
5793
|
+
# @return [String]
|
5794
|
+
#
|
5795
|
+
# @!attribute [rw] status
|
5796
|
+
# The current status of the endpoint. One of: `creating`, `available`,
|
5797
|
+
# `deleting`, `inactive`, `modifying`. The `inactive` state applies to
|
5798
|
+
# an endpoint that cannot be used for a certain kind of cluster, such
|
5799
|
+
# as a `writer` endpoint for a read-only secondary cluster in a global
|
5800
|
+
# database.
|
5801
|
+
# @return [String]
|
5802
|
+
#
|
5803
|
+
# @!attribute [rw] endpoint_type
|
5804
|
+
# The type of the endpoint. One of: `READER`, `WRITER`, `CUSTOM`.
|
5805
|
+
# @return [String]
|
5806
|
+
#
|
5807
|
+
# @!attribute [rw] custom_endpoint_type
|
5808
|
+
# The type associated with a custom endpoint. One of: `READER`,
|
5809
|
+
# `WRITER`, `ANY`.
|
5810
|
+
# @return [String]
|
5811
|
+
#
|
5812
|
+
# @!attribute [rw] static_members
|
5813
|
+
# List of DB instance identifiers that are part of the custom endpoint
|
5814
|
+
# group.
|
5815
|
+
# @return [Array<String>]
|
5816
|
+
#
|
5817
|
+
# @!attribute [rw] excluded_members
|
5818
|
+
# List of DB instance identifiers that aren't part of the custom
|
5819
|
+
# endpoint group. All other eligible instances are reachable through
|
5820
|
+
# the custom endpoint. Only relevant if the list of static members is
|
5821
|
+
# empty.
|
5822
|
+
# @return [Array<String>]
|
5823
|
+
#
|
5824
|
+
# @!attribute [rw] db_cluster_endpoint_arn
|
5825
|
+
# The Amazon Resource Name (ARN) for the endpoint.
|
5826
|
+
# @return [String]
|
5827
|
+
#
|
5828
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-2014-10-31/ModifyDBClusterEndpointOutput AWS API Documentation
|
5829
|
+
#
|
5830
|
+
class ModifyDBClusterEndpointOutput < Struct.new(
|
5831
|
+
:db_cluster_endpoint_identifier,
|
5832
|
+
:db_cluster_identifier,
|
5833
|
+
:db_cluster_endpoint_resource_identifier,
|
5834
|
+
:endpoint,
|
5835
|
+
:status,
|
5836
|
+
:endpoint_type,
|
5837
|
+
:custom_endpoint_type,
|
5838
|
+
:static_members,
|
5839
|
+
:excluded_members,
|
5840
|
+
:db_cluster_endpoint_arn)
|
5841
|
+
SENSITIVE = []
|
5842
|
+
include Aws::Structure
|
5843
|
+
end
|
5844
|
+
|
5239
5845
|
# @note When making an API call, you may pass ModifyDBClusterMessage
|
5240
5846
|
# data as a hash:
|
5241
5847
|
#
|
@@ -5393,12 +5999,18 @@ module Aws::Neptune
|
|
5393
5999
|
# @return [Types::CloudwatchLogsExportConfiguration]
|
5394
6000
|
#
|
5395
6001
|
# @!attribute [rw] engine_version
|
5396
|
-
# The version number of the database engine
|
5397
|
-
#
|
5398
|
-
#
|
6002
|
+
# The version number of the database engine to which you want to
|
6003
|
+
# upgrade. Changing this parameter results in an outage. The change is
|
6004
|
+
# applied during the next maintenance window unless the
|
6005
|
+
# `ApplyImmediately` parameter is set to true.
|
6006
|
+
#
|
6007
|
+
# For a list of valid engine versions, see [Engine Releases for Amazon
|
6008
|
+
# Neptune][1], or call [DescribeDBEngineVersions][2].
|
5399
6009
|
#
|
5400
|
-
#
|
5401
|
-
#
|
6010
|
+
#
|
6011
|
+
#
|
6012
|
+
# [1]: https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases.html
|
6013
|
+
# [2]: https://docs.aws.amazon.com/neptune/latest/userguide/api-other-apis.html#DescribeDBEngineVersions
|
5402
6014
|
# @return [String]
|
5403
6015
|
#
|
5404
6016
|
# @!attribute [rw] deletion_protection
|
@@ -6726,6 +7338,7 @@ module Aws::Neptune
|
|
6726
7338
|
# {
|
6727
7339
|
# db_cluster_identifier: "String", # required
|
6728
7340
|
# role_arn: "String", # required
|
7341
|
+
# feature_name: "String",
|
6729
7342
|
# }
|
6730
7343
|
#
|
6731
7344
|
# @!attribute [rw] db_cluster_identifier
|
@@ -6738,11 +7351,18 @@ module Aws::Neptune
|
|
6738
7351
|
# `arn:aws:iam::123456789012:role/NeptuneAccessRole`.
|
6739
7352
|
# @return [String]
|
6740
7353
|
#
|
7354
|
+
# @!attribute [rw] feature_name
|
7355
|
+
# The name of the feature for the DB cluster that the IAM role is to
|
7356
|
+
# be disassociated from. For the list of supported feature names, see
|
7357
|
+
# DBEngineVersion.
|
7358
|
+
# @return [String]
|
7359
|
+
#
|
6741
7360
|
# @see http://docs.aws.amazon.com/goto/WebAPI/neptune-2014-10-31/RemoveRoleFromDBClusterMessage AWS API Documentation
|
6742
7361
|
#
|
6743
7362
|
class RemoveRoleFromDBClusterMessage < Struct.new(
|
6744
7363
|
:db_cluster_identifier,
|
6745
|
-
:role_arn
|
7364
|
+
:role_arn,
|
7365
|
+
:feature_name)
|
6746
7366
|
SENSITIVE = []
|
6747
7367
|
include Aws::Structure
|
6748
7368
|
end
|