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