/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::DocDB::DeleteDBCluster

NAME

Paws::DocDB::DeleteDBCluster - Arguments for method DeleteDBCluster on Paws::DocDB

DESCRIPTION

This class represents the parameters used for calling the method DeleteDBCluster on the Amazon DocumentDB with MongoDB compatibility service. Use the attributes of this class as arguments to method DeleteDBCluster.

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

SYNOPSIS

my $rds = Paws->service('DocDB');
my $DeleteDBClusterResult = $rds->DeleteDBCluster(
  DBClusterIdentifier       => 'MyString',
  FinalDBSnapshotIdentifier => 'MyString',    # OPTIONAL
  SkipFinalSnapshot         => 1,             # OPTIONAL
);

# Results:
my $DBCluster = $DeleteDBClusterResult->DBCluster;

# Returns a L<Paws::DocDB::DeleteDBClusterResult> 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/DeleteDBCluster

ATTRIBUTES

REQUIRED DBClusterIdentifier => Str

The cluster identifier for the cluster to be deleted. This parameter isn't case sensitive.

Constraints:

  • Must match an existing DBClusterIdentifier.

FinalDBSnapshotIdentifier => Str

The cluster snapshot identifier of the new cluster snapshot created when SkipFinalSnapshot is set to false.

Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.

Constraints:

  • Must be from 1 to 255 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

SkipFinalSnapshot => Bool

Determines whether a final cluster snapshot is created before the cluster is deleted. If true is specified, no cluster snapshot is created. If false is specified, a cluster snapshot is created before the DB cluster is deleted.

If SkipFinalSnapshot is false, you must specify a FinalDBSnapshotIdentifier parameter.

Default: false

SEE ALSO

This class forms part of Paws, documenting arguments for method DeleteDBCluster in Paws::DocDB

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