@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonNeptune extends Object implements AmazonNeptune
AmazonNeptune
. Convenient method forms pass through to the corresponding overload
that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
AddRoleToDBClusterResult |
addRoleToDBCluster(AddRoleToDBClusterRequest request)
Associates an Identity and Access Management (IAM) role with an Neptune DB cluster.
|
EventSubscription |
addSourceIdentifierToSubscription(AddSourceIdentifierToSubscriptionRequest request)
Adds a source identifier to an existing event notification subscription.
|
AddTagsToResourceResult |
addTagsToResource(AddTagsToResourceRequest request)
Adds metadata tags to an Amazon Neptune resource.
|
ResourcePendingMaintenanceActions |
applyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest request)
Applies a pending maintenance action to a resource (for example, to a DB instance).
|
DBClusterParameterGroup |
copyDBClusterParameterGroup(CopyDBClusterParameterGroupRequest request)
Copies the specified DB cluster parameter group.
|
DBClusterSnapshot |
copyDBClusterSnapshot(CopyDBClusterSnapshotRequest request)
Copies a snapshot of a DB cluster.
|
DBParameterGroup |
copyDBParameterGroup(CopyDBParameterGroupRequest request)
Copies the specified DB parameter group.
|
DBCluster |
createDBCluster(CreateDBClusterRequest request)
Creates a new Amazon Neptune DB cluster.
|
CreateDBClusterEndpointResult |
createDBClusterEndpoint(CreateDBClusterEndpointRequest request)
Creates a new custom endpoint and associates it with an Amazon Neptune DB cluster.
|
DBClusterParameterGroup |
createDBClusterParameterGroup(CreateDBClusterParameterGroupRequest request)
Creates a new DB cluster parameter group.
|
DBClusterSnapshot |
createDBClusterSnapshot(CreateDBClusterSnapshotRequest request)
Creates a snapshot of a DB cluster.
|
DBInstance |
createDBInstance(CreateDBInstanceRequest request)
Creates a new DB instance.
|
DBParameterGroup |
createDBParameterGroup(CreateDBParameterGroupRequest request)
Creates a new DB parameter group.
|
DBSubnetGroup |
createDBSubnetGroup(CreateDBSubnetGroupRequest request)
Creates a new DB subnet group.
|
EventSubscription |
createEventSubscription(CreateEventSubscriptionRequest request)
Creates an event notification subscription.
|
GlobalCluster |
createGlobalCluster(CreateGlobalClusterRequest request)
Creates a Neptune global database spread across multiple Amazon Regions.
|
DBCluster |
deleteDBCluster(DeleteDBClusterRequest request)
The DeleteDBCluster action deletes a previously provisioned DB cluster.
|
DeleteDBClusterEndpointResult |
deleteDBClusterEndpoint(DeleteDBClusterEndpointRequest request)
Deletes a custom endpoint and removes it from an Amazon Neptune DB cluster.
|
DeleteDBClusterParameterGroupResult |
deleteDBClusterParameterGroup(DeleteDBClusterParameterGroupRequest request)
Deletes a specified DB cluster parameter group.
|
DBClusterSnapshot |
deleteDBClusterSnapshot(DeleteDBClusterSnapshotRequest request)
Deletes a DB cluster snapshot.
|
DBInstance |
deleteDBInstance(DeleteDBInstanceRequest request)
The DeleteDBInstance action deletes a previously provisioned DB instance.
|
DeleteDBParameterGroupResult |
deleteDBParameterGroup(DeleteDBParameterGroupRequest request)
Deletes a specified DBParameterGroup.
|
DeleteDBSubnetGroupResult |
deleteDBSubnetGroup(DeleteDBSubnetGroupRequest request)
Deletes a DB subnet group.
|
EventSubscription |
deleteEventSubscription(DeleteEventSubscriptionRequest request)
Deletes an event notification subscription.
|
GlobalCluster |
deleteGlobalCluster(DeleteGlobalClusterRequest request)
Deletes a global database.
|
DescribeDBClusterEndpointsResult |
describeDBClusterEndpoints(DescribeDBClusterEndpointsRequest request)
Returns information about endpoints for an Amazon Neptune DB cluster.
|
DescribeDBClusterParameterGroupsResult |
describeDBClusterParameterGroups(DescribeDBClusterParameterGroupsRequest request)
Returns a list of
DBClusterParameterGroup descriptions. |
DescribeDBClusterParametersResult |
describeDBClusterParameters(DescribeDBClusterParametersRequest request)
Returns the detailed parameter list for a particular DB cluster parameter group.
|
DescribeDBClustersResult |
describeDBClusters(DescribeDBClustersRequest request)
Returns information about provisioned DB clusters, and supports pagination.
|
DBClusterSnapshotAttributesResult |
describeDBClusterSnapshotAttributes(DescribeDBClusterSnapshotAttributesRequest request)
Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.
|
DescribeDBClusterSnapshotsResult |
describeDBClusterSnapshots(DescribeDBClusterSnapshotsRequest request)
Returns information about DB cluster snapshots.
|
DescribeDBEngineVersionsResult |
describeDBEngineVersions(DescribeDBEngineVersionsRequest request)
Returns a list of the available DB engines.
|
DescribeDBInstancesResult |
describeDBInstances(DescribeDBInstancesRequest request)
Returns information about provisioned instances, and supports pagination.
|
DescribeDBParameterGroupsResult |
describeDBParameterGroups(DescribeDBParameterGroupsRequest request)
Returns a list of
DBParameterGroup descriptions. |
DescribeDBParametersResult |
describeDBParameters(DescribeDBParametersRequest request)
Returns the detailed parameter list for a particular DB parameter group.
|
DescribeDBSubnetGroupsResult |
describeDBSubnetGroups(DescribeDBSubnetGroupsRequest request)
Returns a list of DBSubnetGroup descriptions.
|
EngineDefaults |
describeEngineDefaultClusterParameters(DescribeEngineDefaultClusterParametersRequest request)
Returns the default engine and system parameter information for the cluster database engine.
|
EngineDefaults |
describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest request)
Returns the default engine and system parameter information for the specified database engine.
|
DescribeEventCategoriesResult |
describeEventCategories(DescribeEventCategoriesRequest request)
Displays a list of categories for all event source types, or, if specified, for a specified source type.
|
DescribeEventsResult |
describeEvents(DescribeEventsRequest request)
Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14
days.
|
DescribeEventSubscriptionsResult |
describeEventSubscriptions(DescribeEventSubscriptionsRequest request)
Lists all the subscription descriptions for a customer account.
|
DescribeGlobalClustersResult |
describeGlobalClusters(DescribeGlobalClustersRequest request)
Returns information about Neptune global database clusters.
|
DescribeOrderableDBInstanceOptionsResult |
describeOrderableDBInstanceOptions(DescribeOrderableDBInstanceOptionsRequest request)
Returns a list of orderable DB instance options for the specified engine.
|
DescribePendingMaintenanceActionsResult |
describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest request)
Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
|
ValidDBInstanceModificationsMessage |
describeValidDBInstanceModifications(DescribeValidDBInstanceModificationsRequest request)
You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB
instance.
|
DBCluster |
failoverDBCluster(FailoverDBClusterRequest request)
Forces a failover for a DB cluster.
|
GlobalCluster |
failoverGlobalCluster(FailoverGlobalClusterRequest request)
Initiates the failover process for a Neptune global database.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Lists all tags on an Amazon Neptune resource.
|
DBCluster |
modifyDBCluster(ModifyDBClusterRequest request)
Modify a setting for a DB cluster.
|
ModifyDBClusterEndpointResult |
modifyDBClusterEndpoint(ModifyDBClusterEndpointRequest request)
Modifies the properties of an endpoint in an Amazon Neptune DB cluster.
|
ModifyDBClusterParameterGroupResult |
modifyDBClusterParameterGroup(ModifyDBClusterParameterGroupRequest request)
Modifies the parameters of a DB cluster parameter group.
|
DBClusterSnapshotAttributesResult |
modifyDBClusterSnapshotAttribute(ModifyDBClusterSnapshotAttributeRequest request)
Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.
|
DBInstance |
modifyDBInstance(ModifyDBInstanceRequest request)
Modifies settings for a DB instance.
|
ModifyDBParameterGroupResult |
modifyDBParameterGroup(ModifyDBParameterGroupRequest request)
Modifies the parameters of a DB parameter group.
|
DBSubnetGroup |
modifyDBSubnetGroup(ModifyDBSubnetGroupRequest request)
Modifies an existing DB subnet group.
|
EventSubscription |
modifyEventSubscription(ModifyEventSubscriptionRequest request)
Modifies an existing event notification subscription.
|
GlobalCluster |
modifyGlobalCluster(ModifyGlobalClusterRequest request)
Modify a setting for an Amazon Neptune global cluster.
|
DBCluster |
promoteReadReplicaDBCluster(PromoteReadReplicaDBClusterRequest request)
Not supported.
|
DBInstance |
rebootDBInstance(RebootDBInstanceRequest request)
You might need to reboot your DB instance, usually for maintenance reasons.
|
GlobalCluster |
removeFromGlobalCluster(RemoveFromGlobalClusterRequest request)
Detaches a Neptune DB cluster from a Neptune global database.
|
RemoveRoleFromDBClusterResult |
removeRoleFromDBCluster(RemoveRoleFromDBClusterRequest request)
Disassociates an Identity and Access Management (IAM) role from a DB cluster.
|
EventSubscription |
removeSourceIdentifierFromSubscription(RemoveSourceIdentifierFromSubscriptionRequest request)
Removes a source identifier from an existing event notification subscription.
|
RemoveTagsFromResourceResult |
removeTagsFromResource(RemoveTagsFromResourceRequest request)
Removes metadata tags from an Amazon Neptune resource.
|
ResetDBClusterParameterGroupResult |
resetDBClusterParameterGroup(ResetDBClusterParameterGroupRequest request)
Modifies the parameters of a DB cluster parameter group to the default value.
|
ResetDBParameterGroupResult |
resetDBParameterGroup(ResetDBParameterGroupRequest request)
Modifies the parameters of a DB parameter group to the engine/system default value.
|
DBCluster |
restoreDBClusterFromSnapshot(RestoreDBClusterFromSnapshotRequest request)
Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
|
DBCluster |
restoreDBClusterToPointInTime(RestoreDBClusterToPointInTimeRequest request)
Restores a DB cluster to an arbitrary point in time.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
DBCluster |
startDBCluster(StartDBClusterRequest request)
Starts an Amazon Neptune DB cluster that was stopped using the Amazon console, the Amazon CLI stop-db-cluster
command, or the StopDBCluster API.
|
DBCluster |
stopDBCluster(StopDBClusterRequest request)
Stops an Amazon Neptune DB cluster.
|
AmazonNeptuneWaiters |
waiters() |
public AddRoleToDBClusterResult addRoleToDBCluster(AddRoleToDBClusterRequest request)
AmazonNeptune
Associates an Identity and Access Management (IAM) role with an Neptune DB cluster.
addRoleToDBCluster
in interface AmazonNeptune
public EventSubscription addSourceIdentifierToSubscription(AddSourceIdentifierToSubscriptionRequest request)
AmazonNeptune
Adds a source identifier to an existing event notification subscription.
addSourceIdentifierToSubscription
in interface AmazonNeptune
public AddTagsToResourceResult addTagsToResource(AddTagsToResourceRequest request)
AmazonNeptune
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.
addTagsToResource
in interface AmazonNeptune
public ResourcePendingMaintenanceActions applyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest request)
AmazonNeptune
Applies a pending maintenance action to a resource (for example, to a DB instance).
applyPendingMaintenanceAction
in interface AmazonNeptune
public DBClusterParameterGroup copyDBClusterParameterGroup(CopyDBClusterParameterGroupRequest request)
AmazonNeptune
Copies the specified DB cluster parameter group.
copyDBClusterParameterGroup
in interface AmazonNeptune
public DBClusterSnapshot copyDBClusterSnapshot(CopyDBClusterSnapshotRequest request)
AmazonNeptune
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.
copyDBClusterSnapshot
in interface AmazonNeptune
public DBParameterGroup copyDBParameterGroup(CopyDBParameterGroupRequest request)
AmazonNeptune
Copies the specified DB parameter group.
copyDBParameterGroup
in interface AmazonNeptune
public DBCluster createDBCluster(CreateDBClusterRequest request)
AmazonNeptune
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
.
createDBCluster
in interface AmazonNeptune
public CreateDBClusterEndpointResult createDBClusterEndpoint(CreateDBClusterEndpointRequest request)
AmazonNeptune
Creates a new custom endpoint and associates it with an Amazon Neptune DB cluster.
createDBClusterEndpoint
in interface AmazonNeptune
public DBClusterParameterGroup createDBClusterParameterGroup(CreateDBClusterParameterGroupRequest request)
AmazonNeptune
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.
createDBClusterParameterGroup
in interface AmazonNeptune
public DBClusterSnapshot createDBClusterSnapshot(CreateDBClusterSnapshotRequest request)
AmazonNeptune
Creates a snapshot of a DB cluster.
createDBClusterSnapshot
in interface AmazonNeptune
public DBInstance createDBInstance(CreateDBInstanceRequest request)
AmazonNeptune
Creates a new DB instance.
createDBInstance
in interface AmazonNeptune
public DBParameterGroup createDBParameterGroup(CreateDBParameterGroupRequest request)
AmazonNeptune
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.
createDBParameterGroup
in interface AmazonNeptune
public DBSubnetGroup createDBSubnetGroup(CreateDBSubnetGroupRequest request)
AmazonNeptune
Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Region.
createDBSubnetGroup
in interface AmazonNeptune
public EventSubscription createEventSubscription(CreateEventSubscriptionRequest request)
AmazonNeptune
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.
createEventSubscription
in interface AmazonNeptune
public GlobalCluster createGlobalCluster(CreateGlobalClusterRequest request)
AmazonNeptune
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.
createGlobalCluster
in interface AmazonNeptune
public DBCluster deleteDBCluster(DeleteDBClusterRequest request)
AmazonNeptune
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
.
deleteDBCluster
in interface AmazonNeptune
public DeleteDBClusterEndpointResult deleteDBClusterEndpoint(DeleteDBClusterEndpointRequest request)
AmazonNeptune
Deletes a custom endpoint and removes it from an Amazon Neptune DB cluster.
deleteDBClusterEndpoint
in interface AmazonNeptune
public DeleteDBClusterParameterGroupResult deleteDBClusterParameterGroup(DeleteDBClusterParameterGroupRequest request)
AmazonNeptune
Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.
deleteDBClusterParameterGroup
in interface AmazonNeptune
public DBClusterSnapshot deleteDBClusterSnapshot(DeleteDBClusterSnapshotRequest request)
AmazonNeptune
Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.
The DB cluster snapshot must be in the available
state to be deleted.
deleteDBClusterSnapshot
in interface AmazonNeptune
public DBInstance deleteDBInstance(DeleteDBInstanceRequest request)
AmazonNeptune
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.
deleteDBInstance
in interface AmazonNeptune
public DeleteDBParameterGroupResult deleteDBParameterGroup(DeleteDBParameterGroupRequest request)
AmazonNeptune
Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted can't be associated with any DB instances.
deleteDBParameterGroup
in interface AmazonNeptune
public DeleteDBSubnetGroupResult deleteDBSubnetGroup(DeleteDBSubnetGroupRequest request)
AmazonNeptune
Deletes a DB subnet group.
The specified database subnet group must not be associated with any DB instances.
deleteDBSubnetGroup
in interface AmazonNeptune
public EventSubscription deleteEventSubscription(DeleteEventSubscriptionRequest request)
AmazonNeptune
Deletes an event notification subscription.
deleteEventSubscription
in interface AmazonNeptune
public GlobalCluster deleteGlobalCluster(DeleteGlobalClusterRequest request)
AmazonNeptune
Deletes a global database. The primary and all secondary clusters must already be detached or deleted first.
deleteGlobalCluster
in interface AmazonNeptune
public DescribeDBClusterEndpointsResult describeDBClusterEndpoints(DescribeDBClusterEndpointsRequest request)
AmazonNeptune
Returns information about endpoints for an Amazon Neptune DB cluster.
This operation can also return information for Amazon RDS clusters and Amazon DocDB clusters.
describeDBClusterEndpoints
in interface AmazonNeptune
public DescribeDBClusterParameterGroupsResult describeDBClusterParameterGroups(DescribeDBClusterParameterGroupsRequest request)
AmazonNeptune
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.
describeDBClusterParameterGroups
in interface AmazonNeptune
public DescribeDBClusterParametersResult describeDBClusterParameters(DescribeDBClusterParametersRequest request)
AmazonNeptune
Returns the detailed parameter list for a particular DB cluster parameter group.
describeDBClusterParameters
in interface AmazonNeptune
public DBClusterSnapshotAttributesResult describeDBClusterSnapshotAttributes(DescribeDBClusterSnapshotAttributesRequest request)
AmazonNeptune
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.
describeDBClusterSnapshotAttributes
in interface AmazonNeptune
public DescribeDBClusterSnapshotsResult describeDBClusterSnapshots(DescribeDBClusterSnapshotsRequest request)
AmazonNeptune
Returns information about DB cluster snapshots. This API action supports pagination.
describeDBClusterSnapshots
in interface AmazonNeptune
public DescribeDBClustersResult describeDBClusters(DescribeDBClustersRequest request)
AmazonNeptune
Returns information about provisioned DB clusters, and supports pagination.
This operation can also return information for Amazon RDS clusters and Amazon DocDB clusters.
describeDBClusters
in interface AmazonNeptune
public DescribeDBEngineVersionsResult describeDBEngineVersions(DescribeDBEngineVersionsRequest request)
AmazonNeptune
Returns a list of the available DB engines.
describeDBEngineVersions
in interface AmazonNeptune
public DescribeDBInstancesResult describeDBInstances(DescribeDBInstancesRequest request)
AmazonNeptune
Returns information about provisioned instances, and supports pagination.
This operation can also return information for Amazon RDS instances and Amazon DocDB instances.
describeDBInstances
in interface AmazonNeptune
public DescribeDBParameterGroupsResult describeDBParameterGroups(DescribeDBParameterGroupsRequest request)
AmazonNeptune
Returns a list of DBParameterGroup
descriptions. If a DBParameterGroupName
is
specified, the list will contain only the description of the specified DB parameter group.
describeDBParameterGroups
in interface AmazonNeptune
public DescribeDBParametersResult describeDBParameters(DescribeDBParametersRequest request)
AmazonNeptune
Returns the detailed parameter list for a particular DB parameter group.
describeDBParameters
in interface AmazonNeptune
public DescribeDBSubnetGroupsResult describeDBSubnetGroups(DescribeDBSubnetGroupsRequest request)
AmazonNeptune
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.
describeDBSubnetGroups
in interface AmazonNeptune
public EngineDefaults describeEngineDefaultClusterParameters(DescribeEngineDefaultClusterParametersRequest request)
AmazonNeptune
Returns the default engine and system parameter information for the cluster database engine.
describeEngineDefaultClusterParameters
in interface AmazonNeptune
public EngineDefaults describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest request)
AmazonNeptune
Returns the default engine and system parameter information for the specified database engine.
describeEngineDefaultParameters
in interface AmazonNeptune
public DescribeEventCategoriesResult describeEventCategories(DescribeEventCategoriesRequest request)
AmazonNeptune
Displays a list of categories for all event source types, or, if specified, for a specified source type.
describeEventCategories
in interface AmazonNeptune
public DescribeEventSubscriptionsResult describeEventSubscriptions(DescribeEventSubscriptionsRequest request)
AmazonNeptune
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.
describeEventSubscriptions
in interface AmazonNeptune
public DescribeEventsResult describeEvents(DescribeEventsRequest request)
AmazonNeptune
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.
describeEvents
in interface AmazonNeptune
public DescribeGlobalClustersResult describeGlobalClusters(DescribeGlobalClustersRequest request)
AmazonNeptune
Returns information about Neptune global database clusters. This API supports pagination.
describeGlobalClusters
in interface AmazonNeptune
public DescribeOrderableDBInstanceOptionsResult describeOrderableDBInstanceOptions(DescribeOrderableDBInstanceOptionsRequest request)
AmazonNeptune
Returns a list of orderable DB instance options for the specified engine.
describeOrderableDBInstanceOptions
in interface AmazonNeptune
public DescribePendingMaintenanceActionsResult describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest request)
AmazonNeptune
Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
describePendingMaintenanceActions
in interface AmazonNeptune
public ValidDBInstanceModificationsMessage describeValidDBInstanceModifications(DescribeValidDBInstanceModificationsRequest request)
AmazonNeptune
You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance.
describeValidDBInstanceModifications
in interface AmazonNeptune
public DBCluster failoverDBCluster(FailoverDBClusterRequest request)
AmazonNeptune
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.
failoverDBCluster
in interface AmazonNeptune
public GlobalCluster failoverGlobalCluster(FailoverGlobalClusterRequest request)
AmazonNeptune
Initiates the failover process for a Neptune global database.
A failover for a Neptune global database promotes one of secondary read-only DB clusters to be the primary DB cluster and demotes the primary DB cluster to being a secondary (read-only) DB cluster. In other words, the role of the current primary DB cluster and the selected target secondary DB cluster are switched. The selected secondary DB cluster assumes full read/write capabilities for the Neptune global database.
This action applies only to Neptune global databases. This action is only intended for use on healthy Neptune global databases with healthy Neptune DB clusters and no region-wide outages, to test disaster recovery scenarios or to reconfigure the global database topology.
failoverGlobalCluster
in interface AmazonNeptune
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AmazonNeptune
Lists all tags on an Amazon Neptune resource.
listTagsForResource
in interface AmazonNeptune
public DBCluster modifyDBCluster(ModifyDBClusterRequest request)
AmazonNeptune
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.
modifyDBCluster
in interface AmazonNeptune
public ModifyDBClusterEndpointResult modifyDBClusterEndpoint(ModifyDBClusterEndpointRequest request)
AmazonNeptune
Modifies the properties of an endpoint in an Amazon Neptune DB cluster.
modifyDBClusterEndpoint
in interface AmazonNeptune
public ModifyDBClusterParameterGroupResult modifyDBClusterParameterGroup(ModifyDBClusterParameterGroupRequest request)
AmazonNeptune
Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the
following: ParameterName
, ParameterValue
, and ApplyMethod
. A maximum of 20
parameters can be modified in a single request.
Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB cluster associated with the parameter group before the change can take effect.
After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB
cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon Neptune to
fully complete the create action before the parameter group is used as the default for a new DB cluster. This is
especially important for parameters that are critical when creating the default database for a DB cluster, such
as the character set for the default database defined by the character_set_database
parameter. You
can use the Parameter Groups option of the Amazon Neptune console or the
DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or
modified.
modifyDBClusterParameterGroup
in interface AmazonNeptune
public DBClusterSnapshotAttributesResult modifyDBClusterSnapshotAttribute(ModifyDBClusterSnapshotAttributeRequest request)
AmazonNeptune
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.
modifyDBClusterSnapshotAttribute
in interface AmazonNeptune
public DBInstance modifyDBInstance(ModifyDBInstanceRequest request)
AmazonNeptune
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.
modifyDBInstance
in interface AmazonNeptune
public ModifyDBParameterGroupResult modifyDBParameterGroup(ModifyDBParameterGroupRequest request)
AmazonNeptune
Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the
following: ParameterName
, ParameterValue
, and ApplyMethod
. A maximum of 20
parameters can be modified in a single request.
Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect.
After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance
that uses that DB parameter group as the default parameter group. This allows Amazon Neptune to fully complete
the modify action before the parameter group is used as the default for a new DB instance. This is especially
important for parameters that are critical when creating the default database for a DB instance, such as the
character set for the default database defined by the character_set_database
parameter. You can use
the Parameter Groups option of the Amazon Neptune console or the DescribeDBParameters command to
verify that your DB parameter group has been created or modified.
modifyDBParameterGroup
in interface AmazonNeptune
public DBSubnetGroup modifyDBSubnetGroup(ModifyDBSubnetGroupRequest request)
AmazonNeptune
Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Region.
modifyDBSubnetGroup
in interface AmazonNeptune
public EventSubscription modifyEventSubscription(ModifyEventSubscriptionRequest request)
AmazonNeptune
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.
modifyEventSubscription
in interface AmazonNeptune
public GlobalCluster modifyGlobalCluster(ModifyGlobalClusterRequest request)
AmazonNeptune
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.
modifyGlobalCluster
in interface AmazonNeptune
public DBCluster promoteReadReplicaDBCluster(PromoteReadReplicaDBClusterRequest request)
AmazonNeptune
Not supported.
promoteReadReplicaDBCluster
in interface AmazonNeptune
public DBInstance rebootDBInstance(RebootDBInstanceRequest request)
AmazonNeptune
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.
rebootDBInstance
in interface AmazonNeptune
public GlobalCluster removeFromGlobalCluster(RemoveFromGlobalClusterRequest request)
AmazonNeptune
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.
removeFromGlobalCluster
in interface AmazonNeptune
public RemoveRoleFromDBClusterResult removeRoleFromDBCluster(RemoveRoleFromDBClusterRequest request)
AmazonNeptune
Disassociates an Identity and Access Management (IAM) role from a DB cluster.
removeRoleFromDBCluster
in interface AmazonNeptune
public EventSubscription removeSourceIdentifierFromSubscription(RemoveSourceIdentifierFromSubscriptionRequest request)
AmazonNeptune
Removes a source identifier from an existing event notification subscription.
removeSourceIdentifierFromSubscription
in interface AmazonNeptune
public RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest request)
AmazonNeptune
Removes metadata tags from an Amazon Neptune resource.
removeTagsFromResource
in interface AmazonNeptune
public ResetDBClusterParameterGroupResult resetDBClusterParameterGroup(ResetDBClusterParameterGroupRequest request)
AmazonNeptune
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.
resetDBClusterParameterGroup
in interface AmazonNeptune
public ResetDBParameterGroupResult resetDBParameterGroup(ResetDBParameterGroupRequest request)
AmazonNeptune
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.
resetDBParameterGroup
in interface AmazonNeptune
public DBCluster restoreDBClusterFromSnapshot(RestoreDBClusterFromSnapshotRequest request)
AmazonNeptune
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.
restoreDBClusterFromSnapshot
in interface AmazonNeptune
public DBCluster restoreDBClusterToPointInTime(RestoreDBClusterToPointInTimeRequest request)
AmazonNeptune
Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before
LatestRestorableTime
for up to BackupRetentionPeriod
days. The target DB cluster is
created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB
cluster is created with the default DB security group.
This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the
CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of
the restored DB cluster in DBClusterIdentifier
. You can create DB instances only after the
RestoreDBClusterToPointInTime
action has completed and the DB cluster is available.
restoreDBClusterToPointInTime
in interface AmazonNeptune
public DBCluster startDBCluster(StartDBClusterRequest request)
AmazonNeptune
Starts an Amazon Neptune DB cluster that was stopped using the Amazon console, the Amazon CLI stop-db-cluster command, or the StopDBCluster API.
startDBCluster
in interface AmazonNeptune
public DBCluster stopDBCluster(StopDBClusterRequest request)
AmazonNeptune
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.
stopDBCluster
in interface AmazonNeptune
public void shutdown()
AmazonNeptune
shutdown
in interface AmazonNeptune
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonNeptune
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata
in interface AmazonNeptune
request
- The originally executed request.public AmazonNeptuneWaiters waiters()
waiters
in interface AmazonNeptune