View a markdown version of this page

StartDBInstance - Amazon Relational Database Service
Request ParametersResponse ElementsErrorsExamplesSee Also

StartDBInstance

Starts an Amazon RDS DB instance that was stopped using the AWS console, the stop-db-instance AWS CLI command, or the StopDBInstance operation.

For more information, see Starting an Amazon RDS DB instance That Was Previously Stopped in the Amazon RDS User Guide.

Note

This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora DB clusters, use StartDBCluster instead.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

DBInstanceIdentifier

The user-supplied instance identifier.

Type: String

Required: Yes

DBCapacityReservationIdentifier

The identifier or the name of the DB capacity reservation for the DB instance to use after it starts. You can specify the identifier, which has the prefix dbcr-, or the reservation name.

Specify this parameter when the DB instance stopped using a reservation, or when you want the DB instance to use a different reservation.

If you omit this parameter, and the DB instance kept a DB capacity reservation when it stopped, Amazon RDS starts the DB instance in that reservation.

If that reservation is deleted, ended, or cancelled, the DB instance still starts. Amazon RDS starts the DB instance outside the reservation, on unreserved capacity, and it charges on-demand prices for the DB instance.

If that reservation has no available capacity in the Availability Zone of the DB instance, the request fails. Amazon RDS doesn't start the DB instance, and it doesn't wait for capacity in that Availability Zone. Specify a reservation that has available capacity in that Availability Zone, or retry the request after the reservation has available capacity.

Constraints:

  • The reservation must be in the active state.

  • The reservation must reserve capacity for the DB instance class and the engine of the DB instance.

  • The reservation must cover the Availability Zone of the DB instance, and it must have available capacity in that Availability Zone.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: [a-z](?:-?[a-z0-9]+){0,15}

Required: No

Response Elements

The following element is returned by the service.

DBInstance

Contains the details of an Amazon RDS DB instance.

This data type is used as a response element in the operations CreateDBInstance, CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, ModifyDBInstance, PromoteReadReplica, RebootDBInstance, RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3, RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance.

Type: DBInstance object

Errors

For information about the errors that are common to all actions, see Common Error Types.

AuthorizationNotFound

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

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

HTTP Status Code: 404

DBCapacityReservationNotFound

DBCapacityReservationIdentifier doesn't refer to an existing DB capacity reservation.

HTTP Status Code: 404

DBClusterNotFoundFault

DBClusterIdentifier doesn't refer to an existing DB cluster.

HTTP Status Code: 404

DBInstanceNotFound

DBInstanceIdentifier doesn't refer to an existing DB instance.

HTTP Status Code: 404

DBSubnetGroupDoesNotCoverEnoughAZs

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

HTTP Status Code: 400

DBSubnetGroupNotFoundFault

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

HTTP Status Code: 404

InsufficientDBInstanceCapacity

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

HTTP Status Code: 400

InvalidDBCapacityReservationState

The DB capacity reservation isn't in a valid state.

HTTP Status Code: 400

InvalidDBClusterStateFault

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

HTTP Status Code: 400

InvalidDBInstanceState

The DB instance isn't in a valid state.

HTTP Status Code: 400

InvalidSubnet

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

HTTP Status Code: 400

InvalidVPCNetworkStateFault

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

HTTP Status Code: 400

KMSKeyNotAccessibleFault

An error occurred accessing an AWS KMS key.

HTTP Status Code: 400

VpcEncryptionControlViolation

The operation violates VPC encryption control settings. Make sure that your DB instance type supports the Nitro encryption-in-transit capability, or modify your VPC's encryption controls to not enforce encryption-in-transit.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of StartDBInstance.

Sample Request

https://rds.amazonaws.com/
    ?Action=StartDBInstance
    &DBInstanceIdentifier=mydbinstance
    &SignatureMethod=HmacSHA256
    &SignatureVersion=4
    &Version=2014-10-31
    &X-Amz-Algorithm=AWS4-HMAC-SHA256
    &X-Amz-Credential=AKIADQKE4EXAMPLE/20131016/us-west-1/rds/aws4_request
    &X-Amz-Date=20131016T233051Z
    &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
    &X-Amz-Signature=6e25c542bf96fe24b28c12976ec92d2f856ab1d2a158e21c35441a736e4fde2b

Sample Response

<StartDBInstanceResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <StartDBInstanceResult>
    <DBInstance>
      <AllocatedStorage>100</AllocatedStorage>
      <EnabledCloudwatchLogsExports>
        <member>alert</member>
        <member>audit</member>
        <member>listener</member>
        <member>trace</member>
      </EnabledCloudwatchLogsExports>
      <AssociatedRoles/>
      <DBParameterGroups>
        <DBParameterGroup>
          <DBParameterGroupName>default.oracle-ee-19</DBParameterGroupName>
          <ParameterApplyStatus>in-sync</ParameterApplyStatus>
        </DBParameterGroup>
      </DBParameterGroups>
      <AvailabilityZone>us-east-1b</AvailabilityZone>
      <DBSecurityGroups/>
      <Iops>1000</Iops>
      <PerformanceInsightsKMSKeyId>arn:aws:kms:us-east-1:123456789012:key/87c22544-4cac-4640-99de-cfdaa8760ad0</PerformanceInsightsKMSKeyId>
      <EnhancedMonitoringResourceArn>arn:aws:logs:us-east-1:123456789012:log-group:RDSOSMetrics:log-stream:db-LENX3LYCR6OKTGWZZEXAMPLE</EnhancedMonitoringResourceArn>
      <PerformanceInsightsRetentionPeriod>7</PerformanceInsightsRetentionPeriod>
      <EngineVersion>19.0.0.0.ru-2019-10.rur-2019-10.r1</EngineVersion>
      <MasterUsername>admin</MasterUsername>
      <InstanceCreateTime>2019-11-23T17:27:58.540Z</InstanceCreateTime>
      <DBInstanceClass>db.t3.medium</DBInstanceClass>
      <HttpEndpointEnabled>false</HttpEndpointEnabled>
      <ReadReplicaDBInstanceIdentifiers/>
      <CustomerOwnedIpEnabled>false</CustomerOwnedIpEnabled>
      <MonitoringInterval>60</MonitoringInterval>
      <DBInstanceStatus>starting</DBInstanceStatus>
      <BackupRetentionPeriod>0</BackupRetentionPeriod>
      <OptionGroupMemberships>
        <OptionGroupMembership>
          <OptionGroupName>default:oracle-ee-19</OptionGroupName>
          <Status>in-sync</Status>
        </OptionGroupMembership>
      </OptionGroupMemberships>
      <CACertificateIdentifier>rds-ca-2019</CACertificateIdentifier>
      <DbInstancePort>0</DbInstancePort>
      <DbiResourceId>db-LENX3LYCR6OKTGWZEXAMPLE</DbiResourceId>
      <PreferredBackupWindow>08:31-09:01</PreferredBackupWindow>
      <DeletionProtection>false</DeletionProtection>
      <DBInstanceIdentifier>mydbinstance</DBInstanceIdentifier>
      <DBInstanceArn>arn:aws:rds:us-east-1:123456789012:db:mydbinstance</DBInstanceArn>
      <Endpoint>
        <HostedZoneId>Z2R2ITUGPM61AM</HostedZoneId>
        <Address>mydbinstance.123example.us-east-1.rds.amazonaws.com</Address>
        <Port>1521</Port>
      </Endpoint>
      <Engine>oracle-ee</Engine>
      <MaxAllocatedStorage>1000</MaxAllocatedStorage>
      <PubliclyAccessible>true</PubliclyAccessible>
      <IAMDatabaseAuthenticationEnabled>false</IAMDatabaseAuthenticationEnabled>
      <PerformanceInsightsEnabled>true</PerformanceInsightsEnabled>
      <DBName>DBOR</DBName>
      <MultiAZ>false</MultiAZ>
      <DomainMemberships/>
      <CharacterSetName>AL32UTF8</CharacterSetName>
      <MonitoringRoleArn>arn:aws:iam::123456789012:role/rds-monitoring-role</MonitoringRoleArn>
      <StorageEncrypted>false</StorageEncrypted>
      <DBSubnetGroup>
        <VpcId>vpc-67a0bc1c</VpcId>
        <Subnets>
          <Subnet>
            <SubnetIdentifier>subnet-example1</SubnetIdentifier>
            <SubnetStatus>Active</SubnetStatus>
            <SubnetOutpost/>
            <SubnetAvailabilityZone>
              <Name>us-east-1a</Name>
            </SubnetAvailabilityZone>
          </Subnet>
          <Subnet>
            <SubnetIdentifier>subnet-example12</SubnetIdentifier>
            <SubnetStatus>Active</SubnetStatus>
            <SubnetOutpost/>
            <SubnetAvailabilityZone>
              <Name>us-east-1e</Name>
            </SubnetAvailabilityZone>
          </Subnet>
          <Subnet>
            <SubnetIdentifier>subnet-example3</SubnetIdentifier>
            <SubnetStatus>Active</SubnetStatus>
            <SubnetOutpost/>
            <SubnetAvailabilityZone>
              <Name>us-east-1f</Name>
            </SubnetAvailabilityZone>
          </Subnet>
          <Subnet>
            <SubnetIdentifier>subnet-example4</SubnetIdentifier>
            <SubnetStatus>Active</SubnetStatus>
            <SubnetOutpost/>
            <SubnetAvailabilityZone>
              <Name>us-east-1d</Name>
            </SubnetAvailabilityZone>
          </Subnet>
          <Subnet>
            <SubnetIdentifier>subnet-example5</SubnetIdentifier>
            <SubnetStatus>Active</SubnetStatus>
            <SubnetOutpost/>
            <SubnetAvailabilityZone>
              <Name>us-east-1b</Name>
            </SubnetAvailabilityZone>
          </Subnet>
          <Subnet>
            <SubnetIdentifier>subnet-example6</SubnetIdentifier>
            <SubnetStatus>Active</SubnetStatus>
            <SubnetOutpost/>
            <SubnetAvailabilityZone>
              <Name>us-east-1c</Name>
            </SubnetAvailabilityZone>
          </Subnet>
        </Subnets>
        <SubnetGroupStatus>Complete</SubnetGroupStatus>
        <DBSubnetGroupDescription>Created from the RDS Management Console</DBSubnetGroupDescription>
        <DBSubnetGroupName>default-vpc-67a0bc1c</DBSubnetGroupName>
      </DBSubnetGroup>
      <TagList>
        <Tag>
          <Value>hr</Value>
          <Key>department</Key>
        </Tag>
        <Tag>
          <Value>rds</Value>
          <Key>type</Key>
        </Tag>
      </TagList>
      <VpcSecurityGroups>
        <VpcSecurityGroupMembership>
          <VpcSecurityGroupId>sg-0417e54f</VpcSecurityGroupId>
          <Status>active</Status>
        </VpcSecurityGroupMembership>
      </VpcSecurityGroups>
      <NcharCharacterSetName>AL16UTF16</NcharCharacterSetName>
      <LicenseModel>bring-your-own-license</LicenseModel>
      <PendingModifiedValues/>
      <PreferredMaintenanceWindow>sun:05:12-sun:05:42</PreferredMaintenanceWindow>
      <StorageType>io1</StorageType>
      <AutoMinorVersionUpgrade>false</AutoMinorVersionUpgrade>
      <CopyTagsToSnapshot>false</CopyTagsToSnapshot>
    </DBInstance>
  </StartDBInstanceResult>
  <ResponseMetadata>
    <RequestId>9d4d8c94-7b81-4a64-8518-EXAMPLE</RequestId>
  </ResponseMetadata>
</StartDBInstanceResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: