delete-db-instance-automated-backup¶

Description¶

Deletes automated backups using the DbiResourceId value of the source DB instance or the Amazon Resource Name (ARN) of the automated backups.

Synopsis¶

  delete-db-instance-automated-backup
[--dbi-resource-id <value>]
[--db-instance-automated-backups-arn <value>]
[--cli-input-json | --cli-input-yaml]
[--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 Amazon Web Services Region.

--db-instance-automated-backups-arn (string)

The Amazon Resource Name (ARN) of the automated backups to delete, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE .

This setting doesn’t apply to RDS Custom.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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.

Examples¶

To delete a replicated automated backup from a Region

The following delete-db-instance-automated-backup example deletes the automated backup with the specified Amazon Resource Name (ARN).

aws rds delete-db-instance-automated-backup \
    --db-instance-automated-backups-arn "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example"

Output:

{
    "DBInstanceAutomatedBackup": {
        "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db",
        "DbiResourceId": "db-JKIB2GFQ5RV7REPLZA4EXAMPLE",
        "Region": "us-east-1",
        "DBInstanceIdentifier": "new-orcl-db",
        "RestoreWindow": {},
        "AllocatedStorage": 20,
        "Status": "deleting",
        "Port": 1521,
        "AvailabilityZone": "us-east-1b",
        "VpcId": "vpc-########",
        "InstanceCreateTime": "2020-12-04T15:28:31Z",
        "MasterUsername": "admin",
        "Engine": "oracle-se2",
        "EngineVersion": "12.1.0.2.v21",
        "LicenseModel": "bring-your-own-license",
        "OptionGroupName": "default:oracle-se2-12-1",
        "Encrypted": false,
        "StorageType": "gp2",
        "IAMDatabaseAuthenticationEnabled": false,
        "BackupRetentionPeriod": 7,
        "DBInstanceAutomatedBackupsArn": "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example"
    }
}

For more information, see Deleting replicated backups in the Amazon RDS User Guide.

Output¶

DBInstanceAutomatedBackup -> (structure)

An automated backup of a DB instance. 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 backups.

DbiResourceId -> (string)

The identifier for the source DB instance, which can’t be changed and which is unique to an Amazon Web Services Region.

Region -> (string)

The Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services KMS key ID for an automated backup.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS 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 Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

BackupRetentionPeriod -> (integer)

The retention period for the automated backups.

DBInstanceAutomatedBackupsArn -> (string)

The Amazon Resource Name (ARN) for the replicated automated backups.

DBInstanceAutomatedBackupsReplications -> (list)

The list of replications to different Amazon Web Services Regions associated with the automated backup.

(structure)

Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties.

DBInstanceAutomatedBackupsArn -> (string)

The Amazon Resource Name (ARN) of the replicated automated backups.

Table of Contents

Feedback

User Guide