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

Class: Aws::RDS::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,
  backtrack_window: 1,
  cloudwatch_logs_export_configuration: {
    enable_log_types: ["String"],
    disable_log_types: ["String"],
  },
  engine_version: "String",
  allow_major_version_upgrade: false,
  db_instance_parameter_group_name: "String",
  domain: "String",
  domain_iam_role_name: "String",
  scaling_configuration: {
    min_capacity: 1,
    max_capacity: 1,
    auto_pause: false,
    seconds_until_auto_pause: 1,
    timeout_action: "String",
  },
  deletion_protection: false,
  enable_http_endpoint: false,
  copy_tags_to_snapshot: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#allow_major_version_upgradeBoolean

A value that indicates whether major version upgrades are allowed.

Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster\'s current version.

Returns:

  • (Boolean)

    A value that indicates whether major version upgrades are allowed.

#apply_immediatelyBoolean

A value that indicates 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 disabled, changes to the DB cluster are applied during the next maintenance window.

The ApplyImmediately parameter only affects the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values. If the ApplyImmediately parameter is disabled, then changes to the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

By default, this parameter is disabled.

Returns:

  • (Boolean)

    A value that indicates 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.

#backtrack_windowInteger

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

Default: 0

Constraints:

  • If specified, this value must be set to a number from 0 to 259,200 (72 hours).

^

Returns:

  • (Integer)

    The target backtrack window, in seconds.

#backup_retention_periodInteger

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_configurationTypes::CloudwatchLogsExportConfiguration

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

Returns:

#copy_tags_to_snapshotBoolean

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.

Returns:

  • (Boolean)

    A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster.

#db_cluster_identifierString

The DB cluster identifier for the cluster being modified. This parameter isn\'t case-sensitive.

Constraints: This identifier must match the identifier of an existing DB cluster.

Returns:

  • (String)

    The DB cluster identifier for the cluster being modified.

#db_cluster_parameter_group_nameString

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.

#db_instance_parameter_group_nameString

The name of the DB parameter group to apply to all instances of the DB cluster.

When you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB cluster isn\'t rebooted automatically. Also, parameter changes aren\'t applied during the next maintenance window but instead are applied immediately.

Default: The existing name setting

Constraints:

  • The DB parameter group must be in the same DB parameter group family as this DB cluster.

  • The DBInstanceParameterGroupName parameter is only valid in combination with the AllowMajorVersionUpgrade parameter.

Returns:

  • (String)

    The name of the DB parameter group to apply to all instances of the DB cluster.

#deletion_protectionBoolean

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.

#domainString

The Active Directory directory ID to move the DB cluster to. Specify none to remove the cluster from its current domain. The domain must be created prior to this operation.

Returns:

  • (String)

    The Active Directory directory ID to move the DB cluster to.

#domain_iam_role_nameString

Specify the name of the IAM role to be used when making API calls to the Directory Service.

Returns:

  • (String)

    Specify the name of the IAM role to be used when making API calls to the Directory Service.

#enable_http_endpointBoolean

A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.

When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.

For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.

Returns:

  • (Boolean)

    A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster.

#enable_iam_database_authenticationBoolean

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

For more information, see IAM Database Authentication in the Amazon Aurora User Guide.

Returns:

  • (Boolean)

    A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.

#engine_versionString

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 ApplyImmediately is enabled.

To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:

aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for aurora-postgresql, use the following command:

aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"

Returns:

  • (String)

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

#master_user_passwordString

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_identifierString

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

  • Can\'t 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_nameString

A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter doesn\'t result in an outage except in the following case, and the change is applied during the next maintenance window unless the ApplyImmediately is enabled for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

Permanent options can\'t be removed from an option group. The option group can\'t be removed from a DB cluster once it is associated with a DB cluster.

Returns:

  • (String)

    A value that indicates that the DB cluster should be associated with the specified option group.

#portInteger

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_windowString

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. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

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_windowString

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. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

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

#scaling_configurationTypes::ScalingConfiguration

The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.

Returns:

#vpc_security_group_idsArray<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.