AddRoleToDBCluster

$result = $client->addRoleToDBCluster([/* ... */]);
$promise = $client->addRoleToDBClusterAsync([/* ... */]);

Associates an Identity and Access Management (IAM) role with a DB cluster.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

DBClusterNotFoundFault:

DBClusterIdentifier doesn't refer to an existing DB cluster.

DBClusterRoleAlreadyExistsFault:

The specified IAM role Amazon Resource Name (ARN) is already associated with the specified DB cluster.

InvalidDBClusterStateFault:

The requested operation can't be performed while the cluster is in this state.

DBClusterRoleQuotaExceededFault:

You have exceeded the maximum number of IAM roles that can be associated with the specified DB cluster.

Examples

Example 1: To associate an AWS Identity and Access Management (IAM) role with a DB cluster

The following example associates a role with a DB cluster.

$result = $client->addRoleToDBCluster([
    'DBClusterIdentifier' => 'mydbcluster',
    'RoleArn' => 'arn:aws:iam::123456789012:role/RDSLoadFromS3',
]);

AddRoleToDBInstance

$result = $client->addRoleToDBInstance([/* ... */]);
$promise = $client->addRoleToDBInstanceAsync([/* ... */]);

Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance.

This command doesn't apply to RDS Custom.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

DBInstanceNotFoundFault:

DBInstanceIdentifier doesn't refer to an existing DB instance.

DBInstanceRoleAlreadyExistsFault:

The specified RoleArn or FeatureName value is already associated with the DB instance.

InvalidDBInstanceStateFault:

The DB instance isn't in a valid state.

DBInstanceRoleQuotaExceededFault:

You can't associate any more Amazon Web Services Identity and Access Management (IAM) roles with the DB instance because the quota has been reached.

Examples

Example 1: To associate an AWS Identity and Access Management (IAM) role with a DB instance

The following example adds the role to a DB instance named test-instance.

$result = $client->addRoleToDBInstance([
    'DBInstanceIdentifier' => 'test-instance',
    'FeatureName' => 'S3_INTEGRATION',
    'RoleArn' => 'arn:aws:iam::111122223333:role/rds-s3-integration-role',
]);

AddSourceIdentifierToSubscription

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

Adds a source identifier to an existing RDS 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.

Examples

Example 1: To add a source identifier to a subscription

The following example adds another source identifier to an existing subscription.

$result = $client->addSourceIdentifierToSubscription([
    'SourceIdentifier' => 'test-instance-repl',
    'SubscriptionName' => 'my-instance-events',
]);

Result syntax:

[
    'EventSubscription' => [
        'CustSubscriptionId' => 'my-instance-events',
        'CustomerAwsId' => '123456789012',
        'Enabled' => ,
        'EventCategoriesList' => [
            'backup',
            'recovery',
        ],
        'EventSubscriptionArn' => 'arn:aws:rds:us-east-1:123456789012:es:my-instance-events',
        'SnsTopicArn' => 'arn:aws:sns:us-east-1:123456789012:interesting-events',
        'SourceIdsList' => [
            'test-instance',
            'test-instance-repl',
        ],
        'SourceType' => 'db-instance',
        'Status' => 'modifying',
        'SubscriptionCreationTime' => 'Tue Jul 31 23:22:01 UTC 2018',
    ],
]

AddTagsToResource

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

Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS.

For an overview on tagging your relational database resources, see Tagging Amazon RDS Resources or Tagging Amazon Aurora and Amazon RDS Resources.

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

DBClusterNotFoundFault:

DBClusterIdentifier doesn't refer to an existing DB cluster.

DBSnapshotNotFoundFault:

DBSnapshotIdentifier doesn't refer to an existing DB snapshot.

DBProxyNotFoundFault:

The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

DBProxyTargetGroupNotFoundFault:

The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

BlueGreenDeploymentNotFoundFault:

BlueGreenDeploymentIdentifier doesn't refer to an existing blue/green deployment.

IntegrationNotFoundFault:

The specified integration could not be found.

TenantDatabaseNotFoundFault:

The specified tenant database wasn't found in the DB instance.

DBSnapshotTenantDatabaseNotFoundFault:

The specified snapshot tenant database wasn't found.

Examples

Example 1: To add tags to a resource

This example adds a tag to an option group.

$result = $client->addTagsToResource([
    'ResourceName' => 'arn:aws:rds:us-east-1:992648334831:og:mymysqloptiongroup',
    'Tags' => [
        [
            'Key' => 'Staging',
            'Value' => 'LocationDB',
        ],
    ],
]);

ApplyPendingMaintenanceAction

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

Applies a pending maintenance action to a resource (for example, to a DB 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 requested operation can't be performed while the cluster is in this state.

InvalidDBInstanceStateFault:

The DB instance isn't in a valid state.

Examples

Example 1: To apply pending maintenance actions

The following example applies the pending maintenance actions for a DB cluster.

$result = $client->applyPendingMaintenanceAction([
    'ApplyAction' => 'system-update',
    'OptInType' => 'immediate',
    'ResourceIdentifier' => 'arn:aws:rds:us-east-1:123456789012:cluster:my-db-cluster',
]);

Result syntax:

[
    'ResourcePendingMaintenanceActions' => [
        'PendingMaintenanceActionDetails' => [
            [
                'Action' => 'system-update',
                'CurrentApplyDate' => ,
                'Description' => 'Upgrade to Aurora PostgreSQL 3.3.2',
                'OptInStatus' => 'immediate',
            ],
        ],
        'ResourceIdentifier' => 'arn:aws:rds:us-east-1:123456789012:cluster:my-db-cluster',
    ],
]

AuthorizeDBSecurityGroupIngress

$result = $client->authorizeDBSecurityGroupIngress([/* ... */]);
$promise = $client->authorizeDBSecurityGroupIngressAsync([/* ... */]);

Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).

You can't authorize ingress from an EC2 security group in one Amazon Web Services Region to an Amazon RDS DB instance in another. You can't authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.

For an overview of CIDR ranges, go to the Wikipedia Tutorial.

Parameter Syntax

$result = $client->authorizeDBSecurityGroupIngress([
    'CIDRIP' => '<string>',
    'DBSecurityGroupName' => '<string>', // REQUIRED
    'EC2SecurityGroupId' => '<string>',
    'EC2SecurityGroupName' => '<string>',
    'EC2SecurityGroupOwnerId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'DBSecurityGroup' => [
        'DBSecurityGroupArn' => '<string>',
        'DBSecurityGroupDescription' => '<string>',
        'DBSecurityGroupName' => '<string>',
        'EC2SecurityGroups' => [
            [
                'EC2SecurityGroupId' => '<string>',
                'EC2SecurityGroupName' => '<string>',
                'EC2SecurityGroupOwnerId' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'IPRanges' => [
            [
                'CIDRIP' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'OwnerId' => '<string>',
        'VpcId' => '<string>',
    ],
]

Result Details

Errors

DBSecurityGroupNotFoundFault:

DBSecurityGroupName doesn't refer to an existing DB security group.

InvalidDBSecurityGroupStateFault:

The state of the DB security group doesn't allow deletion.

AuthorizationAlreadyExistsFault:

The specified CIDR IP range or Amazon EC2 security group is already authorized for the specified DB security group.

AuthorizationQuotaExceededFault:

The DB security group authorization quota has been reached.

Examples

Example 1: To authorize DB security group integress

This example authorizes access to the specified security group by the specified CIDR block.

$result = $client->authorizeDBSecurityGroupIngress([
    'CIDRIP' => '203.0.113.5/32',
    'DBSecurityGroupName' => 'mydbsecuritygroup',
]);

Result syntax:

[
    'DBSecurityGroup' => [
    ],
]

BacktrackDBCluster

$result = $client->backtrackDBCluster([/* ... */]);
$promise = $client->backtrackDBClusterAsync([/* ... */]);

Backtracks a DB cluster to a specific time, without creating a new DB cluster.

For more information on backtracking, see Backtracking an Aurora DB Cluster in the Amazon Aurora User Guide.

Parameter Syntax

$result = $client->backtrackDBCluster([
    'BacktrackTo' => <integer || string || DateTime>, // REQUIRED
    'DBClusterIdentifier' => '<string>', // REQUIRED
    'Force' => true || false,
    'UseEarliestTimeOnPointInTimeUnavailable' => true || false,
]);

Parameter Details

Result Syntax

[
    'BacktrackIdentifier' => '<string>',
    'BacktrackRequestCreationTime' => <DateTime>,
    'BacktrackTo' => <DateTime>,
    'BacktrackedFrom' => <DateTime>,
    'DBClusterIdentifier' => '<string>',
    'Status' => '<string>',
]

Result Details

Errors

DBClusterNotFoundFault:

DBClusterIdentifier doesn't refer to an existing DB cluster.

InvalidDBClusterStateFault:

The requested operation can't be performed while the cluster is in this state.

CancelExportTask

$result = $client->cancelExportTask([/* ... */]);
$promise = $client->cancelExportTaskAsync([/* ... */]);

Cancels an export task in progress that is exporting a snapshot or cluster to Amazon S3. Any data that has already been written to the S3 bucket isn't removed.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'ExportOnly' => ['<string>', ...],
    'ExportTaskIdentifier' => '<string>',
    'FailureCause' => '<string>',
    'IamRoleArn' => '<string>',
    'KmsKeyId' => '<string>',
    'PercentProgress' => <integer>,
    'S3Bucket' => '<string>',
    'S3Prefix' => '<string>',
    'SnapshotTime' => <DateTime>,
    'SourceArn' => '<string>',
    'SourceType' => 'SNAPSHOT|CLUSTER',
    'Status' => '<string>',
    'TaskEndTime' => <DateTime>,
    'TaskStartTime' => <DateTime>,
    'TotalExtractedDataInGB' => <integer>,
    'WarningMessage' => '<string>',
]

Result Details

Errors

ExportTaskNotFoundFault:

The export task doesn't exist.

InvalidExportTaskStateFault:

You can't cancel an export task that has completed.

Examples

Example 1: To cancel a snapshot export to Amazon S3

The following example cancels an export task in progress that is exporting a snapshot to Amazon S3.

$result = $client->cancelExportTask([
    'ExportTaskIdentifier' => 'my-s3-export-1',
]);

Result syntax:

[
    'ExportTaskIdentifier' => 'my-s3-export-1',
    'IamRoleArn' => 'arn:aws:iam::123456789012:role/service-role/export-snap-S3-role',
    'KmsKeyId' => 'arn:aws:kms:us-east-1:123456789012:key/abcd0000-7bfd-4594-af38-aabbccddeeff',
    'PercentProgress' => 0,
    'S3Bucket' => 'mybucket',
    'S3Prefix' => '',
    'SnapshotTime' => ,
    'SourceArn' => 'arn:aws:rds:us-east-1:123456789012:snapshot:publisher-final-snapshot',
    'Status' => 'CANCELING',
    'TotalExtractedDataInGB' => 0,
]

CopyDBClusterParameterGroup

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

Copies the specified DB 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 DB parameter group.

DBParameterGroupQuotaExceededFault:

The request would result in the user exceeding the allowed number of DB parameter groups.

DBParameterGroupAlreadyExistsFault:

A DB parameter group with the same name exists.

Examples

Example 1: To copy a DB cluster parameter group

This example copies a DB cluster parameter group.

$result = $client->copyDBClusterParameterGroup([
    'SourceDBClusterParameterGroupIdentifier' => 'mydbclusterparametergroup',
    'TargetDBClusterParameterGroupDescription' => 'My DB cluster parameter group copy',
    'TargetDBClusterParameterGroupIdentifier' => 'mydbclusterparametergroup-copy',
]);

Result syntax:

[
    'DBClusterParameterGroup' => [
        'DBClusterParameterGroupArn' => 'arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterparametergroup-copy',
        'DBClusterParameterGroupName' => 'mydbclusterparametergroup-copy',
        'DBParameterGroupFamily' => 'aurora-mysql5.7',
        'Description' => 'My DB cluster parameter group copy',
    ],
]

CopyDBClusterSnapshot

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

Copies a snapshot of a DB cluster.

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

You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case, the Amazon Web Services Region where you call the CopyDBClusterSnapshot operation is the destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another Amazon Web Services Region, you must provide the following values:

• KmsKeyId - The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region.

• TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination Amazon Web Services Region.

• SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the ARN format for the source Amazon Web Services Region and is the same value as the SourceDBClusterSnapshotIdentifier in the presigned URL.

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

For more information on copying encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region to another, see Copying a Snapshot in the Amazon Aurora User Guide.

For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'DBClusterSnapshot' => [
        'AllocatedStorage' => <integer>,
        'AvailabilityZones' => ['<string>', ...],
        'ClusterCreateTime' => <DateTime>,
        'DBClusterIdentifier' => '<string>',
        'DBClusterSnapshotArn' => '<string>',
        'DBClusterSnapshotIdentifier' => '<string>',
        'DBSystemId' => '<string>',
        'DbClusterResourceId' => '<string>',
        'Engine' => '<string>',
        'EngineMode' => '<string>',
        'EngineVersion' => '<string>',
        'IAMDatabaseAuthenticationEnabled' => true || false,
        'KmsKeyId' => '<string>',
        'LicenseModel' => '<string>',
        'MasterUsername' => '<string>',
        'PercentProgress' => <integer>,
        'Port' => <integer>,
        'SnapshotCreateTime' => <DateTime>,
        'SnapshotType' => '<string>',
        'SourceDBClusterSnapshotArn' => '<string>',
        'Status' => '<string>',
        'StorageEncrypted' => true || false,
        'StorageThroughput' => <integer>,
        'StorageType' => '<string>',
        'TagList' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VpcId' => '<string>',
    ],
]

Result Details

Errors

DBClusterSnapshotAlreadyExistsFault:

The user already has a DB cluster snapshot with the given identifier.

DBClusterSnapshotNotFoundFault:

DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.

InvalidDBClusterStateFault:

The requested operation can't be performed while the cluster is in this state.

InvalidDBClusterSnapshotStateFault:

The supplied value isn't a valid DB cluster snapshot state.

SnapshotQuotaExceededFault:

The request would result in the user exceeding the allowed number of DB snapshots.

KMSKeyNotAccessibleFault:

An error occurred accessing an Amazon Web Services KMS key.

Examples

Example 1: To copy a DB cluster snapshot

The following example creates a copy of a DB cluster snapshot, including its tags.

$result = $client->copyDBClusterSnapshot([
    'CopyTags' => 1,
    'SourceDBClusterSnapshotIdentifier' => 'arn:aws:rds:us-east-1:123456789012:cluster-snapshot:rds:myaurora-2019-06-04-09-16',
    'TargetDBClusterSnapshotIdentifier' => 'myclustersnapshotcopy',
]);

Result syntax:

[
    'DBClusterSnapshot' => [
        'AllocatedStorage' => 0,
        'AvailabilityZones' => [
            'us-east-1a',
            'us-east-1b',
            'us-east-1e',
        ],
        'ClusterCreateTime' => ,
        'DBClusterIdentifier' => 'myaurora',
        'DBClusterSnapshotArn' => 'arn:aws:rds:us-east-1:123456789012:cluster-snapshot:myclustersnapshotcopy',
        'DBClusterSnapshotIdentifier' => 'myclustersnapshotcopy',
        'Engine' => 'aurora-mysql',
        'EngineVersion' => '5.7.mysql_aurora.2.04.2',
        'IAMDatabaseAuthenticationEnabled' => ,
        'KmsKeyId' => 'arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE',
        'LicenseModel' => 'aurora-mysql',
        'MasterUsername' => 'myadmin',
        'PercentProgress' => 100,
        'Port' => 0,
        'SnapshotCreateTime' => ,
        'SnapshotType' => 'manual',
        'Status' => 'available',
        'StorageEncrypted' => 1,
        'VpcId' => 'vpc-123example',
    ],
]

CopyDBParameterGroup

$result = $client->copyDBParameterGroup([/* ... */]);
$promise = $client->copyDBParameterGroupAsync([/* ... */]);

Copies the specified DB parameter group.

Parameter Syntax

$result = $client->copyDBParameterGroup([
    'SourceDBParameterGroupIdentifier' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'TargetDBParameterGroupDescription' => '<string>', // REQUIRED
    'TargetDBParameterGroupIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DBParameterGroup' => [
        'DBParameterGroupArn' => '<string>',
        'DBParameterGroupFamily' => '<string>',
        'DBParameterGroupName' => '<string>',
        'Description' => '<string>',
    ],
]

Result Details

Errors

DBParameterGroupNotFoundFault:

DBParameterGroupName doesn't refer to an existing DB parameter group.

DBParameterGroupAlreadyExistsFault:

A DB parameter group with the same name exists.

DBParameterGroupQuotaExceededFault:

The request would result in the user exceeding the allowed number of DB parameter groups.

Examples

Example 1: To copy a DB parameter group

The following example makes a copy of a DB parameter group.

$result = $client->copyDBParameterGroup([
    'SourceDBParameterGroupIdentifier' => 'mydbpg',
    'TargetDBParameterGroupDescription' => 'Copy of mydbpg parameter group',
    'TargetDBParameterGroupIdentifier' => 'mydbpgcopy',
]);

Result syntax:

[
    'DBParameterGroup' => [
        'DBParameterGroupArn' => 'arn:aws:rds:us-east-1:814387698303:pg:mydbpgcopy',
        'DBParameterGroupFamily' => 'mysql5.7',
        'DBParameterGroupName' => 'mydbpgcopy',
        'Description' => 'Copy of mydbpg parameter group',
    ],
]

CopyDBSnapshot

$result = $client->copyDBSnapshot([/* ... */]);
$promise = $client->copyDBSnapshotAsync([/* ... */]);

Copies the specified DB snapshot. The source DB snapshot must be in the available state.

You can copy a snapshot from one Amazon Web Services Region to another. In that case, the Amazon Web Services Region where you call the CopyDBSnapshot operation is the destination Amazon Web Services Region for the DB snapshot copy.

This command doesn't apply to RDS Custom.

For more information about copying snapshots, see Copying a DB Snapshot in the Amazon RDS User Guide.

Parameter Syntax

$result = $client->copyDBSnapshot([
    'CopyOptionGroup' => true || false,
    'CopyTags' => true || false,
    'DestinationRegion' => '<string>',
    'KmsKeyId' => '<string>',
    'OptionGroupName' => '<string>',
    'PreSignedUrl' => '<string>',
    'SourceDBSnapshotIdentifier' => '<string>', // REQUIRED
    'SourceRegion' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'TargetCustomAvailabilityZone' => '<string>',
    'TargetDBSnapshotIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DBSnapshot' => [
        'AllocatedStorage' => <integer>,
        'AvailabilityZone' => '<string>',
        'DBInstanceIdentifier' => '<string>',
        'DBSnapshotArn' => '<string>',
        'DBSnapshotIdentifier' => '<string>',
        'DBSystemId' => '<string>',
        'DbiResourceId' => '<string>',
        'DedicatedLogVolume' => true || false,
        'Encrypted' => true || false,
        'Engine' => '<string>',
        'EngineVersion' => '<string>',
        'IAMDatabaseAuthenticationEnabled' => true || false,
        'InstanceCreateTime' => <DateTime>,
        'Iops' => <integer>,
        'KmsKeyId' => '<string>',
        'LicenseModel' => '<string>',
        'MasterUsername' => '<string>',
        'MultiTenant' => true || false,
        'OptionGroupName' => '<string>',
        'OriginalSnapshotCreateTime' => <DateTime>,
        'PercentProgress' => <integer>,
        'Port' => <integer>,
        'ProcessorFeatures' => [
            [
                'Name' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'SnapshotCreateTime' => <DateTime>,
        'SnapshotDatabaseTime' => <DateTime>,
        'SnapshotTarget' => '<string>',
        'SnapshotType' => '<string>',
        'SourceDBSnapshotIdentifier' => '<string>',
        'SourceRegion' => '<string>',
        'Status' => '<string>',
        'StorageThroughput' => <integer>,
        'StorageType' => '<string>',
        'TagList' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'TdeCredentialArn' => '<string>',
        'Timezone' => '<string>',
        'VpcId' => '<string>',
    ],
]

Result Details

Errors

DBSnapshotAlreadyExistsFault:

DBSnapshotIdentifier is already used by an existing snapshot.

DBSnapshotNotFoundFault:

DBSnapshotIdentifier doesn't refer to an existing DB snapshot.

InvalidDBSnapshotStateFault:

The state of the DB snapshot doesn't allow deletion.

SnapshotQuotaExceededFault:

The request would result in the user exceeding the allowed number of DB snapshots.

KMSKeyNotAccessibleFault:

An error occurred accessing an Amazon Web Services KMS key.

CustomAvailabilityZoneNotFoundFault:

CustomAvailabilityZoneId doesn't refer to an existing custom Availability Zone identifier.

Examples

Example 1: To copy a DB snapshot

The following example creates a copy of a DB snapshot.

$result = $client->copyDBSnapshot([
    'SourceDBSnapshotIdentifier' => 'rds:database-mysql-2019-06-06-08-38',
    'TargetDBSnapshotIdentifier' => 'mydbsnapshotcopy',
]);

Result syntax:

[
    'DBSnapshot' => [
        'AllocatedStorage' => 100,
        'AvailabilityZone' => 'us-east-1f',
        'DBInstanceIdentifier' => 'database-mysql',
        'DBSnapshotArn' => 'arn:aws:rds:us-east-1:123456789012:snapshot:mydbsnapshotcopy',
        'DBSnapshotIdentifier' => 'mydbsnapshotcopy',
        'DbiResourceId' => 'db-ZI7UJ5BLKMBYFGX7FDENCKADC4',
        'Encrypted' => 1,
        'Engine' => 'mysql',
        'EngineVersion' => '5.6.40',
        'IAMDatabaseAuthenticationEnabled' => ,
        'InstanceCreateTime' => ,
        'Iops' => 1000,
        'KmsKeyId' => 'arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE',
        'LicenseModel' => 'general-public-license',
        'MasterUsername' => 'admin',
        'OptionGroupName' => 'default:mysql-5-6',
        'PercentProgress' => 0,
        'Port' => 3306,
        'ProcessorFeatures' => [
        ],
        'SnapshotType' => 'manual',
        'SourceDBSnapshotIdentifier' => 'arn:aws:rds:us-east-1:123456789012:snapshot:rds:database-mysql-2019-06-06-08-38',
        'SourceRegion' => 'us-east-1',
        'Status' => 'creating',
        'StorageType' => 'io1',
        'VpcId' => 'vpc-6594f31c',
    ],
]

CopyOptionGroup

$result = $client->copyOptionGroup([/* ... */]);
$promise = $client->copyOptionGroupAsync([/* ... */]);

Copies the specified option group.

Parameter Syntax

$result = $client->copyOptionGroup([
    'SourceOptionGroupIdentifier' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'TargetOptionGroupDescription' => '<string>', // REQUIRED
    'TargetOptionGroupIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'OptionGroup' => [
        'AllowsVpcAndNonVpcInstanceMemberships' => true || false,
        'CopyTimestamp' => <DateTime>,
        'EngineName' => '<string>',
        'MajorEngineVersion' => '<string>',
        'OptionGroupArn' => '<string>',
        'OptionGroupDescription' => '<string>',
        'OptionGroupName' => '<string>',
        'Options' => [
            [
                'DBSecurityGroupMemberships' => [
                    [
                        'DBSecurityGroupName' => '<string>',
                        'Status' => '<string>',
                    ],
                    // ...
                ],
                'OptionDescription' => '<string>',
                'OptionName' => '<string>',
                'OptionSettings' => [
                    [
                        'AllowedValues' => '<string>',
                        'ApplyType' => '<string>',
                        'DataType' => '<string>',
                        'DefaultValue' => '<string>',
                        'Description' => '<string>',
                        'IsCollection' => true || false,
                        'IsModifiable' => true || false,
                        'Name' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'OptionVersion' => '<string>',
                'Permanent' => true || false,
                'Persistent' => true || false,
                'Port' => <integer>,
                'VpcSecurityGroupMemberships' => [
                    [
                        'Status' => '<string>',
                        'VpcSecurityGroupId' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'SourceAccountId' => '<string>',
        'SourceOptionGroup' => '<string>',
        'VpcId' => '<string>',
    ],
]

Result Details

Errors

OptionGroupAlreadyExistsFault:

The option group you are trying to create already exists.

OptionGroupNotFoundFault:

The specified option group could not be found.

OptionGroupQuotaExceededFault:

The quota of 20 option groups was exceeded for this Amazon Web Services account.

Examples

Example 1: To copy an option group

The following example makes a copy of an option group.

$result = $client->copyOptionGroup([
    'SourceOptionGroupIdentifier' => 'myoptiongroup',
    'TargetOptionGroupDescription' => 'My option group copy',
    'TargetOptionGroupIdentifier' => 'new-option-group',
]);

Result syntax:

[
    'OptionGroup' => [
        'AllowsVpcAndNonVpcInstanceMemberships' => 1,
        'EngineName' => 'oracle-ee',
        'MajorEngineVersion' => '11.2',
        'OptionGroupArn' => 'arn:aws:rds:us-east-1:123456789012:og:new-option-group',
        'OptionGroupDescription' => 'My option group copy',
        'OptionGroupName' => 'new-option-group',
        'Options' => [
        ],
    ],
]

CreateBlueGreenDeployment

$result = $client->createBlueGreenDeployment([/* ... */]);
$promise = $client->createBlueGreenDeploymentAsync([/* ... */]);

Creates a blue/green deployment.

A blue/green deployment creates a staging environment that copies the production environment. In a blue/green deployment, the blue environment is the current production environment. The green environment is the staging environment, and it stays in sync with the current production environment.

You can make changes to the databases in the green environment without affecting production workloads. For example, you can upgrade the major or minor DB engine version, change database parameters, or make schema changes in the staging environment. You can thoroughly test changes in the green environment. When ready, you can switch over the environments to promote the green environment to be the new production environment. The switchover typically takes under a minute.

For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.

Parameter Syntax

$result = $client->createBlueGreenDeployment([
    'BlueGreenDeploymentName' => '<string>', // REQUIRED
    'Source' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'TargetAllocatedStorage' => <integer>,
    'TargetDBClusterParameterGroupName' => '<string>',
    'TargetDBInstanceClass' => '<string>',
    'TargetDBParameterGroupName' => '<string>',
    'TargetEngineVersion' => '<string>',
    'TargetIops' => <integer>,
    'TargetStorageThroughput' => <integer>,
    'TargetStorageType' => '<string>',
    'UpgradeTargetStorageConfig' => true || false,
]);

Parameter Details

Result Syntax

[
    'BlueGreenDeployment' => [
        'BlueGreenDeploymentIdentifier' => '<string>',
        'BlueGreenDeploymentName' => '<string>',
        'CreateTime' => <DateTime>,
        'DeleteTime' => <DateTime>,
        'Source' => '<string>',
        'Status' => '<string>',
        'StatusDetails' => '<string>',
        'SwitchoverDetails' => [
            [
                'SourceMember' => '<string>',
                'Status' => '<string>',
                'TargetMember' => '<string>',
            ],
            // ...
        ],
        'TagList' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Target' => '<string>',
        'Tasks' => [
            [
                'Name' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

DBInstanceNotFoundFault:

DBInstanceIdentifier doesn't refer to an existing DB instance.

DBClusterNotFoundFault:

DBClusterIdentifier doesn't refer to an existing DB cluster.

SourceDatabaseNotSupportedFault:

The source DB instance isn't supported for a blue/green deployment.

SourceClusterNotSupportedFault:

The source DB cluster isn't supported for a blue/green deployment.

BlueGreenDeploymentAlreadyExistsFault:

A blue/green deployment with the specified name already exists.

DBParameterGroupNotFoundFault:

DBParameterGroupName doesn't refer to an existing DB parameter group.

DBClusterParameterGroupNotFoundFault:

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

InstanceQuotaExceededFault:

The request would result in the user exceeding the allowed number of DB instances.

DBClusterQuotaExceededFault:

The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.

InvalidDBInstanceStateFault:

The DB instance isn't in a valid state.

InvalidDBClusterStateFault:

The requested operation can't be performed while the cluster is in this state.

Examples

Example 1: To create a blue/green deployment for an RDS for MySQL DB instance

The following example creates a blue/green deployment for a MySQL DB instance.

$result = $client->createBlueGreenDeployment([
    'BlueGreenDeploymentName' => 'bgd-test-instance',
    'Source' => 'arn:aws:rds:us-east-1:123456789012:db:my-db-instance',
    'TargetDBParameterGroupName' => 'mysql-80-group',
    'TargetEngineVersion' => '8.0',
]);

Result syntax:

[
    'BlueGreenDeployment' => [
        'BlueGreenDeploymentIdentifier' => 'bgd-v53303651eexfake',
        'BlueGreenDeploymentName' => 'bgd-cli-test-instance',
        'CreateTime' => ,
        'Source' => 'arn:aws:rds:us-east-1:123456789012:db:my-db-instance',
        'Status' => 'PROVISIONING',
        'SwitchoverDetails' => [
            [
                'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-db-instance',
            ],
            [
                'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-1',
            ],
            [
                'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-2',
            ],
            [
                'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-3',
            ],
        ],
        'Tasks' => [
            [
                'Name' => 'CREATING_READ_REPLICA_OF_SOURCE',
                'Status' => 'PENDING',
            ],
            [
                'Name' => 'DB_ENGINE_VERSION_UPGRADE',
                'Status' => 'PENDING',
            ],
            [
                'Name' => 'CONFIGURE_BACKUPS',
                'Status' => 'PENDING',
            ],
            [
                'Name' => 'CREATING_TOPOLOGY_OF_SOURCE',
                'Status' => 'PENDING',
            ],
        ],
    ],
]

Example 2: To create a blue/green deployment for an Aurora MySQL DB cluster

The following example creates a blue/green deployment for an Aurora MySQL DB cluster.

$result = $client->createBlueGreenDeployment([
    'BlueGreenDeploymentName' => 'my-blue-green-deployment',
    'Source' => 'arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster',
    'TargetDBClusterParameterGroupName' => 'mysql-80-cluster-group',
    'TargetDBParameterGroupName' => 'ams-80-binlog-enabled',
    'TargetEngineVersion' => '8.0',
]);

Result syntax:

[
    'BlueGreenDeployment' => [
        'BlueGreenDeploymentIdentifier' => 'bgd-wi89nwzglccsfake',
        'BlueGreenDeploymentName' => 'my-blue-green-deployment',
        'CreateTime' => ,
        'Source' => 'arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster',
        'Status' => 'PROVISIONING',
        'SwitchoverDetails' => [
            [
                'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster',
                'Status' => 'PROVISIONING',
            ],
            [
                'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-1',
                'Status' => 'PROVISIONING',
            ],
            [
                'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-2',
                'Status' => 'PROVISIONING',
            ],
            [
                'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-3',
                'Status' => 'PROVISIONING',
            ],
            [
                'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-excluded-member-endpoint',
                'Status' => 'PROVISIONING',
            ],
            [
                'SourceMember' => 'arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-reader-endpoint',
                'Status' => 'PROVISIONING',
            ],
        ],
        'Tasks' => [
            [
                'Name' => 'CREATING_READ_REPLICA_OF_SOURCE',
                'Status' => 'PENDING',
            ],
            [
                'Name' => 'DB_ENGINE_VERSION_UPGRADE',
                'Status' => 'PENDING',
            ],
            [
                'Name' => 'CREATE_DB_INSTANCES_FOR_CLUSTER',
                'Status' => 'PENDING',
            ],
            [
                'Name' => 'CREATE_CUSTOM_ENDPOINTS',
                'Status' => 'PENDING',
            ],
        ],
    ],
]

CreateCustomDBEngineVersion

$result = $client->createCustomDBEngineVersion([/* ... */]);
$promise = $client->createCustomDBEngineVersionAsync([/* ... */]);

Creates a custom DB engine version (CEV).

Parameter Syntax

$result = $client->createCustomDBEngineVersion([
    'DatabaseInstallationFilesS3BucketName' => '<string>',
    'DatabaseInstallationFilesS3Prefix' => '<string>',
    'Description' => '<string>',
    'Engine' => '<string>', // REQUIRED
    'EngineVersion' => '<string>', // REQUIRED
    'ImageId' => '<string>',
    'KMSKeyId' => '<string>',
    'Manifest' => '<string>',
    'SourceCustomDbEngineVersionIdentifier' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'UseAwsProvidedLatestImage' => true || false,
]);

Parameter Details

Result Syntax

[
    'CreateTime' => <DateTime>,
    'CustomDBEngineVersionManifest' => '<string>',
    'DBEngineDescription' => '<string>',
    'DBEngineMediaType' => '<string>',
    'DBEngineVersionArn' => '<string>',
    'DBEngineVersionDescription' => '<string>',
    'DBParameterGroupFamily' => '<string>',
    'DatabaseInstallationFilesS3BucketName' => '<string>',
    'DatabaseInstallationFilesS3Prefix' => '<string>',
    'DefaultCharacterSet' => [
        'CharacterSetDescription' => '<string>',
        'CharacterSetName' => '<string>',
    ],
    'Engine' => '<string>',
    'EngineVersion' => '<string>',
    'ExportableLogTypes' => ['<string>', ...],
    'Image' => [
        'ImageId' => '<string>',
        'Status' => '<string>',
    ],
    'KMSKeyId' => '<string>',
    'MajorEngineVersion' => '<string>',
    'ServerlessV2FeaturesSupport' => [
        'MaxCapacity' => <float>,
        'MinCapacity' => <float>,
    ],
    'Status' => '<string>',
    'SupportedCACertificateIdentifiers' => ['<string>', ...],
    'SupportedCharacterSets' => [
        [
            'CharacterSetDescription' => '<string>',
            'CharacterSetName' => '<string>',
        ],
        // ...
    ],
    'SupportedEngineModes' => ['<string>', ...],
    'SupportedFeatureNames' => ['<string>', ...],
    'SupportedNcharCharacterSets' => [
        [
            'CharacterSetDescription' => '<string>',
            'CharacterSetName' => '<string>',
        ],
        // ...
    ],
    'SupportedTimezones' => [
        [
            'TimezoneName' => '<string>',
        ],
        // ...
    ],
    'SupportsBabelfish' => true || false,
    'SupportsCertificateRotationWithoutRestart' => true || false,
    'SupportsGlobalDatabases' => true || false,
    'SupportsIntegrations' => true || false,
    'SupportsLimitlessDatabase' => true || false,
    'SupportsLocalWriteForwarding' => true || false,
    'SupportsLogExportsToCloudwatchLogs' => true || false,
    'SupportsParallelQuery' => true || false,
    'SupportsReadReplica' => true || false,
    'TagList' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'ValidUpgradeTarget' => [
        [
            'AutoUpgrade' => true || false,
            'Description' => '<string>',
            'Engine' => '<string>',
            'EngineVersion' => '<string>',
            'IsMajorVersionUpgrade' => true || false,
            'SupportedEngineModes' => ['<string>', ...],
            'SupportsBabelfish' => true || false,
            'SupportsGlobalDatabases' => true || false,
            'SupportsIntegrations' => true || false,
            'SupportsLimitlessDatabase' => true || false,
            'SupportsLocalWriteForwarding' => true || false,
            'SupportsParallelQuery' => true || false,
        ],
        // ...
    ],
]

Result Details

Errors

CustomDBEngineVersionAlreadyExistsFault:

A CEV with the specified name already exists.

CustomDBEngineVersionQuotaExceededFault:

You have exceeded your CEV quota.

Ec2ImagePropertiesNotSupportedFault:

The AMI configuration prerequisite has not been met.

KMSKeyNotAccessibleFault:

An error occurred accessing an Amazon Web Services KMS key.

CreateCustomDBEngineVersionFault:

An error occurred while trying to create the CEV.

CreateDBCluster

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

Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.

If you create an Aurora DB cluster, the request creates an empty cluster. You must explicitly create the writer instance for your DB cluster using the CreateDBInstance operation. If you create a Multi-AZ DB cluster, the request creates a writer and two reader DB instances for you, each in a different Availability Zone.

You can use the ReplicationSourceIdentifier parameter to create an Amazon Aurora DB cluster as a read replica of another DB cluster or Amazon RDS for MySQL or PostgreSQL DB instance. For more information about Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.

You can also use the ReplicationSourceIdentifier parameter to create a Multi-AZ DB cluster read replica with an RDS for MySQL or PostgreSQL DB instance as the source. For more information about Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

Parameter Syntax

$result = $client->createDBCluster([
    'AllocatedStorage' => <integer>,
    'AutoMinorVersionUpgrade' => true || false,
    'AvailabilityZones' => ['<string>', ...],
    'BacktrackWindow' => <integer>,
    'BackupRetentionPeriod' => <integer>,
    'CACertificateIdentifier' => '<string>',
    'CharacterSetName' => '<string>',
    'ClusterScalabilityType' => 'standard|limitless',
    'CopyTagsToSnapshot' => true || false,
    'DBClusterIdentifier' => '<string>', // REQUIRED
    'DBClusterInstanceClass' => '<string>',
    'DBClusterParameterGroupName' => '<string>',
    'DBSubnetGroupName' => '<string>',
    'DBSystemId' => '<string>',
    'DatabaseInsightsMode' => 'standard|advanced',
    'DatabaseName' => '<string>',
    'DeletionProtection' => true || false,
    'DestinationRegion' => '<string>',
    'Domain' => '<string>',
    'DomainIAMRoleName' => '<string>',
    'EnableCloudwatchLogsExports' => ['<string>', ...],
    'EnableGlobalWriteForwarding' => true || false,
    'EnableHttpEndpoint' => true || false,
    'EnableIAMDatabaseAuthentication' => true || false,
    'EnableLimitlessDatabase' => true || false,
    'EnableLocalWriteForwarding' => true || false,
    'EnablePerformanceInsights' => true || false,
    'Engine' => '<string>', // REQUIRED
    'EngineLifecycleSupport' => '<string>',
    'EngineMode' => '<string>',
    'EngineVersion' => '<string>',
    'GlobalClusterIdentifier' => '<string>',
    'Iops' => <integer>,
    'KmsKeyId' => '<string>',
    'ManageMasterUserPassword' => true || false,
    'MasterUserPassword' => '<string>',
    'MasterUserSecretKmsKeyId' => '<string>',
    'MasterUsername' => '<string>',
    'MonitoringInterval' => <integer>,
    'MonitoringRoleArn' => '<string>',
    'NetworkType' => '<string>',
    'OptionGroupName' => '<string>',
    'PerformanceInsightsKMSKeyId' => '<string>',
    'PerformanceInsightsRetentionPeriod' => <integer>,
    'Port' => <integer>,
    'PreSignedUrl' => '<string>',
    'PreferredBackupWindow' => '<string>',
    'PreferredMaintenanceWindow' => '<string>',
    'PubliclyAccessible' => true || false,
    'RdsCustomClusterConfiguration' => [
        'InterconnectSubnetId' => '<string>',
        'ReplicaMode' => 'open-read-only|mounted',
        'TransitGatewayMulticastDomainId' => '<string>',
    ],
    'ReplicationSourceIdentifier' => '<string>',
    'ScalingConfiguration' => [
        'AutoPause' => true || false,
        'MaxCapacity' => <integer>,
        'MinCapacity' => <integer>,
        'SecondsBeforeTimeout' => <integer>,
        'SecondsUntilAutoPause' => <integer>,
        'TimeoutAction' => '<string>',
    ],
    'ServerlessV2ScalingConfiguration' => [
        'MaxCapacity' => <float>,
        'MinCapacity' => <float>,
        'SecondsUntilAutoPause' => <integer>,
    ],
    'SourceRegion' => '<string>',
    'StorageEncrypted' => true || false,
    'StorageType' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'VpcSecurityGroupIds' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'DBCluster' => [
        'ActivityStreamKinesisStreamName' => '<string>',
        'ActivityStreamKmsKeyId' => '<string>',
        'ActivityStreamMode' => 'sync|async',
        'ActivityStreamStatus' => 'stopped|starting|started|stopping',
        'AllocatedStorage' => <integer>,
        'AssociatedRoles' => [
            [
                'FeatureName' => '<string>',
                'RoleArn' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'AutoMinorVersionUpgrade' => true || false,
        'AutomaticRestartTime' => <DateTime>,
        'AvailabilityZones' => ['<string>', ...],
        'AwsBackupRecoveryPointArn' => '<string>',
        'BacktrackConsumedChangeRecords' => <integer>,
        'BacktrackWindow' => <integer>,
        'BackupRetentionPeriod' => <integer>,
        'Capacity' => <integer>,
        'CertificateDetails' => [
            'CAIdentifier' => '<string>',
            'ValidTill' => <DateTime>,
        ],
        'CharacterSetName' => '<string>',
        'CloneGroupId' => '<string>',
        'ClusterCreateTime' => <DateTime>,
        'ClusterScalabilityType' => 'standard|limitless',
        'CopyTagsToSnapshot' => true || false,
        'CrossAccountClone' => true || false,
        'CustomEndpoints' => ['<string>', ...],
        'DBClusterArn' => '<string>',
        'DBClusterIdentifier' => '<string>',
        'DBClusterInstanceClass' => '<string>',
        'DBClusterMembers' => [
            [
                'DBClusterParameterGroupStatus' => '<string>',
                'DBInstanceIdentifier' => '<string>',
                'IsClusterWriter' => true || false,
                'PromotionTier' => <integer>,
            ],
            // ...
        ],
        'DBClusterOptionGroupMemberships' => [
            [
                'DBClusterOptionGroupName' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'DBClusterParameterGroup' => '<string>',
        'DBSubnetGroup' => '<string>',
        'DBSystemId' => '<string>',
        'DatabaseInsightsMode' => 'standard|advanced',
        'DatabaseName' => '<string>',
        'DbClusterResourceId' => '<string>',
        'DeletionProtection' => true || false,
        'DomainMemberships' => [
            [
                'AuthSecretArn' => '<string>',
                'DnsIps' => ['<string>', ...],
                'Domain' => '<string>',
                'FQDN' => '<string>',
                'IAMRoleName' => '<string>',
                'OU' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'EarliestBacktrackTime' => <DateTime>,
        'EarliestRestorableTime' => <DateTime>,
        'EnabledCloudwatchLogsExports' => ['<string>', ...],
        'Endpoint' => '<string>',
        'Engine' => '<string>',
        'EngineLifecycleSupport' => '<string>',
        'EngineMode' => '<string>',
        'EngineVersion' => '<string>',
        'GlobalWriteForwardingRequested' => true || false,
        'GlobalWriteForwardingStatus' => 'enabled|disabled|enabling|disabling|unknown',
        'HostedZoneId' => '<string>',
        'HttpEndpointEnabled' => true || false,
        'IAMDatabaseAuthenticationEnabled' => true || false,
        'IOOptimizedNextAllowedModificationTime' => <DateTime>,
        'Iops' => <integer>,
        'KmsKeyId' => '<string>',
        'LatestRestorableTime' => <DateTime>,
        'LimitlessDatabase' => [
            'MinRequiredACU' => <float>,
            'Status' => 'active|not-in-use|enabled|disabled|enabling|disabling|modifying-max-capacity|error',
        ],
        'LocalWriteForwardingStatus' => 'enabled|disabled|enabling|disabling|requested',
        'MasterUserSecret' => [
            'KmsKeyId' => '<string>',
            'SecretArn' => '<string>',
            'SecretStatus' => '<string>',
        ],
        'MasterUsername' => '<string>',
        'MonitoringInterval' => <integer>,
        'MonitoringRoleArn' => '<string>',
        'MultiAZ' => true || false,
        'NetworkType' => '<string>',
        'PendingModifiedValues' => [
            'AllocatedStorage' => <integer>,
            'BackupRetentionPeriod' => <integer>,
            'CertificateDetails' => [
                'CAIdentifier' => '<string>',
                'ValidTill' => <DateTime>,
            ],
            'DBClusterIdentifier' => '<string>',
            'EngineVersion' => '<string>',
            'IAMDatabaseAuthenticationEnabled' => true || false,
            'Iops' => <integer>,
            'MasterUserPassword' => '<string>',
            'PendingCloudwatchLogsExports' => [
                'LogTypesToDisable' => ['<string>', ...],
                'LogTypesToEnable' => ['<string>', ...],
            ],
            'RdsCustomClusterConfiguration' => [
                'InterconnectSubnetId' => '<string>',
                'ReplicaMode' => 'open-read-only|mounted',
                'TransitGatewayMulticastDomainId' => '<string>',
            ],
            'StorageType' => '<string>',
        ],
        'PercentProgress' => '<string>',
        'PerformanceInsightsEnabled' => true || false,
        'PerformanceInsightsKMSKeyId' => '<string>',
        'PerformanceInsightsRetentionPeriod' => <integer>,
        'Port' => <integer>,
        'PreferredBackupWindow' => '<string>',
        'PreferredMaintenanceWindow' => '<string>',
        'PubliclyAccessible' => true || false,
        'RdsCustomClusterConfiguration' => [
            'InterconnectSubnetId' => '<string>',
            'ReplicaMode' => 'open-read-only|mounted',
            'TransitGatewayMulticastDomainId' => '<string>',
        ],
        'ReadReplicaIdentifiers' => ['<string>', ...],
        'ReaderEndpoint' => '<string>',
        'ReplicationSourceIdentifier' => '<string>',
        'ScalingConfigurationInfo' => [
            'AutoPause' => true || false,
            'MaxCapacity' => <integer>,
            'MinCapacity' => <integer>,
            'SecondsBeforeTimeout' => <integer>,
            'SecondsUntilAutoPause' => <integer>,
            'TimeoutAction' => '<string>',
        ],
        'ServerlessV2ScalingConfiguration' => [
            'MaxCapacity' => <float>,
            'MinCapacity' => <float>,
            'SecondsUntilAutoPause' => <integer>,
        ],
        'Status' => '<string>',
        'StatusInfos' => [
            [
                'Message' => '<string>',
                'Normal' => true || false,
                'Status' => '<string>',
                'StatusType' => '<string>',
            ],
            // ...
        ],
        'StorageEncrypted' => true || false,
        'StorageThroughput' => <integer>,
        'StorageType' => '<string>',
        'TagList' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VpcSecurityGroups' => [
            [
                'Status' => '<string>',
                'VpcSecurityGroupId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

DBClusterAlreadyExistsFault:

The user already has a DB cluster with the given identifier.

InsufficientDBInstanceCapacityFault:

The specified DB instance class isn't available in the specified Availability Zone.

InsufficientStorageClusterCapacityFault:

There is insufficient 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 user attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.

StorageQuotaExceededFault:

The request would result in the user exceeding the allowed amount of storage available across all DB instances.

DBSubnetGroupNotFoundFault:

DBSubnetGroupName doesn't refer to an existing DB subnet group.

InvalidVPCNetworkStateFault:

The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.

InvalidDBClusterStateFault:

The requested operation can't be performed while the cluster is in this state.

InvalidDBSubnetGroupFault:

The DBSubnetGroup doesn't belong to the same VPC as that of an existing cross-region read replica of the same source instance.

InvalidDBSubnetGroupStateFault:

The DB subnet group cannot be deleted because it's in use.

InvalidSubnet:

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

InvalidDBInstanceStateFault:

The DB instance isn't in a valid state.

DBClusterParameterGroupNotFoundFault:

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

KMSKeyNotAccessibleFault:

An error occurred accessing an Amazon Web Services KMS key.

DBClusterNotFoundFault:

DBClusterIdentifier doesn't refer to an existing DB cluster.

DBInstanceNotFoundFault:

DBInstanceIdentifier doesn't refer to an existing DB instance.

DBSubnetGroupDoesNotCoverEnoughAZs:

Subnets in the DB 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 database cluster.

InvalidGlobalClusterStateFault:

The global cluster is in an invalid state and can't perform the requested operation.

DomainNotFoundFault:

Domain doesn't refer to an existing Active Directory domain.

OptionGroupNotFoundFault:

The specified option group could not be found.

Examples

Example 1: To create a MySQL 5.7-compatible DB cluster

The following example creates a MySQL 5.7-compatible Aurora DB cluster.

$result = $client->createDBCluster([
    'DBClusterIdentifier' => 'sample-cluster',
    'DBSubnetGroupName' => 'default',
    'Engine' => 'aurora-mysql',
    'EngineVersion' => '5.7.12',
    'MasterUserPassword' => 'mypassword',
    'MasterUsername' => 'admin',
    'VpcSecurityGroupIds' => [
        'sg-0b91305example',
    ],
]);

Result syntax:

[
    'DBCluster' => [
        'AllocatedStorage' => 1,
        'AssociatedRoles' => [
        ],
        'AvailabilityZones' => [
            'us-east-1a',
            'us-east-1b',
            'us-east-1e',
        ],
        'BackupRetentionPeriod' => 1,
        'ClusterCreateTime' => ,
        'CopyTagsToSnapshot' => ,
        'DBClusterArn' => 'arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster',
        'DBClusterIdentifier' => 'sample-cluster',
        'DBClusterMembers' => [
        ],
        'DBClusterParameterGroup' => 'default.aurora-mysql5.7',
        'DBSubnetGroup' => 'default',
        'DbClusterResourceId' => 'cluster-ANPAJ4AE5446DAEXAMPLE',
        'DeletionProtection' => ,
        'Endpoint' => 'sample-cluster.cluster-cnpexample.us-east-1.rds.amazonaws.com',
        'Engine' => 'aurora-mysql',
        'EngineMode' => 'provisioned',
        'EngineVersion' => '5.7.12',
        'HostedZoneId' => 'Z2R2ITUGPM61AM',
        'HttpEndpointEnabled' => ,
        'IAMDatabaseAuthenticationEnabled' => ,
        'MasterUsername' => 'master',
        'MultiAZ' => ,
        'Port' => 3306,
        'PreferredBackupWindow' => '09:12-09:42',
        'PreferredMaintenanceWindow' => 'mon:04:31-mon:05:01',
        'ReadReplicaIdentifiers' => [
        ],
        'ReaderEndpoint' => 'sample-cluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com',
        'Status' => 'creating',
        'StorageEncrypted' => ,
        'VpcSecurityGroups' => [
            [
                'Status' => 'active',
                'VpcSecurityGroupId' => 'sg-0b91305example',
            ],
        ],
    ],
]

Example 2: To create a PostgreSQL-compatible DB cluster

The following example creates a PostgreSQL-compatible Aurora DB cluster.

$result = $client->createDBCluster([
    'DBClusterIdentifier' => 'sample-pg-cluster',
    'DBSubnetGroupName' => 'default',
    'Engine' => 'aurora-postgresql',
    'MasterUserPassword' => 'mypassword',
    'MasterUsername' => 'admin',
    'VpcSecurityGroupIds' => [
        'sg-0b91305example',
    ],
]);

Result syntax:

[
    'DBCluster' => [
        'AllocatedStorage' => 1,
        'AssociatedRoles' => [
        ],
        'AvailabilityZones' => [
            'us-east-1a',
            'us-east-1b',
            'us-east-1c',
        ],
        'BackupRetentionPeriod' => 1,
        'ClusterCreateTime' => ,
        'CopyTagsToSnapshot' => ,
        'DBClusterArn' => 'arn:aws:rds:us-east-1:123456789012:cluster:sample-pg-cluster',
        'DBClusterIdentifier' => 'sample-pg-cluster',
        'DBClusterMembers' => [
        ],
        'DBClusterParameterGroup' => 'default.aurora-postgresql9.6',
        'DBSubnetGroup' => 'default',
        'DbClusterResourceId' => 'cluster-ANPAJ4AE5446DAEXAMPLE',
        'DeletionProtection' => ,
        'Endpoint' => 'sample-pg-cluster.cluster-cnpexample.us-east-1.rds.amazonaws.com',
        'Engine' => 'aurora-postgresql',
        'EngineMode' => 'provisioned',
        'EngineVersion' => '9.6.9',
        'HostedZoneId' => 'Z2R2ITUGPM61AM',
        'HttpEndpointEnabled' => ,
        'IAMDatabaseAuthenticationEnabled' => ,
        'MasterUsername' => 'master',
        'MultiAZ' => ,
        'Port' => 5432,
        'PreferredBackupWindow' => '09:56-10:26',
        'PreferredMaintenanceWindow' => 'wed:03:33-wed:04:03',
        'ReadReplicaIdentifiers' => [
        ],
        'ReaderEndpoint' => 'sample-pg-cluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com',
        'Status' => 'creating',
        'StorageEncrypted' => ,
        'VpcSecurityGroups' => [
            [
                'Status' => 'active',
                'VpcSecurityGroupId' => 'sg-0b91305example',
            ],
        ],
    ],
]

CreateDBClusterEndpoint

$result = $client->createDBClusterEndpoint([/* ... */]);
$promise = $client->createDBClusterEndpointAsync([/* ... */]);

Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.

Parameter Syntax

$result = $client->createDBClusterEndpoint([
    'DBClusterEndpointIdentifier' => '<string>', // REQUIRED
    'DBClusterIdentifier' => '<string>', // REQUIRED
    'EndpointType' => '<string>', // REQUIRED
    'ExcludedMembers' => ['<string>', ...],
    'StaticMembers' => ['<string>', ...],
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'CustomEndpointType' => '<string>',
    'DBClusterEndpointArn' => '<string>',
    'DBClusterEndpointIdentifier' => '<string>',
    'DBClusterEndpointResourceIdentifier' => '<string>',
    'DBClusterIdentifier' => '<string>',
    'Endpoint' => '<string>',
    'EndpointType' => '<string>',
    'ExcludedMembers' => ['<string>', ...],
    'StaticMembers' => ['<string>', ...],
    'Status' => '<string>',
]

Result Details

Errors

DBClusterEndpointQuotaExceededFault:

The cluster already has the maximum number of custom endpoints.

DBClusterEndpointAlreadyExistsFault:

The specified custom endpoint can't be created because it already exists.

DBClusterNotFoundFault:

DBClusterIdentifier doesn't refer to an existing DB cluster.

InvalidDBClusterStateFault:

The requested operation can't be performed while the cluster is in this state.

DBInstanceNotFoundFault:

DBInstanceIdentifier doesn't refer to an existing DB instance.

InvalidDBInstanceStateFault:

The DB instance isn't in a valid state.

Examples

Example 1: To create a custom DB cluster endpoint

The following example creates a custom DB cluster endpoint and associate it with the specified Aurora DB cluster.

$result = $client->createDBClusterEndpoint([
    'DBClusterEndpointIdentifier' => 'mycustomendpoint',
    'DBClusterIdentifier' => 'mydbcluster',
    'EndpointType' => 'reader',
    'StaticMembers' => [
        'dbinstance1',
        'dbinstance2',
    ],
]);

Result syntax:

[
    'CustomEndpointType' => 'READER',
    'DBClusterEndpointArn' => 'arn:aws:rds:us-east-1:123456789012:cluster-endpoint:mycustomendpoint',
    'DBClusterEndpointIdentifier' => 'mycustomendpoint',
    'DBClusterEndpointResourceIdentifier' => 'cluster-endpoint-ANPAJ4AE5446DAEXAMPLE',
    'DBClusterIdentifier' => 'mydbcluster',
    'Endpoint' => 'mycustomendpoint.cluster-custom-cnpexample.us-east-1.rds.amazonaws.com',
    'EndpointType' => 'CUSTOM',
    'ExcludedMembers' => [
    ],
    'StaticMembers' => [
        'dbinstance1',
        'dbinstance2',
    ],
    'Status' => 'creating',
]

CreateDBClusterParameterGroup

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

Creates a new DB cluster parameter group.

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

A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster.

When you associate a new DB cluster parameter group with a running Aurora DB cluster, reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.

When you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.

For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

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:

The request would result in the user exceeding the allowed number of DB parameter groups.

DBParameterGroupAlreadyExistsFault:

A DB parameter group with the same name exists.

Examples

Example 1: To create a DB cluster parameter group

The following example creates a DB cluster parameter group.

$result = $client->createDBClusterParameterGroup([
    'DBClusterParameterGroupName' => 'mydbclusterparametergroup',
    'DBParameterGroupFamily' => 'aurora5.6',
    'Description' => 'My new cluster parameter group',
]);

Result syntax:

[
    'DBClusterParameterGroup' => [
        'DBClusterParameterGroupArn' => 'arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterparametergroup',
        'DBClusterParameterGroupName' => 'mydbclusterparametergroup',
        'DBParameterGroupFamily' => 'aurora5.6',
        'Description' => 'My new cluster parameter group',
    ],
]

CreateDBClusterSnapshot

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

Creates a snapshot of a DB cluster.

For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'DBClusterSnapshot' => [
        'AllocatedStorage' => <integer>,
        'AvailabilityZones' => ['<string>', ...],
        'ClusterCreateTime' => <DateTime>,
        'DBClusterIdentifier' => '<string>',
        'DBClusterSnapshotArn' => '<string>',
        'DBClusterSnapshotIdentifier' => '<string>',
        'DBSystemId' => '<string>',
        'DbClusterResourceId' => '<string>',
        'Engine' => '<string>',
        'EngineMode' => '<string>',
        'EngineVersion' => '<string>',
        'IAMDatabaseAuthenticationEnabled' => true || false,
        'KmsKeyId' => '<string>',
        'LicenseModel' => '<string>',
        'MasterUsername' => '<string>',
        'PercentProgress' => <integer>,
        'Port' => <integer>,
        'SnapshotCreateTime' => <DateTime>,
        'SnapshotType' => '<string>',
        'SourceDBClusterSnapshotArn' => '<string>',
        'Status' => '<string>',
        'StorageEncrypted' => true || false,
        'StorageThroughput' => <integer>,
        'StorageType' => '<string>',
        'TagList' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VpcId' => '<string>',
    ],
]

Result Details

Errors

DBClusterSnapshotAlreadyExistsFault:

The user already has a DB cluster snapshot with the given identifier.

InvalidDBClusterStateFault:

The requested operation can't be performed while the cluster is in this state.

DBClusterNotFoundFault:

DBClusterIdentifier doesn't refer to an existing DB cluster.

SnapshotQuotaExceededFault:

The request would result in the user exceeding the allowed number of DB snapshots.

InvalidDBClusterSnapshotStateFault:

The supplied value isn't a valid DB cluster snapshot state.

Examples

Example 1: To create a DB cluster snapshot

The following example creates a DB cluster snapshot.

$result = $client->createDBClusterSnapshot([
    'DBClusterIdentifier' => 'mydbclustersnapshot',
    'DBClusterSnapshotIdentifier' => 'mydbcluster',
]);

Result syntax:

[
    'DBClusterSnapshot' => [
        'AllocatedStorage' => 1,
        'AvailabilityZones' => [
            'us-east-1a',
            'us-east-1b',
            'us-east-1e',
        ],
        'ClusterCreateTime' => ,
        'DBClusterIdentifier' => 'mydbcluster',
        'DBClusterSnapshotArn' => 'arn:aws:rds:us-east-1:123456789012:cluster-snapshot:mydbclustersnapshot',
        'DBClusterSnapshotIdentifier' => 'mydbclustersnapshot',
        'Engine' => 'aurora-mysql',
        'EngineVersion' => '5.7.mysql_aurora.2.04.2',
        'IAMDatabaseAuthenticationEnabled' => ,
        'KmsKeyId' => 'arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE',
        'LicenseModel' => 'aurora-mysql',
        'MasterUsername' => 'myadmin',
        'PercentProgress' => 0,
        'Port' => 0,
        'SnapshotCreateTime' => ,
        'SnapshotType' => 'manual',
        'Status' => 'creating',
        'StorageEncrypted' => 1,
        'VpcId' => 'vpc-6594f31c',
    ],
]

CreateDBInstance

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

Creates a new DB instance.

The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster. For an Aurora DB cluster, you can call this operation multiple times to add more than one DB instance to the cluster.

For more information about creating an RDS DB instance, see Creating an Amazon RDS DB instance in the Amazon RDS User Guide.

For more information about creating a DB instance in an Aurora DB cluster, see Creating an Amazon Aurora DB cluster in the Amazon Aurora User Guide.

Parameter Syntax

$result = $client->createDBInstance([
    'AllocatedStorage' => <integer>,
    'AutoMinorVersionUpgrade' => true || false,
    'AvailabilityZone' => '<string>',
    'BackupRetentionPeriod' => <integer>,
    'BackupTarget' => '<string>',
    'CACertificateIdentifier' => '<string>',
    'CharacterSetName' => '<string>',
    'CopyTagsToSnapshot' => true || false,
    'CustomIamInstanceProfile' => '<string>',
    'DBClusterIdentifier' => '<string>',
    'DBInstanceClass' => '<string>', // REQUIRED
    'DBInstanceIdentifier' => '<string>', // REQUIRED
    'DBName' => '<string>',
    'DBParameterGroupName' => '<string>',
    'DBSecurityGroups' => ['<string>', ...],
    'DBSubnetGroupName' => '<string>',
    'DBSystemId' => '<string>',
    'DatabaseInsightsMode' => 'standard|advanced',
    'DedicatedLogVolume' => true || false,
    'DeletionProtection' => true || false,
    'Domain' => '<string>',
    'DomainAuthSecretArn' => '<string>',
    'DomainDnsIps' => ['<string>', ...],
    'DomainFqdn' => '<string>',
    'DomainIAMRoleName' => '<string>',
    'DomainOu' => '<string>',
    'EnableCloudwatchLogsExports' => ['<string>', ...],
    'EnableCustomerOwnedIp' => true || false,
    'EnableIAMDatabaseAuthentication' => true || false,
    'EnablePerformanceInsights' => true || false,
    'Engine' => '<string>', // REQUIRED
    'EngineLifecycleSupport' => '<string>',
    'EngineVersion' => '<string>',
    'Iops' => <integer>,
    'KmsKeyId' => '<string>',
    'LicenseModel' => '<string>',
    'ManageMasterUserPassword' => true || false,
    'MasterUserPassword' => '<string>',
    'MasterUserSecretKmsKeyId' => '<string>',
    'MasterUsername' => '<string>',
    'MaxAllocatedStorage' => <integer>,
    'MonitoringInterval' => <integer>,
    'MonitoringRoleArn' => '<string>',
    'MultiAZ' => true || false,
    'MultiTenant' => true || false,
    'NcharCharacterSetName' => '<string>',
    'NetworkType' => '<string>',
    'OptionGroupName' => '<string>',
    'PerformanceInsightsKMSKeyId' => '<string>',
    'PerformanceInsightsRetentionPeriod' => <integer>,
    'Port' => <integer>,
    'PreferredBackupWindow' => '<string>',
    'PreferredMaintenanceWindow' => '<string>',
    'ProcessorFeatures' => [
        [
            'Name' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'PromotionTier' => <integer>,
    'PubliclyAccessible' => true || false,
    'StorageEncrypted' => true || false,
    'StorageThroughput' => <integer>,
    'StorageType' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'TdeCredentialArn' => '<string>',
    'TdeCredentialPassword' => '<string>',
    'Timezone' => '<string>',
    'VpcSecurityGroupIds' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'DBInstance' => [
        'ActivityStreamEngineNativeAuditFieldsIncluded' => true || false,
        'ActivityStreamKinesisStreamName' => '<string>',
        'ActivityStreamKmsKeyId' => '<string>',
        'ActivityStreamMode' => 'sync|async',
        'ActivityStreamPolicyStatus' => 'locked|unlocked|locking-policy|unlocking-policy',
        'ActivityStreamStatus' => 'stopped|starting|started|stopping',
        'AllocatedStorage' => <integer>,
        'AssociatedRoles' => [
            [
                'FeatureName' => '<string>',
                'RoleArn' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'AutoMinorVersionUpgrade' => true || false,
        'AutomaticRestartTime' => <DateTime>,
        'AutomationMode' => 'full|all-paused',
        'AvailabilityZone' => '<string>',
        'AwsBackupRecoveryPointArn' => '<string>',
        'BackupRetentionPeriod' => <integer>,
        'BackupTarget' => '<string>',
        'CACertificateIdentifier' => '<string>',
        'CertificateDetails' => [
            'CAIdentifier' => '<string>',
            'ValidTill' => <DateTime>,
        ],
        'CharacterSetName' => '<string>',
        'CopyTagsToSnapshot' => true || false,
        'CustomIamInstanceProfile' => '<string>',
        'CustomerOwnedIpEnabled' => true || false,
        'DBClusterIdentifier' => '<string>',
        'DBInstanceArn' => '<string>',
        'DBInstanceAutomatedBackupsReplications' => [
            [
                'DBInstanceAutomatedBackupsArn' => '<string>',
            ],
            // ...
        ],
        'DBInstanceClass' => '<string>',
        'DBInstanceIdentifier' => '<string>',
        'DBInstanceStatus' => '<string>',
        'DBName' => '<string>',
        'DBParameterGroups' => [
            [
                'DBParameterGroupName' => '<string>',
                'ParameterApplyStatus' => '<string>',
            ],
            // ...
        ],
        'DBSecurityGroups' => [
            [
                'DBSecurityGroupName' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'DBSubnetGroup' => [
            'DBSubnetGroupArn' => '<string>',
            'DBSubnetGroupDescription' => '<string>',
            'DBSubnetGroupName' => '<string>',
            'SubnetGroupStatus' => '<string>',
            'Subnets' => [
                [
                    'SubnetAvailabilityZone' => [
                        'Name' => '<string>',
                    ],
                    'SubnetIdentifier' => '<string>',
                    'SubnetOutpost' => [
                        'Arn' => '<string>',
                    ],
                    'SubnetStatus' => '<string>',
                ],
                // ...
            ],
            'SupportedNetworkTypes' => ['<string>', ...],
            'VpcId' => '<string>',
        ],
        'DBSystemId' => '<string>',
        'DatabaseInsightsMode' => 'standard|advanced',
        'DbInstancePort' => <integer>,
        'DbiResourceId' => '<string>',
        'DedicatedLogVolume' => true || false,
        'DeletionProtection' => true || false,
        'DomainMemberships' => [
            [
                'AuthSecretArn' => '<string>',
                'DnsIps' => ['<string>', ...],
                'Domain' => '<string>',
                'FQDN' => '<string>',
                'IAMRoleName' => '<string>',
                'OU' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'EnabledCloudwatchLogsExports' => ['<string>', ...],
        'Endpoint' => [
            'Address' => '<string>',
            'HostedZoneId' => '<string>',
            'Port' => <integer>,
        ],
        'Engine' => '<string>',
        'EngineLifecycleSupport' => '<string>',
        'EngineVersion' => '<string>',
        'EnhancedMonitoringResourceArn' => '<string>',
        'IAMDatabaseAuthenticationEnabled' => true || false,
        'InstanceCreateTime' => <DateTime>,
        'Iops' => <integer>,
        'IsStorageConfigUpgradeAvailable' => true || false,
        'KmsKeyId' => '<string>',
        'LatestRestorableTime' => <DateTime>,
        'LicenseModel' => '<string>',
        'ListenerEndpoint' => [
            'Address' => '<string>',
            'HostedZoneId' => '<string>',
            'Port' => <integer>,
        ],
        'MasterUserSecret' => [
            'KmsKeyId' => '<string>',
            'SecretArn' => '<string>',
            'SecretStatus' => '<string>',
        ],
        'MasterUsername' => '<string>',
        'MaxAllocatedStorage' => <integer>,
        'MonitoringInterval' => <integer>,
        'MonitoringRoleArn' => '<string>',
        'MultiAZ' => true || false,
        'MultiTenant' => true || false,
        'NcharCharacterSetName' => '<string>',
        'NetworkType' => '<string>',
        'OptionGroupMemberships' => [
            [
                'OptionGroupName' => '<string>',
                'Status' => '<string>',
            ],
            // ...
        ],
        'PendingModifiedValues' => [
            'AllocatedStorage' => <integer>,
            'AutomationMode' => 'full|all-paused',
            'BackupRetentionPeriod' => <integer>,
            'CACertificateIdentifier' => '<string>',
            'DBInstanceClass' => '<string>',
            'DBInstanceIdentifier' => '<string>',
            'DBSubnetGroupName' => '<string>',
            'DedicatedLogVolume' => true || false,
            'Engine' => '<string>',
            'EngineVersion' => '<string>',
            'IAMDatabaseAuthenticationEnabled' => true || false,
            'Iops' => <integer>,
            'LicenseModel' => '<string>',
            'MasterUserPassword' => '<string>',
            'MultiAZ' => true || false,
            'MultiTenant' => true || false,
            'PendingCloudwatchLogsExports' => [
                'LogTypesToDisable' => ['<string>', ...],
                'LogTypesToEnable' => ['<string>', ...],
            ],
            'Port' => <integer>,
            'ProcessorFeatures' => [
                [
                    'Name' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'ResumeFullAutomationModeTime' => <DateTime>,
            'StorageThroughput' => <integer>,
            'StorageType' => '<string>',
        ],
        'PercentProgress' => '<string>',
        'PerformanceInsightsEnabled' => true || false,
        'PerformanceInsightsKMSKeyId' => '<string>',
        'PerformanceInsightsRetentionPeriod' => <integer>,
        'PreferredBackupWindow' => '<string>',
        'PreferredMaintenanceWindow' => '<string>',
        'ProcessorFeatures' => [
            [
                'Name' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'PromotionTier' => <integer>,
        'PubliclyAccessible' => true || false,
        'ReadReplicaDBClusterIdentifiers' => ['<string>', ...],
        'ReadReplicaDBInstanceIdentifiers' => ['<string>', ...],
        'ReadReplicaSourceDBClusterIdentifier' => '<string>',
        'ReadReplicaSourceDBInstanceIdentifier' => '<string>',
        'ReplicaMode' => 'open-read-only|mounted',
        'ResumeFullAutomationModeTime' => <DateTime>,
        'SecondaryAvailabilityZone' => '<string>',
        'StatusInfos' => [
            [
                'Message' => '<string>',
                'Normal' => true || false,
                'Status' => '<string>',
                'StatusType' => '<string>',
            ],
            // ...
        ],
        'StorageEncrypted' => true || false,
        'StorageThroughput' => <integer>,
        'StorageType' => '<string>',
        'TagList' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'TdeCredentialArn' => '<string>',
        'Timezone' => '<string>',
        'VpcSecurityGroups' => [
            [
                'Status' => '<string>',
                'VpcSecurityGroupId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

DBInstanceAlreadyExistsFault:

The user already has a DB instance with the given identifier.

InsufficientDBInstanceCapacityFault:

The specified DB instance class isn't available in the specified Availability Zone.

DBParameterGroupNotFoundFault:

DBParameterGroupName doesn't refer to an existing DB parameter group.

DBSecurityGroupNotFoundFault:

DBSecurityGroupName doesn't refer to an existing DB security group.

InstanceQuotaExceededFault:

The request would result in the user exceeding the allowed number of DB instances.

StorageQuotaExceededFault:

The request would result in the user exceeding the allowed amount of storage available across all DB instances.

DBSubnetGroupNotFoundFault:

DBSubnetGroupName doesn't refer to an existing DB subnet group.

DBSubnetGroupDoesNotCoverEnoughAZs:

Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

InvalidDBClusterStateFault:

The requested operation can't be performed while the cluster is in this state.

InvalidSubnet:

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

InvalidVPCNetworkStateFault:

The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.

ProvisionedIopsNotAvailableInAZFault:

Provisioned IOPS not available in the specified Availability Zone.

OptionGroupNotFoundFault:

The specified option group could not be found.

DBClusterNotFoundFault:

DBClusterIdentifier doesn't refer to an existing DB cluster.

StorageTypeNotSupportedFault:

The specified StorageType can't be associated with the DB instance.

AuthorizationNotFoundFault:

The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB security group.

Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.

KMSKeyNotAccessibleFault:

An error occurred accessing an Amazon Web Services KMS key.

DomainNotFoundFault:

Domain doesn't refer to an existing Active Directory domain.

BackupPolicyNotFoundFault:

This error does not currently have a description.

NetworkTypeNotSupported:

The network type is invalid for the DB instance. Valid nework type values are IPV4 and DUAL.

CertificateNotFoundFault:

CertificateIdentifier doesn't refer to an existing certificate.

TenantDatabaseQuotaExceededFault:

You attempted to create more tenant databases than are permitted in your Amazon Web Services account.

Examples

Example 1: To create a DB instance

The following example uses the required options to launch a new DB instance.

$result = $client->createDBInstance([
    'AllocatedStorage' => 20,
    'DBInstanceClass' => 'db.t3.micro',
    'DBInstanceIdentifier' => 'test-mysql-instance',
    'Engine' => 'mysql',
    'MasterUserPassword' => 'secret99',
    'MasterUsername' => 'admin',
]);

Result syntax:

[
    'DBInstance' => [
        'AllocatedStorage' => 20,
        'AssociatedRoles' => [
        ],
        'AutoMinorVersionUpgrade' => 1,
        'BackupRetentionPeriod' => 1,
        'CACertificateIdentifier' => 'rds-ca-2019',
        'CopyTagsToSnapshot' => ,
        'DBInstanceArn' => 'arn:aws:rds:us-west-2:123456789012:db:test-mysql-instance',
        'DBInstanceClass' => 'db.t3.micro',
        'DBInstanceIdentifier' => 'test-mysql-instance',
        'DBInstanceStatus' => 'creating',
        'DBParameterGroups' => [
            [
                'DBParameterGroupName' => 'default.mysql5.7',
                'ParameterApplyStatus' => 'in-sync',
            ],
        ],
        'DBSecurityGroups' => [
        ],
        'DBSubnetGroup' => [
            'DBSubnetGroupDescription' => 'default',
            'DBSubnetGroupName' => 'default',
            'SubnetGroupStatus' => 'Complete',
            'Subnets' => [
                [
                    'SubnetAvailabilityZone' => [
                        'Name' => 'us-west-2c',
                    ],
                    'SubnetIdentifier' => 'subnet-########',
                    'SubnetStatus' => 'Active',
                ],
                [
                    'SubnetAvailabilityZone' => [
                        'Name' => 'us-west-2d',
                    ],
                    'SubnetIdentifier' => 'subnet-########',
                    'SubnetStatus' => 'Active',
                ],
                [
                    'SubnetAvailabilityZone' => [
                        'Name' => 'us-west-2a',
                    ],
                    'SubnetIdentifier' => 'subnet-########',
                    'SubnetStatus' => 'Active',
                ],
                [
                    'SubnetAvailabilityZone' => [
                        'Name' => 'us-west-2b',
                    ],
                    'SubnetIdentifier' => 'subnet-########',
                    'SubnetStatus' => 'Active',
                ],
            ],
            'VpcId' => 'vpc-2ff2ff2f',
        ],
        'DbInstancePort' => 0,
        'DbiResourceId' => 'db-5555EXAMPLE44444444EXAMPLE',
        'DeletionProtection' => ,
        'DomainMemberships' => [
        ],
        'Engine' => 'mysql',
        'EngineVersion' => '5.7.22',
        'IAMDatabaseAuthenticationEnabled' => ,
        'LicenseModel' => 'general-public-license',
        'MasterUsername' => 'admin',
        'MonitoringInterval' => 0,
        'MultiAZ' => ,
        'OptionGroupMemberships' => [
            [
                'OptionGroupName' => 'default:mysql-5-7',
                'Status' => 'in-sync',
            ],
        ],
        'PendingModifiedValues' => [
            'MasterUserPassword' => '****',
        ],
        'PerformanceInsightsEnabled' => ,
        'PreferredBackupWindow' => '12:55-13:25',
        'PreferredMaintenanceWindow' => 'sun:08:07-sun:08:37',
        'PubliclyAccessible' => 1,
        'ReadReplicaDBInstanceIdentifiers' => [
        ],
        'StorageEncrypted' => ,
        'StorageType' => 'gp2',
        'VpcSecurityGroups' => [
            [
                'Status' => 'active',
                'VpcSecurityGroupId' => 'sg-12345abc',
            ],
        ],
    ],
]

CreateDBInstanceReadReplica

$result = $client->createDBInstanceReadReplica([/* ... */]);
$promise = $client->createDBInstanceReadReplicaAsync([/* ... */]);

Creates a new DB instance that acts as a read replica for an existing source DB instance or Multi-AZ DB cluster. You can create a read replica for a DB instance running Db2, MariaDB, MySQL, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a Multi-AZ DB cluster running MySQL or PostgreSQL. For more information, see Working with read replicas and Migrating from a Multi-AZ DB cluster to a DB instance using a read replica in the Amazon RDS User Guide.

Amazon Aurora doesn't support this operation. To create a DB instance for an Aurora DB cluster, use the CreateDBInstance operation.

All read replica DB instances are created with backups disabled. All other attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance or cluster, except as specified.

Parameter Syntax

$result = $client->createDBInstanceReadReplica([
    'AllocatedStorage' => <integer>,
    'AutoMinorVersionUpgrade' => true || false,
    'AvailabilityZone' => '<string>',
    'CACertificateIdentifier' => '<string>',
    'CopyTagsToSnapshot' => true || false,
    'CustomIamInstanceProfile' => '<string>',
    'DBInstanceClass' => '<string>',
    'DBInstanceIdentifier' => '<string>', // REQUIRED
    'DBParameterGroupName' => '<string>',
    'DBSubnetGroupName' => '<string>',
    'DatabaseInsightsMode' => 'standard|advanced',
    'DedicatedLogVolume' => true || false,
    'DeletionProtection' => true || false,
    'DestinationRegion' => '<string>',
    'Domain' => '<string>',
    'DomainAuthSecretArn' => '<string>',
    'DomainDnsIps' => ['<string>', ...],
    'DomainFqdn' => '<string>',
    'DomainIAMRoleName' => '<string>',
    'DomainOu' => '<string>',
    'EnableCloudwatchLogsExports' => ['<string>', ...],
    'EnableCustomerOwnedIp' => true || false,
    'EnableIAMDatabaseAuthentication' => true || false,
    'EnablePerformanceInsights' => true || false,
    'Iops' => <integer>,
    'KmsKeyId' => '<string>',
    'MaxAllocatedStorage' => <integer>,
    'MonitoringInterval' => <integer>,
    'MonitoringRoleArn' => '<string>',
    'MultiAZ' => true || false,
    'NetworkType' => '<string>',
    'OptionGroupName' => '<string>',
    'PerformanceInsightsKMSKeyId' => '<string>',
    'PerformanceInsightsRetentionPeriod' => <integer>,
    'Port' => <integer>,
    'PreSignedUrl' => '<string>',
    'ProcessorFeatures' => [
        [
            'Name' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'PubliclyAccessible' => true || false,
    'ReplicaMode' => 'open-read-only|mounted',
    'SourceDBClusterIdentifier' => '<string>',
    'SourceDBInstanceIdentifier' => '<string>',
    'SourceRegion' => '<string>',
    'StorageThroughput' => <integer>,
    'StorageType' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'UpgradeStorageConfig' => true || false,
    'UseDefaultProcessorFeatures' => true || false,
    'VpcSecurityGroupIds' => ['<string>', ...],
]);

Parameter Details