You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Neptune::Types::ModifyDBClusterMessage

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ModifyDBClusterMessage as input to an Aws::Client method, you can use a vanilla Hash:

{
  db_cluster_identifier: "String", # required
  new_db_cluster_identifier: "String",
  apply_immediately: false,
  backup_retention_period: 1,
  db_cluster_parameter_group_name: "String",
  vpc_security_group_ids: ["String"],
  port: 1,
  master_user_password: "String",
  option_group_name: "String",
  preferred_backup_window: "String",
  preferred_maintenance_window: "String",
  enable_iam_database_authentication: false,
  cloudwatch_logs_export_configuration: {
    enable_log_types: ["String"],
    disable_log_types: ["String"],
  },
  engine_version: "String",
  deletion_protection: false,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#apply_immediately ⇒ Boolean

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 the NewDBClusterIdentifier and MasterUserPassword values. If you set the ApplyImmediately parameter value to false, then 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

Returns:

  • (Boolean) —

    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.

#backup_retention_period ⇒ Integer

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

^

Returns:

  • (Integer) —

    The number of days for which automated backups are retained.

#cloudwatch_logs_export_configuration ⇒ Types::CloudwatchLogsExportConfiguration

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.

Returns:

#db_cluster_identifier ⇒ String

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

Constraints:

  • Must match the identifier of an existing DBCluster.

^

Returns:

  • (String) —

    The DB cluster identifier for the cluster being modified.

#db_cluster_parameter_group_name ⇒ String

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

Returns:

  • (String) —

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

#deletion_protection ⇒ Boolean

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.

Returns:

  • (Boolean) —

    A value that indicates whether the DB cluster has deletion protection enabled.

#enable_iam_database_authentication ⇒ Boolean

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

Returns:

  • (Boolean) —

    True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

#engine_version ⇒ String

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, or call DescribeDBEngineVersions.

Returns:

  • (String) —

    The version number of the database engine to which you want to upgrade.

#master_user_password ⇒ String

The new password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".

Constraints: Must contain from 8 to 41 characters.

Returns:

  • (String) —

    The new password for the master database user.

#new_db_cluster_identifier ⇒ String

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

Returns:

  • (String) —

    The new DB cluster identifier for the DB cluster when renaming a DB cluster.

#option_group_name ⇒ String

(Not supported by Neptune)

Returns:

  • (String) —

    (Not supported by Neptune).

#port ⇒ Integer

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.

Returns:

  • (Integer) —

    The port number on which the DB cluster accepts connections.

#preferred_backup_window ⇒ String

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 AWS 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.

Returns:

  • (String) —

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

#preferred_maintenance_window ⇒ String

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 AWS Region, occurring on a random day of the week.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

Returns:

  • (String) —

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

#vpc_security_group_ids ⇒ Array<String>

A list of VPC security groups that the DB cluster will belong to.

Returns:

  • (Array<String>) —

    A list of VPC security groups that the DB cluster will belong to.