« blib/lib/Paws/RDS/DeleteDBClusterSnapshotResult.pm
↑ Summary
blib/lib/Paws/RDS/DeleteDBInstanceAutomatedBackup.pm »
| 1 | |||
| 2 | package Paws::RDS::DeleteDBInstance; | ||
| 3 | use Moose; | ||
| 4 | has DBInstanceIdentifier => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has DeleteAutomatedBackups => (is => 'ro', isa => 'Bool'); | ||
| 6 | has FinalDBSnapshotIdentifier => (is => 'ro', isa => 'Str'); | ||
| 7 | has SkipFinalSnapshot => (is => 'ro', isa => 'Bool'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DeleteDBInstance'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::DeleteDBInstanceResult'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'DeleteDBInstanceResult'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::RDS::DeleteDBInstance - Arguments for method DeleteDBInstance on L<Paws::RDS> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method DeleteDBInstance on the | ||
| 25 | L<Amazon Relational Database Service|Paws::RDS> service. Use the attributes of this class | ||
| 26 | as arguments to method DeleteDBInstance. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DeleteDBInstance. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $rds = Paws->service('RDS'); | ||
| 33 | # To delete a DB instance. | ||
| 34 | # This example deletes the specified DB instance. | ||
| 35 | my $DeleteDBInstanceResult = $rds->DeleteDBInstance( | ||
| 36 | 'DBInstanceIdentifier' => 'mymysqlinstance', | ||
| 37 | 'SkipFinalSnapshot' => 1 | ||
| 38 | ); | ||
| 39 | |||
| 40 | # Results: | ||
| 41 | my $DBInstance = $DeleteDBInstanceResult->DBInstance; | ||
| 42 | |||
| 43 | # Returns a L<Paws::RDS::DeleteDBInstanceResult> object. | ||
| 44 | |||
| 45 | 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. | ||
| 46 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/DeleteDBInstance> | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 B<REQUIRED> DBInstanceIdentifier => Str | ||
| 52 | |||
| 53 | The DB instance identifier for the DB instance to be deleted. This | ||
| 54 | parameter isn't case-sensitive. | ||
| 55 | |||
| 56 | Constraints: | ||
| 57 | |||
| 58 | =over | ||
| 59 | |||
| 60 | =item * | ||
| 61 | |||
| 62 | Must match the name of an existing DB instance. | ||
| 63 | |||
| 64 | =back | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head2 DeleteAutomatedBackups => Bool | ||
| 70 | |||
| 71 | A value that indicates whether to remove automated backups immediately | ||
| 72 | after the DB instance is deleted. This parameter isn't case-sensitive. | ||
| 73 | The default is to remove automated backups immediately after the DB | ||
| 74 | instance is deleted. | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head2 FinalDBSnapshotIdentifier => Str | ||
| 79 | |||
| 80 | The C<DBSnapshotIdentifier> of the new C<DBSnapshot> created when the | ||
| 81 | C<SkipFinalSnapshot> parameter is disabled. | ||
| 82 | |||
| 83 | Specifying this parameter and also specifying to skip final DB snapshot | ||
| 84 | creation in SkipFinalShapshot results in an error. | ||
| 85 | |||
| 86 | Constraints: | ||
| 87 | |||
| 88 | =over | ||
| 89 | |||
| 90 | =item * | ||
| 91 | |||
| 92 | Must be 1 to 255 letters or numbers. | ||
| 93 | |||
| 94 | =item * | ||
| 95 | |||
| 96 | First character must be a letter. | ||
| 97 | |||
| 98 | =item * | ||
| 99 | |||
| 100 | Can't end with a hyphen or contain two consecutive hyphens. | ||
| 101 | |||
| 102 | =item * | ||
| 103 | |||
| 104 | Can't be specified when deleting a read replica. | ||
| 105 | |||
| 106 | =back | ||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | =head2 SkipFinalSnapshot => Bool | ||
| 112 | |||
| 113 | A value that indicates whether to skip the creation of a final DB | ||
| 114 | snapshot before the DB instance is deleted. If skip is specified, no DB | ||
| 115 | snapshot is created. If skip isn't specified, a DB snapshot is created | ||
| 116 | before the DB instance is deleted. By default, skip isn't specified, | ||
| 117 | and the DB snapshot is created. | ||
| 118 | |||
| 119 | When a DB instance is in a failure state and has a status of 'failed', | ||
| 120 | 'incompatible-restore', or 'incompatible-network', it can only be | ||
| 121 | deleted when skip is specified. | ||
| 122 | |||
| 123 | Specify skip when deleting a read replica. | ||
| 124 | |||
| 125 | The FinalDBSnapshotIdentifier parameter must be specified if skip isn't | ||
| 126 | specified. | ||
| 127 | |||
| 128 | |||
| 129 | |||
| 130 | |||
| 131 | =head1 SEE ALSO | ||
| 132 | |||
| 133 | This class forms part of L<Paws>, documenting arguments for method DeleteDBInstance in L<Paws::RDS> | ||
| 134 | |||
| 135 | =head1 BUGS and CONTRIBUTIONS | ||
| 136 | |||
| 137 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 138 | |||
| 139 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 140 | |||
| 141 | =cut | ||
| 142 |