Class: Aws::Neptune::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Neptune::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb
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.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#add_role_to_db_cluster(params = {}) ⇒ Struct
Associates an Identity and Access Management (IAM) role with an Neptune DB cluster.
-
#add_source_identifier_to_subscription(params = {}) ⇒ Types::AddSourceIdentifierToSubscriptionResult
Adds a source identifier to an existing event notification subscription.
-
#add_tags_to_resource(params = {}) ⇒ Struct
Adds metadata tags to an Amazon Neptune resource.
-
#apply_pending_maintenance_action(params = {}) ⇒ Types::ApplyPendingMaintenanceActionResult
Applies a pending maintenance action to a resource (for example, to a DB instance).
-
#copy_db_cluster_parameter_group(params = {}) ⇒ Types::CopyDBClusterParameterGroupResult
Copies the specified DB cluster parameter group.
-
#copy_db_cluster_snapshot(params = {}) ⇒ Types::CopyDBClusterSnapshotResult
Copies a snapshot of a DB cluster.
-
#copy_db_parameter_group(params = {}) ⇒ Types::CopyDBParameterGroupResult
Copies the specified DB parameter group.
-
#create_db_cluster(params = {}) ⇒ Types::CreateDBClusterResult
Creates a new Amazon Neptune DB cluster.
-
#create_db_cluster_endpoint(params = {}) ⇒ Types::CreateDBClusterEndpointOutput
Creates a new custom endpoint and associates it with an Amazon Neptune DB cluster.
-
#create_db_cluster_parameter_group(params = {}) ⇒ Types::CreateDBClusterParameterGroupResult
Creates a new DB cluster parameter group.
-
#create_db_cluster_snapshot(params = {}) ⇒ Types::CreateDBClusterSnapshotResult
Creates a snapshot of a DB cluster.
-
#create_db_instance(params = {}) ⇒ Types::CreateDBInstanceResult
Creates a new DB instance.
-
#create_db_parameter_group(params = {}) ⇒ Types::CreateDBParameterGroupResult
Creates a new DB parameter group.
-
#create_db_subnet_group(params = {}) ⇒ Types::CreateDBSubnetGroupResult
Creates a new DB subnet group.
-
#create_event_subscription(params = {}) ⇒ Types::CreateEventSubscriptionResult
Creates an event notification subscription.
-
#create_global_cluster(params = {}) ⇒ Types::CreateGlobalClusterResult
Creates a Neptune global database spread across multiple Amazon Regions.
-
#delete_db_cluster(params = {}) ⇒ Types::DeleteDBClusterResult
The DeleteDBCluster action deletes a previously provisioned DB cluster.
-
#delete_db_cluster_endpoint(params = {}) ⇒ Types::DeleteDBClusterEndpointOutput
Deletes a custom endpoint and removes it from an Amazon Neptune DB cluster.
-
#delete_db_cluster_parameter_group(params = {}) ⇒ Struct
Deletes a specified DB cluster parameter group.
-
#delete_db_cluster_snapshot(params = {}) ⇒ Types::DeleteDBClusterSnapshotResult
Deletes a DB cluster snapshot.
-
#delete_db_instance(params = {}) ⇒ Types::DeleteDBInstanceResult
The DeleteDBInstance action deletes a previously provisioned DB instance.
-
#delete_db_parameter_group(params = {}) ⇒ Struct
Deletes a specified DBParameterGroup.
-
#delete_db_subnet_group(params = {}) ⇒ Struct
Deletes a DB subnet group.
-
#delete_event_subscription(params = {}) ⇒ Types::DeleteEventSubscriptionResult
Deletes an event notification subscription.
-
#delete_global_cluster(params = {}) ⇒ Types::DeleteGlobalClusterResult
Deletes a global database.
-
#describe_db_cluster_endpoints(params = {}) ⇒ Types::DBClusterEndpointMessage
Returns information about endpoints for an Amazon Neptune DB cluster.
-
#describe_db_cluster_parameter_groups(params = {}) ⇒ Types::DBClusterParameterGroupsMessage
Returns a list of
DBClusterParameterGroup
descriptions. -
#describe_db_cluster_parameters(params = {}) ⇒ Types::DBClusterParameterGroupDetails
Returns the detailed parameter list for a particular DB cluster parameter group.
-
#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.
-
#describe_db_cluster_snapshots(params = {}) ⇒ Types::DBClusterSnapshotMessage
Returns information about DB cluster snapshots.
-
#describe_db_clusters(params = {}) ⇒ Types::DBClusterMessage
Returns information about provisioned DB clusters, and supports pagination.
-
#describe_db_engine_versions(params = {}) ⇒ Types::DBEngineVersionMessage
Returns a list of the available DB engines.
-
#describe_db_instances(params = {}) ⇒ Types::DBInstanceMessage
Returns information about provisioned instances, and supports pagination.
-
#describe_db_parameter_groups(params = {}) ⇒ Types::DBParameterGroupsMessage
Returns a list of
DBParameterGroup
descriptions. -
#describe_db_parameters(params = {}) ⇒ Types::DBParameterGroupDetails
Returns the detailed parameter list for a particular DB parameter group.
-
#describe_db_subnet_groups(params = {}) ⇒ Types::DBSubnetGroupMessage
Returns a list of DBSubnetGroup descriptions.
-
#describe_engine_default_cluster_parameters(params = {}) ⇒ Types::DescribeEngineDefaultClusterParametersResult
Returns the default engine and system parameter information for the cluster database engine.
-
#describe_engine_default_parameters(params = {}) ⇒ Types::DescribeEngineDefaultParametersResult
Returns the default engine and system parameter information for the specified database engine.
-
#describe_event_categories(params = {}) ⇒ Types::EventCategoriesMessage
Displays a list of categories for all event source types, or, if specified, for a specified source type.
-
#describe_event_subscriptions(params = {}) ⇒ Types::EventSubscriptionsMessage
Lists all the subscription descriptions for a customer account.
-
#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.
-
#describe_global_clusters(params = {}) ⇒ Types::GlobalClustersMessage
Returns information about Neptune global database clusters.
-
#describe_orderable_db_instance_options(params = {}) ⇒ Types::OrderableDBInstanceOptionsMessage
Returns a list of orderable DB instance options for the specified engine.
-
#describe_pending_maintenance_actions(params = {}) ⇒ Types::PendingMaintenanceActionsMessage
Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
-
#describe_valid_db_instance_modifications(params = {}) ⇒ Types::DescribeValidDBInstanceModificationsResult
You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance.
-
#failover_db_cluster(params = {}) ⇒ Types::FailoverDBClusterResult
Forces a failover for a DB cluster.
-
#failover_global_cluster(params = {}) ⇒ Types::FailoverGlobalClusterResult
Initiates the failover process for a Neptune global database.
-
#list_tags_for_resource(params = {}) ⇒ Types::TagListMessage
Lists all tags on an Amazon Neptune resource.
-
#modify_db_cluster(params = {}) ⇒ Types::ModifyDBClusterResult
Modify a setting for a DB cluster.
-
#modify_db_cluster_endpoint(params = {}) ⇒ Types::ModifyDBClusterEndpointOutput
Modifies the properties of an endpoint in an Amazon Neptune DB cluster.
-
#modify_db_cluster_parameter_group(params = {}) ⇒ Types::DBClusterParameterGroupNameMessage
Modifies the parameters of a 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.
-
#modify_db_instance(params = {}) ⇒ Types::ModifyDBInstanceResult
Modifies settings for a DB instance.
-
#modify_db_parameter_group(params = {}) ⇒ Types::DBParameterGroupNameMessage
Modifies the parameters of a DB parameter group.
-
#modify_db_subnet_group(params = {}) ⇒ Types::ModifyDBSubnetGroupResult
Modifies an existing DB subnet group.
-
#modify_event_subscription(params = {}) ⇒ Types::ModifyEventSubscriptionResult
Modifies an existing event notification subscription.
-
#modify_global_cluster(params = {}) ⇒ Types::ModifyGlobalClusterResult
Modify a setting for an Amazon Neptune global cluster.
-
#promote_read_replica_db_cluster(params = {}) ⇒ Types::PromoteReadReplicaDBClusterResult
Not supported.
-
#reboot_db_instance(params = {}) ⇒ Types::RebootDBInstanceResult
You might need to reboot your DB instance, usually for maintenance reasons.
-
#remove_from_global_cluster(params = {}) ⇒ Types::RemoveFromGlobalClusterResult
Detaches a Neptune DB cluster from a Neptune global database.
-
#remove_role_from_db_cluster(params = {}) ⇒ Struct
Disassociates an Identity and Access Management (IAM) role from a DB cluster.
-
#remove_source_identifier_from_subscription(params = {}) ⇒ Types::RemoveSourceIdentifierFromSubscriptionResult
Removes a source identifier from an existing event notification subscription.
-
#remove_tags_from_resource(params = {}) ⇒ Struct
Removes metadata tags from an Amazon Neptune resource.
-
#reset_db_cluster_parameter_group(params = {}) ⇒ Types::DBClusterParameterGroupNameMessage
Modifies the parameters of a DB cluster parameter group to the default value.
-
#reset_db_parameter_group(params = {}) ⇒ Types::DBParameterGroupNameMessage
Modifies the parameters of a DB parameter group to the engine/system default value.
-
#restore_db_cluster_from_snapshot(params = {}) ⇒ Types::RestoreDBClusterFromSnapshotResult
Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
-
#restore_db_cluster_to_point_in_time(params = {}) ⇒ Types::RestoreDBClusterToPointInTimeResult
Restores a DB cluster to an arbitrary 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.
-
#stop_db_cluster(params = {}) ⇒ Types::StopDBClusterResult
Stops an Amazon Neptune DB cluster.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
-
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
468 469 470 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 468 def initialize(*args) super end |
Instance Method Details
#add_role_to_db_cluster(params = {}) ⇒ Struct
Associates an Identity and Access Management (IAM) role with an Neptune DB cluster.
504 505 506 507 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 504 def add_role_to_db_cluster(params = {}, = {}) req = build_request(:add_role_to_db_cluster, params) req.send_request() end |
#add_source_identifier_to_subscription(params = {}) ⇒ Types::AddSourceIdentifierToSubscriptionResult
Adds a source identifier to an existing event notification subscription.
563 564 565 566 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 563 def add_source_identifier_to_subscription(params = {}, = {}) req = build_request(:add_source_identifier_to_subscription, params) req.send_request() end |
#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.
603 604 605 606 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 603 def (params = {}, = {}) req = build_request(:add_tags_to_resource, params) req.send_request() end |
#apply_pending_maintenance_action(params = {}) ⇒ Types::ApplyPendingMaintenanceActionResult
Applies a pending maintenance action to a resource (for example, to a DB instance).
666 667 668 669 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 666 def apply_pending_maintenance_action(params = {}, = {}) req = build_request(:apply_pending_maintenance_action, params) req.send_request() end |
#copy_db_cluster_parameter_group(params = {}) ⇒ Types::CopyDBClusterParameterGroupResult
Copies the specified DB cluster parameter group.
745 746 747 748 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 745 def copy_db_cluster_parameter_group(params = {}, = {}) req = build_request(:copy_db_cluster_parameter_group, params) req.send_request() end |
#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.
868 869 870 871 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 868 def copy_db_cluster_snapshot(params = {}, = {}) req = build_request(:copy_db_cluster_snapshot, params) req.send_request() end |
#copy_db_parameter_group(params = {}) ⇒ Types::CopyDBParameterGroupResult
Copies the specified DB parameter group.
941 942 943 944 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 941 def copy_db_parameter_group(params = {}, = {}) req = build_request(:copy_db_parameter_group, params) req.send_request() end |
#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
.
1317 1318 1319 1320 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 1317 def create_db_cluster(params = {}, = {}) req = build_request(:create_db_cluster, params) req.send_request() end |
#create_db_cluster_endpoint(params = {}) ⇒ Types::CreateDBClusterEndpointOutput
Creates a new custom endpoint and associates it with an Amazon Neptune DB cluster.
1396 1397 1398 1399 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 1396 def create_db_cluster_endpoint(params = {}, = {}) req = build_request(:create_db_cluster_endpoint, params) req.send_request() end |
#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.
1489 1490 1491 1492 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 1489 def create_db_cluster_parameter_group(params = {}, = {}) req = build_request(:create_db_cluster_parameter_group, params) req.send_request() end |
#create_db_cluster_snapshot(params = {}) ⇒ Types::CreateDBClusterSnapshotResult
Creates a snapshot of a DB cluster.
1571 1572 1573 1574 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 1571 def create_db_cluster_snapshot(params = {}, = {}) req = build_request(:create_db_cluster_snapshot, params) req.send_request() end |
#create_db_instance(params = {}) ⇒ Types::CreateDBInstanceResult
Creates a new DB instance.
2014 2015 2016 2017 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 2014 def create_db_instance(params = {}, = {}) req = build_request(:create_db_instance, params) req.send_request() end |
#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.
2099 2100 2101 2102 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 2099 def create_db_parameter_group(params = {}, = {}) req = build_request(:create_db_parameter_group, params) req.send_request() end |
#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.
2159 2160 2161 2162 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 2159 def create_db_subnet_group(params = {}, = {}) req = build_request(:create_db_subnet_group, params) req.send_request() end |
#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.
2280 2281 2282 2283 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 2280 def create_event_subscription(params = {}, = {}) req = build_request(:create_event_subscription, params) req.send_request() end |
#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.
2355 2356 2357 2358 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 2355 def create_global_cluster(params = {}, = {}) req = build_request(:create_global_cluster, params) req.send_request() end |
#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
.
2498 2499 2500 2501 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 2498 def delete_db_cluster(params = {}, = {}) req = build_request(:delete_db_cluster, params) req.send_request() end |
#delete_db_cluster_endpoint(params = {}) ⇒ Types::DeleteDBClusterEndpointOutput
Deletes a custom endpoint and removes it from an Amazon Neptune DB cluster.
2548 2549 2550 2551 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 2548 def delete_db_cluster_endpoint(params = {}, = {}) req = build_request(:delete_db_cluster_endpoint, params) req.send_request() end |
#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.
2580 2581 2582 2583 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 2580 def delete_db_cluster_parameter_group(params = {}, = {}) req = build_request(:delete_db_cluster_parameter_group, params) req.send_request() end |
#delete_db_cluster_snapshot(params = {}) ⇒ Types::DeleteDBClusterSnapshotResult
Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.
available
state to be
deleted.
2638 2639 2640 2641 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 2638 def delete_db_cluster_snapshot(params = {}, = {}) req = build_request(:delete_db_cluster_snapshot, params) req.send_request() end |
#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.
2828 2829 2830 2831 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 2828 def delete_db_instance(params = {}, = {}) req = build_request(:delete_db_instance, params) req.send_request() end |
#delete_db_parameter_group(params = {}) ⇒ Struct
Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted can't be associated with any DB instances.
2859 2860 2861 2862 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 2859 def delete_db_parameter_group(params = {}, = {}) req = build_request(:delete_db_parameter_group, params) req.send_request() end |
#delete_db_subnet_group(params = {}) ⇒ Struct
Deletes a DB subnet group.
2897 2898 2899 2900 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 2897 def delete_db_subnet_group(params = {}, = {}) req = build_request(:delete_db_subnet_group, params) req.send_request() end |
#delete_event_subscription(params = {}) ⇒ Types::DeleteEventSubscriptionResult
Deletes an event notification subscription.
2936 2937 2938 2939 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 2936 def delete_event_subscription(params = {}, = {}) req = build_request(:delete_event_subscription, params) req.send_request() end |
#delete_global_cluster(params = {}) ⇒ Types::DeleteGlobalClusterResult
Deletes a global database. The primary and all secondary clusters must already be detached or deleted first.
2977 2978 2979 2980 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 2977 def delete_global_cluster(params = {}, = {}) req = build_request(:delete_global_cluster, params) req.send_request() end |
#describe_db_cluster_endpoints(params = {}) ⇒ Types::DBClusterEndpointMessage
Returns information about endpoints for an Amazon Neptune DB cluster.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3069 3070 3071 3072 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 3069 def describe_db_cluster_endpoints(params = {}, = {}) req = build_request(:describe_db_cluster_endpoints, params) req.send_request() end |
#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.
3143 3144 3145 3146 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 3143 def describe_db_cluster_parameter_groups(params = {}, = {}) req = build_request(:describe_db_cluster_parameter_groups, params) req.send_request() end |
#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.
3226 3227 3228 3229 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 3226 def describe_db_cluster_parameters(params = {}, = {}) req = build_request(:describe_db_cluster_parameters, params) req.send_request() end |
#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.
3273 3274 3275 3276 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 3273 def describe_db_cluster_snapshot_attributes(params = {}, = {}) req = build_request(:describe_db_cluster_snapshot_attributes, params) req.send_request() end |
#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.
3426 3427 3428 3429 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 3426 def describe_db_cluster_snapshots(params = {}, = {}) req = build_request(:describe_db_cluster_snapshots, params) req.send_request() end |
#describe_db_clusters(params = {}) ⇒ Types::DBClusterMessage
Returns information about provisioned DB clusters, and supports pagination.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3581 3582 3583 3584 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 3581 def describe_db_clusters(params = {}, = {}) req = build_request(:describe_db_clusters, params) req.send_request() end |
#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.
3697 3698 3699 3700 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 3697 def describe_db_engine_versions(params = {}, = {}) req = build_request(:describe_db_engine_versions, params) req.send_request() end |
#describe_db_instances(params = {}) ⇒ Types::DBInstanceMessage
Returns information about provisioned instances, and supports pagination.
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
3888 3889 3890 3891 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 3888 def describe_db_instances(params = {}, = {}) req = build_request(:describe_db_instances, params) req.send_request() end |
#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.
3960 3961 3962 3963 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 3960 def describe_db_parameter_groups(params = {}, = {}) req = build_request(:describe_db_parameter_groups, params) req.send_request() end |
#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.
4044 4045 4046 4047 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 4044 def describe_db_parameters(params = {}, = {}) req = build_request(:describe_db_parameters, params) req.send_request() end |
#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.
4120 4121 4122 4123 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 4120 def describe_db_subnet_groups(params = {}, = {}) req = build_request(:describe_db_subnet_groups, params) req.send_request() end |
#describe_engine_default_cluster_parameters(params = {}) ⇒ Types::DescribeEngineDefaultClusterParametersResult
Returns the default engine and system parameter information for the cluster database engine.
4189 4190 4191 4192 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 4189 def describe_engine_default_cluster_parameters(params = {}, = {}) req = build_request(:describe_engine_default_cluster_parameters, params) req.send_request() end |
#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.
4259 4260 4261 4262 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 4259 def describe_engine_default_parameters(params = {}, = {}) req = build_request(:describe_engine_default_parameters, params) req.send_request() end |
#describe_event_categories(params = {}) ⇒ Types::EventCategoriesMessage
Displays a list of categories for all event source types, or, if specified, for a specified source type.
4303 4304 4305 4306 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 4303 def describe_event_categories(params = {}, = {}) req = build_request(:describe_event_categories, params) req.send_request() end |
#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.
4379 4380 4381 4382 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 4379 def describe_event_subscriptions(params = {}, = {}) req = build_request(:describe_event_subscriptions, params) req.send_request() end |
#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.
4507 4508 4509 4510 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 4507 def describe_events(params = {}, = {}) req = build_request(:describe_events, params) req.send_request() end |
#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.
4576 4577 4578 4579 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 4576 def describe_global_clusters(params = {}, = {}) req = build_request(:describe_global_clusters, params) req.send_request() end |
#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.
4678 4679 4680 4681 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 4678 def (params = {}, = {}) req = build_request(:describe_orderable_db_instance_options, params) req.send_request() end |
#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.
4758 4759 4760 4761 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 4758 def describe_pending_maintenance_actions(params = {}, = {}) req = build_request(:describe_pending_maintenance_actions, params) req.send_request() end |
#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.
4800 4801 4802 4803 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 4800 def describe_valid_db_instance_modifications(params = {}, = {}) req = build_request(:describe_valid_db_instance_modifications, params) req.send_request() end |
#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.
4922 4923 4924 4925 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 4922 def failover_db_cluster(params = {}, = {}) req = build_request(:failover_db_cluster, params) req.send_request() end |
#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.
4989 4990 4991 4992 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 4989 def failover_global_cluster(params = {}, = {}) req = build_request(:failover_global_cluster, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::TagListMessage
Lists all tags on an Amazon Neptune resource.
5034 5035 5036 5037 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 5034 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#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.
5347 5348 5349 5350 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 5347 def modify_db_cluster(params = {}, = {}) req = build_request(:modify_db_cluster, params) req.send_request() end |
#modify_db_cluster_endpoint(params = {}) ⇒ Types::ModifyDBClusterEndpointOutput
Modifies the properties of an endpoint in an Amazon Neptune DB cluster.
5412 5413 5414 5415 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 5412 def modify_db_cluster_endpoint(params = {}, = {}) req = build_request(:modify_db_cluster_endpoint, params) req.send_request() end |
#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.
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.
5478 5479 5480 5481 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 5478 def modify_db_cluster_parameter_group(params = {}, = {}) req = build_request(:modify_db_cluster_parameter_group, params) req.send_request() end |
#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.
5561 5562 5563 5564 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 5561 def modify_db_cluster_snapshot_attribute(params = {}, = {}) req = build_request(:modify_db_cluster_snapshot_attribute, params) req.send_request() end |
#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.
6016 6017 6018 6019 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 6016 def modify_db_instance(params = {}, = {}) req = build_request(:modify_db_instance, params) req.send_request() end |
#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.
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.
6101 6102 6103 6104 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 6101 def modify_db_parameter_group(params = {}, = {}) req = build_request(:modify_db_parameter_group, params) req.send_request() end |
#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.
6152 6153 6154 6155 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 6152 def modify_db_subnet_group(params = {}, = {}) req = build_request(:modify_db_subnet_group, params) req.send_request() end |
#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.
6224 6225 6226 6227 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 6224 def modify_event_subscription(params = {}, = {}) req = build_request(:modify_event_subscription, params) req.send_request() end |
#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.
6314 6315 6316 6317 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 6314 def modify_global_cluster(params = {}, = {}) req = build_request(:modify_global_cluster, params) req.send_request() end |
#promote_read_replica_db_cluster(params = {}) ⇒ Types::PromoteReadReplicaDBClusterResult
Not supported.
6411 6412 6413 6414 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 6411 def promote_read_replica_db_cluster(params = {}, = {}) req = build_request(:promote_read_replica_db_cluster, params) req.send_request() end |
#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.
6557 6558 6559 6560 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 6557 def reboot_db_instance(params = {}, = {}) req = build_request(:reboot_db_instance, params) req.send_request() end |
#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 a the primary cluster.
6606 6607 6608 6609 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 6606 def remove_from_global_cluster(params = {}, = {}) req = build_request(:remove_from_global_cluster, params) req.send_request() end |
#remove_role_from_db_cluster(params = {}) ⇒ Struct
Disassociates an Identity and Access Management (IAM) role from a DB cluster.
6641 6642 6643 6644 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 6641 def remove_role_from_db_cluster(params = {}, = {}) req = build_request(:remove_role_from_db_cluster, params) req.send_request() end |
#remove_source_identifier_from_subscription(params = {}) ⇒ Types::RemoveSourceIdentifierFromSubscriptionResult
Removes a source identifier from an existing event notification subscription.
6688 6689 6690 6691 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 6688 def remove_source_identifier_from_subscription(params = {}, = {}) req = build_request(:remove_source_identifier_from_subscription, params) req.send_request() end |
#remove_tags_from_resource(params = {}) ⇒ Struct
Removes metadata tags from an Amazon Neptune resource.
6720 6721 6722 6723 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 6720 def (params = {}, = {}) req = build_request(:remove_tags_from_resource, params) req.send_request() end |
#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.
6784 6785 6786 6787 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 6784 def reset_db_cluster_parameter_group(params = {}, = {}) req = build_request(:reset_db_cluster_parameter_group, params) req.send_request() end |
#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.
6855 6856 6857 6858 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 6855 def reset_db_parameter_group(params = {}, = {}) req = build_request(:reset_db_parameter_group, params) req.send_request() end |
#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.
7120 7121 7122 7123 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 7120 def restore_db_cluster_from_snapshot(params = {}, = {}) req = build_request(:restore_db_cluster_from_snapshot, params) req.send_request() end |
#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.
DBClusterIdentifier
. You can create DB
instances only after the RestoreDBClusterToPointInTime
action has
completed and the DB cluster is available.
7408 7409 7410 7411 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 7408 def restore_db_cluster_to_point_in_time(params = {}, = {}) req = build_request(:restore_db_cluster_to_point_in_time, params) req.send_request() end |
#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.
7508 7509 7510 7511 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 7508 def start_db_cluster(params = {}, = {}) req = build_request(:start_db_cluster, params) req.send_request() end |
#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.
7611 7612 7613 7614 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 7611 def stop_db_cluster(params = {}, = {}) req = build_request(:stop_db_cluster, params) req.send_request() end |
#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 |
7727 7728 7729 7730 7731 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 7727 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |