AWS SDK for PHP 3.x

Service ID: docdb

Version: 2014-10-31

This page describes the parameters and results for the operations of the Amazon DocumentDB with MongoDB compatibility (2014-10-31), and shows how to use the Aws\DocDB\DocDBClient object to call the described operations. This documentation is specific to the 2014-10-31 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

AddSourceIdentifierToSubscription ( array $params = [] )
Adds a source identifier to an existing event notification subscription.
AddTagsToResource ( array $params = [] )
Adds metadata tags to an Amazon DocumentDB resource.
ApplyPendingMaintenanceAction ( array $params = [] )
Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).
CopyDBClusterParameterGroup ( array $params = [] )
Copies the specified cluster parameter group.
CopyDBClusterSnapshot ( array $params = [] )
Copies a snapshot of a cluster.
CreateDBCluster ( array $params = [] )
Creates a new Amazon DocumentDB cluster.
CreateDBClusterParameterGroup ( array $params = [] )
Creates a new cluster parameter group.
CreateDBClusterSnapshot ( array $params = [] )
Creates a snapshot of a cluster.
CreateDBInstance ( array $params = [] )
Creates a new instance.
CreateDBSubnetGroup ( array $params = [] )
Creates a new subnet group.
CreateEventSubscription ( array $params = [] )
Creates an Amazon DocumentDB event notification subscription.
CreateGlobalCluster ( array $params = [] )
Creates an Amazon DocumentDB global cluster that can span multiple multiple Amazon Web Services Regions.
DeleteDBCluster ( array $params = [] )
Deletes a previously provisioned cluster.
DeleteDBClusterParameterGroup ( array $params = [] )
Deletes a specified cluster parameter group.
DeleteDBClusterSnapshot ( array $params = [] )
Deletes a cluster snapshot.
DeleteDBInstance ( array $params = [] )
Deletes a previously provisioned instance.
DeleteDBSubnetGroup ( array $params = [] )
Deletes a subnet group.
DeleteEventSubscription ( array $params = [] )
Deletes an Amazon DocumentDB event notification subscription.
DeleteGlobalCluster ( array $params = [] )
Deletes a global cluster.
DescribeCertificates ( array $params = [] )
Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this Amazon Web Services account.
DescribeDBClusterParameterGroups ( array $params = [] )
Returns a list of DBClusterParameterGroup descriptions.
DescribeDBClusterParameters ( array $params = [] )
Returns the detailed parameter list for a particular cluster parameter group.
DescribeDBClusterSnapshotAttributes ( array $params = [] )
Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot.
DescribeDBClusterSnapshots ( array $params = [] )
Returns information about cluster snapshots.
DescribeDBClusters ( array $params = [] )
Returns information about provisioned Amazon DocumentDB clusters.
DescribeDBEngineVersions ( array $params = [] )
Returns a list of the available engines.
DescribeDBInstances ( array $params = [] )
Returns information about provisioned Amazon DocumentDB instances.
DescribeDBSubnetGroups ( array $params = [] )
Returns a list of DBSubnetGroup descriptions.
DescribeEngineDefaultClusterParameters ( array $params = [] )
Returns the default engine and system parameter information for the cluster database engine.
DescribeEventCategories ( array $params = [] )
Displays a list of categories for all event source types, or, if specified, for a specified source type.
DescribeEventSubscriptions ( array $params = [] )
Lists all the subscription descriptions for a customer account.
DescribeEvents ( array $params = [] )
Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days.
DescribeGlobalClusters ( array $params = [] )
Returns information about Amazon DocumentDB global clusters.
DescribeOrderableDBInstanceOptions ( array $params = [] )
Returns a list of orderable instance options for the specified engine.
DescribePendingMaintenanceActions ( array $params = [] )
Returns a list of resources (for example, instances) that have at least one pending maintenance action.
FailoverDBCluster ( array $params = [] )
Forces a failover for a cluster.
ListTagsForResource ( array $params = [] )
Lists all tags on an Amazon DocumentDB resource.
ModifyDBCluster ( array $params = [] )
Modifies a setting for an Amazon DocumentDB cluster.
ModifyDBClusterParameterGroup ( array $params = [] )
Modifies the parameters of a cluster parameter group.
ModifyDBClusterSnapshotAttribute ( array $params = [] )
Adds an attribute and values to, or removes an attribute and values from, a manual cluster snapshot.
ModifyDBInstance ( array $params = [] )
Modifies settings for an instance.
ModifyDBSubnetGroup ( array $params = [] )
Modifies an existing subnet group.
ModifyEventSubscription ( array $params = [] )
Modifies an existing Amazon DocumentDB event notification subscription.
ModifyGlobalCluster ( array $params = [] )
Modify a setting for an Amazon DocumentDB global cluster.
RebootDBInstance ( array $params = [] )
You might need to reboot your instance, usually for maintenance reasons.
RemoveFromGlobalCluster ( array $params = [] )
Detaches an Amazon DocumentDB secondary cluster from a global cluster.
RemoveSourceIdentifierFromSubscription ( array $params = [] )
Removes a source identifier from an existing Amazon DocumentDB event notification subscription.
RemoveTagsFromResource ( array $params = [] )
Removes metadata tags from an Amazon DocumentDB resource.
ResetDBClusterParameterGroup ( array $params = [] )
Modifies the parameters of a cluster parameter group to the default value.
RestoreDBClusterFromSnapshot ( array $params = [] )
Creates a new cluster from a snapshot or cluster snapshot.
RestoreDBClusterToPointInTime ( array $params = [] )
Restores a cluster to an arbitrary point in time.
StartDBCluster ( array $params = [] )
Restarts the stopped cluster that is specified by DBClusterIdentifier.
StopDBCluster ( array $params = [] )
Stops the running cluster that is specified by DBClusterIdentifier.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

DescribeCertificates
DescribeDBClusterParameterGroups
DescribeDBClusterParameters
DescribeDBClusterSnapshots
DescribeDBClusters
DescribeDBEngineVersions
DescribeDBInstances
DescribeDBSubnetGroups
DescribeEventSubscriptions
DescribeEvents
DescribeGlobalClusters
DescribeOrderableDBInstanceOptions
DescribePendingMaintenanceActions
ListTagsForResource

Waiters

Waiters allow you to poll a resource until it enters into a desired state. A waiter has a name used to describe what it does, and is associated with an API operation. When creating a waiter, you can provide the API operation parameters associated with the corresponding operation. Waiters can be accessed using the getWaiter($waiterName, $operationParameters) method of a client object. This client supports the following waiters:

Waiter name	API Operation	Delay	Max Attempts
DBInstanceAvailable	DescribeDBInstances	30	60
DBInstanceDeleted	DescribeDBInstances	30	60

Operations

AddSourceIdentifierToSubscription

$result = $client->addSourceIdentifierToSubscription([/* ... */]);
$promise = $client->addSourceIdentifierToSubscriptionAsync([/* ... */]);

Adds a source identifier to an existing event notification subscription.

Parameter Syntax

$result = $client->addSourceIdentifierToSubscription([
    'SourceIdentifier' => '<string>', // REQUIRED
    'SubscriptionName' => '<string>', // REQUIRED
]);

Parameter Details

Members

SourceIdentifier

Required: Yes
Type: string

The identifier of the event source to be added:

If the source type is an instance, a DBInstanceIdentifier must be provided.
If the source type is a security group, a DBSecurityGroupName must be provided.
If the source type is a parameter group, a DBParameterGroupName must be provided.
If the source type is a snapshot, a DBSnapshotIdentifier must be provided.

SubscriptionName

Required: Yes
Type: string

The name of the Amazon DocumentDB event notification subscription that you want to add a source identifier to.

Result Syntax

[
    'EventSubscription' => [
        'CustSubscriptionId' => '<string>',
        'CustomerAwsId' => '<string>',
        'Enabled' => true || false,
        'EventCategoriesList' => ['<string>', ...],
        'EventSubscriptionArn' => '<string>',
        'SnsTopicArn' => '<string>',
        'SourceIdsList' => ['<string>', ...],
        'SourceType' => '<string>',
        'Status' => '<string>',
        'SubscriptionCreationTime' => '<string>',
    ],
]

Result Details

Members

EventSubscription

Type: EventSubscription structure

Detailed information about an event to which you have subscribed.

Errors

SubscriptionNotFoundFault:
The subscription name does not exist.
SourceNotFoundFault:
The requested source could not be found.

AddTagsToResource

$result = $client->addTagsToResource([/* ... */]);
$promise = $client->addTagsToResourceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->addTagsToResource([
    'ResourceName' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members

ResourceName

Required: Yes
Type: string

The Amazon DocumentDB resource that the tags are added to. This value is an Amazon Resource Name .

Tags

Required: Yes
Type: Array of Tag structures

The tags to be assigned to the Amazon DocumentDB resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

DBInstanceNotFoundFault:
DBInstanceIdentifier doesn't refer to an existing instance.
DBSnapshotNotFoundFault:
DBSnapshotIdentifier doesn't refer to an existing snapshot.
DBClusterNotFoundFault:
DBClusterIdentifier doesn't refer to an existing cluster.

ApplyPendingMaintenanceAction

$result = $client->applyPendingMaintenanceAction([/* ... */]);
$promise = $client->applyPendingMaintenanceActionAsync([/* ... */]);

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

Parameter Syntax

$result = $client->applyPendingMaintenanceAction([
    'ApplyAction' => '<string>', // REQUIRED
    'OptInType' => '<string>', // REQUIRED
    'ResourceIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members

ApplyAction

Required: Yes
Type: string

The pending maintenance action to apply to this resource.

Valid values: system-update, db-upgrade

OptInType

Required: Yes
Type: string

A value that specifies the type of opt-in request or undoes an opt-in request. An opt-in request of type immediate can't be undone.

Valid values:

immediate - Apply the maintenance action immediately.
next-maintenance - Apply the maintenance action during the next maintenance window for the resource.
undo-opt-in - Cancel any existing next-maintenance opt-in requests.

ResourceIdentifier

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to.

Result Syntax

[
    'ResourcePendingMaintenanceActions' => [
        'PendingMaintenanceActionDetails' => [
            [
                'Action' => '<string>',
                'AutoAppliedAfterDate' => <DateTime>,
                'CurrentApplyDate' => <DateTime>,
                'Description' => '<string>',
                'ForcedApplyDate' => <DateTime>,
                'OptInStatus' => '<string>',
            ],
            // ...
        ],
        'ResourceIdentifier' => '<string>',
    ],
]

Result Details

Members

ResourcePendingMaintenanceActions

Type: ResourcePendingMaintenanceActions structure

Represents the output of ApplyPendingMaintenanceAction.

Errors

ResourceNotFoundFault:
The specified resource ID was not found.
InvalidDBClusterStateFault:
The cluster isn't in a valid state.
InvalidDBInstanceStateFault:
The specified instance isn't in the available state.

CopyDBClusterParameterGroup

$result = $client->copyDBClusterParameterGroup([/* ... */]);
$promise = $client->copyDBClusterParameterGroupAsync([/* ... */]);

Copies the specified cluster parameter group.

Parameter Syntax

$result = $client->copyDBClusterParameterGroup([
    'SourceDBClusterParameterGroupIdentifier' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'TargetDBClusterParameterGroupDescription' => '<string>', // REQUIRED
    'TargetDBClusterParameterGroupIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members

SourceDBClusterParameterGroupIdentifier

Required: Yes
Type: string

The identifier or Amazon Resource Name (ARN) for the source cluster parameter group.

Constraints:

Must specify a valid cluster parameter group.
If the source cluster parameter group is in the same Amazon Web Services Region as the copy, specify a valid parameter group identifier; for example, my-db-cluster-param-group, or a valid ARN.
If the source parameter group is in a different Amazon Web Services Region than the copy, specify a valid cluster parameter group ARN; for example, arn:aws:rds:us-east-1:123456789012:sample-cluster:sample-parameter-group.

Tags

Type: Array of Tag structures

The tags that are to be assigned to the parameter group.

TargetDBClusterParameterGroupDescription

Required: Yes
Type: string

A description for the copied cluster parameter group.

TargetDBClusterParameterGroupIdentifier

Required: Yes
Type: string

The identifier for the copied cluster parameter group.

Constraints:

Cannot be null, empty, or blank.
Must contain from 1 to 255 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-param-group1

Result Syntax

[
    'DBClusterParameterGroup' => [
        'DBClusterParameterGroupArn' => '<string>',
        'DBClusterParameterGroupName' => '<string>',
        'DBParameterGroupFamily' => '<string>',
        'Description' => '<string>',
    ],
]

Result Details

Members

DBClusterParameterGroup

Type: DBClusterParameterGroup structure

Detailed information about a cluster parameter group.

Errors

DBParameterGroupNotFoundFault:
DBParameterGroupName doesn't refer to an existing parameter group.
DBParameterGroupQuotaExceededFault:
This request would cause you to exceed the allowed number of parameter groups.
DBParameterGroupAlreadyExistsFault:
A parameter group with the same name already exists.

CopyDBClusterSnapshot

$result = $client->copyDBClusterSnapshot([/* ... */]);
$promise = $client->copyDBClusterSnapshotAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->copyDBClusterSnapshot([
    'CopyTags' => true || false,
    'KmsKeyId' => '<string>',
    'PreSignedUrl' => '<string>',
    'SourceDBClusterSnapshotIdentifier' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'TargetDBClusterSnapshotIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members

CopyTags

Type: boolean

Set to true to copy all tags from the source cluster snapshot to the target cluster snapshot, and otherwise false. The default is false.

KmsKeyId

Type: string

The KMS key ID for an encrypted cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

If you copy an encrypted cluster snapshot from your Amazon Web Services account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the cluster snapshot is encrypted with the same KMS key as the source cluster snapshot.

If you copy an encrypted cluster snapshot that is shared from another Amazon Web Services account, then you must specify a value for KmsKeyId.

To copy an encrypted cluster snapshot to another Amazon Web Services Region, set KmsKeyId to the KMS key ID that you want to use to encrypt the copy of the cluster snapshot in the destination Region. KMS encryption keys are specific to the Amazon Web Services Region that they are created in, and you can't use encryption keys from one Amazon Web Services Region in another Amazon Web Services Region.

If you copy an unencrypted cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

PreSignedUrl

Type: string

The URL that contains a Signature Version 4 signed request for theCopyDBClusterSnapshot API action in the Amazon Web Services Region that contains the source cluster snapshot to copy. You must use the PreSignedUrl parameter when copying a cluster snapshot from another Amazon Web Services Region.

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source Amazon Web Services Region.

The presigned URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source Amazon Web Services Region that contains the cluster snapshot to be copied. The presigned URL request must contain the following parameter values:

SourceRegion - The ID of the region that contains the snapshot to be copied.
SourceDBClusterSnapshotIdentifier - The identifier for the the encrypted cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted cluster snapshot from the us-east-1 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier looks something like the following: arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot.
TargetDBClusterSnapshotIdentifier - The identifier for the new cluster snapshot to be created. This parameter isn't case sensitive.

SourceDBClusterSnapshotIdentifier

Required: Yes
Type: string

The identifier of the cluster snapshot to copy. This parameter is not case sensitive.

Constraints:

Must specify a valid system snapshot in the available state.
If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid snapshot identifier.
If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid cluster snapshot ARN.

Example: my-cluster-snapshot1

Tags

Type: Array of Tag structures

The tags to be assigned to the cluster snapshot.

TargetDBClusterSnapshotIdentifier

Required: Yes
Type: string

The identifier of the new cluster snapshot to create from the source cluster snapshot. This parameter is not case sensitive.

Constraints:

Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-snapshot2

Result Syntax

[
    'DBClusterSnapshot' => [
        'AvailabilityZones' => ['<string>', ...],
        'ClusterCreateTime' => <DateTime>,
        'DBClusterIdentifier' => '<string>',
        'DBClusterSnapshotArn' => '<string>',
        'DBClusterSnapshotIdentifier' => '<string>',
        'Engine' => '<string>',
        'EngineVersion' => '<string>',
        'KmsKeyId' => '<string>',
        'MasterUsername' => '<string>',
        'PercentProgress' => <integer>,
        'Port' => <integer>,
        'SnapshotCreateTime' => <DateTime>,
        'SnapshotType' => '<string>',
        'SourceDBClusterSnapshotArn' => '<string>',
        'Status' => '<string>',
        'StorageEncrypted' => true || false,
        'VpcId' => '<string>',
    ],
]

Result Details

Members

DBClusterSnapshot

Type: DBClusterSnapshot structure

Detailed information about a cluster snapshot.

Errors

DBClusterSnapshotAlreadyExistsFault:
You already have a cluster snapshot with the given identifier.
DBClusterSnapshotNotFoundFault:
DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.
InvalidDBClusterStateFault:
The cluster isn't in a valid state.
InvalidDBClusterSnapshotStateFault:
The provided value isn't a valid cluster snapshot state.
SnapshotQuotaExceededFault:
The request would cause you to exceed the allowed number of snapshots.
KMSKeyNotAccessibleFault:
An error occurred when accessing an KMS key.

CreateDBCluster

$result = $client->createDBCluster([/* ... */]);
$promise = $client->createDBClusterAsync([/* ... */]);

Creates a new Amazon DocumentDB cluster.

Parameter Syntax

$result = $client->createDBCluster([
    'AvailabilityZones' => ['<string>', ...],
    'BackupRetentionPeriod' => <integer>,
    'DBClusterIdentifier' => '<string>', // REQUIRED
    'DBClusterParameterGroupName' => '<string>',
    'DBSubnetGroupName' => '<string>',
    'DeletionProtection' => true || false,
    'EnableCloudwatchLogsExports' => ['<string>', ...],
    'Engine' => '<string>', // REQUIRED
    'EngineVersion' => '<string>',
    'GlobalClusterIdentifier' => '<string>',
    'KmsKeyId' => '<string>',
    'MasterUserPassword' => '<string>',
    'MasterUsername' => '<string>',
    'Port' => <integer>,
    'PreSignedUrl' => '<string>',
    'PreferredBackupWindow' => '<string>',
    'PreferredMaintenanceWindow' => '<string>',
    'StorageEncrypted' => true || false,
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'VpcSecurityGroupIds' => ['<string>', ...],
]);

Parameter Details

Members

AvailabilityZones

Type: Array of strings

A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

BackupRetentionPeriod

Type: int

The number of days for which automated backups are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

Must be a value from 1 to 35.

DBClusterIdentifier

Required: Yes
Type: string

The cluster identifier. This parameter is stored as a lowercase string.

Constraints:

Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster

DBClusterParameterGroupName

Type: string

The name of the cluster parameter group to associate with this cluster.

DBSubnetGroupName

Type: string

A subnet group to associate with this cluster.

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mySubnetgroup

DeletionProtection

Type: boolean

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

EnableCloudwatchLogsExports

Type: Array of strings

A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs. You can enable audit logs or profiler logs. For more information, see Auditing Amazon DocumentDB Events and Profiling Amazon DocumentDB Operations.

Engine

Required: Yes
Type: string

The name of the database engine to be used for this cluster.

Valid values: docdb

EngineVersion

Type: string

The version number of the database engine to use. The --engine-version will default to the latest major engine version. For production workloads, we recommend explicitly declaring this parameter with the intended major engine version.

GlobalClusterIdentifier

Type: string

The cluster identifier of the new global cluster.

KmsKeyId

Type: string

The KMS key identifier for an encrypted cluster.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon Web Services account that owns the KMS encryption key that is used to encrypt the new cluster, you can use the KMS key alias instead of the ARN for the KMS encryption key.

If an encryption key is not specified in KmsKeyId:

If the StorageEncrypted parameter is true, Amazon DocumentDB uses your default encryption key.

KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Regions.

MasterUserPassword

Type: string

The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

Constraints: Must contain from 8 to 100 characters.

MasterUsername

Type: string

The name of the master user for the cluster.

Constraints:

Must be from 1 to 63 letters or numbers.
The first character must be a letter.
Cannot be a reserved word for the chosen database engine.

Port

Type: int

The port number on which the instances in the cluster accept connections.

PreSignedUrl

Type: string

Not currently supported.

PreferredBackupWindow

Type: string

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region.

Constraints:

Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.

PreferredMaintenanceWindow

Type: string

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

StorageEncrypted

Type: boolean

Specifies whether the cluster is encrypted.

Tags

Type: Array of Tag structures

The tags to be assigned to the cluster.

VpcSecurityGroupIds

Type: Array of strings

A list of EC2 VPC security groups to associate with this cluster.

Result Syntax

[
    'DBCluster' => [
        'AssociatedRoles' => [
            [
                'RoleArn' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'AvailabilityZones' => ['<string>', ...],
        'BackupRetentionPeriod' => <integer>,
        'CloneGroupId' => '<string>',
        'ClusterCreateTime' => <DateTime>,
        'DBClusterArn' => '<string>',
        'DBClusterIdentifier' => '<string>',
        'DBClusterMembers' => [
            [
                'DBClusterParameterGroupStatus' => '<string>',
                'DBInstanceIdentifier' => '<string>',
                'IsClusterWriter' => true || false,
                'PromotionTier' => <integer>,
            ],
            // ...
        ],
        'DBClusterParameterGroup' => '<string>',
        'DBSubnetGroup' => '<string>',
        'DbClusterResourceId' => '<string>',
        'DeletionProtection' => true || false,
        'EarliestRestorableTime' => <DateTime>,
        'EnabledCloudwatchLogsExports' => ['<string>', ...],
        'Endpoint' => '<string>',
        'Engine' => '<string>',
        'EngineVersion' => '<string>',
        'HostedZoneId' => '<string>',
        'KmsKeyId' => '<string>',
        'LatestRestorableTime' => <DateTime>,
        'MasterUsername' => '<string>',
        'MultiAZ' => true || false,
        'PercentProgress' => '<string>',
        'Port' => <integer>,
        'PreferredBackupWindow' => '<string>',
        'PreferredMaintenanceWindow' => '<string>',
        'ReadReplicaIdentifiers' => ['<string>', ...],
        'ReaderEndpoint' => '<string>',
        'ReplicationSourceIdentifier' => '<string>',
        'Status' => '<string>',
        'StorageEncrypted' => true || false,
        'VpcSecurityGroups' => [
            [
                'Status' => '<string>',
                'VpcSecurityGroupId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members

DBCluster

Type: DBCluster structure

Detailed information about a cluster.

Errors

DBClusterAlreadyExistsFault:
You already have a cluster with the given identifier.
InsufficientStorageClusterCapacityFault:
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.
DBClusterQuotaExceededFault:
The cluster can't be created because you have reached the maximum allowed quota of clusters.
StorageQuotaExceededFault:
The request would cause you to exceed the allowed amount of storage available across all instances.
DBSubnetGroupNotFoundFault:
DBSubnetGroupName doesn't refer to an existing subnet group.
InvalidVPCNetworkStateFault:
The subnet group doesn't cover all Availability Zones after it is created because of changes that were made.
InvalidDBClusterStateFault:
The cluster isn't in a valid state.
InvalidDBSubnetGroupStateFault:
The subnet group can't be deleted because it's in use.
InvalidSubnet:
The requested subnet is not valid, or multiple subnets were requested that are not all in a common virtual private cloud (VPC).
InvalidDBInstanceStateFault:
The specified instance isn't in the available state.
DBClusterParameterGroupNotFoundFault:
DBClusterParameterGroupName doesn't refer to an existing cluster parameter group.
KMSKeyNotAccessibleFault:
An error occurred when accessing an KMS key.
DBClusterNotFoundFault:
DBClusterIdentifier doesn't refer to an existing cluster.
DBInstanceNotFoundFault:
DBInstanceIdentifier doesn't refer to an existing instance.
DBSubnetGroupDoesNotCoverEnoughAZs:
Subnets in the subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
GlobalClusterNotFoundFault:
The GlobalClusterIdentifier doesn't refer to an existing global cluster.
InvalidGlobalClusterStateFault:
The requested operation can't be performed while the cluster is in this state.

CreateDBClusterParameterGroup

$result = $client->createDBClusterParameterGroup([/* ... */]);
$promise = $client->createDBClusterParameterGroupAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createDBClusterParameterGroup([
    'DBClusterParameterGroupName' => '<string>', // REQUIRED
    'DBParameterGroupFamily' => '<string>', // REQUIRED
    'Description' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members

DBClusterParameterGroupName

Required: Yes
Type: string

The name of the cluster parameter group.

Constraints:

Must not match the name of an existing DBClusterParameterGroup.

This value is stored as a lowercase string.

DBParameterGroupFamily

Required: Yes
Type: string

The cluster parameter group family name.

Description

Required: Yes
Type: string

The description for the cluster parameter group.

Tags

Type: Array of Tag structures

The tags to be assigned to the cluster parameter group.

Result Syntax

[
    'DBClusterParameterGroup' => [
        'DBClusterParameterGroupArn' => '<string>',
        'DBClusterParameterGroupName' => '<string>',
        'DBParameterGroupFamily' => '<string>',
        'Description' => '<string>',
    ],
]

Result Details

Members

DBClusterParameterGroup

Type: DBClusterParameterGroup structure

Detailed information about a cluster parameter group.

Errors

DBParameterGroupQuotaExceededFault:
This request would cause you to exceed the allowed number of parameter groups.
DBParameterGroupAlreadyExistsFault:
A parameter group with the same name already exists.

CreateDBClusterSnapshot

$result = $client->createDBClusterSnapshot([/* ... */]);
$promise = $client->createDBClusterSnapshotAsync([/* ... */]);

Creates a snapshot of a cluster.

Parameter Syntax

$result = $client->createDBClusterSnapshot([
    'DBClusterIdentifier' => '<string>', // REQUIRED
    'DBClusterSnapshotIdentifier' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members

DBClusterIdentifier

Required: Yes
Type: string

The identifier of the cluster to create a snapshot for. This parameter is not case sensitive.

Constraints:

Must match the identifier of an existing DBCluster.

Example: my-cluster

DBClusterSnapshotIdentifier

Required: Yes
Type: string

The identifier of the cluster snapshot. This parameter is stored as a lowercase string.

Constraints:

Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-snapshot1

Tags

Type: Array of Tag structures

The tags to be assigned to the cluster snapshot.

Result Syntax

[
    'DBClusterSnapshot' => [
        'AvailabilityZones' => ['<string>', ...],
        'ClusterCreateTime' => <DateTime>,
        'DBClusterIdentifier' => '<string>',
        'DBClusterSnapshotArn' => '<string>',
        'DBClusterSnapshotIdentifier' => '<string>',
        'Engine' => '<string>',
        'EngineVersion' => '<string>',
        'KmsKeyId' => '<string>',
        'MasterUsername' => '<string>',
        'PercentProgress' => <integer>,
        'Port' => <integer>,
        'SnapshotCreateTime' => <DateTime>,
        'SnapshotType' => '<string>',
        'SourceDBClusterSnapshotArn' => '<string>',
        'Status' => '<string>',
        'StorageEncrypted' => true || false,
        'VpcId' => '<string>',
    ],
]

Result Details

Members

DBClusterSnapshot

Type: DBClusterSnapshot structure

Detailed information about a cluster snapshot.

Errors

DBClusterSnapshotAlreadyExistsFault:
You already have a cluster snapshot with the given identifier.
InvalidDBClusterStateFault:
The cluster isn't in a valid state.
DBClusterNotFoundFault:
DBClusterIdentifier doesn't refer to an existing cluster.
SnapshotQuotaExceededFault:
The request would cause you to exceed the allowed number of snapshots.
InvalidDBClusterSnapshotStateFault:
The provided value isn't a valid cluster snapshot state.

CreateDBInstance

$result = $client->createDBInstance([/* ... */]);
$promise = $client->createDBInstanceAsync([/* ... */]);

Creates a new instance.

Parameter Syntax

$result = $client->createDBInstance([
    'AutoMinorVersionUpgrade' => true || false,
    'AvailabilityZone' => '<string>',
    'CopyTagsToSnapshot' => true || false,
    'DBClusterIdentifier' => '<string>', // REQUIRED
    'DBInstanceClass' => '<string>', // REQUIRED
    'DBInstanceIdentifier' => '<string>', // REQUIRED
    'EnablePerformanceInsights' => true || false,
    'Engine' => '<string>', // REQUIRED
    'PerformanceInsightsKMSKeyId' => '<string>',
    'PreferredMaintenanceWindow' => '<string>',
    'PromotionTier' => <integer>,
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members

AutoMinorVersionUpgrade

Type: boolean

This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

Default: false

AvailabilityZone

Type: string

The Amazon EC2 Availability Zone that the instance is created in.

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

Example: us-east-1d

CopyTagsToSnapshot

Type: boolean

A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

DBClusterIdentifier

Required: Yes
Type: string

The identifier of the cluster that the instance will belong to.

DBInstanceClass

Required: Yes
Type: string

The compute and memory capacity of the instance; for example, db.r5.large.

DBInstanceIdentifier

Required: Yes
Type: string

The instance identifier. This parameter is stored as a lowercase string.

Constraints:

Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

EnablePerformanceInsights

Type: boolean

A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights.

Engine

Required: Yes
Type: string

The name of the database engine to be used for this instance.

Valid value: docdb

PerformanceInsightsKMSKeyId

Type: string

The KMS key identifier for encryption of Performance Insights data.

The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services region.

PreferredMaintenanceWindow

Type: string

The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

PromotionTier

Type: int

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

Default: 1

Valid values: 0-15

Tags

Type: Array of Tag structures

The tags to be assigned to the instance. You can assign up to 10 tags to an instance.

Result Syntax

[
    'DBInstance' => [
        'AutoMinorVersionUpgrade' => true || false,
        'AvailabilityZone' => '<string>',
        'BackupRetentionPeriod' => <integer>,
        'CACertificateIdentifier' => '<string>',
        'CopyTagsToSnapshot' => true || false,
        'DBClusterIdentifier' => '<string>',
        'DBInstanceArn' => '<string>',
        'DBInstanceClass' => '<string>',
        'DBInstanceIdentifier' => '<string>',
        'DBInstanceStatus' => '<string>',
        'DBSubnetGroup' => [
            'DBSubnetGroupArn' => '<string>',
            'DBSubnetGroupDescription' => '<string>',
            'DBSubnetGroupName' => '<string>',
            'SubnetGroupStatus' => '<string>',
            'Subnets' => [
                [
                    'SubnetAvailabilityZone' => [
                        'Name' => '<string>',
                    ],
                    'SubnetIdentifier' => '<string>',
                    'SubnetStatus' => '<string>',
                ],
                // ...
            ],
            'VpcId' => '<string>',
        ],
        'DbiResourceId' => '<string>',
        'EnabledCloudwatchLogsExports' => ['<string>', ...],
        'Endpoint' => [
            'Address' => '<string>',
            'HostedZoneId' => '<string>',
            'Port' => <integer>,
        ],
        'Engine' => '<string>',
        'EngineVersion' => '<string>',
        'InstanceCreateTime' => <DateTime>,
        'KmsKeyId' => '<string>',
        'LatestRestorableTime' => <DateTime>,
        'PendingModifiedValues' => [
            'AllocatedStorage' => <integer>,
            'BackupRetentionPeriod' => <integer>,
            'CACertificateIdentifier' => '<string>',
            'DBInstanceClass' => '<string>',
            'DBInstanceIdentifier' => '<string>',
            'DBSubnetGroupName' => '<string>',
            'EngineVersion' => '<string>',
            'Iops' => <integer>,
            'LicenseModel' => '<string>',
            'MasterUserPassword' => '<string>',
            'MultiAZ' => true || false,
            'PendingCloudwatchLogsExports' => [
                'LogTypesToDisable' => ['<string>', ...],
                'LogTypesToEnable' => ['<string>', ...],
            ],
            'Port' => <integer>,
            'StorageType' => '<string>',
        ],
        'PreferredBackupWindow' => '<string>',
        'PreferredMaintenanceWindow' => '<string>',
        'PromotionTier' => <integer>,
        'PubliclyAccessible' => true || false,
        'StatusInfos' => [
            [
                'Message' => '<string>',
                'Normal' => true || false,
                'Status' => '<string>',
                'StatusType' => '<string>',
            ],
            // ...
        ],
        'StorageEncrypted' => true || false,
        'VpcSecurityGroups' => [
            [
                'Status' => '<string>',
                'VpcSecurityGroupId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members

DBInstance

Type: DBInstance structure

Detailed information about an instance.

Errors

DBInstanceAlreadyExistsFault:
You already have a instance with the given identifier.
InsufficientDBInstanceCapacityFault:
The specified instance class isn't available in the specified Availability Zone.
DBParameterGroupNotFoundFault:
DBParameterGroupName doesn't refer to an existing parameter group.
DBSecurityGroupNotFoundFault:
DBSecurityGroupName doesn't refer to an existing security group.
InstanceQuotaExceededFault:
The request would cause you to exceed the allowed number of instances.
StorageQuotaExceededFault:
The request would cause you to exceed the allowed amount of storage available across all instances.
DBSubnetGroupNotFoundFault:
DBSubnetGroupName doesn't refer to an existing subnet group.
DBSubnetGroupDoesNotCoverEnoughAZs:
Subnets in the subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
InvalidDBClusterStateFault:
The cluster isn't in a valid state.
InvalidSubnet:
The requested subnet is not valid, or multiple subnets were requested that are not all in a common virtual private cloud (VPC).
InvalidVPCNetworkStateFault:
The subnet group doesn't cover all Availability Zones after it is created because of changes that were made.
DBClusterNotFoundFault:
DBClusterIdentifier doesn't refer to an existing cluster.
StorageTypeNotSupportedFault:
Storage of the specified StorageType can't be associated with the DB instance.
AuthorizationNotFoundFault:
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.
KMSKeyNotAccessibleFault:
An error occurred when accessing an KMS key.

CreateDBSubnetGroup

$result = $client->createDBSubnetGroup([/* ... */]);
$promise = $client->createDBSubnetGroupAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createDBSubnetGroup([
    'DBSubnetGroupDescription' => '<string>', // REQUIRED
    'DBSubnetGroupName' => '<string>', // REQUIRED
    'SubnetIds' => ['<string>', ...], // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members

DBSubnetGroupDescription

Required: Yes
Type: string

The description for the subnet group.

DBSubnetGroupName

Required: Yes
Type: string

The name for the subnet group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default.

Example: mySubnetgroup

SubnetIds

Required: Yes
Type: Array of strings

The Amazon EC2 subnet IDs for the subnet group.

Tags

Type: Array of Tag structures

The tags to be assigned to the subnet group.

Result Syntax

[
    'DBSubnetGroup' => [
        'DBSubnetGroupArn' => '<string>',
        'DBSubnetGroupDescription' => '<string>',
        'DBSubnetGroupName' => '<string>',
        'SubnetGroupStatus' => '<string>',
        'Subnets' => [
            [
                'SubnetAvailabilityZone' => [
                    'Name' => '<string>',
                ],
                'SubnetIdentifier' => '<string>',
                'SubnetStatus' => '<string>',
            ],
            // ...
        ],
        'VpcId' => '<string>',
    ],
]

Result Details

Members

DBSubnetGroup

Type: DBSubnetGroup structure

Detailed information about a subnet group.

Errors

DBSubnetGroupAlreadyExistsFault:
DBSubnetGroupName is already being used by an existing subnet group.
DBSubnetGroupQuotaExceededFault:
The request would cause you to exceed the allowed number of subnet groups.
DBSubnetQuotaExceededFault:
The request would cause you to exceed the allowed number of subnets in a subnet group.
DBSubnetGroupDoesNotCoverEnoughAZs:
Subnets in the subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
InvalidSubnet:
The requested subnet is not valid, or multiple subnets were requested that are not all in a common virtual private cloud (VPC).

CreateEventSubscription

$result = $client->createEventSubscription([/* ... */]);
$promise = $client->createEventSubscriptionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createEventSubscription([
    'Enabled' => true || false,
    'EventCategories' => ['<string>', ...],
    'SnsTopicArn' => '<string>', // REQUIRED
    'SourceIds' => ['<string>', ...],
    'SourceType' => '<string>',
    'SubscriptionName' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members

Enabled

Type: boolean

A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.

EventCategories

Type: Array of strings

A list of event categories for a SourceType that you want to subscribe to.

SnsTopicArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the SNS topic created for event notification. Amazon SNS creates the ARN when you create a topic and subscribe to it.

SourceIds

Type: Array of strings

The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

Constraints:

If SourceIds are provided, SourceType must also be provided.
If the source type is an instance, a DBInstanceIdentifier must be provided.
If the source type is a security group, a DBSecurityGroupName must be provided.
If the source type is a parameter group, a DBParameterGroupName must be provided.
If the source type is a snapshot, a DBSnapshotIdentifier must be provided.

SourceType

Type: string

The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, you would set this parameter to db-instance. If this value is not specified, all events are returned.

Valid values: db-instance, db-cluster, db-parameter-group, db-security-group, db-cluster-snapshot

SubscriptionName

Required: Yes
Type: string

The name of the subscription.

Constraints: The name must be fewer than 255 characters.

Tags

Type: Array of Tag structures

The tags to be assigned to the event subscription.

Result Syntax

[
    'EventSubscription' => [
        'CustSubscriptionId' => '<string>',
        'CustomerAwsId' => '<string>',
        'Enabled' => true || false,
        'EventCategoriesList' => ['<string>', ...],
        'EventSubscriptionArn' => '<string>',
        'SnsTopicArn' => '<string>',
        'SourceIdsList' => ['<string>', ...],
        'SourceType' => '<string>',
        'Status' => '<string>',
        'SubscriptionCreationTime' => '<string>',
    ],
]

Result Details

Members

EventSubscription

Type: EventSubscription structure

Detailed information about an event to which you have subscribed.

Errors

EventSubscriptionQuotaExceededFault:
You have reached the maximum number of event subscriptions.
SubscriptionAlreadyExistFault:
The provided subscription name already exists.
SNSInvalidTopicFault:
Amazon SNS has responded that there is a problem with the specified topic.
SNSNoAuthorizationFault:
You do not have permission to publish to the SNS topic Amazon Resource Name (ARN).
SNSTopicArnNotFoundFault:
The SNS topic Amazon Resource Name (ARN) does not exist.
SubscriptionCategoryNotFoundFault:
The provided category does not exist.
SourceNotFoundFault:
The requested source could not be found.

CreateGlobalCluster

$result = $client->createGlobalCluster([/* ... */]);
$promise = $client->createGlobalClusterAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createGlobalCluster([
    'DatabaseName' => '<string>',
    'DeletionProtection' => true || false,
    'Engine' => '<string>',
    'EngineVersion' => '<string>',
    'GlobalClusterIdentifier' => '<string>', // REQUIRED
    'SourceDBClusterIdentifier' => '<string>',
    'StorageEncrypted' => true || false,
]);

Parameter Details

Members

DatabaseName

Type: string

The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon DocumentDB will not create a database in the global cluster you are creating.

DeletionProtection

Type: boolean

The deletion protection setting for the new global cluster. The global cluster can't be deleted when deletion protection is enabled.

Engine

Type: string

The name of the database engine to be used for this cluster.

EngineVersion

Type: string

The engine version of the global cluster.

GlobalClusterIdentifier

Required: Yes
Type: string

The cluster identifier of the new global cluster.

SourceDBClusterIdentifier

Type: string

The Amazon Resource Name (ARN) to use as the primary cluster of the global cluster. This parameter is optional.

StorageEncrypted

Type: boolean

The storage encryption setting for the new global cluster.

Result Syntax

[
    'GlobalCluster' => [
        'DatabaseName' => '<string>',
        'DeletionProtection' => true || false,
        'Engine' => '<string>',
        'EngineVersion' => '<string>',
        'GlobalClusterArn' => '<string>',
        'GlobalClusterIdentifier' => '<string>',
        'GlobalClusterMembers' => [
            [
                'DBClusterArn' => '<string>',
                'IsWriter' => true || false,
                'Readers' => ['<string>', ...],
            ],
            // ...
        ],
        'GlobalClusterResourceId' => '<string>',
        'Status' => '<string>',
        'StorageEncrypted' => true || false,
    ],
]

Result Details

Members

GlobalCluster

Type: GlobalCluster structure

A data type representing an Amazon DocumentDB global cluster.

Errors

GlobalClusterAlreadyExistsFault:
The GlobalClusterIdentifier already exists. Choose a new global cluster identifier (unique name) to create a new global cluster.
GlobalClusterQuotaExceededFault:
The number of global clusters for this account is already at the maximum allowed.
InvalidDBClusterStateFault:
The cluster isn't in a valid state.
DBClusterNotFoundFault:
DBClusterIdentifier doesn't refer to an existing cluster.

DeleteDBCluster

$result = $client->deleteDBCluster([/* ... */]);
$promise = $client->deleteDBClusterAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteDBCluster([
    'DBClusterIdentifier' => '<string>', // REQUIRED
    'FinalDBSnapshotIdentifier' => '<string>',
    'SkipFinalSnapshot' => true || false,
]);

Parameter Details

Members

DBClusterIdentifier

Required: Yes
Type: string

The cluster identifier for the cluster to be deleted. This parameter isn't case sensitive.

Constraints:

Must match an existing DBClusterIdentifier.

FinalDBSnapshotIdentifier

Type: string

The cluster snapshot identifier of the new cluster snapshot created when SkipFinalSnapshot is set to false.

Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.

Constraints:

Must be from 1 to 255 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.

SkipFinalSnapshot

Type: boolean

Determines whether a final cluster snapshot is created before the cluster is deleted. If true is specified, no cluster snapshot is created. If false is specified, a cluster snapshot is created before the DB cluster is deleted.

If SkipFinalSnapshot is false, you must specify a FinalDBSnapshotIdentifier parameter.

Default: false

Result Syntax

[
    'DBCluster' => [
        'AssociatedRoles' => [
            [
                'RoleArn' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'AvailabilityZones' => ['<string>', ...],
        'BackupRetentionPeriod' => <integer>,
        'CloneGroupId' => '<string>',
        'ClusterCreateTime' => <DateTime>,
        'DBClusterArn' => '<string>',
        'DBClusterIdentifier' => '<string>',
        'DBClusterMembers' => [
            [
                'DBClusterParameterGroupStatus' => '<string>',
                'DBInstanceIdentifier' => '<string>',
                'IsClusterWriter' => true || false,
                'PromotionTier' => <integer>,
            ],
            // ...
        ],
        'DBClusterParameterGroup' => '<string>',
        'DBSubnetGroup' => '<string>',
        'DbClusterResourceId' => '<string>',
        'DeletionProtection' => true || false,
        'EarliestRestorableTime' => <DateTime>,
        'EnabledCloudwatchLogsExports' => ['<string>', ...],
        'Endpoint' => '<string>',
        'Engine' => '<string>',
        'EngineVersion' => '<string>',
        'HostedZoneId' => '<string>',
        'KmsKeyId' => '<string>',
        'LatestRestorableTime' => <DateTime>,
        'MasterUsername' => '<string>',
        'MultiAZ' => true || false,
        'PercentProgress' => '<string>',
        'Port' => <integer>,
        'PreferredBackupWindow' => '<string>',
        'PreferredMaintenanceWindow' => '<string>',
        'ReadReplicaIdentifiers' => ['<string>', ...],
        'ReaderEndpoint' => '<string>',
        'ReplicationSourceIdentifier' => '<string>',
        'Status' => '<string>',
        'StorageEncrypted' => true || false,
        'VpcSecurityGroups' => [
            [
                'Status' => '<string>',
                'VpcSecurityGroupId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members

DBCluster

Type: DBCluster structure

Detailed information about a cluster.

Errors

DBClusterNotFoundFault:
DBClusterIdentifier doesn't refer to an existing cluster.
InvalidDBClusterStateFault:
The cluster isn't in a valid state.
DBClusterSnapshotAlreadyExistsFault:
You already have a cluster snapshot with the given identifier.
SnapshotQuotaExceededFault:
The request would cause you to exceed the allowed number of snapshots.
InvalidDBClusterSnapshotStateFault:
The provided value isn't a valid cluster snapshot state.

DeleteDBClusterParameterGroup

$result = $client->deleteDBClusterParameterGroup([/* ... */]);
$promise = $client->deleteDBClusterParameterGroupAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deleteDBClusterParameterGroup([
    'DBClusterParameterGroupName' => '<string>', // REQUIRED
]);

Parameter Details

Members

DBClusterParameterGroupName

Required: Yes
Type: string

The name of the cluster parameter group.

Constraints:

Must be the name of an existing cluster parameter group.
You can't delete a default cluster parameter group.
Cannot be associated with any clusters.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidDBParameterGroupStateFault:
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.
DBParameterGroupNotFoundFault:
DBParameterGroupName doesn't refer to an existing parameter group.

DeleteDBClusterSnapshot

$result = $client->deleteDBClusterSnapshot([/* ... */]);
$promise = $client->deleteDBClusterSnapshotAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteDBClusterSnapshot([
    'DBClusterSnapshotIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members

DBClusterSnapshotIdentifier

Required: Yes
Type: string

The identifier of the cluster snapshot to delete.

Constraints: Must be the name of an existing cluster snapshot in the available state.

Result Syntax

[
    'DBClusterSnapshot' => [
        'AvailabilityZones' => ['<string>', ...],
        'ClusterCreateTime' => <DateTime>,
        'DBClusterIdentifier' => '<string>',
        'DBClusterSnapshotArn' => '<string>',
        'DBClusterSnapshotIdentifier' => '<string>',
        'Engine' => '<string>',
        'EngineVersion' => '<string>',
        'KmsKeyId' => '<string>',
        'MasterUsername' => '<string>',
        'PercentProgress' => <integer>,
        'Port' => <integer>,
        'SnapshotCreateTime' => <DateTime>,
        'SnapshotType' => '<string>',
        'SourceDBClusterSnapshotArn' => '<string>',
        'Status' => '<string>',
        'StorageEncrypted' => true || false,
        'VpcId' => '<string>',
    ],
]

Result Details

Members

DBClusterSnapshot

Type: DBClusterSnapshot structure

Detailed information about a cluster snapshot.

Errors

InvalidDBClusterSnapshotStateFault:
The provided value isn't a valid cluster snapshot state.
DBClusterSnapshotNotFoundFault:
DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.

DeleteDBInstance

$result = $client->deleteDBInstance([/* ... */]);
$promise = $client->deleteDBInstanceAsync([/* ... */]);

Deletes a previously provisioned instance.

Parameter Syntax

$result = $client->deleteDBInstance([
    'DBInstanceIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members

DBInstanceIdentifier

Required: Yes
Type: string

The instance identifier for the instance to be deleted. This parameter isn't case sensitive.

Constraints:

Must match the name of an existing instance.

Result Syntax

[
    'DBInstance' => [
        'AutoMinorVersionUpgrade' => true || false,
        'AvailabilityZone' => '<string>',
        'BackupRetentionPeriod' => <integer>,
        'CACertificateIdentifier' => '<string>',
        'CopyTagsToSnapshot' => true || false,
        'DBClusterIdentifier' => '<string>',
        'DBInstanceArn' => '<string>',
        'DBInstanceClass' => '<string>',
        'DBInstanceIdentifier' => '<string>',
        'DBInstanceStatus' => '<string>',
        'DBSubnetGroup' => [
            'DBSubnetGroupArn' => '<string>',
            'DBSubnetGroupDescription' => '<string>',
            'DBSubnetGroupName' => '<string>',
            'SubnetGroupStatus' => '<string>',
            'Subnets' => [
                [
                    'SubnetAvailabilityZone' => [
                        'Name' => '<string>',
                    ],
                    'SubnetIdentifier' => '<string>',
                    'SubnetStatus' => '<string>',
                ],
                // ...
            ],
            'VpcId' => '<string>',
        ],
        'DbiResourceId' => '<string>',
        'EnabledCloudwatchLogsExports' => ['<string>', ...],
        'Endpoint' => [
            'Address' => '<string>',
            'HostedZoneId' => '<string>',
            'Port' => <integer>,
        ],
        'Engine' => '<string>',
        'EngineVersion' => '<string>',
        'InstanceCreateTime' => <DateTime>,
        'KmsKeyId' => '<string>',
        'LatestRestorableTime' => <DateTime>,
        'PendingModifiedValues' => [
            'AllocatedStorage' => <integer>,
            'BackupRetentionPeriod' => <integer>,
            'CACertificateIdentifier' => '<string>',
            'DBInstanceClass' => '<string>',
            'DBInstanceIdentifier' => '<string>',
            'DBSubnetGroupName' => '<string>',
            'EngineVersion' => '<string>',
            'Iops' => <integer>,
            'LicenseModel' => '<string>',
            'MasterUserPassword' => '<string>',
            'MultiAZ' => true || false,
            'PendingCloudwatchLogsExports' => [
                'LogTypesToDisable' => ['<string>', ...],
                'LogTypesToEnable' => ['<string>', ...],
            ],
            'Port' => <integer>,
            'StorageType' => '<string>',
        ],
        'PreferredBackupWindow' => '<string>',
        'PreferredMaintenanceWindow' => '<string>',
        'PromotionTier' => <integer>,
        'PubliclyAccessible' => true || false,
        'StatusInfos' => [
            [
                'Message' => '<string>',
                'Normal' => true || false,
                'Status' => '<string>',
                'StatusType' => '<string>',
            ],
            // ...
        ],
        'StorageEncrypted' => true || false,
        'VpcSecurityGroups' => [
            [
                'Status' => '<string>',
                'VpcSecurityGroupId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members

DBInstance

Type: DBInstance structure

Detailed information about an instance.

Errors

DBInstanceNotFoundFault:
DBInstanceIdentifier doesn't refer to an existing instance.
InvalidDBInstanceStateFault:
The specified instance isn't in the available state.
DBSnapshotAlreadyExistsFault:
DBSnapshotIdentifier is already being used by an existing snapshot.
SnapshotQuotaExceededFault:
The request would cause you to exceed the allowed number of snapshots.
InvalidDBClusterStateFault:
The cluster isn't in a valid state.

DeleteDBSubnetGroup

$result = $client->deleteDBSubnetGroup([/* ... */]);
$promise = $client->deleteDBSubnetGroupAsync([/* ... */]);

Deletes a subnet group.

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

Parameter Syntax

$result = $client->deleteDBSubnetGroup([
    'DBSubnetGroupName' => '<string>', // REQUIRED
]);

Parameter Details

Members

DBSubnetGroupName

Required: Yes
Type: string

The name of the database subnet group to delete.

You can't delete the default subnet group.

Constraints:

Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mySubnetgroup

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidDBSubnetGroupStateFault:
The subnet group can't be deleted because it's in use.
InvalidDBSubnetStateFault:
The subnet isn't in the available state.
DBSubnetGroupNotFoundFault:
DBSubnetGroupName doesn't refer to an existing subnet group.

DeleteEventSubscription

$result = $client->deleteEventSubscription([/* ... */]);
$promise = $client->deleteEventSubscriptionAsync([/* ... */]);

Deletes an Amazon DocumentDB event notification subscription.

Parameter Syntax

$result = $client->deleteEventSubscription([
    'SubscriptionName' => '<string>', // REQUIRED
]);

Parameter Details

Members

SubscriptionName

Required: Yes
Type: string

The name of the Amazon DocumentDB event notification subscription that you want to delete.

Result Syntax

[
    'EventSubscription' => [
        'CustSubscriptionId' => '<string>',
        'CustomerAwsId' => '<string>',
        'Enabled' => true || false,
        'EventCategoriesList' => ['<string>', ...],
        'EventSubscriptionArn' => '<string>',
        'SnsTopicArn' => '<string>',
        'SourceIdsList' => ['<string>', ...],
        'SourceType' => '<string>',
        'Status' => '<string>',
        'SubscriptionCreationTime' => '<string>',
    ],
]

Result Details

Members

EventSubscription

Type: EventSubscription structure

Detailed information about an event to which you have subscribed.

Errors

SubscriptionNotFoundFault:
The subscription name does not exist.
InvalidEventSubscriptionStateFault:
Someone else might be modifying a subscription. Wait a few seconds, and try again.

DeleteGlobalCluster

$result = $client->deleteGlobalCluster([/* ... */]);
$promise = $client->deleteGlobalClusterAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteGlobalCluster([
    'GlobalClusterIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members

GlobalClusterIdentifier

Required: Yes
Type: string

The cluster identifier of the global cluster being deleted.

Result Syntax

[
    'GlobalCluster' => [
        'DatabaseName' => '<string>',
        'DeletionProtection' => true || false,
        'Engine' => '<string>',
        'EngineVersion' => '<string>',
        'GlobalClusterArn' => '<string>',
        'GlobalClusterIdentifier' => '<string>',
        'GlobalClusterMembers' => [
            [
                'DBClusterArn' => '<string>',
                'IsWriter' => true || false,
                'Readers' => ['<string>', ...],
            ],
            // ...
        ],
        'GlobalClusterResourceId' => '<string>',
        'Status' => '<string>',
        'StorageEncrypted' => true || false,
    ],
]

Result Details

Members

GlobalCluster

Type: GlobalCluster structure

A data type representing an Amazon DocumentDB global cluster.

Errors

GlobalClusterNotFoundFault:
The GlobalClusterIdentifier doesn't refer to an existing global cluster.
InvalidGlobalClusterStateFault:
The requested operation can't be performed while the cluster is in this state.

DescribeCertificates

$result = $client->describeCertificates([/* ... */]);
$promise = $client->describeCertificatesAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeCertificates([
    'CertificateIdentifier' => '<string>',
    'Filters' => [
        [
            'Name' => '<string>', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
]);

Parameter Details

Members

CertificateIdentifier

Type: string

The user-supplied certificate identifier. If this parameter is specified, information for only the specified certificate is returned. If this parameter is omitted, a list of up to MaxRecords certificates is returned. This parameter is not case sensitive.

Constraints

Must match an existing CertificateIdentifier.

Filters

Type: Array of Filter structures

This parameter is not currently supported.

Marker

Type: string

An optional pagination token provided by a previous DescribeCertificates request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

MaxRecords

Type: int

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints:

Minimum: 20
Maximum: 100

Result Syntax

[
    'Certificates' => [
        [
            'CertificateArn' => '<string>',
            'CertificateIdentifier' => '<string>',
            'CertificateType' => '<string>',
            'Thumbprint' => '<string>',
            'ValidFrom' => <DateTime>,
            'ValidTill' => <DateTime>,
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Members

Certificates

Type: Array of Certificate structures

A list of certificates for this Amazon Web Services account.

Marker

Type: string

An optional pagination token provided if the number of records retrieved is greater than MaxRecords. If this parameter is specified, the marker specifies the next record in the list. Including the value of Marker in the next call to DescribeCertificates results in the next page of certificates.

Errors

CertificateNotFoundFault:
CertificateIdentifier doesn't refer to an existing certificate.

DescribeDBClusterParameterGroups

$result = $client->describeDBClusterParameterGroups([/* ... */]);
$promise = $client->describeDBClusterParameterGroupsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeDBClusterParameterGroups([
    'DBClusterParameterGroupName' => '<string>',
    'Filters' => [
        [
            'Name' => '<string>', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
]);

Parameter Details

Members

DBClusterParameterGroupName

Type: string

The name of a specific cluster parameter group to return details for.

Constraints:

If provided, must match the name of an existing DBClusterParameterGroup.

Filters

Type: Array of Filter structures

This parameter is not currently supported.

Marker

Type: string

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

MaxRecords

Type: int

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Result Syntax

[
    'DBClusterParameterGroups' => [
        [
            'DBClusterParameterGroupArn' => '<string>',
            'DBClusterParameterGroupName' => '<string>',
            'DBParameterGroupFamily' => '<string>',
            'Description' => '<string>',
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Members

DBClusterParameterGroups

Type: Array of DBClusterParameterGroup structures

A list of cluster parameter groups.

Marker

Type: string

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Errors

DBParameterGroupNotFoundFault:
DBParameterGroupName doesn't refer to an existing parameter group.

DescribeDBClusterParameters

$result = $client->describeDBClusterParameters([/* ... */]);
$promise = $client->describeDBClusterParametersAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeDBClusterParameters([
    'DBClusterParameterGroupName' => '<string>', // REQUIRED
    'Filters' => [
        [
            'Name' => '<string>', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'Source' => '<string>',
]);

Parameter Details

Members

DBClusterParameterGroupName

Required: Yes
Type: string

The name of a specific cluster parameter group to return parameter details for.

Constraints:

If provided, must match the name of an existing DBClusterParameterGroup.

Filters

Type: Array of Filter structures

This parameter is not currently supported.

Marker

Type: string

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

MaxRecords

Type: int

Default: 100

Constraints: Minimum 20, maximum 100.

Source

Type: string

A value that indicates to return only parameters for a specific source. Parameter sources can be engine, service, or customer.

Result Syntax

[
    'Marker' => '<string>',
    'Parameters' => [
        [
            'AllowedValues' => '<string>',
            'ApplyMethod' => 'immediate|pending-reboot',
            'ApplyType' => '<string>',
            'DataType' => '<string>',
            'Description' => '<string>',
            'IsModifiable' => true || false,
            'MinimumEngineVersion' => '<string>',
            'ParameterName' => '<string>',
            'ParameterValue' => '<string>',
            'Source' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

Marker

Type: string

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Parameters

Type: Array of Parameter structures

Provides a list of parameters for the cluster parameter group.

Errors

DBParameterGroupNotFoundFault:
DBParameterGroupName doesn't refer to an existing parameter group.

DescribeDBClusterSnapshotAttributes

$result = $client->describeDBClusterSnapshotAttributes([/* ... */]);
$promise = $client->describeDBClusterSnapshotAttributesAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeDBClusterSnapshotAttributes([
    'DBClusterSnapshotIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members

DBClusterSnapshotIdentifier

Required: Yes
Type: string

The identifier for the cluster snapshot to describe the attributes for.

Result Syntax

[
    'DBClusterSnapshotAttributesResult' => [
        'DBClusterSnapshotAttributes' => [
            [
                'AttributeName' => '<string>',
                'AttributeValues' => ['<string>', ...],
            ],
            // ...
        ],
        'DBClusterSnapshotIdentifier' => '<string>',
    ],
]

Result Details

Members

DBClusterSnapshotAttributesResult

Type: DBClusterSnapshotAttributesResult structure

Detailed information about the attributes that are associated with a cluster snapshot.

Errors

DBClusterSnapshotNotFoundFault:
DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.

DescribeDBClusterSnapshots

$result = $client->describeDBClusterSnapshots([/* ... */]);
$promise = $client->describeDBClusterSnapshotsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeDBClusterSnapshots([
    'DBClusterIdentifier' => '<string>',
    'DBClusterSnapshotIdentifier' => '<string>',
    'Filters' => [
        [
            'Name' => '<string>', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'IncludePublic' => true || false,
    'IncludeShared' => true || false,
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'SnapshotType' => '<string>',
]);

Parameter Details

Members

DBClusterIdentifier

Type: string

The ID of the cluster to retrieve the list of cluster snapshots for. This parameter can't be used with the DBClusterSnapshotIdentifier parameter. This parameter is not case sensitive.

Constraints:

If provided, must match the identifier of an existing DBCluster.

DBClusterSnapshotIdentifier

Type: string

A specific cluster snapshot identifier to describe. This parameter can't be used with the DBClusterIdentifier parameter. This value is stored as a lowercase string.

Constraints:

If provided, must match the identifier of an existing DBClusterSnapshot.
If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

Filters

Type: Array of Filter structures

This parameter is not currently supported.

IncludePublic

Type: boolean

Set to true to include manual cluster snapshots that are public and can be copied or restored by any Amazon Web Services account, and otherwise false. The default is false.

IncludeShared

Type: boolean

Set to true to include shared manual cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore, and otherwise false. The default is false.

Marker

Type: string

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

MaxRecords

Type: int

Default: 100

Constraints: Minimum 20, maximum 100.

SnapshotType

Type: string

The type of cluster snapshots to be returned. You can specify one of the following values:

automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.
manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.
shared - Return all manual cluster snapshots that have been shared to your Amazon Web Services account.
public - Return all cluster snapshots that have been marked as public.

If you don't specify a SnapshotType value, then both automated and manual cluster snapshots are returned. You can include shared cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public cluster snapshots with these results by setting theIncludePublic parameter to true.

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.

Result Syntax

[
    'DBClusterSnapshots' => [
        [
            'AvailabilityZones' => ['<string>', ...],
            'ClusterCreateTime' => <DateTime>,
            'DBClusterIdentifier' => '<string>',
            'DBClusterSnapshotArn' => '<string>',
            'DBClusterSnapshotIdentifier' => '<string>',
            'Engine' => '<string>',
            'EngineVersion' => '<string>',
            'KmsKeyId' => '<string>',
            'MasterUsername' => '<string>',
            'PercentProgress' => <integer>,
            'Port' => <integer>,
            'SnapshotCreateTime' => <DateTime>,
            'SnapshotType' => '<string>',
            'SourceDBClusterSnapshotArn' => '<string>',
            'Status' => '<string>',
            'StorageEncrypted' => true || false,
            'VpcId' => '<string>',
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Members

DBClusterSnapshots

Type: Array of DBClusterSnapshot structures

Provides a list of cluster snapshots.

Marker

Type: string

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Errors

DBClusterSnapshotNotFoundFault:
DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.

DescribeDBClusters

$result = $client->describeDBClusters([/* ... */]);
$promise = $client->describeDBClustersAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeDBClusters([
    'DBClusterIdentifier' => '<string>',
    'Filters' => [
        [
            'Name' => '<string>', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
]);

Parameter Details

Members

DBClusterIdentifier

Type: string

The user-provided cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case sensitive.

Constraints:

If provided, must match an existing DBClusterIdentifier.

Filters

Type: Array of Filter structures

A filter that specifies one or more clusters to describe.

Supported filters:

db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list only includes information about the clusters identified by these ARNs.

Marker

Type: string

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

MaxRecords

Type: int

Default: 100

Constraints: Minimum 20, maximum 100.

Result Syntax

[
    'DBClusters' => [
        [
            'AssociatedRoles' => [
                [
                    'RoleArn' => '<string>',
                    'Status' => '<string>',
                ],
                // ...
            ],
            'AvailabilityZones' => ['<string>', ...],
            'BackupRetentionPeriod' => <integer>,
            'CloneGroupId' => '<string>',
            'ClusterCreateTime' => <DateTime>,
            'DBClusterArn' => '<string>',
            'DBClusterIdentifier' => '<string>',
            'DBClusterMembers' => [
                [
                    'DBClusterParameterGroupStatus' => '<string>',
                    'DBInstanceIdentifier' => '<string>',
                    'IsClusterWriter' => true || false,
                    'PromotionTier' => <integer>,
                ],
                // ...
            ],
            'DBClusterParameterGroup' => '<string>',
            'DBSubnetGroup' => '<string>',
            'DbClusterResourceId' => '<string>',
            'DeletionProtection' => true || false,
            'EarliestRestorableTime' => <DateTime>,
            'EnabledCloudwatchLogsExports' => ['<string>', ...],
            'Endpoint' => '<string>',
            'Engine' => '<string>',
            'EngineVersion' => '<string>',
            'HostedZoneId' => '<string>',
            'KmsKeyId' => '<string>',
            'LatestRestorableTime' => <DateTime>,
            'MasterUsername' => '<string>',
            'MultiAZ' => true || false,
            'PercentProgress' => '<string>',
            'Port' => <integer>,
            'PreferredBackupWindow' => '<string>',
            'PreferredMaintenanceWindow' => '<string>',
            'ReadReplicaIdentifiers' => ['<string>', ...],
            'ReaderEndpoint' => '<string>',
            'ReplicationSourceIdentifier' => '<string>',
            'Status' => '<string>',
            'StorageEncrypted' => true || false,
            'VpcSecurityGroups' => [
                [
                    'Status' => '<string>',
                    'VpcSecurityGroupId' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Members

DBClusters

Type: Array of DBCluster structures

A list of clusters.

Marker

Type: string

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Errors

DBClusterNotFoundFault:
DBClusterIdentifier doesn't refer to an existing cluster.

DescribeDBEngineVersions

$result = $client->describeDBEngineVersions([/* ... */]);
$promise = $client->describeDBEngineVersionsAsync([/* ... */]);

Returns a list of the available engines.

Parameter Syntax

$result = $client->describeDBEngineVersions([
    'DBParameterGroupFamily' => '<string>',
    'DefaultOnly' => true || false,
    'Engine' => '<string>',
    'EngineVersion' => '<string>',
    'Filters' => [
        [
            'Name' => '<string>', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'ListSupportedCharacterSets' => true || false,
    'ListSupportedTimezones' => true || false,
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
]);

Parameter Details

Members

DBParameterGroupFamily

Type: string

The name of a specific parameter group family to return details for.

Constraints:

If provided, must match an existing DBParameterGroupFamily.

DefaultOnly

Type: boolean

Indicates that only the default version of the specified engine or engine and major version combination is returned.

Engine

Type: string

The database engine to return.

EngineVersion

Type: string

The database engine version to return.

Example: 3.6.0

Filters

Type: Array of Filter structures

This parameter is not currently supported.

ListSupportedCharacterSets

Type: boolean

If this parameter is specified and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.

ListSupportedTimezones

Type: boolean

If this parameter is specified and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.

Marker

Type: string

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

MaxRecords

Type: int

Default: 100

Constraints: Minimum 20, maximum 100.

Result Syntax

[
    'DBEngineVersions' => [
        [
            'DBEngineDescription' => '<string>',
            'DBEngineVersionDescription' => '<string>',
            'DBParameterGroupFamily' => '<string>',
            'Engine' => '<string>',
            'EngineVersion' => '<string>',
            'ExportableLogTypes' => ['<string>', ...],
            'SupportsLogExportsToCloudwatchLogs' => true || false,
            'ValidUpgradeTarget' => [
                [
                    'AutoUpgrade' => true || false,
                    'Description' => '<string>',
                    'Engine' => '<string>',
                    'EngineVersion' => '<string>',
                    'IsMajorVersionUpgrade' => true || false,
                ],
                // ...
            ],
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Members

DBEngineVersions

Type: Array of DBEngineVersion structures

Detailed information about one or more engine versions.

Marker

Type: string

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Errors

There are no errors described for this operation.

DescribeDBInstances

$result = $client->describeDBInstances([/* ... */]);
$promise = $client->describeDBInstancesAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeDBInstances([
    'DBInstanceIdentifier' => '<string>',
    'Filters' => [
        [
            'Name' => '<string>', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
]);

Parameter Details

Members

DBInstanceIdentifier

Type: string

The user-provided instance identifier. If this parameter is specified, information from only the specific instance is returned. This parameter isn't case sensitive.

Constraints:

If provided, must match the identifier of an existing DBInstance.

Filters

Type: Array of Filter structures

A filter that specifies one or more instances to describe.

Supported filters:

db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only the information about the instances that are associated with the clusters that are identified by these ARNs.
db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only the information about the instances that are identified by these ARNs.

Marker

Type: string

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

MaxRecords

Type: int

Default: 100

Constraints: Minimum 20, maximum 100.

Result Syntax

[
    'DBInstances' => [
        [
            'AutoMinorVersionUpgrade' => true || false,
            'AvailabilityZone' => '<string>',
            'BackupRetentionPeriod' => <integer>,
            'CACertificateIdentifier' => '<string>',
            'CopyTagsToSnapshot' => true || false,
            'DBClusterIdentifier' => '<string>',
            'DBInstanceArn' => '<string>',
            'DBInstanceClass' => '<string>',
            'DBInstanceIdentifier' => '<string>',
            'DBInstanceStatus' => '<string>',
            'DBSubnetGroup' => [
                'DBSubnetGroupArn' => '<string>',
                'DBSubnetGroupDescription' => '<string>',
                'DBSubnetGroupName' => '<string>',
                'SubnetGroupStatus' => '<string>',
                'Subnets' => [
                    [
                        'SubnetAvailabilityZone' => [
                            'Name' => '<string>',
                        ],
                        'SubnetIdentifier' => '<string>',
                        'SubnetStatus' => '<string>',
                    ],
                    // ...
                ],
                'VpcId' => '<string>',
            ],
            'DbiResourceId' => '<string>',
            'EnabledCloudwatchLogsExports' => ['<string>', ...],
            'Endpoint' => [
                'Address' => '<string>',
                'HostedZoneId' => '<string>',
                'Port' => <integer>,
            ],
            'Engine' => '<string>',
            'EngineVersion' => '<string>',
            'InstanceCreateTime' => <DateTime>,
            'KmsKeyId' => '<string>',
            'LatestRestorableTime' => <DateTime>,
            'PendingModifiedValues' => [
                'AllocatedStorage' => <integer>,
                'BackupRetentionPeriod' => <integer>,
                'CACertificateIdentifier' => '<string>',
                'DBInstanceClass' => '<string>',
                'DBInstanceIdentifier' => '<string>',
                'DBSubnetGroupName' => '<string>',
                'EngineVersion' => '<string>',
                'Iops' => <integer>,
                'LicenseModel' => '<string>',
                'MasterUserPassword' => '<string>',
                'MultiAZ' => true || false,
                'PendingCloudwatchLogsExports' => [
                    'LogTypesToDisable' => ['<string>', ...],
                    'LogTypesToEnable' => ['<string>', ...],
                ],
                'Port' => <integer>,
                'StorageType' => '<string>',
            ],
            'PreferredBackupWindow' => '<string>',
            'PreferredMaintenanceWindow' => '<string>',
            'PromotionTier' => <integer>,
            'PubliclyAccessible' => true || false,
            'StatusInfos' => [
                [
                    'Message' => '<string>',
                    'Normal' => true || false,
                    'Status' => '<string>',
                    'StatusType' => '<string>',
                ],
                // ...
            ],
            'StorageEncrypted' => true || false,
            'VpcSecurityGroups' => [
                [
                    'Status' => '<string>',
                    'VpcSecurityGroupId' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Members

DBInstances

Type: Array of DBInstance structures

Detailed information about one or more instances.

Marker

Type: string

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Errors

DBInstanceNotFoundFault:
DBInstanceIdentifier doesn't refer to an existing instance.

DescribeDBSubnetGroups

$result = $client->describeDBSubnetGroups([/* ... */]);
$promise = $client->describeDBSubnetGroupsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeDBSubnetGroups([
    'DBSubnetGroupName' => '<string>',
    'Filters' => [
        [
            'Name' => '<string>', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
]);

Parameter Details

Members

DBSubnetGroupName

Type: string

The name of the subnet group to return details for.

Filters

Type: Array of Filter structures

This parameter is not currently supported.

Marker

Type: string

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

MaxRecords

Type: int

Default: 100

Constraints: Minimum 20, maximum 100.

Result Syntax

[
    'DBSubnetGroups' => [
        [
            'DBSubnetGroupArn' => '<string>',
            'DBSubnetGroupDescription' => '<string>',
            'DBSubnetGroupName' => '<string>',
            'SubnetGroupStatus' => '<string>',
            'Subnets' => [
                [
                    'SubnetAvailabilityZone' => [
                        'Name' => '<string>',
                    ],
                    'SubnetIdentifier' => '<string>',
                    'SubnetStatus' => '<string>',
                ],
                // ...
            ],
            'VpcId' => '<string>',
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Members

DBSubnetGroups

Type: Array of DBSubnetGroup structures

Detailed information about one or more subnet groups.

Marker

Type: string

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Errors

DBSubnetGroupNotFoundFault:
DBSubnetGroupName doesn't refer to an existing subnet group.

DescribeEngineDefaultClusterParameters

$result = $client->describeEngineDefaultClusterParameters([/* ... */]);
$promise = $client->describeEngineDefaultClusterParametersAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeEngineDefaultClusterParameters([
    'DBParameterGroupFamily' => '<string>', // REQUIRED
    'Filters' => [
        [
            'Name' => '<string>', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
]);

Parameter Details

Members

DBParameterGroupFamily

Required: Yes
Type: string

The name of the cluster parameter group family to return the engine parameter information for.

Filters

Type: Array of Filter structures

This parameter is not currently supported.

Marker

Type: string

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

MaxRecords

Type: int

Default: 100

Constraints: Minimum 20, maximum 100.

Result Syntax

[
    'EngineDefaults' => [
        'DBParameterGroupFamily' => '<string>',
        'Marker' => '<string>',
        'Parameters' => [
            [
                'AllowedValues' => '<string>',
                'ApplyMethod' => 'immediate|pending-reboot',
                'ApplyType' => '<string>',
                'DataType' => '<string>',
                'Description' => '<string>',
                'IsModifiable' => true || false,
                'MinimumEngineVersion' => '<string>',
                'ParameterName' => '<string>',
                'ParameterValue' => '<string>',
                'Source' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members

EngineDefaults

Type: EngineDefaults structure

Contains the result of a successful invocation of the DescribeEngineDefaultClusterParameters operation.

Errors

There are no errors described for this operation.

DescribeEventCategories

$result = $client->describeEventCategories([/* ... */]);
$promise = $client->describeEventCategoriesAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeEventCategories([
    'Filters' => [
        [
            'Name' => '<string>', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'SourceType' => '<string>',
]);

Parameter Details

Members

Filters

Type: Array of Filter structures

This parameter is not currently supported.

SourceType

Type: string

The type of source that is generating the events.

Valid values: db-instance, db-parameter-group, db-security-group

Result Syntax

[
    'EventCategoriesMapList' => [
        [
            'EventCategories' => ['<string>', ...],
            'SourceType' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

EventCategoriesMapList

Type: Array of EventCategoriesMap structures

A list of event category maps.

Errors

There are no errors described for this operation.

DescribeEventSubscriptions

$result = $client->describeEventSubscriptions([/* ... */]);
$promise = $client->describeEventSubscriptionsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeEventSubscriptions([
    'Filters' => [
        [
            'Name' => '<string>', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'SubscriptionName' => '<string>',
]);

Parameter Details

Members

Filters

Type: Array of Filter structures

This parameter is not currently supported.

Marker

Type: string

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

MaxRecords

Type: int

Default: 100

Constraints: Minimum 20, maximum 100.

SubscriptionName

Type: string

The name of the Amazon DocumentDB event notification subscription that you want to describe.

Result Syntax

[
    'EventSubscriptionsList' => [
        [
            'CustSubscriptionId' => '<string>',
            'CustomerAwsId' => '<string>',
            'Enabled' => true || false,
            'EventCategoriesList' => ['<string>', ...],
            'EventSubscriptionArn' => '<string>',
            'SnsTopicArn' => '<string>',
            'SourceIdsList' => ['<string>', ...],
            'SourceType' => '<string>',
            'Status' => '<string>',
            'SubscriptionCreationTime' => '<string>',
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Members

EventSubscriptionsList

Type: Array of EventSubscription structures

A list of event subscriptions.

Marker

Type: string

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Errors

SubscriptionNotFoundFault:
The subscription name does not exist.

DescribeEvents

$result = $client->describeEvents([/* ... */]);
$promise = $client->describeEventsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeEvents([
    'Duration' => <integer>,
    'EndTime' => <integer || string || DateTime>,
    'EventCategories' => ['<string>', ...],
    'Filters' => [
        [
            'Name' => '<string>', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'SourceIdentifier' => '<string>',
    'SourceType' => 'db-instance|db-parameter-group|db-security-group|db-snapshot|db-cluster|db-cluster-snapshot',
    'StartTime' => <integer || string || DateTime>,
]);

Parameter Details

Members

Duration

Type: int

The number of minutes to retrieve events for.

Default: 60

EndTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The end of the time interval for which to retrieve events, specified in ISO 8601 format.

Example: 2009-07-08T18:00Z

EventCategories

Type: Array of strings

A list of event categories that trigger notifications for an event notification subscription.

Filters

Type: Array of Filter structures

This parameter is not currently supported.

Marker

Type: string

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

MaxRecords

Type: int

Default: 100

Constraints: Minimum 20, maximum 100.

SourceIdentifier

Type: string

The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.

Constraints:

If SourceIdentifier is provided, SourceType must also be provided.
If the source type is DBInstance, a DBInstanceIdentifier must be provided.
If the source type is DBSecurityGroup, a DBSecurityGroupName must be provided.
If the source type is DBParameterGroup, a DBParameterGroupName must be provided.
If the source type is DBSnapshot, a DBSnapshotIdentifier must be provided.
Cannot end with a hyphen or contain two consecutive hyphens.

SourceType

Type: string

The event source to retrieve events for. If no value is specified, all events are returned.

StartTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

Example: 2009-07-08T18:00Z

Result Syntax

[
    'Events' => [
        [
            'Date' => <DateTime>,
            'EventCategories' => ['<string>', ...],
            'Message' => '<string>',
            'SourceArn' => '<string>',
            'SourceIdentifier' => '<string>',
            'SourceType' => 'db-instance|db-parameter-group|db-security-group|db-snapshot|db-cluster|db-cluster-snapshot',
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Members

Events

Type: Array of Event structures

Detailed information about one or more events.

Marker

Type: string

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Errors

There are no errors described for this operation.

DescribeGlobalClusters

$result = $client->describeGlobalClusters([/* ... */]);
$promise = $client->describeGlobalClustersAsync([/* ... */]);

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

This action only applies to Amazon DocumentDB clusters.

Parameter Syntax

$result = $client->describeGlobalClusters([
    'Filters' => [
        [
            'Name' => '<string>', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'GlobalClusterIdentifier' => '<string>',
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
]);

Parameter Details

Members

Filters

Type: Array of Filter structures

A filter that specifies one or more global DB clusters to describe.

Supported filters: db-cluster-id accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list will only include information about the clusters identified by these ARNs.

GlobalClusterIdentifier

Type: string

The user-supplied cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case-sensitive.

Marker

Type: string

An optional pagination token provided by a previous DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

MaxRecords

Type: int

Result Syntax

[
    'GlobalClusters' => [
        [
            'DatabaseName' => '<string>',
            'DeletionProtection' => true || false,
            'Engine' => '<string>',
            'EngineVersion' => '<string>',
            'GlobalClusterArn' => '<string>',
            'GlobalClusterIdentifier' => '<string>',
            'GlobalClusterMembers' => [
                [
                    'DBClusterArn' => '<string>',
                    'IsWriter' => true || false,
                    'Readers' => ['<string>', ...],
                ],
                // ...
            ],
            'GlobalClusterResourceId' => '<string>',
            'Status' => '<string>',
            'StorageEncrypted' => true || false,
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Members

GlobalClusters

Type: Array of GlobalCluster structures

Marker

Type: string

Errors

GlobalClusterNotFoundFault:
The GlobalClusterIdentifier doesn't refer to an existing global cluster.

DescribeOrderableDBInstanceOptions

$result = $client->describeOrderableDBInstanceOptions([/* ... */]);
$promise = $client->describeOrderableDBInstanceOptionsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeOrderableDBInstanceOptions([
    'DBInstanceClass' => '<string>',
    'Engine' => '<string>', // REQUIRED
    'EngineVersion' => '<string>',
    'Filters' => [
        [
            'Name' => '<string>', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'LicenseModel' => '<string>',
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'Vpc' => true || false,
]);

Parameter Details

Members

DBInstanceClass

Type: string

The instance class filter value. Specify this parameter to show only the available offerings that match the specified instance class.

Engine

Required: Yes
Type: string

The name of the engine to retrieve instance options for.

EngineVersion

Type: string

The engine version filter value. Specify this parameter to show only the available offerings that match the specified engine version.

Filters

Type: Array of Filter structures

This parameter is not currently supported.

LicenseModel

Type: string

The license model filter value. Specify this parameter to show only the available offerings that match the specified license model.

Marker

Type: string

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

MaxRecords

Type: int

Default: 100

Constraints: Minimum 20, maximum 100.

Vpc

Type: boolean

The virtual private cloud (VPC) filter value. Specify this parameter to show only the available VPC or non-VPC offerings.

Result Syntax

[
    'Marker' => '<string>',
    'OrderableDBInstanceOptions' => [
        [
            'AvailabilityZones' => [
                [
                    'Name' => '<string>',
                ],
                // ...
            ],
            'DBInstanceClass' => '<string>',
            'Engine' => '<string>',
            'EngineVersion' => '<string>',
            'LicenseModel' => '<string>',
            'Vpc' => true || false,
        ],
        // ...
    ],
]

Result Details

Members

Marker

Type: string

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

OrderableDBInstanceOptions

Type: Array of OrderableDBInstanceOption structures

The options that are available for a particular orderable instance.

Errors

There are no errors described for this operation.

DescribePendingMaintenanceActions

$result = $client->describePendingMaintenanceActions([/* ... */]);
$promise = $client->describePendingMaintenanceActionsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describePendingMaintenanceActions([
    'Filters' => [
        [
            'Name' => '<string>', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'Marker' => '<string>',
    'MaxRecords' => <integer>,
    'ResourceIdentifier' => '<string>',
]);

Parameter Details

Members

Filters

Type: Array of Filter structures

A filter that specifies one or more resources to return pending maintenance actions for.

Supported filters:

db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only pending maintenance actions for the clusters identified by these ARNs.
db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only pending maintenance actions for the DB instances identified by these ARNs.

Marker

Type: string

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

MaxRecords

Type: int

Default: 100

Constraints: Minimum 20, maximum 100.

ResourceIdentifier

Type: string

The ARN of a resource to return pending maintenance actions for.

Result Syntax

[
    'Marker' => '<string>',
    'PendingMaintenanceActions' => [
        [
            'PendingMaintenanceActionDetails' => [
                [
                    'Action' => '<string>',
                    'AutoAppliedAfterDate' => <DateTime>,
                    'CurrentApplyDate' => <DateTime>,
                    'Description' => '<string>',
                    'ForcedApplyDate' => <DateTime>,
                    'OptInStatus' => '<string>',
                ],
                // ...
            ],
            'ResourceIdentifier' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

Marker

Type: string

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

PendingMaintenanceActions

Type: Array of ResourcePendingMaintenanceActions structures

The maintenance actions to be applied.

Errors

ResourceNotFoundFault:
The specified resource ID was not found.

FailoverDBCluster

$result = $client->failoverDBCluster([/* ... */]);
$promise = $client->failoverDBClusterAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->failoverDBCluster([
    'DBClusterIdentifier' => '<string>',
    'TargetDBInstanceIdentifier' => '<string>',
]);

Parameter Details

Members

DBClusterIdentifier

Type: string

A cluster identifier to force a failover for. This parameter is not case sensitive.

Constraints:

Must match the identifier of an existing DBCluster.

TargetDBInstanceIdentifier

Type: string

The name of the instance to promote to the primary instance.

You must specify the instance identifier for an Amazon DocumentDB replica in the cluster. For example, mydbcluster-replica1.

Result Syntax

[
    'DBCluster' => [
        'AssociatedRoles' => [
            [
                'RoleArn' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'AvailabilityZones' => ['<string>', ...],
        'BackupRetentionPeriod' => <integer>,
        'CloneGroupId' => '<string>',
        'ClusterCreateTime' => <DateTime>,
        'DBClusterArn' => '<string>',
        'DBClusterIdentifier' => '<string>',
        'DBClusterMembers' => [
            [
                'DBClusterParameterGroupStatus' => '<string>',
                'DBInstanceIdentifier' => '<string>',
                'IsClusterWriter' => true || false,
                'PromotionTier' => <integer>,
            ],
            // ...
        ],
        'DBClusterParameterGroup' => '<string>',
        'DBSubnetGroup' => '<string>',
        'DbClusterResourceId' => '<string>',
        'DeletionProtection' => true || false,
        'EarliestRestorableTime' => <DateTime>,
        'EnabledCloudwatchLogsExports' => ['<string>', ...],
        'Endpoint' => '<string>',
        'Engine' => '<string>',
        'EngineVersion' => '<string>',
        'HostedZoneId' => '<string>',
        'KmsKeyId' => '<string>',
        'LatestRestorableTime' => <DateTime>,
        'MasterUsername' => '<string>',
        'MultiAZ' => true || false,
        'PercentProgress' => '<string>',
        'Port' => <integer>,
        'PreferredBackupWindow' => '<string>',
        'PreferredMaintenanceWindow' => '<string>',
        'ReadReplicaIdentifiers' => ['<string>', ...],
        'ReaderEndpoint' => '<string>',
        'ReplicationSourceIdentifier' => '<string>',
        'Status' => '<string>',
        'StorageEncrypted' => true || false,
        'VpcSecurityGroups' => [
            [
                'Status' => '<string>',
                'VpcSecurityGroupId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members

DBCluster

Type: DBCluster structure

Detailed information about a cluster.

Errors

DBClusterNotFoundFault:
DBClusterIdentifier doesn't refer to an existing cluster.
InvalidDBClusterStateFault:
The cluster isn't in a valid state.
InvalidDBInstanceStateFault:
The specified instance isn't in the available state.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists all tags on an Amazon DocumentDB resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'Filters' => [
        [
            'Name' => '<string>', // REQUIRED
            'Values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'ResourceName' => '<string>', // REQUIRED
]);

Parameter Details

Members

Filters

Type: Array of Filter structures

This parameter is not currently supported.

ResourceName

Required: Yes
Type: string

The Amazon DocumentDB resource with tags to be listed. This value is an Amazon Resource Name (ARN).

Result Syntax

[
    'TagList' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

TagList

Type: Array of Tag structures

A list of one or more tags.

Errors

DBInstanceNotFoundFault:
DBInstanceIdentifier doesn't refer to an existing instance.
DBSnapshotNotFoundFault:
DBSnapshotIdentifier doesn't refer to an existing snapshot.
DBClusterNotFoundFault:
DBClusterIdentifier doesn't refer to an existing cluster.

ModifyDBCluster

$result = $client->modifyDBCluster([/* ... */]);
$promise = $client->modifyDBClusterAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->modifyDBCluster([
    'ApplyImmediately' => true || false,
    'BackupRetentionPeriod' => <integer>,
    'CloudwatchLogsExportConfiguration' => [
        'DisableLogTypes' => ['<string>', ...],
        'EnableLogTypes' => ['<string>', ...],
    ],
    'DBClusterIdentifier' => '<string>', // REQUIRED
    'DBClusterParameterGroupName' => '<string>',
    'DeletionProtection' => true || false,
    'EngineVersion' => '<string>',
    'MasterUserPassword' => '<string>',
    'NewDBClusterIdentifier' => '<string>',
    'Port' => <integer>,
    'PreferredBackupWindow' => '<string>',
    'PreferredMaintenanceWindow' => '<string>',
    'VpcSecurityGroupIds' => ['<string>', ...],
]);

Parameter Details

Members

ApplyImmediately

Type: boolean

A value that specifies whether the changes in this request and any pending changes are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cluster. If this parameter is set to false, changes to the cluster are applied during the next maintenance window.

The ApplyImmediately parameter affects only the NewDBClusterIdentifier and MasterUserPassword values. If you set this parameter value to false, the changes to the NewDBClusterIdentifier and MasterUserPassword values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

Default: false

BackupRetentionPeriod

Type: int

The number of days for which automated backups are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

Must be a value from 1 to 35.

CloudwatchLogsExportConfiguration

Type: CloudwatchLogsExportConfiguration structure

The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster. The EnableLogTypes and DisableLogTypes arrays determine which logs are exported (or not exported) to CloudWatch Logs.

DBClusterIdentifier

Required: Yes
Type: string

The cluster identifier for the cluster that is being modified. This parameter is not case sensitive.

Constraints:

Must match the identifier of an existing DBCluster.

DBClusterParameterGroupName

Type: string

The name of the cluster parameter group to use for the cluster.

DeletionProtection

Type: boolean

EngineVersion

Type: string

The version number of the database engine to which you want to upgrade. Modifying engine version is not supported on Amazon DocumentDB.

MasterUserPassword

Type: string

The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

Constraints: Must contain from 8 to 100 characters.

NewDBClusterIdentifier

Type: string

The new cluster identifier for the cluster when renaming a cluster. This value is stored as a lowercase string.

Constraints:

Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster2

Port

Type: int

The port number on which the cluster accepts connections.

Constraints: Must be a value from 1150 to 65535.

Default: The same port as the original cluster.

PreferredBackupWindow

Type: string

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region.

Constraints:

Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.

PreferredMaintenanceWindow

Type: string

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

VpcSecurityGroupIds

Type: Array of strings

A list of virtual private cloud (VPC) security groups that the cluster will belong to.

Result Syntax

[
    'DBCluster' => [
        'AssociatedRoles' => [
            [
                'RoleArn' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'AvailabilityZones' => ['<string>', ...],
        'BackupRetentionPeriod' => <integer>,
        'CloneGroupId' => '<string>',
        'ClusterCreateTime' => <DateTime>,
        'DBClusterArn' => '<string>',
        'DBClusterIdentifier' => '<string>',
        'DBClusterMembers' => [
            [
                'DBClusterParameterGroupStatus' => '<string>',
                'DBInstanceIdentifier' => '<string>',
                'IsClusterWriter' => true || false,
                'PromotionTier' => <integer>,
            ],
            // ...
        ],
        'DBClusterParameterGroup' => '<string>',
        'DBSubnetGroup' => '<string>',
        'DbClusterResourceId' => '<string>',
        'DeletionProtection' => true || false,
        'EarliestRestorableTime' => <DateTime>,
        'EnabledCloudwatchLogsExports' => ['<string>', ...],
        'Endpoint' => '<string>',
        'Engine' => '<string>',
        'EngineVersion' => '<string>',
        'HostedZoneId' => '<string>',
        'KmsKeyId' => '<string>',
        'LatestRestorableTime' => <DateTime>,
        'MasterUsername' => '<string>',
        'MultiAZ' => true || false,
        'PercentProgress' => '<string>',
        'Port' => <integer>,
        'PreferredBackupWindow' => '<string>',
        'PreferredMaintenanceWindow' => '<string>',
        'ReadReplicaIdentifiers' => ['<string>', ...],
        'ReaderEndpoint' => '<string>',
        'ReplicationSourceIdentifier' => '<string>',
        'Status' => '<string>',
        'StorageEncrypted' => true || false,
        'VpcSecurityGroups' => [
            [
                'Status' => '<string>',
                'VpcSecurityGroupId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members

DBCluster

Type: DBCluster structure

Detailed information about a cluster.

Errors

DBClusterNotFoundFault:
DBClusterIdentifier doesn't refer to an existing cluster.
InvalidDBClusterStateFault:
The cluster isn't in a valid state.
StorageQuotaExceededFault:
The request would cause you to exceed the allowed amount of storage available across all instances.
DBSubnetGroupNotFoundFault:
DBSubnetGroupName doesn't refer to an existing subnet group.
InvalidVPCNetworkStateFault:
The subnet group doesn't cover all Availability Zones after it is created because of changes that were made.
InvalidDBSubnetGroupStateFault:
The subnet group can't be deleted because it's in use.
InvalidSubnet:
The requested subnet is not valid, or multiple subnets were requested that are not all in a common virtual private cloud (VPC).
DBClusterParameterGroupNotFoundFault:
DBClusterParameterGroupName doesn't refer to an existing cluster parameter group.
InvalidDBSecurityGroupStateFault:
The state of the security group doesn't allow deletion.
InvalidDBInstanceStateFault:
The specified instance isn't in the available state.
DBClusterAlreadyExistsFault:
You already have a cluster with the given identifier.

ModifyDBClusterParameterGroup

$result = $client->modifyDBClusterParameterGroup([/* ... */]);
$promise = $client->modifyDBClusterParameterGroupAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->modifyDBClusterParameterGroup([
    'DBClusterParameterGroupName' => '<string>', // REQUIRED
    'Parameters' => [ // REQUIRED
        [
            'AllowedValues' => '<string>',
            'ApplyMethod' => 'immediate|pending-reboot',
            'ApplyType' => '<string>',
            'DataType' => '<string>',
            'Description' => '<string>',
            'IsModifiable' => true || false,
            'MinimumEngineVersion' => '<string>',
            'ParameterName' => '<string>',
            'ParameterValue' => '<string>',
            'Source' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members

DBClusterParameterGroupName

Required: Yes
Type: string

The name of the cluster parameter group to modify.

Parameters

Required: Yes
Type: Array of Parameter structures

A list of parameters in the cluster parameter group to modify.

Result Syntax

[
    'DBClusterParameterGroupName' => '<string>',
]

Result Details

Members

DBClusterParameterGroupName

Type: string

The name of a cluster parameter group.

Constraints:

Must be from 1 to 255 letters or numbers.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.

This value is stored as a lowercase string.

Errors

DBParameterGroupNotFoundFault:
DBParameterGroupName doesn't refer to an existing parameter group.
InvalidDBParameterGroupStateFault:
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.

ModifyDBClusterSnapshotAttribute

$result = $client->modifyDBClusterSnapshotAttribute([/* ... */]);
$promise = $client->modifyDBClusterSnapshotAttributeAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->modifyDBClusterSnapshotAttribute([
    'AttributeName' => '<string>', // REQUIRED
    'DBClusterSnapshotIdentifier' => '<string>', // REQUIRED
    'ValuesToAdd' => ['<string>', ...],
    'ValuesToRemove' => ['<string>', ...],
]);

Parameter Details

Members

AttributeName

Required: Yes
Type: string

The name of the cluster snapshot attribute to modify.

To manage authorization for other Amazon Web Services accounts to copy or restore a manual cluster snapshot, set this value to restore.

DBClusterSnapshotIdentifier

Required: Yes
Type: string

The identifier for the cluster snapshot to modify the attributes for.

ValuesToAdd

Type: Array of strings

A list of cluster snapshot attributes to add to the attribute specified by AttributeName.

To authorize other Amazon Web Services accounts to copy or restore a manual cluster snapshot, set this list to include one or more Amazon Web Services account IDs. To make the manual cluster snapshot restorable by any Amazon Web Services account, set it to all. Do not add the all value for any manual cluster snapshots that contain private information that you don't want to be available to all Amazon Web Services accounts.

ValuesToRemove

Type: Array of strings

A list of cluster snapshot attributes to remove from the attribute specified by AttributeName.

To remove authorization for other Amazon Web Services accounts to copy or restore a manual cluster snapshot, set this list to include one or more Amazon Web Services account identifiers. To remove authorization for any Amazon Web Services account to copy or restore the cluster snapshot, set it to all . If you specify all, an Amazon Web Services account whose account ID is explicitly added to the restore attribute can still copy or restore a manual cluster snapshot.

Result Syntax

[
    'DBClusterSnapshotAttributesResult' => [
        'DBClusterSnapshotAttributes' => [
            [
                'AttributeName' => '<string>',
                'AttributeValues' => ['<string>', ...],
            ],
            // ...
        ],
        'DBClusterSnapshotIdentifier' => '<string>',
    ],
]

Result Details

Members

DBClusterSnapshotAttributesResult

Type: DBClusterSnapshotAttributesResult structure

Detailed information about the attributes that are associated with a cluster snapshot.

Errors

DBClusterSnapshotNotFoundFault:
DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.
InvalidDBClusterSnapshotStateFault:
The provided value isn't a valid cluster snapshot state.
SharedSnapshotQuotaExceededFault:
You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.

ModifyDBInstance

$result = $client->modifyDBInstance([/* ... */]);
$promise = $client->modifyDBInstanceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->modifyDBInstance([
    'ApplyImmediately' => true || false,
    'AutoMinorVersionUpgrade' => true || false,
    'CACertificateIdentifier' => '<string>',
    'CopyTagsToSnapshot' => true || false,
    'DBInstanceClass' => '<string>',
    'DBInstanceIdentifier' => '<string>', // REQUIRED
    'EnablePerformanceInsights' => true || false,
    'NewDBInstanceIdentifier' => '<string>',
    'PerformanceInsightsKMSKeyId' => '<string>',
    'PreferredMaintenanceWindow' => '<string>',
    'PromotionTier' => <integer>,
]);

Parameter Details

Members

ApplyImmediately

Type: boolean

Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the instance.

If this parameter is set to false, changes to the instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next reboot.

Default: false

AutoMinorVersionUpgrade

Type: boolean

This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

CACertificateIdentifier

Type: string

Indicates the certificate that needs to be associated with the instance.

CopyTagsToSnapshot

Type: boolean

A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

DBInstanceClass

Type: string

The new compute and memory capacity of the instance; for example, db.r5.large. Not all instance classes are available in all Amazon Web Services Regions.

If you modify the instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request.

Default: Uses existing setting.

DBInstanceIdentifier

Required: Yes
Type: string

The instance identifier. This value is stored as a lowercase string.

Constraints:

Must match the identifier of an existing DBInstance.

EnablePerformanceInsights

Type: boolean

A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights.

NewDBInstanceIdentifier

Type: string

The new instance identifier for the instance when renaming an instance. When you change the instance identifier, an instance reboot occurs immediately if you set Apply Immediately to true. It occurs during the next maintenance window if you set Apply Immediately to false. This value is stored as a lowercase string.

Constraints:

Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

PerformanceInsightsKMSKeyId

Type: string

The KMS key identifier for encryption of Performance Insights data.

The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

PreferredMaintenanceWindow

Type: string

The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, changing this parameter causes a reboot of the instance. If you are moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure that pending changes are applied.

Default: Uses existing setting.

Format: ddd:hh24:mi-ddd:hh24:mi

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Must be at least 30 minutes.

PromotionTier

Type: int

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

Default: 1

Valid values: 0-15

Result Syntax

[
    'DBInstance' => [
        'AutoMinorVersionUpgrade' => true || false,
        'AvailabilityZone' => '<string>',
        'BackupRetentionPeriod' => <integer>,
        'CACertificateIdentifier' => '<string>',
        'CopyTagsToSnapshot' => true || false,
        'DBClusterIdentifier' => '<string>',
        'DBInstanceArn' => '<string>',
        'DBInstanceClass' => '<string>',
        'DBInstanceIdentifier' => '<string>',
        'DBInstanceStatus' => '<string>',
        'DBSubnetGroup' => [
            'DBSubnetGroupArn' => '<string>',
            'DBSubnetGroupDescription' => '<string>',
            'DBSubnetGroupName' => '<string>',
            'SubnetGroupStatus' => '<string>',
            'Subnets' => [
                [
                    'SubnetAvailabilityZone' => [
                        'Name' => '<string>',
                    ],
                    'SubnetIdentifier' => '<string>',
                    'SubnetStatus' => '<string>',
                ],
                // ...
            ],
            'VpcId' => '<string>',
        ],
        'DbiResourceId' => '<string>',
        'EnabledCloudwatchLogsExports' => ['<string>', ...],
        'Endpoint' => [
            'Address' => '<string>',
            'HostedZoneId' => '<string>',
            'Port' => <integer>,
        ],
        'Engine' => '<string>',
        'EngineVersion' => '<string>',
        'InstanceCreateTime' => <DateTime>,
        'KmsKeyId' => '<string>',
        'LatestRestorableTime' => <DateTime>,
        'PendingModifiedValues' => [
            'AllocatedStorage' => <integer>,
            'BackupRetentionPeriod' => <integer>,
            'CACertificateIdentifier' => '<string>',
            'DBInstanceClass' => '<string>',
            'DBInstanceIdentifier' => '<string>',
            'DBSubnetGroupName' => '<string>',
            'EngineVersion' => '<string>',
            'Iops' => <integer>,
            'LicenseModel' => '<string>',
            'MasterUserPassword' => '<string>',
            'MultiAZ' => true || false,
            'PendingCloudwatchLogsExports' => [
                'LogTypesToDisable' => ['<string>', ...],
                'LogTypesToEnable' => ['<string>', ...],
            ],
            'Port' => <integer>,
            'StorageType' => '<string>',
        ],
        'PreferredBackupWindow' => '<string>',
        'PreferredMaintenanceWindow' => '<string>',
        'PromotionTier' => <integer>,
        'PubliclyAccessible' => true || false,
        'StatusInfos' => [
            [
                'Message' => '<string>',
                'Normal' => true || false,
                'Status' => '<string>',
                'StatusType' => '<string>',
            ],
            // ...
        ],
        'StorageEncrypted' => true || false,
        'VpcSecurityGroups' => [
            [
                'Status' => '<string>',
                'VpcSecurityGroupId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members

DBInstance

Type: DBInstance structure

Detailed information about an instance.

Errors

InvalidDBInstanceStateFault:
The specified instance isn't in the available state.
InvalidDBSecurityGroupStateFault:
The state of the security group doesn't allow deletion.
DBInstanceAlreadyExistsFault:
You already have a instance with the given identifier.
DBInstanceNotFoundFault:
DBInstanceIdentifier doesn't refer to an existing instance.
DBSecurityGroupNotFoundFault:
DBSecurityGroupName doesn't refer to an existing security group.
DBParameterGroupNotFoundFault:
DBParameterGroupName doesn't refer to an existing parameter group.
InsufficientDBInstanceCapacityFault:
The specified instance class isn't available in the specified Availability Zone.
StorageQuotaExceededFault:
The request would cause you to exceed the allowed amount of storage available across all instances.
InvalidVPCNetworkStateFault:
The subnet group doesn't cover all Availability Zones after it is created because of changes that were made.
DBUpgradeDependencyFailureFault:
The upgrade failed because a resource that the depends on can't be modified.
StorageTypeNotSupportedFault:
Storage of the specified StorageType can't be associated with the DB instance.
AuthorizationNotFoundFault:
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.
CertificateNotFoundFault:
CertificateIdentifier doesn't refer to an existing certificate.

ModifyDBSubnetGroup

$result = $client->modifyDBSubnetGroup([/* ... */]);
$promise = $client->modifyDBSubnetGroupAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->modifyDBSubnetGroup([
    'DBSubnetGroupDescription' => '<string>',
    'DBSubnetGroupName' => '<string>', // REQUIRED
    'SubnetIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

DBSubnetGroupDescription

Type: string

The description for the subnet group.

DBSubnetGroupName

Required: Yes
Type: string

The name for the subnet group. This value is stored as a lowercase string. You can't modify the default subnet group.

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mySubnetgroup

SubnetIds

Required: Yes
Type: Array of strings

The Amazon EC2 subnet IDs for the subnet group.

Result Syntax

[
    'DBSubnetGroup' => [
        'DBSubnetGroupArn' => '<string>',
        'DBSubnetGroupDescription' => '<string>',
        'DBSubnetGroupName' => '<string>',
        'SubnetGroupStatus' => '<string>',
        'Subnets' => [
            [
                'SubnetAvailabilityZone' => [
                    'Name' => '<string>',
                ],
                'SubnetIdentifier' => '<string>',
                'SubnetStatus' => '<string>',
            ],
            // ...
        ],
        'VpcId' => '<string>',
    ],
]

Result Details

Members

DBSubnetGroup

Type: DBSubnetGroup structure

Detailed information about a subnet group.

Errors

DBSubnetGroupNotFoundFault:
DBSubnetGroupName doesn't refer to an existing subnet group.
DBSubnetQuotaExceededFault:
The request would cause you to exceed the allowed number of subnets in a subnet group.
SubnetAlreadyInUse:
The subnet is already in use in the Availability Zone.
DBSubnetGroupDoesNotCoverEnoughAZs:
Subnets in the subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
InvalidSubnet:
The requested subnet is not valid, or multiple subnets were requested that are not all in a common virtual private cloud (VPC).

ModifyEventSubscription

$result = $client->modifyEventSubscription([/* ... */]);
$promise = $client->modifyEventSubscriptionAsync([/* ... */]);

Modifies an existing Amazon DocumentDB event notification subscription.

Parameter Syntax

$result = $client->modifyEventSubscription([
    'Enabled' => true || false,
    'EventCategories' => ['<string>', ...],
    'SnsTopicArn' => '<string>',
    'SourceType' => '<string>',
    'SubscriptionName' => '<string>', // REQUIRED
]);

Parameter Details

Members

Enabled

Type: boolean

A Boolean value; set to true to activate the subscription.

EventCategories

Type: Array of strings

A list of event categories for a SourceType that you want to subscribe to.

SnsTopicArn

Type: string

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

SourceType

Type: string

The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, set this parameter to db-instance. If this value is not specified, all events are returned.

Valid values: db-instance, db-parameter-group, db-security-group

SubscriptionName

Required: Yes
Type: string

The name of the Amazon DocumentDB event notification subscription.

Result Syntax

[
    'EventSubscription' => [
        'CustSubscriptionId' => '<string>',
        'CustomerAwsId' => '<string>',
        'Enabled' => true || false,
        'EventCategoriesList' => ['<string>', ...],
        'EventSubscriptionArn' => '<string>',
        'SnsTopicArn' => '<string>',
        'SourceIdsList' => ['<string>', ...],
        'SourceType' => '<string>',
        'Status' => '<string>',
        'SubscriptionCreationTime' => '<string>',
    ],
]

Result Details

Members

EventSubscription

Type: EventSubscription structure

Detailed information about an event to which you have subscribed.

Errors

EventSubscriptionQuotaExceededFault:
You have reached the maximum number of event subscriptions.
SubscriptionNotFoundFault:
The subscription name does not exist.
SNSInvalidTopicFault:
Amazon SNS has responded that there is a problem with the specified topic.
SNSNoAuthorizationFault:
You do not have permission to publish to the SNS topic Amazon Resource Name (ARN).
SNSTopicArnNotFoundFault:
The SNS topic Amazon Resource Name (ARN) does not exist.
SubscriptionCategoryNotFoundFault:
The provided category does not exist.

ModifyGlobalCluster

$result = $client->modifyGlobalCluster([/* ... */]);
$promise = $client->modifyGlobalClusterAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->modifyGlobalCluster([
    'DeletionProtection' => true || false,
    'GlobalClusterIdentifier' => '<string>', // REQUIRED
    'NewGlobalClusterIdentifier' => '<string>',
]);

Parameter Details

Members

DeletionProtection

Type: boolean

Indicates if the global cluster has deletion protection enabled. The global cluster can't be deleted when deletion protection is enabled.

GlobalClusterIdentifier

Required: Yes
Type: string

The identifier for the global cluster being modified. This parameter isn't case-sensitive.

Constraints:

Must match the identifier of an existing global cluster.

NewGlobalClusterIdentifier

Type: string

The new identifier for a global cluster when you modify a global cluster. This value is stored as a lowercase string.

Must contain from 1 to 63 letters, numbers, or hyphens

The first character must be a letter

Can't end with a hyphen or contain two consecutive hyphens

Example: my-cluster2

Result Syntax

[
    'GlobalCluster' => [
        'DatabaseName' => '<string>',
        'DeletionProtection' => true || false,
        'Engine' => '<string>',
        'EngineVersion' => '<string>',
        'GlobalClusterArn' => '<string>',
        'GlobalClusterIdentifier' => '<string>',
        'GlobalClusterMembers' => [
            [
                'DBClusterArn' => '<string>',
                'IsWriter' => true || false,
                'Readers' => ['<string>', ...],
            ],
            // ...
        ],
        'GlobalClusterResourceId' => '<string>',
        'Status' => '<string>',
        'StorageEncrypted' => true || false,
    ],
]

Result Details

Members

GlobalCluster

Type: GlobalCluster structure

A data type representing an Amazon DocumentDB global cluster.

Errors

GlobalClusterNotFoundFault:
The GlobalClusterIdentifier doesn't refer to an existing global cluster.
InvalidGlobalClusterStateFault:
The requested operation can't be performed while the cluster is in this state.

RebootDBInstance

$result = $client->rebootDBInstance([/* ... */]);
$promise = $client->rebootDBInstanceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->rebootDBInstance([
    'DBInstanceIdentifier' => '<string>', // REQUIRED
    'ForceFailover' => true || false,
]);

Parameter Details

Members

DBInstanceIdentifier

Required: Yes
Type: string

The instance identifier. This parameter is stored as a lowercase string.

Constraints:

Must match the identifier of an existing DBInstance.

ForceFailover

Type: boolean

When true, the reboot is conducted through a Multi-AZ failover.

Constraint: You can't specify true if the instance is not configured for Multi-AZ.

Result Syntax

[
    'DBInstance' => [
        'AutoMinorVersionUpgrade' => true || false,
        'AvailabilityZone' => '<string>',
        'BackupRetentionPeriod' => <integer>,
        'CACertificateIdentifier' => '<string>',
        'CopyTagsToSnapshot' => true || false,
        'DBClusterIdentifier' => '<string>',
        'DBInstanceArn' => '<string>',
        'DBInstanceClass' => '<string>',
        'DBInstanceIdentifier' => '<string>',
        'DBInstanceStatus' => '<string>',
        'DBSubnetGroup' => [
            'DBSubnetGroupArn' => '<string>',
            'DBSubnetGroupDescription' => '<string>',
            'DBSubnetGroupName' => '<string>',
            'SubnetGroupStatus' => '<string>',
            'Subnets' => [
                [
                    'SubnetAvailabilityZone' => [
                        'Name' => '<string>',
                    ],
                    'SubnetIdentifier' => '<string>',
                    'SubnetStatus' => '<string>',
                ],
                // ...
            ],
            'VpcId' => '<string>',
        ],
        'DbiResourceId' => '<string>',
        'EnabledCloudwatchLogsExports' => ['<string>', ...],
        'Endpoint' => [
            'Address' => '<string>',
            'HostedZoneId' => '<string>',
            'Port' => <integer>,
        ],
        'Engine' => '<string>',
        'EngineVersion' => '<string>',
        'InstanceCreateTime' => <DateTime>,
        'KmsKeyId' => '<string>',
        'LatestRestorableTime' => <DateTime>,
        'PendingModifiedValues' => [
            'AllocatedStorage' => <integer>,
            'BackupRetentionPeriod' => <integer>,
            'CACertificateIdentifier' => '<string>',
            'DBInstanceClass' => '<string>',
            'DBInstanceIdentifier' => '<string>',
            'DBSubnetGroupName' => '<string>',
            'EngineVersion' => '<string>',
            'Iops' => <integer>,
            'LicenseModel' => '<string>',
            'MasterUserPassword' => '<string>',
            'MultiAZ' => true || false,
            'PendingCloudwatchLogsExports' => [
                'LogTypesToDisable' => ['<string>', ...],
                'LogTypesToEnable' => ['<string>', ...],
            ],
            'Port' => <integer>,
            'StorageType' => '<string>',
        ],
        'PreferredBackupWindow' => '<string>',
        'PreferredMaintenanceWindow' => '<string>',
        'PromotionTier' => <integer>,
        'PubliclyAccessible' => true || false,
        'StatusInfos' => [
            [
                'Message' => '<string>',
                'Normal' => true || false,
                'Status' => '<string>',
                'StatusType' => '<string>',
            ],
            // ...
        ],
        'StorageEncrypted' => true || false,
        'VpcSecurityGroups' => [
            [
                'Status' => '<string>',
                'VpcSecurityGroupId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members

DBInstance

Type: DBInstance structure

Detailed information about an instance.

Errors

InvalidDBInstanceStateFault:
The specified instance isn't in the available state.
DBInstanceNotFoundFault:
DBInstanceIdentifier doesn't refer to an existing instance.

RemoveFromGlobalCluster

$result = $client->removeFromGlobalCluster([/* ... */]);
$promise = $client->removeFromGlobalClusterAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->removeFromGlobalCluster([
    'DbClusterIdentifier' => '<string>', // REQUIRED
    'GlobalClusterIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members

DbClusterIdentifier

Required: Yes
Type: string

The Amazon Resource Name (ARN) identifying the cluster that was detached from the Amazon DocumentDB global cluster.

GlobalClusterIdentifier

Required: Yes
Type: string

The cluster identifier to detach from the Amazon DocumentDB global cluster.

Result Syntax

[
    'GlobalCluster' => [
        'DatabaseName' => '<string>',
        'DeletionProtection' => true || false,
        'Engine' => '<string>',
        'EngineVersion' => '<string>',
        'GlobalClusterArn' => '<string>',
        'GlobalClusterIdentifier' => '<string>',
        'GlobalClusterMembers' => [
            [
                'DBClusterArn' => '<string>',
                'IsWriter' => true || false,
                'Readers' => ['<string>', ...],
            ],
            // ...
        ],
        'GlobalClusterResourceId' => '<string>',
        'Status' => '<string>',
        'StorageEncrypted' => true || false,
    ],
]

Result Details

Members

GlobalCluster

Type: GlobalCluster structure

A data type representing an Amazon DocumentDB global cluster.

Errors

GlobalClusterNotFoundFault:
The GlobalClusterIdentifier doesn't refer to an existing global cluster.
InvalidGlobalClusterStateFault:
The requested operation can't be performed while the cluster is in this state.
DBClusterNotFoundFault:
DBClusterIdentifier doesn't refer to an existing cluster.

RemoveSourceIdentifierFromSubscription

$result = $client->removeSourceIdentifierFromSubscription([/* ... */]);
$promise = $client->removeSourceIdentifierFromSubscriptionAsync([/* ... */]);

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

Parameter Syntax

$result = $client->removeSourceIdentifierFromSubscription([
    'SourceIdentifier' => '<string>', // REQUIRED
    'SubscriptionName' => '<string>', // REQUIRED
]);

Parameter Details

Members

SourceIdentifier

Required: Yes
Type: string

The source identifier to be removed from the subscription, such as the instance identifier for an instance, or the name of a security group.

SubscriptionName

Required: Yes
Type: string

The name of the Amazon DocumentDB event notification subscription that you want to remove a source identifier from.

Result Syntax

[
    'EventSubscription' => [
        'CustSubscriptionId' => '<string>',
        'CustomerAwsId' => '<string>',
        'Enabled' => true || false,
        'EventCategoriesList' => ['<string>', ...],
        'EventSubscriptionArn' => '<string>',
        'SnsTopicArn' => '<string>',
        'SourceIdsList' => ['<string>', ...],
        'SourceType' => '<string>',
        'Status' => '<string>',
        'SubscriptionCreationTime' => '<string>',
    ],
]

Result Details

Members

EventSubscription

Type: EventSubscription structure

Detailed information about an event to which you have subscribed.

Errors

SubscriptionNotFoundFault:
The subscription name does not exist.
SourceNotFoundFault:
The requested source could not be found.

RemoveTagsFromResource

$result = $client->removeTagsFromResource([/* ... */]);
$promise = $client->removeTagsFromResourceAsync([/* ... */]);

Removes metadata tags from an Amazon DocumentDB resource.

Parameter Syntax

$result = $client->removeTagsFromResource([
    'ResourceName' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

ResourceName

Required: Yes
Type: string

The Amazon DocumentDB resource that the tags are removed from. This value is an Amazon Resource Name (ARN).

TagKeys

Required: Yes
Type: Array of strings

The tag key (name) of the tag to be removed.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

DBInstanceNotFoundFault:
DBInstanceIdentifier doesn't refer to an existing instance.
DBSnapshotNotFoundFault:
DBSnapshotIdentifier doesn't refer to an existing snapshot.
DBClusterNotFoundFault:
DBClusterIdentifier doesn't refer to an existing cluster.

ResetDBClusterParameterGroup

$result = $client->resetDBClusterParameterGroup([/* ... */]);
$promise = $client->resetDBClusterParameterGroupAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->resetDBClusterParameterGroup([
    'DBClusterParameterGroupName' => '<string>', // REQUIRED
    'Parameters' => [
        [
            'AllowedValues' => '<string>',
            'ApplyMethod' => 'immediate|pending-reboot',
            'ApplyType' => '<string>',
            'DataType' => '<string>',
            'Description' => '<string>',
            'IsModifiable' => true || false,
            'MinimumEngineVersion' => '<string>',
            'ParameterName' => '<string>',
            'ParameterValue' => '<string>',
            'Source' => '<string>',
        ],
        // ...
    ],
    'ResetAllParameters' => true || false,
]);

Parameter Details

Members

DBClusterParameterGroupName

Required: Yes
Type: string

The name of the cluster parameter group to reset.

Parameters

Type: Array of Parameter structures

A list of parameter names in the cluster parameter group to reset to the default values. You can't use this parameter if the ResetAllParameters parameter is set to true.

ResetAllParameters

Type: boolean

A value that is set to true to reset all parameters in the cluster parameter group to their default values, and false otherwise. You can't use this parameter if there is a list of parameter names specified for the Parameters parameter.

Result Syntax

[
    'DBClusterParameterGroupName' => '<string>',
]

Result Details

Members

DBClusterParameterGroupName

Type: string

The name of a cluster parameter group.

Constraints:

Must be from 1 to 255 letters or numbers.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.

This value is stored as a lowercase string.

Errors

InvalidDBParameterGroupStateFault:
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.
DBParameterGroupNotFoundFault:
DBParameterGroupName doesn't refer to an existing parameter group.

RestoreDBClusterFromSnapshot

$result = $client->restoreDBClusterFromSnapshot([/* ... */]);
$promise = $client->restoreDBClusterFromSnapshotAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->restoreDBClusterFromSnapshot([
    'AvailabilityZones' => ['<string>', ...],
    'DBClusterIdentifier' => '<string>', // REQUIRED
    'DBSubnetGroupName' => '<string>',
    'DeletionProtection' => true || false,
    'EnableCloudwatchLogsExports' => ['<string>', ...],
    'Engine' => '<string>', // REQUIRED
    'EngineVersion' => '<string>',
    'KmsKeyId' => '<string>',
    'Port' => <integer>,
    'SnapshotIdentifier' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'VpcSecurityGroupIds' => ['<string>', ...],
]);

Parameter Details

Members

AvailabilityZones

Type: Array of strings

Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.

DBClusterIdentifier

Required: Yes
Type: string

The name of the cluster to create from the snapshot or cluster snapshot. This parameter isn't case sensitive.

Constraints:

Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-snapshot-id

DBSubnetGroupName

Type: string

The name of the subnet group to use for the new cluster.

Constraints: If provided, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

DeletionProtection

Type: boolean

EnableCloudwatchLogsExports

Type: Array of strings

A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.

Engine

Required: Yes
Type: string

The database engine to use for the new cluster.

Default: The same as source.

Constraint: Must be compatible with the engine of the source.

EngineVersion

Type: string

The version of the database engine to use for the new cluster.

KmsKeyId

Type: string

The KMS key identifier to use when restoring an encrypted cluster from a DB snapshot or cluster snapshot.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a cluster with the same Amazon Web Services account that owns the KMS encryption key used to encrypt the new cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

If you do not specify a value for the KmsKeyId parameter, then the following occurs:

If the snapshot or cluster snapshot in SnapshotIdentifier is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt the snapshot or the cluster snapshot.
If the snapshot or the cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted.

Port

Type: int

The port number on which the new cluster accepts connections.

Constraints: Must be a value from 1150 to 65535.

Default: The same port as the original cluster.

SnapshotIdentifier

Required: Yes
Type: string

The identifier for the snapshot or cluster snapshot to restore from.

You can use either the name or the Amazon Resource Name (ARN) to specify a cluster snapshot. However, you can use only the ARN to specify a snapshot.

Constraints:

Must match the identifier of an existing snapshot.

Tags

Type: Array of Tag structures

The tags to be assigned to the restored cluster.

VpcSecurityGroupIds

Type: Array of strings

A list of virtual private cloud (VPC) security groups that the new cluster will belong to.

Result Syntax

[
    'DBCluster' => [
        'AssociatedRoles' => [
            [
                'RoleArn' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'AvailabilityZones' => ['<string>', ...],
        'BackupRetentionPeriod' => <integer>,
        'CloneGroupId' => '<string>',
        'ClusterCreateTime' => <DateTime>,
        'DBClusterArn' => '<string>',
        'DBClusterIdentifier' => '<string>',
        'DBClusterMembers' => [
            [
                'DBClusterParameterGroupStatus' => '<string>',
                'DBInstanceIdentifier' => '<string>',
                'IsClusterWriter' => true || false,
                'PromotionTier' => <integer>,
            ],
            // ...
        ],
        'DBClusterParameterGroup' => '<string>',
        'DBSubnetGroup' => '<string>',
        'DbClusterResourceId' => '<string>',
        'DeletionProtection' => true || false,
        'EarliestRestorableTime' => <DateTime>,
        'EnabledCloudwatchLogsExports' => ['<string>', ...],
        'Endpoint' => '<string>',
        'Engine' => '<string>',
        'EngineVersion' => '<string>',
        'HostedZoneId' => '<string>',
        'KmsKeyId' => '<string>',
        'LatestRestorableTime' => <DateTime>,
        'MasterUsername' => '<string>',
        'MultiAZ' => true || false,
        'PercentProgress' => '<string>',
        'Port' => <integer>,
        'PreferredBackupWindow' => '<string>',
        'PreferredMaintenanceWindow' => '<string>',
        'ReadReplicaIdentifiers' => ['<string>', ...],
        'ReaderEndpoint' => '<string>',
        'ReplicationSourceIdentifier' => '<string>',
        'Status' => '<string>',
        'StorageEncrypted' => true || false,
        'VpcSecurityGroups' => [
            [
                'Status' => '<string>',
                'VpcSecurityGroupId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members

DBCluster

Type: DBCluster structure

Detailed information about a cluster.

Errors

DBClusterAlreadyExistsFault:
You already have a cluster with the given identifier.
DBClusterQuotaExceededFault:
The cluster can't be created because you have reached the maximum allowed quota of clusters.
StorageQuotaExceededFault:
The request would cause you to exceed the allowed amount of storage available across all instances.
DBSubnetGroupNotFoundFault:
DBSubnetGroupName doesn't refer to an existing subnet group.
DBSnapshotNotFoundFault:
DBSnapshotIdentifier doesn't refer to an existing snapshot.
DBClusterSnapshotNotFoundFault:
DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.
InsufficientDBClusterCapacityFault:
The cluster doesn't have enough capacity for the current operation.
InsufficientStorageClusterCapacityFault:
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.
InvalidDBSnapshotStateFault:
The state of the snapshot doesn't allow deletion.
InvalidDBClusterSnapshotStateFault:
The provided value isn't a valid cluster snapshot state.
StorageQuotaExceededFault:
The request would cause you to exceed the allowed amount of storage available across all instances.
InvalidVPCNetworkStateFault:
The subnet group doesn't cover all Availability Zones after it is created because of changes that were made.
InvalidRestoreFault:
You cannot restore from a virtual private cloud (VPC) backup to a non-VPC DB instance.
DBSubnetGroupNotFoundFault:
DBSubnetGroupName doesn't refer to an existing subnet group.
InvalidSubnet:
The requested subnet is not valid, or multiple subnets were requested that are not all in a common virtual private cloud (VPC).
KMSKeyNotAccessibleFault:
An error occurred when accessing an KMS key.

RestoreDBClusterToPointInTime

$result = $client->restoreDBClusterToPointInTime([/* ... */]);
$promise = $client->restoreDBClusterToPointInTimeAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->restoreDBClusterToPointInTime([
    'DBClusterIdentifier' => '<string>', // REQUIRED
    'DBSubnetGroupName' => '<string>',
    'DeletionProtection' => true || false,
    'EnableCloudwatchLogsExports' => ['<string>', ...],
    'KmsKeyId' => '<string>',
    'Port' => <integer>,
    'RestoreToTime' => <integer || string || DateTime>,
    'RestoreType' => '<string>',
    'SourceDBClusterIdentifier' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'UseLatestRestorableTime' => true || false,
    'VpcSecurityGroupIds' => ['<string>', ...],
]);

Parameter Details

Members

DBClusterIdentifier

Required: Yes
Type: string

The name of the new cluster to be created.

Constraints:

Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.

DBSubnetGroupName

Type: string

The subnet group name to use for the new cluster.

Constraints: If provided, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

DeletionProtection

Type: boolean

EnableCloudwatchLogsExports

Type: Array of strings

A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.

KmsKeyId

Type: string

The KMS key identifier to use when restoring an encrypted cluster from an encrypted cluster.

You can restore to a new cluster and encrypt the new cluster with an KMS key that is different from the KMS key used to encrypt the source cluster. The new DB cluster is encrypted with the KMS key identified by the KmsKeyId parameter.

If you do not specify a value for the KmsKeyId parameter, then the following occurs:

If the cluster is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt the source cluster.
If the cluster is not encrypted, then the restored cluster is not encrypted.

If DBClusterIdentifier refers to a cluster that is not encrypted, then the restore request is rejected.

Port

Type: int

The port number on which the new cluster accepts connections.

Constraints: Must be a value from 1150 to 65535.

Default: The default port for the engine.

RestoreToTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time to restore the cluster to.

Valid values: A time in Universal Coordinated Time (UTC) format.

Constraints:

Must be before the latest restorable time for the instance.
Must be specified if the UseLatestRestorableTime parameter is not provided.
Cannot be specified if the UseLatestRestorableTime parameter is true.
Cannot be specified if the RestoreType parameter is copy-on-write.

Example: 2015-03-07T23:45:00Z

RestoreType

Type: string

The type of restore to be performed. You can specify one of the following values:

full-copy - The new DB cluster is restored as a full copy of the source DB cluster.
copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.

If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.

SourceDBClusterIdentifier

Required: Yes
Type: string

The identifier of the source cluster from which to restore.

Constraints:

Must match the identifier of an existing DBCluster.

Tags

Type: Array of Tag structures

The tags to be assigned to the restored cluster.

UseLatestRestorableTime

Type: boolean

A value that is set to true to restore the cluster to the latest restorable backup time, and false otherwise.

Default: false

Constraints: Cannot be specified if the RestoreToTime parameter is provided.

VpcSecurityGroupIds

Type: Array of strings

A list of VPC security groups that the new cluster belongs to.

Result Syntax

[
    'DBCluster' => [
        'AssociatedRoles' => [
            [
                'RoleArn' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'AvailabilityZones' => ['<string>', ...],
        'BackupRetentionPeriod' => <integer>,
        'CloneGroupId' => '<string>',
        'ClusterCreateTime' => <DateTime>,
        'DBClusterArn' => '<string>',
        'DBClusterIdentifier' => '<string>',
        'DBClusterMembers' => [
            [
                'DBClusterParameterGroupStatus' => '<string>',
                'DBInstanceIdentifier' => '<string>',
                'IsClusterWriter' => true || false,
                'PromotionTier' => <integer>,
            ],
            // ...
        ],
        'DBClusterParameterGroup' => '<string>',
        'DBSubnetGroup' => '<string>',
        'DbClusterResourceId' => '<string>',
        'DeletionProtection' => true || false,
        'EarliestRestorableTime' => <DateTime>,
        'EnabledCloudwatchLogsExports' => ['<string>', ...],
        'Endpoint' => '<string>',
        'Engine' => '<string>',
        'EngineVersion' => '<string>',
        'HostedZoneId' => '<string>',
        'KmsKeyId' => '<string>',
        'LatestRestorableTime' => <DateTime>,
        'MasterUsername' => '<string>',
        'MultiAZ' => true || false,
        'PercentProgress' => '<string>',
        'Port' => <integer>,
        'PreferredBackupWindow' => '<string>',
        'PreferredMaintenanceWindow' => '<string>',
        'ReadReplicaIdentifiers' => ['<string>', ...],
        'ReaderEndpoint' => '<string>',
        'ReplicationSourceIdentifier' => '<string>',
        'Status' => '<string>',
        'StorageEncrypted' => true || false,
        'VpcSecurityGroups' => [
            [
                'Status' => '<string>',
                'VpcSecurityGroupId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members

DBCluster

Type: DBCluster structure

Detailed information about a cluster.

Errors

DBClusterAlreadyExistsFault:
You already have a cluster with the given identifier.
DBClusterNotFoundFault:
DBClusterIdentifier doesn't refer to an existing cluster.
DBClusterQuotaExceededFault:
The cluster can't be created because you have reached the maximum allowed quota of clusters.
DBClusterSnapshotNotFoundFault:
DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.
DBSubnetGroupNotFoundFault:
DBSubnetGroupName doesn't refer to an existing subnet group.
InsufficientDBClusterCapacityFault:
The cluster doesn't have enough capacity for the current operation.
InsufficientStorageClusterCapacityFault:
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.
InvalidDBClusterSnapshotStateFault:
The provided value isn't a valid cluster snapshot state.
InvalidDBClusterStateFault:
The cluster isn't in a valid state.
InvalidDBSnapshotStateFault:
The state of the snapshot doesn't allow deletion.
InvalidRestoreFault:
You cannot restore from a virtual private cloud (VPC) backup to a non-VPC DB instance.
InvalidSubnet:
The requested subnet is not valid, or multiple subnets were requested that are not all in a common virtual private cloud (VPC).
InvalidVPCNetworkStateFault:
The subnet group doesn't cover all Availability Zones after it is created because of changes that were made.
KMSKeyNotAccessibleFault:
An error occurred when accessing an KMS key.
StorageQuotaExceededFault:
The request would cause you to exceed the allowed amount of storage available across all instances.

StartDBCluster

$result = $client->startDBCluster([/* ... */]);
$promise = $client->startDBClusterAsync([/* ... */]);

Restarts the stopped cluster that is specified by DBClusterIdentifier. For more information, see Stopping and Starting an Amazon DocumentDB Cluster.

Parameter Syntax

$result = $client->startDBCluster([
    'DBClusterIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members

DBClusterIdentifier

Required: Yes
Type: string

The identifier of the cluster to restart. Example: docdb-2019-05-28-15-24-52

Result Syntax

[
    'DBCluster' => [
        'AssociatedRoles' => [
            [
                'RoleArn' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'AvailabilityZones' => ['<string>', ...],
        'BackupRetentionPeriod' => <integer>,
        'CloneGroupId' => '<string>',
        'ClusterCreateTime' => <DateTime>,
        'DBClusterArn' => '<string>',
        'DBClusterIdentifier' => '<string>',
        'DBClusterMembers' => [
            [
                'DBClusterParameterGroupStatus' => '<string>',
                'DBInstanceIdentifier' => '<string>',
                'IsClusterWriter' => true || false,
                'PromotionTier' => <integer>,
            ],
            // ...
        ],
        'DBClusterParameterGroup' => '<string>',
        'DBSubnetGroup' => '<string>',
        'DbClusterResourceId' => '<string>',
        'DeletionProtection' => true || false,
        'EarliestRestorableTime' => <DateTime>,
        'EnabledCloudwatchLogsExports' => ['<string>', ...],
        'Endpoint' => '<string>',
        'Engine' => '<string>',
        'EngineVersion' => '<string>',
        'HostedZoneId' => '<string>',
        'KmsKeyId' => '<string>',
        'LatestRestorableTime' => <DateTime>,
        'MasterUsername' => '<string>',
        'MultiAZ' => true || false,
        'PercentProgress' => '<string>',
        'Port' => <integer>,
        'PreferredBackupWindow' => '<string>',
        'PreferredMaintenanceWindow' => '<string>',
        'ReadReplicaIdentifiers' => ['<string>', ...],
        'ReaderEndpoint' => '<string>',
        'ReplicationSourceIdentifier' => '<string>',
        'Status' => '<string>',
        'StorageEncrypted' => true || false,
        'VpcSecurityGroups' => [
            [
                'Status' => '<string>',
                'VpcSecurityGroupId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members

DBCluster

Type: DBCluster structure

Detailed information about a cluster.

Errors

DBClusterNotFoundFault:
DBClusterIdentifier doesn't refer to an existing cluster.
InvalidDBClusterStateFault:
The cluster isn't in a valid state.
InvalidDBInstanceStateFault:
The specified instance isn't in the available state.

StopDBCluster

$result = $client->stopDBCluster([/* ... */]);
$promise = $client->stopDBClusterAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->stopDBCluster([
    'DBClusterIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members

DBClusterIdentifier

Required: Yes
Type: string

The identifier of the cluster to stop. Example: docdb-2019-05-28-15-24-52

Result Syntax

[
    'DBCluster' => [
        'AssociatedRoles' => [
            [
                'RoleArn' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'AvailabilityZones' => ['<string>', ...],
        'BackupRetentionPeriod' => <integer>,
        'CloneGroupId' => '<string>',
        'ClusterCreateTime' => <DateTime>,
        'DBClusterArn' => '<string>',
        'DBClusterIdentifier' => '<string>',
        'DBClusterMembers' => [
            [
                'DBClusterParameterGroupStatus' => '<string>',
                'DBInstanceIdentifier' => '<string>',
                'IsClusterWriter' => true || false,
                'PromotionTier' => <integer>,
            ],
            // ...
        ],
        'DBClusterParameterGroup' => '<string>',
        'DBSubnetGroup' => '<string>',
        'DbClusterResourceId' => '<string>',
        'DeletionProtection' => true || false,
        'EarliestRestorableTime' => <DateTime>,
        'EnabledCloudwatchLogsExports' => ['<string>', ...],
        'Endpoint' => '<string>',
        'Engine' => '<string>',
        'EngineVersion' => '<string>',
        'HostedZoneId' => '<string>',
        'KmsKeyId' => '<string>',
        'LatestRestorableTime' => <DateTime>,
        'MasterUsername' => '<string>',
        'MultiAZ' => true || false,
        'PercentProgress' => '<string>',
        'Port' => <integer>,
        'PreferredBackupWindow' => '<string>',
        'PreferredMaintenanceWindow' => '<string>',
        'ReadReplicaIdentifiers' => ['<string>', ...],
        'ReaderEndpoint' => '<string>',
        'ReplicationSourceIdentifier' => '<string>',
        'Status' => '<string>',
        'StorageEncrypted' => true || false,
        'VpcSecurityGroups' => [
            [
                'Status' => '<string>',
                'VpcSecurityGroupId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members

DBCluster

Type: DBCluster structure

Detailed information about a cluster.

Errors

DBClusterNotFoundFault:
DBClusterIdentifier doesn't refer to an existing cluster.
InvalidDBClusterStateFault:
The cluster isn't in a valid state.
InvalidDBInstanceStateFault:
The specified instance isn't in the available state.

Shapes

AddSourceIdentifierToSubscriptionResult

Members

EventSubscription

Type: EventSubscription structure

Detailed information about an event to which you have subscribed.

ApplyPendingMaintenanceActionResult

Members

ResourcePendingMaintenanceActions

Type: ResourcePendingMaintenanceActions structure

Represents the output of ApplyPendingMaintenanceAction.

AuthorizationNotFoundFault

Description

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.

Members

AvailabilityZone

Description

Information about an Availability Zone.

Members

Name

Type: string

The name of the Availability Zone.

Certificate

Description

A certificate authority (CA) certificate for an Amazon Web Services account.

Members

CertificateArn

Type: string

The Amazon Resource Name (ARN) for the certificate.

Example: arn:aws:rds:us-east-1::cert:rds-ca-2019

CertificateIdentifier

Type: string

The unique key that identifies a certificate.

Example: rds-ca-2019

CertificateType

Type: string

The type of the certificate.

Example: CA

Thumbprint

Type: string

The thumbprint of the certificate.

ValidFrom

Type: timestamp (string|DateTime or anything parsable by strtotime)

The starting date-time from which the certificate is valid.

Example: 2019-07-31T17:57:09Z

ValidTill

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date-time after which the certificate is no longer valid.

Example: 2024-07-31T17:57:09Z

CertificateMessage

Members

Certificates

Type: Array of Certificate structures

A list of certificates for this Amazon Web Services account.

Marker

Type: string

CertificateNotFoundFault

Description

CertificateIdentifier doesn't refer to an existing certificate.

Members

CloudwatchLogsExportConfiguration

Description

The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster.

The EnableLogTypes and DisableLogTypes arrays determine which logs are exported (or not exported) to CloudWatch Logs. The values within these arrays depend on the engine that is being used.

Members

DisableLogTypes

Type: Array of strings

The list of log types to disable.

EnableLogTypes

Type: Array of strings

The list of log types to enable.

CopyDBClusterParameterGroupResult

Members

DBClusterParameterGroup

Type: DBClusterParameterGroup structure

Detailed information about a cluster parameter group.

CopyDBClusterSnapshotResult

Members

DBClusterSnapshot

Type: DBClusterSnapshot structure

Detailed information about a cluster snapshot.

CreateDBClusterParameterGroupResult

Members

DBClusterParameterGroup

Type: DBClusterParameterGroup structure

Detailed information about a cluster parameter group.

CreateDBClusterResult

Members

DBCluster

Type: DBCluster structure

Detailed information about a cluster.

CreateDBClusterSnapshotResult

Members

DBClusterSnapshot

Type: DBClusterSnapshot structure

Detailed information about a cluster snapshot.

CreateDBInstanceResult

Members

DBInstance

Type: DBInstance structure

Detailed information about an instance.

CreateDBSubnetGroupResult

Members

DBSubnetGroup

Type: DBSubnetGroup structure

Detailed information about a subnet group.

CreateEventSubscriptionResult

Members

EventSubscription

Type: EventSubscription structure

Detailed information about an event to which you have subscribed.

CreateGlobalClusterResult

Members

GlobalCluster

Type: GlobalCluster structure

A data type representing an Amazon DocumentDB global cluster.

DBCluster

Description

Detailed information about a cluster.

Members

AssociatedRoles

Type: Array of DBClusterRole structures

Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.

AvailabilityZones

Type: Array of strings

Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

BackupRetentionPeriod

Type: int

Specifies the number of days for which automatic snapshots are retained.

CloneGroupId

Type: string

Identifies the clone group to which the DB cluster is associated.

ClusterCreateTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).

DBClusterArn

Type: string

The Amazon Resource Name (ARN) for the cluster.

DBClusterIdentifier

Type: string

Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.

DBClusterMembers

Type: Array of DBClusterMember structures

Provides the list of instances that make up the cluster.

DBClusterParameterGroup

Type: string

Specifies the name of the cluster parameter group for the cluster.

DBSubnetGroup

Type: string

Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.

DbClusterResourceId

Type: string

The Amazon Web Services Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.

DeletionProtection

Type: boolean

EarliestRestorableTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The earliest time to which a database can be restored with point-in-time restore.

EnabledCloudwatchLogsExports

Type: Array of strings

A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.

Endpoint

Type: string

Specifies the connection endpoint for the primary instance of the cluster.

Engine

Type: string

Provides the name of the database engine to be used for this cluster.

EngineVersion

Type: string

Indicates the database engine version.

HostedZoneId

Type: string

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

KmsKeyId

Type: string

If StorageEncrypted is true, the KMS key identifier for the encrypted cluster.

LatestRestorableTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

Specifies the latest time to which a database can be restored with point-in-time restore.

MasterUsername

Type: string

Contains the master user name for the cluster.

MultiAZ

Type: boolean

Specifies whether the cluster has instances in multiple Availability Zones.

PercentProgress

Type: string

Specifies the progress of the operation as a percentage.

Port

Type: int

Specifies the port that the database engine is listening on.

PreferredBackupWindow

Type: string

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

PreferredMaintenanceWindow

Type: string

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

ReadReplicaIdentifiers

Type: Array of strings

Contains one or more identifiers of the secondary clusters that are associated with this cluster.

ReaderEndpoint

Type: string

The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.

If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.

ReplicationSourceIdentifier

Type: string

Contains the identifier of the source cluster if this cluster is a secondary cluster.

Status

Type: string

Specifies the current state of this cluster.

StorageEncrypted

Type: boolean

Specifies whether the cluster is encrypted.

VpcSecurityGroups

Type: Array of VpcSecurityGroupMembership structures

Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.

DBClusterAlreadyExistsFault

Description

You already have a cluster with the given identifier.

Members

DBClusterMember

Description

Contains information about an instance that is part of a cluster.

Members

DBClusterParameterGroupStatus

Type: string

Specifies the status of the cluster parameter group for this member of the DB cluster.

DBInstanceIdentifier

Type: string

Specifies the instance identifier for this member of the cluster.

IsClusterWriter

Type: boolean

A value that is true if the cluster member is the primary instance for the cluster and false otherwise.

PromotionTier

Type: int

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

DBClusterMessage

Description

Represents the output of DescribeDBClusters.

Members

DBClusters

Type: Array of DBCluster structures

A list of clusters.

Marker

Type: string

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

DBClusterNotFoundFault

Description

DBClusterIdentifier doesn't refer to an existing cluster.

Members

DBClusterParameterGroup

Description

Detailed information about a cluster parameter group.

Members

DBClusterParameterGroupArn

Type: string

The Amazon Resource Name (ARN) for the cluster parameter group.

DBClusterParameterGroupName

Type: string

Provides the name of the cluster parameter group.

DBParameterGroupFamily

Type: string

Provides the name of the parameter group family that this cluster parameter group is compatible with.

Description

Type: string

Provides the customer-specified description for this cluster parameter group.

DBClusterParameterGroupDetails

Description

Represents the output of DBClusterParameterGroup.

Members

Marker

Type: string

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Parameters

Type: Array of Parameter structures

Provides a list of parameters for the cluster parameter group.

DBClusterParameterGroupNameMessage

Description

Contains the name of a cluster parameter group.

Members

DBClusterParameterGroupName

Type: string

The name of a cluster parameter group.

Constraints:

Must be from 1 to 255 letters or numbers.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.

This value is stored as a lowercase string.

DBClusterParameterGroupNotFoundFault

Description

DBClusterParameterGroupName doesn't refer to an existing cluster parameter group.

Members

DBClusterParameterGroupsMessage

Description

Represents the output of DBClusterParameterGroups.

Members

DBClusterParameterGroups

Type: Array of DBClusterParameterGroup structures

A list of cluster parameter groups.

Marker

Type: string

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

DBClusterQuotaExceededFault

Description

The cluster can't be created because you have reached the maximum allowed quota of clusters.

Members

DBClusterRole

Description

Describes an Identity and Access Management (IAM) role that is associated with a cluster.

Members

RoleArn

Type: string

The Amazon Resource Name (ARN) of the IAMrole that is associated with the DB cluster.

Status

Type: string

Describes the state of association between the IAMrole and the cluster. The Status property returns one of the following values:

ACTIVE - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.
PENDING - The IAMrole ARN is being associated with the cluster.
INVALID - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.

DBClusterSnapshot

Description

Detailed information about a cluster snapshot.

Members

AvailabilityZones

Type: Array of strings

Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored in.

ClusterCreateTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).

DBClusterIdentifier

Type: string

Specifies the cluster identifier of the cluster that this cluster snapshot was created from.

DBClusterSnapshotArn

Type: string

The Amazon Resource Name (ARN) for the cluster snapshot.

DBClusterSnapshotIdentifier

Type: string

Specifies the identifier for the cluster snapshot.

Engine

Type: string

Specifies the name of the database engine.

EngineVersion

Type: string

Provides the version of the database engine for this cluster snapshot.

KmsKeyId

Type: string

If StorageEncrypted is true, the KMS key identifier for the encrypted cluster snapshot.

MasterUsername

Type: string

Provides the master user name for the cluster snapshot.

PercentProgress

Type: int

Specifies the percentage of the estimated data that has been transferred.

Port

Type: int

Specifies the port that the cluster was listening on at the time of the snapshot.

SnapshotCreateTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

Provides the time when the snapshot was taken, in UTC.

SnapshotType

Type: string

Provides the type of the cluster snapshot.

SourceDBClusterSnapshotArn

Type: string

If the cluster snapshot was copied from a source cluster snapshot, the ARN for the source cluster snapshot; otherwise, a null value.

Status

Type: string

Specifies the status of this cluster snapshot.

StorageEncrypted

Type: boolean

Specifies whether the cluster snapshot is encrypted.

VpcId

Type: string

Provides the virtual private cloud (VPC) ID that is associated with the cluster snapshot.

DBClusterSnapshotAlreadyExistsFault

Description

You already have a cluster snapshot with the given identifier.

Members

DBClusterSnapshotAttribute

Description

Contains the name and values of a manual cluster snapshot attribute.

Manual cluster snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual cluster snapshot.

Members

AttributeName

Type: string

The name of the manual cluster snapshot attribute.

The attribute named restore refers to the list of Amazon Web Services accounts that have permission to copy or restore the manual cluster snapshot.

AttributeValues

Type: Array of strings

The values for the manual cluster snapshot attribute.

If the AttributeName field is set to restore, then this element returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual cluster snapshot. If a value of all is in the list, then the manual cluster snapshot is public and available for any Amazon Web Services account to copy or restore.

DBClusterSnapshotAttributesResult

Description

Detailed information about the attributes that are associated with a cluster snapshot.

Members

DBClusterSnapshotAttributes

Type: Array of DBClusterSnapshotAttribute structures

The list of attributes and values for the cluster snapshot.

DBClusterSnapshotIdentifier

Type: string

The identifier of the cluster snapshot that the attributes apply to.

DBClusterSnapshotMessage

Description

Represents the output of DescribeDBClusterSnapshots.

Members

DBClusterSnapshots

Type: Array of DBClusterSnapshot structures

Provides a list of cluster snapshots.

Marker

Type: string

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

DBClusterSnapshotNotFoundFault

Description

DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.

Members

DBEngineVersion

Description

Detailed information about an engine version.

Members

DBEngineDescription

Type: string

The description of the database engine.

DBEngineVersionDescription

Type: string

The description of the database engine version.

DBParameterGroupFamily

Type: string

The name of the parameter group family for the database engine.

Engine

Type: string

The name of the database engine.

EngineVersion

Type: string

The version number of the database engine.

ExportableLogTypes

Type: Array of strings

The types of logs that the database engine has available for export to Amazon CloudWatch Logs.

SupportsLogExportsToCloudwatchLogs

Type: boolean

A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.

ValidUpgradeTarget

Type: Array of UpgradeTarget structures

A list of engine versions that this database engine version can be upgraded to.

DBEngineVersionMessage

Description

Represents the output of DescribeDBEngineVersions.

Members

DBEngineVersions

Type: Array of DBEngineVersion structures

Detailed information about one or more engine versions.

Marker

Type: string

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

DBInstance

Description

Detailed information about an instance.

Members

AutoMinorVersionUpgrade

Type: boolean

Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

AvailabilityZone

Type: string

Specifies the name of the Availability Zone that the instance is located in.

BackupRetentionPeriod

Type: int

Specifies the number of days for which automatic snapshots are retained.

CACertificateIdentifier

Type: string

The identifier of the CA certificate for this DB instance.

CopyTagsToSnapshot

Type: boolean

A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

DBClusterIdentifier

Type: string

Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.

DBInstanceArn

Type: string

The Amazon Resource Name (ARN) for the instance.

DBInstanceClass

Type: string

Contains the name of the compute and memory capacity class of the instance.

DBInstanceIdentifier

Type: string

Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.

DBInstanceStatus

Type: string

Specifies the current state of this database.

DBSubnetGroup

Type: DBSubnetGroup structure

Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.

DbiResourceId

Type: string

The Amazon Web Services Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is accessed.

EnabledCloudwatchLogsExports

Type: Array of strings

A list of log types that this instance is configured to export to CloudWatch Logs.

Endpoint

Type: Endpoint structure

Specifies the connection endpoint.

Engine

Type: string

Provides the name of the database engine to be used for this instance.

EngineVersion

Type: string

Indicates the database engine version.

InstanceCreateTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

Provides the date and time that the instance was created.

KmsKeyId

Type: string

If StorageEncrypted is true, the KMS key identifier for the encrypted instance.

LatestRestorableTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

Specifies the latest time to which a database can be restored with point-in-time restore.

PendingModifiedValues

Type: PendingModifiedValues structure

Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.

PreferredBackupWindow

Type: string

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

PreferredMaintenanceWindow

Type: string

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

PromotionTier

Type: int

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

PubliclyAccessible

Type: boolean

Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.

StatusInfos

Type: Array of DBInstanceStatusInfo structures

The status of a read replica. If the instance is not a read replica, this is blank.

StorageEncrypted

Type: boolean

Specifies whether or not the instance is encrypted.

VpcSecurityGroups

Type: Array of VpcSecurityGroupMembership structures

Provides a list of VPC security group elements that the instance belongs to.

DBInstanceAlreadyExistsFault

Description

You already have a instance with the given identifier.

Members

DBInstanceMessage

Description

Represents the output of DescribeDBInstances.

Members

DBInstances

Type: Array of DBInstance structures

Detailed information about one or more instances.

Marker

Type: string

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

DBInstanceNotFoundFault

Description

DBInstanceIdentifier doesn't refer to an existing instance.

Members

DBInstanceStatusInfo

Description

Provides a list of status information for an instance.

Members

Message

Type: string

Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.

Normal

Type: boolean

A Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

Status

Type: string

Status of the instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.

StatusType

Type: string

Members

DBSubnetGroupArn

Type: string

The Amazon Resource Name (ARN) for the DB subnet group.

DBSubnetGroupDescription

Type: string

Provides the description of the subnet group.

DBSubnetGroupName

Type: string

The name of the subnet group.

SubnetGroupStatus

Type: string

Provides the status of the subnet group.

Subnets

Type: Array of Subnet structures

Detailed information about one or more subnets within a subnet group.

VpcId

Type: string

Members

DBSubnetGroups

Type: Array of DBSubnetGroup structures

Detailed information about one or more subnet groups.

Marker

Type: string

Type: DBCluster structure

Detailed information about a cluster.

DeleteDBClusterSnapshotResult

Members

DBClusterSnapshot

Type: DBClusterSnapshot structure

Detailed information about a cluster snapshot.

DeleteDBInstanceResult

Members

DBInstance

Type: DBInstance structure

Detailed information about an instance.

DeleteEventSubscriptionResult

Members

EventSubscription

Type: EventSubscription structure

Detailed information about an event to which you have subscribed.

DeleteGlobalClusterResult

Members

GlobalCluster

Type: GlobalCluster structure

A data type representing an Amazon DocumentDB global cluster.

DescribeDBClusterSnapshotAttributesResult

Members

DBClusterSnapshotAttributesResult

Type: DBClusterSnapshotAttributesResult structure

Detailed information about the attributes that are associated with a cluster snapshot.

DescribeEngineDefaultClusterParametersResult

Members

EngineDefaults

Type: EngineDefaults structure

Contains the result of a successful invocation of the DescribeEngineDefaultClusterParameters operation.

Endpoint

Description

Network information for accessing a cluster or instance. Client programs must specify a valid endpoint to access these Amazon DocumentDB resources.

Members

Address

Type: string

Specifies the DNS address of the instance.

HostedZoneId

Type: string

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

Port

Type: int

Specifies the port that the database engine is listening on.

EngineDefaults

Description

Contains the result of a successful invocation of the DescribeEngineDefaultClusterParameters operation.

Members

DBParameterGroupFamily

Type: string

The name of the cluster parameter group family to return the engine parameter information for.

Marker

Type: string

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Parameters

Type: Array of Parameter structures

The parameters of a particular cluster parameter group family.

Event

Description

Detailed information about an event.

Members

Date

Type: timestamp (string|DateTime or anything parsable by strtotime)

Specifies the date and time of the event.

EventCategories

Type: Array of strings

Specifies the category for the event.

Message

Type: string

Provides the text of this event.

SourceArn

Type: string

The Amazon Resource Name (ARN) for the event.

SourceIdentifier

Type: string

Provides the identifier for the source of the event.

SourceType

Type: string

Specifies the source type for this event.

EventCategoriesMap

Description

An event source type, accompanied by one or more event category names.

Members

EventCategories

Type: Array of strings

The event categories for the specified source type.

SourceType

Type: string

The source type that the returned categories belong to.

EventCategoriesMessage

Description

Represents the output of DescribeEventCategories.

Members

EventCategoriesMapList

Type: Array of EventCategoriesMap structures

A list of event category maps.

EventSubscription

Description

Detailed information about an event to which you have subscribed.

Members

CustSubscriptionId

Type: string

The Amazon DocumentDB event notification subscription ID.

CustomerAwsId

Type: string

The Amazon Web Services customer account that is associated with the Amazon DocumentDB event notification subscription.

Enabled

Type: boolean

A Boolean value indicating whether the subscription is enabled. A value of true indicates that the subscription is enabled.

EventCategoriesList

Type: Array of strings

A list of event categories for the Amazon DocumentDB event notification subscription.

EventSubscriptionArn

Type: string

The Amazon Resource Name (ARN) for the event subscription.

SnsTopicArn

Type: string

The topic ARN of the Amazon DocumentDB event notification subscription.

SourceIdsList

Type: Array of strings

A list of source IDs for the Amazon DocumentDB event notification subscription.

SourceType

Type: string

The source type for the Amazon DocumentDB event notification subscription.

Status

Type: string

The status of the Amazon DocumentDB event notification subscription.

Constraints:

Can be one of the following: creating, modifying, deleting, active, no-permission, topic-not-exist

The no-permission status indicates that Amazon DocumentDB no longer has permission to post to the SNS topic. The topic-not-exist status indicates that the topic was deleted after the subscription was created.

SubscriptionCreationTime

Type: string

The time at which the Amazon DocumentDB event notification subscription was created.

EventSubscriptionQuotaExceededFault

Description

You have reached the maximum number of event subscriptions.

Members

EventSubscriptionsMessage

Description

Represents the output of DescribeEventSubscriptions.

Members

EventSubscriptionsList

Type: Array of EventSubscription structures

A list of event subscriptions.

Marker

Type: string

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

EventsMessage

Description

Represents the output of DescribeEvents.

Members

Events

Type: Array of Event structures

Detailed information about one or more events.

Marker

Type: string

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

FailoverDBClusterResult

Members

DBCluster

Type: DBCluster structure

Detailed information about a cluster.

Filter

Description

A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.

Wildcards are not supported in filters.

Members

Name

Required: Yes
Type: string

The name of the filter. Filter names are case sensitive.

Values

Required: Yes
Type: Array of strings

One or more filter values. Filter values are case sensitive.

GlobalCluster

Description

A data type representing an Amazon DocumentDB global cluster.

Members

DatabaseName

Type: string

The default database name within the new global cluster.

DeletionProtection

Type: boolean

The deletion protection setting for the new global cluster.

Engine

Type: string

The Amazon DocumentDB database engine used by the global cluster.

EngineVersion

Type: string

Indicates the database engine version.

GlobalClusterArn

Type: string

The Amazon Resource Name (ARN) for the global cluster.

GlobalClusterIdentifier

Type: string

Contains a user-supplied global cluster identifier. This identifier is the unique key that identifies a global cluster.

GlobalClusterMembers

Type: Array of GlobalClusterMember structures

The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item.

GlobalClusterResourceId

Type: string

The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the cluster is accessed.

Status

Type: string

Specifies the current state of this global cluster.

StorageEncrypted

Type: boolean

The storage encryption setting for the global cluster.

GlobalClusterAlreadyExistsFault

Description

The GlobalClusterIdentifier already exists. Choose a new global cluster identifier (unique name) to create a new global cluster.

Members

GlobalClusterMember

Description

A data structure with information about any primary and secondary clusters associated with an Amazon DocumentDB global clusters.

Members

DBClusterArn

Type: string

The Amazon Resource Name (ARN) for each Amazon DocumentDB cluster.

IsWriter

Type: boolean

Specifies whether the Amazon DocumentDB cluster is the primary cluster (that is, has read-write capability) for the Amazon DocumentDB global cluster with which it is associated.

Readers

Type: Array of strings

Type: Array of GlobalCluster structures

Marker

Type: string

ModifyDBClusterResult

Members

DBCluster

Type: DBCluster structure

Detailed information about a cluster.

ModifyDBClusterSnapshotAttributeResult

Members

DBClusterSnapshotAttributesResult

Type: DBClusterSnapshotAttributesResult structure

Detailed information about the attributes that are associated with a cluster snapshot.

ModifyDBInstanceResult

Members

DBInstance

Type: DBInstance structure

Detailed information about an instance.

ModifyDBSubnetGroupResult

Members

DBSubnetGroup

Type: DBSubnetGroup structure

Detailed information about a subnet group.

ModifyEventSubscriptionResult

Members

EventSubscription

Type: EventSubscription structure

Detailed information about an event to which you have subscribed.

ModifyGlobalClusterResult

Members

GlobalCluster

Type: GlobalCluster structure

A data type representing an Amazon DocumentDB global cluster.

OrderableDBInstanceOption

Description

The options that are available for an instance.

Members

AvailabilityZones

Type: Array of AvailabilityZone structures

A list of Availability Zones for an instance.

DBInstanceClass

Type: string

The instance class for an instance.

Engine

Type: string

The engine type of an instance.

EngineVersion

Type: string

The engine version of an instance.

LicenseModel

Type: string

The license model for an instance.

Vpc

Type: boolean

Indicates whether an instance is in a virtual private cloud (VPC).

OrderableDBInstanceOptionsMessage

Description

Represents the output of DescribeOrderableDBInstanceOptions.

Members

Marker

Type: string

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

OrderableDBInstanceOptions

Type: Array of OrderableDBInstanceOption structures

The options that are available for a particular orderable instance.

Parameter

Description

Detailed information about an individual parameter.

Members

AllowedValues

Type: string

Specifies the valid range of values for the parameter.

ApplyMethod

Type: string

Indicates when to apply parameter updates.

ApplyType

Type: string

Specifies the engine-specific parameters type.

DataType

Type: string

Specifies the valid data type for the parameter.

Description

Type: string

Provides a description of the parameter.

IsModifiable

Type: boolean

Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

MinimumEngineVersion

Type: string

The earliest engine version to which the parameter can apply.

ParameterName

Type: string

Specifies the name of the parameter.

ParameterValue

Type: string

Specifies the value of the parameter.

Source

Type: string

Indicates the source of the parameter value.

PendingCloudwatchLogsExports

Description

A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.

Members

LogTypesToDisable

Type: Array of strings

Log types that are in the process of being enabled. After they are enabled, these log types are exported to Amazon CloudWatch Logs.

LogTypesToEnable

Type: Array of strings

Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.

PendingMaintenanceAction

Description

Provides information about a pending maintenance action for a resource.

Members

Action

Type: string

The type of pending maintenance action that is available for the resource.

AutoAppliedAfterDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date of the maintenance window when the action is applied. The maintenance action is applied to the resource during its first maintenance window after this date. If this date is specified, any next-maintenance opt-in requests are ignored.

CurrentApplyDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The effective date when the pending maintenance action is applied to the resource.

Description

Type: string

A description providing more detail about the maintenance action.

ForcedApplyDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date when the maintenance action is automatically applied. The maintenance action is applied to the resource on this date regardless of the maintenance window for the resource. If this date is specified, any immediate opt-in requests are ignored.

OptInStatus

Type: string

Indicates the type of opt-in request that has been received for the resource.

PendingMaintenanceActionsMessage

Description

Represents the output of DescribePendingMaintenanceActions.

Members

Marker

Type: string

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

PendingMaintenanceActions

Type: Array of ResourcePendingMaintenanceActions structures

The maintenance actions to be applied.

PendingModifiedValues

Description

One or more modified settings for an instance. These modified settings have been requested, but haven't been applied yet.

Members

AllocatedStorage

Type: int

Contains the new AllocatedStorage size for then instance that will be applied or is currently being applied.

BackupRetentionPeriod

Type: int

Specifies the pending number of days for which automated backups are retained.

CACertificateIdentifier

Type: string

Specifies the identifier of the certificate authority (CA) certificate for the DB instance.

DBInstanceClass

Type: string

Contains the new DBInstanceClass for the instance that will be applied or is currently being applied.

DBInstanceIdentifier

Type: string

Contains the new DBInstanceIdentifier for the instance that will be applied or is currently being applied.

DBSubnetGroupName

Type: string

The new subnet group for the instance.

EngineVersion

Type: string

Indicates the database engine version.

Iops

Type: int

Specifies the new Provisioned IOPS value for the instance that will be applied or is currently being applied.

LicenseModel

Type: string

The license model for the instance.

Valid values: license-included, bring-your-own-license, general-public-license

MasterUserPassword

Type: string

Contains the pending or currently in-progress change of the master credentials for the instance.

MultiAZ

Type: boolean

Indicates that the Single-AZ instance is to change to a Multi-AZ deployment.

PendingCloudwatchLogsExports

Type: PendingCloudwatchLogsExports structure

A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.

Port

Type: int

Specifies the pending port for the instance.

StorageType

Type: string

Specifies the storage type to be associated with the instance.

RebootDBInstanceResult

Members

DBInstance

Type: DBInstance structure

Detailed information about an instance.

RemoveFromGlobalClusterResult

Members

GlobalCluster

Type: GlobalCluster structure

A data type representing an Amazon DocumentDB global cluster.

RemoveSourceIdentifierFromSubscriptionResult

Members

EventSubscription

Type: EventSubscription structure

Detailed information about an event to which you have subscribed.

ResourceNotFoundFault

Description

The specified resource ID was not found.

Members

ResourcePendingMaintenanceActions

Description

Represents the output of ApplyPendingMaintenanceAction.

Members

PendingMaintenanceActionDetails

Type: Array of PendingMaintenanceAction structures

A list that provides details about the pending maintenance actions for the resource.

ResourceIdentifier

Type: string

The Amazon Resource Name (ARN) of the resource that has pending maintenance actions.

RestoreDBClusterFromSnapshotResult

Members

DBCluster

Type: DBCluster structure

Detailed information about a cluster.

RestoreDBClusterToPointInTimeResult

Members

DBCluster

Type: DBCluster structure

Type: DBCluster structure

Detailed information about a cluster.

StopDBClusterResult

Members

DBCluster

Type: DBCluster structure

Members

SubnetAvailabilityZone

Type: AvailabilityZone structure

Specifies the Availability Zone for the subnet.

SubnetIdentifier

Type: string

Specifies the identifier of the subnet.

SubnetStatus

Type: string

Members

Key

Type: string

The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").

Value

Type: string

The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").

TagListMessage

Description

Represents the output of ListTagsForResource.

Members

TagList

Type: Array of Tag structures

A list of one or more tags.

UpgradeTarget

Description

The version of the database engine that an instance can be upgraded to.

Members

AutoUpgrade

Type: boolean

A value that indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.

Description

Type: string

The version of the database engine that an instance can be upgraded to.

Engine

Type: string

The name of the upgrade target database engine.

EngineVersion

Type: string

The version number of the upgrade target database engine.

IsMajorVersionUpgrade

Type: boolean

A value that indicates whether a database engine is upgraded to a major version.

VpcSecurityGroupMembership

Description

Used as a response element for queries on virtual private cloud (VPC) security group membership.

Members

Status

Type: string

The status of the VPC security group.

VpcSecurityGroupId

Type: string

The name of the VPC security group.

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

Amazon DocumentDB with MongoDB compatibility 2014-10-31

Operation Summary

Paginators

Waiters

Operations

AddSourceIdentifierToSubscription

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

AddTagsToResource

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

ApplyPendingMaintenanceAction

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CopyDBClusterParameterGroup

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CopyDBClusterSnapshot

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateDBCluster

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateDBClusterParameterGroup

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateDBClusterSnapshot

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateDBInstance

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details