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.
448 449 450 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 448 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.
484 485 486 487 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 484 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.
543 544 545 546 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 543 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.
583 584 585 586 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 583 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).
646 647 648 649 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 646 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.
725 726 727 728 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 725 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.
848 849 850 851 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 848 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.
921 922 923 924 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 921 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
.
1297 1298 1299 1300 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 1297 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.
1376 1377 1378 1379 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 1376 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.
1469 1470 1471 1472 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 1469 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.
1551 1552 1553 1554 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 1551 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.
1994 1995 1996 1997 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 1994 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.
2079 2080 2081 2082 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 2079 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.
2139 2140 2141 2142 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 2139 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.
2260 2261 2262 2263 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 2260 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.
2335 2336 2337 2338 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 2335 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
.
2478 2479 2480 2481 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 2478 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.
2528 2529 2530 2531 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 2528 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.
2560 2561 2562 2563 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 2560 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.
2618 2619 2620 2621 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 2618 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.
2808 2809 2810 2811 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 2808 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.
2839 2840 2841 2842 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 2839 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.
2877 2878 2879 2880 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 2877 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.
2916 2917 2918 2919 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 2916 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.
2957 2958 2959 2960 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 2957 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.
3049 3050 3051 3052 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 3049 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.
3123 3124 3125 3126 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 3123 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.
3206 3207 3208 3209 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 3206 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.
3253 3254 3255 3256 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 3253 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.
3406 3407 3408 3409 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 3406 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.
3561 3562 3563 3564 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 3561 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.
3677 3678 3679 3680 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 3677 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
3868 3869 3870 3871 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 3868 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.
3940 3941 3942 3943 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 3940 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.
4024 4025 4026 4027 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 4024 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.
4100 4101 4102 4103 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 4100 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.
4169 4170 4171 4172 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 4169 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.
4239 4240 4241 4242 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 4239 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.
4283 4284 4285 4286 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 4283 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.
4359 4360 4361 4362 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 4359 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.
4487 4488 4489 4490 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 4487 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.
4556 4557 4558 4559 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 4556 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.
4658 4659 4660 4661 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 4658 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.
4738 4739 4740 4741 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 4738 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.
4780 4781 4782 4783 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 4780 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.
4902 4903 4904 4905 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 4902 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.
4969 4970 4971 4972 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 4969 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.
5014 5015 5016 5017 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 5014 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.
5327 5328 5329 5330 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 5327 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.
5392 5393 5394 5395 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 5392 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.
5458 5459 5460 5461 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 5458 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.
5541 5542 5543 5544 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 5541 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.
5996 5997 5998 5999 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 5996 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.
6081 6082 6083 6084 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 6081 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.
6132 6133 6134 6135 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 6132 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.
6204 6205 6206 6207 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 6204 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.
6294 6295 6296 6297 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 6294 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.
6391 6392 6393 6394 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 6391 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.
6537 6538 6539 6540 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 6537 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.
6586 6587 6588 6589 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 6586 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.
6621 6622 6623 6624 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 6621 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.
6668 6669 6670 6671 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 6668 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.
6700 6701 6702 6703 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 6700 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.
6764 6765 6766 6767 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 6764 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.
6835 6836 6837 6838 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 6835 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.
7100 7101 7102 7103 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 7100 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.
7388 7389 7390 7391 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 7388 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.
7488 7489 7490 7491 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 7488 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.
7591 7592 7593 7594 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 7591 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 |
7707 7708 7709 7710 7711 |
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/client.rb', line 7707 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |