AWS API Changes

2018/09/20 - Amazon Relational Database Service - 2 new api methods

Changes This launch enables RDS start-db-cluster and stop-db-cluster. Stopping and starting Amazon Aurora clusters helps you manage costs for development and test environments. You can temporarily stop all the DB instances in your cluster, instead of setting up and tearing down all the DB instances each time that you use the cluster.

StopDBCluster (new)

Link ¶

Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's metadata, including its endpoints and DB parameter groups. Aurora also retains the transaction logs so you can do a point-in-time restore if necessary.

See also: AWS API Documentation

Request Syntax

client.stop_db_cluster(
    DBClusterIdentifier='string'
)

type DBClusterIdentifier

string

param DBClusterIdentifier

[REQUIRED]

The DB cluster identifier of the Amazon Aurora DB cluster to be stopped. This parameter is stored as a lowercase string.

rtype

dict

returns

Response Syntax

{
    'DBCluster': {
        'AllocatedStorage': 123,
        'AvailabilityZones': [
            'string',
        ],
        'BackupRetentionPeriod': 123,
        'CharacterSetName': 'string',
        'DatabaseName': 'string',
        'DBClusterIdentifier': 'string',
        'DBClusterParameterGroup': 'string',
        'DBSubnetGroup': 'string',
        'Status': 'string',
        'PercentProgress': 'string',
        'EarliestRestorableTime': datetime(2015, 1, 1),
        'Endpoint': 'string',
        'ReaderEndpoint': 'string',
        'MultiAZ': True|False,
        'Engine': 'string',
        'EngineVersion': 'string',
        'LatestRestorableTime': datetime(2015, 1, 1),
        'Port': 123,
        'MasterUsername': 'string',
        'DBClusterOptionGroupMemberships': [
            {
                'DBClusterOptionGroupName': 'string',
                'Status': 'string'
            },
        ],
        'PreferredBackupWindow': 'string',
        'PreferredMaintenanceWindow': 'string',
        'ReplicationSourceIdentifier': 'string',
        'ReadReplicaIdentifiers': [
            'string',
        ],
        'DBClusterMembers': [
            {
                'DBInstanceIdentifier': 'string',
                'IsClusterWriter': True|False,
                'DBClusterParameterGroupStatus': 'string',
                'PromotionTier': 123
            },
        ],
        'VpcSecurityGroups': [
            {
                'VpcSecurityGroupId': 'string',
                'Status': 'string'
            },
        ],
        'HostedZoneId': 'string',
        'StorageEncrypted': True|False,
        'KmsKeyId': 'string',
        'DbClusterResourceId': 'string',
        'DBClusterArn': 'string',
        'AssociatedRoles': [
            {
                'RoleArn': 'string',
                'Status': 'string',
                'FeatureName': 'string'
            },
        ],
        'IAMDatabaseAuthenticationEnabled': True|False,
        'CloneGroupId': 'string',
        'ClusterCreateTime': datetime(2015, 1, 1),
        'EarliestBacktrackTime': datetime(2015, 1, 1),
        'BacktrackWindow': 123,
        'BacktrackConsumedChangeRecords': 123,
        'EnabledCloudwatchLogsExports': [
            'string',
        ],
        'Capacity': 123,
        'EngineMode': 'string',
        'ScalingConfigurationInfo': {
            'MinCapacity': 123,
            'MaxCapacity': 123,
            'AutoPause': True|False,
            'SecondsUntilAutoPause': 123
        }
    }
}

Response Structure

(dict) --
- DBCluster (dict) --
  
  Contains the details of an Amazon Aurora DB cluster.
  
  This data type is used as a response element in the DescribeDBClusters , StopDBCluster , and StartDBCluster actions.
  - AllocatedStorage (integer) --
    
    For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size is not fixed, but instead automatically adjusts as needed.
  - AvailabilityZones (list) --
    
    Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
    - (string) --
  - BackupRetentionPeriod (integer) --
    
    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 (datetime) --
    
    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.
  - ReaderEndpoint (string) --
    
    The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.
    
    If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
  - MultiAZ (boolean) --
    
    Specifies whether the DB cluster has instances in multiple Availability Zones.
  - Engine (string) --
    
    Provides the name of the database engine to be used for this DB cluster.
  - EngineVersion (string) --
    
    Indicates the database engine version.
  - LatestRestorableTime (datetime) --
    
    Specifies the latest time to which a database can be restored with point-in-time restore.
  - Port (integer) --
    
    Specifies the port that the database engine is listening on.
  - MasterUsername (string) --
    
    Contains the master username for the DB cluster.
  - DBClusterOptionGroupMemberships (list) --
    
    Provides the list of option group memberships for this DB cluster.
    - (dict) --
      
      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).
  - ReplicationSourceIdentifier (string) --
    
    Contains the identifier of the source DB cluster if this DB cluster is a Read Replica.
  - ReadReplicaIdentifiers (list) --
    
    Contains one or more identifiers of the Read Replicas associated with this DB cluster.
    - (string) --
  - DBClusterMembers (list) --
    
    Provides the list of instances that make up the DB cluster.
    - (dict) --
      
      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 (boolean) --
        
        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.
      - PromotionTier (integer) --
        
        A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
  - VpcSecurityGroups (list) --
    
    Provides a list of VPC security groups that the DB cluster belongs to.
    - (dict) --
      
      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.
  - StorageEncrypted (boolean) --
    
    Specifies whether the DB cluster is encrypted.
  - KmsKeyId (string) --
    
    If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster.
  - DbClusterResourceId (string) --
    
    The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
  - DBClusterArn (string) --
    
    The Amazon Resource Name (ARN) for the DB cluster.
  - AssociatedRoles (list) --
    
    Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.
    - (dict) --
      
      Describes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster.
      - RoleArn (string) --
        
        The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
      - Status (string) --
        
        Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:
        
        ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other AWS services on your behalf.
        
        PENDING - the IAM role ARN is being associated with the DB cluster.
        
        INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other AWS services on your behalf.
      - FeatureName (string) --
  - IAMDatabaseAuthenticationEnabled (boolean) --
    
    True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
  - CloneGroupId (string) --
    
    Identifies the clone group to which the DB cluster is associated.
  - ClusterCreateTime (datetime) --
    
    Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
  - EarliestBacktrackTime (datetime) --
    
    The earliest time to which a DB cluster can be backtracked.
  - BacktrackWindow (integer) --
    
    The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.
  - BacktrackConsumedChangeRecords (integer) --
    
    The number of change records stored for Backtrack.
  - EnabledCloudwatchLogsExports (list) --
    
    A list of log types that this DB cluster is configured to export to CloudWatch Logs.
    
    Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.
    - (string) --
  - Capacity (integer) --
  - EngineMode (string) --
    
    The DB engine mode of the DB cluster, either provisioned , serverless , or parallelquery .
  - ScalingConfigurationInfo (dict) --
    
    Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.
    
    For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide .
    - MinCapacity (integer) --
      
      The maximum capacity for the Aurora DB cluster in serverless DB engine mode.
    - MaxCapacity (integer) --
      
      The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
    - AutoPause (boolean) --
      
      A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
    - SecondsUntilAutoPause (integer) --
      
      The remaining amount of time, in seconds, before the Aurora DB cluster in serverless mode is paused. A DB cluster can be paused only when it's idle (it has no connections).

StartDBCluster (new)