Skip to content

RDS  >  Operations  >  start_db_instance

start_db_instance

Operation

start_db_instance async 

start_db_instance(input: StartDBInstanceInput, plugins: list[Plugin] | None = None) -> StartDBInstanceOutput

Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance 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.

Parameters:

Name Type Description Default
input StartDBInstanceInput

An instance of StartDBInstanceInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
StartDBInstanceOutput

An instance of StartDBInstanceOutput.

Input

StartDBInstanceInput dataclass

Bases: _SerdeShape

Dataclass for StartDBInstanceInput structure.

Attributes

db_capacity_reservation_identifier class-attribute instance-attribute 
db_capacity_reservation_identifier: str | None = ...

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.

db_instance_identifier class-attribute instance-attribute 
db_instance_identifier: str | None = ...

The user-supplied instance identifier.

Output

StartDBInstanceOutput dataclass

Bases: _SerdeShape

Dataclass for StartDBInstanceOutput structure.

Attributes

db_instance class-attribute instance-attribute 
db_instance: DBInstance | None = ...

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.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.