/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::RDS::DeleteDBInstance

NAME

Paws::RDS::DeleteDBInstance - Arguments for method DeleteDBInstance on Paws::RDS

DESCRIPTION

This class represents the parameters used for calling the method DeleteDBInstance on the Amazon Relational Database Service service. Use the attributes of this class as arguments to method DeleteDBInstance.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DeleteDBInstance.

SYNOPSIS

my $rds = Paws->service('RDS');
# To delete a DB instance.
# This example deletes the specified DB instance.
my $DeleteDBInstanceResult = $rds->DeleteDBInstance(
  'DBInstanceIdentifier' => 'mymysqlinstance',
  'SkipFinalSnapshot'    => 1
);

# Results:
my $DBInstance = $DeleteDBInstanceResult->DBInstance;

# Returns a L<Paws::RDS::DeleteDBInstanceResult> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/rds/DeleteDBInstance

ATTRIBUTES

REQUIRED DBInstanceIdentifier => Str

The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive.

Constraints:

  • Must match the name of an existing DB instance.

DeleteAutomatedBackups => Bool

A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.

FinalDBSnapshotIdentifier => Str

The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled.

Specifying this parameter and also specifying to skip final DB snapshot creation in SkipFinalShapshot results in an error.

Constraints:

  • Must be 1 to 255 letters or numbers.

  • First character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

  • Can't be specified when deleting a read replica.

SkipFinalSnapshot => Bool

A value that indicates whether to skip the creation of a final DB snapshot before the DB instance is deleted. If skip is specified, no DB snapshot is created. If skip isn't specified, a DB snapshot is created before the DB instance is deleted. By default, skip isn't specified, and the DB snapshot is created.

When a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when skip is specified.

Specify skip when deleting a read replica.

The FinalDBSnapshotIdentifier parameter must be specified if skip isn't specified.

SEE ALSO

This class forms part of Paws, documenting arguments for method DeleteDBInstance in Paws::RDS

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues