NAME
Paws::Neptune::ModifyDBCluster - Arguments for method ModifyDBCluster on Paws::Neptune
DESCRIPTION
This class represents the parameters used for calling the method ModifyDBCluster on the Amazon Neptune 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('Neptune');
my $ModifyDBClusterResult = $rds->ModifyDBCluster(
DBClusterIdentifier => 'MyString',
ApplyImmediately => 1, # OPTIONAL
BackupRetentionPeriod => 1, # OPTIONAL
CloudwatchLogsExportConfiguration => {
DisableLogTypes => [ 'MyString', ... ], # OPTIONAL
EnableLogTypes => [ 'MyString', ... ], # OPTIONAL
}, # OPTIONAL
CopyTagsToSnapshot => 1, # OPTIONAL
DBClusterParameterGroupName => 'MyString', # OPTIONAL
DeletionProtection => 1, # OPTIONAL
EnableIAMDatabaseAuthentication => 1, # OPTIONAL
EngineVersion => 'MyString', # OPTIONAL
MasterUserPassword => 'MyString', # OPTIONAL
NewDBClusterIdentifier => 'MyString', # OPTIONAL
OptionGroupName => 'MyString', # OPTIONAL
Port => 1, # OPTIONAL
PreferredBackupWindow => 'MyString', # OPTIONAL
PreferredMaintenanceWindow => 'MyString', # OPTIONAL
VpcSecurityGroupIds => [ 'MyString', ... ], # OPTIONAL
);
# Results:
my $DBCluster = $ModifyDBClusterResult->DBCluster;
# Returns a L<Paws::Neptune::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 modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is set to false, changes to the DB cluster are applied during the next maintenance window.
The ApplyImmediately parameter only affects NewDBClusterIdentifier values. If you set the ApplyImmediately parameter value to false, then changes to NewDBClusterIdentifier 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::Neptune::CloudwatchLogsExportConfiguration
The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.
CopyTagsToSnapshot => Bool
If set to true, tags are copied to any snapshot of the DB cluster that is created.
REQUIRED DBClusterIdentifier => Str
The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive.
Constraints:
Must match the identifier of an existing DBCluster.
DBClusterParameterGroupName => Str
The name of the DB cluster parameter group to use for the DB cluster.
DeletionProtection => Bool
A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
EnableIAMDatabaseAuthentication => Bool
True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
Default: false
EngineVersion => Str
The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true.
For a list of valid engine versions, see Engine Releases for Amazon Neptune (https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases.html), or call DescribeDBEngineVersions (https://docs.aws.amazon.com/neptune/latest/userguide/api-other-apis.html#DescribeDBEngineVersions).
MasterUserPassword => Str
Not supported by Neptune.
NewDBClusterIdentifier => Str
The new DB cluster identifier for the DB cluster when renaming a DB 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
OptionGroupName => Str
Not supported by Neptune.
Port => Int
The port number on which the DB cluster accepts connections.
Constraints: Value must be 1150-65535
Default: The same port as the original DB 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 Amazon 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 Amazon 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 VPC security groups that the DB cluster will belong to.
SEE ALSO
This class forms part of Paws, documenting arguments for method ModifyDBCluster in Paws::Neptune
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