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

NAME

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

DESCRIPTION

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

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

SYNOPSIS

my $rds = Paws->service('DocDB');
my $FailoverDBClusterResult = $rds->FailoverDBCluster(
  DBClusterIdentifier        => 'MyString',    # OPTIONAL
  TargetDBInstanceIdentifier => 'MyString',    # OPTIONAL
);

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

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

ATTRIBUTES

DBClusterIdentifier => Str

A cluster identifier to force a failover for. This parameter is not case sensitive.

Constraints:

  • Must match the identifier of an existing DBCluster.

TargetDBInstanceIdentifier => Str

The name of the instance to promote to the primary instance.

You must specify the instance identifier for an Amazon DocumentDB replica in the cluster. For example, mydbcluster-replica1.

SEE ALSO

This class forms part of Paws, documenting arguments for method FailoverDBCluster 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