Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . rds ]

delete-db-instance-automated-backup

Description

Deletes automated backups based on the source instance's DbiResourceId value or the restorable instance's resource ID.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  delete-db-instance-automated-backup
--dbi-resource-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--dbi-resource-id (string)

The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

DBInstanceAutomatedBackup -> (structure)

An automated backup of a DB instance. It it consists of system backups, transaction logs, and the database instance properties that existed at the time you deleted the source instance.

DBInstanceArn -> (string)

The Amazon Resource Name (ARN) for the automated backup.

DbiResourceId -> (string)

The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.

Region -> (string)

The AWS Region associated with the automated backup.

DBInstanceIdentifier -> (string)

The customer id of the instance that is/was associated with the automated backup.

RestoreWindow -> (structure)

Earliest and latest time an instance can be restored to.

EarliestTime -> (timestamp)

The earliest time you can restore an instance to.

LatestTime -> (timestamp)

The latest time you can restore an instance to.

AllocatedStorage -> (integer)

Specifies the allocated storage size in gibibytes (GiB).

Status -> (string)

Provides a list of status information for an automated backup:

  • active - automated backups for current instances
  • retained - automated backups for deleted instances
  • creating - automated backups that are waiting for the first automated snapshot to be available.

Port -> (integer)

The port number that the automated backup used for connections.

Default: Inherits from the source DB instance

Valid Values: 1150-65535

AvailabilityZone -> (string)

The Availability Zone that the automated backup was created in. For information on AWS Regions and Availability Zones, see Regions and Availability Zones .

VpcId -> (string)

Provides the VPC ID associated with the DB instance

InstanceCreateTime -> (timestamp)

Provides the date and time that the DB instance was created.

MasterUsername -> (string)

The license model of an automated backup.

Engine -> (string)

The name of the database engine for this automated backup.

EngineVersion -> (string)

The version of the database engine for the automated backup.

LicenseModel -> (string)

License model information for the automated backup.

Iops -> (integer)

The IOPS (I/O operations per second) value for the automated backup.

OptionGroupName -> (string)

The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used.

TdeCredentialArn -> (string)

The ARN from the key store with which the automated backup is associated for TDE encryption.

Encrypted -> (boolean)

Specifies whether the automated backup is encrypted.

StorageType -> (string)

Specifies the storage type associated with the automated backup.

KmsKeyId -> (string)

The AWS KMS key ID for an automated backup. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

Timezone -> (string)

The time zone of the automated backup. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.

IAMDatabaseAuthenticationEnabled -> (boolean)

True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.