Class: Aws::RDS::Types::ModifyDBClusterMessage

Inherits:

Struct

Object
Struct
Aws::RDS::Types::ModifyDBClusterMessage

show all

Includes:: Structure

Defined in:: lib/aws-sdk-rds/types.rb

Overview

Note:

When making an API call, you may pass ModifyDBClusterMessage data as a 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",
  scaling_configuration: {
    min_capacity: 1,
    max_capacity: 1,
    auto_pause: false,
    seconds_until_auto_pause: 1,
  },
  deletion_protection: false,
  enable_http_endpoint: false,
}

Instance Attribute Summary collapse

#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.
#backtrack_window ⇒ Integer

The target backtrack window, in seconds.
#backup_retention_period ⇒ 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.
#db_cluster_identifier ⇒ 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.
#deletion_protection ⇒ Boolean

Indicates if the DB cluster has deletion protection enabled.
#enable_http_endpoint ⇒ Boolean

<note markdown=“1”> HTTP endpoint functionality is in beta for Aurora Serverless and is subject to change.
#enable_iam_database_authentication ⇒ 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.
#master_user_password ⇒ 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.
#option_group_name ⇒ String

A value that indicates that the DB cluster should be associated with the specified option group.
#port ⇒ 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.
#preferred_maintenance_window ⇒ String

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
#scaling_configuration ⇒ Types::ScalingConfiguration

The scaling properties of the DB cluster.
#vpc_security_group_ids ⇒ Array<String>

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

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

Default: ‘false`

Returns:

(Boolean)

# File 'lib/aws-sdk-rds/types.rb', line 9894

class ModifyDBClusterMessage < Struct.new(
  :db_cluster_identifier,
  :new_db_cluster_identifier,
  :apply_immediately,
  :backup_retention_period,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :port,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :enable_iam_database_authentication,
  :backtrack_window,
  :cloudwatch_logs_export_configuration,
  :engine_version,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint)
  include Aws::Structure
end

#backtrack_window ⇒ `Integer`

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)

# File 'lib/aws-sdk-rds/types.rb', line 9894

class ModifyDBClusterMessage < Struct.new(
  :db_cluster_identifier,
  :new_db_cluster_identifier,
  :apply_immediately,
  :backup_retention_period,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :port,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :enable_iam_database_authentication,
  :backtrack_window,
  :cloudwatch_logs_export_configuration,
  :engine_version,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint)
  include Aws::Structure
end

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

# File 'lib/aws-sdk-rds/types.rb', line 9894

class ModifyDBClusterMessage < Struct.new(
  :db_cluster_identifier,
  :new_db_cluster_identifier,
  :apply_immediately,
  :backup_retention_period,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :port,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :enable_iam_database_authentication,
  :backtrack_window,
  :cloudwatch_logs_export_configuration,
  :engine_version,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint)
  include Aws::Structure
end

#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:

(Types::CloudwatchLogsExportConfiguration)

# File 'lib/aws-sdk-rds/types.rb', line 9894

class ModifyDBClusterMessage < Struct.new(
  :db_cluster_identifier,
  :new_db_cluster_identifier,
  :apply_immediately,
  :backup_retention_period,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :port,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :enable_iam_database_authentication,
  :backtrack_window,
  :cloudwatch_logs_export_configuration,
  :engine_version,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint)
  include Aws::Structure
end

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

# File 'lib/aws-sdk-rds/types.rb', line 9894

class ModifyDBClusterMessage < Struct.new(
  :db_cluster_identifier,
  :new_db_cluster_identifier,
  :apply_immediately,
  :backup_retention_period,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :port,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :enable_iam_database_authentication,
  :backtrack_window,
  :cloudwatch_logs_export_configuration,
  :engine_version,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint)
  include Aws::Structure
end

#db_cluster_parameter_group_name ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9894

class ModifyDBClusterMessage < Struct.new(
  :db_cluster_identifier,
  :new_db_cluster_identifier,
  :apply_immediately,
  :backup_retention_period,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :port,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :enable_iam_database_authentication,
  :backtrack_window,
  :cloudwatch_logs_export_configuration,
  :engine_version,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint)
  include Aws::Structure
end

#deletion_protection ⇒ `Boolean`

Indicates if the DB cluster has deletion protection enabled. The database can’t be deleted when this value is set to true.

Returns:

(Boolean)

# File 'lib/aws-sdk-rds/types.rb', line 9894

class ModifyDBClusterMessage < Struct.new(
  :db_cluster_identifier,
  :new_db_cluster_identifier,
  :apply_immediately,
  :backup_retention_period,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :port,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :enable_iam_database_authentication,
  :backtrack_window,
  :cloudwatch_logs_export_configuration,
  :engine_version,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint)
  include Aws::Structure
end

#enable_http_endpoint ⇒ `Boolean`

<note markdown=“1”> HTTP endpoint functionality is in beta for Aurora Serverless and is subject to change.

</note>

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 about Aurora Serverless, see [Using Amazon Aurora Serverless] in the *Amazon Aurora User Guide*.

[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html

Returns:

(Boolean)

# File 'lib/aws-sdk-rds/types.rb', line 9894

class ModifyDBClusterMessage < Struct.new(
  :db_cluster_identifier,
  :new_db_cluster_identifier,
  :apply_immediately,
  :backup_retention_period,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :port,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :enable_iam_database_authentication,
  :backtrack_window,
  :cloudwatch_logs_export_configuration,
  :engine_version,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint)
  include Aws::Structure
end

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

# File 'lib/aws-sdk-rds/types.rb', line 9894

class ModifyDBClusterMessage < Struct.new(
  :db_cluster_identifier,
  :new_db_cluster_identifier,
  :apply_immediately,
  :backup_retention_period,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :port,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :enable_iam_database_authentication,
  :backtrack_window,
  :cloudwatch_logs_export_configuration,
  :engine_version,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint)
  include Aws::Structure
end

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

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9894

class ModifyDBClusterMessage < Struct.new(
  :db_cluster_identifier,
  :new_db_cluster_identifier,
  :apply_immediately,
  :backup_retention_period,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :port,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :enable_iam_database_authentication,
  :backtrack_window,
  :cloudwatch_logs_export_configuration,
  :engine_version,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint)
  include Aws::Structure
end

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

# File 'lib/aws-sdk-rds/types.rb', line 9894

class ModifyDBClusterMessage < Struct.new(
  :db_cluster_identifier,
  :new_db_cluster_identifier,
  :apply_immediately,
  :backup_retention_period,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :port,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :enable_iam_database_authentication,
  :backtrack_window,
  :cloudwatch_logs_export_configuration,
  :engine_version,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint)
  include Aws::Structure
end

#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
Can’t end with a hyphen or contain two consecutive hyphens

Example: ‘my-cluster2`

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9894

class ModifyDBClusterMessage < Struct.new(
  :db_cluster_identifier,
  :new_db_cluster_identifier,
  :apply_immediately,
  :backup_retention_period,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :port,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :enable_iam_database_authentication,
  :backtrack_window,
  :cloudwatch_logs_export_configuration,
  :engine_version,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint)
  include Aws::Structure
end

#option_group_name ⇒ `String`

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` parameter is set to `true` 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)

# File 'lib/aws-sdk-rds/types.rb', line 9894

class ModifyDBClusterMessage < Struct.new(
  :db_cluster_identifier,
  :new_db_cluster_identifier,
  :apply_immediately,
  :backup_retention_period,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :port,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :enable_iam_database_authentication,
  :backtrack_window,
  :cloudwatch_logs_export_configuration,
  :engine_version,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint)
  include Aws::Structure
end

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

# File 'lib/aws-sdk-rds/types.rb', line 9894

class ModifyDBClusterMessage < Struct.new(
  :db_cluster_identifier,
  :new_db_cluster_identifier,
  :apply_immediately,
  :backup_retention_period,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :port,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :enable_iam_database_authentication,
  :backtrack_window,
  :cloudwatch_logs_export_configuration,
  :engine_version,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint)
  include Aws::Structure
end

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

[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9894

class ModifyDBClusterMessage < Struct.new(
  :db_cluster_identifier,
  :new_db_cluster_identifier,
  :apply_immediately,
  :backup_retention_period,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :port,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :enable_iam_database_authentication,
  :backtrack_window,
  :cloudwatch_logs_export_configuration,
  :engine_version,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint)
  include Aws::Structure
end

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

[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9894

class ModifyDBClusterMessage < Struct.new(
  :db_cluster_identifier,
  :new_db_cluster_identifier,
  :apply_immediately,
  :backup_retention_period,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :port,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :enable_iam_database_authentication,
  :backtrack_window,
  :cloudwatch_logs_export_configuration,
  :engine_version,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint)
  include Aws::Structure
end

#scaling_configuration ⇒ `Types::ScalingConfiguration`

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

Returns:

(Types::ScalingConfiguration)

# File 'lib/aws-sdk-rds/types.rb', line 9894

class ModifyDBClusterMessage < Struct.new(
  :db_cluster_identifier,
  :new_db_cluster_identifier,
  :apply_immediately,
  :backup_retention_period,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :port,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :enable_iam_database_authentication,
  :backtrack_window,
  :cloudwatch_logs_export_configuration,
  :engine_version,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint)
  include Aws::Structure
end

#vpc_security_group_ids ⇒ `Array<String>`

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

Returns:

(Array<String>)

# File 'lib/aws-sdk-rds/types.rb', line 9894

class ModifyDBClusterMessage < Struct.new(
  :db_cluster_identifier,
  :new_db_cluster_identifier,
  :apply_immediately,
  :backup_retention_period,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :port,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :enable_iam_database_authentication,
  :backtrack_window,
  :cloudwatch_logs_export_configuration,
  :engine_version,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint)
  include Aws::Structure
end

Class: Aws::RDS::Types::ModifyDBClusterMessage

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#apply_immediately ⇒ Boolean

#backtrack_window ⇒ Integer

#backup_retention_period ⇒ Integer

#cloudwatch_logs_export_configuration ⇒ Types::CloudwatchLogsExportConfiguration

#db_cluster_identifier ⇒ String

#db_cluster_parameter_group_name ⇒ String

#deletion_protection ⇒ Boolean

#enable_http_endpoint ⇒ Boolean

#enable_iam_database_authentication ⇒ Boolean

#engine_version ⇒ String

#master_user_password ⇒ String

#new_db_cluster_identifier ⇒ String

#option_group_name ⇒ String

#port ⇒ Integer

#preferred_backup_window ⇒ String

#preferred_maintenance_window ⇒ String

#scaling_configuration ⇒ Types::ScalingConfiguration

#vpc_security_group_ids ⇒ Array<String>

#apply_immediately ⇒ `Boolean`

#backtrack_window ⇒ `Integer`

#backup_retention_period ⇒ `Integer`

#cloudwatch_logs_export_configuration ⇒ `Types::CloudwatchLogsExportConfiguration`

#db_cluster_identifier ⇒ `String`

#db_cluster_parameter_group_name ⇒ `String`

#deletion_protection ⇒ `Boolean`

#enable_http_endpoint ⇒ `Boolean`

#enable_iam_database_authentication ⇒ `Boolean`

#engine_version ⇒ `String`

#master_user_password ⇒ `String`

#new_db_cluster_identifier ⇒ `String`

#option_group_name ⇒ `String`

#port ⇒ `Integer`

#preferred_backup_window ⇒ `String`

#preferred_maintenance_window ⇒ `String`

#scaling_configuration ⇒ `Types::ScalingConfiguration`

#vpc_security_group_ids ⇒ `Array<String>`