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