NAME

Paws::DocDB - Perl Interface to AWS Amazon DocumentDB with MongoDB compatibility

SYNOPSIS

use Paws;

my $obj = Paws->service('DocDB');
my $res = $obj->Method(
  Arg1 => $val1,
  Arg2 => [ 'V1', 'V2' ],
  # if Arg3 is an object, the HashRef will be used as arguments to the constructor
  # of the arguments type
  Arg3 => { Att1 => 'Val1' },
  # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
  # the constructor of the arguments type
  Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
);

DESCRIPTION

Amazon DocumentDB API documentation

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31

METHODS

AddSourceIdentifierToSubscription

SourceIdentifier => Str
SubscriptionName => Str

Each argument is described in detail in: Paws::DocDB::AddSourceIdentifierToSubscription

Returns: a Paws::DocDB::AddSourceIdentifierToSubscriptionResult instance

Adds a source identifier to an existing event notification subscription.

AddTagsToResource

ResourceName => Str
Tags => ArrayRef[Paws::DocDB::Tag]

Each argument is described in detail in: Paws::DocDB::AddTagsToResource

Returns: nothing

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.

ApplyPendingMaintenanceAction

ApplyAction => Str
OptInType => Str
ResourceIdentifier => Str

Each argument is described in detail in: Paws::DocDB::ApplyPendingMaintenanceAction

Returns: a Paws::DocDB::ApplyPendingMaintenanceActionResult instance

Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).

CopyDBClusterParameterGroup

SourceDBClusterParameterGroupIdentifier => Str
TargetDBClusterParameterGroupDescription => Str
TargetDBClusterParameterGroupIdentifier => Str
[Tags => ArrayRef[Paws::DocDB::Tag]]

Each argument is described in detail in: Paws::DocDB::CopyDBClusterParameterGroup

Returns: a Paws::DocDB::CopyDBClusterParameterGroupResult instance

Copies the specified cluster parameter group.

CopyDBClusterSnapshot

SourceDBClusterSnapshotIdentifier => Str
TargetDBClusterSnapshotIdentifier => Str
[CopyTags => Bool]
[KmsKeyId => Str]
[PreSignedUrl => Str]
[Tags => ArrayRef[Paws::DocDB::Tag]]

Each argument is described in detail in: Paws::DocDB::CopyDBClusterSnapshot

Returns: a Paws::DocDB::CopyDBClusterSnapshotResult instance

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 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.

CreateDBCluster

DBClusterIdentifier => Str
Engine => Str
[AvailabilityZones => ArrayRef[Str|Undef]]
[BackupRetentionPeriod => Int]
[DBClusterParameterGroupName => Str]
[DBSubnetGroupName => Str]
[DeletionProtection => Bool]
[EnableCloudwatchLogsExports => ArrayRef[Str|Undef]]
[EngineVersion => Str]
[GlobalClusterIdentifier => Str]
[KmsKeyId => Str]
[MasterUsername => Str]
[MasterUserPassword => Str]
[Port => Int]
[PreferredBackupWindow => Str]
[PreferredMaintenanceWindow => Str]
[PreSignedUrl => Str]
[StorageEncrypted => Bool]
[Tags => ArrayRef[Paws::DocDB::Tag]]
[VpcSecurityGroupIds => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::DocDB::CreateDBCluster

Returns: a Paws::DocDB::CreateDBClusterResult instance

Creates a new Amazon DocumentDB cluster.

CreateDBClusterParameterGroup

DBClusterParameterGroupName => Str
DBParameterGroupFamily => Str
Description => Str
[Tags => ArrayRef[Paws::DocDB::Tag]]

Each argument is described in detail in: Paws::DocDB::CreateDBClusterParameterGroup

Returns: a Paws::DocDB::CreateDBClusterParameterGroupResult instance

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 (https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-create.html) or copy an existing parameter group (https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-copy.html), 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 (https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-modify.html).

CreateDBClusterSnapshot

DBClusterIdentifier => Str
DBClusterSnapshotIdentifier => Str
[Tags => ArrayRef[Paws::DocDB::Tag]]

Each argument is described in detail in: Paws::DocDB::CreateDBClusterSnapshot

Returns: a Paws::DocDB::CreateDBClusterSnapshotResult instance

Creates a snapshot of a cluster.

CreateDBInstance

DBClusterIdentifier => Str
DBInstanceClass => Str
DBInstanceIdentifier => Str
Engine => Str
[AutoMinorVersionUpgrade => Bool]
[AvailabilityZone => Str]
[PreferredMaintenanceWindow => Str]
[PromotionTier => Int]
[Tags => ArrayRef[Paws::DocDB::Tag]]

Each argument is described in detail in: Paws::DocDB::CreateDBInstance

Returns: a Paws::DocDB::CreateDBInstanceResult instance

Creates a new instance.

CreateDBSubnetGroup

DBSubnetGroupDescription => Str
DBSubnetGroupName => Str
SubnetIds => ArrayRef[Str|Undef]
[Tags => ArrayRef[Paws::DocDB::Tag]]

Each argument is described in detail in: Paws::DocDB::CreateDBSubnetGroup

Returns: a Paws::DocDB::CreateDBSubnetGroupResult instance

Creates a new subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Region.

CreateEventSubscription

SnsTopicArn => Str
SubscriptionName => Str
[Enabled => Bool]
[EventCategories => ArrayRef[Str|Undef]]
[SourceIds => ArrayRef[Str|Undef]]
[SourceType => Str]
[Tags => ArrayRef[Paws::DocDB::Tag]]

Each argument is described in detail in: Paws::DocDB::CreateEventSubscription

Returns: a Paws::DocDB::CreateEventSubscriptionResult instance

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.

CreateGlobalCluster

GlobalClusterIdentifier => Str
[DatabaseName => Str]
[DeletionProtection => Bool]
[Engine => Str]
[EngineVersion => Str]
[SourceDBClusterIdentifier => Str]
[StorageEncrypted => Bool]

Each argument is described in detail in: Paws::DocDB::CreateGlobalCluster

Returns: a Paws::DocDB::CreateGlobalClusterResult instance

Creates an Amazon DocumentDB global cluster that can span multiple multiple 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.

DeleteDBCluster

DBClusterIdentifier => Str
[FinalDBSnapshotIdentifier => Str]
[SkipFinalSnapshot => Bool]

Each argument is described in detail in: Paws::DocDB::DeleteDBCluster

Returns: a Paws::DocDB::DeleteDBClusterResult instance

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.

DeleteDBClusterParameterGroup

DBClusterParameterGroupName => Str

Each argument is described in detail in: Paws::DocDB::DeleteDBClusterParameterGroup

Returns: nothing

Deletes a specified cluster parameter group. The cluster parameter group to be deleted can't be associated with any clusters.

DeleteDBClusterSnapshot

DBClusterSnapshotIdentifier => Str

Each argument is described in detail in: Paws::DocDB::DeleteDBClusterSnapshot

Returns: a Paws::DocDB::DeleteDBClusterSnapshotResult instance

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.

DeleteDBInstance

DBInstanceIdentifier => Str

Each argument is described in detail in: Paws::DocDB::DeleteDBInstance

Returns: a Paws::DocDB::DeleteDBInstanceResult instance

Deletes a previously provisioned instance.

DeleteDBSubnetGroup

DBSubnetGroupName => Str

Each argument is described in detail in: Paws::DocDB::DeleteDBSubnetGroup

Returns: nothing

Deletes a subnet group.

The specified database subnet group must not be associated with any DB instances.

DeleteEventSubscription

SubscriptionName => Str

Each argument is described in detail in: Paws::DocDB::DeleteEventSubscription

Returns: a Paws::DocDB::DeleteEventSubscriptionResult instance

Deletes an Amazon DocumentDB event notification subscription.

DeleteGlobalCluster

GlobalClusterIdentifier => Str

Each argument is described in detail in: Paws::DocDB::DeleteGlobalCluster

Returns: a Paws::DocDB::DeleteGlobalClusterResult instance

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.

DescribeCertificates

[CertificateIdentifier => Str]
[Filters => ArrayRef[Paws::DocDB::Filter]]
[Marker => Str]
[MaxRecords => Int]

Each argument is described in detail in: Paws::DocDB::DescribeCertificates

Returns: a Paws::DocDB::CertificateMessage instance

Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this account.

DescribeDBClusterParameterGroups

[DBClusterParameterGroupName => Str]
[Filters => ArrayRef[Paws::DocDB::Filter]]
[Marker => Str]
[MaxRecords => Int]

Each argument is described in detail in: Paws::DocDB::DescribeDBClusterParameterGroups

Returns: a Paws::DocDB::DBClusterParameterGroupsMessage instance

Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list contains only the description of the specified cluster parameter group.

DescribeDBClusterParameters

DBClusterParameterGroupName => Str
[Filters => ArrayRef[Paws::DocDB::Filter]]
[Marker => Str]
[MaxRecords => Int]
[Source => Str]

Each argument is described in detail in: Paws::DocDB::DescribeDBClusterParameters

Returns: a Paws::DocDB::DBClusterParameterGroupDetails instance

Returns the detailed parameter list for a particular cluster parameter group.

DescribeDBClusters

[DBClusterIdentifier => Str]
[Filters => ArrayRef[Paws::DocDB::Filter]]
[Marker => Str]
[MaxRecords => Int]

Each argument is described in detail in: Paws::DocDB::DescribeDBClusters

Returns: a Paws::DocDB::DBClusterMessage instance

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.

DescribeDBClusterSnapshotAttributes

DBClusterSnapshotIdentifier => Str

Each argument is described in detail in: Paws::DocDB::DescribeDBClusterSnapshotAttributes

Returns: a Paws::DocDB::DescribeDBClusterSnapshotAttributesResult instance

Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot.

When you share snapshots with other accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the 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 accounts.

DescribeDBClusterSnapshots

[DBClusterIdentifier => Str]
[DBClusterSnapshotIdentifier => Str]
[Filters => ArrayRef[Paws::DocDB::Filter]]
[IncludePublic => Bool]
[IncludeShared => Bool]
[Marker => Str]
[MaxRecords => Int]
[SnapshotType => Str]

Each argument is described in detail in: Paws::DocDB::DescribeDBClusterSnapshots

Returns: a Paws::DocDB::DBClusterSnapshotMessage instance

Returns information about cluster snapshots. This API operation supports pagination.

DescribeDBEngineVersions

[DBParameterGroupFamily => Str]
[DefaultOnly => Bool]
[Engine => Str]
[EngineVersion => Str]
[Filters => ArrayRef[Paws::DocDB::Filter]]
[ListSupportedCharacterSets => Bool]
[ListSupportedTimezones => Bool]
[Marker => Str]
[MaxRecords => Int]

Each argument is described in detail in: Paws::DocDB::DescribeDBEngineVersions

Returns: a Paws::DocDB::DBEngineVersionMessage instance

Returns a list of the available engines.

DescribeDBInstances

[DBInstanceIdentifier => Str]
[Filters => ArrayRef[Paws::DocDB::Filter]]
[Marker => Str]
[MaxRecords => Int]

Each argument is described in detail in: Paws::DocDB::DescribeDBInstances

Returns: a Paws::DocDB::DBInstanceMessage instance

Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.

DescribeDBSubnetGroups

[DBSubnetGroupName => Str]
[Filters => ArrayRef[Paws::DocDB::Filter]]
[Marker => Str]
[MaxRecords => Int]

Each argument is described in detail in: Paws::DocDB::DescribeDBSubnetGroups

Returns: a Paws::DocDB::DBSubnetGroupMessage instance

Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

DescribeEngineDefaultClusterParameters

DBParameterGroupFamily => Str
[Filters => ArrayRef[Paws::DocDB::Filter]]
[Marker => Str]
[MaxRecords => Int]

Each argument is described in detail in: Paws::DocDB::DescribeEngineDefaultClusterParameters

Returns: a Paws::DocDB::DescribeEngineDefaultClusterParametersResult instance

Returns the default engine and system parameter information for the cluster database engine.

DescribeEventCategories

[Filters => ArrayRef[Paws::DocDB::Filter]]
[SourceType => Str]

Each argument is described in detail in: Paws::DocDB::DescribeEventCategories

Returns: a Paws::DocDB::EventCategoriesMessage instance

Displays a list of categories for all event source types, or, if specified, for a specified source type.

DescribeEvents

[Duration => Int]
[EndTime => Str]
[EventCategories => ArrayRef[Str|Undef]]
[Filters => ArrayRef[Paws::DocDB::Filter]]
[Marker => Str]
[MaxRecords => Int]
[SourceIdentifier => Str]
[SourceType => Str]
[StartTime => Str]

Each argument is described in detail in: Paws::DocDB::DescribeEvents

Returns: a Paws::DocDB::EventsMessage instance

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.

DescribeEventSubscriptions

[Filters => ArrayRef[Paws::DocDB::Filter]]
[Marker => Str]
[MaxRecords => Int]
[SubscriptionName => Str]

Each argument is described in detail in: Paws::DocDB::DescribeEventSubscriptions

Returns: a Paws::DocDB::EventSubscriptionsMessage instance

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.

DescribeGlobalClusters

[Filters => ArrayRef[Paws::DocDB::Filter]]
[GlobalClusterIdentifier => Str]
[Marker => Str]
[MaxRecords => Int]

Each argument is described in detail in: Paws::DocDB::DescribeGlobalClusters

Returns: a Paws::DocDB::GlobalClustersMessage instance

Returns information about Amazon DocumentDB global clusters. This API supports pagination.

This action only applies to Amazon DocumentDB clusters.

DescribeOrderableDBInstanceOptions

Engine => Str
[DBInstanceClass => Str]
[EngineVersion => Str]
[Filters => ArrayRef[Paws::DocDB::Filter]]
[LicenseModel => Str]
[Marker => Str]
[MaxRecords => Int]
[Vpc => Bool]

Each argument is described in detail in: Paws::DocDB::DescribeOrderableDBInstanceOptions

Returns: a Paws::DocDB::OrderableDBInstanceOptionsMessage instance

Returns a list of orderable instance options for the specified engine.

DescribePendingMaintenanceActions

[Filters => ArrayRef[Paws::DocDB::Filter]]
[Marker => Str]
[MaxRecords => Int]
[ResourceIdentifier => Str]

Each argument is described in detail in: Paws::DocDB::DescribePendingMaintenanceActions

Returns: a Paws::DocDB::PendingMaintenanceActionsMessage instance

Returns a list of resources (for example, instances) that have at least one pending maintenance action.

FailoverDBCluster

[DBClusterIdentifier => Str]
[TargetDBInstanceIdentifier => Str]

Each argument is described in detail in: Paws::DocDB::FailoverDBCluster

Returns: a Paws::DocDB::FailoverDBClusterResult instance

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.

ListTagsForResource

ResourceName => Str
[Filters => ArrayRef[Paws::DocDB::Filter]]

Each argument is described in detail in: Paws::DocDB::ListTagsForResource

Returns: a Paws::DocDB::TagListMessage instance

Lists all tags on an Amazon DocumentDB resource.

ModifyDBCluster

DBClusterIdentifier => Str
[ApplyImmediately => Bool]
[BackupRetentionPeriod => Int]
[CloudwatchLogsExportConfiguration => Paws::DocDB::CloudwatchLogsExportConfiguration]
[DBClusterParameterGroupName => Str]
[DeletionProtection => Bool]
[EngineVersion => Str]
[MasterUserPassword => Str]
[NewDBClusterIdentifier => Str]
[Port => Int]
[PreferredBackupWindow => Str]
[PreferredMaintenanceWindow => Str]
[VpcSecurityGroupIds => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::DocDB::ModifyDBCluster

Returns: a Paws::DocDB::ModifyDBClusterResult instance

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.

ModifyDBClusterParameterGroup

DBClusterParameterGroupName => Str
Parameters => ArrayRef[Paws::DocDB::Parameter]

Each argument is described in detail in: Paws::DocDB::ModifyDBClusterParameterGroup

Returns: a Paws::DocDB::DBClusterParameterGroupNameMessage instance

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.

ModifyDBClusterSnapshotAttribute

AttributeName => Str
DBClusterSnapshotIdentifier => Str
[ValuesToAdd => ArrayRef[Str|Undef]]
[ValuesToRemove => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::DocDB::ModifyDBClusterSnapshotAttribute

Returns: a Paws::DocDB::ModifyDBClusterSnapshotAttributeResult instance

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 accounts, specify restore as the AttributeName, and use the ValuesToAdd parameter to add a list of IDs of the 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 accounts. Do not add the all value for any manual cluster snapshots that contain private information that you don't want available to all accounts. If a manual cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.

ModifyDBInstance

DBInstanceIdentifier => Str
[ApplyImmediately => Bool]
[AutoMinorVersionUpgrade => Bool]
[CACertificateIdentifier => Str]
[DBInstanceClass => Str]
[NewDBInstanceIdentifier => Str]
[PreferredMaintenanceWindow => Str]
[PromotionTier => Int]

Each argument is described in detail in: Paws::DocDB::ModifyDBInstance

Returns: a Paws::DocDB::ModifyDBInstanceResult instance

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.

ModifyDBSubnetGroup

DBSubnetGroupName => Str
SubnetIds => ArrayRef[Str|Undef]
[DBSubnetGroupDescription => Str]

Each argument is described in detail in: Paws::DocDB::ModifyDBSubnetGroup

Returns: a Paws::DocDB::ModifyDBSubnetGroupResult instance

Modifies an existing subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Region.

ModifyEventSubscription

SubscriptionName => Str
[Enabled => Bool]
[EventCategories => ArrayRef[Str|Undef]]
[SnsTopicArn => Str]
[SourceType => Str]

Each argument is described in detail in: Paws::DocDB::ModifyEventSubscription

Returns: a Paws::DocDB::ModifyEventSubscriptionResult instance

Modifies an existing Amazon DocumentDB event notification subscription.

ModifyGlobalCluster

GlobalClusterIdentifier => Str
[DeletionProtection => Bool]
[NewGlobalClusterIdentifier => Str]

Each argument is described in detail in: Paws::DocDB::ModifyGlobalCluster

Returns: a Paws::DocDB::ModifyGlobalClusterResult instance

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.

RebootDBInstance

DBInstanceIdentifier => Str
[ForceFailover => Bool]

Each argument is described in detail in: Paws::DocDB::RebootDBInstance

Returns: a Paws::DocDB::RebootDBInstanceResult instance

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.

RemoveFromGlobalCluster

DbClusterIdentifier => Str
GlobalClusterIdentifier => Str

Each argument is described in detail in: Paws::DocDB::RemoveFromGlobalCluster

Returns: a Paws::DocDB::RemoveFromGlobalClusterResult instance

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.

RemoveSourceIdentifierFromSubscription

SourceIdentifier => Str
SubscriptionName => Str

Each argument is described in detail in: Paws::DocDB::RemoveSourceIdentifierFromSubscription

Returns: a Paws::DocDB::RemoveSourceIdentifierFromSubscriptionResult instance

Removes a source identifier from an existing Amazon DocumentDB event notification subscription.

RemoveTagsFromResource

ResourceName => Str
TagKeys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::DocDB::RemoveTagsFromResource

Returns: nothing

Removes metadata tags from an Amazon DocumentDB resource.

ResetDBClusterParameterGroup

DBClusterParameterGroupName => Str
[Parameters => ArrayRef[Paws::DocDB::Parameter]]
[ResetAllParameters => Bool]

Each argument is described in detail in: Paws::DocDB::ResetDBClusterParameterGroup

Returns: a Paws::DocDB::DBClusterParameterGroupNameMessage instance

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.

RestoreDBClusterFromSnapshot

DBClusterIdentifier => Str
Engine => Str
SnapshotIdentifier => Str
[AvailabilityZones => ArrayRef[Str|Undef]]
[DBSubnetGroupName => Str]
[DeletionProtection => Bool]
[EnableCloudwatchLogsExports => ArrayRef[Str|Undef]]
[EngineVersion => Str]
[KmsKeyId => Str]
[Port => Int]
[Tags => ArrayRef[Paws::DocDB::Tag]]
[VpcSecurityGroupIds => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::DocDB::RestoreDBClusterFromSnapshot

Returns: a Paws::DocDB::RestoreDBClusterFromSnapshotResult instance

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.

RestoreDBClusterToPointInTime

DBClusterIdentifier => Str
SourceDBClusterIdentifier => Str
[DBSubnetGroupName => Str]
[DeletionProtection => Bool]
[EnableCloudwatchLogsExports => ArrayRef[Str|Undef]]
[KmsKeyId => Str]
[Port => Int]
[RestoreToTime => Str]
[Tags => ArrayRef[Paws::DocDB::Tag]]
[UseLatestRestorableTime => Bool]
[VpcSecurityGroupIds => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::DocDB::RestoreDBClusterToPointInTime

Returns: a Paws::DocDB::RestoreDBClusterToPointInTimeResult instance

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.

StartDBCluster

DBClusterIdentifier => Str

Each argument is described in detail in: Paws::DocDB::StartDBCluster

Returns: a Paws::DocDB::StartDBClusterResult instance

Restarts the stopped cluster that is specified by DBClusterIdentifier. For more information, see Stopping and Starting an Amazon DocumentDB Cluster (https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-stop-start.html).

StopDBCluster

DBClusterIdentifier => Str

Each argument is described in detail in: Paws::DocDB::StopDBCluster

Returns: a Paws::DocDB::StopDBClusterResult instance

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 (https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-stop-start.html).

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results