/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include Amazon DocumentDB API documentation 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 AWS
* Identity and Access Management (IAM) policy for Amazon DocumentDB.See
* Also:
AWS
* API Reference
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 AWS
* Identity and Access Management (IAM) policy for Amazon DocumentDB.
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 AWS
* Identity and Access Management (IAM) policy for Amazon DocumentDB.
Applies a pending maintenance action to a resource (for example, to a DB * instance).
Applies a pending maintenance action to a resource (for example, to a DB * instance).
Applies a pending maintenance action to a resource (for example, to a DB * instance).
Copies the specified cluster parameter group.
Copies the specified cluster parameter group.
Copies the specified cluster parameter group.
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.
To
* cancel the copy operation after it is in progress, delete the target cluster
* snapshot identified by TargetDBClusterSnapshotIdentifier while that
* DB cluster snapshot is in the copying status.
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.
To
* cancel the copy operation after it is in progress, delete the target cluster
* snapshot identified by TargetDBClusterSnapshotIdentifier while that
* DB cluster snapshot is in the copying status.
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.
To
* cancel the copy operation after it is in progress, delete the target cluster
* snapshot identified by TargetDBClusterSnapshotIdentifier while that
* DB cluster snapshot is in the copying status.
Creates a new Amazon DocumentDB cluster.
Creates a new Amazon DocumentDB cluster.
Creates a new Amazon DocumentDB cluster.
Creates a new cluster parameter group.
Parameters in a cluster * parameter group apply to all of the instances in a DB cluster.
A cluster * parameter group is initially created with the default parameters for the * database engine used by instances in the cluster. To provide custom values for * any of the parameters, you must modify the group after you create it. After you * create a DB cluster parameter group, you must associate it with your cluster. * For the new DB cluster parameter group and associated settings to take effect, * you must then reboot the instances in the cluster without failover.
*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 cluster 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.
Creates a new cluster parameter group.
Parameters in a cluster * parameter group apply to all of the instances in a DB cluster.
A cluster * parameter group is initially created with the default parameters for the * database engine used by instances in the cluster. To provide custom values for * any of the parameters, you must modify the group after you create it. After you * create a DB cluster parameter group, you must associate it with your cluster. * For the new DB cluster parameter group and associated settings to take effect, * you must then reboot the instances in the cluster without failover.
*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 cluster 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.
Creates a new cluster parameter group.
Parameters in a cluster * parameter group apply to all of the instances in a DB cluster.
A cluster * parameter group is initially created with the default parameters for the * database engine used by instances in the cluster. To provide custom values for * any of the parameters, you must modify the group after you create it. After you * create a DB cluster parameter group, you must associate it with your cluster. * For the new DB cluster parameter group and associated settings to take effect, * you must then reboot the instances in the cluster without failover.
*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 cluster 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.
Creates a snapshot of a cluster.
Creates a snapshot of a cluster.
Creates a snapshot of a cluster.
Creates a new instance.
Creates a new instance.
Creates a new instance.
Creates a new subnet group. subnet groups must contain at least one subnet in * at least two Availability Zones in the AWS Region.
Creates a new subnet group. subnet groups must contain at least one subnet in * at least two Availability Zones in the AWS Region.
Creates a new subnet group. subnet groups must contain at least one subnet in * at least two Availability Zones in the AWS Region.
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.
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.
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.
Deletes a specified cluster parameter group. The cluster parameter group to * be deleted can't be associated with any clusters.
Deletes a specified cluster parameter group. The cluster parameter group to * be deleted can't be associated with any clusters.
Deletes a specified cluster parameter group. The cluster parameter group to * be deleted can't be associated with any clusters.
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.
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.
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.
Deletes a previously provisioned instance.
Deletes a previously provisioned instance.
Deletes a previously provisioned instance.
Deletes a subnet group.
The specified database subnet group * must not be associated with any DB instances.
Deletes a subnet group.
The specified database subnet group * must not be associated with any DB instances.
Deletes a subnet group.
The specified database subnet group * must not be associated with any DB instances.
Returns a list of certificate authority (CA) certificates provided by Amazon * DocumentDB for this AWS account.
Returns a list of certificate authority (CA) certificates provided by Amazon * DocumentDB for this AWS account.
Returns a list of certificate authority (CA) certificates provided by Amazon * DocumentDB for this AWS account.
Returns a list of DBClusterParameterGroup descriptions. If a
* DBClusterParameterGroupName parameter is specified, the list
* contains only the description of the specified cluster parameter group.
*
Returns a list of DBClusterParameterGroup descriptions. If a
* DBClusterParameterGroupName parameter is specified, the list
* contains only the description of the specified cluster parameter group.
*
Returns a list of DBClusterParameterGroup descriptions. If a
* DBClusterParameterGroupName parameter is specified, the list
* contains only the description of the specified cluster parameter group.
*
Returns the detailed parameter list for a particular cluster parameter * group.
Returns the detailed parameter list for a particular cluster parameter * group.
Returns the detailed parameter list for a particular cluster parameter * group.
Returns a list of cluster snapshot attribute names and values for a manual DB * cluster snapshot.
When you share snapshots with other AWS accounts,
* DescribeDBClusterSnapshotAttributes returns the
* restore attribute and a list of IDs for the AWS 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 AWS
* accounts.
Returns a list of cluster snapshot attribute names and values for a manual DB * cluster snapshot.
When you share snapshots with other AWS accounts,
* DescribeDBClusterSnapshotAttributes returns the
* restore attribute and a list of IDs for the AWS 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 AWS
* accounts.
Returns a list of cluster snapshot attribute names and values for a manual DB * cluster snapshot.
When you share snapshots with other AWS accounts,
* DescribeDBClusterSnapshotAttributes returns the
* restore attribute and a list of IDs for the AWS 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 AWS
* accounts.
Returns information about cluster snapshots. This API operation supports * pagination.
Returns information about cluster snapshots. This API operation supports * pagination.
Returns information about cluster snapshots. This API operation supports * pagination.
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.
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.
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.
Returns a list of the available engines.
Returns a list of the available engines.
Returns a list of the available engines.
Returns information about provisioned Amazon DocumentDB instances. This API * supports pagination.
Returns information about provisioned Amazon DocumentDB instances. This API * supports pagination.
Returns information about provisioned Amazon DocumentDB instances. This API * supports pagination.
Returns a list of DBSubnetGroup descriptions. If a
* DBSubnetGroupName is specified, the list will contain only the
* descriptions of the specified DBSubnetGroup.
Returns a list of DBSubnetGroup descriptions. If a
* DBSubnetGroupName is specified, the list will contain only the
* descriptions of the specified DBSubnetGroup.
Returns a list of DBSubnetGroup descriptions. If a
* DBSubnetGroupName is specified, the list will contain only the
* descriptions of the specified DBSubnetGroup.
Returns the default engine and system parameter information for the cluster * database engine.
Returns the default engine and system parameter information for the cluster * database engine.
Returns the default engine and system parameter information for the cluster * database engine.
Displays a list of categories for all event source types, or, if specified, * for a specified source type.
Displays a list of categories for all event source types, or, if specified, * for a specified source type.
Displays a list of categories for all event source types, or, if specified, * for a specified source type.
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.
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.
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.
Returns a list of orderable instance options for the specified * engine.
Returns a list of orderable instance options for the specified * engine.
Returns a list of orderable instance options for the specified * engine.
Returns a list of resources (for example, instances) that have at least one * pending maintenance action.
Returns a list of resources (for example, instances) that have at least one * pending maintenance action.
Returns a list of resources (for example, instances) that have at least one * pending maintenance action.
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.
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.
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.
Lists all tags on an Amazon DocumentDB resource.
Lists all tags on an Amazon DocumentDB resource.
Lists all tags on an Amazon DocumentDB resource.
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.
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.
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.
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.
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.
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.
Adds an attribute and values to, or removes an attribute and values from, a * manual DB cluster snapshot.
To share a manual cluster snapshot with other
* AWS accounts, specify restore as the AttributeName,
* and use the ValuesToAdd parameter to add a list of IDs of the AWS
* 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 AWS accounts. Do not add the
* all value for any manual DB cluster snapshots that contain private
* information that you don't want available to all AWS accounts. If a manual
* cluster snapshot is encrypted, it can be shared, but only by specifying a list
* of authorized AWS account IDs for the ValuesToAdd parameter. You
* can't use all as a value for that parameter in this
* case.
Adds an attribute and values to, or removes an attribute and values from, a * manual DB cluster snapshot.
To share a manual cluster snapshot with other
* AWS accounts, specify restore as the AttributeName,
* and use the ValuesToAdd parameter to add a list of IDs of the AWS
* 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 AWS accounts. Do not add the
* all value for any manual DB cluster snapshots that contain private
* information that you don't want available to all AWS accounts. If a manual
* cluster snapshot is encrypted, it can be shared, but only by specifying a list
* of authorized AWS account IDs for the ValuesToAdd parameter. You
* can't use all as a value for that parameter in this
* case.
Adds an attribute and values to, or removes an attribute and values from, a * manual DB cluster snapshot.
To share a manual cluster snapshot with other
* AWS accounts, specify restore as the AttributeName,
* and use the ValuesToAdd parameter to add a list of IDs of the AWS
* 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 AWS accounts. Do not add the
* all value for any manual DB cluster snapshots that contain private
* information that you don't want available to all AWS accounts. If a manual
* cluster snapshot is encrypted, it can be shared, but only by specifying a list
* of authorized AWS account IDs for the ValuesToAdd parameter. You
* can't use all as a value for that parameter in this
* case.
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.
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.
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.
Modifies an existing subnet group. subnet groups must contain at least one * subnet in at least two Availability Zones in the AWS Region.
Modifies an existing subnet group. subnet groups must contain at least one * subnet in at least two Availability Zones in the AWS Region.
Modifies an existing subnet group. subnet groups must contain at least one * subnet in at least two Availability Zones in the AWS Region.
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.
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.
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.
Removes metadata tags from an Amazon DocumentDB resource.
Removes metadata tags from an Amazon DocumentDB resource.
Removes metadata tags from an Amazon DocumentDB resource.
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.
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.
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.
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.
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.
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.
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.
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.
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.
Restarts the stopped cluster that is specified by
* DBClusterIdentifier. For more information, see Stopping
* and Starting an Amazon DocumentDB Cluster.
Restarts the stopped cluster that is specified by
* DBClusterIdentifier. For more information, see Stopping
* and Starting an Amazon DocumentDB Cluster.
Restarts the stopped cluster that is specified by
* DBClusterIdentifier. For more information, see Stopping
* and Starting an Amazon DocumentDB Cluster.
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.
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.
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.