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

NAME

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

DESCRIPTION

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

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

SYNOPSIS

my $rds = Paws->service('DocDB');
my $ModifyDBClusterResult = $rds->ModifyDBCluster(
  DBClusterIdentifier               => 'MyString',
  ApplyImmediately                  => 1,            # OPTIONAL
  BackupRetentionPeriod             => 1,            # OPTIONAL
  CloudwatchLogsExportConfiguration => {
    DisableLogTypes => [ 'MyString', ... ],          # OPTIONAL
    EnableLogTypes  => [ 'MyString', ... ],          # OPTIONAL
  },    # OPTIONAL
  DBClusterParameterGroupName => 'MyString',             # OPTIONAL
  DeletionProtection          => 1,                      # OPTIONAL
  EngineVersion               => 'MyString',             # OPTIONAL
  MasterUserPassword          => 'MyString',             # OPTIONAL
  NewDBClusterIdentifier      => 'MyString',             # OPTIONAL
  Port                        => 1,                      # OPTIONAL
  PreferredBackupWindow       => 'MyString',             # OPTIONAL
  PreferredMaintenanceWindow  => 'MyString',             # OPTIONAL
  VpcSecurityGroupIds         => [ 'MyString', ... ],    # OPTIONAL
);

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

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

ATTRIBUTES

ApplyImmediately => Bool

A value that specifies whether the changes in this request and any pending changes are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cluster. If this parameter is set to false, changes to the cluster are applied during the next maintenance window.

The ApplyImmediately parameter affects only the NewDBClusterIdentifier and MasterUserPassword values. If you set this parameter value to false, the changes to the NewDBClusterIdentifier and MasterUserPassword values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

Default: false

BackupRetentionPeriod => Int

The number of days for which automated backups are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

  • Must be a value from 1 to 35.

CloudwatchLogsExportConfiguration => Paws::DocDB::CloudwatchLogsExportConfiguration

The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster. The EnableLogTypes and DisableLogTypes arrays determine which logs are exported (or not exported) to CloudWatch Logs.

REQUIRED DBClusterIdentifier => Str

The cluster identifier for the cluster that is being modified. This parameter is not case sensitive.

Constraints:

  • Must match the identifier of an existing DBCluster.

DBClusterParameterGroupName => Str

The name of the cluster parameter group to use for the cluster.

DeletionProtection => Bool

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

EngineVersion => Str

The version number of the database engine to which you want to upgrade. Modifying engine version is not supported on Amazon DocumentDB.

MasterUserPassword => Str

The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

Constraints: Must contain from 8 to 100 characters.

NewDBClusterIdentifier => Str

The new cluster identifier for the cluster when renaming a cluster. This value is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

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

Example: my-cluster2

Port => Int

The port number on which the cluster accepts connections.

Constraints: Must be a value from 1150 to 65535.

Default: The same port as the original cluster.

PreferredBackupWindow => Str

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each Region.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

PreferredMaintenanceWindow => Str

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

VpcSecurityGroupIds => ArrayRef[Str|Undef]

A list of virtual private cloud (VPC) security groups that the cluster will belong to.

SEE ALSO

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