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

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

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

Result Syntax

[]

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

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,
        'StorageType' => '<string>',
        'VpcId' => '<string>',
    ],
]

Result Details

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>',
    'ManageMasterUserPassword' => true || false,
    'MasterUserPassword' => '<string>',
    'MasterUserSecretKmsKeyId' => '<string>',
    'MasterUsername' => '<string>',
    'Port' => <integer>,
    'PreSignedUrl' => '<string>',
    'PreferredBackupWindow' => '<string>',
    'PreferredMaintenanceWindow' => '<string>',
    'StorageEncrypted' => true || false,
    'StorageType' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'VpcSecurityGroupIds' => ['<string>', ...],
]);

Parameter Details

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>,
        'MasterUserSecret' => [
            'KmsKeyId' => '<string>',
            'SecretArn' => '<string>',
            'SecretStatus' => '<string>',
        ],
        'MasterUsername' => '<string>',
        'MultiAZ' => true || false,
        'PercentProgress' => '<string>',
        'Port' => <integer>,
        'PreferredBackupWindow' => '<string>',
        'PreferredMaintenanceWindow' => '<string>',
        'ReadReplicaIdentifiers' => ['<string>', ...],
        'ReaderEndpoint' => '<string>',
        'ReplicationSourceIdentifier' => '<string>',
        'Status' => '<string>',
        'StorageEncrypted' => true || false,
        'StorageType' => '<string>',
        'VpcSecurityGroups' => [
            [
                'Status' => '<string>',
                'VpcSecurityGroupId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

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

Result Syntax

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

Result Details

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

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,
        'StorageType' => '<string>',
        'VpcId' => '<string>',
    ],
]

Result Details

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>',
    'CACertificateIdentifier' => '<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

Result Syntax

[
    'DBInstance' => [
        'AutoMinorVersionUpgrade' => true || false,
        'AvailabilityZone' => '<string>',
        'BackupRetentionPeriod' => <integer>,
        'CACertificateIdentifier' => '<string>',
        'CertificateDetails' => [
            'CAIdentifier' => '<string>',
            'ValidTill' => <DateTime>,
        ],
        '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>',
        ],
        'PerformanceInsightsEnabled' => true || false,
        'PerformanceInsightsKMSKeyId' => '<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

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

Result Syntax

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

Result Details

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

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

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.

Parameter Syntax

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

Parameter Details

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

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

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>,
        'MasterUserSecret' => [
            'KmsKeyId' => '<string>',
            'SecretArn' => '<string>',
            'SecretStatus' => '<string>',
        ],
        'MasterUsername' => '<string>',
        'MultiAZ' => true || false,
        'PercentProgress' => '<string>',
        'Port' => <integer>,
        'PreferredBackupWindow' => '<string>',
        'PreferredMaintenanceWindow' => '<string>',
        'ReadReplicaIdentifiers' => ['<string>', ...],
        'ReaderEndpoint' => '<string>',
        'ReplicationSourceIdentifier' => '<string>',
        'Status' => '<string>',
        'StorageEncrypted' => true || false,
        'StorageType' => '<string>',
        'VpcSecurityGroups' => [
            [
                'Status' => '<string>',
                'VpcSecurityGroupId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

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

Result Syntax

[]

Result Details

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.

Parameter Syntax

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

Parameter Details

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,
        'StorageType' => '<string>',
        'VpcId' => '<string>',
    ],
]

Result Details

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

Result Syntax

[
    'DBInstance' => [
        'AutoMinorVersionUpgrade' => true || false,
        'AvailabilityZone' => '<string>',
        'BackupRetentionPeriod' => <integer>,
        'CACertificateIdentifier' => '<string>',
        'CertificateDetails' => [
            'CAIdentifier' => '<string>',
            'ValidTill' => <DateTime>,
        ],
        '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>',
        ],
        'PerformanceInsightsEnabled' => true || false,
        'PerformanceInsightsKMSKeyId' => '<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

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.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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

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

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.

Parameter Syntax

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

Parameter Details

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

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

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

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

Result Syntax

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

Result Details

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

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,
            'StorageType' => '<string>',
            'VpcId' => '<string>',
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

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

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>,
            'MasterUserSecret' => [
                'KmsKeyId' => '<string>',
                'SecretArn' => '<string>',
                'SecretStatus' => '<string>',
            ],
            'MasterUsername' => '<string>',
            'MultiAZ' => true || false,
            'PercentProgress' => '<string>',
            'Port' => <integer>,
            'PreferredBackupWindow' => '<string>',
            'PreferredMaintenanceWindow' => '<string>',
            'ReadReplicaIdentifiers' => ['<string>', ...],
            'ReaderEndpoint' => '<string>',
            'ReplicationSourceIdentifier' => '<string>',
            'Status' => '<string>',
            'StorageEncrypted' => true || false,
            'StorageType' => '<string>',
            'VpcSecurityGroups' => [
                [
                    'Status' => '<string>',
                    'VpcSecurityGroupId' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

[
    'DBInstances' => [
        [
            'AutoMinorVersionUpgrade' => true || false,
            'AvailabilityZone' => '<string>',
            'BackupRetentionPeriod' => <integer>,
            'CACertificateIdentifier' => '<string>',
            'CertificateDetails' => [
                'CAIdentifier' => '<string>',
                'ValidTill' => <DateTime>,
            ],
            '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>',
            ],
            'PerformanceInsightsEnabled' => true || false,
            'PerformanceInsightsKMSKeyId' => '<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

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

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

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

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

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

Result Syntax

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

Result Details

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

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

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

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

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.

Parameter Syntax

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

Parameter Details

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

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

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>,
        'MasterUserSecret' => [
            'KmsKeyId' => '<string>',
            'SecretArn' => '<string>',
            'SecretStatus' => '<string>',
        ],
        'MasterUsername' => '<string>',
        'MultiAZ' => true || false,
        'PercentProgress' => '<string>',
        'Port' => <integer>,
        'PreferredBackupWindow' => '<string>',
        'PreferredMaintenanceWindow' => '<string>',
        'ReadReplicaIdentifiers' => ['<string>', ...],
        'ReaderEndpoint' => '<string>',
        'ReplicationSourceIdentifier' => '<string>',
        'Status' => '<string>',
        'StorageEncrypted' => true || false,
        'StorageType' => '<string>',
        'VpcSecurityGroups' => [
            [
                'Status' => '<string>',
                'VpcSecurityGroupId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

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.

FailoverGlobalCluster

$result = $client->failoverGlobalCluster([/* ... */]);
$promise = $client->failoverGlobalClusterAsync([/* ... */]);

Promotes the specified secondary DB cluster to be the primary DB cluster in the global cluster when failing over a global cluster occurs.

Use this operation to respond to an unplanned event, such as a regional disaster in the primary region. Failing over can result in a loss of write transaction data that wasn't replicated to the chosen secondary before the failover event occurred. However, the recovery process that promotes a DB instance on the chosen seconday DB cluster to be the primary writer DB instance guarantees that the data is in a transactionally consistent state.

Parameter Syntax

$result = $client->failoverGlobalCluster([
    'AllowDataLoss' => true || false,
    'GlobalClusterIdentifier' => '<string>', // REQUIRED
    'Switchover' => true || false,
    'TargetDbClusterIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

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

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.

InvalidDBClusterStateFault:

The cluster isn't in a valid state.

DBClusterNotFoundFault:

DBClusterIdentifier doesn't refer to an existing cluster.

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

Result Syntax

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

Result Details

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([
    'AllowMajorVersionUpgrade' => true || false,
    'ApplyImmediately' => true || false,
    'BackupRetentionPeriod' => <integer>,
    'CloudwatchLogsExportConfiguration' => [
        'DisableLogTypes' => ['<string>', ...],
        'EnableLogTypes' => ['<string>', ...],
    ],
    'DBClusterIdentifier' => '<string>', // REQUIRED
    'DBClusterParameterGroupName' => '<string>',
    'DeletionProtection' => true || false,
    'EngineVersion' => '<string>',
    'ManageMasterUserPassword' => true || false,
    'MasterUserPassword' => '<string>',
    'MasterUserSecretKmsKeyId' => '<string>',
    'NewDBClusterIdentifier' => '<string>',
    'Port' => <integer>,
    'PreferredBackupWindow' => '<string>',
    'PreferredMaintenanceWindow' => '<string>',
    'RotateMasterUserPassword' => true || false,
    'StorageType' => '<string>',
    'VpcSecurityGroupIds' => ['<string>', ...],
]);

Parameter Details

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>,
        'MasterUserSecret' => [
            'KmsKeyId' => '<string>',
            'SecretArn' => '<string>',
            'SecretStatus' => '<string>',
        ],
        'MasterUsername' => '<string>',
        'MultiAZ' => true || false,
        'PercentProgress' => '<string>',
        'Port' => <integer>,
        'PreferredBackupWindow' => '<string>',
        'PreferredMaintenanceWindow' => '<string>',
        'ReadReplicaIdentifiers' => ['<string>', ...],
        'ReaderEndpoint' => '<string>',
        'ReplicationSourceIdentifier' => '<string>',
        'Status' => '<string>',
        'StorageEncrypted' => true || false,
        'StorageType' => '<string>',
        'VpcSecurityGroups' => [
            [
                'Status' => '<string>',
                'VpcSecurityGroupId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

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.

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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>',
    'CertificateRotationRestart' => true || false,
    'CopyTagsToSnapshot' => true || false,
    'DBInstanceClass' => '<string>',
    'DBInstanceIdentifier' => '<string>', // REQUIRED
    'EnablePerformanceInsights' => true || false,
    'NewDBInstanceIdentifier' => '<string>',
    'PerformanceInsightsKMSKeyId' => '<string>',
    'PreferredMaintenanceWindow' => '<string>',
    'PromotionTier' => <integer>,
]);

Parameter Details

Result Syntax

[
    'DBInstance' => [
        'AutoMinorVersionUpgrade' => true || false,
        'AvailabilityZone' => '<string>',
        'BackupRetentionPeriod' => <integer>,
        'CACertificateIdentifier' => '<string>',
        'CertificateDetails' => [
            'CAIdentifier' => '<string>',
            'ValidTill' => <DateTime>,
        ],
        '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>',
        ],
        'PerformanceInsightsEnabled' => true || false,
        'PerformanceInsightsKMSKeyId' => '<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

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

Result Syntax

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

Result Details

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

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

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.

Parameter Syntax

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

Parameter Details

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

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

Result Syntax

[
    'DBInstance' => [
        'AutoMinorVersionUpgrade' => true || false,
        'AvailabilityZone' => '<string>',
        'BackupRetentionPeriod' => <integer>,
        'CACertificateIdentifier' => '<string>',
        'CertificateDetails' => [
            'CAIdentifier' => '<string>',
            'ValidTill' => <DateTime>,
        ],
        '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>',
        ],
        'PerformanceInsightsEnabled' => true || false,
        'PerformanceInsightsKMSKeyId' => '<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

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.

Parameter Syntax

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

Parameter Details

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

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

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

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

Result Syntax

[]

Result Details

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

Result Syntax

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

Result Details

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
    'DBClusterParameterGroupName' => '<string>',
    'DBSubnetGroupName' => '<string>',
    'DeletionProtection' => true || false,
    'EnableCloudwatchLogsExports' => ['<string>', ...],
    'Engine' => '<string>', // REQUIRED
    'EngineVersion' => '<string>',
    'KmsKeyId' => '<string>',
    'Port' => <integer>,
    'SnapshotIdentifier' => '<string>', // REQUIRED
    'StorageType' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'VpcSecurityGroupIds' => ['<string>', ...],
]);

Parameter Details

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>,
        'MasterUserSecret' => [
            'KmsKeyId' => '<string>',
            'SecretArn' => '<string>',
            'SecretStatus' => '<string>',
        ],
        'MasterUsername' => '<string>',
        'MultiAZ' => true || false,
        'PercentProgress' => '<string>',
        'Port' => <integer>,
        'PreferredBackupWindow' => '<string>',
        'PreferredMaintenanceWindow' => '<string>',
        'ReadReplicaIdentifiers' => ['<string>', ...],
        'ReaderEndpoint' => '<string>',
        'ReplicationSourceIdentifier' => '<string>',
        'Status' => '<string>',
        'StorageEncrypted' => true || false,
        'StorageType' => '<string>',
        'VpcSecurityGroups' => [
            [
                'Status' => '<string>',
                'VpcSecurityGroupId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

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
    'StorageType' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'UseLatestRestorableTime' => true || false,
    'VpcSecurityGroupIds' => ['<string>', ...],
]);

Parameter Details

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>,
        'MasterUserSecret' => [
            'KmsKeyId' => '<string>',
            'SecretArn' => '<string>',
            'SecretStatus' => '<string>',
        ],
        'MasterUsername' => '<string>',
        'MultiAZ' => true || false,
        'PercentProgress' => '<string>',
        'Port' => <integer>,
        'PreferredBackupWindow' => '<string>',
        'PreferredMaintenanceWindow' => '<string>',
        'ReadReplicaIdentifiers' => ['<string>', ...],
        'ReaderEndpoint' => '<string>',
        'ReplicationSourceIdentifier' => '<string>',
        'Status' => '<string>',
        'StorageEncrypted' => true || false,
        'StorageType' => '<string>',
        'VpcSecurityGroups' => [
            [
                'Status' => '<string>',
                'VpcSecurityGroupId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

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

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>,
        'MasterUserSecret' => [
            'KmsKeyId' => '<string>',
            'SecretArn' => '<string>',
            'SecretStatus' => '<string>',
        ],
        'MasterUsername' => '<string>',
        'MultiAZ' => true || false,
        'PercentProgress' => '<string>',
        'Port' => <integer>,
        'PreferredBackupWindow' => '<string>',
        'PreferredMaintenanceWindow' => '<string>',
        'ReadReplicaIdentifiers' => ['<string>', ...],
        'ReaderEndpoint' => '<string>',
        'ReplicationSourceIdentifier' => '<string>',
        'Status' => '<string>',
        'StorageEncrypted' => true || false,
        'StorageType' => '<string>',
        'VpcSecurityGroups' => [
            [
                'Status' => '<string>',
                'VpcSecurityGroupId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

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

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>,
        'MasterUserSecret' => [
            'KmsKeyId' => '<string>',
            'SecretArn' => '<string>',
            'SecretStatus' => '<string>',
        ],
        'MasterUsername' => '<string>',
        'MultiAZ' => true || false,
        'PercentProgress' => '<string>',
        'Port' => <integer>,
        'PreferredBackupWindow' => '<string>',
        'PreferredMaintenanceWindow' => '<string>',
        'ReadReplicaIdentifiers' => ['<string>', ...],
        'ReaderEndpoint' => '<string>',
        'ReplicationSourceIdentifier' => '<string>',
        'Status' => '<string>',
        'StorageEncrypted' => true || false,
        'StorageType' => '<string>',
        'VpcSecurityGroups' => [
            [
                'Status' => '<string>',
                'VpcSecurityGroupId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

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.

SwitchoverGlobalCluster

$result = $client->switchoverGlobalCluster([/* ... */]);
$promise = $client->switchoverGlobalClusterAsync([/* ... */]);

Switches over the specified secondary Amazon DocumentDB cluster to be the new primary Amazon DocumentDB cluster in the global database cluster.

Parameter Syntax

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

Parameter Details

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

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.

InvalidDBClusterStateFault:

The cluster isn't in a valid state.