/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/*
* Do not modify this file. This file is generated from the docdb-2014-10-31.normal.json service model.
*/
using System;
using System.Runtime.ExceptionServices;
using System.Threading;
using System.Threading.Tasks;
using System.Collections.Generic;
using System.Net;
using Amazon.DocDB.Model;
using Amazon.DocDB.Model.Internal.MarshallTransformations;
using Amazon.DocDB.Internal;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
using Amazon.Runtime.Internal.Auth;
using Amazon.Runtime.Internal.Transform;
namespace Amazon.DocDB
{
///
/// Implementation for accessing DocDB
///
/// Amazon DocumentDB is a fast, reliable, and fully managed database service. Amazon
/// DocumentDB makes it easy to set up, operate, and scale MongoDB-compatible databases
/// in the cloud. With Amazon DocumentDB, you can run the same application code and use
/// the same drivers and tools that you use with MongoDB.
///
public partial class AmazonDocDBClient : AmazonServiceClient, IAmazonDocDB
{
private static IServiceMetadata serviceMetadata = new AmazonDocDBMetadata();
private IDocDBPaginatorFactory _paginators;
///
/// Paginators for the service
///
public IDocDBPaginatorFactory Paginators
{
get
{
if (this._paginators == null)
{
this._paginators = new DocDBPaginatorFactory(this);
}
return this._paginators;
}
}
#region Constructors
///
/// Constructs AmazonDocDBClient with the credentials loaded from the application's
/// default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
///
/// Example App.config with credentials set.
///
/// <?xml version="1.0" encoding="utf-8" ?>
/// <configuration>
/// <appSettings>
/// <add key="AWSProfileName" value="AWS Default"/>
/// </appSettings>
/// </configuration>
///
///
///
public AmazonDocDBClient()
: base(FallbackCredentialsFactory.GetCredentials(), new AmazonDocDBConfig()) { }
///
/// Constructs AmazonDocDBClient with the credentials loaded from the application's
/// default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
///
/// Example App.config with credentials set.
///
/// <?xml version="1.0" encoding="utf-8" ?>
/// <configuration>
/// <appSettings>
/// <add key="AWSProfileName" value="AWS Default"/>
/// </appSettings>
/// </configuration>
///
///
///
/// The region to connect.
public AmazonDocDBClient(RegionEndpoint region)
: base(FallbackCredentialsFactory.GetCredentials(), new AmazonDocDBConfig{RegionEndpoint = region}) { }
///
/// Constructs AmazonDocDBClient with the credentials loaded from the application's
/// default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
///
/// Example App.config with credentials set.
///
/// <?xml version="1.0" encoding="utf-8" ?>
/// <configuration>
/// <appSettings>
/// <add key="AWSProfileName" value="AWS Default"/>
/// </appSettings>
/// </configuration>
///
///
///
/// The AmazonDocDBClient Configuration Object
public AmazonDocDBClient(AmazonDocDBConfig config)
: base(FallbackCredentialsFactory.GetCredentials(config), config){}
///
/// Constructs AmazonDocDBClient with AWS Credentials
///
/// AWS Credentials
public AmazonDocDBClient(AWSCredentials credentials)
: this(credentials, new AmazonDocDBConfig())
{
}
///
/// Constructs AmazonDocDBClient with AWS Credentials
///
/// AWS Credentials
/// The region to connect.
public AmazonDocDBClient(AWSCredentials credentials, RegionEndpoint region)
: this(credentials, new AmazonDocDBConfig{RegionEndpoint = region})
{
}
///
/// Constructs AmazonDocDBClient with AWS Credentials and an
/// AmazonDocDBClient Configuration object.
///
/// AWS Credentials
/// The AmazonDocDBClient Configuration Object
public AmazonDocDBClient(AWSCredentials credentials, AmazonDocDBConfig clientConfig)
: base(credentials, clientConfig)
{
}
///
/// Constructs AmazonDocDBClient with AWS Access Key ID and AWS Secret Key
///
/// AWS Access Key ID
/// AWS Secret Access Key
public AmazonDocDBClient(string awsAccessKeyId, string awsSecretAccessKey)
: this(awsAccessKeyId, awsSecretAccessKey, new AmazonDocDBConfig())
{
}
///
/// Constructs AmazonDocDBClient with AWS Access Key ID and AWS Secret Key
///
/// AWS Access Key ID
/// AWS Secret Access Key
/// The region to connect.
public AmazonDocDBClient(string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region)
: this(awsAccessKeyId, awsSecretAccessKey, new AmazonDocDBConfig() {RegionEndpoint=region})
{
}
///
/// Constructs AmazonDocDBClient with AWS Access Key ID, AWS Secret Key and an
/// AmazonDocDBClient Configuration object.
///
/// AWS Access Key ID
/// AWS Secret Access Key
/// The AmazonDocDBClient Configuration Object
public AmazonDocDBClient(string awsAccessKeyId, string awsSecretAccessKey, AmazonDocDBConfig clientConfig)
: base(awsAccessKeyId, awsSecretAccessKey, clientConfig)
{
}
///
/// Constructs AmazonDocDBClient with AWS Access Key ID and AWS Secret Key
///
/// AWS Access Key ID
/// AWS Secret Access Key
/// AWS Session Token
public AmazonDocDBClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken)
: this(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, new AmazonDocDBConfig())
{
}
///
/// Constructs AmazonDocDBClient with AWS Access Key ID and AWS Secret Key
///
/// AWS Access Key ID
/// AWS Secret Access Key
/// AWS Session Token
/// The region to connect.
public AmazonDocDBClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region)
: this(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, new AmazonDocDBConfig{RegionEndpoint = region})
{
}
///
/// Constructs AmazonDocDBClient with AWS Access Key ID, AWS Secret Key and an
/// AmazonDocDBClient Configuration object.
///
/// AWS Access Key ID
/// AWS Secret Access Key
/// AWS Session Token
/// The AmazonDocDBClient Configuration Object
public AmazonDocDBClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonDocDBConfig clientConfig)
: base(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, clientConfig)
{
}
#endregion
#region Overrides
///
/// Creates the signer for the service.
///
protected override AbstractAWSSigner CreateSigner()
{
return new AWS4Signer();
}
///
/// Customize the pipeline
///
///
protected override void CustomizeRuntimePipeline(RuntimePipeline pipeline)
{
pipeline.AddHandlerBefore(new Amazon.DocDB.Internal.PreSignedUrlRequestHandler(this.Credentials));
pipeline.RemoveHandler();
pipeline.AddHandlerAfter(new AmazonDocDBEndpointResolver());
}
///
/// Capture metadata for the service.
///
protected override IServiceMetadata ServiceMetadata
{
get
{
return serviceMetadata;
}
}
#endregion
#region Dispose
///
/// Disposes the service client.
///
protected override void Dispose(bool disposing)
{
base.Dispose(disposing);
}
#endregion
#region AddSourceIdentifierToSubscription
///
/// Adds a source identifier to an existing event notification subscription.
///
/// Container for the necessary parameters to execute the AddSourceIdentifierToSubscription service method.
///
/// The response from the AddSourceIdentifierToSubscription service method, as returned by DocDB.
///
/// The requested source could not be found.
///
///
/// The subscription name does not exist.
///
/// REST API Reference for AddSourceIdentifierToSubscription Operation
public virtual AddSourceIdentifierToSubscriptionResponse AddSourceIdentifierToSubscription(AddSourceIdentifierToSubscriptionRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = AddSourceIdentifierToSubscriptionRequestMarshaller.Instance;
options.ResponseUnmarshaller = AddSourceIdentifierToSubscriptionResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Adds a source identifier to an existing event notification subscription.
///
/// Container for the necessary parameters to execute the AddSourceIdentifierToSubscription service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the AddSourceIdentifierToSubscription service method, as returned by DocDB.
///
/// The requested source could not be found.
///
///
/// The subscription name does not exist.
///
/// REST API Reference for AddSourceIdentifierToSubscription Operation
public virtual Task AddSourceIdentifierToSubscriptionAsync(AddSourceIdentifierToSubscriptionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = AddSourceIdentifierToSubscriptionRequestMarshaller.Instance;
options.ResponseUnmarshaller = AddSourceIdentifierToSubscriptionResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region AddTagsToResource
///
/// Adds metadata tags to an Amazon DocumentDB resource. You can use these tags with cost
/// allocation reporting to track costs that are associated with Amazon DocumentDB resources
/// or in a Condition
statement in an Identity and Access Management (IAM)
/// policy for Amazon DocumentDB.
///
/// Container for the necessary parameters to execute the AddTagsToResource service method.
///
/// The response from the AddTagsToResource service method, as returned by DocDB.
///
/// DBClusterIdentifier
doesn't refer to an existing cluster.
///
///
/// DBInstanceIdentifier
doesn't refer to an existing instance.
///
///
/// DBSnapshotIdentifier
doesn't refer to an existing snapshot.
///
/// REST API Reference for AddTagsToResource Operation
public virtual AddTagsToResourceResponse AddTagsToResource(AddTagsToResourceRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = AddTagsToResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = AddTagsToResourceResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Adds metadata tags to an Amazon DocumentDB resource. You can use these tags with cost
/// allocation reporting to track costs that are associated with Amazon DocumentDB resources
/// or in a Condition
statement in an Identity and Access Management (IAM)
/// policy for Amazon DocumentDB.
///
/// Container for the necessary parameters to execute the AddTagsToResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the AddTagsToResource service method, as returned by DocDB.
///
/// DBClusterIdentifier
doesn't refer to an existing cluster.
///
///
/// DBInstanceIdentifier
doesn't refer to an existing instance.
///
///
/// DBSnapshotIdentifier
doesn't refer to an existing snapshot.
///
/// REST API Reference for AddTagsToResource Operation
public virtual Task AddTagsToResourceAsync(AddTagsToResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = AddTagsToResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = AddTagsToResourceResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region ApplyPendingMaintenanceAction
///
/// Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB
/// instance).
///
/// Container for the necessary parameters to execute the ApplyPendingMaintenanceAction service method.
///
/// The response from the ApplyPendingMaintenanceAction service method, as returned by DocDB.
///
/// The cluster isn't in a valid state.
///
///
/// The specified instance isn't in the available state.
///
///
/// The specified resource ID was not found.
///
/// REST API Reference for ApplyPendingMaintenanceAction Operation
public virtual ApplyPendingMaintenanceActionResponse ApplyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ApplyPendingMaintenanceActionRequestMarshaller.Instance;
options.ResponseUnmarshaller = ApplyPendingMaintenanceActionResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB
/// instance).
///
/// Container for the necessary parameters to execute the ApplyPendingMaintenanceAction service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ApplyPendingMaintenanceAction service method, as returned by DocDB.
///
/// The cluster isn't in a valid state.
///
///
/// The specified instance isn't in the available state.
///
///
/// The specified resource ID was not found.
///
/// REST API Reference for ApplyPendingMaintenanceAction Operation
public virtual Task ApplyPendingMaintenanceActionAsync(ApplyPendingMaintenanceActionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ApplyPendingMaintenanceActionRequestMarshaller.Instance;
options.ResponseUnmarshaller = ApplyPendingMaintenanceActionResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region CopyDBClusterParameterGroup
///
/// Copies the specified cluster parameter group.
///
/// Container for the necessary parameters to execute the CopyDBClusterParameterGroup service method.
///
/// The response from the CopyDBClusterParameterGroup service method, as returned by DocDB.
///
/// A parameter group with the same name already exists.
///
///
/// DBParameterGroupName
doesn't refer to an existing parameter group.
///
///
/// This request would cause you to exceed the allowed number of parameter groups.
///
/// REST API Reference for CopyDBClusterParameterGroup Operation
public virtual CopyDBClusterParameterGroupResponse CopyDBClusterParameterGroup(CopyDBClusterParameterGroupRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = CopyDBClusterParameterGroupRequestMarshaller.Instance;
options.ResponseUnmarshaller = CopyDBClusterParameterGroupResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Copies the specified cluster parameter group.
///
/// Container for the necessary parameters to execute the CopyDBClusterParameterGroup service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CopyDBClusterParameterGroup service method, as returned by DocDB.
///
/// A parameter group with the same name already exists.
///
///
/// DBParameterGroupName
doesn't refer to an existing parameter group.
///
///
/// This request would cause you to exceed the allowed number of parameter groups.
///
/// REST API Reference for CopyDBClusterParameterGroup Operation
public virtual Task CopyDBClusterParameterGroupAsync(CopyDBClusterParameterGroupRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = CopyDBClusterParameterGroupRequestMarshaller.Instance;
options.ResponseUnmarshaller = CopyDBClusterParameterGroupResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region CopyDBClusterSnapshot
///
/// Copies a snapshot of a cluster.
///
///
///
/// To copy a cluster snapshot from a shared manual cluster snapshot, SourceDBClusterSnapshotIdentifier
/// must be the Amazon Resource Name (ARN) of the shared cluster snapshot. You can only
/// copy a shared DB cluster snapshot, whether encrypted or not, in the same Amazon Web
/// Services Region.
///
///
///
/// To cancel the copy operation after it is in progress, delete the target cluster snapshot
/// identified by TargetDBClusterSnapshotIdentifier
while that cluster snapshot
/// is in the copying status.
///
///
/// Container for the necessary parameters to execute the CopyDBClusterSnapshot service method.
///
/// The response from the CopyDBClusterSnapshot service method, as returned by DocDB.
///
/// You already have a cluster snapshot with the given identifier.
///
///
/// DBClusterSnapshotIdentifier
doesn't refer to an existing cluster snapshot.
///
///
/// The provided value isn't a valid cluster snapshot state.
///
///
/// The cluster isn't in a valid state.
///
///
/// An error occurred when accessing an KMS key.
///
///
/// The request would cause you to exceed the allowed number of snapshots.
///
/// REST API Reference for CopyDBClusterSnapshot Operation
public virtual CopyDBClusterSnapshotResponse CopyDBClusterSnapshot(CopyDBClusterSnapshotRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = CopyDBClusterSnapshotRequestMarshaller.Instance;
options.ResponseUnmarshaller = CopyDBClusterSnapshotResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Copies a snapshot of a cluster.
///
///
///
/// To copy a cluster snapshot from a shared manual cluster snapshot, SourceDBClusterSnapshotIdentifier
/// must be the Amazon Resource Name (ARN) of the shared cluster snapshot. You can only
/// copy a shared DB cluster snapshot, whether encrypted or not, in the same Amazon Web
/// Services Region.
///
///
///
/// To cancel the copy operation after it is in progress, delete the target cluster snapshot
/// identified by TargetDBClusterSnapshotIdentifier
while that cluster snapshot
/// is in the copying status.
///
///
/// Container for the necessary parameters to execute the CopyDBClusterSnapshot service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CopyDBClusterSnapshot service method, as returned by DocDB.
///
/// You already have a cluster snapshot with the given identifier.
///
///
/// DBClusterSnapshotIdentifier
doesn't refer to an existing cluster snapshot.
///
///
/// The provided value isn't a valid cluster snapshot state.
///
///
/// The cluster isn't in a valid state.
///
///
/// An error occurred when accessing an KMS key.
///
///
/// The request would cause you to exceed the allowed number of snapshots.
///
/// REST API Reference for CopyDBClusterSnapshot Operation
public virtual Task CopyDBClusterSnapshotAsync(CopyDBClusterSnapshotRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = CopyDBClusterSnapshotRequestMarshaller.Instance;
options.ResponseUnmarshaller = CopyDBClusterSnapshotResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region CreateDBCluster
///
/// Creates a new Amazon DocumentDB cluster.
///
/// Container for the necessary parameters to execute the CreateDBCluster service method.
///
/// The response from the CreateDBCluster service method, as returned by DocDB.
///
/// You already have a cluster with the given identifier.
///
///
/// DBClusterIdentifier
doesn't refer to an existing cluster.
///
///
/// DBClusterParameterGroupName
doesn't refer to an existing cluster parameter
/// group.
///
///
/// The cluster can't be created because you have reached the maximum allowed quota of
/// clusters.
///
///
/// DBInstanceIdentifier
doesn't refer to an existing instance.
///
///
/// Subnets in the subnet group should cover at least two Availability Zones unless there
/// is only one Availability Zone.
///
///
/// DBSubnetGroupName
doesn't refer to an existing subnet group.
///
///
/// The GlobalClusterIdentifier
doesn't refer to an existing global cluster.
///
///
/// There is not enough storage available for the current action. You might be able to
/// resolve this error by updating your subnet group to use different Availability Zones
/// that have more storage available.
///
///
/// The cluster isn't in a valid state.
///
///
/// The specified instance isn't in the available state.
///
///
/// The subnet group can't be deleted because it's in use.
///
///
/// The requested operation can't be performed while the cluster is in this state.
///
///
/// The requested subnet is not valid, or multiple subnets were requested that are not
/// all in a common virtual private cloud (VPC).
///
///
/// The subnet group doesn't cover all Availability Zones after it is created because
/// of changes that were made.
///
///
/// An error occurred when accessing an KMS key.
///
///
/// The request would cause you to exceed the allowed amount of storage available across
/// all instances.
///
/// REST API Reference for CreateDBCluster Operation
public virtual CreateDBClusterResponse CreateDBCluster(CreateDBClusterRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateDBClusterRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateDBClusterResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Creates a new Amazon DocumentDB cluster.
///
/// Container for the necessary parameters to execute the CreateDBCluster service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateDBCluster service method, as returned by DocDB.
///
/// You already have a cluster with the given identifier.
///
///
/// DBClusterIdentifier
doesn't refer to an existing cluster.
///
///
/// DBClusterParameterGroupName
doesn't refer to an existing cluster parameter
/// group.
///
///
/// The cluster can't be created because you have reached the maximum allowed quota of
/// clusters.
///
///
/// DBInstanceIdentifier
doesn't refer to an existing instance.
///
///
/// Subnets in the subnet group should cover at least two Availability Zones unless there
/// is only one Availability Zone.
///
///
/// DBSubnetGroupName
doesn't refer to an existing subnet group.
///
///
/// The GlobalClusterIdentifier
doesn't refer to an existing global cluster.
///
///
/// There is not enough storage available for the current action. You might be able to
/// resolve this error by updating your subnet group to use different Availability Zones
/// that have more storage available.
///
///
/// The cluster isn't in a valid state.
///
///
/// The specified instance isn't in the available state.
///
///
/// The subnet group can't be deleted because it's in use.
///
///
/// The requested operation can't be performed while the cluster is in this state.
///
///
/// The requested subnet is not valid, or multiple subnets were requested that are not
/// all in a common virtual private cloud (VPC).
///
///
/// The subnet group doesn't cover all Availability Zones after it is created because
/// of changes that were made.
///
///
/// An error occurred when accessing an KMS key.
///
///
/// The request would cause you to exceed the allowed amount of storage available across
/// all instances.
///
/// REST API Reference for CreateDBCluster Operation
public virtual Task CreateDBClusterAsync(CreateDBClusterRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateDBClusterRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateDBClusterResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region CreateDBClusterParameterGroup
///
/// Creates a new cluster parameter group.
///
///
///
/// Parameters in a cluster parameter group apply to all of the instances in a cluster.
///
///
///
/// A cluster parameter group is initially created with the default parameters for the
/// database engine used by instances in the cluster. In Amazon DocumentDB, you cannot
/// make modifications directly to the default.docdb3.6
cluster parameter
/// group. If your Amazon DocumentDB cluster is using the default cluster parameter group
/// and you want to modify a value in it, you must first
/// create a new parameter group or
/// copy an existing parameter group, modify it, and then apply the modified parameter
/// group to your cluster. For the new cluster parameter group and associated settings
/// to take effect, you must then reboot the instances in the cluster without failover.
/// For more information, see
/// Modifying Amazon DocumentDB Cluster Parameter Groups.
///
///
/// Container for the necessary parameters to execute the CreateDBClusterParameterGroup service method.
///
/// The response from the CreateDBClusterParameterGroup service method, as returned by DocDB.
///
/// A parameter group with the same name already exists.
///
///
/// This request would cause you to exceed the allowed number of parameter groups.
///
/// REST API Reference for CreateDBClusterParameterGroup Operation
public virtual CreateDBClusterParameterGroupResponse CreateDBClusterParameterGroup(CreateDBClusterParameterGroupRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateDBClusterParameterGroupRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateDBClusterParameterGroupResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Creates a new cluster parameter group.
///
///
///
/// Parameters in a cluster parameter group apply to all of the instances in a cluster.
///
///
///
/// A cluster parameter group is initially created with the default parameters for the
/// database engine used by instances in the cluster. In Amazon DocumentDB, you cannot
/// make modifications directly to the default.docdb3.6
cluster parameter
/// group. If your Amazon DocumentDB cluster is using the default cluster parameter group
/// and you want to modify a value in it, you must first
/// create a new parameter group or
/// copy an existing parameter group, modify it, and then apply the modified parameter
/// group to your cluster. For the new cluster parameter group and associated settings
/// to take effect, you must then reboot the instances in the cluster without failover.
/// For more information, see
/// Modifying Amazon DocumentDB Cluster Parameter Groups.
///
///
/// Container for the necessary parameters to execute the CreateDBClusterParameterGroup service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateDBClusterParameterGroup service method, as returned by DocDB.
///
/// A parameter group with the same name already exists.
///
///
/// This request would cause you to exceed the allowed number of parameter groups.
///
/// REST API Reference for CreateDBClusterParameterGroup Operation
public virtual Task CreateDBClusterParameterGroupAsync(CreateDBClusterParameterGroupRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateDBClusterParameterGroupRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateDBClusterParameterGroupResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region CreateDBClusterSnapshot
///
/// Creates a snapshot of a cluster.
///
/// Container for the necessary parameters to execute the CreateDBClusterSnapshot service method.
///
/// The response from the CreateDBClusterSnapshot service method, as returned by DocDB.
///
/// DBClusterIdentifier
doesn't refer to an existing cluster.
///
///
/// You already have a cluster snapshot with the given identifier.
///
///
/// The provided value isn't a valid cluster snapshot state.
///
///
/// The cluster isn't in a valid state.
///
///
/// The request would cause you to exceed the allowed number of snapshots.
///
/// REST API Reference for CreateDBClusterSnapshot Operation
public virtual CreateDBClusterSnapshotResponse CreateDBClusterSnapshot(CreateDBClusterSnapshotRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateDBClusterSnapshotRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateDBClusterSnapshotResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Creates a snapshot of a cluster.
///
/// Container for the necessary parameters to execute the CreateDBClusterSnapshot service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateDBClusterSnapshot service method, as returned by DocDB.
///
/// DBClusterIdentifier
doesn't refer to an existing cluster.
///
///
/// You already have a cluster snapshot with the given identifier.
///
///
/// The provided value isn't a valid cluster snapshot state.
///
///
/// The cluster isn't in a valid state.
///
///
/// The request would cause you to exceed the allowed number of snapshots.
///
/// REST API Reference for CreateDBClusterSnapshot Operation
public virtual Task CreateDBClusterSnapshotAsync(CreateDBClusterSnapshotRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateDBClusterSnapshotRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateDBClusterSnapshotResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region CreateDBInstance
///
/// Creates a new instance.
///
/// Container for the necessary parameters to execute the CreateDBInstance service method.
///
/// The response from the CreateDBInstance service method, as returned by DocDB.
///
/// The specified CIDR IP or Amazon EC2 security group isn't authorized for the specified
/// security group.
///
///
///
/// Amazon DocumentDB also might not be authorized to perform necessary actions on your
/// behalf using IAM.
///
///
///
/// DBClusterIdentifier
doesn't refer to an existing cluster.
///
///
/// You already have a instance with the given identifier.
///
///
/// DBParameterGroupName
doesn't refer to an existing parameter group.
///
///
/// DBSecurityGroupName
doesn't refer to an existing security group.
///
///
/// Subnets in the subnet group should cover at least two Availability Zones unless there
/// is only one Availability Zone.
///
///
/// DBSubnetGroupName
doesn't refer to an existing subnet group.
///
///
/// The request would cause you to exceed the allowed number of instances.
///
///
/// The specified instance class isn't available in the specified Availability Zone.
///
///
/// The cluster isn't in a valid state.
///
///
/// The requested subnet is not valid, or multiple subnets were requested that are not
/// all in a common virtual private cloud (VPC).
///
///
/// The subnet group doesn't cover all Availability Zones after it is created because
/// of changes that were made.
///
///
/// An error occurred when accessing an KMS key.
///
///
/// The request would cause you to exceed the allowed amount of storage available across
/// all instances.
///
///
/// Storage of the specified StorageType
can't be associated with the DB
/// instance.
///
/// REST API Reference for CreateDBInstance Operation
public virtual CreateDBInstanceResponse CreateDBInstance(CreateDBInstanceRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateDBInstanceRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateDBInstanceResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Creates a new instance.
///
/// Container for the necessary parameters to execute the CreateDBInstance service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateDBInstance service method, as returned by DocDB.
///
/// The specified CIDR IP or Amazon EC2 security group isn't authorized for the specified
/// security group.
///
///
///
/// Amazon DocumentDB also might not be authorized to perform necessary actions on your
/// behalf using IAM.
///
///
///
/// DBClusterIdentifier
doesn't refer to an existing cluster.
///
///
/// You already have a instance with the given identifier.
///
///
/// DBParameterGroupName
doesn't refer to an existing parameter group.
///
///
/// DBSecurityGroupName
doesn't refer to an existing security group.
///
///
/// Subnets in the subnet group should cover at least two Availability Zones unless there
/// is only one Availability Zone.
///
///
/// DBSubnetGroupName
doesn't refer to an existing subnet group.
///
///
/// The request would cause you to exceed the allowed number of instances.
///
///
/// The specified instance class isn't available in the specified Availability Zone.
///
///
/// The cluster isn't in a valid state.
///
///
/// The requested subnet is not valid, or multiple subnets were requested that are not
/// all in a common virtual private cloud (VPC).
///
///
/// The subnet group doesn't cover all Availability Zones after it is created because
/// of changes that were made.
///
///
/// An error occurred when accessing an KMS key.
///
///
/// The request would cause you to exceed the allowed amount of storage available across
/// all instances.
///
///
/// Storage of the specified StorageType
can't be associated with the DB
/// instance.
///
/// REST API Reference for CreateDBInstance Operation
public virtual Task CreateDBInstanceAsync(CreateDBInstanceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateDBInstanceRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateDBInstanceResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region CreateDBSubnetGroup
///
/// Creates a new subnet group. subnet groups must contain at least one subnet in at least
/// two Availability Zones in the Amazon Web Services Region.
///
/// Container for the necessary parameters to execute the CreateDBSubnetGroup service method.
///
/// The response from the CreateDBSubnetGroup service method, as returned by DocDB.
///
/// DBSubnetGroupName
is already being used by an existing subnet group.
///
///
/// Subnets in the subnet group should cover at least two Availability Zones unless there
/// is only one Availability Zone.
///
///
/// The request would cause you to exceed the allowed number of subnet groups.
///
///
/// The request would cause you to exceed the allowed number of subnets in a subnet group.
///
///
/// The requested subnet is not valid, or multiple subnets were requested that are not
/// all in a common virtual private cloud (VPC).
///
/// REST API Reference for CreateDBSubnetGroup Operation
public virtual CreateDBSubnetGroupResponse CreateDBSubnetGroup(CreateDBSubnetGroupRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateDBSubnetGroupRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateDBSubnetGroupResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Creates a new subnet group. subnet groups must contain at least one subnet in at least
/// two Availability Zones in the Amazon Web Services Region.
///
/// Container for the necessary parameters to execute the CreateDBSubnetGroup service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateDBSubnetGroup service method, as returned by DocDB.
///
/// DBSubnetGroupName
is already being used by an existing subnet group.
///
///
/// Subnets in the subnet group should cover at least two Availability Zones unless there
/// is only one Availability Zone.
///
///
/// The request would cause you to exceed the allowed number of subnet groups.
///
///
/// The request would cause you to exceed the allowed number of subnets in a subnet group.
///
///
/// The requested subnet is not valid, or multiple subnets were requested that are not
/// all in a common virtual private cloud (VPC).
///
/// REST API Reference for CreateDBSubnetGroup Operation
public virtual Task CreateDBSubnetGroupAsync(CreateDBSubnetGroupRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateDBSubnetGroupRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateDBSubnetGroupResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region CreateEventSubscription
///
/// Creates an Amazon DocumentDB event notification subscription. This action requires
/// a topic Amazon Resource Name (ARN) created by using the Amazon DocumentDB console,
/// the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you
/// must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed
/// in the Amazon SNS console.
///
///
///
/// You can specify the type of source (SourceType
) that you want to be notified
/// of. You can also provide a list of Amazon DocumentDB sources (SourceIds
)
/// that trigger the events, and you can provide a list of event categories (EventCategories
)
/// for events that 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 Amazon DocumentDB
/// sources. If you do not specify either the SourceType
or the SourceIdentifier
,
/// you are notified of events generated from all Amazon DocumentDB sources belonging
/// to your customer account.
///
///
/// Container for the necessary parameters to execute the CreateEventSubscription service method.
///
/// The response from the CreateEventSubscription service method, as returned by DocDB.
///
/// You have reached the maximum number of event subscriptions.
///
///
/// Amazon SNS has responded that there is a problem with the specified topic.
///
///
/// You do not have permission to publish to the SNS topic Amazon Resource Name (ARN).
///
///
/// The SNS topic Amazon Resource Name (ARN) does not exist.
///
///
/// The requested source could not be found.
///
///
/// The provided subscription name already exists.
///
///
/// The provided category does not exist.
///
/// REST API Reference for CreateEventSubscription Operation
public virtual CreateEventSubscriptionResponse CreateEventSubscription(CreateEventSubscriptionRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateEventSubscriptionRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateEventSubscriptionResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Creates an Amazon DocumentDB event notification subscription. This action requires
/// a topic Amazon Resource Name (ARN) created by using the Amazon DocumentDB console,
/// the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you
/// must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed
/// in the Amazon SNS console.
///
///
///
/// You can specify the type of source (SourceType
) that you want to be notified
/// of. You can also provide a list of Amazon DocumentDB sources (SourceIds
)
/// that trigger the events, and you can provide a list of event categories (EventCategories
)
/// for events that 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 Amazon DocumentDB
/// sources. If you do not specify either the SourceType
or the SourceIdentifier
,
/// you are notified of events generated from all Amazon DocumentDB sources belonging
/// to your customer account.
///
///
/// Container for the necessary parameters to execute the CreateEventSubscription service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateEventSubscription service method, as returned by DocDB.
///
/// You have reached the maximum number of event subscriptions.
///
///
/// Amazon SNS has responded that there is a problem with the specified topic.
///
///
/// You do not have permission to publish to the SNS topic Amazon Resource Name (ARN).
///
///
/// The SNS topic Amazon Resource Name (ARN) does not exist.
///
///
/// The requested source could not be found.
///
///
/// The provided subscription name already exists.
///
///
/// The provided category does not exist.
///
/// REST API Reference for CreateEventSubscription Operation
public virtual Task CreateEventSubscriptionAsync(CreateEventSubscriptionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateEventSubscriptionRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateEventSubscriptionResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region CreateGlobalCluster
///
/// Creates an Amazon DocumentDB global cluster that can span multiple multiple Amazon
/// Web Services Regions. The global cluster contains one primary cluster with read-write
/// capability, and up-to give read-only secondary clusters. Global clusters uses storage-based
/// fast replication across regions with latencies less than one second, using dedicated
/// infrastructure with no impact to your workload’s performance.
///
///
///
/// You can create a global cluster that is initially empty, and then add a primary and
/// a secondary to it. Or you can specify an existing cluster during the create operation,
/// and this cluster becomes the primary of the global cluster.
///
///
///
/// This action only applies to Amazon DocumentDB clusters.
///
///
///
/// Container for the necessary parameters to execute the CreateGlobalCluster service method.
///
/// The response from the CreateGlobalCluster service method, as returned by DocDB.
///
/// DBClusterIdentifier
doesn't refer to an existing cluster.
///
///
/// The GlobalClusterIdentifier
already exists. Choose a new global cluster
/// identifier (unique name) to create a new global cluster.
///
///
/// The number of global clusters for this account is already at the maximum allowed.
///
///
/// The cluster isn't in a valid state.
///
/// REST API Reference for CreateGlobalCluster Operation
public virtual CreateGlobalClusterResponse CreateGlobalCluster(CreateGlobalClusterRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateGlobalClusterRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateGlobalClusterResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Creates an Amazon DocumentDB global cluster that can span multiple multiple Amazon
/// Web Services Regions. The global cluster contains one primary cluster with read-write
/// capability, and up-to give read-only secondary clusters. Global clusters uses storage-based
/// fast replication across regions with latencies less than one second, using dedicated
/// infrastructure with no impact to your workload’s performance.
///
///
///
/// You can create a global cluster that is initially empty, and then add a primary and
/// a secondary to it. Or you can specify an existing cluster during the create operation,
/// and this cluster becomes the primary of the global cluster.
///
///
///
/// This action only applies to Amazon DocumentDB clusters.
///
///
///
/// Container for the necessary parameters to execute the CreateGlobalCluster service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateGlobalCluster service method, as returned by DocDB.
///
/// DBClusterIdentifier
doesn't refer to an existing cluster.
///
///
/// The GlobalClusterIdentifier
already exists. Choose a new global cluster
/// identifier (unique name) to create a new global cluster.
///
///
/// The number of global clusters for this account is already at the maximum allowed.
///
///
/// The cluster isn't in a valid state.
///
/// REST API Reference for CreateGlobalCluster Operation
public virtual Task CreateGlobalClusterAsync(CreateGlobalClusterRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateGlobalClusterRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateGlobalClusterResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DeleteDBCluster
///
/// Deletes a previously provisioned cluster. When you delete a cluster, all automated
/// backups for that cluster are deleted and can't be recovered. Manual DB cluster snapshots
/// of the specified cluster are not deleted.
///
/// Container for the necessary parameters to execute the DeleteDBCluster service method.
///
/// The response from the DeleteDBCluster service method, as returned by DocDB.
///
/// DBClusterIdentifier
doesn't refer to an existing cluster.
///
///
/// You already have a cluster snapshot with the given identifier.
///
///
/// The provided value isn't a valid cluster snapshot state.
///
///
/// The cluster isn't in a valid state.
///
///
/// The request would cause you to exceed the allowed number of snapshots.
///
/// REST API Reference for DeleteDBCluster Operation
public virtual DeleteDBClusterResponse DeleteDBCluster(DeleteDBClusterRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteDBClusterRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteDBClusterResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Deletes a previously provisioned cluster. When you delete a cluster, all automated
/// backups for that cluster are deleted and can't be recovered. Manual DB cluster snapshots
/// of the specified cluster are not deleted.
///
/// Container for the necessary parameters to execute the DeleteDBCluster service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteDBCluster service method, as returned by DocDB.
///
/// DBClusterIdentifier
doesn't refer to an existing cluster.
///
///
/// You already have a cluster snapshot with the given identifier.
///
///
/// The provided value isn't a valid cluster snapshot state.
///
///
/// The cluster isn't in a valid state.
///
///
/// The request would cause you to exceed the allowed number of snapshots.
///
/// REST API Reference for DeleteDBCluster Operation
public virtual Task DeleteDBClusterAsync(DeleteDBClusterRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteDBClusterRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteDBClusterResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DeleteDBClusterParameterGroup
///
/// Deletes a specified cluster parameter group. The cluster parameter group to be deleted
/// can't be associated with any clusters.
///
/// Container for the necessary parameters to execute the DeleteDBClusterParameterGroup service method.
///
/// The response from the DeleteDBClusterParameterGroup service method, as returned by DocDB.
///
/// DBParameterGroupName
doesn't refer to an existing parameter group.
///
///
/// The parameter group is in use, or it is in a state that is not valid. If you are trying
/// to delete the parameter group, you can't delete it when the parameter group is in
/// this state.
///
/// REST API Reference for DeleteDBClusterParameterGroup Operation
public virtual DeleteDBClusterParameterGroupResponse DeleteDBClusterParameterGroup(DeleteDBClusterParameterGroupRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteDBClusterParameterGroupRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteDBClusterParameterGroupResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Deletes a specified cluster parameter group. The cluster parameter group to be deleted
/// can't be associated with any clusters.
///
/// Container for the necessary parameters to execute the DeleteDBClusterParameterGroup service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteDBClusterParameterGroup service method, as returned by DocDB.
///
/// DBParameterGroupName
doesn't refer to an existing parameter group.
///
///
/// The parameter group is in use, or it is in a state that is not valid. If you are trying
/// to delete the parameter group, you can't delete it when the parameter group is in
/// this state.
///
/// REST API Reference for DeleteDBClusterParameterGroup Operation
public virtual Task DeleteDBClusterParameterGroupAsync(DeleteDBClusterParameterGroupRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteDBClusterParameterGroupRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteDBClusterParameterGroupResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DeleteDBClusterSnapshot
///
/// Deletes a cluster snapshot. If the snapshot is being copied, the copy operation is
/// terminated.
///
///
///
/// The cluster snapshot must be in the available
state to be deleted.
///
///
///
/// Container for the necessary parameters to execute the DeleteDBClusterSnapshot service method.
///
/// The response from the DeleteDBClusterSnapshot service method, as returned by DocDB.
///
/// DBClusterSnapshotIdentifier
doesn't refer to an existing cluster snapshot.
///
///
/// The provided value isn't a valid cluster snapshot state.
///
/// REST API Reference for DeleteDBClusterSnapshot Operation
public virtual DeleteDBClusterSnapshotResponse DeleteDBClusterSnapshot(DeleteDBClusterSnapshotRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteDBClusterSnapshotRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteDBClusterSnapshotResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Deletes a cluster snapshot. If the snapshot is being copied, the copy operation is
/// terminated.
///
///
///
/// The cluster snapshot must be in the available
state to be deleted.
///
///
///
/// Container for the necessary parameters to execute the DeleteDBClusterSnapshot service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteDBClusterSnapshot service method, as returned by DocDB.
///
/// DBClusterSnapshotIdentifier
doesn't refer to an existing cluster snapshot.
///
///
/// The provided value isn't a valid cluster snapshot state.
///
/// REST API Reference for DeleteDBClusterSnapshot Operation
public virtual Task DeleteDBClusterSnapshotAsync(DeleteDBClusterSnapshotRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteDBClusterSnapshotRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteDBClusterSnapshotResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DeleteDBInstance
///
/// Deletes a previously provisioned instance.
///
/// Container for the necessary parameters to execute the DeleteDBInstance service method.
///
/// The response from the DeleteDBInstance service method, as returned by DocDB.
///
/// DBInstanceIdentifier
doesn't refer to an existing instance.
///
///
/// DBSnapshotIdentifier
is already being used by an existing snapshot.
///
///
/// The cluster isn't in a valid state.
///
///
/// The specified instance isn't in the available state.
///
///
/// The request would cause you to exceed the allowed number of snapshots.
///
/// REST API Reference for DeleteDBInstance Operation
public virtual DeleteDBInstanceResponse DeleteDBInstance(DeleteDBInstanceRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteDBInstanceRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteDBInstanceResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Deletes a previously provisioned instance.
///
/// Container for the necessary parameters to execute the DeleteDBInstance service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteDBInstance service method, as returned by DocDB.
///
/// DBInstanceIdentifier
doesn't refer to an existing instance.
///
///
/// DBSnapshotIdentifier
is already being used by an existing snapshot.
///
///
/// The cluster isn't in a valid state.
///
///
/// The specified instance isn't in the available state.
///
///
/// The request would cause you to exceed the allowed number of snapshots.
///
/// REST API Reference for DeleteDBInstance Operation
public virtual Task DeleteDBInstanceAsync(DeleteDBInstanceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteDBInstanceRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteDBInstanceResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DeleteDBSubnetGroup
///
/// Deletes a subnet group.
///
///
///
/// The specified database subnet group must not be associated with any DB instances.
///
///
///
/// Container for the necessary parameters to execute the DeleteDBSubnetGroup service method.
///
/// The response from the DeleteDBSubnetGroup service method, as returned by DocDB.
///
/// DBSubnetGroupName
doesn't refer to an existing subnet group.
///
///
/// The subnet group can't be deleted because it's in use.
///
///
/// The subnet isn't in the available state.
///
/// REST API Reference for DeleteDBSubnetGroup Operation
public virtual DeleteDBSubnetGroupResponse DeleteDBSubnetGroup(DeleteDBSubnetGroupRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteDBSubnetGroupRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteDBSubnetGroupResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Deletes a subnet group.
///
///
///
/// The specified database subnet group must not be associated with any DB instances.
///
///
///
/// Container for the necessary parameters to execute the DeleteDBSubnetGroup service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteDBSubnetGroup service method, as returned by DocDB.
///
/// DBSubnetGroupName
doesn't refer to an existing subnet group.
///
///
/// The subnet group can't be deleted because it's in use.
///
///
/// The subnet isn't in the available state.
///
/// REST API Reference for DeleteDBSubnetGroup Operation
public virtual Task DeleteDBSubnetGroupAsync(DeleteDBSubnetGroupRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteDBSubnetGroupRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteDBSubnetGroupResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DeleteEventSubscription
///
/// Deletes an Amazon DocumentDB event notification subscription.
///
/// Container for the necessary parameters to execute the DeleteEventSubscription service method.
///
/// The response from the DeleteEventSubscription service method, as returned by DocDB.
///
/// Someone else might be modifying a subscription. Wait a few seconds, and try again.
///
///
/// The subscription name does not exist.
///
/// REST API Reference for DeleteEventSubscription Operation
public virtual DeleteEventSubscriptionResponse DeleteEventSubscription(DeleteEventSubscriptionRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteEventSubscriptionRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteEventSubscriptionResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Deletes an Amazon DocumentDB event notification subscription.
///
/// Container for the necessary parameters to execute the DeleteEventSubscription service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteEventSubscription service method, as returned by DocDB.
///
/// Someone else might be modifying a subscription. Wait a few seconds, and try again.
///
///
/// The subscription name does not exist.
///
/// REST API Reference for DeleteEventSubscription Operation
public virtual Task DeleteEventSubscriptionAsync(DeleteEventSubscriptionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteEventSubscriptionRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteEventSubscriptionResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DeleteGlobalCluster
///
/// Deletes a global cluster. The primary and secondary clusters must already be detached
/// or deleted before attempting to delete a global cluster.
///
///
///
/// This action only applies to Amazon DocumentDB clusters.
///
///
///
/// Container for the necessary parameters to execute the DeleteGlobalCluster service method.
///
/// The response from the DeleteGlobalCluster service method, as returned by DocDB.
///
/// The GlobalClusterIdentifier
doesn't refer to an existing global cluster.
///
///
/// The requested operation can't be performed while the cluster is in this state.
///
/// REST API Reference for DeleteGlobalCluster Operation
public virtual DeleteGlobalClusterResponse DeleteGlobalCluster(DeleteGlobalClusterRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteGlobalClusterRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteGlobalClusterResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Deletes a global cluster. The primary and secondary clusters must already be detached
/// or deleted before attempting to delete a global cluster.
///
///
///
/// This action only applies to Amazon DocumentDB clusters.
///
///
///
/// Container for the necessary parameters to execute the DeleteGlobalCluster service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteGlobalCluster service method, as returned by DocDB.
///
/// The GlobalClusterIdentifier
doesn't refer to an existing global cluster.
///
///
/// The requested operation can't be performed while the cluster is in this state.
///
/// REST API Reference for DeleteGlobalCluster Operation
public virtual Task DeleteGlobalClusterAsync(DeleteGlobalClusterRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteGlobalClusterRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteGlobalClusterResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DescribeCertificates
///
/// Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB
/// for this Amazon Web Services account.
///
/// Container for the necessary parameters to execute the DescribeCertificates service method.
///
/// The response from the DescribeCertificates service method, as returned by DocDB.
///
/// CertificateIdentifier
doesn't refer to an existing certificate.
///
/// REST API Reference for DescribeCertificates Operation
public virtual DescribeCertificatesResponse DescribeCertificates(DescribeCertificatesRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeCertificatesRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeCertificatesResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB
/// for this Amazon Web Services account.
///
/// Container for the necessary parameters to execute the DescribeCertificates service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeCertificates service method, as returned by DocDB.
///
/// CertificateIdentifier
doesn't refer to an existing certificate.
///
/// REST API Reference for DescribeCertificates Operation
public virtual Task DescribeCertificatesAsync(DescribeCertificatesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeCertificatesRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeCertificatesResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DescribeDBClusterParameterGroups
///
/// Returns a list of DBClusterParameterGroup
descriptions. If a DBClusterParameterGroupName
/// parameter is specified, the list contains only the description of the specified cluster
/// parameter group.
///
/// Container for the necessary parameters to execute the DescribeDBClusterParameterGroups service method.
///
/// The response from the DescribeDBClusterParameterGroups service method, as returned by DocDB.
///
/// DBParameterGroupName
doesn't refer to an existing parameter group.
///
/// REST API Reference for DescribeDBClusterParameterGroups Operation
public virtual DescribeDBClusterParameterGroupsResponse DescribeDBClusterParameterGroups(DescribeDBClusterParameterGroupsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeDBClusterParameterGroupsRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeDBClusterParameterGroupsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns a list of DBClusterParameterGroup
descriptions. If a DBClusterParameterGroupName
/// parameter is specified, the list contains only the description of the specified cluster
/// parameter group.
///
/// Container for the necessary parameters to execute the DescribeDBClusterParameterGroups service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeDBClusterParameterGroups service method, as returned by DocDB.
///
/// DBParameterGroupName
doesn't refer to an existing parameter group.
///
/// REST API Reference for DescribeDBClusterParameterGroups Operation
public virtual Task DescribeDBClusterParameterGroupsAsync(DescribeDBClusterParameterGroupsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeDBClusterParameterGroupsRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeDBClusterParameterGroupsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DescribeDBClusterParameters
///
/// Returns the detailed parameter list for a particular cluster parameter group.
///
/// Container for the necessary parameters to execute the DescribeDBClusterParameters service method.
///
/// The response from the DescribeDBClusterParameters service method, as returned by DocDB.
///
/// DBParameterGroupName
doesn't refer to an existing parameter group.
///
/// REST API Reference for DescribeDBClusterParameters Operation
public virtual DescribeDBClusterParametersResponse DescribeDBClusterParameters(DescribeDBClusterParametersRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeDBClusterParametersRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeDBClusterParametersResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns the detailed parameter list for a particular cluster parameter group.
///
/// Container for the necessary parameters to execute the DescribeDBClusterParameters service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeDBClusterParameters service method, as returned by DocDB.
///
/// DBParameterGroupName
doesn't refer to an existing parameter group.
///
/// REST API Reference for DescribeDBClusterParameters Operation
public virtual Task DescribeDBClusterParametersAsync(DescribeDBClusterParametersRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeDBClusterParametersRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeDBClusterParametersResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DescribeDBClusters
///
/// Returns information about provisioned Amazon DocumentDB clusters. This API operation
/// supports pagination. For certain management features such as cluster and instance
/// lifecycle management, Amazon DocumentDB leverages operational technology that is shared
/// with Amazon RDS and Amazon Neptune. Use the filterName=engine,Values=docdb
/// filter parameter to return only Amazon DocumentDB clusters.
///
/// Container for the necessary parameters to execute the DescribeDBClusters service method.
///
/// The response from the DescribeDBClusters service method, as returned by DocDB.
///
/// DBClusterIdentifier
doesn't refer to an existing cluster.
///
/// REST API Reference for DescribeDBClusters Operation
public virtual DescribeDBClustersResponse DescribeDBClusters(DescribeDBClustersRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeDBClustersRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeDBClustersResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns information about provisioned Amazon DocumentDB clusters. This API operation
/// supports pagination. For certain management features such as cluster and instance
/// lifecycle management, Amazon DocumentDB leverages operational technology that is shared
/// with Amazon RDS and Amazon Neptune. Use the filterName=engine,Values=docdb
/// filter parameter to return only Amazon DocumentDB clusters.
///
/// Container for the necessary parameters to execute the DescribeDBClusters service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeDBClusters service method, as returned by DocDB.
///
/// DBClusterIdentifier
doesn't refer to an existing cluster.
///
/// REST API Reference for DescribeDBClusters Operation
public virtual Task DescribeDBClustersAsync(DescribeDBClustersRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeDBClustersRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeDBClustersResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DescribeDBClusterSnapshotAttributes
///
/// Returns a list of cluster snapshot attribute names and values for a manual DB cluster
/// snapshot.
///
///
///
/// When you share snapshots with other Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes
/// returns the restore
attribute and a list of IDs for the Amazon Web Services
/// accounts that are authorized to copy or restore the manual cluster snapshot. If all
/// is included in the list of values for the restore
attribute, then the
/// manual cluster snapshot is public and can be copied or restored by all Amazon Web
/// Services accounts.
///
///
/// Container for the necessary parameters to execute the DescribeDBClusterSnapshotAttributes service method.
///
/// The response from the DescribeDBClusterSnapshotAttributes service method, as returned by DocDB.
///
/// DBClusterSnapshotIdentifier
doesn't refer to an existing cluster snapshot.
///
/// REST API Reference for DescribeDBClusterSnapshotAttributes Operation
public virtual DescribeDBClusterSnapshotAttributesResponse DescribeDBClusterSnapshotAttributes(DescribeDBClusterSnapshotAttributesRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeDBClusterSnapshotAttributesRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeDBClusterSnapshotAttributesResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns a list of cluster snapshot attribute names and values for a manual DB cluster
/// snapshot.
///
///
///
/// When you share snapshots with other Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes
/// returns the restore
attribute and a list of IDs for the Amazon Web Services
/// accounts that are authorized to copy or restore the manual cluster snapshot. If all
/// is included in the list of values for the restore
attribute, then the
/// manual cluster snapshot is public and can be copied or restored by all Amazon Web
/// Services accounts.
///
///
/// Container for the necessary parameters to execute the DescribeDBClusterSnapshotAttributes service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeDBClusterSnapshotAttributes service method, as returned by DocDB.
///
/// DBClusterSnapshotIdentifier
doesn't refer to an existing cluster snapshot.
///
/// REST API Reference for DescribeDBClusterSnapshotAttributes Operation
public virtual Task DescribeDBClusterSnapshotAttributesAsync(DescribeDBClusterSnapshotAttributesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeDBClusterSnapshotAttributesRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeDBClusterSnapshotAttributesResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DescribeDBClusterSnapshots
///
/// Returns information about cluster snapshots. This API operation supports pagination.
///
/// Container for the necessary parameters to execute the DescribeDBClusterSnapshots service method.
///
/// The response from the DescribeDBClusterSnapshots service method, as returned by DocDB.
///
/// DBClusterSnapshotIdentifier
doesn't refer to an existing cluster snapshot.
///
/// REST API Reference for DescribeDBClusterSnapshots Operation
public virtual DescribeDBClusterSnapshotsResponse DescribeDBClusterSnapshots(DescribeDBClusterSnapshotsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeDBClusterSnapshotsRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeDBClusterSnapshotsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns information about cluster snapshots. This API operation supports pagination.
///
/// Container for the necessary parameters to execute the DescribeDBClusterSnapshots service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeDBClusterSnapshots service method, as returned by DocDB.
///
/// DBClusterSnapshotIdentifier
doesn't refer to an existing cluster snapshot.
///
/// REST API Reference for DescribeDBClusterSnapshots Operation
public virtual Task DescribeDBClusterSnapshotsAsync(DescribeDBClusterSnapshotsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeDBClusterSnapshotsRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeDBClusterSnapshotsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DescribeDBEngineVersions
///
/// Returns a list of the available engines.
///
/// Container for the necessary parameters to execute the DescribeDBEngineVersions service method.
///
/// The response from the DescribeDBEngineVersions service method, as returned by DocDB.
/// REST API Reference for DescribeDBEngineVersions Operation
public virtual DescribeDBEngineVersionsResponse DescribeDBEngineVersions(DescribeDBEngineVersionsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeDBEngineVersionsRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeDBEngineVersionsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns a list of the available engines.
///
/// Container for the necessary parameters to execute the DescribeDBEngineVersions service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeDBEngineVersions service method, as returned by DocDB.
/// REST API Reference for DescribeDBEngineVersions Operation
public virtual Task DescribeDBEngineVersionsAsync(DescribeDBEngineVersionsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeDBEngineVersionsRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeDBEngineVersionsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DescribeDBInstances
///
/// Returns information about provisioned Amazon DocumentDB instances. This API supports
/// pagination.
///
/// Container for the necessary parameters to execute the DescribeDBInstances service method.
///
/// The response from the DescribeDBInstances service method, as returned by DocDB.
///
/// DBInstanceIdentifier
doesn't refer to an existing instance.
///
/// REST API Reference for DescribeDBInstances Operation
public virtual DescribeDBInstancesResponse DescribeDBInstances(DescribeDBInstancesRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeDBInstancesRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeDBInstancesResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns information about provisioned Amazon DocumentDB instances. This API supports
/// pagination.
///
/// Container for the necessary parameters to execute the DescribeDBInstances service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeDBInstances service method, as returned by DocDB.
///
/// DBInstanceIdentifier
doesn't refer to an existing instance.
///
/// REST API Reference for DescribeDBInstances Operation
public virtual Task DescribeDBInstancesAsync(DescribeDBInstancesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeDBInstancesRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeDBInstancesResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DescribeDBSubnetGroups
///
/// Returns a list of DBSubnetGroup
descriptions. If a DBSubnetGroupName
/// is specified, the list will contain only the descriptions of the specified DBSubnetGroup
.
///
/// Container for the necessary parameters to execute the DescribeDBSubnetGroups service method.
///
/// The response from the DescribeDBSubnetGroups service method, as returned by DocDB.
///
/// DBSubnetGroupName
doesn't refer to an existing subnet group.
///
/// REST API Reference for DescribeDBSubnetGroups Operation
public virtual DescribeDBSubnetGroupsResponse DescribeDBSubnetGroups(DescribeDBSubnetGroupsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeDBSubnetGroupsRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeDBSubnetGroupsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns a list of DBSubnetGroup
descriptions. If a DBSubnetGroupName
/// is specified, the list will contain only the descriptions of the specified DBSubnetGroup
.
///
/// Container for the necessary parameters to execute the DescribeDBSubnetGroups service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeDBSubnetGroups service method, as returned by DocDB.
///
/// DBSubnetGroupName
doesn't refer to an existing subnet group.
///
/// REST API Reference for DescribeDBSubnetGroups Operation
public virtual Task DescribeDBSubnetGroupsAsync(DescribeDBSubnetGroupsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeDBSubnetGroupsRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeDBSubnetGroupsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DescribeEngineDefaultClusterParameters
///
/// Returns the default engine and system parameter information for the cluster database
/// engine.
///
/// Container for the necessary parameters to execute the DescribeEngineDefaultClusterParameters service method.
///
/// The response from the DescribeEngineDefaultClusterParameters service method, as returned by DocDB.
/// REST API Reference for DescribeEngineDefaultClusterParameters Operation
public virtual DescribeEngineDefaultClusterParametersResponse DescribeEngineDefaultClusterParameters(DescribeEngineDefaultClusterParametersRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeEngineDefaultClusterParametersRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeEngineDefaultClusterParametersResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns the default engine and system parameter information for the cluster database
/// engine.
///
/// Container for the necessary parameters to execute the DescribeEngineDefaultClusterParameters service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeEngineDefaultClusterParameters service method, as returned by DocDB.
/// REST API Reference for DescribeEngineDefaultClusterParameters Operation
public virtual Task DescribeEngineDefaultClusterParametersAsync(DescribeEngineDefaultClusterParametersRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeEngineDefaultClusterParametersRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeEngineDefaultClusterParametersResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DescribeEventCategories
///
/// Displays a list of categories for all event source types, or, if specified, for a
/// specified source type.
///
/// Container for the necessary parameters to execute the DescribeEventCategories service method.
///
/// The response from the DescribeEventCategories service method, as returned by DocDB.
/// REST API Reference for DescribeEventCategories Operation
public virtual DescribeEventCategoriesResponse DescribeEventCategories(DescribeEventCategoriesRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeEventCategoriesRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeEventCategoriesResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Displays a list of categories for all event source types, or, if specified, for a
/// specified source type.
///
/// Container for the necessary parameters to execute the DescribeEventCategories service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeEventCategories service method, as returned by DocDB.
/// REST API Reference for DescribeEventCategories Operation
public virtual Task DescribeEventCategoriesAsync(DescribeEventCategoriesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeEventCategoriesRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeEventCategoriesResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DescribeEvents
///
/// Returns events related to instances, security groups, snapshots, and DB parameter
/// groups for the past 14 days. You can obtain events specific to a particular DB instance,
/// security group, snapshot, or parameter group by providing the name as a parameter.
/// By default, the events of the past hour are returned.
///
/// Container for the necessary parameters to execute the DescribeEvents service method.
///
/// The response from the DescribeEvents service method, as returned by DocDB.
/// REST API Reference for DescribeEvents Operation
public virtual DescribeEventsResponse DescribeEvents(DescribeEventsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeEventsRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeEventsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns events related to instances, security groups, snapshots, and DB parameter
/// groups for the past 14 days. You can obtain events specific to a particular DB instance,
/// security group, snapshot, or parameter group by providing the name as a parameter.
/// By default, the events of the past hour are returned.
///
/// Container for the necessary parameters to execute the DescribeEvents service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeEvents service method, as returned by DocDB.
/// REST API Reference for DescribeEvents Operation
public virtual Task DescribeEventsAsync(DescribeEventsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeEventsRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeEventsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DescribeEventSubscriptions
///
/// 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.
///
///
/// Container for the necessary parameters to execute the DescribeEventSubscriptions service method.
///
/// The response from the DescribeEventSubscriptions service method, as returned by DocDB.
///
/// The subscription name does not exist.
///
/// REST API Reference for DescribeEventSubscriptions Operation
public virtual DescribeEventSubscriptionsResponse DescribeEventSubscriptions(DescribeEventSubscriptionsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeEventSubscriptionsRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeEventSubscriptionsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// 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.
///
///
/// Container for the necessary parameters to execute the DescribeEventSubscriptions service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeEventSubscriptions service method, as returned by DocDB.
///
/// The subscription name does not exist.
///
/// REST API Reference for DescribeEventSubscriptions Operation
public virtual Task DescribeEventSubscriptionsAsync(DescribeEventSubscriptionsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeEventSubscriptionsRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeEventSubscriptionsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DescribeGlobalClusters
///
/// Returns information about Amazon DocumentDB global clusters. This API supports pagination.
///
///
///
/// This action only applies to Amazon DocumentDB clusters.
///
///
///
/// Container for the necessary parameters to execute the DescribeGlobalClusters service method.
///
/// The response from the DescribeGlobalClusters service method, as returned by DocDB.
///
/// The GlobalClusterIdentifier
doesn't refer to an existing global cluster.
///
/// REST API Reference for DescribeGlobalClusters Operation
public virtual DescribeGlobalClustersResponse DescribeGlobalClusters(DescribeGlobalClustersRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeGlobalClustersRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeGlobalClustersResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns information about Amazon DocumentDB global clusters. This API supports pagination.
///
///
///
/// This action only applies to Amazon DocumentDB clusters.
///
///
///
/// Container for the necessary parameters to execute the DescribeGlobalClusters service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeGlobalClusters service method, as returned by DocDB.
///
/// The GlobalClusterIdentifier
doesn't refer to an existing global cluster.
///
/// REST API Reference for DescribeGlobalClusters Operation
public virtual Task DescribeGlobalClustersAsync(DescribeGlobalClustersRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeGlobalClustersRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeGlobalClustersResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DescribeOrderableDBInstanceOptions
///
/// Returns a list of orderable instance options for the specified engine.
///
/// Container for the necessary parameters to execute the DescribeOrderableDBInstanceOptions service method.
///
/// The response from the DescribeOrderableDBInstanceOptions service method, as returned by DocDB.
/// REST API Reference for DescribeOrderableDBInstanceOptions Operation
public virtual DescribeOrderableDBInstanceOptionsResponse DescribeOrderableDBInstanceOptions(DescribeOrderableDBInstanceOptionsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeOrderableDBInstanceOptionsRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeOrderableDBInstanceOptionsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns a list of orderable instance options for the specified engine.
///
/// Container for the necessary parameters to execute the DescribeOrderableDBInstanceOptions service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeOrderableDBInstanceOptions service method, as returned by DocDB.
/// REST API Reference for DescribeOrderableDBInstanceOptions Operation
public virtual Task DescribeOrderableDBInstanceOptionsAsync(DescribeOrderableDBInstanceOptionsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeOrderableDBInstanceOptionsRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeOrderableDBInstanceOptionsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region DescribePendingMaintenanceActions
///
/// Returns a list of resources (for example, instances) that have at least one pending
/// maintenance action.
///
/// Container for the necessary parameters to execute the DescribePendingMaintenanceActions service method.
///
/// The response from the DescribePendingMaintenanceActions service method, as returned by DocDB.
///
/// The specified resource ID was not found.
///
/// REST API Reference for DescribePendingMaintenanceActions Operation
public virtual DescribePendingMaintenanceActionsResponse DescribePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribePendingMaintenanceActionsRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribePendingMaintenanceActionsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Returns a list of resources (for example, instances) that have at least one pending
/// maintenance action.
///
/// Container for the necessary parameters to execute the DescribePendingMaintenanceActions service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribePendingMaintenanceActions service method, as returned by DocDB.
///
/// The specified resource ID was not found.
///
/// REST API Reference for DescribePendingMaintenanceActions Operation
public virtual Task DescribePendingMaintenanceActionsAsync(DescribePendingMaintenanceActionsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribePendingMaintenanceActionsRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribePendingMaintenanceActionsResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region FailoverDBCluster
///
/// Forces a failover for a cluster.
///
///
///
/// A failover for a cluster promotes one of the Amazon DocumentDB replicas (read-only
/// instances) in the cluster to be the primary instance (the cluster writer).
///
///
///
/// If the primary instance fails, Amazon DocumentDB automatically fails over to an Amazon
/// DocumentDB replica, if one exists. You can force a failover when you want to simulate
/// a failure of a primary instance for testing.
///
///
/// Container for the necessary parameters to execute the FailoverDBCluster service method.
///
/// The response from the FailoverDBCluster service method, as returned by DocDB.
///
/// DBClusterIdentifier
doesn't refer to an existing cluster.
///
///
/// The cluster isn't in a valid state.
///
///
/// The specified instance isn't in the available state.
///
/// REST API Reference for FailoverDBCluster Operation
public virtual FailoverDBClusterResponse FailoverDBCluster(FailoverDBClusterRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = FailoverDBClusterRequestMarshaller.Instance;
options.ResponseUnmarshaller = FailoverDBClusterResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Forces a failover for a cluster.
///
///
///
/// A failover for a cluster promotes one of the Amazon DocumentDB replicas (read-only
/// instances) in the cluster to be the primary instance (the cluster writer).
///
///
///
/// If the primary instance fails, Amazon DocumentDB automatically fails over to an Amazon
/// DocumentDB replica, if one exists. You can force a failover when you want to simulate
/// a failure of a primary instance for testing.
///
///
/// Container for the necessary parameters to execute the FailoverDBCluster service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the FailoverDBCluster service method, as returned by DocDB.
///
/// DBClusterIdentifier
doesn't refer to an existing cluster.
///
///
/// The cluster isn't in a valid state.
///
///
/// The specified instance isn't in the available state.
///
/// REST API Reference for FailoverDBCluster Operation
public virtual Task FailoverDBClusterAsync(FailoverDBClusterRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = FailoverDBClusterRequestMarshaller.Instance;
options.ResponseUnmarshaller = FailoverDBClusterResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region ListTagsForResource
///
/// Lists all tags on an Amazon DocumentDB resource.
///
/// Container for the necessary parameters to execute the ListTagsForResource service method.
///
/// The response from the ListTagsForResource service method, as returned by DocDB.
///
/// DBClusterIdentifier
doesn't refer to an existing cluster.
///
///
/// DBInstanceIdentifier
doesn't refer to an existing instance.
///
///
/// DBSnapshotIdentifier
doesn't refer to an existing snapshot.
///
/// REST API Reference for ListTagsForResource Operation
public virtual ListTagsForResourceResponse ListTagsForResource(ListTagsForResourceRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListTagsForResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListTagsForResourceResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Lists all tags on an Amazon DocumentDB resource.
///
/// Container for the necessary parameters to execute the ListTagsForResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListTagsForResource service method, as returned by DocDB.
///
/// DBClusterIdentifier
doesn't refer to an existing cluster.
///
///
/// DBInstanceIdentifier
doesn't refer to an existing instance.
///
///
/// DBSnapshotIdentifier
doesn't refer to an existing snapshot.
///
/// REST API Reference for ListTagsForResource Operation
public virtual Task ListTagsForResourceAsync(ListTagsForResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ListTagsForResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListTagsForResourceResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region ModifyDBCluster
///
/// Modifies a setting for an Amazon DocumentDB cluster. You can change one or more database
/// configuration parameters by specifying these parameters and the new values in the
/// request.
///
/// Container for the necessary parameters to execute the ModifyDBCluster service method.
///
/// The response from the ModifyDBCluster service method, as returned by DocDB.
///
/// You already have a cluster with the given identifier.
///
///
/// DBClusterIdentifier
doesn't refer to an existing cluster.
///
///
/// DBClusterParameterGroupName
doesn't refer to an existing cluster parameter
/// group.
///
///
/// DBSubnetGroupName
doesn't refer to an existing subnet group.
///
///
/// The cluster isn't in a valid state.
///
///
/// The specified instance isn't in the available state.
///
///
/// The state of the security group doesn't allow deletion.
///
///
/// The subnet group can't be deleted because it's in use.
///
///
/// The requested subnet is not valid, or multiple subnets were requested that are not
/// all in a common virtual private cloud (VPC).
///
///
/// The subnet group doesn't cover all Availability Zones after it is created because
/// of changes that were made.
///
///
/// The request would cause you to exceed the allowed amount of storage available across
/// all instances.
///
/// REST API Reference for ModifyDBCluster Operation
public virtual ModifyDBClusterResponse ModifyDBCluster(ModifyDBClusterRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ModifyDBClusterRequestMarshaller.Instance;
options.ResponseUnmarshaller = ModifyDBClusterResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Modifies a setting for an Amazon DocumentDB cluster. You can change one or more database
/// configuration parameters by specifying these parameters and the new values in the
/// request.
///
/// Container for the necessary parameters to execute the ModifyDBCluster service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ModifyDBCluster service method, as returned by DocDB.
///
/// You already have a cluster with the given identifier.
///
///
/// DBClusterIdentifier
doesn't refer to an existing cluster.
///
///
/// DBClusterParameterGroupName
doesn't refer to an existing cluster parameter
/// group.
///
///
/// DBSubnetGroupName
doesn't refer to an existing subnet group.
///
///
/// The cluster isn't in a valid state.
///
///
/// The specified instance isn't in the available state.
///
///
/// The state of the security group doesn't allow deletion.
///
///
/// The subnet group can't be deleted because it's in use.
///
///
/// The requested subnet is not valid, or multiple subnets were requested that are not
/// all in a common virtual private cloud (VPC).
///
///
/// The subnet group doesn't cover all Availability Zones after it is created because
/// of changes that were made.
///
///
/// The request would cause you to exceed the allowed amount of storage available across
/// all instances.
///
/// REST API Reference for ModifyDBCluster Operation
public virtual Task ModifyDBClusterAsync(ModifyDBClusterRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ModifyDBClusterRequestMarshaller.Instance;
options.ResponseUnmarshaller = ModifyDBClusterResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region ModifyDBClusterParameterGroup
///
/// Modifies the parameters of a 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 or maintenance window before the change can take effect.
///
///
///
/// After you create a cluster parameter group, you should wait at least 5 minutes before
/// creating your first cluster that uses that cluster parameter group as the default
/// parameter group. This allows Amazon DocumentDB to fully complete the create action
/// before the parameter group is used as the default for a new cluster. This step is
/// especially important for parameters that are critical when creating the default database
/// for a cluster, such as the character set for the default database defined by the character_set_database
/// parameter.
///
///
///
/// Container for the necessary parameters to execute the ModifyDBClusterParameterGroup service method.
///
/// The response from the ModifyDBClusterParameterGroup service method, as returned by DocDB.
///
/// DBParameterGroupName
doesn't refer to an existing parameter group.
///
///
/// The parameter group is in use, or it is in a state that is not valid. If you are trying
/// to delete the parameter group, you can't delete it when the parameter group is in
/// this state.
///
/// REST API Reference for ModifyDBClusterParameterGroup Operation
public virtual ModifyDBClusterParameterGroupResponse ModifyDBClusterParameterGroup(ModifyDBClusterParameterGroupRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ModifyDBClusterParameterGroupRequestMarshaller.Instance;
options.ResponseUnmarshaller = ModifyDBClusterParameterGroupResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Modifies the parameters of a 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 or maintenance window before the change can take effect.
///
///
///
/// After you create a cluster parameter group, you should wait at least 5 minutes before
/// creating your first cluster that uses that cluster parameter group as the default
/// parameter group. This allows Amazon DocumentDB to fully complete the create action
/// before the parameter group is used as the default for a new cluster. This step is
/// especially important for parameters that are critical when creating the default database
/// for a cluster, such as the character set for the default database defined by the character_set_database
/// parameter.
///
///
///
/// Container for the necessary parameters to execute the ModifyDBClusterParameterGroup service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ModifyDBClusterParameterGroup service method, as returned by DocDB.
///
/// DBParameterGroupName
doesn't refer to an existing parameter group.
///
///
/// The parameter group is in use, or it is in a state that is not valid. If you are trying
/// to delete the parameter group, you can't delete it when the parameter group is in
/// this state.
///
/// REST API Reference for ModifyDBClusterParameterGroup Operation
public virtual Task ModifyDBClusterParameterGroupAsync(ModifyDBClusterParameterGroupRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ModifyDBClusterParameterGroupRequestMarshaller.Instance;
options.ResponseUnmarshaller = ModifyDBClusterParameterGroupResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region ModifyDBClusterSnapshotAttribute
///
/// Adds an attribute and values to, or removes an attribute and values from, a manual
/// cluster snapshot.
///
///
///
/// To share a manual cluster snapshot with other Amazon Web Services accounts, specify
/// restore
as the AttributeName
, and use the ValuesToAdd
/// parameter to add a list of IDs of the Amazon Web Services accounts that are authorized
/// to restore the manual cluster snapshot. Use the value all
to make the
/// manual cluster snapshot public, which means that it can be copied or restored by all
/// Amazon Web Services accounts. Do not add the all
value for any manual
/// cluster snapshots that contain private information that you don't want available to
/// all Amazon Web Services accounts. If a manual cluster snapshot is encrypted, it can
/// be shared, but only by specifying a list of authorized Amazon Web Services account
/// IDs for the ValuesToAdd
parameter. You can't use all
as
/// a value for that parameter in this case.
///
///
/// Container for the necessary parameters to execute the ModifyDBClusterSnapshotAttribute service method.
///
/// The response from the ModifyDBClusterSnapshotAttribute service method, as returned by DocDB.
///
/// DBClusterSnapshotIdentifier
doesn't refer to an existing cluster snapshot.
///
///
/// The provided value isn't a valid cluster snapshot state.
///
///
/// You have exceeded the maximum number of accounts that you can share a manual DB snapshot
/// with.
///
/// REST API Reference for ModifyDBClusterSnapshotAttribute Operation
public virtual ModifyDBClusterSnapshotAttributeResponse ModifyDBClusterSnapshotAttribute(ModifyDBClusterSnapshotAttributeRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ModifyDBClusterSnapshotAttributeRequestMarshaller.Instance;
options.ResponseUnmarshaller = ModifyDBClusterSnapshotAttributeResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Adds an attribute and values to, or removes an attribute and values from, a manual
/// cluster snapshot.
///
///
///
/// To share a manual cluster snapshot with other Amazon Web Services accounts, specify
/// restore
as the AttributeName
, and use the ValuesToAdd
/// parameter to add a list of IDs of the Amazon Web Services accounts that are authorized
/// to restore the manual cluster snapshot. Use the value all
to make the
/// manual cluster snapshot public, which means that it can be copied or restored by all
/// Amazon Web Services accounts. Do not add the all
value for any manual
/// cluster snapshots that contain private information that you don't want available to
/// all Amazon Web Services accounts. If a manual cluster snapshot is encrypted, it can
/// be shared, but only by specifying a list of authorized Amazon Web Services account
/// IDs for the ValuesToAdd
parameter. You can't use all
as
/// a value for that parameter in this case.
///
///
/// Container for the necessary parameters to execute the ModifyDBClusterSnapshotAttribute service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ModifyDBClusterSnapshotAttribute service method, as returned by DocDB.
///
/// DBClusterSnapshotIdentifier
doesn't refer to an existing cluster snapshot.
///
///
/// The provided value isn't a valid cluster snapshot state.
///
///
/// You have exceeded the maximum number of accounts that you can share a manual DB snapshot
/// with.
///
/// REST API Reference for ModifyDBClusterSnapshotAttribute Operation
public virtual Task ModifyDBClusterSnapshotAttributeAsync(ModifyDBClusterSnapshotAttributeRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ModifyDBClusterSnapshotAttributeRequestMarshaller.Instance;
options.ResponseUnmarshaller = ModifyDBClusterSnapshotAttributeResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region ModifyDBInstance
///
/// Modifies settings for an instance. You can change one or more database configuration
/// parameters by specifying these parameters and the new values in the request.
///
/// Container for the necessary parameters to execute the ModifyDBInstance service method.
///
/// The response from the ModifyDBInstance service method, as returned by DocDB.
///
/// The specified CIDR IP or Amazon EC2 security group isn't authorized for the specified
/// security group.
///
///
///
/// Amazon DocumentDB also might not be authorized to perform necessary actions on your
/// behalf using IAM.
///
///
///
/// CertificateIdentifier
doesn't refer to an existing certificate.
///
///
/// You already have a instance with the given identifier.
///
///
/// DBInstanceIdentifier
doesn't refer to an existing instance.
///
///
/// DBParameterGroupName
doesn't refer to an existing parameter group.
///
///
/// DBSecurityGroupName
doesn't refer to an existing security group.
///
///
/// The upgrade failed because a resource that the depends on can't be modified.
///
///
/// The specified instance class isn't available in the specified Availability Zone.
///
///
/// The specified instance isn't in the available state.
///
///
/// The state of the security group doesn't allow deletion.
///
///
/// The subnet group doesn't cover all Availability Zones after it is created because
/// of changes that were made.
///
///
/// The request would cause you to exceed the allowed amount of storage available across
/// all instances.
///
///
/// Storage of the specified StorageType
can't be associated with the DB
/// instance.
///
/// REST API Reference for ModifyDBInstance Operation
public virtual ModifyDBInstanceResponse ModifyDBInstance(ModifyDBInstanceRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ModifyDBInstanceRequestMarshaller.Instance;
options.ResponseUnmarshaller = ModifyDBInstanceResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Modifies settings for an instance. You can change one or more database configuration
/// parameters by specifying these parameters and the new values in the request.
///
/// Container for the necessary parameters to execute the ModifyDBInstance service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ModifyDBInstance service method, as returned by DocDB.
///
/// The specified CIDR IP or Amazon EC2 security group isn't authorized for the specified
/// security group.
///
///
///
/// Amazon DocumentDB also might not be authorized to perform necessary actions on your
/// behalf using IAM.
///
///
///
/// CertificateIdentifier
doesn't refer to an existing certificate.
///
///
/// You already have a instance with the given identifier.
///
///
/// DBInstanceIdentifier
doesn't refer to an existing instance.
///
///
/// DBParameterGroupName
doesn't refer to an existing parameter group.
///
///
/// DBSecurityGroupName
doesn't refer to an existing security group.
///
///
/// The upgrade failed because a resource that the depends on can't be modified.
///
///
/// The specified instance class isn't available in the specified Availability Zone.
///
///
/// The specified instance isn't in the available state.
///
///
/// The state of the security group doesn't allow deletion.
///
///
/// The subnet group doesn't cover all Availability Zones after it is created because
/// of changes that were made.
///
///
/// The request would cause you to exceed the allowed amount of storage available across
/// all instances.
///
///
/// Storage of the specified StorageType
can't be associated with the DB
/// instance.
///
/// REST API Reference for ModifyDBInstance Operation
public virtual Task ModifyDBInstanceAsync(ModifyDBInstanceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ModifyDBInstanceRequestMarshaller.Instance;
options.ResponseUnmarshaller = ModifyDBInstanceResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region ModifyDBSubnetGroup
///
/// Modifies an existing subnet group. subnet groups must contain at least one subnet
/// in at least two Availability Zones in the Amazon Web Services Region.
///
/// Container for the necessary parameters to execute the ModifyDBSubnetGroup service method.
///
/// The response from the ModifyDBSubnetGroup service method, as returned by DocDB.
///
/// Subnets in the subnet group should cover at least two Availability Zones unless there
/// is only one Availability Zone.
///
///
/// DBSubnetGroupName
doesn't refer to an existing subnet group.
///
///
/// The request would cause you to exceed the allowed number of subnets in a subnet group.
///
///
/// The requested subnet is not valid, or multiple subnets were requested that are not
/// all in a common virtual private cloud (VPC).
///
///
/// The subnet is already in use in the Availability Zone.
///
/// REST API Reference for ModifyDBSubnetGroup Operation
public virtual ModifyDBSubnetGroupResponse ModifyDBSubnetGroup(ModifyDBSubnetGroupRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ModifyDBSubnetGroupRequestMarshaller.Instance;
options.ResponseUnmarshaller = ModifyDBSubnetGroupResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Modifies an existing subnet group. subnet groups must contain at least one subnet
/// in at least two Availability Zones in the Amazon Web Services Region.
///
/// Container for the necessary parameters to execute the ModifyDBSubnetGroup service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ModifyDBSubnetGroup service method, as returned by DocDB.
///
/// Subnets in the subnet group should cover at least two Availability Zones unless there
/// is only one Availability Zone.
///
///
/// DBSubnetGroupName
doesn't refer to an existing subnet group.
///
///
/// The request would cause you to exceed the allowed number of subnets in a subnet group.
///
///
/// The requested subnet is not valid, or multiple subnets were requested that are not
/// all in a common virtual private cloud (VPC).
///
///
/// The subnet is already in use in the Availability Zone.
///
/// REST API Reference for ModifyDBSubnetGroup Operation
public virtual Task ModifyDBSubnetGroupAsync(ModifyDBSubnetGroupRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ModifyDBSubnetGroupRequestMarshaller.Instance;
options.ResponseUnmarshaller = ModifyDBSubnetGroupResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region ModifyEventSubscription
///
/// Modifies an existing Amazon DocumentDB event notification subscription.
///
/// Container for the necessary parameters to execute the ModifyEventSubscription service method.
///
/// The response from the ModifyEventSubscription service method, as returned by DocDB.
///
/// You have reached the maximum number of event subscriptions.
///
///
/// Amazon SNS has responded that there is a problem with the specified topic.
///
///
/// You do not have permission to publish to the SNS topic Amazon Resource Name (ARN).
///
///
/// The SNS topic Amazon Resource Name (ARN) does not exist.
///
///
/// The provided category does not exist.
///
///
/// The subscription name does not exist.
///
/// REST API Reference for ModifyEventSubscription Operation
public virtual ModifyEventSubscriptionResponse ModifyEventSubscription(ModifyEventSubscriptionRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ModifyEventSubscriptionRequestMarshaller.Instance;
options.ResponseUnmarshaller = ModifyEventSubscriptionResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Modifies an existing Amazon DocumentDB event notification subscription.
///
/// Container for the necessary parameters to execute the ModifyEventSubscription service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ModifyEventSubscription service method, as returned by DocDB.
///
/// You have reached the maximum number of event subscriptions.
///
///
/// Amazon SNS has responded that there is a problem with the specified topic.
///
///
/// You do not have permission to publish to the SNS topic Amazon Resource Name (ARN).
///
///
/// The SNS topic Amazon Resource Name (ARN) does not exist.
///
///
/// The provided category does not exist.
///
///
/// The subscription name does not exist.
///
/// REST API Reference for ModifyEventSubscription Operation
public virtual Task ModifyEventSubscriptionAsync(ModifyEventSubscriptionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ModifyEventSubscriptionRequestMarshaller.Instance;
options.ResponseUnmarshaller = ModifyEventSubscriptionResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region ModifyGlobalCluster
///
/// Modify a setting for an Amazon DocumentDB global cluster. You can change one or more
/// configuration parameters (for example: deletion protection), or the global cluster
/// identifier by specifying these parameters and the new values in the request.
///
///
///
/// This action only applies to Amazon DocumentDB clusters.
///
///
///
/// Container for the necessary parameters to execute the ModifyGlobalCluster service method.
///
/// The response from the ModifyGlobalCluster service method, as returned by DocDB.
///
/// The GlobalClusterIdentifier
doesn't refer to an existing global cluster.
///
///
/// The requested operation can't be performed while the cluster is in this state.
///
/// REST API Reference for ModifyGlobalCluster Operation
public virtual ModifyGlobalClusterResponse ModifyGlobalCluster(ModifyGlobalClusterRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ModifyGlobalClusterRequestMarshaller.Instance;
options.ResponseUnmarshaller = ModifyGlobalClusterResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Modify a setting for an Amazon DocumentDB global cluster. You can change one or more
/// configuration parameters (for example: deletion protection), or the global cluster
/// identifier by specifying these parameters and the new values in the request.
///
///
///
/// This action only applies to Amazon DocumentDB clusters.
///
///
///
/// Container for the necessary parameters to execute the ModifyGlobalCluster service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ModifyGlobalCluster service method, as returned by DocDB.
///
/// The GlobalClusterIdentifier
doesn't refer to an existing global cluster.
///
///
/// The requested operation can't be performed while the cluster is in this state.
///
/// REST API Reference for ModifyGlobalCluster Operation
public virtual Task ModifyGlobalClusterAsync(ModifyGlobalClusterRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ModifyGlobalClusterRequestMarshaller.Instance;
options.ResponseUnmarshaller = ModifyGlobalClusterResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region RebootDBInstance
///
/// You might need to reboot your instance, usually for maintenance reasons. For example,
/// if you make certain changes, or if you change the cluster parameter group that is
/// associated with the instance, you must reboot the instance for the changes to take
/// effect.
///
///
///
/// Rebooting an instance restarts the database engine service. Rebooting an instance
/// results in a momentary outage, during which the instance status is set to rebooting.
///
///
///
/// Container for the necessary parameters to execute the RebootDBInstance service method.
///
/// The response from the RebootDBInstance service method, as returned by DocDB.
///
/// DBInstanceIdentifier
doesn't refer to an existing instance.
///
///
/// The specified instance isn't in the available state.
///
/// REST API Reference for RebootDBInstance Operation
public virtual RebootDBInstanceResponse RebootDBInstance(RebootDBInstanceRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = RebootDBInstanceRequestMarshaller.Instance;
options.ResponseUnmarshaller = RebootDBInstanceResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// You might need to reboot your instance, usually for maintenance reasons. For example,
/// if you make certain changes, or if you change the cluster parameter group that is
/// associated with the instance, you must reboot the instance for the changes to take
/// effect.
///
///
///
/// Rebooting an instance restarts the database engine service. Rebooting an instance
/// results in a momentary outage, during which the instance status is set to rebooting.
///
///
///
/// Container for the necessary parameters to execute the RebootDBInstance service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the RebootDBInstance service method, as returned by DocDB.
///
/// DBInstanceIdentifier
doesn't refer to an existing instance.
///
///
/// The specified instance isn't in the available state.
///
/// REST API Reference for RebootDBInstance Operation
public virtual Task RebootDBInstanceAsync(RebootDBInstanceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = RebootDBInstanceRequestMarshaller.Instance;
options.ResponseUnmarshaller = RebootDBInstanceResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region RemoveFromGlobalCluster
///
/// Detaches an Amazon DocumentDB secondary cluster from a global cluster. The cluster
/// becomes a standalone cluster with read-write capability instead of being read-only
/// and receiving data from a primary in a different region.
///
///
///
/// This action only applies to Amazon DocumentDB clusters.
///
///
///
/// Container for the necessary parameters to execute the RemoveFromGlobalCluster service method.
///
/// The response from the RemoveFromGlobalCluster service method, as returned by DocDB.
///
/// DBClusterIdentifier
doesn't refer to an existing cluster.
///
///
/// The GlobalClusterIdentifier
doesn't refer to an existing global cluster.
///
///
/// The requested operation can't be performed while the cluster is in this state.
///
/// REST API Reference for RemoveFromGlobalCluster Operation
public virtual RemoveFromGlobalClusterResponse RemoveFromGlobalCluster(RemoveFromGlobalClusterRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = RemoveFromGlobalClusterRequestMarshaller.Instance;
options.ResponseUnmarshaller = RemoveFromGlobalClusterResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Detaches an Amazon DocumentDB secondary cluster from a global cluster. The cluster
/// becomes a standalone cluster with read-write capability instead of being read-only
/// and receiving data from a primary in a different region.
///
///
///
/// This action only applies to Amazon DocumentDB clusters.
///
///
///
/// Container for the necessary parameters to execute the RemoveFromGlobalCluster service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the RemoveFromGlobalCluster service method, as returned by DocDB.
///
/// DBClusterIdentifier
doesn't refer to an existing cluster.
///
///
/// The GlobalClusterIdentifier
doesn't refer to an existing global cluster.
///
///
/// The requested operation can't be performed while the cluster is in this state.
///
/// REST API Reference for RemoveFromGlobalCluster Operation
public virtual Task RemoveFromGlobalClusterAsync(RemoveFromGlobalClusterRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = RemoveFromGlobalClusterRequestMarshaller.Instance;
options.ResponseUnmarshaller = RemoveFromGlobalClusterResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region RemoveSourceIdentifierFromSubscription
///
/// Removes a source identifier from an existing Amazon DocumentDB event notification
/// subscription.
///
/// Container for the necessary parameters to execute the RemoveSourceIdentifierFromSubscription service method.
///
/// The response from the RemoveSourceIdentifierFromSubscription service method, as returned by DocDB.
///
/// The requested source could not be found.
///
///
/// The subscription name does not exist.
///
/// REST API Reference for RemoveSourceIdentifierFromSubscription Operation
public virtual RemoveSourceIdentifierFromSubscriptionResponse RemoveSourceIdentifierFromSubscription(RemoveSourceIdentifierFromSubscriptionRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = RemoveSourceIdentifierFromSubscriptionRequestMarshaller.Instance;
options.ResponseUnmarshaller = RemoveSourceIdentifierFromSubscriptionResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Removes a source identifier from an existing Amazon DocumentDB event notification
/// subscription.
///
/// Container for the necessary parameters to execute the RemoveSourceIdentifierFromSubscription service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the RemoveSourceIdentifierFromSubscription service method, as returned by DocDB.
///
/// The requested source could not be found.
///
///
/// The subscription name does not exist.
///
/// REST API Reference for RemoveSourceIdentifierFromSubscription Operation
public virtual Task RemoveSourceIdentifierFromSubscriptionAsync(RemoveSourceIdentifierFromSubscriptionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = RemoveSourceIdentifierFromSubscriptionRequestMarshaller.Instance;
options.ResponseUnmarshaller = RemoveSourceIdentifierFromSubscriptionResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region RemoveTagsFromResource
///
/// Removes metadata tags from an Amazon DocumentDB resource.
///
/// Container for the necessary parameters to execute the RemoveTagsFromResource service method.
///
/// The response from the RemoveTagsFromResource service method, as returned by DocDB.
///
/// DBClusterIdentifier
doesn't refer to an existing cluster.
///
///
/// DBInstanceIdentifier
doesn't refer to an existing instance.
///
///
/// DBSnapshotIdentifier
doesn't refer to an existing snapshot.
///
/// REST API Reference for RemoveTagsFromResource Operation
public virtual RemoveTagsFromResourceResponse RemoveTagsFromResource(RemoveTagsFromResourceRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = RemoveTagsFromResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = RemoveTagsFromResourceResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Removes metadata tags from an Amazon DocumentDB resource.
///
/// Container for the necessary parameters to execute the RemoveTagsFromResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the RemoveTagsFromResource service method, as returned by DocDB.
///
/// DBClusterIdentifier
doesn't refer to an existing cluster.
///
///
/// DBInstanceIdentifier
doesn't refer to an existing instance.
///
///
/// DBSnapshotIdentifier
doesn't refer to an existing snapshot.
///
/// REST API Reference for RemoveTagsFromResource Operation
public virtual Task RemoveTagsFromResourceAsync(RemoveTagsFromResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = RemoveTagsFromResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = RemoveTagsFromResourceResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region ResetDBClusterParameterGroup
///
/// Modifies the parameters of a cluster parameter group to the default value. To reset
/// specific parameters, submit a list of the following: ParameterName
and
/// ApplyMethod
. To reset the entire cluster parameter group, specify the
/// DBClusterParameterGroupName
and ResetAllParameters
parameters.
///
///
///
///
/// When you reset the entire group, dynamic parameters are updated immediately and static
/// parameters are set to pending-reboot
to take effect on the next DB instance
/// reboot.
///
///
/// Container for the necessary parameters to execute the ResetDBClusterParameterGroup service method.
///
/// The response from the ResetDBClusterParameterGroup service method, as returned by DocDB.
///
/// DBParameterGroupName
doesn't refer to an existing parameter group.
///
///
/// The parameter group is in use, or it is in a state that is not valid. If you are trying
/// to delete the parameter group, you can't delete it when the parameter group is in
/// this state.
///
/// REST API Reference for ResetDBClusterParameterGroup Operation
public virtual ResetDBClusterParameterGroupResponse ResetDBClusterParameterGroup(ResetDBClusterParameterGroupRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ResetDBClusterParameterGroupRequestMarshaller.Instance;
options.ResponseUnmarshaller = ResetDBClusterParameterGroupResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Modifies the parameters of a cluster parameter group to the default value. To reset
/// specific parameters, submit a list of the following: ParameterName
and
/// ApplyMethod
. To reset the entire cluster parameter group, specify the
/// DBClusterParameterGroupName
and ResetAllParameters
parameters.
///
///
///
///
/// When you reset the entire group, dynamic parameters are updated immediately and static
/// parameters are set to pending-reboot
to take effect on the next DB instance
/// reboot.
///
///
/// Container for the necessary parameters to execute the ResetDBClusterParameterGroup service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ResetDBClusterParameterGroup service method, as returned by DocDB.
///
/// DBParameterGroupName
doesn't refer to an existing parameter group.
///
///
/// The parameter group is in use, or it is in a state that is not valid. If you are trying
/// to delete the parameter group, you can't delete it when the parameter group is in
/// this state.
///
/// REST API Reference for ResetDBClusterParameterGroup Operation
public virtual Task ResetDBClusterParameterGroupAsync(ResetDBClusterParameterGroupRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = ResetDBClusterParameterGroupRequestMarshaller.Instance;
options.ResponseUnmarshaller = ResetDBClusterParameterGroupResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region RestoreDBClusterFromSnapshot
///
/// Creates a new cluster from a snapshot or cluster snapshot.
///
///
///
/// If a snapshot is specified, the target cluster is created from the source DB snapshot
/// with a default configuration and default security group.
///
///
///
/// If a cluster snapshot is specified, the target cluster is created from the source
/// cluster restore point with the same configuration as the original source DB cluster,
/// except that the new cluster is created with the default security group.
///
///
/// Container for the necessary parameters to execute the RestoreDBClusterFromSnapshot service method.
///
/// The response from the RestoreDBClusterFromSnapshot service method, as returned by DocDB.
///
/// You already have a cluster with the given identifier.
///
///
/// The cluster can't be created because you have reached the maximum allowed quota of
/// clusters.
///
///
/// DBClusterSnapshotIdentifier
doesn't refer to an existing cluster snapshot.
///
///
/// DBSnapshotIdentifier
doesn't refer to an existing snapshot.
///
///
/// DBSubnetGroupName
doesn't refer to an existing subnet group.
///
///
/// The cluster doesn't have enough capacity for the current operation.
///
///
/// There is not enough storage available for the current action. You might be able to
/// resolve this error by updating your subnet group to use different Availability Zones
/// that have more storage available.
///
///
/// The provided value isn't a valid cluster snapshot state.
///
///
/// The state of the snapshot doesn't allow deletion.
///
///
/// You cannot restore from a virtual private cloud (VPC) backup to a non-VPC DB instance.
///
///
/// The requested subnet is not valid, or multiple subnets were requested that are not
/// all in a common virtual private cloud (VPC).
///
///
/// The subnet group doesn't cover all Availability Zones after it is created because
/// of changes that were made.
///
///
/// An error occurred when accessing an KMS key.
///
///
/// The request would cause you to exceed the allowed amount of storage available across
/// all instances.
///
/// REST API Reference for RestoreDBClusterFromSnapshot Operation
public virtual RestoreDBClusterFromSnapshotResponse RestoreDBClusterFromSnapshot(RestoreDBClusterFromSnapshotRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = RestoreDBClusterFromSnapshotRequestMarshaller.Instance;
options.ResponseUnmarshaller = RestoreDBClusterFromSnapshotResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Creates a new cluster from a snapshot or cluster snapshot.
///
///
///
/// If a snapshot is specified, the target cluster is created from the source DB snapshot
/// with a default configuration and default security group.
///
///
///
/// If a cluster snapshot is specified, the target cluster is created from the source
/// cluster restore point with the same configuration as the original source DB cluster,
/// except that the new cluster is created with the default security group.
///
///
/// Container for the necessary parameters to execute the RestoreDBClusterFromSnapshot service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the RestoreDBClusterFromSnapshot service method, as returned by DocDB.
///
/// You already have a cluster with the given identifier.
///
///
/// The cluster can't be created because you have reached the maximum allowed quota of
/// clusters.
///
///
/// DBClusterSnapshotIdentifier
doesn't refer to an existing cluster snapshot.
///
///
/// DBSnapshotIdentifier
doesn't refer to an existing snapshot.
///
///
/// DBSubnetGroupName
doesn't refer to an existing subnet group.
///
///
/// The cluster doesn't have enough capacity for the current operation.
///
///
/// There is not enough storage available for the current action. You might be able to
/// resolve this error by updating your subnet group to use different Availability Zones
/// that have more storage available.
///
///
/// The provided value isn't a valid cluster snapshot state.
///
///
/// The state of the snapshot doesn't allow deletion.
///
///
/// You cannot restore from a virtual private cloud (VPC) backup to a non-VPC DB instance.
///
///
/// The requested subnet is not valid, or multiple subnets were requested that are not
/// all in a common virtual private cloud (VPC).
///
///
/// The subnet group doesn't cover all Availability Zones after it is created because
/// of changes that were made.
///
///
/// An error occurred when accessing an KMS key.
///
///
/// The request would cause you to exceed the allowed amount of storage available across
/// all instances.
///
/// REST API Reference for RestoreDBClusterFromSnapshot Operation
public virtual Task RestoreDBClusterFromSnapshotAsync(RestoreDBClusterFromSnapshotRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = RestoreDBClusterFromSnapshotRequestMarshaller.Instance;
options.ResponseUnmarshaller = RestoreDBClusterFromSnapshotResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region RestoreDBClusterToPointInTime
///
/// Restores a cluster to an arbitrary point in time. Users can restore to any point in
/// time before LatestRestorableTime
for up to BackupRetentionPeriod
/// days. The target cluster is created from the source cluster with the same configuration
/// as the original cluster, except that the new cluster is created with the default security
/// group.
///
/// Container for the necessary parameters to execute the RestoreDBClusterToPointInTime service method.
///
/// The response from the RestoreDBClusterToPointInTime service method, as returned by DocDB.
///
/// You already have a cluster with the given identifier.
///
///
/// DBClusterIdentifier
doesn't refer to an existing cluster.
///
///
/// The cluster can't be created because you have reached the maximum allowed quota of
/// clusters.
///
///
/// DBClusterSnapshotIdentifier
doesn't refer to an existing cluster snapshot.
///
///
/// DBSubnetGroupName
doesn't refer to an existing subnet group.
///
///
/// The cluster doesn't have enough capacity for the current operation.
///
///
/// There is not enough storage available for the current action. You might be able to
/// resolve this error by updating your subnet group to use different Availability Zones
/// that have more storage available.
///
///
/// The provided value isn't a valid cluster snapshot state.
///
///
/// The cluster isn't in a valid state.
///
///
/// The state of the snapshot doesn't allow deletion.
///
///
/// You cannot restore from a virtual private cloud (VPC) backup to a non-VPC DB instance.
///
///
/// The requested subnet is not valid, or multiple subnets were requested that are not
/// all in a common virtual private cloud (VPC).
///
///
/// The subnet group doesn't cover all Availability Zones after it is created because
/// of changes that were made.
///
///
/// An error occurred when accessing an KMS key.
///
///
/// The request would cause you to exceed the allowed amount of storage available across
/// all instances.
///
/// REST API Reference for RestoreDBClusterToPointInTime Operation
public virtual RestoreDBClusterToPointInTimeResponse RestoreDBClusterToPointInTime(RestoreDBClusterToPointInTimeRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = RestoreDBClusterToPointInTimeRequestMarshaller.Instance;
options.ResponseUnmarshaller = RestoreDBClusterToPointInTimeResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Restores a cluster to an arbitrary point in time. Users can restore to any point in
/// time before LatestRestorableTime
for up to BackupRetentionPeriod
/// days. The target cluster is created from the source cluster with the same configuration
/// as the original cluster, except that the new cluster is created with the default security
/// group.
///
/// Container for the necessary parameters to execute the RestoreDBClusterToPointInTime service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the RestoreDBClusterToPointInTime service method, as returned by DocDB.
///
/// You already have a cluster with the given identifier.
///
///
/// DBClusterIdentifier
doesn't refer to an existing cluster.
///
///
/// The cluster can't be created because you have reached the maximum allowed quota of
/// clusters.
///
///
/// DBClusterSnapshotIdentifier
doesn't refer to an existing cluster snapshot.
///
///
/// DBSubnetGroupName
doesn't refer to an existing subnet group.
///
///
/// The cluster doesn't have enough capacity for the current operation.
///
///
/// There is not enough storage available for the current action. You might be able to
/// resolve this error by updating your subnet group to use different Availability Zones
/// that have more storage available.
///
///
/// The provided value isn't a valid cluster snapshot state.
///
///
/// The cluster isn't in a valid state.
///
///
/// The state of the snapshot doesn't allow deletion.
///
///
/// You cannot restore from a virtual private cloud (VPC) backup to a non-VPC DB instance.
///
///
/// The requested subnet is not valid, or multiple subnets were requested that are not
/// all in a common virtual private cloud (VPC).
///
///
/// The subnet group doesn't cover all Availability Zones after it is created because
/// of changes that were made.
///
///
/// An error occurred when accessing an KMS key.
///
///
/// The request would cause you to exceed the allowed amount of storage available across
/// all instances.
///
/// REST API Reference for RestoreDBClusterToPointInTime Operation
public virtual Task RestoreDBClusterToPointInTimeAsync(RestoreDBClusterToPointInTimeRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = RestoreDBClusterToPointInTimeRequestMarshaller.Instance;
options.ResponseUnmarshaller = RestoreDBClusterToPointInTimeResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region StartDBCluster
///
/// Restarts the stopped cluster that is specified by DBClusterIdentifier
.
/// For more information, see Stopping
/// and Starting an Amazon DocumentDB Cluster.
///
/// Container for the necessary parameters to execute the StartDBCluster service method.
///
/// The response from the StartDBCluster service method, as returned by DocDB.
///
/// DBClusterIdentifier
doesn't refer to an existing cluster.
///
///
/// The cluster isn't in a valid state.
///
///
/// The specified instance isn't in the available state.
///
/// REST API Reference for StartDBCluster Operation
public virtual StartDBClusterResponse StartDBCluster(StartDBClusterRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = StartDBClusterRequestMarshaller.Instance;
options.ResponseUnmarshaller = StartDBClusterResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Restarts the stopped cluster that is specified by DBClusterIdentifier
.
/// For more information, see Stopping
/// and Starting an Amazon DocumentDB Cluster.
///
/// Container for the necessary parameters to execute the StartDBCluster service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the StartDBCluster service method, as returned by DocDB.
///
/// DBClusterIdentifier
doesn't refer to an existing cluster.
///
///
/// The cluster isn't in a valid state.
///
///
/// The specified instance isn't in the available state.
///
/// REST API Reference for StartDBCluster Operation
public virtual Task StartDBClusterAsync(StartDBClusterRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = StartDBClusterRequestMarshaller.Instance;
options.ResponseUnmarshaller = StartDBClusterResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
#region StopDBCluster
///
/// Stops the running cluster that is specified by DBClusterIdentifier
. The
/// cluster must be in the available state. For more information, see Stopping
/// and Starting an Amazon DocumentDB Cluster.
///
/// Container for the necessary parameters to execute the StopDBCluster service method.
///
/// The response from the StopDBCluster service method, as returned by DocDB.
///
/// DBClusterIdentifier
doesn't refer to an existing cluster.
///
///
/// The cluster isn't in a valid state.
///
///
/// The specified instance isn't in the available state.
///
/// REST API Reference for StopDBCluster Operation
public virtual StopDBClusterResponse StopDBCluster(StopDBClusterRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = StopDBClusterRequestMarshaller.Instance;
options.ResponseUnmarshaller = StopDBClusterResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Stops the running cluster that is specified by DBClusterIdentifier
. The
/// cluster must be in the available state. For more information, see Stopping
/// and Starting an Amazon DocumentDB Cluster.
///
/// Container for the necessary parameters to execute the StopDBCluster service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the StopDBCluster service method, as returned by DocDB.
///
/// DBClusterIdentifier
doesn't refer to an existing cluster.
///
///
/// The cluster isn't in a valid state.
///
///
/// The specified instance isn't in the available state.
///
/// REST API Reference for StopDBCluster Operation
public virtual Task StopDBClusterAsync(StopDBClusterRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var options = new InvokeOptions();
options.RequestMarshaller = StopDBClusterRequestMarshaller.Instance;
options.ResponseUnmarshaller = StopDBClusterResponseUnmarshaller.Instance;
return InvokeAsync(request, options, cancellationToken);
}
#endregion
}
}