NOTE: For Version 3 of the AWS SDK for PHP, please see the V3 User Guide and V3 API Reference.

# Class RdsClient

Client to interact with Amazon Relational Database Service

  Guzzle\Common\AbstractHasDispatcher implements Guzzle\Common\HasDispatcherInterface
  Guzzle\Http\Client implements Guzzle\Http\ClientInterface
  Guzzle\Service\Client implements Guzzle\Service\ClientInterface
  Aws\Common\Client\AbstractClient implements Aws\Common\Client\AwsClientInterface
  Aws\Rds\RdsClient

Namespace: Aws\Rds
Link: User guide
Link: API docs
Located at Aws/Rds/RdsClient.php

## Methods summary

- `public static` `factory ( array|Collection $config = array() )`

  Factory method to create a new Amazon Relational Database Service client using an array of configuration options.

- `public` `addSourceIdentifierToSubscription ( array $args = array() )`

  Executes the AddSourceIdentifierToSubscription operation.

- `public` `addTagsToResource ( array $args = array() )`

  Executes the AddTagsToResource operation.

- `public` `applyPendingMaintenanceAction ( array $args = array() )`

  Executes the ApplyPendingMaintenanceAction operation.

- `public` `authorizeDBSecurityGroupIngress ( array $args = array() )`

  Executes the AuthorizeDBSecurityGroupIngress operation.

- `public` `copyDBClusterSnapshot ( array $args = array() )`

  Executes the CopyDBClusterSnapshot operation.

- `public` `copyDBParameterGroup ( array $args = array() )`

  Executes the CopyDBParameterGroup operation.

- `public` `copyDBSnapshot ( array $args = array() )`

  Executes the CopyDBSnapshot operation.

- `public` `copyOptionGroup ( array $args = array() )`

  Executes the CopyOptionGroup operation.

- `public` `createDBCluster ( array $args = array() )`

  Executes the CreateDBCluster operation.

- `public` `createDBClusterParameterGroup ( array $args = array() )`

  Executes the CreateDBClusterParameterGroup operation.

- `public` `createDBClusterSnapshot ( array $args = array() )`

  Executes the CreateDBClusterSnapshot operation.

- `public` `createDBInstance ( array $args = array() )`

  Executes the CreateDBInstance operation.

- `public` `createDBInstanceReadReplica ( array $args = array() )`

  Executes the CreateDBInstanceReadReplica operation.

- `public` `createDBParameterGroup ( array $args = array() )`

  Executes the CreateDBParameterGroup operation.

- `public` `createDBSecurityGroup ( array $args = array() )`

  Executes the CreateDBSecurityGroup operation.

- `public` `createDBSnapshot ( array $args = array() )`

  Executes the CreateDBSnapshot operation.

- `public` `createDBSubnetGroup ( array $args = array() )`

  Executes the CreateDBSubnetGroup operation.

- `public` `createEventSubscription ( array $args = array() )`

  Executes the CreateEventSubscription operation.

- `public` `createOptionGroup ( array $args = array() )`

  Executes the CreateOptionGroup operation.

- `public` `deleteDBCluster ( array $args = array() )`

  Executes the DeleteDBCluster operation.

- `public` `deleteDBClusterParameterGroup ( array $args = array() )`

  Executes the DeleteDBClusterParameterGroup operation.

- `public` `deleteDBClusterSnapshot ( array $args = array() )`

  Executes the DeleteDBClusterSnapshot operation.

- `public` `deleteDBInstance ( array $args = array() )`

  Executes the DeleteDBInstance operation.

- `public` `deleteDBParameterGroup ( array $args = array() )`

  Executes the DeleteDBParameterGroup operation.

- `public` `deleteDBSecurityGroup ( array $args = array() )`

  Executes the DeleteDBSecurityGroup operation.

- `public` `deleteDBSnapshot ( array $args = array() )`

  Executes the DeleteDBSnapshot operation.

- `public` `deleteDBSubnetGroup ( array $args = array() )`

  Executes the DeleteDBSubnetGroup operation.

- `public` `deleteEventSubscription ( array $args = array() )`

  Executes the DeleteEventSubscription operation.

- `public` `deleteOptionGroup ( array $args = array() )`

  Executes the DeleteOptionGroup operation.

- `public` `describeAccountAttributes ( array $args = array() )`

  Executes the DescribeAccountAttributes operation.

- `public` `describeCertificates ( array $args = array() )`

  Executes the DescribeCertificates operation.

- `public` `describeDBClusterParameterGroups ( array $args = array() )`

  Executes the DescribeDBClusterParameterGroups operation.

- `public` `describeDBClusterParameters ( array $args = array() )`

  Executes the DescribeDBClusterParameters operation.

- `public` `describeDBClusterSnapshots ( array $args = array() )`

  Executes the DescribeDBClusterSnapshots operation.

- `public` `describeDBClusters ( array $args = array() )`

  Executes the DescribeDBClusters operation.

- `public` `describeDBEngineVersions ( array $args = array() )`

  Executes the DescribeDBEngineVersions operation.

- `public` `describeDBInstances ( array $args = array() )`

  Executes the DescribeDBInstances operation.

- `public` `describeDBLogFiles ( array $args = array() )`

  Executes the DescribeDBLogFiles operation.

- `public` `describeDBParameterGroups ( array $args = array() )`

  Executes the DescribeDBParameterGroups operation.

- `public` `describeDBParameters ( array $args = array() )`

  Executes the DescribeDBParameters operation.

- `public` `describeDBSecurityGroups ( array $args = array() )`

  Executes the DescribeDBSecurityGroups operation.

- `public` `describeDBSnapshots ( array $args = array() )`

  Executes the DescribeDBSnapshots operation.

- `public` `describeDBSubnetGroups ( array $args = array() )`

  Executes the DescribeDBSubnetGroups operation.

- `public` `describeEngineDefaultClusterParameters ( array $args = array() )`

  Executes the DescribeEngineDefaultClusterParameters operation.

- `public` `describeEngineDefaultParameters ( array $args = array() )`

  Executes the DescribeEngineDefaultParameters operation.

- `public` `describeEventCategories ( array $args = array() )`

  Executes the DescribeEventCategories operation.

- `public` `describeEventSubscriptions ( array $args = array() )`

  Executes the DescribeEventSubscriptions operation.

- `public` `describeEvents ( array $args = array() )`

  Executes the DescribeEvents operation.

- `public` `describeOptionGroupOptions ( array $args = array() )`

  Executes the DescribeOptionGroupOptions operation.

- `public` `describeOptionGroups ( array $args = array() )`

  Executes the DescribeOptionGroups operation.

- `public` `describeOrderableDBInstanceOptions ( array $args = array() )`

  Executes the DescribeOrderableDBInstanceOptions operation.

- `public` `describePendingMaintenanceActions ( array $args = array() )`

  Executes the DescribePendingMaintenanceActions operation.

- `public` `describeReservedDBInstances ( array $args = array() )`

  Executes the DescribeReservedDBInstances operation.

- `public` `describeReservedDBInstancesOfferings ( array $args = array() )`

  Executes the DescribeReservedDBInstancesOfferings operation.

- `public` `downloadDBLogFilePortion ( array $args = array() )`

  Executes the DownloadDBLogFilePortion operation.

- `public` `failoverDBCluster ( array $args = array() )`

  Executes the FailoverDBCluster operation.

- `public` `listTagsForResource ( array $args = array() )`

  Executes the ListTagsForResource operation.

- `public` `modifyDBCluster ( array $args = array() )`

  Executes the ModifyDBCluster operation.

- `public` `modifyDBClusterParameterGroup ( array $args = array() )`

  Executes the ModifyDBClusterParameterGroup operation.

- `public` `modifyDBInstance ( array $args = array() )`

  Executes the ModifyDBInstance operation.

- `public` `modifyDBParameterGroup ( array $args = array() )`

  Executes the ModifyDBParameterGroup operation.

- `public` `modifyDBSubnetGroup ( array $args = array() )`

  Executes the ModifyDBSubnetGroup operation.

- `public` `modifyEventSubscription ( array $args = array() )`

  Executes the ModifyEventSubscription operation.

- `public` `modifyOptionGroup ( array $args = array() )`

  Executes the ModifyOptionGroup operation.

- `public` `promoteReadReplica ( array $args = array() )`

  Executes the PromoteReadReplica operation.

- `public` `purchaseReservedDBInstancesOffering ( array $args = array() )`

  Executes the PurchaseReservedDBInstancesOffering operation.

- `public` `rebootDBInstance ( array $args = array() )`

  Executes the RebootDBInstance operation.

- `public` `removeSourceIdentifierFromSubscription ( array $args = array() )`

  Executes the RemoveSourceIdentifierFromSubscription operation.

- `public` `removeTagsFromResource ( array $args = array() )`

  Executes the RemoveTagsFromResource operation.

- `public` `resetDBClusterParameterGroup ( array $args = array() )`

  Executes the ResetDBClusterParameterGroup operation.

- `public` `resetDBParameterGroup ( array $args = array() )`

  Executes the ResetDBParameterGroup operation.

- `public` `restoreDBClusterFromSnapshot ( array $args = array() )`

  Executes the RestoreDBClusterFromSnapshot operation.

- `public` `restoreDBClusterToPointInTime ( array $args = array() )`

  Executes the RestoreDBClusterToPointInTime operation.

- `public` `restoreDBInstanceFromDBSnapshot ( array $args = array() )`

  Executes the RestoreDBInstanceFromDBSnapshot operation.

- `public` `restoreDBInstanceToPointInTime ( array $args = array() )`

  Executes the RestoreDBInstanceToPointInTime operation.

- `public` `revokeDBSecurityGroupIngress ( array $args = array() )`

  Executes the RevokeDBSecurityGroupIngress operation.

- `public` `waitUntilDBInstanceAvailable ( array $input )`

  The input array uses the parameters of the DescribeDBInstances operation and waiter specific settings

- `public` `waitUntilDBInstanceDeleted ( array $input )`

  The input array uses the parameters of the DescribeDBInstances operation and waiter specific settings

- `public` `getDescribeEngineDefaultParametersIterator ( array $args = array() )`

  The input array uses the parameters of the DescribeEngineDefaultParameters operation

## Methods detail

# `public static `Aws\Rds\RdsClient``
`factory( array|`Guzzle\Common\Collection` $config = array() )`

Factory method to create a new Amazon Relational Database Service client using an array of configuration options.

#### Parameters

$config
  `array|`Guzzle\Common\Collection``
  $config Client configuration data

#### Returns

``Aws\Rds\RdsClient``

#### Link

http://docs.aws.amazon.com/aws-sdk-php/v2/guide/configuration.html#client-configuration-options

#### Overrides

`Guzzle\Service\Client::factory`
# `public `Guzzle\Service\Resource\Model``
`addSourceIdentifierToSubscription( array $args = array() )`

Executes the AddSourceIdentifierToSubscription operation.

Adds a source identifier to an existing RDS event notification subscription.

#### Examples

- Basic formatting example

      $result = $client->addSourceIdentifierToSubscription(array(
          // SubscriptionName is required
          'SubscriptionName' => 'string',
          // SourceIdentifier is required
          'SourceIdentifier' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - SubscriptionName => (string)

    The name of the RDS event notification subscription you want to add a source identifier to.

  - SourceIdentifier => (string)

    The identifier of the event source to be added. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.

    Constraints:

    - If the source type is a DB instance, then a DBInstanceIdentifier must be supplied.
    - If the source type is a DB security group, a DBSecurityGroupName must be supplied.
    - If the source type is a DB parameter group, a DBParameterGroupName must be supplied.
    - If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- EventSubscription => (associative-array)

  Contains the results of a successful invocation of the DescribeEventSubscriptions action.

  - CustomerAwsId => (string)

    The AWS customer account associated with the RDS event notification subscription.

  - CustSubscriptionId => (string)

    The RDS event notification subscription Id.

  - SnsTopicArn => (string)

    The topic ARN of the RDS event notification subscription.

  - Status => (string)

    The status of the RDS event notification subscription.

    Constraints:

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

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

  - SubscriptionCreationTime => (string)

    The time the RDS event notification subscription was created.

  - SourceType => (string)

    The source type for the RDS event notification subscription.

  - SourceIdsList => (array<string>)

    A list of source IDs for the RDS event notification subscription.

  - EventCategoriesList => (array<string>)

    A list of event categories for the RDS event notification subscription.

  - Enabled => (bool)

    A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

# `public `Guzzle\Service\Resource\Model``
`addTagsToResource( array $args = array() )`

Executes the AddTagsToResource operation.

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 Amazon RDS resources, see Tagging Amazon RDS Resources.

#### Examples

- Basic formatting example

      $result = $client->addTagsToResource(array(
          // ResourceName is required
          'ResourceName' => 'string',
          // Tags is required
          'Tags' => array(
              array(
                  'Key' => 'string',
                  'Value' => 'string',
              ),
              // ... repeated
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - ResourceName => (string)

    The Amazon RDS resource the tags will be added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

  - Tags => (array<associative-array>)

    The tags to be assigned to the Amazon RDS resource.

    - (associative-array)

      Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

      - Key => (string)

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

      - Value => (string)

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

# `public `Guzzle\Service\Resource\Model``
`applyPendingMaintenanceAction( array $args = array() )`

Executes the ApplyPendingMaintenanceAction operation.

Applies a pending maintenance action to a resource (for example, to a DB instance).

#### Examples

- Basic formatting example

      $result = $client->applyPendingMaintenanceAction(array(
          // ResourceIdentifier is required
          'ResourceIdentifier' => 'string',
          // ApplyAction is required
          'ApplyAction' => 'string',
          // OptInType is required
          'OptInType' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - ResourceIdentifier => (string)

    The RDS Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to. For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

  - ApplyAction => (string)

    The pending maintenance action to apply to this resource.

  - OptInType => (string)

    A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in request of type immediate cannot be undone.

    Valid values:

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- ResourcePendingMaintenanceActions => (associative-array)

  Describes the pending maintenance actions for a resource.

  - ResourceIdentifier => (string)

    The ARN of the resource that has pending maintenance actions.

  - PendingMaintenanceActionDetails => (array<associative-array>)

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

    - (associative-array)

      Provides information about a pending maintenance action for a resource.

      - Action => (string)

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

      - AutoAppliedAfterDate => (string)

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

      - ForcedApplyDate => (string)

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

      - OptInStatus => (string)

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

      - CurrentApplyDate => (string)

        The effective date when the pending maintenance action will be applied to the resource. This date takes into account opt-in requests received from the ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate, and the ForcedApplyDate. This value is blank if an opt-in request has not been received and nothing has been specified as AutoAppliedAfterDate or ForcedApplyDate.

      - Description => (string)

        A description providing more detail about the maintenance action.

# `public `Guzzle\Service\Resource\Model``
`authorizeDBSecurityGroupIngress( array $args = array() )`

Executes the AuthorizeDBSecurityGroupIngress operation.

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 cannot authorize ingress from an EC2 security group in one region to an Amazon RDS DB instance in another. You cannot 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.

#### Examples

- Basic formatting example

      $result = $client->authorizeDBSecurityGroupIngress(array(
          // DBSecurityGroupName is required
          'DBSecurityGroupName' => 'string',
          'CIDRIP' => 'string',
          'EC2SecurityGroupName' => 'string',
          'EC2SecurityGroupId' => 'string',
          'EC2SecurityGroupOwnerId' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DBSecurityGroupName => (string)

    The name of the DB security group to add authorization to.

  - CIDRIP => (string)

    The IP range to authorize.

  - EC2SecurityGroupName => (string)

    Name of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

  - EC2SecurityGroupId => (string)

    Id of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

  - EC2SecurityGroupOwnerId => (string)

    AWS account number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- DBSecurityGroup => (associative-array)

  Contains the result of a successful invocation of the following actions:

  - DescribeDBSecurityGroups
  - AuthorizeDBSecurityGroupIngress
  - CreateDBSecurityGroup
  - RevokeDBSecurityGroupIngress

  This data type is used as a response element in the DescribeDBSecurityGroups action.

  - OwnerId => (string)

    Provides the AWS ID of the owner of a specific DB security group.

  - DBSecurityGroupName => (string)

    Specifies the name of the DB security group.

  - DBSecurityGroupDescription => (string)

    Provides the description of the DB security group.

  - VpcId => (string)

    Provides the VpcId of the DB security group.

  - EC2SecurityGroups => (array<associative-array>)

    Contains a list of EC2SecurityGroup elements.

    - (associative-array)

      This data type is used as a response element in the following actions:

      - AuthorizeDBSecurityGroupIngress
      - DescribeDBSecurityGroups
      - RevokeDBSecurityGroupIngress
      - Status => (string)

        Provides the status of the EC2 security group. Status can be "authorizing", "authorized", "revoking", and "revoked".

      - EC2SecurityGroupName => (string)

        Specifies the name of the EC2 security group.

      - EC2SecurityGroupId => (string)

        Specifies the id of the EC2 security group.

      - EC2SecurityGroupOwnerId => (string)

        Specifies the AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.

  - IPRanges => (array<associative-array>)

    Contains a list of IPRange elements.

    - (associative-array)

      This data type is used as a response element in the DescribeDBSecurityGroups action.

      - Status => (string)

        Specifies the status of the IP range. Status can be "authorizing", "authorized", "revoking", and "revoked".

      - CIDRIP => (string)

        Specifies the IP range.

# `public `Guzzle\Service\Resource\Model``
`copyDBClusterSnapshot( array $args = array() )`

Executes the CopyDBClusterSnapshot operation.

Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

#### Examples

- Basic formatting example

      $result = $client->copyDBClusterSnapshot(array(
          // SourceDBClusterSnapshotIdentifier is required
          'SourceDBClusterSnapshotIdentifier' => 'string',
          // TargetDBClusterSnapshotIdentifier is required
          'TargetDBClusterSnapshotIdentifier' => 'string',
          'Tags' => array(
              array(
                  'Key' => 'string',
                  'Value' => 'string',
              ),
              // ... repeated
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - SourceDBClusterSnapshotIdentifier => (string)

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

    Constraints:

    - Must contain from 1 to 63 alphanumeric characters or hyphens.
    - First character must be a letter.
    - Cannot end with a hyphen or contain two consecutive hyphens.

    Example: my-cluster-snapshot1

  - TargetDBClusterSnapshotIdentifier => (string)

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

    Constraints:

    - Must contain from 1 to 63 alphanumeric characters or hyphens.
    - First character must be a letter.
    - Cannot end with a hyphen or contain two consecutive hyphens.

    Example: my-cluster-snapshot2

  - Tags => (array<associative-array>)

    A list of tags.

    - (associative-array)

      Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

      - Key => (string)

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

      - Value => (string)

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- DBClusterSnapshot => (associative-array)

  Contains the result of a successful invocation of the following actions:

  - CreateDBClusterSnapshot
  - DeleteDBClusterSnapshot

  This data type is used as a response element in the DescribeDBClusterSnapshots action.

  - AvailabilityZones => (array<string>)

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

  - DBClusterSnapshotIdentifier => (string)

    Specifies the identifier for the DB cluster snapshot.

  - DBClusterIdentifier => (string)

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

  - SnapshotCreateTime => (string)

    Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

  - Engine => (string)

    Specifies the name of the database engine.

  - AllocatedStorage => (int)

    Specifies the allocated storage size in gigabytes (GB).

  - Status => (string)

    Specifies the status of this DB cluster snapshot.

  - Port => (int)

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

  - VpcId => (string)

    Provides the VPC ID associated with the DB cluster snapshot.

  - ClusterCreateTime => (string)

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

  - MasterUsername => (string)

    Provides the master username for the DB cluster snapshot.

  - EngineVersion => (string)

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

  - LicenseModel => (string)

    Provides the license model information for this DB cluster snapshot.

  - SnapshotType => (string)

    Provides the type of the DB cluster snapshot.

  - PercentProgress => (int)

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

# `public `Guzzle\Service\Resource\Model``
`copyDBParameterGroup( array $args = array() )`

Executes the CopyDBParameterGroup operation.

Copies the specified DB parameter group.

#### Examples

- Basic formatting example

      $result = $client->copyDBParameterGroup(array(
          // SourceDBParameterGroupIdentifier is required
          'SourceDBParameterGroupIdentifier' => 'string',
          // TargetDBParameterGroupIdentifier is required
          'TargetDBParameterGroupIdentifier' => 'string',
          // TargetDBParameterGroupDescription is required
          'TargetDBParameterGroupDescription' => 'string',
          'Tags' => array(
              array(
                  'Key' => 'string',
                  'Value' => 'string',
              ),
              // ... repeated
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - SourceDBParameterGroupIdentifier => (string)

    The identifier or ARN for the source DB parameter group. For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

    Constraints:

    - Must specify a valid DB parameter group.
    - If the source DB parameter group is in the same region as the copy, specify a valid DB parameter group identifier, for example my-db-param-group, or a valid ARN.
    - If the source DB parameter group is in a different region than the copy, specify a valid DB parameter group ARN, for example arn:aws:rds:us-west-2:123456789012:pg:special-parameters.
  - TargetDBParameterGroupIdentifier => (string)

    The identifier for the copied DB parameter group.

    Constraints:

    - Cannot be null, empty, or blank
    - Must contain from 1 to 255 alphanumeric characters or hyphens
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens

    Example: my-db-parameter-group

  - TargetDBParameterGroupDescription => (string)

    A description for the copied DB parameter group.

  - Tags => (array<associative-array>)

    A list of tags.

    - (associative-array)

      Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

      - Key => (string)

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

      - Value => (string)

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- DBParameterGroup => (associative-array)

  Contains the result of a successful invocation of the CreateDBParameterGroup action.

  This data type is used as a request parameter in the DeleteDBParameterGroup action, and as a response element in the DescribeDBParameterGroups action.

  - DBParameterGroupName => (string)

    Provides the name of the DB parameter group.

  - DBParameterGroupFamily => (string)

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

  - Description => (string)

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

# `public `Guzzle\Service\Resource\Model``
`copyDBSnapshot( array $args = array() )`

Executes the CopyDBSnapshot operation.

Copies the specified DBSnapshot. The source DBSnapshot must be in the "available" state.

#### Examples

- Basic formatting example

      $result = $client->copyDBSnapshot(array(
          // SourceDBSnapshotIdentifier is required
          'SourceDBSnapshotIdentifier' => 'string',
          // TargetDBSnapshotIdentifier is required
          'TargetDBSnapshotIdentifier' => 'string',
          'Tags' => array(
              array(
                  'Key' => 'string',
                  'Value' => 'string',
              ),
              // ... repeated
          ),
          'CopyTags' => true || false,
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - SourceDBSnapshotIdentifier => (string)

    The identifier for the source DB snapshot.

    Constraints:

    - Must specify a valid system snapshot in the "available" state.
    - If the source snapshot is in the same region as the copy, specify a valid DB snapshot identifier.
    - If the source snapshot is in a different region than the copy, specify a valid DB snapshot ARN. For more information, go to Copying a DB Snapshot.

    Example: rds:mydb-2012-04-02-00-01

    Example: arn:aws:rds:rr-regn-1:123456789012:snapshot:mysql-instance1-snapshot-20130805

  - TargetDBSnapshotIdentifier => (string)

    The identifier for the copied snapshot.

    Constraints:

    - Cannot be null, empty, or blank
    - Must contain from 1 to 255 alphanumeric characters or hyphens
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens

    Example: my-db-snapshot

  - Tags => (array<associative-array>)

    A list of tags.

    - (associative-array)

      Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

      - Key => (string)

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

      - Value => (string)

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

  - CopyTags => (bool)

    True to copy all tags from the source DB snapshot to the target DB snapshot; otherwise false. The default is false.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- DBSnapshot => (associative-array)

  Contains the result of a successful invocation of the following actions:

  - CreateDBSnapshot
  - DeleteDBSnapshot

  This data type is used as a response element in the DescribeDBSnapshots action.

  - DBSnapshotIdentifier => (string)

    Specifies the identifier for the DB snapshot.

  - DBInstanceIdentifier => (string)

    Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

  - SnapshotCreateTime => (string)

    Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

  - Engine => (string)

    Specifies the name of the database engine.

  - AllocatedStorage => (int)

    Specifies the allocated storage size in gigabytes (GB).

  - Status => (string)

    Specifies the status of this DB snapshot.

  - Port => (int)

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

  - AvailabilityZone => (string)

    Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

  - VpcId => (string)

    Provides the VPC ID associated with the DB snapshot.

  - InstanceCreateTime => (string)

    Specifies the time when the snapshot was taken, in Universal Coordinated Time (UTC).

  - MasterUsername => (string)

    Provides the master username for the DB snapshot.

  - EngineVersion => (string)

    Specifies the version of the database engine.

  - LicenseModel => (string)

    License model information for the restored DB instance.

  - SnapshotType => (string)

    Provides the type of the DB snapshot.

  - Iops => (int)

    Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

  - OptionGroupName => (string)

    Provides the option group name for the DB snapshot.

  - PercentProgress => (int)

    The percentage of the estimated data that has been transferred.

  - SourceRegion => (string)

    The region that the DB snapshot was created in or copied from.

  - SourceDBSnapshotIdentifier => (string)

    The DB snapshot Arn that the DB snapshot was copied from. It only has value in case of cross customer or cross region copy.

  - StorageType => (string)

    Specifies the storage type associated with DB Snapshot.

  - TdeCredentialArn => (string)

    The ARN from the Key Store with which to associate the instance for TDE encryption.

  - Encrypted => (bool)

    Specifies whether the DB snapshot is encrypted.

  - KmsKeyId => (string)

    If Encrypted is true, the KMS key identifier for the encrypted DB snapshot.

# `public `Guzzle\Service\Resource\Model``
`copyOptionGroup( array $args = array() )`

Executes the CopyOptionGroup operation.

Copies the specified option group.

#### Examples

- Basic formatting example

      $result = $client->copyOptionGroup(array(
          // SourceOptionGroupIdentifier is required
          'SourceOptionGroupIdentifier' => 'string',
          // TargetOptionGroupIdentifier is required
          'TargetOptionGroupIdentifier' => 'string',
          // TargetOptionGroupDescription is required
          'TargetOptionGroupDescription' => 'string',
          'Tags' => array(
              array(
                  'Key' => 'string',
                  'Value' => 'string',
              ),
              // ... repeated
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - SourceOptionGroupIdentifier => (string)

    The identifier or ARN for the source option group. For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

    Constraints:

    - Must specify a valid option group.
    - If the source option group is in the same region as the copy, specify a valid option group identifier, for example my-option-group, or a valid ARN.
    - If the source option group is in a different region than the copy, specify a valid option group ARN, for example arn:aws:rds:us-west-2:123456789012:og:special-options.
  - TargetOptionGroupIdentifier => (string)

    The identifier for the copied option group.

    Constraints:

    - Cannot be null, empty, or blank
    - Must contain from 1 to 255 alphanumeric characters or hyphens
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens

    Example: my-option-group

  - TargetOptionGroupDescription => (string)

    The description for the copied option group.

  - Tags => (array<associative-array>)

    A list of tags.

    - (associative-array)

      Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

      - Key => (string)

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

      - Value => (string)

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- OptionGroup => (associative-array)
  - OptionGroupName => (string)

    Specifies the name of the option group.

  - OptionGroupDescription => (string)

    Provides a description of the option group.

  - EngineName => (string)

    Indicates the name of the engine that this option group can be applied to.

  - MajorEngineVersion => (string)

    Indicates the major engine version associated with this option group.

  - Options => (array<associative-array>)

    Indicates what options are available in the option group.

    - (associative-array)

      Option details.

      - OptionName => (string)

        The name of the option.

      - OptionDescription => (string)

        The description of the option.

      - Persistent => (bool)

        Indicate if this option is persistent.

      - Permanent => (bool)

        Indicate if this option is permanent.

      - Port => (int)

        If required, the port configured for this option to use.

      - OptionSettings => (array<associative-array>)

        The option settings for this option.

        - (associative-array)

          Option settings are the actual settings being applied or configured for that option. It is used when you modify an option group or describe option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting called SQLNET.ENCRYPTION_SERVER that can have several different values.

          - Name => (string)

            The name of the option that has settings that you can set.

          - Value => (string)

            The current value of the option setting.

          - DefaultValue => (string)

            The default value of the option setting.

          - Description => (string)

            The description of the option setting.

          - ApplyType => (string)

            The DB engine specific parameter type.

          - DataType => (string)

            The data type of the option setting.

          - AllowedValues => (string)

            The allowed values of the option setting.

          - IsModifiable => (bool)

            A Boolean value that, when true, indicates the option setting can be modified from the default.

          - IsCollection => (bool)

            Indicates if the option setting is part of a collection.

      - DBSecurityGroupMemberships => (array<associative-array>)

        If the option requires access to a port, then this DB security group allows access to the port.

        - (associative-array)

          This data type is used as a response element in the following actions:

          - ModifyDBInstance
          - RebootDBInstance
          - RestoreDBInstanceFromDBSnapshot
          - RestoreDBInstanceToPointInTime
          - DBSecurityGroupName => (string)

            The name of the DB security group.

          - Status => (string)

            The status of the DB security group.

      - VpcSecurityGroupMemberships => (array<associative-array>)

        If the option requires access to a port, then this VPC security group allows access to the port.

        - (associative-array)

          This data type is used as a response element for queries on VPC security group membership.

          - VpcSecurityGroupId => (string)

            The name of the VPC security group.

          - Status => (string)

            The status of the VPC security group.

  - AllowsVpcAndNonVpcInstanceMemberships => (bool)

    Indicates whether this option group can be applied to both VPC and non-VPC instances. The value true indicates the option group can be applied to both VPC and non-VPC instances.

  - VpcId => (string)

    If AllowsVpcAndNonVpcInstanceMemberships is false, this field is blank. If AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field.

# `public `Guzzle\Service\Resource\Model``
`createDBCluster( array $args = array() )`

Executes the CreateDBCluster operation.

Creates a new Amazon Aurora DB cluster. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

#### Examples

- Basic formatting example

      $result = $client->createDBCluster(array(
          'AvailabilityZones' => array('string', ... ),
          'BackupRetentionPeriod' => integer,
          'CharacterSetName' => 'string',
          'DatabaseName' => 'string',
          // DBClusterIdentifier is required
          'DBClusterIdentifier' => 'string',
          'DBClusterParameterGroupName' => 'string',
          'VpcSecurityGroupIds' => array('string', ... ),
          'DBSubnetGroupName' => 'string',
          // Engine is required
          'Engine' => 'string',
          'EngineVersion' => 'string',
          'Port' => integer,
          // MasterUsername is required
          'MasterUsername' => 'string',
          // MasterUserPassword is required
          'MasterUserPassword' => 'string',
          'OptionGroupName' => 'string',
          'PreferredBackupWindow' => 'string',
          'PreferredMaintenanceWindow' => 'string',
          'Tags' => array(
              array(
                  'Key' => 'string',
                  'Value' => 'string',
              ),
              // ... repeated
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - AvailabilityZones => (array<string>)

    A list of EC2 Availability Zones that instances in the DB cluster can be created in. For information on regions and Availability Zones, see Regions and Availability Zones.

  - BackupRetentionPeriod => (int)

    The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

    Default: 1

    Constraints:

    - Must be a value from 0 to 35
  - CharacterSetName => (string)

    A value that indicates that the DB cluster should be associated with the specified CharacterSet.

  - DatabaseName => (string)

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

  - DBClusterIdentifier => (string)

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

    Constraints:

    - Must contain from 1 to 63 alphanumeric characters or hyphens.
    - First character must be a letter.
    - Cannot end with a hyphen or contain two consecutive hyphens.

    Example: my-cluster1

  - DBClusterParameterGroupName => (string)

    The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, default.aurora5.6 for the specified engine will be used.

    Constraints:

    - Must be 1 to 255 alphanumeric characters
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
  - VpcSecurityGroupIds => (array<string>)

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

  - DBSubnetGroupName => (string)

    A DB subnet group to associate with this DB cluster.

  - Engine => (string)

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

    Valid Values: aurora

  - EngineVersion => (string)

    The version number of the database engine to use.

    Aurora

    Example: 5.6.0

  - Port => (int)

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

    Default: 3306

  - MasterUsername => (string)

    The name of the master user for the client DB cluster.

    Constraints:

    - Must be 1 to 16 alphanumeric characters.
    - First character must be a letter.
    - Cannot be a reserved word for the chosen database engine.
  - MasterUserPassword => (string)

    The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".

    Constraints: Must contain from 8 to 41 characters.

  - OptionGroupName => (string)

    A value that indicates that the DB cluster should be associated with the specified option group.

    Permanent options cannot be removed from an option group. The option group cannot be removed from a DB cluster once it is associated with a DB cluster.

  - PreferredBackupWindow => (string)

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

    Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

    Constraints:

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

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

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

    Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

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

    Constraints: Minimum 30-minute window.

  - Tags => (array<associative-array>)

    A list of tags.

    - (associative-array)

      Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

      - Key => (string)

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

      - Value => (string)

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- DBCluster => (associative-array)

  Contains the result of a successful invocation of the following actions:

  - CreateDBCluster
  - DeleteDBCluster
  - FailoverDBCluster
  - ModifyDBCluster
  - RestoreDBClusterFromSnapshot

  This data type is used as a response element in the DescribeDBClusters action.

  - AllocatedStorage => (int)

    Specifies the allocated storage size in gigabytes (GB).

  - AvailabilityZones => (array<string>)

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

  - BackupRetentionPeriod => (int)

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

  - CharacterSetName => (string)

    If present, specifies the name of the character set that this cluster is associated with.

  - DatabaseName => (string)

    Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

  - DBClusterIdentifier => (string)

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

  - DBClusterParameterGroup => (string)

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

  - DBSubnetGroup => (string)

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

  - Status => (string)

    Specifies the current state of this DB cluster.

  - PercentProgress => (string)

    Specifies the progress of the operation as a percentage.

  - EarliestRestorableTime => (string)

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

  - Endpoint => (string)

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

  - Engine => (string)

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

  - EngineVersion => (string)

    Indicates the database engine version.

  - LatestRestorableTime => (string)

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

  - Port => (int)

    Specifies the port that the database engine is listening on.

  - MasterUsername => (string)

    Contains the master username for the DB cluster.

  - DBClusterOptionGroupMemberships => (array<associative-array>)

    Provides the list of option group memberships for this DB cluster.

    - (associative-array)

      Contains status information for a DB cluster option group.

      - DBClusterOptionGroupName => (string)

        Specifies the name of the DB cluster option group.

      - Status => (string)

        Specifies the status of the DB cluster option group.

  - PreferredBackupWindow => (string)

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

  - PreferredMaintenanceWindow => (string)

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

  - DBClusterMembers => (array<associative-array>)

    Provides the list of instances that make up the DB cluster.

    - (associative-array)

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

      - DBInstanceIdentifier => (string)

        Specifies the instance identifier for this member of the DB cluster.

      - IsClusterWriter => (bool)

        Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

      - DBClusterParameterGroupStatus => (string)

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

  - VpcSecurityGroups => (array<associative-array>)

    Provides a list of VPC security groups that the DB cluster belongs to.

    - (associative-array)

      This data type is used as a response element for queries on VPC security group membership.

      - VpcSecurityGroupId => (string)

        The name of the VPC security group.

      - Status => (string)

        The status of the VPC security group.

  - HostedZoneId => (string)

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

# `public `Guzzle\Service\Resource\Model``
`createDBClusterParameterGroup( array $args = array() )`

Executes the CreateDBClusterParameterGroup operation.

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 DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.

After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

#### Examples

- Basic formatting example

      $result = $client->createDBClusterParameterGroup(array(
          // DBClusterParameterGroupName is required
          'DBClusterParameterGroupName' => 'string',
          // DBParameterGroupFamily is required
          'DBParameterGroupFamily' => 'string',
          // Description is required
          'Description' => 'string',
          'Tags' => array(
              array(
                  'Key' => 'string',
                  'Value' => 'string',
              ),
              // ... repeated
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DBClusterParameterGroupName => (string)

    The name of the DB cluster parameter group.

    Constraints:

    - Must be 1 to 255 alphanumeric characters
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
    This value is stored as a lowercase string.
  - DBParameterGroupFamily => (string)

    The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.

  - Description => (string)

    The description for the DB cluster parameter group.

  - Tags => (array<associative-array>)

    A list of tags.

    - (associative-array)

      Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

      - Key => (string)

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

      - Value => (string)

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- DBClusterParameterGroup => (associative-array)

  Contains the result of a successful invocation of the CreateDBClusterParameterGroup action.

  This data type is used as a request parameter in the DeleteDBClusterParameterGroup action, and as a response element in the DescribeDBClusterParameterGroups action.

  - DBClusterParameterGroupName => (string)

    Provides the name of the DB cluster parameter group.

  - DBParameterGroupFamily => (string)

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

  - Description => (string)

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

# `public `Guzzle\Service\Resource\Model``
`createDBClusterSnapshot( array $args = array() )`

Executes the CreateDBClusterSnapshot operation.

Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

#### Examples

- Basic formatting example

      $result = $client->createDBClusterSnapshot(array(
          // DBClusterSnapshotIdentifier is required
          'DBClusterSnapshotIdentifier' => 'string',
          // DBClusterIdentifier is required
          'DBClusterIdentifier' => 'string',
          'Tags' => array(
              array(
                  'Key' => 'string',
                  'Value' => 'string',
              ),
              // ... repeated
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DBClusterSnapshotIdentifier => (string)

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

    Constraints:

    - Must contain from 1 to 63 alphanumeric characters or hyphens.
    - First character must be a letter.
    - Cannot end with a hyphen or contain two consecutive hyphens.

    Example: my-cluster1-snapshot1

  - DBClusterIdentifier => (string)

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

    Constraints:

    - Must contain from 1 to 63 alphanumeric characters or hyphens.
    - First character must be a letter.
    - Cannot end with a hyphen or contain two consecutive hyphens.

    Example: my-cluster1

  - Tags => (array<associative-array>)

    The tags to be assigned to the DB cluster snapshot.

    - (associative-array)

      Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

      - Key => (string)

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

      - Value => (string)

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- DBClusterSnapshot => (associative-array)

  Contains the result of a successful invocation of the following actions:

  - CreateDBClusterSnapshot
  - DeleteDBClusterSnapshot

  This data type is used as a response element in the DescribeDBClusterSnapshots action.

  - AvailabilityZones => (array<string>)

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

  - DBClusterSnapshotIdentifier => (string)

    Specifies the identifier for the DB cluster snapshot.

  - DBClusterIdentifier => (string)

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

  - SnapshotCreateTime => (string)

    Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

  - Engine => (string)

    Specifies the name of the database engine.

  - AllocatedStorage => (int)

    Specifies the allocated storage size in gigabytes (GB).

  - Status => (string)

    Specifies the status of this DB cluster snapshot.

  - Port => (int)

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

  - VpcId => (string)

    Provides the VPC ID associated with the DB cluster snapshot.

  - ClusterCreateTime => (string)

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

  - MasterUsername => (string)

    Provides the master username for the DB cluster snapshot.

  - EngineVersion => (string)

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

  - LicenseModel => (string)

    Provides the license model information for this DB cluster snapshot.

  - SnapshotType => (string)

    Provides the type of the DB cluster snapshot.

  - PercentProgress => (int)

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

# `public `Guzzle\Service\Resource\Model``
`createDBInstance( array $args = array() )`

Executes the CreateDBInstance operation.

Creates a new DB instance.

#### Examples

- Basic formatting example

      $result = $client->createDBInstance(array(
          'DBName' => 'string',
          // DBInstanceIdentifier is required
          'DBInstanceIdentifier' => 'string',
          'AllocatedStorage' => integer,
          // DBInstanceClass is required
          'DBInstanceClass' => 'string',
          // Engine is required
          'Engine' => 'string',
          'MasterUsername' => 'string',
          'MasterUserPassword' => 'string',
          'DBSecurityGroups' => array('string', ... ),
          'VpcSecurityGroupIds' => array('string', ... ),
          'AvailabilityZone' => 'string',
          'DBSubnetGroupName' => 'string',
          'PreferredMaintenanceWindow' => 'string',
          'DBParameterGroupName' => 'string',
          'BackupRetentionPeriod' => integer,
          'PreferredBackupWindow' => 'string',
          'Port' => integer,
          'MultiAZ' => true || false,
          'EngineVersion' => 'string',
          'AutoMinorVersionUpgrade' => true || false,
          'LicenseModel' => 'string',
          'Iops' => integer,
          'OptionGroupName' => 'string',
          'CharacterSetName' => 'string',
          'PubliclyAccessible' => true || false,
          'Tags' => array(
              array(
                  'Key' => 'string',
                  'Value' => 'string',
              ),
              // ... repeated
          ),
          'DBClusterIdentifier' => 'string',
          'StorageType' => 'string',
          'TdeCredentialArn' => 'string',
          'TdeCredentialPassword' => 'string',
          'StorageEncrypted' => true || false,
          'KmsKeyId' => 'string',
          'CopyTagsToSnapshot' => true || false,
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DBName => (string)

    The meaning of this parameter differs according to the database engine you use.

    Type: String

    MySQL

    The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.

    Constraints:

    - Must contain 1 to 64 alphanumeric characters
    - Cannot be a word reserved by the specified database engine

    PostgreSQL

    The name of the database to create when the DB instance is created. If this parameter is not specified, the default "postgres" database is created in the DB instance.

    Constraints:

    - Must contain 1 to 63 alphanumeric characters
    - Must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits (0-9).
    - Cannot be a word reserved by the specified database engine

    Oracle

    The Oracle System ID (SID) of the created DB instance.

    Default: ORCL

    Constraints:

    - Cannot be longer than 8 characters

    SQL Server

    Not applicable. Must be null.

    Amazon Aurora

    The name of the database to create when the primary instance of the DB cluster is created. If this parameter is not specified, no database is created in the DB instance.

    Constraints:

    - Must contain 1 to 64 alphanumeric characters
    - Cannot be a word reserved by the specified database engine
  - DBInstanceIdentifier => (string)

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

    Constraints:

    - Must contain from 1 to 63 alphanumeric characters or hyphens (1 to 15 for SQL Server).
    - First character must be a letter.
    - Cannot end with a hyphen or contain two consecutive hyphens.

    Example: mydbinstance

  - AllocatedStorage => (int)

    The amount of storage (in gigabytes) to be initially allocated for the database instance.

    Type: Integer

    MySQL

    Constraints: Must be an integer from 5 to 6144.

    PostgreSQL

    Constraints: Must be an integer from 5 to 6144.

    Oracle

    Constraints: Must be an integer from 10 to 6144.

    SQL Server

    Constraints: Must be an integer from 200 to 4096 (Standard Edition and Enterprise Edition) or from 20 to 4096 (Express Edition and Web Edition)

  - DBInstanceClass => (string)

    The compute and memory capacity of the DB instance.

    Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium

  - Engine => (string)

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

    Valid Values: MySQL | oracle-se1 | oracle-se | oracle-ee | sqlserver-ee | sqlserver-se | sqlserver-ex | sqlserver-web | postgres

    Not every database engine is available for every AWS region.

  - MasterUsername => (string)

    The name of master user for the client DB instance.

    MySQL

    Constraints:

    - Must be 1 to 16 alphanumeric characters.
    - First character must be a letter.
    - Cannot be a reserved word for the chosen database engine.

    Type: String

    Oracle

    Constraints:

    - Must be 1 to 30 alphanumeric characters.
    - First character must be a letter.
    - Cannot be a reserved word for the chosen database engine.

    SQL Server

    Constraints:

    - Must be 1 to 128 alphanumeric characters.
    - First character must be a letter.
    - Cannot be a reserved word for the chosen database engine.

    PostgreSQL

    Constraints:

    - Must be 1 to 63 alphanumeric characters.
    - First character must be a letter.
    - Cannot be a reserved word for the chosen database engine.
  - MasterUserPassword => (string)

    The password for the master database user. Can be any printable ASCII character except "/", """, or "@".

    Type: String

    MySQL

    Constraints: Must contain from 8 to 41 characters.

    Oracle

    Constraints: Must contain from 8 to 30 characters.

    SQL Server

    Constraints: Must contain from 8 to 128 characters.

    PostgreSQL

    Constraints: Must contain from 8 to 128 characters.

    Amazon Aurora

    Constraints: Must contain from 8 to 41 characters.

  - DBSecurityGroups => (array<string>)

    A list of DB security groups to associate with this DB instance.

    Default: The default DB security group for the database engine.

  - VpcSecurityGroupIds => (array<string>)

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

    Default: The default EC2 VPC security group for the DB subnet group's VPC.

  - AvailabilityZone => (string)

    The EC2 Availability Zone that the database instance will be created in. For information on regions and Availability Zones, see Regions and Availability Zones.

    Default: A random, system-chosen Availability Zone in the endpoint's region.

    Example: us-east-1d

    Constraint: The AvailabilityZone parameter cannot be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same region as the current endpoint.

  - DBSubnetGroupName => (string)

    A DB subnet group to associate with this DB instance.

    If there is no DB subnet group, then it is a non-VPC DB instance.

  - PreferredMaintenanceWindow => (string)

    The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see DB Instance Maintenance.

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

    Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

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

    Constraints: Minimum 30-minute window.

  - DBParameterGroupName => (string)

    The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine will be used.

    Constraints:

    - Must be 1 to 255 alphanumeric characters
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
  - BackupRetentionPeriod => (int)

    The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

    Default: 1

    Constraints:

    - Must be a value from 0 to 35
    - Cannot be set to 0 if the DB instance is a source to Read Replicas
  - PreferredBackupWindow => (string)

    The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. For more information, see DB Instance Backups.

    Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

    Constraints:

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

    The port number on which the database accepts connections.

    MySQL

    Default: 3306

    Valid Values: 1150-65535

    Type: Integer

    PostgreSQL

    Default: 5432

    Valid Values: 1150-65535

    Type: Integer

    Oracle

    Default: 1521

    Valid Values: 1150-65535

    SQL Server

    Default: 1433

    Valid Values: 1150-65535 except for 1434, 3389, 47001, 49152, and 49152 through 49156.

    Amazon Aurora

    Default: 3306

    Valid Values: 1150-65535

    Type: Integer

  - MultiAZ => (bool)

    Specifies if the DB instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the MultiAZ parameter is set to true. Do not set this value if you want a Multi-AZ deployment for a SQL Server DB instance. Multi-AZ for SQL Server is set using the Mirroring option in an option group.

  - EngineVersion => (string)

    The version number of the database engine to use.

    The following are the database engines and major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS region.

    MySQL

    - Version 5.1 (Only available in the following regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-west-1, us-west-2): 5.1.73a | 5.1.73b
    - Version 5.5 (Only available in the following regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-west-1, us-west-2): 5.5.40 | 5.5.40a
    - Version 5.5 (Available in all regions): 5.5.40b | 5.5.41 | 5.5.42
    - Version 5.6 (Available in all regions): 5.6.19a | 5.6.19b | 5.6.21 | 5.6.21b | 5.6.22 | 5.6.23

    MySQL

    - Version 5.1 (Only available in the following regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-west-1, us-west-2): 5.1.73a | 5.1.73b
    - Version 5.5 (Only available in the following regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-west-1, us-west-2): 5.5.40 | 5.5.40a
    - Version 5.5 (Available in all regions): 5.5.40b | 5.5.41 | 5.5.42
    - Version 5.6 (Available in all regions): 5.6.19a | 5.6.19b | 5.6.21 | 5.6.21b | 5.6.22 | 5.6.23

    MySQL

    - Version 5.1 (Only available in the following regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-west-1, us-west-2): 5.1.73a | 5.1.73b
    - Version 5.5 (Only available in the following regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-west-1, us-west-2): 5.5.40 | 5.5.40a
    - Version 5.5 (Available in all regions): 5.5.40b | 5.5.41 | 5.5.42
    - Version 5.6 (Available in all regions): 5.6.19a | 5.6.19b | 5.6.21 | 5.6.21b | 5.6.22 | 5.6.23

    MySQL

    - Version 5.1 (Only available in the following regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-west-1, us-west-2): 5.1.73a | 5.1.73b
    - Version 5.5 (Only available in the following regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-west-1, us-west-2): 5.5.40 | 5.5.40a
    - Version 5.5 (Available in all regions): 5.5.40b | 5.5.41 | 5.5.42
    - Version 5.6 (Available in all regions): 5.6.19a | 5.6.19b | 5.6.21 | 5.6.21b | 5.6.22 | 5.6.23

    Oracle Database Enterprise Edition (oracle-ee)

    - Version 11.2 (Only available in the following regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-west-1, us-west-2): 11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7
    - Version 11.2 (Available in all regions): 11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.3.v3 | 11.2.0.4.v1 | 11.2.0.4.v3 | 11.2.0.4.v4
    - Version 12.1 (Available in all regions): 12.1.0.1.v1 | 12.1.0.1.v2 | 12.1.0.2.v1

    Oracle Database Enterprise Edition (oracle-ee)

    - Version 11.2 (Only available in the following regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-west-1, us-west-2): 11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7
    - Version 11.2 (Available in all regions): 11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.3.v3 | 11.2.0.4.v1 | 11.2.0.4.v3 | 11.2.0.4.v4
    - Version 12.1 (Available in all regions): 12.1.0.1.v1 | 12.1.0.1.v2 | 12.1.0.2.v1

    Oracle Database Enterprise Edition (oracle-ee)

    - Version 11.2 (Only available in the following regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-west-1, us-west-2): 11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7
    - Version 11.2 (Available in all regions): 11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.3.v3 | 11.2.0.4.v1 | 11.2.0.4.v3 | 11.2.0.4.v4
    - Version 12.1 (Available in all regions): 12.1.0.1.v1 | 12.1.0.1.v2 | 12.1.0.2.v1

    Oracle Database Standard Edition (oracle-se)

    - Version 11.2 (Only available in the following regions: us-west-1): 11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7
    - Version 11.2 (Only available in the following regions: eu-central-1, us-west-1): 11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.3.v3 | 11.2.0.4.v1 | 11.2.0.4.v3 | 11.2.0.4.v4
    - Version 12.1 (Only available in the following regions: eu-central-1, us-west-1): 12.1.0.1.v1 | 12.1.0.1.v2

    Oracle Database Standard Edition (oracle-se)

    - Version 11.2 (Only available in the following regions: us-west-1): 11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7
    - Version 11.2 (Only available in the following regions: eu-central-1, us-west-1): 11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.3.v3 | 11.2.0.4.v1 | 11.2.0.4.v3 | 11.2.0.4.v4
    - Version 12.1 (Only available in the following regions: eu-central-1, us-west-1): 12.1.0.1.v1 | 12.1.0.1.v2

    Oracle Database Standard Edition (oracle-se)

    - Version 11.2 (Only available in the following regions: us-west-1): 11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7
    - Version 11.2 (Only available in the following regions: eu-central-1, us-west-1): 11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.3.v3 | 11.2.0.4.v1 | 11.2.0.4.v3 | 11.2.0.4.v4
    - Version 12.1 (Only available in the following regions: eu-central-1, us-west-1): 12.1.0.1.v1 | 12.1.0.1.v2

    Oracle Database Standard Edition One (oracle-se1)

    - Version 11.2 (Only available in the following regions: us-west-1): 11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7
    - Version 11.2 (Only available in the following regions: eu-central-1, us-west-1): 11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.3.v3 | 11.2.0.4.v1 | 11.2.0.4.v3 | 11.2.0.4.v4
    - Version 12.1 (Only available in the following regions: eu-central-1, us-west-1): 12.1.0.1.v1 | 12.1.0.1.v2

    Oracle Database Standard Edition One (oracle-se1)

    - Version 11.2 (Only available in the following regions: us-west-1): 11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7
    - Version 11.2 (Only available in the following regions: eu-central-1, us-west-1): 11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.3.v3 | 11.2.0.4.v1 | 11.2.0.4.v3 | 11.2.0.4.v4
    - Version 12.1 (Only available in the following regions: eu-central-1, us-west-1): 12.1.0.1.v1 | 12.1.0.1.v2

    Oracle Database Standard Edition One (oracle-se1)

    - Version 11.2 (Only available in the following regions: us-west-1): 11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7
    - Version 11.2 (Only available in the following regions: eu-central-1, us-west-1): 11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.3.v3 | 11.2.0.4.v1 | 11.2.0.4.v3 | 11.2.0.4.v4
    - Version 12.1 (Only available in the following regions: eu-central-1, us-west-1): 12.1.0.1.v1 | 12.1.0.1.v2

    PostgreSQL

    - Version 9.3 (Only available in the following regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-west-1, us-west-2): 9.3.1 | 9.3.2
    - Version 9.3 (Available in all regions): 9.3.3 | 9.3.5 | 9.3.6
    - Version 9.4 (Available in all regions): 9.4.1

    PostgreSQL

    - Version 9.3 (Only available in the following regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-west-1, us-west-2): 9.3.1 | 9.3.2
    - Version 9.3 (Available in all regions): 9.3.3 | 9.3.5 | 9.3.6
    - Version 9.4 (Available in all regions): 9.4.1

    PostgreSQL

    - Version 9.3 (Only available in the following regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-west-1, us-west-2): 9.3.1 | 9.3.2
    - Version 9.3 (Available in all regions): 9.3.3 | 9.3.5 | 9.3.6
    - Version 9.4 (Available in all regions): 9.4.1

    Microsoft SQL Server Enterprise Edition (sqlserver-ee)

    - Version 10.50 (Only available in the following regions: eu-central-1, us-west-1): 10.50.2789.0.v1
    - Version 11.00 (Only available in the following regions: eu-central-1, us-west-1): 11.00.2100.60.v1

    Microsoft SQL Server Enterprise Edition (sqlserver-ee)

    - Version 10.50 (Only available in the following regions: eu-central-1, us-west-1): 10.50.2789.0.v1
    - Version 11.00 (Only available in the following regions: eu-central-1, us-west-1): 11.00.2100.60.v1

    Microsoft SQL Server Express Edition (sqlserver-ex)

    - Version 10.50 (Available in all regions): 10.50.2789.0.v1
    - Version 11.00 (Available in all regions): 11.00.2100.60.v1

    Microsoft SQL Server Express Edition (sqlserver-ex)

    - Version 10.50 (Available in all regions): 10.50.2789.0.v1
    - Version 11.00 (Available in all regions): 11.00.2100.60.v1

    Microsoft SQL Server Standard Edition (sqlserver-se)

    - Version 10.50 (Available in all regions): 10.50.2789.0.v1
    - Version 11.00 (Available in all regions): 11.00.2100.60.v1

    Microsoft SQL Server Standard Edition (sqlserver-se)

    - Version 10.50 (Available in all regions): 10.50.2789.0.v1
    - Version 11.00 (Available in all regions): 11.00.2100.60.v1

    Microsoft SQL Server Web Edition (sqlserver-web)

    - Version 10.50 (Available in all regions): 10.50.2789.0.v1
    - Version 11.00 (Available in all regions): 11.00.2100.60.v1

    Microsoft SQL Server Web Edition (sqlserver-web)

    - Version 10.50 (Available in all regions): 10.50.2789.0.v1
    - Version 11.00 (Available in all regions): 11.00.2100.60.v1
  - AutoMinorVersionUpgrade => (bool)

    Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window.

    Default: true

  - LicenseModel => (string)

    License model information for this DB instance.

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

  - Iops => (int)

    The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

    Constraints: To use PIOPS, this value must be an integer greater than 1000.

  - OptionGroupName => (string)

    Indicates that the DB instance should be associated with the specified option group.

    Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance

  - CharacterSetName => (string)

    For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.

  - PubliclyAccessible => (bool)

    Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

    Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

    - Default VPC: true
    - VPC: false

    If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

  - Tags => (array<associative-array>)

    A list of tags.

    - (associative-array)

      Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

      - Key => (string)

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

      - Value => (string)

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

  - DBClusterIdentifier => (string)

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

    For information on creating a DB cluster, see CreateDBCluster.

    Type: String

  - StorageType => (string)

    Specifies the storage type to be associated with the DB instance.

    Valid values: standard | gp2 | io1

    If you specify io1, you must also include a value for the Iops parameter.

    Default: io1 if the Iops parameter is specified; otherwise standard

  - TdeCredentialArn => (string)

    The ARN from the Key Store with which to associate the instance for TDE encryption.

  - TdeCredentialPassword => (string)

    The password for the given ARN from the Key Store in order to access the device.

  - StorageEncrypted => (bool)

    Specifies whether the DB instance is encrypted.

    Default: false

  - KmsKeyId => (string)

    The KMS key identifier for an encrypted DB instance.

    The KMS key identifier is the Amazon Resoure Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.

    If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.

  - Domain => (string)

    Specify the Active Directory Domain to create the instance in.

  - CopyTagsToSnapshot => (bool)

    True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default is false.

  - MonitoringInterval => (int)

    The interval, in seconds, between when metrics are collected for the DB instance. Specify 0 to disable collecting metrics. The default is 60.

    Valid Values: 0, 1, 5, 10, 15, 30, 60

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- DBInstance => (associative-array)

  Contains the result of a successful invocation of the following actions:

  - CreateDBInstance
  - DeleteDBInstance
  - ModifyDBInstance

  This data type is used as a response element in the DescribeDBInstances action.

  - DBInstanceIdentifier => (string)

    Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

  - DBInstanceClass => (string)

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

  - Engine => (string)

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

  - DBInstanceStatus => (string)

    Specifies the current state of this database.

  - MasterUsername => (string)

    Contains the master username for the DB instance.

  - DBName => (string)

    The meaning of this parameter differs according to the database engine you use. For example, this value returns either MySQL or PostgreSQL information when returning values from CreateDBInstanceReadReplica since Read Replicas are only supported for MySQL and PostgreSQL.

    MySQL, SQL Server, PostgreSQL, Amazon Aurora

    Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

    Type: String

    Oracle

    Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

  - Endpoint => (associative-array)

    Specifies the connection endpoint.

    - Address => (string)

      Specifies the DNS address of the DB instance.

    - Port => (int)

      Specifies the port that the database engine is listening on.

    - HostedZoneId => (string)

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

  - AllocatedStorage => (int)

    Specifies the allocated storage size specified in gigabytes.

  - InstanceCreateTime => (string)

    Provides the date and time the DB instance was created.

  - PreferredBackupWindow => (string)

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

  - BackupRetentionPeriod => (int)

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

  - DBSecurityGroups => (array<associative-array>)

    Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

    - (associative-array)

      This data type is used as a response element in the following actions:

      - ModifyDBInstance
      - RebootDBInstance
      - RestoreDBInstanceFromDBSnapshot
      - RestoreDBInstanceToPointInTime
      - DBSecurityGroupName => (string)

        The name of the DB security group.

      - Status => (string)

        The status of the DB security group.

  - VpcSecurityGroups => (array<associative-array>)

    Provides List of VPC security group elements that the DB instance belongs to.

    - (associative-array)

      This data type is used as a response element for queries on VPC security group membership.

      - VpcSecurityGroupId => (string)

        The name of the VPC security group.

      - Status => (string)

        The status of the VPC security group.

  - DBParameterGroups => (array<associative-array>)

    Provides the list of DB parameter groups applied to this DB instance.

    - (associative-array)

      The status of the DB parameter group.

      This data type is used as a response element in the following actions:

      - CreateDBInstance
      - CreateDBInstanceReadReplica
      - DeleteDBInstance
      - ModifyDBInstance
      - RebootDBInstance
      - RestoreDBInstanceFromDBSnapshot
      - DBParameterGroupName => (string)

        The name of the DP parameter group.

      - ParameterApplyStatus => (string)

        The status of parameter updates.

  - AvailabilityZone => (string)

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

  - DBSubnetGroup => (associative-array)

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

    - DBSubnetGroupName => (string)

      Specifies the name of the DB subnet group.

    - DBSubnetGroupDescription => (string)

      Provides the description of the DB subnet group.

    - VpcId => (string)

      Provides the VpcId of the DB subnet group.

    - SubnetGroupStatus => (string)

      Provides the status of the DB subnet group.

    - Subnets => (array<associative-array>)

      Contains a list of Subnet elements.

      - (associative-array)

        This data type is used as a response element in the DescribeDBSubnetGroups action.

        - SubnetIdentifier => (string)

          Specifies the identifier of the subnet.

        - SubnetAvailabilityZone => (associative-array)

          Contains Availability Zone information.

          This data type is used as an element in the following data type:

          - OrderableDBInstanceOption
          - Name => (string)

            The name of the availability zone.

        - SubnetStatus => (string)

          Specifies the status of the subnet.

  - PreferredMaintenanceWindow => (string)

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

  - PendingModifiedValues => (associative-array)

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

    - DBInstanceClass => (string)

      Contains the new DBInstanceClass for the DB instance that will be applied or is in progress.

    - AllocatedStorage => (int)

      Contains the new AllocatedStorage size for the DB instance that will be applied or is in progress.

    - MasterUserPassword => (string)

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

    - Port => (int)

      Specifies the pending port for the DB instance.

    - BackupRetentionPeriod => (int)

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

    - MultiAZ => (bool)

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

    - EngineVersion => (string)

      Indicates the database engine version.

    - Iops => (int)

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

    - DBInstanceIdentifier => (string)

      Contains the new DBInstanceIdentifier for the DB instance that will be applied or is in progress.

    - StorageType => (string)

      Specifies the storage type to be associated with the DB instance.

    - CACertificateIdentifier => (string)

      Specifies the identifier of the CA certificate for the DB instance.

  - LatestRestorableTime => (string)

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

  - MultiAZ => (bool)

    Specifies if the DB instance is a Multi-AZ deployment.

  - EngineVersion => (string)

    Indicates the database engine version.

  - AutoMinorVersionUpgrade => (bool)

    Indicates that minor version patches are applied automatically.

  - ReadReplicaSourceDBInstanceIdentifier => (string)

    Contains the identifier of the source DB instance if this DB instance is a Read Replica.

  - ReadReplicaDBInstanceIdentifiers => (array<string>)

    Contains one or more identifiers of the Read Replicas associated with this DB instance.

  - LicenseModel => (string)

    License model information for this DB instance.

  - Iops => (int)

    Specifies the Provisioned IOPS (I/O operations per second) value.

  - OptionGroupMemberships => (array<associative-array>)

    Provides the list of option group memberships for this DB instance.

    - (associative-array)

      Provides information on the option groups the DB instance is a member of.

      - OptionGroupName => (string)

        The name of the option group that the instance belongs to.

      - Status => (string)

        The status of the DB instance's option group membership (e.g. in-sync, pending, pending-maintenance, applying).

  - CharacterSetName => (string)

    If present, specifies the name of the character set that this instance is associated with.

  - SecondaryAvailabilityZone => (string)

    If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

  - PubliclyAccessible => (bool)

    Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

    Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

    - Default VPC:true
    - VPC:false

    If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

  - StatusInfos => (array<associative-array>)

    The status of a Read Replica. If the instance is not a Read Replica, this will be blank.

    - (associative-array)

      Provides a list of status information for a DB instance.

      - StatusType => (string)

        This value is currently "read replication."

      - Normal => (bool)

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

      - Status => (string)

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

      - Message => (string)

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

  - StorageType => (string)

    Specifies the storage type associated with DB instance.

  - TdeCredentialArn => (string)

    The ARN from the Key Store with which the instance is associated for TDE encryption.

  - DbInstancePort => (int)

    Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

  - DBClusterIdentifier => (string)

    If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

  - StorageEncrypted => (bool)

    Specifies whether the DB instance is encrypted.

  - KmsKeyId => (string)

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

  - DbiResourceId => (string)

    If StorageEncrypted is true, the region-unique, immutable identifier for the encrypted DB instance. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB instance is accessed.

  - CACertificateIdentifier => (string)

    The identifier of the CA certificate for this DB instance.

  - DomainMemberships => (array<associative-array>)

    The Active Directory Domain membership records associated with the DB instance.

    - (associative-array)

      An Active Directory Domain membership record associated with the DB instance.

      - Domain => (string)

        The identifier of the Active Directory Domain.

      - Status => (string)

        The status of the DB instance's Active Directory Domain membership (e.g. joined, pending-join, failed etc).

      - Connectivity => (string)

        The observed connectivity of the Active Directory Domain.

  - CopyTagsToSnapshot => (bool)

    Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

  - MonitoringInterval => (int)

    The interval, in seconds, between when metrics are collected for the DB instance.

# `public `Guzzle\Service\Resource\Model``
`createDBInstanceReadReplica( array $args = array() )`

Executes the CreateDBInstanceReadReplica operation.

Creates a DB instance for a DB instance running MySQL or PostgreSQL that acts as a Read Replica of a source DB instance.

All Read Replica DB instances are created as Single-AZ deployments with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified below.

The source DB instance must have backup retention enabled.

#### Examples

- Basic formatting example

      $result = $client->createDBInstanceReadReplica(array(
          // DBInstanceIdentifier is required
          'DBInstanceIdentifier' => 'string',
          // SourceDBInstanceIdentifier is required
          'SourceDBInstanceIdentifier' => 'string',
          'DBInstanceClass' => 'string',
          'AvailabilityZone' => 'string',
          'Port' => integer,
          'AutoMinorVersionUpgrade' => true || false,
          'Iops' => integer,
          'OptionGroupName' => 'string',
          'PubliclyAccessible' => true || false,
          'Tags' => array(
              array(
                  'Key' => 'string',
                  'Value' => 'string',
              ),
              // ... repeated
          ),
          'DBSubnetGroupName' => 'string',
          'StorageType' => 'string',
          'CopyTagsToSnapshot' => true || false,
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DBInstanceIdentifier => (string)

    The DB instance identifier of the Read Replica. This identifier is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.

  - SourceDBInstanceIdentifier => (string)

    The identifier of the DB instance that will act as the source for the Read Replica. Each DB instance can have up to five Read Replicas.

    Constraints:

    - Must be the identifier of an existing DB instance.
    - Can specify a DB instance that is a MySQL Read Replica only if the source is running MySQL 5.6.
    - Can specify a DB instance that is a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5.
    - The specified DB instance must have automatic backups enabled, its backup retention period must be greater than 0.
    - If the source DB instance is in the same region as the Read Replica, specify a valid DB instance identifier.
    - If the source DB instance is in a different region than the Read Replica, specify a valid DB instance ARN. For more information, go to Constructing a Amazon RDS Amazon Resource Name (ARN).
  - DBInstanceClass => (string)

    The compute and memory capacity of the Read Replica.

    Valid Values: db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium

    Default: Inherits from the source DB instance.

  - AvailabilityZone => (string)

    The Amazon EC2 Availability Zone that the Read Replica will be created in.

    Default: A random, system-chosen Availability Zone in the endpoint's region.

    Example: us-east-1d

  - Port => (int)

    The port number that the DB instance uses for connections.

    Default: Inherits from the source DB instance

    Valid Values: 1150-65535

  - AutoMinorVersionUpgrade => (bool)

    Indicates that minor engine upgrades will be applied automatically to the Read Replica during the maintenance window.

    Default: Inherits from the source DB instance

  - Iops => (int)

    The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

  - OptionGroupName => (string)

    The option group the DB instance will be associated with. If omitted, the default option group for the engine specified will be used.

  - PubliclyAccessible => (bool)

    Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

    Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

    - Default VPC:true
    - VPC:false

    If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

  - Tags => (array<associative-array>)

    A list of tags.

    - (associative-array)

      Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

      - Key => (string)

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

      - Value => (string)

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

  - DBSubnetGroupName => (string)

    Specifies a DB subnet group for the DB instance. The new DB instance will be created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance is not created in a VPC.

    Constraints:

    - Can only be specified if the source DB instance identifier specifies a DB instance in another region.
    - The specified DB subnet group must be in the same region in which the operation is running.
    - All Read Replicas in one region that are created from the same source DB instance must either:
      - Specify DB subnet groups from the same VPC. All these Read Replicas will be created in the same VPC.
      - Not specify a DB subnet group. All these Read Replicas will be created outside of any VPC.
  - StorageType => (string)

    Specifies the storage type to be associated with the Read Replica.

    Valid values: standard | gp2 | io1

    If you specify io1, you must also include a value for the Iops parameter.

    Default: io1 if the Iops parameter is specified; otherwise standard

  - CopyTagsToSnapshot => (bool)

    True to copy all tags from the Read Replica to snapshots of the Read Replica; otherwise false. The default is false.

  - MonitoringInterval => (int)

    The interval, in seconds, between when metrics are collected for the Read Replica. Specify 0 to disable collecting metrics. The default is 60.

    Valid Values: 0, 1, 5, 10, 15, 30, 60

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- DBInstance => (associative-array)

  Contains the result of a successful invocation of the following actions:

  - CreateDBInstance
  - DeleteDBInstance
  - ModifyDBInstance

  This data type is used as a response element in the DescribeDBInstances action.

  - DBInstanceIdentifier => (string)

    Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

  - DBInstanceClass => (string)

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

  - Engine => (string)

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

  - DBInstanceStatus => (string)

    Specifies the current state of this database.

  - MasterUsername => (string)

    Contains the master username for the DB instance.

  - DBName => (string)

    The meaning of this parameter differs according to the database engine you use. For example, this value returns either MySQL or PostgreSQL information when returning values from CreateDBInstanceReadReplica since Read Replicas are only supported for MySQL and PostgreSQL.

    MySQL, SQL Server, PostgreSQL, Amazon Aurora

    Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

    Type: String

    Oracle

    Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

  - Endpoint => (associative-array)

    Specifies the connection endpoint.

    - Address => (string)

      Specifies the DNS address of the DB instance.

    - Port => (int)

      Specifies the port that the database engine is listening on.

    - HostedZoneId => (string)

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

  - AllocatedStorage => (int)

    Specifies the allocated storage size specified in gigabytes.

  - InstanceCreateTime => (string)

    Provides the date and time the DB instance was created.

  - PreferredBackupWindow => (string)

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

  - BackupRetentionPeriod => (int)

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

  - DBSecurityGroups => (array<associative-array>)

    Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

    - (associative-array)

      This data type is used as a response element in the following actions:

      - ModifyDBInstance
      - RebootDBInstance
      - RestoreDBInstanceFromDBSnapshot
      - RestoreDBInstanceToPointInTime
      - DBSecurityGroupName => (string)

        The name of the DB security group.

      - Status => (string)

        The status of the DB security group.

  - VpcSecurityGroups => (array<associative-array>)

    Provides List of VPC security group elements that the DB instance belongs to.

    - (associative-array)

      This data type is used as a response element for queries on VPC security group membership.

      - VpcSecurityGroupId => (string)

        The name of the VPC security group.

      - Status => (string)

        The status of the VPC security group.

  - DBParameterGroups => (array<associative-array>)

    Provides the list of DB parameter groups applied to this DB instance.

    - (associative-array)

      The status of the DB parameter group.

      This data type is used as a response element in the following actions:

      - CreateDBInstance
      - CreateDBInstanceReadReplica
      - DeleteDBInstance
      - ModifyDBInstance
      - RebootDBInstance
      - RestoreDBInstanceFromDBSnapshot
      - DBParameterGroupName => (string)

        The name of the DP parameter group.

      - ParameterApplyStatus => (string)

        The status of parameter updates.

  - AvailabilityZone => (string)

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

  - DBSubnetGroup => (associative-array)

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

    - DBSubnetGroupName => (string)

      Specifies the name of the DB subnet group.

    - DBSubnetGroupDescription => (string)

      Provides the description of the DB subnet group.

    - VpcId => (string)

      Provides the VpcId of the DB subnet group.

    - SubnetGroupStatus => (string)

      Provides the status of the DB subnet group.

    - Subnets => (array<associative-array>)

      Contains a list of Subnet elements.

      - (associative-array)

        This data type is used as a response element in the DescribeDBSubnetGroups action.

        - SubnetIdentifier => (string)

          Specifies the identifier of the subnet.

        - SubnetAvailabilityZone => (associative-array)

          Contains Availability Zone information.

          This data type is used as an element in the following data type:

          - OrderableDBInstanceOption
          - Name => (string)

            The name of the availability zone.

        - SubnetStatus => (string)

          Specifies the status of the subnet.

  - PreferredMaintenanceWindow => (string)

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

  - PendingModifiedValues => (associative-array)

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

    - DBInstanceClass => (string)

      Contains the new DBInstanceClass for the DB instance that will be applied or is in progress.

    - AllocatedStorage => (int)

      Contains the new AllocatedStorage size for the DB instance that will be applied or is in progress.

    - MasterUserPassword => (string)

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

    - Port => (int)

      Specifies the pending port for the DB instance.

    - BackupRetentionPeriod => (int)

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

    - MultiAZ => (bool)

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

    - EngineVersion => (string)

      Indicates the database engine version.

    - Iops => (int)

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

    - DBInstanceIdentifier => (string)

      Contains the new DBInstanceIdentifier for the DB instance that will be applied or is in progress.

    - StorageType => (string)

      Specifies the storage type to be associated with the DB instance.

    - CACertificateIdentifier => (string)

      Specifies the identifier of the CA certificate for the DB instance.

  - LatestRestorableTime => (string)

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

  - MultiAZ => (bool)

    Specifies if the DB instance is a Multi-AZ deployment.

  - EngineVersion => (string)

    Indicates the database engine version.

  - AutoMinorVersionUpgrade => (bool)

    Indicates that minor version patches are applied automatically.

  - ReadReplicaSourceDBInstanceIdentifier => (string)

    Contains the identifier of the source DB instance if this DB instance is a Read Replica.

  - ReadReplicaDBInstanceIdentifiers => (array<string>)

    Contains one or more identifiers of the Read Replicas associated with this DB instance.

  - LicenseModel => (string)

    License model information for this DB instance.

  - Iops => (int)

    Specifies the Provisioned IOPS (I/O operations per second) value.

  - OptionGroupMemberships => (array<associative-array>)

    Provides the list of option group memberships for this DB instance.

    - (associative-array)

      Provides information on the option groups the DB instance is a member of.

      - OptionGroupName => (string)

        The name of the option group that the instance belongs to.

      - Status => (string)

        The status of the DB instance's option group membership (e.g. in-sync, pending, pending-maintenance, applying).

  - CharacterSetName => (string)

    If present, specifies the name of the character set that this instance is associated with.

  - SecondaryAvailabilityZone => (string)

    If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

  - PubliclyAccessible => (bool)

    Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

    Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

    - Default VPC:true
    - VPC:false

    If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

  - StatusInfos => (array<associative-array>)

    The status of a Read Replica. If the instance is not a Read Replica, this will be blank.

    - (associative-array)

      Provides a list of status information for a DB instance.

      - StatusType => (string)

        This value is currently "read replication."

      - Normal => (bool)

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

      - Status => (string)

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

      - Message => (string)

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

  - StorageType => (string)

    Specifies the storage type associated with DB instance.

  - TdeCredentialArn => (string)

    The ARN from the Key Store with which the instance is associated for TDE encryption.

  - DbInstancePort => (int)

    Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

  - DBClusterIdentifier => (string)

    If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

  - StorageEncrypted => (bool)

    Specifies whether the DB instance is encrypted.

  - KmsKeyId => (string)

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

  - DbiResourceId => (string)

    If StorageEncrypted is true, the region-unique, immutable identifier for the encrypted DB instance. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB instance is accessed.

  - CACertificateIdentifier => (string)

    The identifier of the CA certificate for this DB instance.

  - DomainMemberships => (array<associative-array>)

    The Active Directory Domain membership records associated with the DB instance.

    - (associative-array)

      An Active Directory Domain membership record associated with the DB instance.

      - Domain => (string)

        The identifier of the Active Directory Domain.

      - Status => (string)

        The status of the DB instance's Active Directory Domain membership (e.g. joined, pending-join, failed etc).

      - Connectivity => (string)

        The observed connectivity of the Active Directory Domain.

  - CopyTagsToSnapshot => (bool)

    Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

  - MonitoringInterval => (int)

    The interval, in seconds, between when metrics are collected for the DB instance.

# `public `Guzzle\Service\Resource\Model``
`createDBParameterGroup( array $args = array() )`

Executes the CreateDBParameterGroup operation.

Creates a new DB parameter group.

A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.

After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.

#### Examples

- Basic formatting example

      $result = $client->createDBParameterGroup(array(
          // DBParameterGroupName is required
          'DBParameterGroupName' => 'string',
          // DBParameterGroupFamily is required
          'DBParameterGroupFamily' => 'string',
          // Description is required
          'Description' => 'string',
          'Tags' => array(
              array(
                  'Key' => 'string',
                  'Value' => 'string',
              ),
              // ... repeated
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DBParameterGroupName => (string)

    The name of the DB parameter group.

    Constraints:

    - Must be 1 to 255 alphanumeric characters
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
    This value is stored as a lowercase string.
  - DBParameterGroupFamily => (string)

    The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.

  - Description => (string)

    The description for the DB parameter group.

  - Tags => (array<associative-array>)

    A list of tags.

    - (associative-array)

      Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

      - Key => (string)

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

      - Value => (string)

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- DBParameterGroup => (associative-array)

  Contains the result of a successful invocation of the CreateDBParameterGroup action.

  This data type is used as a request parameter in the DeleteDBParameterGroup action, and as a response element in the DescribeDBParameterGroups action.

  - DBParameterGroupName => (string)

    Provides the name of the DB parameter group.

  - DBParameterGroupFamily => (string)

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

  - Description => (string)

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

# `public `Guzzle\Service\Resource\Model``
`createDBSecurityGroup( array $args = array() )`

Executes the CreateDBSecurityGroup operation.

Creates a new DB security group. DB security groups control access to a DB instance.

#### Examples

- Basic formatting example

      $result = $client->createDBSecurityGroup(array(
          // DBSecurityGroupName is required
          'DBSecurityGroupName' => 'string',
          // DBSecurityGroupDescription is required
          'DBSecurityGroupDescription' => 'string',
          'Tags' => array(
              array(
                  'Key' => 'string',
                  'Value' => 'string',
              ),
              // ... repeated
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DBSecurityGroupName => (string)

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

    Constraints:

    - Must be 1 to 255 alphanumeric characters
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
    - Must not be "Default"
    - Cannot contain spaces

    Example: mysecuritygroup

  - DBSecurityGroupDescription => (string)

    The description for the DB security group.

  - Tags => (array<associative-array>)

    A list of tags.

    - (associative-array)

      Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

      - Key => (string)

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

      - Value => (string)

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- DBSecurityGroup => (associative-array)

  Contains the result of a successful invocation of the following actions:

  - DescribeDBSecurityGroups
  - AuthorizeDBSecurityGroupIngress
  - CreateDBSecurityGroup
  - RevokeDBSecurityGroupIngress

  This data type is used as a response element in the DescribeDBSecurityGroups action.

  - OwnerId => (string)

    Provides the AWS ID of the owner of a specific DB security group.

  - DBSecurityGroupName => (string)

    Specifies the name of the DB security group.

  - DBSecurityGroupDescription => (string)

    Provides the description of the DB security group.

  - VpcId => (string)

    Provides the VpcId of the DB security group.

  - EC2SecurityGroups => (array<associative-array>)

    Contains a list of EC2SecurityGroup elements.

    - (associative-array)

      This data type is used as a response element in the following actions:

      - AuthorizeDBSecurityGroupIngress
      - DescribeDBSecurityGroups
      - RevokeDBSecurityGroupIngress
      - Status => (string)

        Provides the status of the EC2 security group. Status can be "authorizing", "authorized", "revoking", and "revoked".

      - EC2SecurityGroupName => (string)

        Specifies the name of the EC2 security group.

      - EC2SecurityGroupId => (string)

        Specifies the id of the EC2 security group.

      - EC2SecurityGroupOwnerId => (string)

        Specifies the AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.

  - IPRanges => (array<associative-array>)

    Contains a list of IPRange elements.

    - (associative-array)

      This data type is used as a response element in the DescribeDBSecurityGroups action.

      - Status => (string)

        Specifies the status of the IP range. Status can be "authorizing", "authorized", "revoking", and "revoked".

      - CIDRIP => (string)

        Specifies the IP range.

# `public `Guzzle\Service\Resource\Model``
`createDBSnapshot( array $args = array() )`

Executes the CreateDBSnapshot operation.

Creates a DBSnapshot. The source DBInstance must be in "available" state.

#### Examples

- Basic formatting example

      $result = $client->createDBSnapshot(array(
          // DBSnapshotIdentifier is required
          'DBSnapshotIdentifier' => 'string',
          // DBInstanceIdentifier is required
          'DBInstanceIdentifier' => 'string',
          'Tags' => array(
              array(
                  'Key' => 'string',
                  'Value' => 'string',
              ),
              // ... repeated
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DBSnapshotIdentifier => (string)

    The identifier for the DB snapshot.

    Constraints:

    - Cannot be null, empty, or blank
    - Must contain from 1 to 255 alphanumeric characters or hyphens
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens

    Example: my-snapshot-id

  - DBInstanceIdentifier => (string)

    The DB instance identifier. This is the unique key that identifies a DB instance.

    Constraints:

    - Must contain from 1 to 63 alphanumeric characters or hyphens
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
  - Tags => (array<associative-array>)

    A list of tags.

    - (associative-array)

      Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

      - Key => (string)

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

      - Value => (string)

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- DBSnapshot => (associative-array)

  Contains the result of a successful invocation of the following actions:

  - CreateDBSnapshot
  - DeleteDBSnapshot

  This data type is used as a response element in the DescribeDBSnapshots action.

  - DBSnapshotIdentifier => (string)

    Specifies the identifier for the DB snapshot.

  - DBInstanceIdentifier => (string)

    Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

  - SnapshotCreateTime => (string)

    Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

  - Engine => (string)

    Specifies the name of the database engine.

  - AllocatedStorage => (int)

    Specifies the allocated storage size in gigabytes (GB).

  - Status => (string)

    Specifies the status of this DB snapshot.

  - Port => (int)

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

  - AvailabilityZone => (string)

    Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

  - VpcId => (string)

    Provides the VPC ID associated with the DB snapshot.

  - InstanceCreateTime => (string)

    Specifies the time when the snapshot was taken, in Universal Coordinated Time (UTC).

  - MasterUsername => (string)

    Provides the master username for the DB snapshot.

  - EngineVersion => (string)

    Specifies the version of the database engine.

  - LicenseModel => (string)

    License model information for the restored DB instance.

  - SnapshotType => (string)

    Provides the type of the DB snapshot.

  - Iops => (int)

    Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

  - OptionGroupName => (string)

    Provides the option group name for the DB snapshot.

  - PercentProgress => (int)

    The percentage of the estimated data that has been transferred.

  - SourceRegion => (string)

    The region that the DB snapshot was created in or copied from.

  - SourceDBSnapshotIdentifier => (string)

    The DB snapshot Arn that the DB snapshot was copied from. It only has value in case of cross customer or cross region copy.

  - StorageType => (string)

    Specifies the storage type associated with DB Snapshot.

  - TdeCredentialArn => (string)

    The ARN from the Key Store with which to associate the instance for TDE encryption.

  - Encrypted => (bool)

    Specifies whether the DB snapshot is encrypted.

  - KmsKeyId => (string)

    If Encrypted is true, the KMS key identifier for the encrypted DB snapshot.

# `public `Guzzle\Service\Resource\Model``
`createDBSubnetGroup( array $args = array() )`

Executes the CreateDBSubnetGroup operation.

Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.

#### Examples

- Basic formatting example

      $result = $client->createDBSubnetGroup(array(
          // DBSubnetGroupName is required
          'DBSubnetGroupName' => 'string',
          // DBSubnetGroupDescription is required
          'DBSubnetGroupDescription' => 'string',
          // SubnetIds is required
          'SubnetIds' => array('string', ... ),
          'Tags' => array(
              array(
                  'Key' => 'string',
                  'Value' => 'string',
              ),
              // ... repeated
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DBSubnetGroupName => (string)

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

    Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, or hyphens. Must not be default.

    Example: mySubnetgroup

  - DBSubnetGroupDescription => (string)

    The description for the DB subnet group.

  - SubnetIds => (array<string>)

    The EC2 Subnet IDs for the DB subnet group.

  - Tags => (array<associative-array>)

    A list of tags.

    - (associative-array)

      Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

      - Key => (string)

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

      - Value => (string)

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- DBSubnetGroup => (associative-array)

  Contains the result of a successful invocation of the following actions:

  - CreateDBSubnetGroup
  - ModifyDBSubnetGroup
  - DescribeDBSubnetGroups
  - DeleteDBSubnetGroup

  This data type is used as a response element in the DescribeDBSubnetGroups action.

  - DBSubnetGroupName => (string)

    Specifies the name of the DB subnet group.

  - DBSubnetGroupDescription => (string)

    Provides the description of the DB subnet group.

  - VpcId => (string)

    Provides the VpcId of the DB subnet group.

  - SubnetGroupStatus => (string)

    Provides the status of the DB subnet group.

  - Subnets => (array<associative-array>)

    Contains a list of Subnet elements.

    - (associative-array)

      This data type is used as a response element in the DescribeDBSubnetGroups action.

      - SubnetIdentifier => (string)

        Specifies the identifier of the subnet.

      - SubnetAvailabilityZone => (associative-array)

        Contains Availability Zone information.

        This data type is used as an element in the following data type:

        - OrderableDBInstanceOption
        - Name => (string)

          The name of the availability zone.

      - SubnetStatus => (string)

        Specifies the status of the subnet.

# `public `Guzzle\Service\Resource\Model``
`createEventSubscription( array $args = array() )`

Executes the CreateEventSubscription operation.

Creates an RDS event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.

You can specify the type of source (SourceType) you want to be notified of, provide a list of RDS sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.

If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you will be notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you will receive notice of the events for that source type for all your RDS sources. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all RDS sources belonging to your customer account.

#### Examples

- Basic formatting example

      $result = $client->createEventSubscription(array(
          // SubscriptionName is required
          'SubscriptionName' => 'string',
          // SnsTopicArn is required
          'SnsTopicArn' => 'string',
          'SourceType' => 'string',
          'EventCategories' => array('string', ... ),
          'SourceIds' => array('string', ... ),
          'Enabled' => true || false,
          'Tags' => array(
              array(
                  'Key' => 'string',
                  'Value' => 'string',
              ),
              // ... repeated
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - SubscriptionName => (string)

    The name of the subscription.

    Constraints: The name must be less than 255 characters.

  - SnsTopicArn => (string)

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

  - SourceType => (string)

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

    Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

  - EventCategories => (array<string>)

    A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.

  - SourceIds => (array<string>)

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

    Constraints:

    - If SourceIds are supplied, SourceType must also be provided.
    - If the source type is a DB instance, then a DBInstanceIdentifier must be supplied.
    - If the source type is a DB security group, a DBSecurityGroupName must be supplied.
    - If the source type is a DB parameter group, a DBParameterGroupName must be supplied.
    - If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied.
  - Enabled => (bool)

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

  - Tags => (array<associative-array>)

    A list of tags.

    - (associative-array)

      Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

      - Key => (string)

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

      - Value => (string)

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- EventSubscription => (associative-array)

  Contains the results of a successful invocation of the DescribeEventSubscriptions action.

  - CustomerAwsId => (string)

    The AWS customer account associated with the RDS event notification subscription.

  - CustSubscriptionId => (string)

    The RDS event notification subscription Id.

  - SnsTopicArn => (string)

    The topic ARN of the RDS event notification subscription.

  - Status => (string)

    The status of the RDS event notification subscription.

    Constraints:

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

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

  - SubscriptionCreationTime => (string)

    The time the RDS event notification subscription was created.

  - SourceType => (string)

    The source type for the RDS event notification subscription.

  - SourceIdsList => (array<string>)

    A list of source IDs for the RDS event notification subscription.

  - EventCategoriesList => (array<string>)

    A list of event categories for the RDS event notification subscription.

  - Enabled => (bool)

    A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

# `public `Guzzle\Service\Resource\Model``
`createOptionGroup( array $args = array() )`

Executes the CreateOptionGroup operation.

Creates a new option group. You can create up to 20 option groups.

#### Examples

- Basic formatting example

      $result = $client->createOptionGroup(array(
          // OptionGroupName is required
          'OptionGroupName' => 'string',
          // EngineName is required
          'EngineName' => 'string',
          // MajorEngineVersion is required
          'MajorEngineVersion' => 'string',
          // OptionGroupDescription is required
          'OptionGroupDescription' => 'string',
          'Tags' => array(
              array(
                  'Key' => 'string',
                  'Value' => 'string',
              ),
              // ... repeated
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - OptionGroupName => (string)

    Specifies the name of the option group to be created.

    Constraints:

    - Must be 1 to 255 alphanumeric characters or hyphens
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens

    Example: myoptiongroup

  - EngineName => (string)

    Specifies the name of the engine that this option group should be associated with.

  - MajorEngineVersion => (string)

    Specifies the major version of the engine that this option group should be associated with.

  - OptionGroupDescription => (string)

    The description of the option group.

  - Tags => (array<associative-array>)

    A list of tags.

    - (associative-array)

      Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

      - Key => (string)

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

      - Value => (string)

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- OptionGroup => (associative-array)
  - OptionGroupName => (string)

    Specifies the name of the option group.

  - OptionGroupDescription => (string)

    Provides a description of the option group.

  - EngineName => (string)

    Indicates the name of the engine that this option group can be applied to.

  - MajorEngineVersion => (string)

    Indicates the major engine version associated with this option group.

  - Options => (array<associative-array>)

    Indicates what options are available in the option group.

    - (associative-array)

      Option details.

      - OptionName => (string)

        The name of the option.

      - OptionDescription => (string)

        The description of the option.

      - Persistent => (bool)

        Indicate if this option is persistent.

      - Permanent => (bool)

        Indicate if this option is permanent.

      - Port => (int)

        If required, the port configured for this option to use.

      - OptionSettings => (array<associative-array>)

        The option settings for this option.

        - (associative-array)

          Option settings are the actual settings being applied or configured for that option. It is used when you modify an option group or describe option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting called SQLNET.ENCRYPTION_SERVER that can have several different values.

          - Name => (string)

            The name of the option that has settings that you can set.

          - Value => (string)

            The current value of the option setting.

          - DefaultValue => (string)

            The default value of the option setting.

          - Description => (string)

            The description of the option setting.

          - ApplyType => (string)

            The DB engine specific parameter type.

          - DataType => (string)

            The data type of the option setting.

          - AllowedValues => (string)

            The allowed values of the option setting.

          - IsModifiable => (bool)

            A Boolean value that, when true, indicates the option setting can be modified from the default.

          - IsCollection => (bool)

            Indicates if the option setting is part of a collection.

      - DBSecurityGroupMemberships => (array<associative-array>)

        If the option requires access to a port, then this DB security group allows access to the port.

        - (associative-array)

          This data type is used as a response element in the following actions:

          - ModifyDBInstance
          - RebootDBInstance
          - RestoreDBInstanceFromDBSnapshot
          - RestoreDBInstanceToPointInTime
          - DBSecurityGroupName => (string)

            The name of the DB security group.

          - Status => (string)

            The status of the DB security group.

      - VpcSecurityGroupMemberships => (array<associative-array>)

        If the option requires access to a port, then this VPC security group allows access to the port.

        - (associative-array)

          This data type is used as a response element for queries on VPC security group membership.

          - VpcSecurityGroupId => (string)

            The name of the VPC security group.

          - Status => (string)

            The status of the VPC security group.

  - AllowsVpcAndNonVpcInstanceMemberships => (bool)

    Indicates whether this option group can be applied to both VPC and non-VPC instances. The value true indicates the option group can be applied to both VPC and non-VPC instances.

  - VpcId => (string)

    If AllowsVpcAndNonVpcInstanceMemberships is false, this field is blank. If AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field.

# `public `Guzzle\Service\Resource\Model``
`deleteDBCluster( array $args = array() )`

Executes the DeleteDBCluster operation.

The DeleteDBCluster action deletes a previously provisioned DB cluster. A successful response from the web service indicates the request was received correctly. When you delete a DB cluster, all automated backups for that DB cluster are deleted and cannot be recovered. Manual DB cluster snapshots of the DB cluster to be deleted are not deleted.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

#### Examples

- Basic formatting example

      $result = $client->deleteDBCluster(array(
          // DBClusterIdentifier is required
          'DBClusterIdentifier' => 'string',
          'SkipFinalSnapshot' => true || false,
          'FinalDBSnapshotIdentifier' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DBClusterIdentifier => (string)

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

    Constraints:

    - Must contain from 1 to 63 alphanumeric characters or hyphens
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
  - SkipFinalSnapshot => (bool)

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

    You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is false.

    Default: false

  - FinalDBSnapshotIdentifier => (string)

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

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

    Constraints:

    - Must be 1 to 255 alphanumeric characters
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- DBCluster => (associative-array)

  Contains the result of a successful invocation of the following actions:

  - CreateDBCluster
  - DeleteDBCluster
  - FailoverDBCluster
  - ModifyDBCluster
  - RestoreDBClusterFromSnapshot

  This data type is used as a response element in the DescribeDBClusters action.

  - AllocatedStorage => (int)

    Specifies the allocated storage size in gigabytes (GB).

  - AvailabilityZones => (array<string>)

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

  - BackupRetentionPeriod => (int)

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

  - CharacterSetName => (string)

    If present, specifies the name of the character set that this cluster is associated with.

  - DatabaseName => (string)

    Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

  - DBClusterIdentifier => (string)

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

  - DBClusterParameterGroup => (string)

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

  - DBSubnetGroup => (string)

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

  - Status => (string)

    Specifies the current state of this DB cluster.

  - PercentProgress => (string)

    Specifies the progress of the operation as a percentage.

  - EarliestRestorableTime => (string)

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

  - Endpoint => (string)

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

  - Engine => (string)

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

  - EngineVersion => (string)

    Indicates the database engine version.

  - LatestRestorableTime => (string)

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

  - Port => (int)

    Specifies the port that the database engine is listening on.

  - MasterUsername => (string)

    Contains the master username for the DB cluster.

  - DBClusterOptionGroupMemberships => (array<associative-array>)

    Provides the list of option group memberships for this DB cluster.

    - (associative-array)

      Contains status information for a DB cluster option group.

      - DBClusterOptionGroupName => (string)

        Specifies the name of the DB cluster option group.

      - Status => (string)

        Specifies the status of the DB cluster option group.

  - PreferredBackupWindow => (string)

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

  - PreferredMaintenanceWindow => (string)

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

  - DBClusterMembers => (array<associative-array>)

    Provides the list of instances that make up the DB cluster.

    - (associative-array)

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

      - DBInstanceIdentifier => (string)

        Specifies the instance identifier for this member of the DB cluster.

      - IsClusterWriter => (bool)

        Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

      - DBClusterParameterGroupStatus => (string)

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

  - VpcSecurityGroups => (array<associative-array>)

    Provides a list of VPC security groups that the DB cluster belongs to.

    - (associative-array)

      This data type is used as a response element for queries on VPC security group membership.

      - VpcSecurityGroupId => (string)

        The name of the VPC security group.

      - Status => (string)

        The status of the VPC security group.

  - HostedZoneId => (string)

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

# `public `Guzzle\Service\Resource\Model``
`deleteDBClusterParameterGroup( array $args = array() )`

Executes the DeleteDBClusterParameterGroup operation.

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

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

#### Examples

- Basic formatting example

      $result = $client->deleteDBClusterParameterGroup(array(
          // DBClusterParameterGroupName is required
          'DBClusterParameterGroupName' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DBClusterParameterGroupName => (string)

    The name of the DB cluster parameter group.

    Constraints:

    - Must be the name of an existing DB cluster parameter group.
    - You cannot delete a default DB cluster parameter group.
    - Cannot be associated with any DB clusters.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

# `public `Guzzle\Service\Resource\Model``
`deleteDBClusterSnapshot( array $args = array() )`

Executes the DeleteDBClusterSnapshot operation.

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

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

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

#### Examples

- Basic formatting example

      $result = $client->deleteDBClusterSnapshot(array(
          // DBClusterSnapshotIdentifier is required
          'DBClusterSnapshotIdentifier' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DBClusterSnapshotIdentifier => (string)

    The identifier of the DB cluster snapshot to delete.

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- DBClusterSnapshot => (associative-array)

  Contains the result of a successful invocation of the following actions:

  - CreateDBClusterSnapshot
  - DeleteDBClusterSnapshot

  This data type is used as a response element in the DescribeDBClusterSnapshots action.

  - AvailabilityZones => (array<string>)

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

  - DBClusterSnapshotIdentifier => (string)

    Specifies the identifier for the DB cluster snapshot.

  - DBClusterIdentifier => (string)

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

  - SnapshotCreateTime => (string)

    Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

  - Engine => (string)

    Specifies the name of the database engine.

  - AllocatedStorage => (int)

    Specifies the allocated storage size in gigabytes (GB).

  - Status => (string)

    Specifies the status of this DB cluster snapshot.

  - Port => (int)

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

  - VpcId => (string)

    Provides the VPC ID associated with the DB cluster snapshot.

  - ClusterCreateTime => (string)

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

  - MasterUsername => (string)

    Provides the master username for the DB cluster snapshot.

  - EngineVersion => (string)

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

  - LicenseModel => (string)

    Provides the license model information for this DB cluster snapshot.

  - SnapshotType => (string)

    Provides the type of the DB cluster snapshot.

  - PercentProgress => (int)

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

# `public `Guzzle\Service\Resource\Model``
`deleteDBInstance( array $args = array() )`

Executes the DeleteDBInstance operation.

The DeleteDBInstance action deletes a previously provisioned DB instance. A successful response from the web service indicates the request was received correctly. When you delete a DB instance, all automated backups for that instance are deleted and cannot be recovered. Manual DB snapshots of the DB instance to be deleted are not deleted.

If a final DB snapshot is requested the status of the RDS instance will be "deleting" until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action cannot be canceled or reverted once submitted.

Note that when a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when the SkipFinalSnapshot parameter is set to "true".

#### Examples

- Basic formatting example

      $result = $client->deleteDBInstance(array(
          // DBInstanceIdentifier is required
          'DBInstanceIdentifier' => 'string',
          'SkipFinalSnapshot' => true || false,
          'FinalDBSnapshotIdentifier' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DBInstanceIdentifier => (string)

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

    Constraints:

    - Must contain from 1 to 63 alphanumeric characters or hyphens
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
  - SkipFinalSnapshot => (bool)

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

    Note that when a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when the SkipFinalSnapshot parameter is set to "true".

    Specify true when deleting a Read Replica.

    The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is false.

    Default: false

  - FinalDBSnapshotIdentifier => (string)

    The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to false.

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

    Constraints:

    - Must be 1 to 255 alphanumeric characters
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
    - Cannot be specified when deleting a Read Replica.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- DBInstance => (associative-array)

  Contains the result of a successful invocation of the following actions:

  - CreateDBInstance
  - DeleteDBInstance
  - ModifyDBInstance

  This data type is used as a response element in the DescribeDBInstances action.

  - DBInstanceIdentifier => (string)

    Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

  - DBInstanceClass => (string)

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

  - Engine => (string)

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

  - DBInstanceStatus => (string)

    Specifies the current state of this database.

  - MasterUsername => (string)

    Contains the master username for the DB instance.

  - DBName => (string)

    The meaning of this parameter differs according to the database engine you use. For example, this value returns either MySQL or PostgreSQL information when returning values from CreateDBInstanceReadReplica since Read Replicas are only supported for MySQL and PostgreSQL.

    MySQL, SQL Server, PostgreSQL, Amazon Aurora

    Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

    Type: String

    Oracle

    Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

  - Endpoint => (associative-array)

    Specifies the connection endpoint.

    - Address => (string)

      Specifies the DNS address of the DB instance.

    - Port => (int)

      Specifies the port that the database engine is listening on.

    - HostedZoneId => (string)

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

  - AllocatedStorage => (int)

    Specifies the allocated storage size specified in gigabytes.

  - InstanceCreateTime => (string)

    Provides the date and time the DB instance was created.

  - PreferredBackupWindow => (string)

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

  - BackupRetentionPeriod => (int)

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

  - DBSecurityGroups => (array<associative-array>)

    Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

    - (associative-array)

      This data type is used as a response element in the following actions:

      - ModifyDBInstance
      - RebootDBInstance
      - RestoreDBInstanceFromDBSnapshot
      - RestoreDBInstanceToPointInTime
      - DBSecurityGroupName => (string)

        The name of the DB security group.

      - Status => (string)

        The status of the DB security group.

  - VpcSecurityGroups => (array<associative-array>)

    Provides List of VPC security group elements that the DB instance belongs to.

    - (associative-array)

      This data type is used as a response element for queries on VPC security group membership.

      - VpcSecurityGroupId => (string)

        The name of the VPC security group.

      - Status => (string)

        The status of the VPC security group.

  - DBParameterGroups => (array<associative-array>)

    Provides the list of DB parameter groups applied to this DB instance.

    - (associative-array)

      The status of the DB parameter group.

      This data type is used as a response element in the following actions:

      - CreateDBInstance
      - CreateDBInstanceReadReplica
      - DeleteDBInstance
      - ModifyDBInstance
      - RebootDBInstance
      - RestoreDBInstanceFromDBSnapshot
      - DBParameterGroupName => (string)

        The name of the DP parameter group.

      - ParameterApplyStatus => (string)

        The status of parameter updates.

  - AvailabilityZone => (string)

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

  - DBSubnetGroup => (associative-array)

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

    - DBSubnetGroupName => (string)

      Specifies the name of the DB subnet group.

    - DBSubnetGroupDescription => (string)

      Provides the description of the DB subnet group.

    - VpcId => (string)

      Provides the VpcId of the DB subnet group.

    - SubnetGroupStatus => (string)

      Provides the status of the DB subnet group.

    - Subnets => (array<associative-array>)

      Contains a list of Subnet elements.

      - (associative-array)

        This data type is used as a response element in the DescribeDBSubnetGroups action.

        - SubnetIdentifier => (string)

          Specifies the identifier of the subnet.

        - SubnetAvailabilityZone => (associative-array)

          Contains Availability Zone information.

          This data type is used as an element in the following data type:

          - OrderableDBInstanceOption
          - Name => (string)

            The name of the availability zone.

        - SubnetStatus => (string)

          Specifies the status of the subnet.

  - PreferredMaintenanceWindow => (string)

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

  - PendingModifiedValues => (associative-array)

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

    - DBInstanceClass => (string)

      Contains the new DBInstanceClass for the DB instance that will be applied or is in progress.

    - AllocatedStorage => (int)

      Contains the new AllocatedStorage size for the DB instance that will be applied or is in progress.

    - MasterUserPassword => (string)

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

    - Port => (int)

      Specifies the pending port for the DB instance.

    - BackupRetentionPeriod => (int)

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

    - MultiAZ => (bool)

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

    - EngineVersion => (string)

      Indicates the database engine version.

    - Iops => (int)

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

    - DBInstanceIdentifier => (string)

      Contains the new DBInstanceIdentifier for the DB instance that will be applied or is in progress.

    - StorageType => (string)

      Specifies the storage type to be associated with the DB instance.

    - CACertificateIdentifier => (string)

      Specifies the identifier of the CA certificate for the DB instance.

  - LatestRestorableTime => (string)

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

  - MultiAZ => (bool)

    Specifies if the DB instance is a Multi-AZ deployment.

  - EngineVersion => (string)

    Indicates the database engine version.

  - AutoMinorVersionUpgrade => (bool)

    Indicates that minor version patches are applied automatically.

  - ReadReplicaSourceDBInstanceIdentifier => (string)

    Contains the identifier of the source DB instance if this DB instance is a Read Replica.

  - ReadReplicaDBInstanceIdentifiers => (array<string>)

    Contains one or more identifiers of the Read Replicas associated with this DB instance.

  - LicenseModel => (string)

    License model information for this DB instance.

  - Iops => (int)

    Specifies the Provisioned IOPS (I/O operations per second) value.

  - OptionGroupMemberships => (array<associative-array>)

    Provides the list of option group memberships for this DB instance.

    - (associative-array)

      Provides information on the option groups the DB instance is a member of.

      - OptionGroupName => (string)

        The name of the option group that the instance belongs to.

      - Status => (string)

        The status of the DB instance's option group membership (e.g. in-sync, pending, pending-maintenance, applying).

  - CharacterSetName => (string)

    If present, specifies the name of the character set that this instance is associated with.

  - SecondaryAvailabilityZone => (string)

    If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

  - PubliclyAccessible => (bool)

    Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

    Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

    - Default VPC:true
    - VPC:false

    If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

  - StatusInfos => (array<associative-array>)

    The status of a Read Replica. If the instance is not a Read Replica, this will be blank.

    - (associative-array)

      Provides a list of status information for a DB instance.

      - StatusType => (string)

        This value is currently "read replication."

      - Normal => (bool)

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

      - Status => (string)

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

      - Message => (string)

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

  - StorageType => (string)

    Specifies the storage type associated with DB instance.

  - TdeCredentialArn => (string)

    The ARN from the Key Store with which the instance is associated for TDE encryption.

  - DbInstancePort => (int)

    Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

  - DBClusterIdentifier => (string)

    If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

  - StorageEncrypted => (bool)

    Specifies whether the DB instance is encrypted.

  - KmsKeyId => (string)

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

  - DbiResourceId => (string)

    If StorageEncrypted is true, the region-unique, immutable identifier for the encrypted DB instance. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB instance is accessed.

  - CACertificateIdentifier => (string)

    The identifier of the CA certificate for this DB instance.

  - DomainMemberships => (array<associative-array>)

    The Active Directory Domain membership records associated with the DB instance.

    - (associative-array)

      An Active Directory Domain membership record associated with the DB instance.

      - Domain => (string)

        The identifier of the Active Directory Domain.

      - Status => (string)

        The status of the DB instance's Active Directory Domain membership (e.g. joined, pending-join, failed etc).

      - Connectivity => (string)

        The observed connectivity of the Active Directory Domain.

  - CopyTagsToSnapshot => (bool)

    Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

  - MonitoringInterval => (int)

    The interval, in seconds, between when metrics are collected for the DB instance.

# `public `Guzzle\Service\Resource\Model``
`deleteDBParameterGroup( array $args = array() )`

Executes the DeleteDBParameterGroup operation.

Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted cannot be associated with any DB instances.

#### Examples

- Basic formatting example

      $result = $client->deleteDBParameterGroup(array(
          // DBParameterGroupName is required
          'DBParameterGroupName' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DBParameterGroupName => (string)

    The name of the DB parameter group.

    Constraints:

    - Must be the name of an existing DB parameter group
    - You cannot delete a default DB parameter group
    - Cannot be associated with any DB instances

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

# `public `Guzzle\Service\Resource\Model``
`deleteDBSecurityGroup( array $args = array() )`

Executes the DeleteDBSecurityGroup operation.

Deletes a DB security group.

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

#### Examples

- Basic formatting example

      $result = $client->deleteDBSecurityGroup(array(
          // DBSecurityGroupName is required
          'DBSecurityGroupName' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DBSecurityGroupName => (string)

    The name of the DB security group to delete.

    You cannot delete the default DB security group.

    Constraints:

    - Must be 1 to 255 alphanumeric characters
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
    - Must not be "Default"
    - Cannot contain spaces

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

# `public `Guzzle\Service\Resource\Model``
`deleteDBSnapshot( array $args = array() )`

Executes the DeleteDBSnapshot operation.

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

The DBSnapshot must be in the available state to be deleted.

#### Examples

- Basic formatting example

      $result = $client->deleteDBSnapshot(array(
          // DBSnapshotIdentifier is required
          'DBSnapshotIdentifier' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DBSnapshotIdentifier => (string)

    The DBSnapshot identifier.

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- DBSnapshot => (associative-array)

  Contains the result of a successful invocation of the following actions:

  - CreateDBSnapshot
  - DeleteDBSnapshot

  This data type is used as a response element in the DescribeDBSnapshots action.

  - DBSnapshotIdentifier => (string)

    Specifies the identifier for the DB snapshot.

  - DBInstanceIdentifier => (string)

    Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

  - SnapshotCreateTime => (string)

    Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

  - Engine => (string)

    Specifies the name of the database engine.

  - AllocatedStorage => (int)

    Specifies the allocated storage size in gigabytes (GB).

  - Status => (string)

    Specifies the status of this DB snapshot.

  - Port => (int)

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

  - AvailabilityZone => (string)

    Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

  - VpcId => (string)

    Provides the VPC ID associated with the DB snapshot.

  - InstanceCreateTime => (string)

    Specifies the time when the snapshot was taken, in Universal Coordinated Time (UTC).

  - MasterUsername => (string)

    Provides the master username for the DB snapshot.

  - EngineVersion => (string)

    Specifies the version of the database engine.

  - LicenseModel => (string)

    License model information for the restored DB instance.

  - SnapshotType => (string)

    Provides the type of the DB snapshot.

  - Iops => (int)

    Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

  - OptionGroupName => (string)

    Provides the option group name for the DB snapshot.

  - PercentProgress => (int)

    The percentage of the estimated data that has been transferred.

  - SourceRegion => (string)

    The region that the DB snapshot was created in or copied from.

  - SourceDBSnapshotIdentifier => (string)

    The DB snapshot Arn that the DB snapshot was copied from. It only has value in case of cross customer or cross region copy.

  - StorageType => (string)

    Specifies the storage type associated with DB Snapshot.

  - TdeCredentialArn => (string)

    The ARN from the Key Store with which to associate the instance for TDE encryption.

  - Encrypted => (bool)

    Specifies whether the DB snapshot is encrypted.

  - KmsKeyId => (string)

    If Encrypted is true, the KMS key identifier for the encrypted DB snapshot.

# `public `Guzzle\Service\Resource\Model``
`deleteDBSubnetGroup( array $args = array() )`

Executes the DeleteDBSubnetGroup operation.

Deletes a DB subnet group.

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

#### Examples

- Basic formatting example

      $result = $client->deleteDBSubnetGroup(array(
          // DBSubnetGroupName is required
          'DBSubnetGroupName' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DBSubnetGroupName => (string)

    The name of the database subnet group to delete.

    You cannot delete the default subnet group.

    Constraints:

    - Must be 1 to 255 alphanumeric characters
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

# `public `Guzzle\Service\Resource\Model``
`deleteEventSubscription( array $args = array() )`

Executes the DeleteEventSubscription operation.

Deletes an RDS event notification subscription.

#### Examples

- Basic formatting example

      $result = $client->deleteEventSubscription(array(
          // SubscriptionName is required
          'SubscriptionName' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - SubscriptionName => (string)

    The name of the RDS event notification subscription you want to delete.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- EventSubscription => (associative-array)

  Contains the results of a successful invocation of the DescribeEventSubscriptions action.

  - CustomerAwsId => (string)

    The AWS customer account associated with the RDS event notification subscription.

  - CustSubscriptionId => (string)

    The RDS event notification subscription Id.

  - SnsTopicArn => (string)

    The topic ARN of the RDS event notification subscription.

  - Status => (string)

    The status of the RDS event notification subscription.

    Constraints:

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

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

  - SubscriptionCreationTime => (string)

    The time the RDS event notification subscription was created.

  - SourceType => (string)

    The source type for the RDS event notification subscription.

  - SourceIdsList => (array<string>)

    A list of source IDs for the RDS event notification subscription.

  - EventCategoriesList => (array<string>)

    A list of event categories for the RDS event notification subscription.

  - Enabled => (bool)

    A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

# `public `Guzzle\Service\Resource\Model``
`deleteOptionGroup( array $args = array() )`

Executes the DeleteOptionGroup operation.

Deletes an existing option group.

#### Examples

- Basic formatting example

      $result = $client->deleteOptionGroup(array(
          // OptionGroupName is required
          'OptionGroupName' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - OptionGroupName => (string)

    The name of the option group to be deleted.

    You cannot delete default option groups.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

# `public `Guzzle\Service\Resource\Model``
`describeAccountAttributes( array $args = array() )`

Executes the DescribeAccountAttributes operation.

Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.

This command does not take any parameters.

#### Examples

- Basic formatting example

      $result = $client->describeAccountAttributes(array(
      ));

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- AccountQuotas => (array<associative-array>)

  A list of AccountQuota objects. Within this list, each quota has a name, a count of usage toward the quota maximum, and a maximum value for the quota.

  - (associative-array)

    Describes a quota for an AWS account, for example, the number of DB instances allowed.

    - AccountQuotaName => (string)

      The name of the Amazon RDS quota for this AWS account.

    - Used => (int)

      The amount currently used toward the quota maximum.

    - Max => (int)

      The maximum allowed value for the quota.

# `public `Guzzle\Service\Resource\Model``
`describeCertificates( array $args = array() )`

Executes the DescribeCertificates operation.

Lists the set of CA certificates provided by Amazon RDS for this AWS account.

#### Examples

- Basic formatting example

      $result = $client->describeCertificates(array(
          'CertificateIdentifier' => 'string',
          'Filters' => array(
              array(
                  // Name is required
                  'Name' => 'string',
                  // Values is required
                  'Values' => array('string', ... ),
              ),
              // ... repeated
          ),
          'MaxRecords' => integer,
          'Marker' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - CertificateIdentifier => (string)

    The user-supplied certificate identifier. If this parameter is specified, information for only the identified certificate is returned. This parameter isn't case-sensitive.

    Constraints:

    - Must contain from 1 to 63 alphanumeric characters or hyphens
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
  - Filters => (array<associative-array>)

    This parameter is not currently supported.

    - (associative-array)
      - Name => (string)

        This parameter is not currently supported.

      - Values => (array<string>)

        This parameter is not currently supported.

  - MaxRecords => (int)

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

    Default: 100

    Constraints: Minimum 20, maximum 100.

  - Marker => (string)

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- Certificates => (array<associative-array>)

  The list of Certificate objects for the AWS account.

  - (associative-array)

    A CA certificate for an AWS account.

    - CertificateIdentifier => (string)

      The unique key that identifies a certificate.

    - CertificateType => (string)

      The type of the certificate.

    - Thumbprint => (string)

      The thumbprint of the certificate.

    - ValidFrom => (string)

      The starting date from which the certificate is valid.

    - ValidTill => (string)

      The final date that the certificate continues to be valid.

- Marker => (string)

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

# `public `Guzzle\Service\Resource\Model``
`describeDBClusterParameterGroups( array $args = array() )`

Executes the DescribeDBClusterParameterGroups operation.

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

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

#### Examples

- Basic formatting example

      $result = $client->describeDBClusterParameterGroups(array(
          'DBClusterParameterGroupName' => 'string',
          'Filters' => array(
              array(
                  // Name is required
                  'Name' => 'string',
                  // Values is required
                  'Values' => array('string', ... ),
              ),
              // ... repeated
          ),
          'MaxRecords' => integer,
          'Marker' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DBClusterParameterGroupName => (string)

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

    Constraints:

    - Must be 1 to 255 alphanumeric characters
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
  - Filters => (array<associative-array>)

    This parameter is not currently supported.

    - (associative-array)
      - Name => (string)

        This parameter is not currently supported.

      - Values => (array<string>)

        This parameter is not currently supported.

  - MaxRecords => (int)

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

    Default: 100

    Constraints: Minimum 20, maximum 100.

  - Marker => (string)

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- Marker => (string)

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

- DBClusterParameterGroups => (array<associative-array>)

  A list of DB cluster parameter groups.

  - (associative-array)

    Contains the result of a successful invocation of the CreateDBClusterParameterGroup action.

    This data type is used as a request parameter in the DeleteDBClusterParameterGroup action, and as a response element in the DescribeDBClusterParameterGroups action.

    - DBClusterParameterGroupName => (string)

      Provides the name of the DB cluster parameter group.

    - DBParameterGroupFamily => (string)

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

    - Description => (string)

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

# `public `Guzzle\Service\Resource\Model``
`describeDBClusterParameters( array $args = array() )`

Executes the DescribeDBClusterParameters operation.

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

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

#### Examples

- Basic formatting example

      $result = $client->describeDBClusterParameters(array(
          // DBClusterParameterGroupName is required
          'DBClusterParameterGroupName' => 'string',
          'Source' => 'string',
          'Filters' => array(
              array(
                  // Name is required
                  'Name' => 'string',
                  // Values is required
                  'Values' => array('string', ... ),
              ),
              // ... repeated
          ),
          'MaxRecords' => integer,
          'Marker' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DBClusterParameterGroupName => (string)

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

    Constraints:

    - Must be 1 to 255 alphanumeric characters
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
  - Source => (string)

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

  - Filters => (array<associative-array>)

    This parameter is not currently supported.

    - (associative-array)
      - Name => (string)

        This parameter is not currently supported.

      - Values => (array<string>)

        This parameter is not currently supported.

  - MaxRecords => (int)

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

    Default: 100

    Constraints: Minimum 20, maximum 100.

  - Marker => (string)

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- Parameters => (array<associative-array>)

  Provides a list of parameters for the DB cluster parameter group.

  - (associative-array)

    This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.

    This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.

    - ParameterName => (string)

      Specifies the name of the parameter.

    - ParameterValue => (string)

      Specifies the value of the parameter.

    - Description => (string)

      Provides a description of the parameter.

    - Source => (string)

      Indicates the source of the parameter value.

    - ApplyType => (string)

      Specifies the engine specific parameters type.

    - DataType => (string)

      Specifies the valid data type for the parameter.

    - AllowedValues => (string)

      Specifies the valid range of values for the parameter.

    - IsModifiable => (bool)

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

    - MinimumEngineVersion => (string)

      The earliest engine version to which the parameter can apply.

    - ApplyMethod => (string)

      Indicates when to apply parameter updates.

- Marker => (string)

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

# `public `Guzzle\Service\Resource\Model``
`describeDBClusterSnapshots( array $args = array() )`

Executes the DescribeDBClusterSnapshots operation.

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

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

#### Examples

- Basic formatting example

      $result = $client->describeDBClusterSnapshots(array(
          'DBClusterIdentifier' => 'string',
          'DBClusterSnapshotIdentifier' => 'string',
          'SnapshotType' => 'string',
          'Filters' => array(
              array(
                  // Name is required
                  'Name' => 'string',
                  // Values is required
                  'Values' => array('string', ... ),
              ),
              // ... repeated
          ),
          'MaxRecords' => integer,
          'Marker' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DBClusterIdentifier => (string)

    A DB cluster identifier to retrieve the list of DB cluster snapshots for. This parameter cannot be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter is not case-sensitive.

    Constraints:

    - Must contain from 1 to 63 alphanumeric characters or hyphens
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
  - DBClusterSnapshotIdentifier => (string)

    A specific DB cluster snapshot identifier to describe. This parameter cannot be used in conjunction with the DBClusterIdentifier parameter. This value is stored as a lowercase string.

    Constraints:

    - Must be 1 to 255 alphanumeric characters
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
    - If this is the identifier of an automated snapshot, the SnapshotType parameter must also be specified.
  - SnapshotType => (string)

    The type of DB cluster snapshots that will be returned. Values can be automated or manual. If this parameter is not specified, the returned results will include all snapshot types.

  - Filters => (array<associative-array>)

    This parameter is not currently supported.

    - (associative-array)
      - Name => (string)

        This parameter is not currently supported.

      - Values => (array<string>)

        This parameter is not currently supported.

  - MaxRecords => (int)

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

    Default: 100

    Constraints: Minimum 20, maximum 100.

  - Marker => (string)

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- Marker => (string)

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

- DBClusterSnapshots => (array<associative-array>)

  Provides a list of DB cluster snapshots for the user.

  - (associative-array)

    Contains the result of a successful invocation of the following actions:

    - CreateDBClusterSnapshot
    - DeleteDBClusterSnapshot

    This data type is used as a response element in the DescribeDBClusterSnapshots action.

    - AvailabilityZones => (array<string>)

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

    - DBClusterSnapshotIdentifier => (string)

      Specifies the identifier for the DB cluster snapshot.

    - DBClusterIdentifier => (string)

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

    - SnapshotCreateTime => (string)

      Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

    - Engine => (string)

      Specifies the name of the database engine.

    - AllocatedStorage => (int)

      Specifies the allocated storage size in gigabytes (GB).

    - Status => (string)

      Specifies the status of this DB cluster snapshot.

    - Port => (int)

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

    - VpcId => (string)

      Provides the VPC ID associated with the DB cluster snapshot.

    - ClusterCreateTime => (string)

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

    - MasterUsername => (string)

      Provides the master username for the DB cluster snapshot.

    - EngineVersion => (string)

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

    - LicenseModel => (string)

      Provides the license model information for this DB cluster snapshot.

    - SnapshotType => (string)

      Provides the type of the DB cluster snapshot.

    - PercentProgress => (int)

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

# `public `Guzzle\Service\Resource\Model``
`describeDBClusters( array $args = array() )`

Executes the DescribeDBClusters operation.

Returns information about provisioned Aurora DB clusters. This API supports pagination.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

#### Examples

- Basic formatting example

      $result = $client->describeDBClusters(array(
          'DBClusterIdentifier' => 'string',
          'Filters' => array(
              array(
                  // Name is required
                  'Name' => 'string',
                  // Values is required
                  'Values' => array('string', ... ),
              ),
              // ... repeated
          ),
          'MaxRecords' => integer,
          'Marker' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DBClusterIdentifier => (string)

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

    Constraints:

    - Must contain from 1 to 63 alphanumeric characters or hyphens
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
  - Filters => (array<associative-array>)

    This parameter is not currently supported.

    - (associative-array)
      - Name => (string)

        This parameter is not currently supported.

      - Values => (array<string>)

        This parameter is not currently supported.

  - MaxRecords => (int)

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

    Default: 100

    Constraints: Minimum 20, maximum 100.

  - Marker => (string)

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- Marker => (string)

  A pagination token that can be used in a subsequent DescribeDBClusters request.

- DBClusters => (array<associative-array>)

  Contains a list of DB clusters for the user.

  - (associative-array)

    Contains the result of a successful invocation of the following actions:

    - CreateDBCluster
    - DeleteDBCluster
    - FailoverDBCluster
    - ModifyDBCluster
    - RestoreDBClusterFromSnapshot

    This data type is used as a response element in the DescribeDBClusters action.

    - AllocatedStorage => (int)

      Specifies the allocated storage size in gigabytes (GB).

    - AvailabilityZones => (array<string>)

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

    - BackupRetentionPeriod => (int)

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

    - CharacterSetName => (string)

      If present, specifies the name of the character set that this cluster is associated with.

    - DatabaseName => (string)

      Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

    - DBClusterIdentifier => (string)

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

    - DBClusterParameterGroup => (string)

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

    - DBSubnetGroup => (string)

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

    - Status => (string)

      Specifies the current state of this DB cluster.

    - PercentProgress => (string)

      Specifies the progress of the operation as a percentage.

    - EarliestRestorableTime => (string)

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

    - Endpoint => (string)

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

    - Engine => (string)

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

    - EngineVersion => (string)

      Indicates the database engine version.

    - LatestRestorableTime => (string)

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

    - Port => (int)

      Specifies the port that the database engine is listening on.

    - MasterUsername => (string)

      Contains the master username for the DB cluster.

    - DBClusterOptionGroupMemberships => (array<associative-array>)

      Provides the list of option group memberships for this DB cluster.

      - (associative-array)

        Contains status information for a DB cluster option group.

        - DBClusterOptionGroupName => (string)

          Specifies the name of the DB cluster option group.

        - Status => (string)

          Specifies the status of the DB cluster option group.

    - PreferredBackupWindow => (string)

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

    - PreferredMaintenanceWindow => (string)

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

    - DBClusterMembers => (array<associative-array>)

      Provides the list of instances that make up the DB cluster.

      - (associative-array)

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

        - DBInstanceIdentifier => (string)

          Specifies the instance identifier for this member of the DB cluster.

        - IsClusterWriter => (bool)

          Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

        - DBClusterParameterGroupStatus => (string)

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

    - VpcSecurityGroups => (array<associative-array>)

      Provides a list of VPC security groups that the DB cluster belongs to.

      - (associative-array)

        This data type is used as a response element for queries on VPC security group membership.

        - VpcSecurityGroupId => (string)

          The name of the VPC security group.

        - Status => (string)

          The status of the VPC security group.

    - HostedZoneId => (string)

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

# `public `Guzzle\Service\Resource\Model``
`describeDBEngineVersions( array $args = array() )`

Executes the DescribeDBEngineVersions operation.

Returns a list of the available DB engines.

#### Examples

- Basic formatting example

      $result = $client->describeDBEngineVersions(array(
          'Engine' => 'string',
          'EngineVersion' => 'string',
          'DBParameterGroupFamily' => 'string',
          'Filters' => array(
              array(
                  // Name is required
                  'Name' => 'string',
                  // Values is required
                  'Values' => array('string', ... ),
              ),
              // ... repeated
          ),
          'MaxRecords' => integer,
          'Marker' => 'string',
          'DefaultOnly' => true || false,
          'ListSupportedCharacterSets' => true || false,
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Engine => (string)

    The database engine to return.

  - EngineVersion => (string)

    The database engine version to return.

    Example: 5.1.49

  - DBParameterGroupFamily => (string)

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

    Constraints:

    - Must be 1 to 255 alphanumeric characters
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
  - Filters => (array<associative-array>)

    Not currently supported.

    - (associative-array)
      - Name => (string)

        This parameter is not currently supported.

      - Values => (array<string>)

        This parameter is not currently supported.

  - MaxRecords => (int)

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

    Default: 100

    Constraints: Minimum 20, maximum 100.

  - Marker => (string)

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

  - DefaultOnly => (bool)

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

  - ListSupportedCharacterSets => (bool)

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- Marker => (string)

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

- DBEngineVersions => (array<associative-array>)

  A list of DBEngineVersion elements.

  - (associative-array)

    This data type is used as a response element in the action DescribeDBEngineVersions.

    - Engine => (string)

      The name of the database engine.

    - EngineVersion => (string)

      The version number of the database engine.

    - DBParameterGroupFamily => (string)

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

    - DBEngineDescription => (string)

      The description of the database engine.

    - DBEngineVersionDescription => (string)

      The description of the database engine version.

    - DefaultCharacterSet => (associative-array)

      The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API is not specified.

      - CharacterSetName => (string)

        The name of the character set.

      - CharacterSetDescription => (string)

        The description of the character set.

    - SupportedCharacterSets => (array<associative-array>)

      A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance API.

      - (associative-array)

        This data type is used as a response element in the action DescribeDBEngineVersions.

        - CharacterSetName => (string)

          The name of the character set.

        - CharacterSetDescription => (string)

          The description of the character set.

    - ValidUpgradeTarget => (array<associative-array>)

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

      - (associative-array)

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

        - Engine => (string)

          The name of the upgrade target database engine.

        - EngineVersion => (string)

          The version number of the upgrade target database engine.

        - Description => (string)

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

        - AutoUpgrade => (bool)

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

        - IsMajorVersionUpgrade => (bool)

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

# `public `Guzzle\Service\Resource\Model``
`describeDBInstances( array $args = array() )`

Executes the DescribeDBInstances operation.

Returns information about provisioned RDS instances. This API supports pagination.

#### Examples

- Basic formatting example

      $result = $client->describeDBInstances(array(
          'DBInstanceIdentifier' => 'string',
          'Filters' => array(
              array(
                  // Name is required
                  'Name' => 'string',
                  // Values is required
                  'Values' => array('string', ... ),
              ),
              // ... repeated
          ),
          'MaxRecords' => integer,
          'Marker' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DBInstanceIdentifier => (string)

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

    Constraints:

    - Must contain from 1 to 63 alphanumeric characters or hyphens
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
  - Filters => (array<associative-array>)

    This parameter is not currently supported.

    - (associative-array)
      - Name => (string)

        This parameter is not currently supported.

      - Values => (array<string>)

        This parameter is not currently supported.

  - MaxRecords => (int)

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

    Default: 100

    Constraints: Minimum 20, maximum 100.

  - Marker => (string)

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- Marker => (string)

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

- DBInstances => (array<associative-array>)

  A list of DBInstance instances.

  - (associative-array)

    Contains the result of a successful invocation of the following actions:

    - CreateDBInstance
    - DeleteDBInstance
    - ModifyDBInstance

    This data type is used as a response element in the DescribeDBInstances action.

    - DBInstanceIdentifier => (string)

      Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

    - DBInstanceClass => (string)

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

    - Engine => (string)

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

    - DBInstanceStatus => (string)

      Specifies the current state of this database.

    - MasterUsername => (string)

      Contains the master username for the DB instance.

    - DBName => (string)

      The meaning of this parameter differs according to the database engine you use. For example, this value returns either MySQL or PostgreSQL information when returning values from CreateDBInstanceReadReplica since Read Replicas are only supported for MySQL and PostgreSQL.

      MySQL, SQL Server, PostgreSQL, Amazon Aurora

      Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

      Type: String

      Oracle

      Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

    - Endpoint => (associative-array)

      Specifies the connection endpoint.

      - Address => (string)

        Specifies the DNS address of the DB instance.

      - Port => (int)

        Specifies the port that the database engine is listening on.

      - HostedZoneId => (string)

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

    - AllocatedStorage => (int)

      Specifies the allocated storage size specified in gigabytes.

    - InstanceCreateTime => (string)

      Provides the date and time the DB instance was created.

    - PreferredBackupWindow => (string)

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

    - BackupRetentionPeriod => (int)

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

    - DBSecurityGroups => (array<associative-array>)

      Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

      - (associative-array)

        This data type is used as a response element in the following actions:

        - ModifyDBInstance
        - RebootDBInstance
        - RestoreDBInstanceFromDBSnapshot
        - RestoreDBInstanceToPointInTime
        - DBSecurityGroupName => (string)

          The name of the DB security group.

        - Status => (string)

          The status of the DB security group.

    - VpcSecurityGroups => (array<associative-array>)

      Provides List of VPC security group elements that the DB instance belongs to.

      - (associative-array)

        This data type is used as a response element for queries on VPC security group membership.

        - VpcSecurityGroupId => (string)

          The name of the VPC security group.

        - Status => (string)

          The status of the VPC security group.

    - DBParameterGroups => (array<associative-array>)

      Provides the list of DB parameter groups applied to this DB instance.

      - (associative-array)

        The status of the DB parameter group.

        This data type is used as a response element in the following actions:

        - CreateDBInstance
        - CreateDBInstanceReadReplica
        - DeleteDBInstance
        - ModifyDBInstance
        - RebootDBInstance
        - RestoreDBInstanceFromDBSnapshot
        - DBParameterGroupName => (string)

          The name of the DP parameter group.

        - ParameterApplyStatus => (string)

          The status of parameter updates.

    - AvailabilityZone => (string)

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

    - DBSubnetGroup => (associative-array)

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

      - DBSubnetGroupName => (string)

        Specifies the name of the DB subnet group.

      - DBSubnetGroupDescription => (string)

        Provides the description of the DB subnet group.

      - VpcId => (string)

        Provides the VpcId of the DB subnet group.

      - SubnetGroupStatus => (string)

        Provides the status of the DB subnet group.

      - Subnets => (array<associative-array>)

        Contains a list of Subnet elements.

        - (associative-array)

          This data type is used as a response element in the DescribeDBSubnetGroups action.

          - SubnetIdentifier => (string)

            Specifies the identifier of the subnet.

          - SubnetAvailabilityZone => (associative-array)

            Contains Availability Zone information.

            This data type is used as an element in the following data type:

            - OrderableDBInstanceOption
            - Name => (string)

              The name of the availability zone.

          - SubnetStatus => (string)

            Specifies the status of the subnet.

    - PreferredMaintenanceWindow => (string)

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

    - PendingModifiedValues => (associative-array)

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

      - DBInstanceClass => (string)

        Contains the new DBInstanceClass for the DB instance that will be applied or is in progress.

      - AllocatedStorage => (int)

        Contains the new AllocatedStorage size for the DB instance that will be applied or is in progress.

      - MasterUserPassword => (string)

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

      - Port => (int)

        Specifies the pending port for the DB instance.

      - BackupRetentionPeriod => (int)

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

      - MultiAZ => (bool)

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

      - EngineVersion => (string)

        Indicates the database engine version.

      - Iops => (int)

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

      - DBInstanceIdentifier => (string)

        Contains the new DBInstanceIdentifier for the DB instance that will be applied or is in progress.

      - StorageType => (string)

        Specifies the storage type to be associated with the DB instance.

      - CACertificateIdentifier => (string)

        Specifies the identifier of the CA certificate for the DB instance.

    - LatestRestorableTime => (string)

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

    - MultiAZ => (bool)

      Specifies if the DB instance is a Multi-AZ deployment.

    - EngineVersion => (string)

      Indicates the database engine version.

    - AutoMinorVersionUpgrade => (bool)

      Indicates that minor version patches are applied automatically.

    - ReadReplicaSourceDBInstanceIdentifier => (string)

      Contains the identifier of the source DB instance if this DB instance is a Read Replica.

    - ReadReplicaDBInstanceIdentifiers => (array<string>)

      Contains one or more identifiers of the Read Replicas associated with this DB instance.

    - LicenseModel => (string)

      License model information for this DB instance.

    - Iops => (int)

      Specifies the Provisioned IOPS (I/O operations per second) value.

    - OptionGroupMemberships => (array<associative-array>)

      Provides the list of option group memberships for this DB instance.

      - (associative-array)

        Provides information on the option groups the DB instance is a member of.

        - OptionGroupName => (string)

          The name of the option group that the instance belongs to.

        - Status => (string)

          The status of the DB instance's option group membership (e.g. in-sync, pending, pending-maintenance, applying).

    - CharacterSetName => (string)

      If present, specifies the name of the character set that this instance is associated with.

    - SecondaryAvailabilityZone => (string)

      If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

    - PubliclyAccessible => (bool)

      Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

      Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

      - Default VPC:true
      - VPC:false

      If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

    - StatusInfos => (array<associative-array>)

      The status of a Read Replica. If the instance is not a Read Replica, this will be blank.

      - (associative-array)

        Provides a list of status information for a DB instance.

        - StatusType => (string)

          This value is currently "read replication."

        - Normal => (bool)

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

        - Status => (string)

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

        - Message => (string)

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

    - StorageType => (string)

      Specifies the storage type associated with DB instance.

    - TdeCredentialArn => (string)

      The ARN from the Key Store with which the instance is associated for TDE encryption.

    - DbInstancePort => (int)

      Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

    - DBClusterIdentifier => (string)

      If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

    - StorageEncrypted => (bool)

      Specifies whether the DB instance is encrypted.

    - KmsKeyId => (string)

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

    - DbiResourceId => (string)

      If StorageEncrypted is true, the region-unique, immutable identifier for the encrypted DB instance. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB instance is accessed.

    - CACertificateIdentifier => (string)

      The identifier of the CA certificate for this DB instance.

    - DomainMemberships => (array<associative-array>)

      The Active Directory Domain membership records associated with the DB instance.

      - (associative-array)

        An Active Directory Domain membership record associated with the DB instance.

        - Domain => (string)

          The identifier of the Active Directory Domain.

        - Status => (string)

          The status of the DB instance's Active Directory Domain membership (e.g. joined, pending-join, failed etc).

        - Connectivity => (string)

          The observed connectivity of the Active Directory Domain.

    - CopyTagsToSnapshot => (bool)

      Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

    - MonitoringInterval => (int)

      The interval, in seconds, between when metrics are collected for the DB instance.

# `public `Guzzle\Service\Resource\Model``
`describeDBLogFiles( array $args = array() )`

Executes the DescribeDBLogFiles operation.

Returns a list of DB log files for the DB instance.

#### Examples

- Basic formatting example

      $result = $client->describeDBLogFiles(array(
          // DBInstanceIdentifier is required
          'DBInstanceIdentifier' => 'string',
          'FilenameContains' => 'string',
          'FileLastWritten' => integer,
          'FileSize' => integer,
          'Filters' => array(
              array(
                  // Name is required
                  'Name' => 'string',
                  // Values is required
                  'Values' => array('string', ... ),
              ),
              // ... repeated
          ),
          'MaxRecords' => integer,
          'Marker' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DBInstanceIdentifier => (string)

    The customer-assigned name of the DB instance that contains the log files you want to list.

    Constraints:

    - Must contain from 1 to 63 alphanumeric characters or hyphens
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
  - FilenameContains => (string)

    Filters the available log files for log file names that contain the specified string.

  - FileLastWritten => (int)

    Filters the available log files for files written since the specified date, in POSIX timestamp format with milliseconds.

  - FileSize => (int)

    Filters the available log files for files larger than the specified size.

  - Filters => (array<associative-array>)

    This parameter is not currently supported.

    - (associative-array)
      - Name => (string)

        This parameter is not currently supported.

      - Values => (array<string>)

        This parameter is not currently supported.

  - MaxRecords => (int)

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

  - Marker => (string)

    The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- DescribeDBLogFiles => (array<associative-array>)

  The DB log files returned.

  - (associative-array)

    This data type is used as a response element to DescribeDBLogFiles.

    - LogFileName => (string)

      The name of the log file for the specified DB instance.

    - LastWritten => (int)

      A POSIX timestamp when the last log entry was written.

    - Size => (int)

      The size, in bytes, of the log file for the specified DB instance.

- Marker => (string)

  A pagination token that can be used in a subsequent DescribeDBLogFiles request.

# `public `Guzzle\Service\Resource\Model``
`describeDBParameterGroups( array $args = array() )`

Executes the DescribeDBParameterGroups operation.

Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.

#### Examples

- Basic formatting example

      $result = $client->describeDBParameterGroups(array(
          'DBParameterGroupName' => 'string',
          'Filters' => array(
              array(
                  // Name is required
                  'Name' => 'string',
                  // Values is required
                  'Values' => array('string', ... ),
              ),
              // ... repeated
          ),
          'MaxRecords' => integer,
          'Marker' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DBParameterGroupName => (string)

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

    Constraints:

    - Must be 1 to 255 alphanumeric characters
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
  - Filters => (array<associative-array>)

    This parameter is not currently supported.

    - (associative-array)
      - Name => (string)

        This parameter is not currently supported.

      - Values => (array<string>)

        This parameter is not currently supported.

  - MaxRecords => (int)

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

    Default: 100

    Constraints: Minimum 20, maximum 100.

  - Marker => (string)

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- Marker => (string)

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

- DBParameterGroups => (array<associative-array>)

  A list of DBParameterGroup instances.

  - (associative-array)

    Contains the result of a successful invocation of the CreateDBParameterGroup action.

    This data type is used as a request parameter in the DeleteDBParameterGroup action, and as a response element in the DescribeDBParameterGroups action.

    - DBParameterGroupName => (string)

      Provides the name of the DB parameter group.

    - DBParameterGroupFamily => (string)

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

    - Description => (string)

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

# `public `Guzzle\Service\Resource\Model``
`describeDBParameters( array $args = array() )`

Executes the DescribeDBParameters operation.

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

#### Examples

- Basic formatting example

      $result = $client->describeDBParameters(array(
          // DBParameterGroupName is required
          'DBParameterGroupName' => 'string',
          'Source' => 'string',
          'Filters' => array(
              array(
                  // Name is required
                  'Name' => 'string',
                  // Values is required
                  'Values' => array('string', ... ),
              ),
              // ... repeated
          ),
          'MaxRecords' => integer,
          'Marker' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DBParameterGroupName => (string)

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

    Constraints:

    - Must be 1 to 255 alphanumeric characters
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
  - Source => (string)

    The parameter types to return.

    Default: All parameter types returned

    Valid Values: user | system | engine-default

  - Filters => (array<associative-array>)

    This parameter is not currently supported.

    - (associative-array)
      - Name => (string)

        This parameter is not currently supported.

      - Values => (array<string>)

        This parameter is not currently supported.

  - MaxRecords => (int)

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

    Default: 100

    Constraints: Minimum 20, maximum 100.

  - Marker => (string)

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- Parameters => (array<associative-array>)

  A list of Parameter values.

  - (associative-array)

    This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.

    This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.

    - ParameterName => (string)

      Specifies the name of the parameter.

    - ParameterValue => (string)

      Specifies the value of the parameter.

    - Description => (string)

      Provides a description of the parameter.

    - Source => (string)

      Indicates the source of the parameter value.

    - ApplyType => (string)

      Specifies the engine specific parameters type.

    - DataType => (string)

      Specifies the valid data type for the parameter.

    - AllowedValues => (string)

      Specifies the valid range of values for the parameter.

    - IsModifiable => (bool)

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

    - MinimumEngineVersion => (string)

      The earliest engine version to which the parameter can apply.

    - ApplyMethod => (string)

      Indicates when to apply parameter updates.

- Marker => (string)

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

# `public `Guzzle\Service\Resource\Model``
`describeDBSecurityGroups( array $args = array() )`

Executes the DescribeDBSecurityGroups operation.

Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DB security group.

#### Examples

- Basic formatting example

      $result = $client->describeDBSecurityGroups(array(
          'DBSecurityGroupName' => 'string',
          'Filters' => array(
              array(
                  // Name is required
                  'Name' => 'string',
                  // Values is required
                  'Values' => array('string', ... ),
              ),
              // ... repeated
          ),
          'MaxRecords' => integer,
          'Marker' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DBSecurityGroupName => (string)

    The name of the DB security group to return details for.

  - Filters => (array<associative-array>)

    This parameter is not currently supported.

    - (associative-array)
      - Name => (string)

        This parameter is not currently supported.

      - Values => (array<string>)

        This parameter is not currently supported.

  - MaxRecords => (int)

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

    Default: 100

    Constraints: Minimum 20, maximum 100.

  - Marker => (string)

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- Marker => (string)

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

- DBSecurityGroups => (array<associative-array>)

  A list of DBSecurityGroup instances.

  - (associative-array)

    Contains the result of a successful invocation of the following actions:

    - DescribeDBSecurityGroups
    - AuthorizeDBSecurityGroupIngress
    - CreateDBSecurityGroup
    - RevokeDBSecurityGroupIngress

    This data type is used as a response element in the DescribeDBSecurityGroups action.

    - OwnerId => (string)

      Provides the AWS ID of the owner of a specific DB security group.

    - DBSecurityGroupName => (string)

      Specifies the name of the DB security group.

    - DBSecurityGroupDescription => (string)

      Provides the description of the DB security group.

    - VpcId => (string)

      Provides the VpcId of the DB security group.

    - EC2SecurityGroups => (array<associative-array>)

      Contains a list of EC2SecurityGroup elements.

      - (associative-array)

        This data type is used as a response element in the following actions:

        - AuthorizeDBSecurityGroupIngress
        - DescribeDBSecurityGroups
        - RevokeDBSecurityGroupIngress
        - Status => (string)

          Provides the status of the EC2 security group. Status can be "authorizing", "authorized", "revoking", and "revoked".

        - EC2SecurityGroupName => (string)

          Specifies the name of the EC2 security group.

        - EC2SecurityGroupId => (string)

          Specifies the id of the EC2 security group.

        - EC2SecurityGroupOwnerId => (string)

          Specifies the AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.

    - IPRanges => (array<associative-array>)

      Contains a list of IPRange elements.

      - (associative-array)

        This data type is used as a response element in the DescribeDBSecurityGroups action.

        - Status => (string)

          Specifies the status of the IP range. Status can be "authorizing", "authorized", "revoking", and "revoked".

        - CIDRIP => (string)

          Specifies the IP range.

# `public `Guzzle\Service\Resource\Model``
`describeDBSnapshots( array $args = array() )`

Executes the DescribeDBSnapshots operation.

Returns information about DB snapshots. This API supports pagination.

#### Examples

- Basic formatting example

      $result = $client->describeDBSnapshots(array(
          'DBInstanceIdentifier' => 'string',
          'DBSnapshotIdentifier' => 'string',
          'SnapshotType' => 'string',
          'Filters' => array(
              array(
                  // Name is required
                  'Name' => 'string',
                  // Values is required
                  'Values' => array('string', ... ),
              ),
              // ... repeated
          ),
          'MaxRecords' => integer,
          'Marker' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DBInstanceIdentifier => (string)

    A DB instance identifier to retrieve the list of DB snapshots for. This parameter cannot be used in conjunction with DBSnapshotIdentifier. This parameter is not case-sensitive.

    Constraints:

    - Must contain from 1 to 63 alphanumeric characters or hyphens
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
  - DBSnapshotIdentifier => (string)

    A specific DB snapshot identifier to describe. This parameter cannot be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string.

    Constraints:

    - Must be 1 to 255 alphanumeric characters.
    - First character must be a letter.
    - Cannot end with a hyphen or contain two consecutive hyphens.
    - If this is the identifier of an automated snapshot, the SnapshotType parameter must also be specified.
  - SnapshotType => (string)

    The type of snapshots that will be returned. Values can be "automated" or "manual." If not specified, the returned results will include all snapshots types.

  - Filters => (array<associative-array>)

    This parameter is not currently supported.

    - (associative-array)
      - Name => (string)

        This parameter is not currently supported.

      - Values => (array<string>)

        This parameter is not currently supported.

  - MaxRecords => (int)

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

    Default: 100

    Constraints: Minimum 20, maximum 100.

  - Marker => (string)

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- Marker => (string)

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

- DBSnapshots => (array<associative-array>)

  A list of DBSnapshot instances.

  - (associative-array)

    Contains the result of a successful invocation of the following actions:

    - CreateDBSnapshot
    - DeleteDBSnapshot

    This data type is used as a response element in the DescribeDBSnapshots action.

    - DBSnapshotIdentifier => (string)

      Specifies the identifier for the DB snapshot.

    - DBInstanceIdentifier => (string)

      Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

    - SnapshotCreateTime => (string)

      Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

    - Engine => (string)

      Specifies the name of the database engine.

    - AllocatedStorage => (int)

      Specifies the allocated storage size in gigabytes (GB).

    - Status => (string)

      Specifies the status of this DB snapshot.

    - Port => (int)

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

    - AvailabilityZone => (string)

      Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

    - VpcId => (string)

      Provides the VPC ID associated with the DB snapshot.

    - InstanceCreateTime => (string)

      Specifies the time when the snapshot was taken, in Universal Coordinated Time (UTC).

    - MasterUsername => (string)

      Provides the master username for the DB snapshot.

    - EngineVersion => (string)

      Specifies the version of the database engine.

    - LicenseModel => (string)

      License model information for the restored DB instance.

    - SnapshotType => (string)

      Provides the type of the DB snapshot.

    - Iops => (int)

      Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

    - OptionGroupName => (string)

      Provides the option group name for the DB snapshot.

    - PercentProgress => (int)

      The percentage of the estimated data that has been transferred.

    - SourceRegion => (string)

      The region that the DB snapshot was created in or copied from.

    - SourceDBSnapshotIdentifier => (string)

      The DB snapshot Arn that the DB snapshot was copied from. It only has value in case of cross customer or cross region copy.

    - StorageType => (string)

      Specifies the storage type associated with DB Snapshot.

    - TdeCredentialArn => (string)

      The ARN from the Key Store with which to associate the instance for TDE encryption.

    - Encrypted => (bool)

      Specifies whether the DB snapshot is encrypted.

    - KmsKeyId => (string)

      If Encrypted is true, the KMS key identifier for the encrypted DB snapshot.

# `public `Guzzle\Service\Resource\Model``
`describeDBSubnetGroups( array $args = array() )`

Executes the DescribeDBSubnetGroups operation.

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

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

#### Examples

- Basic formatting example

      $result = $client->describeDBSubnetGroups(array(
          'DBSubnetGroupName' => 'string',
          'Filters' => array(
              array(
                  // Name is required
                  'Name' => 'string',
                  // Values is required
                  'Values' => array('string', ... ),
              ),
              // ... repeated
          ),
          'MaxRecords' => integer,
          'Marker' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DBSubnetGroupName => (string)

    The name of the DB subnet group to return details for.

  - Filters => (array<associative-array>)

    This parameter is not currently supported.

    - (associative-array)
      - Name => (string)

        This parameter is not currently supported.

      - Values => (array<string>)

        This parameter is not currently supported.

  - MaxRecords => (int)

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

    Default: 100

    Constraints: Minimum 20, maximum 100.

  - Marker => (string)

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- Marker => (string)

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

- DBSubnetGroups => (array<associative-array>)

  A list of DBSubnetGroup instances.

  - (associative-array)

    Contains the result of a successful invocation of the following actions:

    - CreateDBSubnetGroup
    - ModifyDBSubnetGroup
    - DescribeDBSubnetGroups
    - DeleteDBSubnetGroup

    This data type is used as a response element in the DescribeDBSubnetGroups action.

    - DBSubnetGroupName => (string)

      Specifies the name of the DB subnet group.

    - DBSubnetGroupDescription => (string)

      Provides the description of the DB subnet group.

    - VpcId => (string)

      Provides the VpcId of the DB subnet group.

    - SubnetGroupStatus => (string)

      Provides the status of the DB subnet group.

    - Subnets => (array<associative-array>)

      Contains a list of Subnet elements.

      - (associative-array)

        This data type is used as a response element in the DescribeDBSubnetGroups action.

        - SubnetIdentifier => (string)

          Specifies the identifier of the subnet.

        - SubnetAvailabilityZone => (associative-array)

          Contains Availability Zone information.

          This data type is used as an element in the following data type:

          - OrderableDBInstanceOption
          - Name => (string)

            The name of the availability zone.

        - SubnetStatus => (string)

          Specifies the status of the subnet.

# `public `Guzzle\Service\Resource\Model``
`describeEngineDefaultClusterParameters( array $args = array() )`

Executes the DescribeEngineDefaultClusterParameters operation.

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

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

#### Examples

- Basic formatting example

      $result = $client->describeEngineDefaultClusterParameters(array(
          // DBParameterGroupFamily is required
          'DBParameterGroupFamily' => 'string',
          'Filters' => array(
              array(
                  // Name is required
                  'Name' => 'string',
                  // Values is required
                  'Values' => array('string', ... ),
              ),
              // ... repeated
          ),
          'MaxRecords' => integer,
          'Marker' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DBParameterGroupFamily => (string)

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

  - Filters => (array<associative-array>)

    This parameter is not currently supported.

    - (associative-array)
      - Name => (string)

        This parameter is not currently supported.

      - Values => (array<string>)

        This parameter is not currently supported.

  - MaxRecords => (int)

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

    Default: 100

    Constraints: Minimum 20, maximum 100.

  - Marker => (string)

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- EngineDefaults => (associative-array)

  Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.

  - DBParameterGroupFamily => (string)

    Specifies the name of the DB parameter group family that the engine default parameters apply to.

  - Marker => (string)

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

  - Parameters => (array<associative-array>)

    Contains a list of engine default parameters.

    - (associative-array)

      This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.

      This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.

      - ParameterName => (string)

        Specifies the name of the parameter.

      - ParameterValue => (string)

        Specifies the value of the parameter.

      - Description => (string)

        Provides a description of the parameter.

      - Source => (string)

        Indicates the source of the parameter value.

      - ApplyType => (string)

        Specifies the engine specific parameters type.

      - DataType => (string)

        Specifies the valid data type for the parameter.

      - AllowedValues => (string)

        Specifies the valid range of values for the parameter.

      - IsModifiable => (bool)

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

      - MinimumEngineVersion => (string)

        The earliest engine version to which the parameter can apply.

      - ApplyMethod => (string)

        Indicates when to apply parameter updates.

# `public `Guzzle\Service\Resource\Model``
`describeEngineDefaultParameters( array $args = array() )`

Executes the DescribeEngineDefaultParameters operation.

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

#### Examples

- Basic formatting example

      $result = $client->describeEngineDefaultParameters(array(
          // DBParameterGroupFamily is required
          'DBParameterGroupFamily' => 'string',
          'Filters' => array(
              array(
                  // Name is required
                  'Name' => 'string',
                  // Values is required
                  'Values' => array('string', ... ),
              ),
              // ... repeated
          ),
          'MaxRecords' => integer,
          'Marker' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DBParameterGroupFamily => (string)

    The name of the DB parameter group family.

  - Filters => (array<associative-array>)

    Not currently supported.

    - (associative-array)
      - Name => (string)

        This parameter is not currently supported.

      - Values => (array<string>)

        This parameter is not currently supported.

  - MaxRecords => (int)

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

    Default: 100

    Constraints: Minimum 20, maximum 100.

  - Marker => (string)

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- EngineDefaults => (associative-array)

  Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.

  - DBParameterGroupFamily => (string)

    Specifies the name of the DB parameter group family that the engine default parameters apply to.

  - Marker => (string)

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

  - Parameters => (array<associative-array>)

    Contains a list of engine default parameters.

    - (associative-array)

      This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.

      This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.

      - ParameterName => (string)

        Specifies the name of the parameter.

      - ParameterValue => (string)

        Specifies the value of the parameter.

      - Description => (string)

        Provides a description of the parameter.

      - Source => (string)

        Indicates the source of the parameter value.

      - ApplyType => (string)

        Specifies the engine specific parameters type.

      - DataType => (string)

        Specifies the valid data type for the parameter.

      - AllowedValues => (string)

        Specifies the valid range of values for the parameter.

      - IsModifiable => (bool)

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

      - MinimumEngineVersion => (string)

        The earliest engine version to which the parameter can apply.

      - ApplyMethod => (string)

        Indicates when to apply parameter updates.

# `public `Guzzle\Service\Resource\Model``
`describeEventCategories( array $args = array() )`

Executes the DescribeEventCategories operation.

Displays a list of categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in the Events topic in the Amazon RDS User Guide.

#### Examples

- Basic formatting example

      $result = $client->describeEventCategories(array(
          'SourceType' => 'string',
          'Filters' => array(
              array(
                  // Name is required
                  'Name' => 'string',
                  // Values is required
                  'Values' => array('string', ... ),
              ),
              // ... repeated
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - SourceType => (string)

    The type of source that will be generating the events.

    Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

  - Filters => (array<associative-array>)

    This parameter is not currently supported.

    - (associative-array)
      - Name => (string)

        This parameter is not currently supported.

      - Values => (array<string>)

        This parameter is not currently supported.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- EventCategoriesMapList => (array<associative-array>)

  A list of EventCategoriesMap data types.

  - (associative-array)

    Contains the results of a successful invocation of the DescribeEventCategories action.

    - SourceType => (string)

      The source type that the returned categories belong to

    - EventCategories => (array<string>)

      The event categories for the specified source type

# `public `Guzzle\Service\Resource\Model``
`describeEventSubscriptions( array $args = array() )`

Executes the DescribeEventSubscriptions operation.

Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

If you specify a SubscriptionName, lists the description for that subscription.

#### Examples

- Basic formatting example

      $result = $client->describeEventSubscriptions(array(
          'SubscriptionName' => 'string',
          'Filters' => array(
              array(
                  // Name is required
                  'Name' => 'string',
                  // Values is required
                  'Values' => array('string', ... ),
              ),
              // ... repeated
          ),
          'MaxRecords' => integer,
          'Marker' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - SubscriptionName => (string)

    The name of the RDS event notification subscription you want to describe.

  - Filters => (array<associative-array>)

    This parameter is not currently supported.

    - (associative-array)
      - Name => (string)

        This parameter is not currently supported.

      - Values => (array<string>)

        This parameter is not currently supported.

  - MaxRecords => (int)

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

    Default: 100

    Constraints: Minimum 20, maximum 100.

  - Marker => (string)

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- Marker => (string)

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

- EventSubscriptionsList => (array<associative-array>)

  A list of EventSubscriptions data types.

  - (associative-array)

    Contains the results of a successful invocation of the DescribeEventSubscriptions action.

    - CustomerAwsId => (string)

      The AWS customer account associated with the RDS event notification subscription.

    - CustSubscriptionId => (string)

      The RDS event notification subscription Id.

    - SnsTopicArn => (string)

      The topic ARN of the RDS event notification subscription.

    - Status => (string)

      The status of the RDS event notification subscription.

      Constraints:

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

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

    - SubscriptionCreationTime => (string)

      The time the RDS event notification subscription was created.

    - SourceType => (string)

      The source type for the RDS event notification subscription.

    - SourceIdsList => (array<string>)

      A list of source IDs for the RDS event notification subscription.

    - EventCategoriesList => (array<string>)

      A list of event categories for the RDS event notification subscription.

    - Enabled => (bool)

      A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

# `public `Guzzle\Service\Resource\Model``
`describeEvents( array $args = array() )`

Executes the DescribeEvents operation.

Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.

#### Examples

- Basic formatting example

      $result = $client->describeEvents(array(
          'SourceIdentifier' => 'string',
          'SourceType' => 'string',
          'StartTime' => 'mixed type: string (date format)|int (unix timestamp)|\DateTime',
          'EndTime' => 'mixed type: string (date format)|int (unix timestamp)|\DateTime',
          'Duration' => integer,
          'EventCategories' => array('string', ... ),
          'Filters' => array(
              array(
                  // Name is required
                  'Name' => 'string',
                  // Values is required
                  'Values' => array('string', ... ),
              ),
              // ... repeated
          ),
          'MaxRecords' => integer,
          'Marker' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - SourceIdentifier => (string)

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

    Constraints:

    - If SourceIdentifier is supplied, SourceType must also be provided.
    - If the source type is DBInstance, then a DBInstanceIdentifier must be supplied.
    - If the source type is DBSecurityGroup, a DBSecurityGroupName must be supplied.
    - If the source type is DBParameterGroup, a DBParameterGroupName must be supplied.
    - If the source type is DBSnapshot, a DBSnapshotIdentifier must be supplied.
    - Cannot end with a hyphen or contain two consecutive hyphens.
  - SourceType => (string)

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

  - StartTime => (string [date format]|int [unix timestamp]|\DateTime)

    The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

    Example: 2009-07-08T18:00Z

  - EndTime => (string [date format]|int [unix timestamp]|\DateTime)

    The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

    Example: 2009-07-08T18:00Z

  - Duration => (int)

    The number of minutes to retrieve events for.

    Default: 60

  - EventCategories => (array<string>)

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

  - Filters => (array<associative-array>)

    This parameter is not currently supported.

    - (associative-array)
      - Name => (string)

        This parameter is not currently supported.

      - Values => (array<string>)

        This parameter is not currently supported.

  - MaxRecords => (int)

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

    Default: 100

    Constraints: Minimum 20, maximum 100.

  - Marker => (string)

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- Marker => (string)

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

- Events => (array<associative-array>)

  A list of Event instances.

  - (associative-array)

    This data type is used as a response element in the DescribeEvents action.

    - SourceIdentifier => (string)

      Provides the identifier for the source of the event.

    - SourceType => (string)

      Specifies the source type for this event.

    - Message => (string)

      Provides the text of this event.

    - EventCategories => (array<string>)

      Specifies the category for the event.

    - Date => (string)

      Specifies the date and time of the event.

# `public `Guzzle\Service\Resource\Model``
`describeOptionGroupOptions( array $args = array() )`

Executes the DescribeOptionGroupOptions operation.

Describes all available options.

#### Examples

- Basic formatting example

      $result = $client->describeOptionGroupOptions(array(
          // EngineName is required
          'EngineName' => 'string',
          'MajorEngineVersion' => 'string',
          'Filters' => array(
              array(
                  // Name is required
                  'Name' => 'string',
                  // Values is required
                  'Values' => array('string', ... ),
              ),
              // ... repeated
          ),
          'MaxRecords' => integer,
          'Marker' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - EngineName => (string)

    A required parameter. Options available for the given engine name will be described.

  - MajorEngineVersion => (string)

    If specified, filters the results to include only options for the specified major engine version.

  - Filters => (array<associative-array>)

    This parameter is not currently supported.

    - (associative-array)
      - Name => (string)

        This parameter is not currently supported.

      - Values => (array<string>)

        This parameter is not currently supported.

  - MaxRecords => (int)

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

    Default: 100

    Constraints: Minimum 20, maximum 100.

  - Marker => (string)

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- OptionGroupOptions => (array<associative-array>)

  List of available option group options.

  - (associative-array)

    Available option.

    - Name => (string)

      The name of the option.

    - Description => (string)

      The description of the option.

    - EngineName => (string)

      The name of the engine that this option can be applied to.

    - MajorEngineVersion => (string)

      Indicates the major engine version that the option is available for.

    - MinimumRequiredMinorEngineVersion => (string)

      The minimum required engine version for the option to be applied.

    - PortRequired => (bool)

      Specifies whether the option requires a port.

    - DefaultPort => (int)

      If the option requires a port, specifies the default port for the option.

    - OptionsDependedOn => (array<string>)

      List of all options that are prerequisites for this option.

    - Persistent => (bool)

      A persistent option cannot be removed from the option group once the option group is used, but this option can be removed from the db instance while modifying the related data and assigning another option group without this option.

    - Permanent => (bool)

      A permanent option cannot be removed from the option group once the option group is used, and it cannot be removed from the db instance after assigning an option group with this permanent option.

    - OptionGroupOptionSettings => (array<associative-array>)

      Specifies the option settings that are available (and the default value) for each option in an option group.

      - (associative-array)

        Option group option settings are used to display settings available for each option with their default values and other information. These values are used with the DescribeOptionGroupOptions action.

        - SettingName => (string)

          The name of the option group option.

        - SettingDescription => (string)

          The description of the option group option.

        - DefaultValue => (string)

          The default value for the option group option.

        - ApplyType => (string)

          The DB engine specific parameter type for the option group option.

        - AllowedValues => (string)

          Indicates the acceptable values for the option group option.

        - IsModifiable => (bool)

          Boolean value where true indicates that this option group option can be changed from the default value.

- Marker => (string)

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

# `public `Guzzle\Service\Resource\Model``
`describeOptionGroups( array $args = array() )`

Executes the DescribeOptionGroups operation.

Describes the available option groups.

#### Examples

- Basic formatting example

      $result = $client->describeOptionGroups(array(
          'OptionGroupName' => 'string',
          'Filters' => array(
              array(
                  // Name is required
                  'Name' => 'string',
                  // Values is required
                  'Values' => array('string', ... ),
              ),
              // ... repeated
          ),
          'Marker' => 'string',
          'MaxRecords' => integer,
          'EngineName' => 'string',
          'MajorEngineVersion' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - OptionGroupName => (string)

    The name of the option group to describe. Cannot be supplied together with EngineName or MajorEngineVersion.

  - Filters => (array<associative-array>)

    This parameter is not currently supported.

    - (associative-array)
      - Name => (string)

        This parameter is not currently supported.

      - Values => (array<string>)

        This parameter is not currently supported.

  - Marker => (string)

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

  - MaxRecords => (int)

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

    Default: 100

    Constraints: Minimum 20, maximum 100.

  - EngineName => (string)

    Filters the list of option groups to only include groups associated with a specific database engine.

  - MajorEngineVersion => (string)

    Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- OptionGroupsList => (array<associative-array>)

  List of option groups.

  - (associative-array)
    - OptionGroupName => (string)

      Specifies the name of the option group.

    - OptionGroupDescription => (string)

      Provides a description of the option group.

    - EngineName => (string)

      Indicates the name of the engine that this option group can be applied to.

    - MajorEngineVersion => (string)

      Indicates the major engine version associated with this option group.

    - Options => (array<associative-array>)

      Indicates what options are available in the option group.

      - (associative-array)

        Option details.

        - OptionName => (string)

          The name of the option.

        - OptionDescription => (string)

          The description of the option.

        - Persistent => (bool)

          Indicate if this option is persistent.

        - Permanent => (bool)

          Indicate if this option is permanent.

        - Port => (int)

          If required, the port configured for this option to use.

        - OptionSettings => (array<associative-array>)

          The option settings for this option.

          - (associative-array)

            Option settings are the actual settings being applied or configured for that option. It is used when you modify an option group or describe option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting called SQLNET.ENCRYPTION_SERVER that can have several different values.

            - Name => (string)

              The name of the option that has settings that you can set.

            - Value => (string)

              The current value of the option setting.

            - DefaultValue => (string)

              The default value of the option setting.

            - Description => (string)

              The description of the option setting.

            - ApplyType => (string)

              The DB engine specific parameter type.

            - DataType => (string)

              The data type of the option setting.

            - AllowedValues => (string)

              The allowed values of the option setting.

            - IsModifiable => (bool)

              A Boolean value that, when true, indicates the option setting can be modified from the default.

            - IsCollection => (bool)

              Indicates if the option setting is part of a collection.

        - DBSecurityGroupMemberships => (array<associative-array>)

          If the option requires access to a port, then this DB security group allows access to the port.

          - (associative-array)

            This data type is used as a response element in the following actions:

            - ModifyDBInstance
            - RebootDBInstance
            - RestoreDBInstanceFromDBSnapshot
            - RestoreDBInstanceToPointInTime
            - DBSecurityGroupName => (string)

              The name of the DB security group.

            - Status => (string)

              The status of the DB security group.

        - VpcSecurityGroupMemberships => (array<associative-array>)

          If the option requires access to a port, then this VPC security group allows access to the port.

          - (associative-array)

            This data type is used as a response element for queries on VPC security group membership.

            - VpcSecurityGroupId => (string)

              The name of the VPC security group.

            - Status => (string)

              The status of the VPC security group.

    - AllowsVpcAndNonVpcInstanceMemberships => (bool)

      Indicates whether this option group can be applied to both VPC and non-VPC instances. The value true indicates the option group can be applied to both VPC and non-VPC instances.

    - VpcId => (string)

      If AllowsVpcAndNonVpcInstanceMemberships is false, this field is blank. If AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field.

- Marker => (string)

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

# `public `Guzzle\Service\Resource\Model``
`describeOrderableDBInstanceOptions( array $args = array() )`

Executes the DescribeOrderableDBInstanceOptions operation.

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

#### Examples

- Basic formatting example

      $result = $client->describeOrderableDBInstanceOptions(array(
          // Engine is required
          'Engine' => 'string',
          'EngineVersion' => 'string',
          'DBInstanceClass' => 'string',
          'LicenseModel' => 'string',
          'Vpc' => true || false,
          'Filters' => array(
              array(
                  // Name is required
                  'Name' => 'string',
                  // Values is required
                  'Values' => array('string', ... ),
              ),
              // ... repeated
          ),
          'MaxRecords' => integer,
          'Marker' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Engine => (string)

    The name of the engine to retrieve DB instance options for.

  - EngineVersion => (string)

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

  - DBInstanceClass => (string)

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

  - LicenseModel => (string)

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

  - Vpc => (bool)

    The VPC filter value. Specify this parameter to show only the available VPC or non-VPC offerings.

  - Filters => (array<associative-array>)

    This parameter is not currently supported.

    - (associative-array)
      - Name => (string)

        This parameter is not currently supported.

      - Values => (array<string>)

        This parameter is not currently supported.

  - MaxRecords => (int)

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

    Default: 100

    Constraints: Minimum 20, maximum 100.

  - Marker => (string)

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- OrderableDBInstanceOptions => (array<associative-array>)

  An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.

  - (associative-array)

    Contains a list of available options for a DB instance

    This data type is used as a response element in the DescribeOrderableDBInstanceOptions action.

    - Engine => (string)

      The engine type of the orderable DB instance.

    - EngineVersion => (string)

      The engine version of the orderable DB instance.

    - DBInstanceClass => (string)

      The DB instance class for the orderable DB instance.

    - LicenseModel => (string)

      The license model for the orderable DB instance.

    - AvailabilityZones => (array<associative-array>)

      A list of Availability Zones for the orderable DB instance.

      - (associative-array)

        Contains Availability Zone information.

        This data type is used as an element in the following data type:

        - OrderableDBInstanceOption
        - Name => (string)

          The name of the availability zone.

    - MultiAZCapable => (bool)

      Indicates whether this orderable DB instance is multi-AZ capable.

    - ReadReplicaCapable => (bool)

      Indicates whether this orderable DB instance can have a Read Replica.

    - Vpc => (bool)

      Indicates whether this is a VPC orderable DB instance.

    - SupportsStorageEncryption => (bool)

      Indicates whether this orderable DB instance supports encrypted storage.

    - StorageType => (string)

      Indicates the storage type for this orderable DB instance.

    - SupportsIops => (bool)

      Indicates whether this orderable DB instance supports provisioned IOPS.

    - SupportsEnhancedMonitoring => (bool)

      Indicates whether the DB instance supports enhanced monitoring at intervals from 1 to 60 seconds.

- Marker => (string)

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

# `public `Guzzle\Service\Resource\Model``
`describePendingMaintenanceActions( array $args = array() )`

Executes the DescribePendingMaintenanceActions operation.

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

#### Examples

- Basic formatting example

      $result = $client->describePendingMaintenanceActions(array(
          'ResourceIdentifier' => 'string',
          'Filters' => array(
              array(
                  // Name is required
                  'Name' => 'string',
                  // Values is required
                  'Values' => array('string', ... ),
              ),
              // ... repeated
          ),
          'Marker' => 'string',
          'MaxRecords' => integer,
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - ResourceIdentifier => (string)

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

  - Filters => (array<associative-array>)

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

    Supported filters:

    - db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list will only include pending maintenance actions for the DB instances identified by these ARNs.
    - (associative-array)
      - Name => (string)

        This parameter is not currently supported.

      - Values => (array<string>)

        This parameter is not currently supported.

  - Marker => (string)

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

  - MaxRecords => (int)

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

    Default: 100

    Constraints: Minimum 20, maximum 100.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- PendingMaintenanceActions => (array<associative-array>)

  A list of the pending maintenance actions for the resource.

  - (associative-array)

    Describes the pending maintenance actions for a resource.

    - ResourceIdentifier => (string)

      The ARN of the resource that has pending maintenance actions.

    - PendingMaintenanceActionDetails => (array<associative-array>)

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

      - (associative-array)

        Provides information about a pending maintenance action for a resource.

        - Action => (string)

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

        - AutoAppliedAfterDate => (string)

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

        - ForcedApplyDate => (string)

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

        - OptInStatus => (string)

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

        - CurrentApplyDate => (string)

          The effective date when the pending maintenance action will be applied to the resource. This date takes into account opt-in requests received from the ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate, and the ForcedApplyDate. This value is blank if an opt-in request has not been received and nothing has been specified as AutoAppliedAfterDate or ForcedApplyDate.

        - Description => (string)

          A description providing more detail about the maintenance action.

- Marker => (string)

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

# `public `Guzzle\Service\Resource\Model``
`describeReservedDBInstances( array $args = array() )`

Executes the DescribeReservedDBInstances operation.

Returns information about reserved DB instances for this account, or about a specified reserved DB instance.

#### Examples

- Basic formatting example

      $result = $client->describeReservedDBInstances(array(
          'ReservedDBInstanceId' => 'string',
          'ReservedDBInstancesOfferingId' => 'string',
          'DBInstanceClass' => 'string',
          'Duration' => 'string',
          'ProductDescription' => 'string',
          'OfferingType' => 'string',
          'MultiAZ' => true || false,
          'Filters' => array(
              array(
                  // Name is required
                  'Name' => 'string',
                  // Values is required
                  'Values' => array('string', ... ),
              ),
              // ... repeated
          ),
          'MaxRecords' => integer,
          'Marker' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - ReservedDBInstanceId => (string)

    The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.

  - ReservedDBInstancesOfferingId => (string)

    The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.

  - DBInstanceClass => (string)

    The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.

  - Duration => (string)

    The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

    Valid Values: 1 | 3 | 31536000 | 94608000

  - ProductDescription => (string)

    The product description filter value. Specify this parameter to show only those reservations matching the specified product description.

  - OfferingType => (string)

    The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

    Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"

  - MultiAZ => (bool)

    The Multi-AZ filter value. Specify this parameter to show only those reservations matching the specified Multi-AZ parameter.

  - Filters => (array<associative-array>)

    This parameter is not currently supported.

    - (associative-array)
      - Name => (string)

        This parameter is not currently supported.

      - Values => (array<string>)

        This parameter is not currently supported.

  - MaxRecords => (int)

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

    Default: 100

    Constraints: Minimum 20, maximum 100.

  - Marker => (string)

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- Marker => (string)

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

- ReservedDBInstances => (array<associative-array>)

  A list of reserved DB instances.

  - (associative-array)

    This data type is used as a response element in the DescribeReservedDBInstances and PurchaseReservedDBInstancesOffering actions.

    - ReservedDBInstanceId => (string)

      The unique identifier for the reservation.

    - ReservedDBInstancesOfferingId => (string)

      The offering identifier.

    - DBInstanceClass => (string)

      The DB instance class for the reserved DB instance.

    - StartTime => (string)

      The time the reservation started.

    - Duration => (int)

      The duration of the reservation in seconds.

    - FixedPrice => (int)

      The fixed price charged for this reserved DB instance.

    - UsagePrice => (int)

      The hourly price charged for this reserved DB instance.

    - CurrencyCode => (string)

      The currency code for the reserved DB instance.

    - DBInstanceCount => (int)

      The number of reserved DB instances.

    - ProductDescription => (string)

      The description of the reserved DB instance.

    - OfferingType => (string)

      The offering type of this reserved DB instance.

    - MultiAZ => (bool)

      Indicates if the reservation applies to Multi-AZ deployments.

    - State => (string)

      The state of the reserved DB instance.

    - RecurringCharges => (array<associative-array>)

      The recurring price charged to run this reserved DB instance.

      - (associative-array)

        This data type is used as a response element in the DescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions.

        - RecurringChargeAmount => (int)

          The amount of the recurring charge.

        - RecurringChargeFrequency => (string)

          The frequency of the recurring charge.

# `public `Guzzle\Service\Resource\Model``
`describeReservedDBInstancesOfferings( array $args = array() )`

Executes the DescribeReservedDBInstancesOfferings operation.

Lists available reserved DB instance offerings.

#### Examples

- Basic formatting example

      $result = $client->describeReservedDBInstancesOfferings(array(
          'ReservedDBInstancesOfferingId' => 'string',
          'DBInstanceClass' => 'string',
          'Duration' => 'string',
          'ProductDescription' => 'string',
          'OfferingType' => 'string',
          'MultiAZ' => true || false,
          'Filters' => array(
              array(
                  // Name is required
                  'Name' => 'string',
                  // Values is required
                  'Values' => array('string', ... ),
              ),
              // ... repeated
          ),
          'MaxRecords' => integer,
          'Marker' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - ReservedDBInstancesOfferingId => (string)

    The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier.

    Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

  - DBInstanceClass => (string)

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

  - Duration => (string)

    Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

    Valid Values: 1 | 3 | 31536000 | 94608000

  - ProductDescription => (string)

    Product description filter value. Specify this parameter to show only the available offerings matching the specified product description.

  - OfferingType => (string)

    The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

    Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"

  - MultiAZ => (bool)

    The Multi-AZ filter value. Specify this parameter to show only the available offerings matching the specified Multi-AZ parameter.

  - Filters => (array<associative-array>)

    This parameter is not currently supported.

    - (associative-array)
      - Name => (string)

        This parameter is not currently supported.

      - Values => (array<string>)

        This parameter is not currently supported.

  - MaxRecords => (int)

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

    Default: 100

    Constraints: Minimum 20, maximum 100.

  - Marker => (string)

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- Marker => (string)

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

- ReservedDBInstancesOfferings => (array<associative-array>)

  A list of reserved DB instance offerings.

  - (associative-array)

    This data type is used as a response element in the DescribeReservedDBInstancesOfferings action.

    - ReservedDBInstancesOfferingId => (string)

      The offering identifier.

    - DBInstanceClass => (string)

      The DB instance class for the reserved DB instance.

    - Duration => (int)

      The duration of the offering in seconds.

    - FixedPrice => (int)

      The fixed price charged for this offering.

    - UsagePrice => (int)

      The hourly price charged for this offering.

    - CurrencyCode => (string)

      The currency code for the reserved DB instance offering.

    - ProductDescription => (string)

      The database engine used by the offering.

    - OfferingType => (string)

      The offering type.

    - MultiAZ => (bool)

      Indicates if the offering applies to Multi-AZ deployments.

    - RecurringCharges => (array<associative-array>)

      The recurring price charged to run this reserved DB instance.

      - (associative-array)

        This data type is used as a response element in the DescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions.

        - RecurringChargeAmount => (int)

          The amount of the recurring charge.

        - RecurringChargeFrequency => (string)

          The frequency of the recurring charge.

# `public `Guzzle\Service\Resource\Model``
`downloadDBLogFilePortion( array $args = array() )`

Executes the DownloadDBLogFilePortion operation.

Downloads all or a portion of the specified log file, up to 1 MB in size.

#### Examples

- Basic formatting example

      $result = $client->downloadDBLogFilePortion(array(
          // DBInstanceIdentifier is required
          'DBInstanceIdentifier' => 'string',
          // LogFileName is required
          'LogFileName' => 'string',
          'Marker' => 'string',
          'NumberOfLines' => integer,
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DBInstanceIdentifier => (string)

    The customer-assigned name of the DB instance that contains the log files you want to list.

    Constraints:

    - Must contain from 1 to 63 alphanumeric characters or hyphens
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
  - LogFileName => (string)

    The name of the log file to be downloaded.

  - Marker => (string)

    The pagination token provided in the previous request or "0". If the Marker parameter is specified the response includes only records beyond the marker until the end of the file or up to NumberOfLines.

  - NumberOfLines => (int)

    The number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file will be truncated at 1 MB in size.

    If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning or the end of the log file, depending on the value of the Marker parameter.

    - If neither Marker or NumberOfLines are specified, the entire log file is returned.

    - If NumberOfLines is specified and Marker is not specified, then the most recent lines from the end of the log file are returned.

    - If Marker is specified as "0", then the specified number of lines from the beginning of the log file are returned.

    - You can download the log file in blocks of lines by specifying the size of the block using the NumberOfLines parameter, and by specifying a value of "0" for the Marker parameter in your first request. Include the Marker value returned in the response as the Marker value for the next request, continuing until the AdditionalDataPending response element returns false.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- LogFileData => (string)

  Entries from the specified log file.

- Marker => (string)

  A pagination token that can be used in a subsequent DownloadDBLogFilePortion request.

- AdditionalDataPending => (bool)

  Boolean value that if true, indicates there is more data to be downloaded.

# `public `Guzzle\Service\Resource\Model``
`failoverDBCluster( array $args = array() )`

Executes the FailoverDBCluster operation.

Forces a failover for a DB cluster.

A failover for a DB cluster promotes one of the read-only instances in the DB cluster to the master DB instance (the cluster writer) and deletes the current primary instance.

Amazon Aurora will automatically fail over to a read-only instance, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a DB instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

#### Examples

- Basic formatting example

      $result = $client->failoverDBCluster(array(
          'DBClusterIdentifier' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DBClusterIdentifier => (string)

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

    Constraints:

    - Must contain from 1 to 63 alphanumeric characters or hyphens
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- DBCluster => (associative-array)

  Contains the result of a successful invocation of the following actions:

  - CreateDBCluster
  - DeleteDBCluster
  - FailoverDBCluster
  - ModifyDBCluster
  - RestoreDBClusterFromSnapshot

  This data type is used as a response element in the DescribeDBClusters action.

  - AllocatedStorage => (int)

    Specifies the allocated storage size in gigabytes (GB).

  - AvailabilityZones => (array<string>)

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

  - BackupRetentionPeriod => (int)

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

  - CharacterSetName => (string)

    If present, specifies the name of the character set that this cluster is associated with.

  - DatabaseName => (string)

    Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

  - DBClusterIdentifier => (string)

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

  - DBClusterParameterGroup => (string)

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

  - DBSubnetGroup => (string)

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

  - Status => (string)

    Specifies the current state of this DB cluster.

  - PercentProgress => (string)

    Specifies the progress of the operation as a percentage.

  - EarliestRestorableTime => (string)

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

  - Endpoint => (string)

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

  - Engine => (string)

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

  - EngineVersion => (string)

    Indicates the database engine version.

  - LatestRestorableTime => (string)

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

  - Port => (int)

    Specifies the port that the database engine is listening on.

  - MasterUsername => (string)

    Contains the master username for the DB cluster.

  - DBClusterOptionGroupMemberships => (array<associative-array>)

    Provides the list of option group memberships for this DB cluster.

    - (associative-array)

      Contains status information for a DB cluster option group.

      - DBClusterOptionGroupName => (string)

        Specifies the name of the DB cluster option group.

      - Status => (string)

        Specifies the status of the DB cluster option group.

  - PreferredBackupWindow => (string)

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

  - PreferredMaintenanceWindow => (string)

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

  - DBClusterMembers => (array<associative-array>)

    Provides the list of instances that make up the DB cluster.

    - (associative-array)

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

      - DBInstanceIdentifier => (string)

        Specifies the instance identifier for this member of the DB cluster.

      - IsClusterWriter => (bool)

        Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

      - DBClusterParameterGroupStatus => (string)

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

  - VpcSecurityGroups => (array<associative-array>)

    Provides a list of VPC security groups that the DB cluster belongs to.

    - (associative-array)

      This data type is used as a response element for queries on VPC security group membership.

      - VpcSecurityGroupId => (string)

        The name of the VPC security group.

      - Status => (string)

        The status of the VPC security group.

  - HostedZoneId => (string)

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

# `public `Guzzle\Service\Resource\Model``
`listTagsForResource( array $args = array() )`

Executes the ListTagsForResource operation.

Lists all tags on an Amazon RDS resource.

For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources.

#### Examples

- Basic formatting example

      $result = $client->listTagsForResource(array(
          // ResourceName is required
          'ResourceName' => 'string',
          'Filters' => array(
              array(
                  // Name is required
                  'Name' => 'string',
                  // Values is required
                  'Values' => array('string', ... ),
              ),
              // ... repeated
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - ResourceName => (string)

    The Amazon RDS resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

  - Filters => (array<associative-array>)

    This parameter is not currently supported.

    - (associative-array)
      - Name => (string)

        This parameter is not currently supported.

      - Values => (array<string>)

        This parameter is not currently supported.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- TagList => (array<associative-array>)

  List of tags returned by the ListTagsForResource operation.

  - (associative-array)

    Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

    - Key => (string)

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

    - Value => (string)

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

# `public `Guzzle\Service\Resource\Model``
`modifyDBCluster( array $args = array() )`

Executes the ModifyDBCluster operation.

Modify a setting for an Amazon Aurora DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

#### Examples

- Basic formatting example

      $result = $client->modifyDBCluster(array(
          // DBClusterIdentifier is required
          'DBClusterIdentifier' => 'string',
          'NewDBClusterIdentifier' => 'string',
          'ApplyImmediately' => true || false,
          'BackupRetentionPeriod' => integer,
          'DBClusterParameterGroupName' => 'string',
          'VpcSecurityGroupIds' => array('string', ... ),
          'Port' => integer,
          'MasterUserPassword' => 'string',
          'OptionGroupName' => 'string',
          'PreferredBackupWindow' => 'string',
          'PreferredMaintenanceWindow' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DBClusterIdentifier => (string)

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

    Constraints:

    - Must be the identifier for an existing DB cluster.
    - Must contain from 1 to 63 alphanumeric characters or hyphens.
    - First character must be a letter.
    - Cannot end with a hyphen or contain two consecutive hyphens.
  - NewDBClusterIdentifier => (string)

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

    Constraints:

    - Must contain from 1 to 63 alphanumeric characters or hyphens
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens

    Example: my-cluster2

  - ApplyImmediately => (bool)

    A value that specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster.

    If this parameter is set to false, changes to the DB cluster are applied during the next maintenance window.

    Default: false

  - BackupRetentionPeriod => (int)

    The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

    Default: 1

    Constraints:

    - Must be a value from 0 to 35
  - DBClusterParameterGroupName => (string)

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

  - VpcSecurityGroupIds => (array<string>)

    A lst of VPC security groups that the DB cluster will belong to.

  - Port => (int)

    The port number on which the DB cluster accepts connections.

    Constraints: Value must be 1150-65535

    Default: The same port as the original DB cluster.

  - MasterUserPassword => (string)

    The new password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".

    Constraints: Must contain from 8 to 41 characters.

  - OptionGroupName => (string)

    A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter does not result in an outage except in the following case, and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

    Permanent options cannot be removed from an option group. The option group cannot be removed from a DB cluster once it is associated with a DB cluster.

  - PreferredBackupWindow => (string)

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

    Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

    Constraints:

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

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

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

    Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

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

    Constraints: Minimum 30-minute window.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- DBCluster => (associative-array)

  Contains the result of a successful invocation of the following actions:

  - CreateDBCluster
  - DeleteDBCluster
  - FailoverDBCluster
  - ModifyDBCluster
  - RestoreDBClusterFromSnapshot

  This data type is used as a response element in the DescribeDBClusters action.

  - AllocatedStorage => (int)

    Specifies the allocated storage size in gigabytes (GB).

  - AvailabilityZones => (array<string>)

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

  - BackupRetentionPeriod => (int)

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

  - CharacterSetName => (string)

    If present, specifies the name of the character set that this cluster is associated with.

  - DatabaseName => (string)

    Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

  - DBClusterIdentifier => (string)

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

  - DBClusterParameterGroup => (string)

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

  - DBSubnetGroup => (string)

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

  - Status => (string)

    Specifies the current state of this DB cluster.

  - PercentProgress => (string)

    Specifies the progress of the operation as a percentage.

  - EarliestRestorableTime => (string)

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

  - Endpoint => (string)

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

  - Engine => (string)

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

  - EngineVersion => (string)

    Indicates the database engine version.

  - LatestRestorableTime => (string)

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

  - Port => (int)

    Specifies the port that the database engine is listening on.

  - MasterUsername => (string)

    Contains the master username for the DB cluster.

  - DBClusterOptionGroupMemberships => (array<associative-array>)

    Provides the list of option group memberships for this DB cluster.

    - (associative-array)

      Contains status information for a DB cluster option group.

      - DBClusterOptionGroupName => (string)

        Specifies the name of the DB cluster option group.

      - Status => (string)

        Specifies the status of the DB cluster option group.

  - PreferredBackupWindow => (string)

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

  - PreferredMaintenanceWindow => (string)

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

  - DBClusterMembers => (array<associative-array>)

    Provides the list of instances that make up the DB cluster.

    - (associative-array)

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

      - DBInstanceIdentifier => (string)

        Specifies the instance identifier for this member of the DB cluster.

      - IsClusterWriter => (bool)

        Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

      - DBClusterParameterGroupStatus => (string)

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

  - VpcSecurityGroups => (array<associative-array>)

    Provides a list of VPC security groups that the DB cluster belongs to.

    - (associative-array)

      This data type is used as a response element for queries on VPC security group membership.

      - VpcSecurityGroupId => (string)

        The name of the VPC security group.

      - Status => (string)

        The status of the VPC security group.

  - HostedZoneId => (string)

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

# `public `Guzzle\Service\Resource\Model``
`modifyDBClusterParameterGroup( array $args = array() )`

Executes the ModifyDBClusterParameterGroup operation.

Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName , ParameterValue , and ApplyMethod . A maximum of 20 parameters can be modified in a single request.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB cluster associated with the parameter group before the change can take effect.

After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.

#### Examples

- Basic formatting example

      $result = $client->modifyDBClusterParameterGroup(array(
          // DBClusterParameterGroupName is required
          'DBClusterParameterGroupName' => 'string',
          // Parameters is required
          'Parameters' => array(
              array(
                  'ParameterName' => 'string',
                  'ParameterValue' => 'string',
                  'Description' => 'string',
                  'Source' => 'string',
                  'ApplyType' => 'string',
                  'DataType' => 'string',
                  'AllowedValues' => 'string',
                  'IsModifiable' => true || false,
                  'MinimumEngineVersion' => 'string',
                  'ApplyMethod' => 'string',
              ),
              // ... repeated
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DBClusterParameterGroupName => (string)

    The name of the DB cluster parameter group to modify.

  - Parameters => (array<associative-array>)

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

    - (associative-array)

      This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.

      This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.

      - ParameterName => (string)

        Specifies the name of the parameter.

      - ParameterValue => (string)

        Specifies the value of the parameter.

      - Description => (string)

        Provides a description of the parameter.

      - Source => (string)

        Indicates the source of the parameter value.

      - ApplyType => (string)

        Specifies the engine specific parameters type.

      - DataType => (string)

        Specifies the valid data type for the parameter.

      - AllowedValues => (string)

        Specifies the valid range of values for the parameter.

      - IsModifiable => (bool)

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

      - MinimumEngineVersion => (string)

        The earliest engine version to which the parameter can apply.

      - ApplyMethod => (string: immediate | pending-reboot )

        Indicates when to apply parameter updates.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- DBClusterParameterGroupName => (string)

  The name of the DB cluster parameter group.

  Constraints:

  - Must be 1 to 255 alphanumeric characters
  - First character must be a letter
  - Cannot end with a hyphen or contain two consecutive hyphens
  This value is stored as a lowercase string.

# `public `Guzzle\Service\Resource\Model``
`modifyDBInstance( array $args = array() )`

Executes the ModifyDBInstance operation.

Modify settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.

#### Examples

- Basic formatting example

      $result = $client->modifyDBInstance(array(
          // DBInstanceIdentifier is required
          'DBInstanceIdentifier' => 'string',
          'AllocatedStorage' => integer,
          'DBInstanceClass' => 'string',
          'DBSecurityGroups' => array('string', ... ),
          'VpcSecurityGroupIds' => array('string', ... ),
          'ApplyImmediately' => true || false,
          'MasterUserPassword' => 'string',
          'DBParameterGroupName' => 'string',
          'BackupRetentionPeriod' => integer,
          'PreferredBackupWindow' => 'string',
          'PreferredMaintenanceWindow' => 'string',
          'MultiAZ' => true || false,
          'EngineVersion' => 'string',
          'AllowMajorVersionUpgrade' => true || false,
          'AutoMinorVersionUpgrade' => true || false,
          'Iops' => integer,
          'OptionGroupName' => 'string',
          'NewDBInstanceIdentifier' => 'string',
          'StorageType' => 'string',
          'TdeCredentialArn' => 'string',
          'TdeCredentialPassword' => 'string',
          'CACertificateIdentifier' => 'string',
          'CopyTagsToSnapshot' => true || false,
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DBInstanceIdentifier => (string)

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

    Constraints:

    - Must be the identifier for an existing DB instance
    - Must contain from 1 to 63 alphanumeric characters or hyphens
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
  - AllocatedStorage => (int)

    The new storage capacity of the RDS instance. Changing this setting does not result in an outage and the change is applied during the next maintenance window unless ApplyImmediately is set to true for this request.

    MySQL

    Default: Uses existing setting

    Valid Values: 5-6144

    Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

    Type: Integer

    PostgreSQL

    Default: Uses existing setting

    Valid Values: 5-6144

    Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

    Type: Integer

    Oracle

    Default: Uses existing setting

    Valid Values: 10-6144

    Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

    SQL Server

    Cannot be modified.

    If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance will be suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance.

  - DBInstanceClass => (string)

    The new compute and memory capacity of the DB instance. To determine the instance classes that are available for a particular DB engine, use the DescribeOrderableDBInstanceOptions action.

    Passing a value for this setting causes an outage during the change and is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request.

    Default: Uses existing setting

    Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium

  - DBSubnetGroupName => (string)

    The new DB subnet group for the DB instance. If the DB instance is not in a VPC, then the DB instance will be converted to use the VPC referred to by the new DB subnet group.

    Passing a value for this parameter causes an outage during the change and is applied during the next maintenance window, unless the ApplyImmediately parameter is specified as true for this request.

  - DBSecurityGroups => (array<string>)

    A list of DB security groups to authorize on this DB instance. Changing this setting does not result in an outage and the change is asynchronously applied as soon as possible.

    Constraints:

    - Must be 1 to 255 alphanumeric characters
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
  - VpcSecurityGroupIds => (array<string>)

    A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.

    Constraints:

    - Must be 1 to 255 alphanumeric characters
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
  - ApplyImmediately => (bool)

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

    If this parameter is set to false, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and will be applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in Modifying a DB Instance and Using the Apply Immediately Parameter to see the impact that setting ApplyImmediately to true or false has for each modified parameter and to determine when the changes will be applied.

    Default: false

  - MasterUserPassword => (string)

    The new password for the DB instance master user. Can be any printable ASCII character except "/", """, or "@".

    Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

    Default: Uses existing setting

    Constraints: Must be 8 to 41 alphanumeric characters (MySQL and Amazon Aurora), 8 to 30 alphanumeric characters (Oracle), or 8 to 128 alphanumeric characters (SQL Server).

    Amazon RDS API actions never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.
  - DBParameterGroupName => (string)

    The name of the DB parameter group to apply to the DB instance. Changing this setting does not result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. The db instance will NOT be rebooted automatically and the parameter changes will NOT be applied during the next maintenance window.

    Default: Uses existing setting

    Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.

  - BackupRetentionPeriod => (int)

    The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

    Changing this parameter can result in an outage if you change from 0 to a non-zero value or from a non-zero value to 0. These changes are applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible.

    Default: Uses existing setting

    Constraints:

    - Must be a value from 0 to 35
    - Can be specified for a MySQL Read Replica only if the source is running MySQL 5.6
    - Can be specified for a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5
    - Cannot be set to 0 if the DB instance is a source to Read Replicas
  - PreferredBackupWindow => (string)

    The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod parameter. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.

    Constraints:

    - Must be in the format hh24:mi-hh24:mi
    - Times should be in Universal Time Coordinated (UTC)
    - Must not conflict with the preferred maintenance window
    - Must be at least 30 minutes
  - PreferredMaintenanceWindow => (string)

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

    Default: Uses existing setting

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

    Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

    Constraints: Must be at least 30 minutes

  - MultiAZ => (bool)

    Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

    Constraints: Cannot be specified if the DB instance is a Read Replica. This parameter cannot be used with SQL Server DB instances. Multi-AZ for SQL Server DB instances is set using the Mirroring option in an option group associated with the DB instance.

  - EngineVersion => (string)

    The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

    For major version upgrades, if a non-default DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.

    For a list of valid engine versions, see CreateDBInstance.

  - AllowMajorVersionUpgrade => (bool)

    Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.

    Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.

  - AutoMinorVersionUpgrade => (bool)

    Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window. Changing this parameter does not result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to true during the maintenance window, and a newer minor version is available, and RDS has enabled auto patching for that engine version.

  - Iops => (int)

    The new Provisioned IOPS (I/O operations per second) value for the RDS instance. Changing this setting does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

    Default: Uses existing setting

    Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.

    SQL Server

    Setting the IOPS value for the SQL Server database engine is not supported.

    Type: Integer

    If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance will be suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance.

  - OptionGroupName => (string)

    Indicates that the DB instance should be associated with the specified option group. Changing this parameter does not result in an outage except in the following case and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

    Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance

  - NewDBInstanceIdentifier => (string)

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

    Constraints:

    - Must contain from 1 to 63 alphanumeric characters or hyphens
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
  - StorageType => (string)

    Specifies the storage type to be associated with the DB instance.

    Valid values: standard | gp2 | io1

    If you specify io1, you must also include a value for the Iops parameter.

    Default: io1 if the Iops parameter is specified; otherwise standard

  - TdeCredentialArn => (string)

    The ARN from the Key Store with which to associate the instance for TDE encryption.

  - TdeCredentialPassword => (string)

    The password for the given ARN from the Key Store in order to access the device.

  - CACertificateIdentifier => (string)

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

  - Domain => (string)

    Specify the Active Directory Domain to move the instance to.

    The specified Active Directory Domain must be created prior to this operation. Currently only SQL Server instance can be created in a Domain

  - CopyTagsToSnapshot => (bool)

    True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default is false.

  - MonitoringInterval => (int)

    The interval, in seconds, between when metrics are collected for the DB instance. Specify 0 to disable collecting metrics.

    Valid Values: 0, 1, 5, 10, 15, 30, 60

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- DBInstance => (associative-array)

  Contains the result of a successful invocation of the following actions:

  - CreateDBInstance
  - DeleteDBInstance
  - ModifyDBInstance

  This data type is used as a response element in the DescribeDBInstances action.

  - DBInstanceIdentifier => (string)

    Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

  - DBInstanceClass => (string)

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

  - Engine => (string)

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

  - DBInstanceStatus => (string)

    Specifies the current state of this database.

  - MasterUsername => (string)

    Contains the master username for the DB instance.

  - DBName => (string)

    The meaning of this parameter differs according to the database engine you use. For example, this value returns either MySQL or PostgreSQL information when returning values from CreateDBInstanceReadReplica since Read Replicas are only supported for MySQL and PostgreSQL.

    MySQL, SQL Server, PostgreSQL, Amazon Aurora

    Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

    Type: String

    Oracle

    Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

  - Endpoint => (associative-array)

    Specifies the connection endpoint.

    - Address => (string)

      Specifies the DNS address of the DB instance.

    - Port => (int)

      Specifies the port that the database engine is listening on.

    - HostedZoneId => (string)

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

  - AllocatedStorage => (int)

    Specifies the allocated storage size specified in gigabytes.

  - InstanceCreateTime => (string)

    Provides the date and time the DB instance was created.

  - PreferredBackupWindow => (string)

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

  - BackupRetentionPeriod => (int)

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

  - DBSecurityGroups => (array<associative-array>)

    Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

    - (associative-array)

      This data type is used as a response element in the following actions:

      - ModifyDBInstance
      - RebootDBInstance
      - RestoreDBInstanceFromDBSnapshot
      - RestoreDBInstanceToPointInTime
      - DBSecurityGroupName => (string)

        The name of the DB security group.

      - Status => (string)

        The status of the DB security group.

  - VpcSecurityGroups => (array<associative-array>)

    Provides List of VPC security group elements that the DB instance belongs to.

    - (associative-array)

      This data type is used as a response element for queries on VPC security group membership.

      - VpcSecurityGroupId => (string)

        The name of the VPC security group.

      - Status => (string)

        The status of the VPC security group.

  - DBParameterGroups => (array<associative-array>)

    Provides the list of DB parameter groups applied to this DB instance.

    - (associative-array)

      The status of the DB parameter group.

      This data type is used as a response element in the following actions:

      - CreateDBInstance
      - CreateDBInstanceReadReplica
      - DeleteDBInstance
      - ModifyDBInstance
      - RebootDBInstance
      - RestoreDBInstanceFromDBSnapshot
      - DBParameterGroupName => (string)

        The name of the DP parameter group.

      - ParameterApplyStatus => (string)

        The status of parameter updates.

  - AvailabilityZone => (string)

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

  - DBSubnetGroup => (associative-array)

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

    - DBSubnetGroupName => (string)

      Specifies the name of the DB subnet group.

    - DBSubnetGroupDescription => (string)

      Provides the description of the DB subnet group.

    - VpcId => (string)

      Provides the VpcId of the DB subnet group.

    - SubnetGroupStatus => (string)

      Provides the status of the DB subnet group.

    - Subnets => (array<associative-array>)

      Contains a list of Subnet elements.

      - (associative-array)

        This data type is used as a response element in the DescribeDBSubnetGroups action.

        - SubnetIdentifier => (string)

          Specifies the identifier of the subnet.

        - SubnetAvailabilityZone => (associative-array)

          Contains Availability Zone information.

          This data type is used as an element in the following data type:

          - OrderableDBInstanceOption
          - Name => (string)

            The name of the availability zone.

        - SubnetStatus => (string)

          Specifies the status of the subnet.

  - PreferredMaintenanceWindow => (string)

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

  - PendingModifiedValues => (associative-array)

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

    - DBInstanceClass => (string)

      Contains the new DBInstanceClass for the DB instance that will be applied or is in progress.

    - AllocatedStorage => (int)

      Contains the new AllocatedStorage size for the DB instance that will be applied or is in progress.

    - MasterUserPassword => (string)

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

    - Port => (int)

      Specifies the pending port for the DB instance.

    - BackupRetentionPeriod => (int)

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

    - MultiAZ => (bool)

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

    - EngineVersion => (string)

      Indicates the database engine version.

    - Iops => (int)

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

    - DBInstanceIdentifier => (string)

      Contains the new DBInstanceIdentifier for the DB instance that will be applied or is in progress.

    - StorageType => (string)

      Specifies the storage type to be associated with the DB instance.

    - CACertificateIdentifier => (string)

      Specifies the identifier of the CA certificate for the DB instance.

  - LatestRestorableTime => (string)

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

  - MultiAZ => (bool)

    Specifies if the DB instance is a Multi-AZ deployment.

  - EngineVersion => (string)

    Indicates the database engine version.

  - AutoMinorVersionUpgrade => (bool)

    Indicates that minor version patches are applied automatically.

  - ReadReplicaSourceDBInstanceIdentifier => (string)

    Contains the identifier of the source DB instance if this DB instance is a Read Replica.

  - ReadReplicaDBInstanceIdentifiers => (array<string>)

    Contains one or more identifiers of the Read Replicas associated with this DB instance.

  - LicenseModel => (string)

    License model information for this DB instance.

  - Iops => (int)

    Specifies the Provisioned IOPS (I/O operations per second) value.

  - OptionGroupMemberships => (array<associative-array>)

    Provides the list of option group memberships for this DB instance.

    - (associative-array)

      Provides information on the option groups the DB instance is a member of.

      - OptionGroupName => (string)

        The name of the option group that the instance belongs to.

      - Status => (string)

        The status of the DB instance's option group membership (e.g. in-sync, pending, pending-maintenance, applying).

  - CharacterSetName => (string)

    If present, specifies the name of the character set that this instance is associated with.

  - SecondaryAvailabilityZone => (string)

    If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

  - PubliclyAccessible => (bool)

    Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

    Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

    - Default VPC:true
    - VPC:false

    If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

  - StatusInfos => (array<associative-array>)

    The status of a Read Replica. If the instance is not a Read Replica, this will be blank.

    - (associative-array)

      Provides a list of status information for a DB instance.

      - StatusType => (string)

        This value is currently "read replication."

      - Normal => (bool)

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

      - Status => (string)

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

      - Message => (string)

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

  - StorageType => (string)

    Specifies the storage type associated with DB instance.

  - TdeCredentialArn => (string)

    The ARN from the Key Store with which the instance is associated for TDE encryption.

  - DbInstancePort => (int)

    Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

  - DBClusterIdentifier => (string)

    If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

  - StorageEncrypted => (bool)

    Specifies whether the DB instance is encrypted.

  - KmsKeyId => (string)

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

  - DbiResourceId => (string)

    If StorageEncrypted is true, the region-unique, immutable identifier for the encrypted DB instance. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB instance is accessed.

  - CACertificateIdentifier => (string)

    The identifier of the CA certificate for this DB instance.

  - DomainMemberships => (array<associative-array>)

    The Active Directory Domain membership records associated with the DB instance.

    - (associative-array)

      An Active Directory Domain membership record associated with the DB instance.

      - Domain => (string)

        The identifier of the Active Directory Domain.

      - Status => (string)

        The status of the DB instance's Active Directory Domain membership (e.g. joined, pending-join, failed etc).

      - Connectivity => (string)

        The observed connectivity of the Active Directory Domain.

  - CopyTagsToSnapshot => (bool)

    Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

  - MonitoringInterval => (int)

    The interval, in seconds, between when metrics are collected for the DB instance.

# `public `Guzzle\Service\Resource\Model``
`modifyDBParameterGroup( array $args = array() )`

Executes the ModifyDBParameterGroup operation.

Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName , ParameterValue , and ApplyMethod . A maximum of 20 parameters can be modified in a single request.

Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect.

After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.

#### Examples

- Basic formatting example

      $result = $client->modifyDBParameterGroup(array(
          // DBParameterGroupName is required
          'DBParameterGroupName' => 'string',
          // Parameters is required
          'Parameters' => array(
              array(
                  'ParameterName' => 'string',
                  'ParameterValue' => 'string',
                  'Description' => 'string',
                  'Source' => 'string',
                  'ApplyType' => 'string',
                  'DataType' => 'string',
                  'AllowedValues' => 'string',
                  'IsModifiable' => true || false,
                  'MinimumEngineVersion' => 'string',
                  'ApplyMethod' => 'string',
              ),
              // ... repeated
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DBParameterGroupName => (string)

    The name of the DB parameter group.

    Constraints:

    - Must be the name of an existing DB parameter group
    - Must be 1 to 255 alphanumeric characters
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
  - Parameters => (array<associative-array>)

    An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters can be modified in a single request.

    Valid Values (for the application method): immediate | pending-reboot

    You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when you reboot the DB instance without failover.
    - (associative-array)

      This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.

      This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.

      - ParameterName => (string)

        Specifies the name of the parameter.

      - ParameterValue => (string)

        Specifies the value of the parameter.

      - Description => (string)

        Provides a description of the parameter.

      - Source => (string)

        Indicates the source of the parameter value.

      - ApplyType => (string)

        Specifies the engine specific parameters type.

      - DataType => (string)

        Specifies the valid data type for the parameter.

      - AllowedValues => (string)

        Specifies the valid range of values for the parameter.

      - IsModifiable => (bool)

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

      - MinimumEngineVersion => (string)

        The earliest engine version to which the parameter can apply.

      - ApplyMethod => (string: immediate | pending-reboot )

        Indicates when to apply parameter updates.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- DBParameterGroupName => (string)

  Provides the name of the DB parameter group.

# `public `Guzzle\Service\Resource\Model``
`modifyDBSubnetGroup( array $args = array() )`

Executes the ModifyDBSubnetGroup operation.

Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.

#### Examples

- Basic formatting example

      $result = $client->modifyDBSubnetGroup(array(
          // DBSubnetGroupName is required
          'DBSubnetGroupName' => 'string',
          'DBSubnetGroupDescription' => 'string',
          // SubnetIds is required
          'SubnetIds' => array('string', ... ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DBSubnetGroupName => (string)

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

    Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be "Default".

    Example: mySubnetgroup

  - DBSubnetGroupDescription => (string)

    The description for the DB subnet group.

  - SubnetIds => (array<string>)

    The EC2 subnet IDs for the DB subnet group.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- DBSubnetGroup => (associative-array)

  Contains the result of a successful invocation of the following actions:

  - CreateDBSubnetGroup
  - ModifyDBSubnetGroup
  - DescribeDBSubnetGroups
  - DeleteDBSubnetGroup

  This data type is used as a response element in the DescribeDBSubnetGroups action.

  - DBSubnetGroupName => (string)

    Specifies the name of the DB subnet group.

  - DBSubnetGroupDescription => (string)

    Provides the description of the DB subnet group.

  - VpcId => (string)

    Provides the VpcId of the DB subnet group.

  - SubnetGroupStatus => (string)

    Provides the status of the DB subnet group.

  - Subnets => (array<associative-array>)

    Contains a list of Subnet elements.

    - (associative-array)

      This data type is used as a response element in the DescribeDBSubnetGroups action.

      - SubnetIdentifier => (string)

        Specifies the identifier of the subnet.

      - SubnetAvailabilityZone => (associative-array)

        Contains Availability Zone information.

        This data type is used as an element in the following data type:

        - OrderableDBInstanceOption
        - Name => (string)

          The name of the availability zone.

      - SubnetStatus => (string)

        Specifies the status of the subnet.

# `public `Guzzle\Service\Resource\Model``
`modifyEventSubscription( array $args = array() )`

Executes the ModifyEventSubscription operation.

Modifies an existing RDS event notification subscription. Note that you cannot modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.

You can see a list of the event categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.

#### Examples

- Basic formatting example

      $result = $client->modifyEventSubscription(array(
          // SubscriptionName is required
          'SubscriptionName' => 'string',
          'SnsTopicArn' => 'string',
          'SourceType' => 'string',
          'EventCategories' => array('string', ... ),
          'Enabled' => true || false,
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - SubscriptionName => (string)

    The name of the RDS event notification subscription.

  - SnsTopicArn => (string)

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

  - SourceType => (string)

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

    Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

  - EventCategories => (array<string>)

    A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.

  - Enabled => (bool)

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- EventSubscription => (associative-array)

  Contains the results of a successful invocation of the DescribeEventSubscriptions action.

  - CustomerAwsId => (string)

    The AWS customer account associated with the RDS event notification subscription.

  - CustSubscriptionId => (string)

    The RDS event notification subscription Id.

  - SnsTopicArn => (string)

    The topic ARN of the RDS event notification subscription.

  - Status => (string)

    The status of the RDS event notification subscription.

    Constraints:

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

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

  - SubscriptionCreationTime => (string)

    The time the RDS event notification subscription was created.

  - SourceType => (string)

    The source type for the RDS event notification subscription.

  - SourceIdsList => (array<string>)

    A list of source IDs for the RDS event notification subscription.

  - EventCategoriesList => (array<string>)

    A list of event categories for the RDS event notification subscription.

  - Enabled => (bool)

    A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

# `public `Guzzle\Service\Resource\Model``
`modifyOptionGroup( array $args = array() )`

Executes the ModifyOptionGroup operation.

Modifies an existing option group.

#### Examples

- Basic formatting example

      $result = $client->modifyOptionGroup(array(
          // OptionGroupName is required
          'OptionGroupName' => 'string',
          'OptionsToInclude' => array(
              array(
                  // OptionName is required
                  'OptionName' => 'string',
                  'Port' => integer,
                  'DBSecurityGroupMemberships' => array('string', ... ),
                  'VpcSecurityGroupMemberships' => array('string', ... ),
                  'OptionSettings' => array(
                      array(
                          'Name' => 'string',
                          'Value' => 'string',
                          'DefaultValue' => 'string',
                          'Description' => 'string',
                          'ApplyType' => 'string',
                          'DataType' => 'string',
                          'AllowedValues' => 'string',
                          'IsModifiable' => true || false,
                          'IsCollection' => true || false,
                      ),
                      // ... repeated
                  ),
              ),
              // ... repeated
          ),
          'OptionsToRemove' => array('string', ... ),
          'ApplyImmediately' => true || false,
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - OptionGroupName => (string)

    The name of the option group to be modified.

    Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance

  - OptionsToInclude => (array<associative-array>)

    Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration.

    - (associative-array)

      A list of all available options

      - OptionName => (string)

        The configuration of options to include in a group.

      - Port => (int)

        The optional port for the option.

      - DBSecurityGroupMemberships => (array<string>)

        A list of DBSecurityGroupMemebrship name strings used for this option.

      - VpcSecurityGroupMemberships => (array<string>)

        A list of VpcSecurityGroupMemebrship name strings used for this option.

      - OptionSettings => (array<associative-array>)

        The option settings to include in an option group.

        - (associative-array)

          Option settings are the actual settings being applied or configured for that option. It is used when you modify an option group or describe option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting called SQLNET.ENCRYPTION_SERVER that can have several different values.

          - Name => (string)

            The name of the option that has settings that you can set.

          - Value => (string)

            The current value of the option setting.

          - DefaultValue => (string)

            The default value of the option setting.

          - Description => (string)

            The description of the option setting.

          - ApplyType => (string)

            The DB engine specific parameter type.

          - DataType => (string)

            The data type of the option setting.

          - AllowedValues => (string)

            The allowed values of the option setting.

          - IsModifiable => (bool)

            A Boolean value that, when true, indicates the option setting can be modified from the default.

          - IsCollection => (bool)

            Indicates if the option setting is part of a collection.

  - OptionsToRemove => (array<string>)

    Options in this list are removed from the option group.

  - ApplyImmediately => (bool)

    Indicates whether the changes should be applied immediately, or during the next maintenance window for each instance associated with the option group.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- OptionGroup => (associative-array)
  - OptionGroupName => (string)

    Specifies the name of the option group.

  - OptionGroupDescription => (string)

    Provides a description of the option group.

  - EngineName => (string)

    Indicates the name of the engine that this option group can be applied to.

  - MajorEngineVersion => (string)

    Indicates the major engine version associated with this option group.

  - Options => (array<associative-array>)

    Indicates what options are available in the option group.

    - (associative-array)

      Option details.

      - OptionName => (string)

        The name of the option.

      - OptionDescription => (string)

        The description of the option.

      - Persistent => (bool)

        Indicate if this option is persistent.

      - Permanent => (bool)

        Indicate if this option is permanent.

      - Port => (int)

        If required, the port configured for this option to use.

      - OptionSettings => (array<associative-array>)

        The option settings for this option.

        - (associative-array)

          Option settings are the actual settings being applied or configured for that option. It is used when you modify an option group or describe option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting called SQLNET.ENCRYPTION_SERVER that can have several different values.

          - Name => (string)

            The name of the option that has settings that you can set.

          - Value => (string)

            The current value of the option setting.

          - DefaultValue => (string)

            The default value of the option setting.

          - Description => (string)

            The description of the option setting.

          - ApplyType => (string)

            The DB engine specific parameter type.

          - DataType => (string)

            The data type of the option setting.

          - AllowedValues => (string)

            The allowed values of the option setting.

          - IsModifiable => (bool)

            A Boolean value that, when true, indicates the option setting can be modified from the default.

          - IsCollection => (bool)

            Indicates if the option setting is part of a collection.

      - DBSecurityGroupMemberships => (array<associative-array>)

        If the option requires access to a port, then this DB security group allows access to the port.

        - (associative-array)

          This data type is used as a response element in the following actions:

          - ModifyDBInstance
          - RebootDBInstance
          - RestoreDBInstanceFromDBSnapshot
          - RestoreDBInstanceToPointInTime
          - DBSecurityGroupName => (string)

            The name of the DB security group.

          - Status => (string)

            The status of the DB security group.

      - VpcSecurityGroupMemberships => (array<associative-array>)

        If the option requires access to a port, then this VPC security group allows access to the port.

        - (associative-array)

          This data type is used as a response element for queries on VPC security group membership.

          - VpcSecurityGroupId => (string)

            The name of the VPC security group.

          - Status => (string)

            The status of the VPC security group.

  - AllowsVpcAndNonVpcInstanceMemberships => (bool)

    Indicates whether this option group can be applied to both VPC and non-VPC instances. The value true indicates the option group can be applied to both VPC and non-VPC instances.

  - VpcId => (string)

    If AllowsVpcAndNonVpcInstanceMemberships is false, this field is blank. If AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field.

# `public `Guzzle\Service\Resource\Model``
`promoteReadReplica( array $args = array() )`

Executes the PromoteReadReplica operation.

Promotes a Read Replica DB instance to a standalone DB instance.

We recommend that you enable automated backups on your Read Replica before promoting the Read Replica. This ensures that no backup is taken during the promotion process. Once the instance is promoted to a primary instance, backups are taken based on your backup settings.

#### Examples

- Basic formatting example

      $result = $client->promoteReadReplica(array(
          // DBInstanceIdentifier is required
          'DBInstanceIdentifier' => 'string',
          'BackupRetentionPeriod' => integer,
          'PreferredBackupWindow' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DBInstanceIdentifier => (string)

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

    Constraints:

    - Must be the identifier for an existing Read Replica DB instance
    - Must contain from 1 to 63 alphanumeric characters or hyphens
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens

    Example: mydbinstance

  - BackupRetentionPeriod => (int)

    The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

    Default: 1

    Constraints:

    - Must be a value from 0 to 8
  - PreferredBackupWindow => (string)

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

    Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

    Constraints:

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- DBInstance => (associative-array)

  Contains the result of a successful invocation of the following actions:

  - CreateDBInstance
  - DeleteDBInstance
  - ModifyDBInstance

  This data type is used as a response element in the DescribeDBInstances action.

  - DBInstanceIdentifier => (string)

    Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

  - DBInstanceClass => (string)

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

  - Engine => (string)

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

  - DBInstanceStatus => (string)

    Specifies the current state of this database.

  - MasterUsername => (string)

    Contains the master username for the DB instance.

  - DBName => (string)

    The meaning of this parameter differs according to the database engine you use. For example, this value returns either MySQL or PostgreSQL information when returning values from CreateDBInstanceReadReplica since Read Replicas are only supported for MySQL and PostgreSQL.

    MySQL, SQL Server, PostgreSQL, Amazon Aurora

    Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

    Type: String

    Oracle

    Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

  - Endpoint => (associative-array)

    Specifies the connection endpoint.

    - Address => (string)

      Specifies the DNS address of the DB instance.

    - Port => (int)

      Specifies the port that the database engine is listening on.

    - HostedZoneId => (string)

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

  - AllocatedStorage => (int)

    Specifies the allocated storage size specified in gigabytes.

  - InstanceCreateTime => (string)

    Provides the date and time the DB instance was created.

  - PreferredBackupWindow => (string)

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

  - BackupRetentionPeriod => (int)

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

  - DBSecurityGroups => (array<associative-array>)

    Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

    - (associative-array)

      This data type is used as a response element in the following actions:

      - ModifyDBInstance
      - RebootDBInstance
      - RestoreDBInstanceFromDBSnapshot
      - RestoreDBInstanceToPointInTime
      - DBSecurityGroupName => (string)

        The name of the DB security group.

      - Status => (string)

        The status of the DB security group.

  - VpcSecurityGroups => (array<associative-array>)

    Provides List of VPC security group elements that the DB instance belongs to.

    - (associative-array)

      This data type is used as a response element for queries on VPC security group membership.

      - VpcSecurityGroupId => (string)

        The name of the VPC security group.

      - Status => (string)

        The status of the VPC security group.

  - DBParameterGroups => (array<associative-array>)

    Provides the list of DB parameter groups applied to this DB instance.

    - (associative-array)

      The status of the DB parameter group.

      This data type is used as a response element in the following actions:

      - CreateDBInstance
      - CreateDBInstanceReadReplica
      - DeleteDBInstance
      - ModifyDBInstance
      - RebootDBInstance
      - RestoreDBInstanceFromDBSnapshot
      - DBParameterGroupName => (string)

        The name of the DP parameter group.

      - ParameterApplyStatus => (string)

        The status of parameter updates.

  - AvailabilityZone => (string)

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

  - DBSubnetGroup => (associative-array)

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

    - DBSubnetGroupName => (string)

      Specifies the name of the DB subnet group.

    - DBSubnetGroupDescription => (string)

      Provides the description of the DB subnet group.

    - VpcId => (string)

      Provides the VpcId of the DB subnet group.

    - SubnetGroupStatus => (string)

      Provides the status of the DB subnet group.

    - Subnets => (array<associative-array>)

      Contains a list of Subnet elements.

      - (associative-array)

        This data type is used as a response element in the DescribeDBSubnetGroups action.

        - SubnetIdentifier => (string)

          Specifies the identifier of the subnet.

        - SubnetAvailabilityZone => (associative-array)

          Contains Availability Zone information.

          This data type is used as an element in the following data type:

          - OrderableDBInstanceOption
          - Name => (string)

            The name of the availability zone.

        - SubnetStatus => (string)

          Specifies the status of the subnet.

  - PreferredMaintenanceWindow => (string)

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

  - PendingModifiedValues => (associative-array)

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

    - DBInstanceClass => (string)

      Contains the new DBInstanceClass for the DB instance that will be applied or is in progress.

    - AllocatedStorage => (int)

      Contains the new AllocatedStorage size for the DB instance that will be applied or is in progress.

    - MasterUserPassword => (string)

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

    - Port => (int)

      Specifies the pending port for the DB instance.

    - BackupRetentionPeriod => (int)

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

    - MultiAZ => (bool)

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

    - EngineVersion => (string)

      Indicates the database engine version.

    - Iops => (int)

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

    - DBInstanceIdentifier => (string)

      Contains the new DBInstanceIdentifier for the DB instance that will be applied or is in progress.

    - StorageType => (string)

      Specifies the storage type to be associated with the DB instance.

    - CACertificateIdentifier => (string)

      Specifies the identifier of the CA certificate for the DB instance.

  - LatestRestorableTime => (string)

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

  - MultiAZ => (bool)

    Specifies if the DB instance is a Multi-AZ deployment.

  - EngineVersion => (string)

    Indicates the database engine version.

  - AutoMinorVersionUpgrade => (bool)

    Indicates that minor version patches are applied automatically.

  - ReadReplicaSourceDBInstanceIdentifier => (string)

    Contains the identifier of the source DB instance if this DB instance is a Read Replica.

  - ReadReplicaDBInstanceIdentifiers => (array<string>)

    Contains one or more identifiers of the Read Replicas associated with this DB instance.

  - LicenseModel => (string)

    License model information for this DB instance.

  - Iops => (int)

    Specifies the Provisioned IOPS (I/O operations per second) value.

  - OptionGroupMemberships => (array<associative-array>)

    Provides the list of option group memberships for this DB instance.

    - (associative-array)

      Provides information on the option groups the DB instance is a member of.

      - OptionGroupName => (string)

        The name of the option group that the instance belongs to.

      - Status => (string)

        The status of the DB instance's option group membership (e.g. in-sync, pending, pending-maintenance, applying).

  - CharacterSetName => (string)

    If present, specifies the name of the character set that this instance is associated with.

  - SecondaryAvailabilityZone => (string)

    If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

  - PubliclyAccessible => (bool)

    Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

    Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

    - Default VPC:true
    - VPC:false

    If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

  - StatusInfos => (array<associative-array>)

    The status of a Read Replica. If the instance is not a Read Replica, this will be blank.

    - (associative-array)

      Provides a list of status information for a DB instance.

      - StatusType => (string)

        This value is currently "read replication."

      - Normal => (bool)

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

      - Status => (string)

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

      - Message => (string)

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

  - StorageType => (string)

    Specifies the storage type associated with DB instance.

  - TdeCredentialArn => (string)

    The ARN from the Key Store with which the instance is associated for TDE encryption.

  - DbInstancePort => (int)

    Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

  - DBClusterIdentifier => (string)

    If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

  - StorageEncrypted => (bool)

    Specifies whether the DB instance is encrypted.

  - KmsKeyId => (string)

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

  - DbiResourceId => (string)

    If StorageEncrypted is true, the region-unique, immutable identifier for the encrypted DB instance. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB instance is accessed.

  - CACertificateIdentifier => (string)

    The identifier of the CA certificate for this DB instance.

  - DomainMemberships => (array<associative-array>)

    The Active Directory Domain membership records associated with the DB instance.

    - (associative-array)

      An Active Directory Domain membership record associated with the DB instance.

      - Domain => (string)

        The identifier of the Active Directory Domain.

      - Status => (string)

        The status of the DB instance's Active Directory Domain membership (e.g. joined, pending-join, failed etc).

      - Connectivity => (string)

        The observed connectivity of the Active Directory Domain.

  - CopyTagsToSnapshot => (bool)

    Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

  - MonitoringInterval => (int)

    The interval, in seconds, between when metrics are collected for the DB instance.

# `public `Guzzle\Service\Resource\Model``
`purchaseReservedDBInstancesOffering( array $args = array() )`

Executes the PurchaseReservedDBInstancesOffering operation.

Purchases a reserved DB instance offering.

#### Examples

- Basic formatting example

      $result = $client->purchaseReservedDBInstancesOffering(array(
          // ReservedDBInstancesOfferingId is required
          'ReservedDBInstancesOfferingId' => 'string',
          'ReservedDBInstanceId' => 'string',
          'DBInstanceCount' => integer,
          'Tags' => array(
              array(
                  'Key' => 'string',
                  'Value' => 'string',
              ),
              // ... repeated
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - ReservedDBInstancesOfferingId => (string)

    The ID of the Reserved DB instance offering to purchase.

    Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

  - ReservedDBInstanceId => (string)

    Customer-specified identifier to track this reservation.

    Example: myreservationID

  - DBInstanceCount => (int)

    The number of instances to reserve.

    Default: 1

  - Tags => (array<associative-array>)

    A list of tags.

    - (associative-array)

      Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

      - Key => (string)

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

      - Value => (string)

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- ReservedDBInstance => (associative-array)

  This data type is used as a response element in the DescribeReservedDBInstances and PurchaseReservedDBInstancesOffering actions.

  - ReservedDBInstanceId => (string)

    The unique identifier for the reservation.

  - ReservedDBInstancesOfferingId => (string)

    The offering identifier.

  - DBInstanceClass => (string)

    The DB instance class for the reserved DB instance.

  - StartTime => (string)

    The time the reservation started.

  - Duration => (int)

    The duration of the reservation in seconds.

  - FixedPrice => (int)

    The fixed price charged for this reserved DB instance.

  - UsagePrice => (int)

    The hourly price charged for this reserved DB instance.

  - CurrencyCode => (string)

    The currency code for the reserved DB instance.

  - DBInstanceCount => (int)

    The number of reserved DB instances.

  - ProductDescription => (string)

    The description of the reserved DB instance.

  - OfferingType => (string)

    The offering type of this reserved DB instance.

  - MultiAZ => (bool)

    Indicates if the reservation applies to Multi-AZ deployments.

  - State => (string)

    The state of the reserved DB instance.

  - RecurringCharges => (array<associative-array>)

    The recurring price charged to run this reserved DB instance.

    - (associative-array)

      This data type is used as a response element in the DescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions.

      - RecurringChargeAmount => (int)

        The amount of the recurring charge.

      - RecurringChargeFrequency => (string)

        The frequency of the recurring charge.

# `public `Guzzle\Service\Resource\Model``
`rebootDBInstance( array $args = array() )`

Executes the RebootDBInstance operation.

Rebooting a DB instance restarts the database engine service. A reboot also applies to the DB instance any modifications to the associated DB parameter group that were pending. Rebooting a DB instance results in a momentary outage of the instance, during which the DB instance status is set to rebooting. If the RDS instance is configured for MultiAZ, it is possible that the reboot will be conducted through a failover. An Amazon RDS event is created when the reboot is completed.

If your DB instance is deployed in multiple Availability Zones, you can force a failover from one AZ to the other during the reboot. You might force a failover to test the availability of your DB instance deployment or to restore operations to the original AZ after a failover occurs.

The time required to reboot is a function of the specific database engine's crash recovery process. To improve the reboot time, we recommend that you reduce database activities as much as possible during the reboot process to reduce rollback activity for in-transit transactions.

#### Examples

- Basic formatting example

      $result = $client->rebootDBInstance(array(
          // DBInstanceIdentifier is required
          'DBInstanceIdentifier' => 'string',
          'ForceFailover' => true || false,
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DBInstanceIdentifier => (string)

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

    Constraints:

    - Must contain from 1 to 63 alphanumeric characters or hyphens
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
  - ForceFailover => (bool)

    When true, the reboot will be conducted through a MultiAZ failover.

    Constraint: You cannot specify true if the instance is not configured for MultiAZ.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- DBInstance => (associative-array)

  Contains the result of a successful invocation of the following actions:

  - CreateDBInstance
  - DeleteDBInstance
  - ModifyDBInstance

  This data type is used as a response element in the DescribeDBInstances action.

  - DBInstanceIdentifier => (string)

    Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

  - DBInstanceClass => (string)

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

  - Engine => (string)

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

  - DBInstanceStatus => (string)

    Specifies the current state of this database.

  - MasterUsername => (string)

    Contains the master username for the DB instance.

  - DBName => (string)

    The meaning of this parameter differs according to the database engine you use. For example, this value returns either MySQL or PostgreSQL information when returning values from CreateDBInstanceReadReplica since Read Replicas are only supported for MySQL and PostgreSQL.

    MySQL, SQL Server, PostgreSQL, Amazon Aurora

    Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

    Type: String

    Oracle

    Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

  - Endpoint => (associative-array)

    Specifies the connection endpoint.

    - Address => (string)

      Specifies the DNS address of the DB instance.

    - Port => (int)

      Specifies the port that the database engine is listening on.

    - HostedZoneId => (string)

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

  - AllocatedStorage => (int)

    Specifies the allocated storage size specified in gigabytes.

  - InstanceCreateTime => (string)

    Provides the date and time the DB instance was created.

  - PreferredBackupWindow => (string)

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

  - BackupRetentionPeriod => (int)

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

  - DBSecurityGroups => (array<associative-array>)

    Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

    - (associative-array)

      This data type is used as a response element in the following actions:

      - ModifyDBInstance
      - RebootDBInstance
      - RestoreDBInstanceFromDBSnapshot
      - RestoreDBInstanceToPointInTime
      - DBSecurityGroupName => (string)

        The name of the DB security group.

      - Status => (string)

        The status of the DB security group.

  - VpcSecurityGroups => (array<associative-array>)

    Provides List of VPC security group elements that the DB instance belongs to.

    - (associative-array)

      This data type is used as a response element for queries on VPC security group membership.

      - VpcSecurityGroupId => (string)

        The name of the VPC security group.

      - Status => (string)

        The status of the VPC security group.

  - DBParameterGroups => (array<associative-array>)

    Provides the list of DB parameter groups applied to this DB instance.

    - (associative-array)

      The status of the DB parameter group.

      This data type is used as a response element in the following actions:

      - CreateDBInstance
      - CreateDBInstanceReadReplica
      - DeleteDBInstance
      - ModifyDBInstance
      - RebootDBInstance
      - RestoreDBInstanceFromDBSnapshot
      - DBParameterGroupName => (string)

        The name of the DP parameter group.

      - ParameterApplyStatus => (string)

        The status of parameter updates.

  - AvailabilityZone => (string)

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

  - DBSubnetGroup => (associative-array)

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

    - DBSubnetGroupName => (string)

      Specifies the name of the DB subnet group.

    - DBSubnetGroupDescription => (string)

      Provides the description of the DB subnet group.

    - VpcId => (string)

      Provides the VpcId of the DB subnet group.

    - SubnetGroupStatus => (string)

      Provides the status of the DB subnet group.

    - Subnets => (array<associative-array>)

      Contains a list of Subnet elements.

      - (associative-array)

        This data type is used as a response element in the DescribeDBSubnetGroups action.

        - SubnetIdentifier => (string)

          Specifies the identifier of the subnet.

        - SubnetAvailabilityZone => (associative-array)

          Contains Availability Zone information.

          This data type is used as an element in the following data type:

          - OrderableDBInstanceOption
          - Name => (string)

            The name of the availability zone.

        - SubnetStatus => (string)

          Specifies the status of the subnet.

  - PreferredMaintenanceWindow => (string)

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

  - PendingModifiedValues => (associative-array)

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

    - DBInstanceClass => (string)

      Contains the new DBInstanceClass for the DB instance that will be applied or is in progress.

    - AllocatedStorage => (int)

      Contains the new AllocatedStorage size for the DB instance that will be applied or is in progress.

    - MasterUserPassword => (string)

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

    - Port => (int)

      Specifies the pending port for the DB instance.

    - BackupRetentionPeriod => (int)

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

    - MultiAZ => (bool)

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

    - EngineVersion => (string)

      Indicates the database engine version.

    - Iops => (int)

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

    - DBInstanceIdentifier => (string)

      Contains the new DBInstanceIdentifier for the DB instance that will be applied or is in progress.

    - StorageType => (string)

      Specifies the storage type to be associated with the DB instance.

    - CACertificateIdentifier => (string)

      Specifies the identifier of the CA certificate for the DB instance.

  - LatestRestorableTime => (string)

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

  - MultiAZ => (bool)

    Specifies if the DB instance is a Multi-AZ deployment.

  - EngineVersion => (string)

    Indicates the database engine version.

  - AutoMinorVersionUpgrade => (bool)

    Indicates that minor version patches are applied automatically.

  - ReadReplicaSourceDBInstanceIdentifier => (string)

    Contains the identifier of the source DB instance if this DB instance is a Read Replica.

  - ReadReplicaDBInstanceIdentifiers => (array<string>)

    Contains one or more identifiers of the Read Replicas associated with this DB instance.

  - LicenseModel => (string)

    License model information for this DB instance.

  - Iops => (int)

    Specifies the Provisioned IOPS (I/O operations per second) value.

  - OptionGroupMemberships => (array<associative-array>)

    Provides the list of option group memberships for this DB instance.

    - (associative-array)

      Provides information on the option groups the DB instance is a member of.

      - OptionGroupName => (string)

        The name of the option group that the instance belongs to.

      - Status => (string)

        The status of the DB instance's option group membership (e.g. in-sync, pending, pending-maintenance, applying).

  - CharacterSetName => (string)

    If present, specifies the name of the character set that this instance is associated with.

  - SecondaryAvailabilityZone => (string)

    If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

  - PubliclyAccessible => (bool)

    Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

    Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

    - Default VPC:true
    - VPC:false

    If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

  - StatusInfos => (array<associative-array>)

    The status of a Read Replica. If the instance is not a Read Replica, this will be blank.

    - (associative-array)

      Provides a list of status information for a DB instance.

      - StatusType => (string)

        This value is currently "read replication."

      - Normal => (bool)

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

      - Status => (string)

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

      - Message => (string)

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

  - StorageType => (string)

    Specifies the storage type associated with DB instance.

  - TdeCredentialArn => (string)

    The ARN from the Key Store with which the instance is associated for TDE encryption.

  - DbInstancePort => (int)

    Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

  - DBClusterIdentifier => (string)

    If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

  - StorageEncrypted => (bool)

    Specifies whether the DB instance is encrypted.

  - KmsKeyId => (string)

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

  - DbiResourceId => (string)

    If StorageEncrypted is true, the region-unique, immutable identifier for the encrypted DB instance. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB instance is accessed.

  - CACertificateIdentifier => (string)

    The identifier of the CA certificate for this DB instance.

  - DomainMemberships => (array<associative-array>)

    The Active Directory Domain membership records associated with the DB instance.

    - (associative-array)

      An Active Directory Domain membership record associated with the DB instance.

      - Domain => (string)

        The identifier of the Active Directory Domain.

      - Status => (string)

        The status of the DB instance's Active Directory Domain membership (e.g. joined, pending-join, failed etc).

      - Connectivity => (string)

        The observed connectivity of the Active Directory Domain.

  - CopyTagsToSnapshot => (bool)

    Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

  - MonitoringInterval => (int)

    The interval, in seconds, between when metrics are collected for the DB instance.

# `public `Guzzle\Service\Resource\Model``
`removeSourceIdentifierFromSubscription( array $args = array() )`

Executes the RemoveSourceIdentifierFromSubscription operation.

Removes a source identifier from an existing RDS event notification subscription.

#### Examples

- Basic formatting example

      $result = $client->removeSourceIdentifierFromSubscription(array(
          // SubscriptionName is required
          'SubscriptionName' => 'string',
          // SourceIdentifier is required
          'SourceIdentifier' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - SubscriptionName => (string)

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

  - SourceIdentifier => (string)

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- EventSubscription => (associative-array)

  Contains the results of a successful invocation of the DescribeEventSubscriptions action.

  - CustomerAwsId => (string)

    The AWS customer account associated with the RDS event notification subscription.

  - CustSubscriptionId => (string)

    The RDS event notification subscription Id.

  - SnsTopicArn => (string)

    The topic ARN of the RDS event notification subscription.

  - Status => (string)

    The status of the RDS event notification subscription.

    Constraints:

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

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

  - SubscriptionCreationTime => (string)

    The time the RDS event notification subscription was created.

  - SourceType => (string)

    The source type for the RDS event notification subscription.

  - SourceIdsList => (array<string>)

    A list of source IDs for the RDS event notification subscription.

  - EventCategoriesList => (array<string>)

    A list of event categories for the RDS event notification subscription.

  - Enabled => (bool)

    A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

# `public `Guzzle\Service\Resource\Model``
`removeTagsFromResource( array $args = array() )`

Executes the RemoveTagsFromResource operation.

Removes metadata tags from an Amazon RDS resource.

For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources.

#### Examples

- Basic formatting example

      $result = $client->removeTagsFromResource(array(
          // ResourceName is required
          'ResourceName' => 'string',
          // TagKeys is required
          'TagKeys' => array('string', ... ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - ResourceName => (string)

    The Amazon RDS resource the tags will be removed from. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

  - TagKeys => (array<string>)

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

# `public `Guzzle\Service\Resource\Model``
`resetDBClusterParameterGroup( array $args = array() )`

Executes the ResetDBClusterParameterGroup operation.

Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod . To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters.

When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

#### Examples

- Basic formatting example

      $result = $client->resetDBClusterParameterGroup(array(
          // DBClusterParameterGroupName is required
          'DBClusterParameterGroupName' => 'string',
          'ResetAllParameters' => true || false,
          'Parameters' => array(
              array(
                  'ParameterName' => 'string',
                  'ParameterValue' => 'string',
                  'Description' => 'string',
                  'Source' => 'string',
                  'ApplyType' => 'string',
                  'DataType' => 'string',
                  'AllowedValues' => 'string',
                  'IsModifiable' => true || false,
                  'MinimumEngineVersion' => 'string',
                  'ApplyMethod' => 'string',
              ),
              // ... repeated
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DBClusterParameterGroupName => (string)

    The name of the DB cluster parameter group to reset.

  - ResetAllParameters => (bool)

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

  - Parameters => (array<associative-array>)

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

    - (associative-array)

      This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.

      This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.

      - ParameterName => (string)

        Specifies the name of the parameter.

      - ParameterValue => (string)

        Specifies the value of the parameter.

      - Description => (string)

        Provides a description of the parameter.

      - Source => (string)

        Indicates the source of the parameter value.

      - ApplyType => (string)

        Specifies the engine specific parameters type.

      - DataType => (string)

        Specifies the valid data type for the parameter.

      - AllowedValues => (string)

        Specifies the valid range of values for the parameter.

      - IsModifiable => (bool)

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

      - MinimumEngineVersion => (string)

        The earliest engine version to which the parameter can apply.

      - ApplyMethod => (string: immediate | pending-reboot )

        Indicates when to apply parameter updates.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- DBClusterParameterGroupName => (string)

  The name of the DB cluster parameter group.

  Constraints:

  - Must be 1 to 255 alphanumeric characters
  - First character must be a letter
  - Cannot end with a hyphen or contain two consecutive hyphens
  This value is stored as a lowercase string.

# `public `Guzzle\Service\Resource\Model``
`resetDBParameterGroup( array $args = array() )`

Executes the ResetDBParameterGroup operation.

Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod . To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.

#### Examples

- Basic formatting example

      $result = $client->resetDBParameterGroup(array(
          // DBParameterGroupName is required
          'DBParameterGroupName' => 'string',
          'ResetAllParameters' => true || false,
          'Parameters' => array(
              array(
                  'ParameterName' => 'string',
                  'ParameterValue' => 'string',
                  'Description' => 'string',
                  'Source' => 'string',
                  'ApplyType' => 'string',
                  'DataType' => 'string',
                  'AllowedValues' => 'string',
                  'IsModifiable' => true || false,
                  'MinimumEngineVersion' => 'string',
                  'ApplyMethod' => 'string',
              ),
              // ... repeated
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DBParameterGroupName => (string)

    The name of the DB parameter group.

    Constraints:

    - Must be 1 to 255 alphanumeric characters
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
  - ResetAllParameters => (bool)

    Specifies whether (true) or not (false) to reset all parameters in the DB parameter group to default values.

    Default: true

  - Parameters => (array<associative-array>)

    An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters can be modified in a single request.

    MySQL

    Valid Values (for Apply method): immediate | pending-reboot

    You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots.

    Oracle

    Valid Values (for Apply method): pending-reboot

    - (associative-array)

      This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.

      This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.

      - ParameterName => (string)

        Specifies the name of the parameter.

      - ParameterValue => (string)

        Specifies the value of the parameter.

      - Description => (string)

        Provides a description of the parameter.

      - Source => (string)

        Indicates the source of the parameter value.

      - ApplyType => (string)

        Specifies the engine specific parameters type.

      - DataType => (string)

        Specifies the valid data type for the parameter.

      - AllowedValues => (string)

        Specifies the valid range of values for the parameter.

      - IsModifiable => (bool)

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

      - MinimumEngineVersion => (string)

        The earliest engine version to which the parameter can apply.

      - ApplyMethod => (string: immediate | pending-reboot )

        Indicates when to apply parameter updates.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- DBParameterGroupName => (string)

  Provides the name of the DB parameter group.

# `public `Guzzle\Service\Resource\Model``
`restoreDBClusterFromSnapshot( array $args = array() )`

Executes the RestoreDBClusterFromSnapshot operation.

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

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

#### Examples

- Basic formatting example

      $result = $client->restoreDBClusterFromSnapshot(array(
          'AvailabilityZones' => array('string', ... ),
          // DBClusterIdentifier is required
          'DBClusterIdentifier' => 'string',
          // SnapshotIdentifier is required
          'SnapshotIdentifier' => 'string',
          // Engine is required
          'Engine' => 'string',
          'EngineVersion' => 'string',
          'Port' => integer,
          'DBSubnetGroupName' => 'string',
          'DatabaseName' => 'string',
          'OptionGroupName' => 'string',
          'VpcSecurityGroupIds' => array('string', ... ),
          'Tags' => array(
              array(
                  'Key' => 'string',
                  'Value' => 'string',
              ),
              // ... repeated
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - AvailabilityZones => (array<string>)

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

  - DBClusterIdentifier => (string)

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

    Constraints:

    - Must contain from 1 to 255 alphanumeric characters or hyphens
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens

    Example: my-snapshot-id

  - SnapshotIdentifier => (string)

    The identifier for the DB cluster snapshot to restore from.

    Constraints:

    - Must contain from 1 to 63 alphanumeric characters or hyphens
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
  - Engine => (string)

    The database engine to use for the new DB cluster.

    Default: The same as source

    Constraint: Must be compatible with the engine of the source

  - EngineVersion => (string)

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

  - Port => (int)

    The port number on which the new DB cluster accepts connections.

    Constraints: Value must be 1150-65535

    Default: The same port as the original DB cluster.

  - DBSubnetGroupName => (string)

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

  - DatabaseName => (string)

    The database name for the restored DB cluster.

  - OptionGroupName => (string)

    The name of the option group to use for the restored DB cluster.

  - VpcSecurityGroupIds => (array<string>)

    A list of VPC security groups that the new DB cluster will belong to.

  - Tags => (array<associative-array>)

    The tags to be assigned to the restored DB cluster.

    - (associative-array)

      Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

      - Key => (string)

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

      - Value => (string)

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- DBCluster => (associative-array)

  Contains the result of a successful invocation of the following actions:

  - CreateDBCluster
  - DeleteDBCluster
  - FailoverDBCluster
  - ModifyDBCluster
  - RestoreDBClusterFromSnapshot

  This data type is used as a response element in the DescribeDBClusters action.

  - AllocatedStorage => (int)

    Specifies the allocated storage size in gigabytes (GB).

  - AvailabilityZones => (array<string>)

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

  - BackupRetentionPeriod => (int)

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

  - CharacterSetName => (string)

    If present, specifies the name of the character set that this cluster is associated with.

  - DatabaseName => (string)

    Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

  - DBClusterIdentifier => (string)

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

  - DBClusterParameterGroup => (string)

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

  - DBSubnetGroup => (string)

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

  - Status => (string)

    Specifies the current state of this DB cluster.

  - PercentProgress => (string)

    Specifies the progress of the operation as a percentage.

  - EarliestRestorableTime => (string)

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

  - Endpoint => (string)

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

  - Engine => (string)

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

  - EngineVersion => (string)

    Indicates the database engine version.

  - LatestRestorableTime => (string)

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

  - Port => (int)

    Specifies the port that the database engine is listening on.

  - MasterUsername => (string)

    Contains the master username for the DB cluster.

  - DBClusterOptionGroupMemberships => (array<associative-array>)

    Provides the list of option group memberships for this DB cluster.

    - (associative-array)

      Contains status information for a DB cluster option group.

      - DBClusterOptionGroupName => (string)

        Specifies the name of the DB cluster option group.

      - Status => (string)

        Specifies the status of the DB cluster option group.

  - PreferredBackupWindow => (string)

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

  - PreferredMaintenanceWindow => (string)

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

  - DBClusterMembers => (array<associative-array>)

    Provides the list of instances that make up the DB cluster.

    - (associative-array)

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

      - DBInstanceIdentifier => (string)

        Specifies the instance identifier for this member of the DB cluster.

      - IsClusterWriter => (bool)

        Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

      - DBClusterParameterGroupStatus => (string)

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

  - VpcSecurityGroups => (array<associative-array>)

    Provides a list of VPC security groups that the DB cluster belongs to.

    - (associative-array)

      This data type is used as a response element for queries on VPC security group membership.

      - VpcSecurityGroupId => (string)

        The name of the VPC security group.

      - Status => (string)

        The status of the VPC security group.

  - HostedZoneId => (string)

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

# `public `Guzzle\Service\Resource\Model``
`restoreDBClusterToPointInTime( array $args = array() )`

Executes the RestoreDBClusterToPointInTime operation.

Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

#### Examples

- Basic formatting example

      $result = $client->restoreDBClusterToPointInTime(array(
          // DBClusterIdentifier is required
          'DBClusterIdentifier' => 'string',
          // SourceDBClusterIdentifier is required
          'SourceDBClusterIdentifier' => 'string',
          'RestoreToTime' => 'mixed type: string (date format)|int (unix timestamp)|\DateTime',
          'UseLatestRestorableTime' => true || false,
          'Port' => integer,
          'DBSubnetGroupName' => 'string',
          'OptionGroupName' => 'string',
          'VpcSecurityGroupIds' => array('string', ... ),
          'Tags' => array(
              array(
                  'Key' => 'string',
                  'Value' => 'string',
              ),
              // ... repeated
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DBClusterIdentifier => (string)

    The name of the new DB cluster to be created.

    Constraints:

    - Must contain from 1 to 63 alphanumeric characters or hyphens
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
  - SourceDBClusterIdentifier => (string)

    The identifier of the source DB cluster from which to restore.

    Constraints:

    - Must be the identifier of an existing database instance
    - Must contain from 1 to 63 alphanumeric characters or hyphens
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
  - RestoreToTime => (string [date format]|int [unix timestamp]|\DateTime)

    The date and time to restore the DB cluster to.

    Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

    Constraints:

    - Must be before the latest restorable time for the DB instance
    - Cannot be specified if UseLatestRestorableTime parameter is true

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

  - UseLatestRestorableTime => (bool)

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

    Default: false

    Constraints: Cannot be specified if RestoreToTime parameter is provided.

  - Port => (int)

    The port number on which the new DB cluster accepts connections.

    Constraints: Value must be 1150-65535

    Default: The same port as the original DB cluster.

  - DBSubnetGroupName => (string)

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

  - OptionGroupName => (string)

    The name of the option group for the new DB cluster.

  - VpcSecurityGroupIds => (array<string>)

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

  - Tags => (array<associative-array>)

    A list of tags.

    - (associative-array)

      Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

      - Key => (string)

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

      - Value => (string)

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- DBCluster => (associative-array)

  Contains the result of a successful invocation of the following actions:

  - CreateDBCluster
  - DeleteDBCluster
  - FailoverDBCluster
  - ModifyDBCluster
  - RestoreDBClusterFromSnapshot

  This data type is used as a response element in the DescribeDBClusters action.

  - AllocatedStorage => (int)

    Specifies the allocated storage size in gigabytes (GB).

  - AvailabilityZones => (array<string>)

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

  - BackupRetentionPeriod => (int)

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

  - CharacterSetName => (string)

    If present, specifies the name of the character set that this cluster is associated with.

  - DatabaseName => (string)

    Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

  - DBClusterIdentifier => (string)

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

  - DBClusterParameterGroup => (string)

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

  - DBSubnetGroup => (string)

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

  - Status => (string)

    Specifies the current state of this DB cluster.

  - PercentProgress => (string)

    Specifies the progress of the operation as a percentage.

  - EarliestRestorableTime => (string)

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

  - Endpoint => (string)

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

  - Engine => (string)

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

  - EngineVersion => (string)

    Indicates the database engine version.

  - LatestRestorableTime => (string)

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

  - Port => (int)

    Specifies the port that the database engine is listening on.

  - MasterUsername => (string)

    Contains the master username for the DB cluster.

  - DBClusterOptionGroupMemberships => (array<associative-array>)

    Provides the list of option group memberships for this DB cluster.

    - (associative-array)

      Contains status information for a DB cluster option group.

      - DBClusterOptionGroupName => (string)

        Specifies the name of the DB cluster option group.

      - Status => (string)

        Specifies the status of the DB cluster option group.

  - PreferredBackupWindow => (string)

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

  - PreferredMaintenanceWindow => (string)

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

  - DBClusterMembers => (array<associative-array>)

    Provides the list of instances that make up the DB cluster.

    - (associative-array)

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

      - DBInstanceIdentifier => (string)

        Specifies the instance identifier for this member of the DB cluster.

      - IsClusterWriter => (bool)

        Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

      - DBClusterParameterGroupStatus => (string)

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

  - VpcSecurityGroups => (array<associative-array>)

    Provides a list of VPC security groups that the DB cluster belongs to.

    - (associative-array)

      This data type is used as a response element for queries on VPC security group membership.

      - VpcSecurityGroupId => (string)

        The name of the VPC security group.

      - Status => (string)

        The status of the VPC security group.

  - HostedZoneId => (string)

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

# `public `Guzzle\Service\Resource\Model``
`restoreDBInstanceFromDBSnapshot( array $args = array() )`

Executes the RestoreDBInstanceFromDBSnapshot operation.

Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with the most of original configuration, but in a system chosen availability zone with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored AZ deployment and not a single-AZ deployment.

If your intent is to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS does not allow two DB instances with the same name. Once you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you will replace the original DB instance with the DB instance created from the snapshot.

#### Examples

- Basic formatting example

      $result = $client->restoreDBInstanceFromDBSnapshot(array(
          // DBInstanceIdentifier is required
          'DBInstanceIdentifier' => 'string',
          // DBSnapshotIdentifier is required
          'DBSnapshotIdentifier' => 'string',
          'DBInstanceClass' => 'string',
          'Port' => integer,
          'AvailabilityZone' => 'string',
          'DBSubnetGroupName' => 'string',
          'MultiAZ' => true || false,
          'PubliclyAccessible' => true || false,
          'AutoMinorVersionUpgrade' => true || false,
          'LicenseModel' => 'string',
          'DBName' => 'string',
          'Engine' => 'string',
          'Iops' => integer,
          'OptionGroupName' => 'string',
          'Tags' => array(
              array(
                  'Key' => 'string',
                  'Value' => 'string',
              ),
              // ... repeated
          ),
          'StorageType' => 'string',
          'TdeCredentialArn' => 'string',
          'TdeCredentialPassword' => 'string',
          'CopyTagsToSnapshot' => true || false,
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DBInstanceIdentifier => (string)

    Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.

    Constraints:

    - Must contain from 1 to 255 alphanumeric characters or hyphens
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens

    Example: my-snapshot-id

  - DBSnapshotIdentifier => (string)

    The identifier for the DB snapshot to restore from.

    Constraints:

    - Must contain from 1 to 63 alphanumeric characters or hyphens
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
  - DBInstanceClass => (string)

    The compute and memory capacity of the Amazon RDS DB instance.

    Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium

  - Port => (int)

    The port number on which the database accepts connections.

    Default: The same port as the original DB instance

    Constraints: Value must be 1150-65535

  - AvailabilityZone => (string)

    The EC2 Availability Zone that the database instance will be created in.

    Default: A random, system-chosen Availability Zone.

    Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

    Example: us-east-1a

  - DBSubnetGroupName => (string)

    The DB subnet group name to use for the new instance.

  - MultiAZ => (bool)

    Specifies if the DB instance is a Multi-AZ deployment.

    Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

  - PubliclyAccessible => (bool)

    Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

    Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

    - Default VPC: true
    - VPC: false

    If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

  - AutoMinorVersionUpgrade => (bool)

    Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window.

  - LicenseModel => (string)

    License model information for the restored DB instance.

    Default: Same as source.

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

  - DBName => (string)

    The database name for the restored DB instance.

    This parameter doesn't apply to the MySQL engine.

  - Engine => (string)

    The database engine to use for the new instance.

    Default: The same as source

    Constraint: Must be compatible with the engine of the source

    Valid Values: MySQL | oracle-se1 | oracle-se | oracle-ee | sqlserver-ee | sqlserver-se | sqlserver-ex | sqlserver-web | postgres

  - Iops => (int)

    Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter is not specified, the IOPS value will be taken from the backup. If this parameter is set to 0, the new instance will be converted to a non-PIOPS instance, which will take additional time, though your DB instance will be available for connections before the conversion starts.

    Constraints: Must be an integer greater than 1000.

    SQL Server

    Setting the IOPS value for the SQL Server database engine is not supported.

  - OptionGroupName => (string)

    The name of the option group to be used for the restored DB instance.

    Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance

  - Tags => (array<associative-array>)

    A list of tags.

    - (associative-array)

      Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

      - Key => (string)

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

      - Value => (string)

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

  - StorageType => (string)

    Specifies the storage type to be associated with the DB instance.

    Valid values: standard | gp2 | io1

    If you specify io1, you must also include a value for the Iops parameter.

    Default: io1 if the Iops parameter is specified; otherwise standard

  - TdeCredentialArn => (string)

    The ARN from the Key Store with which to associate the instance for TDE encryption.

  - TdeCredentialPassword => (string)

    The password for the given ARN from the Key Store in order to access the device.

  - VpcSecurityGroupIds => (array<string>)

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

    Default: The default EC2 VPC security group for the DB subnet group's VPC.

  - DBSecurityGroups => (array<string>)

    A list of DB security groups to associate with this DB instance.

    Default: The default DB security group for the database engine.

  - Domain => (string)

    Specify the Active Directory Domain to restore the instance in.

  - CopyTagsToSnapshot => (bool)

    True to copy all tags from the restored DB instance to snapshots of the DB instance; otherwise false. The default is false.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- DBInstance => (associative-array)

  Contains the result of a successful invocation of the following actions:

  - CreateDBInstance
  - DeleteDBInstance
  - ModifyDBInstance

  This data type is used as a response element in the DescribeDBInstances action.

  - DBInstanceIdentifier => (string)

    Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

  - DBInstanceClass => (string)

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

  - Engine => (string)

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

  - DBInstanceStatus => (string)

    Specifies the current state of this database.

  - MasterUsername => (string)

    Contains the master username for the DB instance.

  - DBName => (string)

    The meaning of this parameter differs according to the database engine you use. For example, this value returns either MySQL or PostgreSQL information when returning values from CreateDBInstanceReadReplica since Read Replicas are only supported for MySQL and PostgreSQL.

    MySQL, SQL Server, PostgreSQL, Amazon Aurora

    Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

    Type: String

    Oracle

    Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

  - Endpoint => (associative-array)

    Specifies the connection endpoint.

    - Address => (string)

      Specifies the DNS address of the DB instance.

    - Port => (int)

      Specifies the port that the database engine is listening on.

    - HostedZoneId => (string)

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

  - AllocatedStorage => (int)

    Specifies the allocated storage size specified in gigabytes.

  - InstanceCreateTime => (string)

    Provides the date and time the DB instance was created.

  - PreferredBackupWindow => (string)

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

  - BackupRetentionPeriod => (int)

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

  - DBSecurityGroups => (array<associative-array>)

    Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

    - (associative-array)

      This data type is used as a response element in the following actions:

      - ModifyDBInstance
      - RebootDBInstance
      - RestoreDBInstanceFromDBSnapshot
      - RestoreDBInstanceToPointInTime
      - DBSecurityGroupName => (string)

        The name of the DB security group.

      - Status => (string)

        The status of the DB security group.

  - VpcSecurityGroups => (array<associative-array>)

    Provides List of VPC security group elements that the DB instance belongs to.

    - (associative-array)

      This data type is used as a response element for queries on VPC security group membership.

      - VpcSecurityGroupId => (string)

        The name of the VPC security group.

      - Status => (string)

        The status of the VPC security group.

  - DBParameterGroups => (array<associative-array>)

    Provides the list of DB parameter groups applied to this DB instance.

    - (associative-array)

      The status of the DB parameter group.

      This data type is used as a response element in the following actions:

      - CreateDBInstance
      - CreateDBInstanceReadReplica
      - DeleteDBInstance
      - ModifyDBInstance
      - RebootDBInstance
      - RestoreDBInstanceFromDBSnapshot
      - DBParameterGroupName => (string)

        The name of the DP parameter group.

      - ParameterApplyStatus => (string)

        The status of parameter updates.

  - AvailabilityZone => (string)

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

  - DBSubnetGroup => (associative-array)

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

    - DBSubnetGroupName => (string)

      Specifies the name of the DB subnet group.

    - DBSubnetGroupDescription => (string)

      Provides the description of the DB subnet group.

    - VpcId => (string)

      Provides the VpcId of the DB subnet group.

    - SubnetGroupStatus => (string)

      Provides the status of the DB subnet group.

    - Subnets => (array<associative-array>)

      Contains a list of Subnet elements.

      - (associative-array)

        This data type is used as a response element in the DescribeDBSubnetGroups action.

        - SubnetIdentifier => (string)

          Specifies the identifier of the subnet.

        - SubnetAvailabilityZone => (associative-array)

          Contains Availability Zone information.

          This data type is used as an element in the following data type:

          - OrderableDBInstanceOption
          - Name => (string)

            The name of the availability zone.

        - SubnetStatus => (string)

          Specifies the status of the subnet.

  - PreferredMaintenanceWindow => (string)

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

  - PendingModifiedValues => (associative-array)

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

    - DBInstanceClass => (string)

      Contains the new DBInstanceClass for the DB instance that will be applied or is in progress.

    - AllocatedStorage => (int)

      Contains the new AllocatedStorage size for the DB instance that will be applied or is in progress.

    - MasterUserPassword => (string)

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

    - Port => (int)

      Specifies the pending port for the DB instance.

    - BackupRetentionPeriod => (int)

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

    - MultiAZ => (bool)

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

    - EngineVersion => (string)

      Indicates the database engine version.

    - Iops => (int)

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

    - DBInstanceIdentifier => (string)

      Contains the new DBInstanceIdentifier for the DB instance that will be applied or is in progress.

    - StorageType => (string)

      Specifies the storage type to be associated with the DB instance.

    - CACertificateIdentifier => (string)

      Specifies the identifier of the CA certificate for the DB instance.

  - LatestRestorableTime => (string)

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

  - MultiAZ => (bool)

    Specifies if the DB instance is a Multi-AZ deployment.

  - EngineVersion => (string)

    Indicates the database engine version.

  - AutoMinorVersionUpgrade => (bool)

    Indicates that minor version patches are applied automatically.

  - ReadReplicaSourceDBInstanceIdentifier => (string)

    Contains the identifier of the source DB instance if this DB instance is a Read Replica.

  - ReadReplicaDBInstanceIdentifiers => (array<string>)

    Contains one or more identifiers of the Read Replicas associated with this DB instance.

  - LicenseModel => (string)

    License model information for this DB instance.

  - Iops => (int)

    Specifies the Provisioned IOPS (I/O operations per second) value.

  - OptionGroupMemberships => (array<associative-array>)

    Provides the list of option group memberships for this DB instance.

    - (associative-array)

      Provides information on the option groups the DB instance is a member of.

      - OptionGroupName => (string)

        The name of the option group that the instance belongs to.

      - Status => (string)

        The status of the DB instance's option group membership (e.g. in-sync, pending, pending-maintenance, applying).

  - CharacterSetName => (string)

    If present, specifies the name of the character set that this instance is associated with.

  - SecondaryAvailabilityZone => (string)

    If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

  - PubliclyAccessible => (bool)

    Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

    Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

    - Default VPC:true
    - VPC:false

    If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

  - StatusInfos => (array<associative-array>)

    The status of a Read Replica. If the instance is not a Read Replica, this will be blank.

    - (associative-array)

      Provides a list of status information for a DB instance.

      - StatusType => (string)

        This value is currently "read replication."

      - Normal => (bool)

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

      - Status => (string)

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

      - Message => (string)

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

  - StorageType => (string)

    Specifies the storage type associated with DB instance.

  - TdeCredentialArn => (string)

    The ARN from the Key Store with which the instance is associated for TDE encryption.

  - DbInstancePort => (int)

    Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

  - DBClusterIdentifier => (string)

    If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

  - StorageEncrypted => (bool)

    Specifies whether the DB instance is encrypted.

  - KmsKeyId => (string)

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

  - DbiResourceId => (string)

    If StorageEncrypted is true, the region-unique, immutable identifier for the encrypted DB instance. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB instance is accessed.

  - CACertificateIdentifier => (string)

    The identifier of the CA certificate for this DB instance.

  - DomainMemberships => (array<associative-array>)

    The Active Directory Domain membership records associated with the DB instance.

    - (associative-array)

      An Active Directory Domain membership record associated with the DB instance.

      - Domain => (string)

        The identifier of the Active Directory Domain.

      - Status => (string)

        The status of the DB instance's Active Directory Domain membership (e.g. joined, pending-join, failed etc).

      - Connectivity => (string)

        The observed connectivity of the Active Directory Domain.

  - CopyTagsToSnapshot => (bool)

    Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

  - MonitoringInterval => (int)

    The interval, in seconds, between when metrics are collected for the DB instance.

# `public `Guzzle\Service\Resource\Model``
`restoreDBInstanceToPointInTime( array $args = array() )`

Executes the RestoreDBInstanceToPointInTime operation.

Restores a DB instance to an arbitrary point-in-time. Users can restore to any point in time before the LatestRestorableTime for up to BackupRetentionPeriod days. The target database is created with the most of original configuration, but in a system chosen availability zone with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored deployment and not a single-AZ deployment.

#### Examples

- Basic formatting example

      $result = $client->restoreDBInstanceToPointInTime(array(
          // SourceDBInstanceIdentifier is required
          'SourceDBInstanceIdentifier' => 'string',
          // TargetDBInstanceIdentifier is required
          'TargetDBInstanceIdentifier' => 'string',
          'RestoreTime' => 'mixed type: string (date format)|int (unix timestamp)|\DateTime',
          'UseLatestRestorableTime' => true || false,
          'DBInstanceClass' => 'string',
          'Port' => integer,
          'AvailabilityZone' => 'string',
          'DBSubnetGroupName' => 'string',
          'MultiAZ' => true || false,
          'PubliclyAccessible' => true || false,
          'AutoMinorVersionUpgrade' => true || false,
          'LicenseModel' => 'string',
          'DBName' => 'string',
          'Engine' => 'string',
          'Iops' => integer,
          'OptionGroupName' => 'string',
          'CopyTagsToSnapshot' => true || false,
          'Tags' => array(
              array(
                  'Key' => 'string',
                  'Value' => 'string',
              ),
              // ... repeated
          ),
          'StorageType' => 'string',
          'TdeCredentialArn' => 'string',
          'TdeCredentialPassword' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - SourceDBInstanceIdentifier => (string)

    The identifier of the source DB instance from which to restore.

    Constraints:

    - Must be the identifier of an existing database instance
    - Must contain from 1 to 63 alphanumeric characters or hyphens
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
  - TargetDBInstanceIdentifier => (string)

    The name of the new database instance to be created.

    Constraints:

    - Must contain from 1 to 63 alphanumeric characters or hyphens
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
  - RestoreTime => (string [date format]|int [unix timestamp]|\DateTime)

    The date and time to restore from.

    Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

    Constraints:

    - Must be before the latest restorable time for the DB instance
    - Cannot be specified if UseLatestRestorableTime parameter is true

    Example: 2009-09-07T23:45:00Z

  - UseLatestRestorableTime => (bool)

    Specifies whether (true) or not (false) the DB instance is restored from the latest backup time.

    Default: false

    Constraints: Cannot be specified if RestoreTime parameter is provided.

  - DBInstanceClass => (string)

    The compute and memory capacity of the Amazon RDS DB instance.

    Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium

    Default: The same DBInstanceClass as the original DB instance.

  - Port => (int)

    The port number on which the database accepts connections.

    Constraints: Value must be 1150-65535

    Default: The same port as the original DB instance.

  - AvailabilityZone => (string)

    The EC2 Availability Zone that the database instance will be created in.

    Default: A random, system-chosen Availability Zone.

    Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

    Example: us-east-1a

  - DBSubnetGroupName => (string)

    The DB subnet group name to use for the new instance.

  - MultiAZ => (bool)

    Specifies if the DB instance is a Multi-AZ deployment.

    Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

  - PubliclyAccessible => (bool)

    Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

    Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

    - Default VPC:true
    - VPC:false

    If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

  - AutoMinorVersionUpgrade => (bool)

    Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window.

  - LicenseModel => (string)

    License model information for the restored DB instance.

    Default: Same as source.

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

  - DBName => (string)

    The database name for the restored DB instance.

    This parameter is not used for the MySQL engine.

  - Engine => (string)

    The database engine to use for the new instance.

    Default: The same as source

    Constraint: Must be compatible with the engine of the source

    Valid Values: MySQL | oracle-se1 | oracle-se | oracle-ee | sqlserver-ee | sqlserver-se | sqlserver-ex | sqlserver-web | postgres

  - Iops => (int)

    The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

    Constraints: Must be an integer greater than 1000.

    SQL Server

    Setting the IOPS value for the SQL Server database engine is not supported.

  - OptionGroupName => (string)

    The name of the option group to be used for the restored DB instance.

    Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance

  - CopyTagsToSnapshot => (bool)

    True to copy all tags from the restored DB instance to snapshots of the DB instance; otherwise false. The default is false.

  - Tags => (array<associative-array>)

    A list of tags.

    - (associative-array)

      Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

      - Key => (string)

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

      - Value => (string)

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

  - StorageType => (string)

    Specifies the storage type to be associated with the DB instance.

    Valid values: standard | gp2 | io1

    If you specify io1, you must also include a value for the Iops parameter.

    Default: io1 if the Iops parameter is specified; otherwise standard

  - TdeCredentialArn => (string)

    The ARN from the Key Store with which to associate the instance for TDE encryption.

  - TdeCredentialPassword => (string)

    The password for the given ARN from the Key Store in order to access the device.

  - VpcSecurityGroupIds => (array<string>)

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

    Default: The default EC2 VPC security group for the DB subnet group's VPC.

  - DBSecurityGroups => (array<string>)

    A list of DB security groups to associate with this DB instance.

    Default: The default DB security group for the database engine.

  - Domain => (string)

    Specify the Active Directory Domain to restore the instance in.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- DBInstance => (associative-array)

  Contains the result of a successful invocation of the following actions:

  - CreateDBInstance
  - DeleteDBInstance
  - ModifyDBInstance

  This data type is used as a response element in the DescribeDBInstances action.

  - DBInstanceIdentifier => (string)

    Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

  - DBInstanceClass => (string)

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

  - Engine => (string)

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

  - DBInstanceStatus => (string)

    Specifies the current state of this database.

  - MasterUsername => (string)

    Contains the master username for the DB instance.

  - DBName => (string)

    The meaning of this parameter differs according to the database engine you use. For example, this value returns either MySQL or PostgreSQL information when returning values from CreateDBInstanceReadReplica since Read Replicas are only supported for MySQL and PostgreSQL.

    MySQL, SQL Server, PostgreSQL, Amazon Aurora

    Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

    Type: String

    Oracle

    Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

  - Endpoint => (associative-array)

    Specifies the connection endpoint.

    - Address => (string)

      Specifies the DNS address of the DB instance.

    - Port => (int)

      Specifies the port that the database engine is listening on.

    - HostedZoneId => (string)

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

  - AllocatedStorage => (int)

    Specifies the allocated storage size specified in gigabytes.

  - InstanceCreateTime => (string)

    Provides the date and time the DB instance was created.

  - PreferredBackupWindow => (string)

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

  - BackupRetentionPeriod => (int)

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

  - DBSecurityGroups => (array<associative-array>)

    Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

    - (associative-array)

      This data type is used as a response element in the following actions:

      - ModifyDBInstance
      - RebootDBInstance
      - RestoreDBInstanceFromDBSnapshot
      - RestoreDBInstanceToPointInTime
      - DBSecurityGroupName => (string)

        The name of the DB security group.

      - Status => (string)

        The status of the DB security group.

  - VpcSecurityGroups => (array<associative-array>)

    Provides List of VPC security group elements that the DB instance belongs to.

    - (associative-array)

      This data type is used as a response element for queries on VPC security group membership.

      - VpcSecurityGroupId => (string)

        The name of the VPC security group.

      - Status => (string)

        The status of the VPC security group.

  - DBParameterGroups => (array<associative-array>)

    Provides the list of DB parameter groups applied to this DB instance.

    - (associative-array)

      The status of the DB parameter group.

      This data type is used as a response element in the following actions:

      - CreateDBInstance
      - CreateDBInstanceReadReplica
      - DeleteDBInstance
      - ModifyDBInstance
      - RebootDBInstance
      - RestoreDBInstanceFromDBSnapshot
      - DBParameterGroupName => (string)

        The name of the DP parameter group.

      - ParameterApplyStatus => (string)

        The status of parameter updates.

  - AvailabilityZone => (string)

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

  - DBSubnetGroup => (associative-array)

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

    - DBSubnetGroupName => (string)

      Specifies the name of the DB subnet group.

    - DBSubnetGroupDescription => (string)

      Provides the description of the DB subnet group.

    - VpcId => (string)

      Provides the VpcId of the DB subnet group.

    - SubnetGroupStatus => (string)

      Provides the status of the DB subnet group.

    - Subnets => (array<associative-array>)

      Contains a list of Subnet elements.

      - (associative-array)

        This data type is used as a response element in the DescribeDBSubnetGroups action.

        - SubnetIdentifier => (string)

          Specifies the identifier of the subnet.

        - SubnetAvailabilityZone => (associative-array)

          Contains Availability Zone information.

          This data type is used as an element in the following data type:

          - OrderableDBInstanceOption
          - Name => (string)

            The name of the availability zone.

        - SubnetStatus => (string)

          Specifies the status of the subnet.

  - PreferredMaintenanceWindow => (string)

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

  - PendingModifiedValues => (associative-array)

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

    - DBInstanceClass => (string)

      Contains the new DBInstanceClass for the DB instance that will be applied or is in progress.

    - AllocatedStorage => (int)

      Contains the new AllocatedStorage size for the DB instance that will be applied or is in progress.

    - MasterUserPassword => (string)

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

    - Port => (int)

      Specifies the pending port for the DB instance.

    - BackupRetentionPeriod => (int)

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

    - MultiAZ => (bool)

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

    - EngineVersion => (string)

      Indicates the database engine version.

    - Iops => (int)

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

    - DBInstanceIdentifier => (string)

      Contains the new DBInstanceIdentifier for the DB instance that will be applied or is in progress.

    - StorageType => (string)

      Specifies the storage type to be associated with the DB instance.

    - CACertificateIdentifier => (string)

      Specifies the identifier of the CA certificate for the DB instance.

  - LatestRestorableTime => (string)

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

  - MultiAZ => (bool)

    Specifies if the DB instance is a Multi-AZ deployment.

  - EngineVersion => (string)

    Indicates the database engine version.

  - AutoMinorVersionUpgrade => (bool)

    Indicates that minor version patches are applied automatically.

  - ReadReplicaSourceDBInstanceIdentifier => (string)

    Contains the identifier of the source DB instance if this DB instance is a Read Replica.

  - ReadReplicaDBInstanceIdentifiers => (array<string>)

    Contains one or more identifiers of the Read Replicas associated with this DB instance.

  - LicenseModel => (string)

    License model information for this DB instance.

  - Iops => (int)

    Specifies the Provisioned IOPS (I/O operations per second) value.

  - OptionGroupMemberships => (array<associative-array>)

    Provides the list of option group memberships for this DB instance.

    - (associative-array)

      Provides information on the option groups the DB instance is a member of.

      - OptionGroupName => (string)

        The name of the option group that the instance belongs to.

      - Status => (string)

        The status of the DB instance's option group membership (e.g. in-sync, pending, pending-maintenance, applying).

  - CharacterSetName => (string)

    If present, specifies the name of the character set that this instance is associated with.

  - SecondaryAvailabilityZone => (string)

    If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

  - PubliclyAccessible => (bool)

    Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

    Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

    - Default VPC:true
    - VPC:false

    If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

  - StatusInfos => (array<associative-array>)

    The status of a Read Replica. If the instance is not a Read Replica, this will be blank.

    - (associative-array)

      Provides a list of status information for a DB instance.

      - StatusType => (string)

        This value is currently "read replication."

      - Normal => (bool)

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

      - Status => (string)

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

      - Message => (string)

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

  - StorageType => (string)

    Specifies the storage type associated with DB instance.

  - TdeCredentialArn => (string)

    The ARN from the Key Store with which the instance is associated for TDE encryption.

  - DbInstancePort => (int)

    Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

  - DBClusterIdentifier => (string)

    If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

  - StorageEncrypted => (bool)

    Specifies whether the DB instance is encrypted.

  - KmsKeyId => (string)

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

  - DbiResourceId => (string)

    If StorageEncrypted is true, the region-unique, immutable identifier for the encrypted DB instance. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB instance is accessed.

  - CACertificateIdentifier => (string)

    The identifier of the CA certificate for this DB instance.

  - DomainMemberships => (array<associative-array>)

    The Active Directory Domain membership records associated with the DB instance.

    - (associative-array)

      An Active Directory Domain membership record associated with the DB instance.

      - Domain => (string)

        The identifier of the Active Directory Domain.

      - Status => (string)

        The status of the DB instance's Active Directory Domain membership (e.g. joined, pending-join, failed etc).

      - Connectivity => (string)

        The observed connectivity of the Active Directory Domain.

  - CopyTagsToSnapshot => (bool)

    Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

  - MonitoringInterval => (int)

    The interval, in seconds, between when metrics are collected for the DB instance.

# `public `Guzzle\Service\Resource\Model``
`revokeDBSecurityGroupIngress( array $args = array() )`

Executes the RevokeDBSecurityGroupIngress operation.

Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC Security Groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId).

#### Examples

- Basic formatting example

      $result = $client->revokeDBSecurityGroupIngress(array(
          // DBSecurityGroupName is required
          'DBSecurityGroupName' => 'string',
          'CIDRIP' => 'string',
          'EC2SecurityGroupName' => 'string',
          'EC2SecurityGroupId' => 'string',
          'EC2SecurityGroupOwnerId' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DBSecurityGroupName => (string)

    The name of the DB security group to revoke ingress from.

  - CIDRIP => (string)

    The IP range to revoke access from. Must be a valid CIDR range. If CIDRIP is specified, EC2SecurityGroupName, EC2SecurityGroupId and EC2SecurityGroupOwnerId cannot be provided.

  - EC2SecurityGroupName => (string)

    The name of the EC2 security group to revoke access from. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

  - EC2SecurityGroupId => (string)

    The id of the EC2 security group to revoke access from. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

  - EC2SecurityGroupOwnerId => (string)

    The AWS Account Number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- DBSecurityGroup => (associative-array)

  Contains the result of a successful invocation of the following actions:

  - DescribeDBSecurityGroups
  - AuthorizeDBSecurityGroupIngress
  - CreateDBSecurityGroup
  - RevokeDBSecurityGroupIngress

  This data type is used as a response element in the DescribeDBSecurityGroups action.

  - OwnerId => (string)

    Provides the AWS ID of the owner of a specific DB security group.

  - DBSecurityGroupName => (string)

    Specifies the name of the DB security group.

  - DBSecurityGroupDescription => (string)

    Provides the description of the DB security group.

  - VpcId => (string)

    Provides the VpcId of the DB security group.

  - EC2SecurityGroups => (array<associative-array>)

    Contains a list of EC2SecurityGroup elements.

    - (associative-array)

      This data type is used as a response element in the following actions:

      - AuthorizeDBSecurityGroupIngress
      - DescribeDBSecurityGroups
      - RevokeDBSecurityGroupIngress
      - Status => (string)

        Provides the status of the EC2 security group. Status can be "authorizing", "authorized", "revoking", and "revoked".

      - EC2SecurityGroupName => (string)

        Specifies the name of the EC2 security group.

      - EC2SecurityGroupId => (string)

        Specifies the id of the EC2 security group.

      - EC2SecurityGroupOwnerId => (string)

        Specifies the AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.

  - IPRanges => (array<associative-array>)

    Contains a list of IPRange elements.

    - (associative-array)

      This data type is used as a response element in the DescribeDBSecurityGroups action.

      - Status => (string)

        Specifies the status of the IP range. Status can be "authorizing", "authorized", "revoking", and "revoked".

      - CIDRIP => (string)

        Specifies the IP range.

# `public`
`waitUntilDBInstanceAvailable( array $input )`

The input array uses the parameters of the DescribeDBInstances operation and waiter specific settings

#### Parameters

$input
  `array`
  $input

# `public`
`waitUntilDBInstanceDeleted( array $input )`

The input array uses the parameters of the DescribeDBInstances operation and waiter specific settings

#### Parameters

$input
  `array`
  $input

# `public `Guzzle\Service\Resource\ResourceIteratorInterface``
`getDescribeEngineDefaultParametersIterator( array $args = array() )`

The input array uses the parameters of the DescribeEngineDefaultParameters operation

#### Parameters

$args
  `array`
  $args

#### Returns

``Guzzle\Service\Resource\ResourceIteratorInterface``

### Methods inherited from Aws\Common\Client\AbstractClient

`__call()`, `__construct()`, `createRequest()`, `getAllEvents()`, `getApiVersion()`, `getCredentials()`, `getRegion()`, `getRegions()`, `getSignature()`, `getWaiter()`, `getWaiterFactory()`, `send()`, `setCredentials()`, `setRegion()`, `setWaiterFactory()`, `waitUntil()`

### Methods inherited from Guzzle\Service\Client

`execute()`, `executeMultiple()`, `getCommand()`, `getCommandFactory()`, `getDescription()`, `getInflector()`, `getIterator()`, `getResourceIteratorFactory()`, `prepareCommand()`, `setCommandFactory()`, `setDescription()`, `setInflector()`, `setResourceIteratorFactory()`

### Methods inherited from Guzzle\Http\Client

`delete()`, `expandTemplate()`, `extractPharCacert()`, `get()`, `getBaseUrl()`, `getConfig()`, `getCurlMulti()`, `getDefaultOption()`, `getDefaultUserAgent()`, `getUriTemplate()`, `head()`, `initSsl()`, `options()`, `patch()`, `post()`, `prepareRequest()`, `put()`, `sendMultiple()`, `setBaseUrl()`, `setConfig()`, `setCurlMulti()`, `setDefaultOption()`, `setRequestFactory()`, `setSslVerification()`, `setUriTemplate()`, `setUserAgent()`

### Methods inherited from Guzzle\Common\AbstractHasDispatcher

`addSubscriber()`, `dispatch()`, `getEventDispatcher()`, `setEventDispatcher()`

### Magic methods summary

## Constants summary

`string` | `LATEST_API_VERSION` | `'2014-10-31'` | #

### Constants inherited from Guzzle\Service\Client

`COMMAND_PARAMS`

### Constants inherited from Guzzle\Http\Client

`CURL_OPTIONS`, `DEFAULT_SELECT_TIMEOUT`, `DISABLE_REDIRECTS`, `MAX_HANDLES`, `REQUEST_OPTIONS`, `SSL_CERT_AUTHORITY`

### Constants inherited from Guzzle\Http\ClientInterface

`CREATE_REQUEST`, `HTTP_DATE`

## Properties summary

### Properties inherited from Aws\Common\Client\AbstractClient

`$aggregator`, `$credentials`, `$signature`, `$waiterFactory`

### Properties inherited from Guzzle\Service\Client

`$commandFactory`, `$inflector`, `$resourceIteratorFactory`, `$serviceDescription`

### Properties inherited from Guzzle\Http\Client

`$defaultHeaders`, `$requestFactory`, `$userAgent`

### Properties inherited from Guzzle\Common\AbstractHasDispatcher

`$eventDispatcher`