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

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 AWS 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 a DB 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 DB 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 DB cluster.

To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.

To cancel the copy operation after it is in progress, delete the target DB cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in the copying status.

CreateDBCluster

DBClusterIdentifier => Str
Engine => Str
MasterUsername => Str
MasterUserPassword => Str
[AvailabilityZones => ArrayRef[Str|Undef]]
[BackupRetentionPeriod => Int]
[DBClusterParameterGroupName => Str]
[DBSubnetGroupName => Str]
[DeletionProtection => Bool]
[EnableCloudwatchLogsExports => ArrayRef[Str|Undef]]
[EngineVersion => Str]
[KmsKeyId => Str]
[Port => Int]
[PreferredBackupWindow => Str]
[PreferredMaintenanceWindow => 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 DB 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 DB cluster parameter group.

Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.

A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after you create it. After you create a DB cluster parameter group, you must associate it with your DB cluster. For the new DB cluster parameter group and associated settings to take effect, you must then reboot the DB instances in the DB cluster without failover.

After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This step is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter.

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 DB 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 DB 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 DB subnet group. DB subnet groups must contain at least one subnet in at least two Availability Zones in the AWS Region.

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 DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.

DeleteDBClusterParameterGroup

DBClusterParameterGroupName => Str

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

Returns: nothing

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

DeleteDBClusterSnapshot

DBClusterSnapshotIdentifier => Str

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

Returns: a Paws::DocDB::DeleteDBClusterSnapshotResult instance

Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.

The DB cluster snapshot must be in the available state to be deleted.

DeleteDBInstance

DBInstanceIdentifier => Str

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

Returns: a Paws::DocDB::DeleteDBInstanceResult instance

Deletes a previously provisioned DB instance.

DeleteDBSubnetGroup

DBSubnetGroupName => Str

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

Returns: nothing

Deletes a DB subnet group.

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

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 DB 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 DB 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 DB clusters. This API operation supports pagination.

DescribeDBClusterSnapshotAttributes

DBClusterSnapshotIdentifier => Str

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

Returns: a Paws::DocDB::DescribeDBClusterSnapshotAttributesResult instance

Returns a list of DB 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 DB cluster snapshot. If all is included in the list of values for the restore attribute, then the manual DB cluster snapshot is public and can be copied or restored by all AWS 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 DB 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 DB 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 DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. You can obtain events specific to a particular DB instance, DB security group, DB snapshot, or DB parameter group by providing the name as a parameter. By default, the events of the past hour are returned.

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 DB 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, DB 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 DB cluster.

A failover for a DB cluster promotes one of the Amazon DocumentDB replicas (read-only instances) in the DB 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 DB 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 DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot or maintenance window before the change can take effect.

After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully complete the create action before the parameter group is used as the default for a new DB cluster. This step is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter.

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 DB cluster snapshot.

To share a manual DB 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 DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all 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 DB 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.

ModifyDBInstance

DBInstanceIdentifier => Str
[ApplyImmediately => Bool]
[AutoMinorVersionUpgrade => Bool]
[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 a DB 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 DB subnet group. DB subnet groups must contain at least one subnet in at least two Availability Zones in the AWS Region.

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 DB instance, usually for maintenance reasons. For example, if you make certain changes, or if you change the DB cluster parameter group that is associated with the DB instance, you must reboot the instance for the changes to take effect.

Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.

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 DB cluster parameter group to the default value. To reset specific parameters, submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters.

When 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 DB cluster from a DB snapshot or DB cluster snapshot.

If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

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 DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group.

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