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

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#allocated_storage ⇒ Integer

The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
#allow_engine_mode_change ⇒ Boolean

Specifies whether engine mode changes from ‘serverless` to `provisioned` are allowed.
#allow_major_version_upgrade ⇒ Boolean

Specifies whether major version upgrades are allowed.
#apply_immediately ⇒ Boolean

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.
#auto_minor_version_upgrade ⇒ Boolean

Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window.
#aws_backup_recovery_point_arn ⇒ String

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
#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.
#copy_tags_to_snapshot ⇒ Boolean

Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster.
#db_cluster_identifier ⇒ String

The DB cluster identifier for the cluster being modified.
#db_cluster_instance_class ⇒ String

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example ‘db.m6gd.xlarge`.
#db_cluster_parameter_group_name ⇒ String

The name of the DB cluster parameter group to use for the DB cluster.
#db_instance_parameter_group_name ⇒ String

The name of the DB parameter group to apply to all instances of the DB cluster.
#deletion_protection ⇒ Boolean

Specifies whether the DB cluster has deletion protection enabled.
#domain ⇒ String

The Active Directory directory ID to move the DB cluster to.
#domain_iam_role_name ⇒ String

The name of the IAM role to use when making API calls to the Directory Service.
#enable_global_write_forwarding ⇒ Boolean

Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database).
#enable_http_endpoint ⇒ Boolean

Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster.
#enable_iam_database_authentication ⇒ Boolean

Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts.
#enable_local_write_forwarding ⇒ Boolean

Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster.
#enable_performance_insights ⇒ Boolean

Specifies whether to turn on Performance Insights for the DB cluster.
#engine_mode ⇒ String

The DB engine mode of the DB cluster, either ‘provisioned` or `serverless`.
#engine_version ⇒ String

The version number of the database engine to which you want to upgrade.
#iops ⇒ Integer

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
#manage_master_user_password ⇒ Boolean

Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
#master_user_password ⇒ String

The new password for the master database user.
#master_user_secret_kms_key_id ⇒ String

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
#monitoring_interval ⇒ Integer

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
#monitoring_role_arn ⇒ String

The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
#network_type ⇒ String

The network type of the DB cluster.
#new_db_cluster_identifier ⇒ String

The new DB cluster identifier for the DB cluster when renaming a DB cluster.
#option_group_name ⇒ String

The option group to associate the DB cluster with.
#performance_insights_kms_key_id ⇒ String

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
#performance_insights_retention_period ⇒ Integer

The number of days to retain Performance Insights data.
#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).
#rotate_master_user_password ⇒ Boolean

Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.
#scaling_configuration ⇒ Types::ScalingConfiguration

The scaling properties of the DB cluster.
#serverless_v2_scaling_configuration ⇒ Types::ServerlessV2ScalingConfiguration

Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
#storage_type ⇒ String

The storage type to associate with the DB cluster.
#vpc_security_group_ids ⇒ Array<String>

A list of EC2 VPC security groups to associate with this DB cluster.

Instance Attribute Details

#allocated_storage ⇒ `Integer`

The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

Valid for Cluster Type: Multi-AZ DB clusters only

Returns:

(Integer)

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

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,
  :allow_major_version_upgrade,
  :db_instance_parameter_group_name,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint,
  :copy_tags_to_snapshot,
  :enable_global_write_forwarding,
  :db_cluster_instance_class,
  :allocated_storage,
  :storage_type,
  :iops,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :rotate_master_user_password,
  :master_user_secret_kms_key_id,
  :engine_mode,
  :allow_engine_mode_change,
  :enable_local_write_forwarding,
  :aws_backup_recovery_point_arn)
  SENSITIVE = []
  include Aws::Structure
end

#allow_engine_mode_change ⇒ `Boolean`

Specifies whether engine mode changes from ‘serverless` to `provisioned` are allowed.

Valid for Cluster Type: Aurora Serverless v1 DB clusters only

Constraints:

You must allow engine mode changes when specifying a different value for the ‘EngineMode` parameter from the DB cluster’s current engine mode.

Returns:

(Boolean)

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

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,
  :allow_major_version_upgrade,
  :db_instance_parameter_group_name,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint,
  :copy_tags_to_snapshot,
  :enable_global_write_forwarding,
  :db_cluster_instance_class,
  :allocated_storage,
  :storage_type,
  :iops,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :rotate_master_user_password,
  :master_user_secret_kms_key_id,
  :engine_mode,
  :allow_engine_mode_change,
  :enable_local_write_forwarding,
  :aws_backup_recovery_point_arn)
  SENSITIVE = []
  include Aws::Structure
end

#allow_major_version_upgrade ⇒ `Boolean`

Specifies whether major version upgrades are allowed.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

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)

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

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,
  :allow_major_version_upgrade,
  :db_instance_parameter_group_name,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint,
  :copy_tags_to_snapshot,
  :enable_global_write_forwarding,
  :db_cluster_instance_class,
  :allocated_storage,
  :storage_type,
  :iops,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :rotate_master_user_password,
  :master_user_secret_kms_key_id,
  :engine_mode,
  :allow_engine_mode_change,
  :enable_local_write_forwarding,
  :aws_backup_recovery_point_arn)
  SENSITIVE = []
  include Aws::Structure
end

#apply_immediately ⇒ `Boolean`

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

Most modifications can be applied immediately or during the next scheduled maintenance window. Some modifications, such as turning on deletion protection and changing the master password, are applied immediately—regardless of when you choose to apply them.

By default, this parameter is disabled.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Returns:

(Boolean)

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

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,
  :allow_major_version_upgrade,
  :db_instance_parameter_group_name,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint,
  :copy_tags_to_snapshot,
  :enable_global_write_forwarding,
  :db_cluster_instance_class,
  :allocated_storage,
  :storage_type,
  :iops,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :rotate_master_user_password,
  :master_user_secret_kms_key_id,
  :engine_mode,
  :allow_engine_mode_change,
  :enable_local_write_forwarding,
  :aws_backup_recovery_point_arn)
  SENSITIVE = []
  include Aws::Structure
end

#auto_minor_version_upgrade ⇒ `Boolean`

Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.

Valid for Cluster Type: Multi-AZ DB clusters only

Returns:

(Boolean)

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

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,
  :allow_major_version_upgrade,
  :db_instance_parameter_group_name,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint,
  :copy_tags_to_snapshot,
  :enable_global_write_forwarding,
  :db_cluster_instance_class,
  :allocated_storage,
  :storage_type,
  :iops,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :rotate_master_user_password,
  :master_user_secret_kms_key_id,
  :engine_mode,
  :allow_engine_mode_change,
  :enable_local_write_forwarding,
  :aws_backup_recovery_point_arn)
  SENSITIVE = []
  include Aws::Structure
end

#aws_backup_recovery_point_arn ⇒ `String`

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

Returns:

(String)

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

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,
  :allow_major_version_upgrade,
  :db_instance_parameter_group_name,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint,
  :copy_tags_to_snapshot,
  :enable_global_write_forwarding,
  :db_cluster_instance_class,
  :allocated_storage,
  :storage_type,
  :iops,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :rotate_master_user_password,
  :master_user_secret_kms_key_id,
  :engine_mode,
  :allow_engine_mode_change,
  :enable_local_write_forwarding,
  :aws_backup_recovery_point_arn)
  SENSITIVE = []
  include Aws::Structure
end

#backtrack_window ⇒ `Integer`

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

Valid for Cluster Type: Aurora MySQL DB clusters only

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 16510

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,
  :allow_major_version_upgrade,
  :db_instance_parameter_group_name,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint,
  :copy_tags_to_snapshot,
  :enable_global_write_forwarding,
  :db_cluster_instance_class,
  :allocated_storage,
  :storage_type,
  :iops,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :rotate_master_user_password,
  :master_user_secret_kms_key_id,
  :engine_mode,
  :allow_engine_mode_change,
  :enable_local_write_forwarding,
  :aws_backup_recovery_point_arn)
  SENSITIVE = []
  include Aws::Structure
end

#backup_retention_period ⇒ `Integer`

The number of days for which automated backups are retained. Specify a minimum value of ‘1`.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Default: ‘1`

Constraints:

Must be a value from 1 to 35.

Returns:

(Integer)

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

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,
  :allow_major_version_upgrade,
  :db_instance_parameter_group_name,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint,
  :copy_tags_to_snapshot,
  :enable_global_write_forwarding,
  :db_cluster_instance_class,
  :allocated_storage,
  :storage_type,
  :iops,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :rotate_master_user_password,
  :master_user_secret_kms_key_id,
  :engine_mode,
  :allow_engine_mode_change,
  :enable_local_write_forwarding,
  :aws_backup_recovery_point_arn)
  SENSITIVE = []
  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.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

The following values are valid for each DB engine:

Aurora MySQL - ‘audit | error | general | slowquery`
Aurora PostgreSQL - ‘postgresql`
RDS for MySQL - ‘error | general | slowquery`
RDS for PostgreSQL - ‘postgresql | upgrade`

For more information about exporting CloudWatch Logs for Amazon RDS, see [ Publishing Database Logs to Amazon CloudWatch Logs] in the *Amazon RDS User Guide*.

For more information about exporting CloudWatch Logs for Amazon Aurora, see [Publishing Database Logs to Amazon CloudWatch Logs] in the *Amazon Aurora User Guide*.

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch [2]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch

Returns:

(Types::CloudwatchLogsExportConfiguration)

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

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,
  :allow_major_version_upgrade,
  :db_instance_parameter_group_name,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint,
  :copy_tags_to_snapshot,
  :enable_global_write_forwarding,
  :db_cluster_instance_class,
  :allocated_storage,
  :storage_type,
  :iops,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :rotate_master_user_password,
  :master_user_secret_kms_key_id,
  :engine_mode,
  :allow_engine_mode_change,
  :enable_local_write_forwarding,
  :aws_backup_recovery_point_arn)
  SENSITIVE = []
  include Aws::Structure
end

#copy_tags_to_snapshot ⇒ `Boolean`

Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Returns:

(Boolean)

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

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,
  :allow_major_version_upgrade,
  :db_instance_parameter_group_name,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint,
  :copy_tags_to_snapshot,
  :enable_global_write_forwarding,
  :db_cluster_instance_class,
  :allocated_storage,
  :storage_type,
  :iops,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :rotate_master_user_password,
  :master_user_secret_kms_key_id,
  :engine_mode,
  :allow_engine_mode_change,
  :enable_local_write_forwarding,
  :aws_backup_recovery_point_arn)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_identifier ⇒ `String`

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

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Constraints:

Must match the identifier of an existing DB cluster.

Returns:

(String)

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

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,
  :allow_major_version_upgrade,
  :db_instance_parameter_group_name,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint,
  :copy_tags_to_snapshot,
  :enable_global_write_forwarding,
  :db_cluster_instance_class,
  :allocated_storage,
  :storage_type,
  :iops,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :rotate_master_user_password,
  :master_user_secret_kms_key_id,
  :engine_mode,
  :allow_engine_mode_change,
  :enable_local_write_forwarding,
  :aws_backup_recovery_point_arn)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_instance_class ⇒ `String`

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example ‘db.m6gd.xlarge`. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.

For the full list of DB instance classes and availability for your engine, see [ DB Instance Class] in the *Amazon RDS User Guide*.

Valid for Cluster Type: Multi-AZ DB clusters only

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html

Returns:

(String)

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

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,
  :allow_major_version_upgrade,
  :db_instance_parameter_group_name,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint,
  :copy_tags_to_snapshot,
  :enable_global_write_forwarding,
  :db_cluster_instance_class,
  :allocated_storage,
  :storage_type,
  :iops,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :rotate_master_user_password,
  :master_user_secret_kms_key_id,
  :engine_mode,
  :allow_engine_mode_change,
  :enable_local_write_forwarding,
  :aws_backup_recovery_point_arn)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_parameter_group_name ⇒ `String`

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

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Returns:

(String)

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

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,
  :allow_major_version_upgrade,
  :db_instance_parameter_group_name,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint,
  :copy_tags_to_snapshot,
  :enable_global_write_forwarding,
  :db_cluster_instance_class,
  :allocated_storage,
  :storage_type,
  :iops,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :rotate_master_user_password,
  :master_user_secret_kms_key_id,
  :engine_mode,
  :allow_engine_mode_change,
  :enable_local_write_forwarding,
  :aws_backup_recovery_point_arn)
  SENSITIVE = []
  include Aws::Structure
end

#db_instance_parameter_group_name ⇒ `String`

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

<note markdown=“1”> When you apply a parameter group using the ‘DBInstanceParameterGroupName` parameter, the DB cluster isn’t rebooted automatically. Also, parameter changes are applied immediately rather than during the next maintenance window.

</note>

Valid for Cluster Type: Aurora DB clusters only

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 valid in combination with the `AllowMajorVersionUpgrade` parameter for a major version upgrade only.

Returns:

(String)

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

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,
  :allow_major_version_upgrade,
  :db_instance_parameter_group_name,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint,
  :copy_tags_to_snapshot,
  :enable_global_write_forwarding,
  :db_cluster_instance_class,
  :allocated_storage,
  :storage_type,
  :iops,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :rotate_master_user_password,
  :master_user_secret_kms_key_id,
  :engine_mode,
  :allow_engine_mode_change,
  :enable_local_write_forwarding,
  :aws_backup_recovery_point_arn)
  SENSITIVE = []
  include Aws::Structure
end

#deletion_protection ⇒ `Boolean`

Specifies whether the DB cluster has deletion protection enabled. The database can’t be deleted when deletion protection is enabled. By default, deletion protection isn’t enabled.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Returns:

(Boolean)

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

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,
  :allow_major_version_upgrade,
  :db_instance_parameter_group_name,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint,
  :copy_tags_to_snapshot,
  :enable_global_write_forwarding,
  :db_cluster_instance_class,
  :allocated_storage,
  :storage_type,
  :iops,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :rotate_master_user_password,
  :master_user_secret_kms_key_id,
  :engine_mode,
  :allow_engine_mode_change,
  :enable_local_write_forwarding,
  :aws_backup_recovery_point_arn)
  SENSITIVE = []
  include Aws::Structure
end

#domain ⇒ `String`

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.

For more information, see [Kerberos Authentication] in the *Amazon Aurora User Guide*.

Valid for Cluster Type: Aurora DB clusters only

[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html

Returns:

(String)

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

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,
  :allow_major_version_upgrade,
  :db_instance_parameter_group_name,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint,
  :copy_tags_to_snapshot,
  :enable_global_write_forwarding,
  :db_cluster_instance_class,
  :allocated_storage,
  :storage_type,
  :iops,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :rotate_master_user_password,
  :master_user_secret_kms_key_id,
  :engine_mode,
  :allow_engine_mode_change,
  :enable_local_write_forwarding,
  :aws_backup_recovery_point_arn)
  SENSITIVE = []
  include Aws::Structure
end

#domain_iam_role_name ⇒ `String`

The name of the IAM role to use when making API calls to the Directory Service.

Valid for Cluster Type: Aurora DB clusters only

Returns:

(String)

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

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,
  :allow_major_version_upgrade,
  :db_instance_parameter_group_name,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint,
  :copy_tags_to_snapshot,
  :enable_global_write_forwarding,
  :db_cluster_instance_class,
  :allocated_storage,
  :storage_type,
  :iops,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :rotate_master_user_password,
  :master_user_secret_kms_key_id,
  :engine_mode,
  :allow_engine_mode_change,
  :enable_local_write_forwarding,
  :aws_backup_recovery_point_arn)
  SENSITIVE = []
  include Aws::Structure
end

#enable_global_write_forwarding ⇒ `Boolean`

Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.

You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by a global cluster API operation, but it does nothing until then.

Valid for Cluster Type: Aurora DB clusters only

Returns:

(Boolean)

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

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,
  :allow_major_version_upgrade,
  :db_instance_parameter_group_name,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint,
  :copy_tags_to_snapshot,
  :enable_global_write_forwarding,
  :db_cluster_instance_class,
  :allocated_storage,
  :storage_type,
  :iops,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :rotate_master_user_password,
  :master_user_secret_kms_key_id,
  :engine_mode,
  :allow_engine_mode_change,
  :enable_local_write_forwarding,
  :aws_backup_recovery_point_arn)
  SENSITIVE = []
  include Aws::Structure
end

#enable_http_endpoint ⇒ `Boolean`

Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 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 v1 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 v1] in the *Amazon Aurora User Guide*.

Valid for Cluster Type: Aurora DB clusters only

[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html

Returns:

(Boolean)

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

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,
  :allow_major_version_upgrade,
  :db_instance_parameter_group_name,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint,
  :copy_tags_to_snapshot,
  :enable_global_write_forwarding,
  :db_cluster_instance_class,
  :allocated_storage,
  :storage_type,
  :iops,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :rotate_master_user_password,
  :master_user_secret_kms_key_id,
  :engine_mode,
  :allow_engine_mode_change,
  :enable_local_write_forwarding,
  :aws_backup_recovery_point_arn)
  SENSITIVE = []
  include Aws::Structure
end

#enable_iam_database_authentication ⇒ `Boolean`

Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn’t enabled.

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

Valid for Cluster Type: Aurora DB clusters only

[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html

Returns:

(Boolean)

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

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,
  :allow_major_version_upgrade,
  :db_instance_parameter_group_name,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint,
  :copy_tags_to_snapshot,
  :enable_global_write_forwarding,
  :db_cluster_instance_class,
  :allocated_storage,
  :storage_type,
  :iops,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :rotate_master_user_password,
  :master_user_secret_kms_key_id,
  :engine_mode,
  :allow_engine_mode_change,
  :enable_local_write_forwarding,
  :aws_backup_recovery_point_arn)
  SENSITIVE = []
  include Aws::Structure
end

#enable_local_write_forwarding ⇒ `Boolean`

Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren’t allowed on reader DB instances.

Valid for: Aurora DB clusters only

Returns:

(Boolean)

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

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,
  :allow_major_version_upgrade,
  :db_instance_parameter_group_name,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint,
  :copy_tags_to_snapshot,
  :enable_global_write_forwarding,
  :db_cluster_instance_class,
  :allocated_storage,
  :storage_type,
  :iops,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :rotate_master_user_password,
  :master_user_secret_kms_key_id,
  :engine_mode,
  :allow_engine_mode_change,
  :enable_local_write_forwarding,
  :aws_backup_recovery_point_arn)
  SENSITIVE = []
  include Aws::Structure
end

#enable_performance_insights ⇒ `Boolean`

Specifies whether to turn on Performance Insights for the DB cluster.

For more information, see [ Using Amazon Performance Insights] in the *Amazon RDS User Guide*.

Valid for Cluster Type: Multi-AZ DB clusters only

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html

Returns:

(Boolean)

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

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,
  :allow_major_version_upgrade,
  :db_instance_parameter_group_name,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint,
  :copy_tags_to_snapshot,
  :enable_global_write_forwarding,
  :db_cluster_instance_class,
  :allocated_storage,
  :storage_type,
  :iops,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :rotate_master_user_password,
  :master_user_secret_kms_key_id,
  :engine_mode,
  :allow_engine_mode_change,
  :enable_local_write_forwarding,
  :aws_backup_recovery_point_arn)
  SENSITIVE = []
  include Aws::Structure
end

#engine_mode ⇒ `String`

The DB engine mode of the DB cluster, either ‘provisioned` or `serverless`.

<note markdown=“1”> The DB engine mode can be modified only from ‘serverless` to `provisioned`.

</note>

For more information, see [ CreateDBCluster].

Valid for Cluster Type: Aurora DB clusters only

[1]: docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html

Returns:

(String)

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

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,
  :allow_major_version_upgrade,
  :db_instance_parameter_group_name,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint,
  :copy_tags_to_snapshot,
  :enable_global_write_forwarding,
  :db_cluster_instance_class,
  :allocated_storage,
  :storage_type,
  :iops,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :rotate_master_user_password,
  :master_user_secret_kms_key_id,
  :engine_mode,
  :allow_engine_mode_change,
  :enable_local_write_forwarding,
  :aws_backup_recovery_point_arn)
  SENSITIVE = []
  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 ‘ApplyImmediately` is enabled.

If the cluster that you’re modifying has one or more read replicas, all replicas must be running an engine version that’s the same or later than the version you specify.

To list all of the available engine versions for Aurora MySQL, 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”`

To list all of the available engine versions for RDS for MySQL, use the following command:

‘aws rds describe-db-engine-versions –engine mysql –query “DBEngineVersions[].EngineVersion”`

To list all of the available engine versions for RDS for PostgreSQL, use the following command:

‘aws rds describe-db-engine-versions –engine postgres –query “DBEngineVersions[].EngineVersion”`

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Returns:

(String)

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

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,
  :allow_major_version_upgrade,
  :db_instance_parameter_group_name,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint,
  :copy_tags_to_snapshot,
  :enable_global_write_forwarding,
  :db_cluster_instance_class,
  :allocated_storage,
  :storage_type,
  :iops,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :rotate_master_user_password,
  :master_user_secret_kms_key_id,
  :engine_mode,
  :allow_engine_mode_change,
  :enable_local_write_forwarding,
  :aws_backup_recovery_point_arn)
  SENSITIVE = []
  include Aws::Structure
end

#iops ⇒ `Integer`

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.

For information about valid IOPS values, see [Amazon RDS Provisioned IOPS storage] in the *Amazon RDS User Guide*.

Valid for Cluster Type: Multi-AZ DB clusters only

Constraints:

Must be a multiple between .5 and 50 of the storage amount for the DB cluster.

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS

Returns:

(Integer)

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

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,
  :allow_major_version_upgrade,
  :db_instance_parameter_group_name,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint,
  :copy_tags_to_snapshot,
  :enable_global_write_forwarding,
  :db_cluster_instance_class,
  :allocated_storage,
  :storage_type,
  :iops,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :rotate_master_user_password,
  :master_user_secret_kms_key_id,
  :engine_mode,
  :allow_engine_mode_change,
  :enable_local_write_forwarding,
  :aws_backup_recovery_point_arn)
  SENSITIVE = []
  include Aws::Structure
end

#manage_master_user_password ⇒ `Boolean`

Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

If the DB cluster doesn’t manage the master user password with Amazon Web Services Secrets Manager, you can turn on this management. In this case, you can’t specify ‘MasterUserPassword`.

If the DB cluster already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the master user password is not managed with Amazon Web Services Secrets Manager, then you must specify ‘MasterUserPassword`. In this case, RDS deletes the secret and uses the new password for the master user specified by `MasterUserPassword`.

For more information, see [Password management with Amazon Web Services Secrets Manager] in the *Amazon RDS User Guide* and

Password management with Amazon Web Services Secrets Manager][2: in

the *Amazon Aurora User Guide.*

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html [2]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html

Returns:

(Boolean)

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

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,
  :allow_major_version_upgrade,
  :db_instance_parameter_group_name,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint,
  :copy_tags_to_snapshot,
  :enable_global_write_forwarding,
  :db_cluster_instance_class,
  :allocated_storage,
  :storage_type,
  :iops,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :rotate_master_user_password,
  :master_user_secret_kms_key_id,
  :engine_mode,
  :allow_engine_mode_change,
  :enable_local_write_forwarding,
  :aws_backup_recovery_point_arn)
  SENSITIVE = []
  include Aws::Structure
end

#master_user_password ⇒ `String`

The new password for the master database user.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Constraints:

Must contain from 8 to 41 characters.
Can contain any printable ASCII character except “/”, “”“, or ”@“.
Can’t be specified if ‘ManageMasterUserPassword` is turned on.

Returns:

(String)

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

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,
  :allow_major_version_upgrade,
  :db_instance_parameter_group_name,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint,
  :copy_tags_to_snapshot,
  :enable_global_write_forwarding,
  :db_cluster_instance_class,
  :allocated_storage,
  :storage_type,
  :iops,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :rotate_master_user_password,
  :master_user_secret_kms_key_id,
  :engine_mode,
  :allow_engine_mode_change,
  :enable_local_write_forwarding,
  :aws_backup_recovery_point_arn)
  SENSITIVE = []
  include Aws::Structure
end

#master_user_secret_kms_key_id ⇒ `String`

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.

This setting is valid only if both of the following conditions are met:

The DB cluster doesn’t manage the master user password in Amazon Web Services Secrets Manager.

If the DB cluster already manages the master user password in Amazon Web Services Secrets Manager, you can’t change the KMS key that is used to encrypt the secret.
You are turning on ‘ManageMasterUserPassword` to manage the master user password in Amazon Web Services Secrets Manager.

If you are turning on ‘ManageMasterUserPassword` and don’t specify ‘MasterUserSecretKmsKeyId`, then the `aws/secretsmanager` KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can’t use the ‘aws/secretsmanager` KMS key to encrypt the secret, and you must use a customer managed KMS key.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Returns:

(String)

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

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,
  :allow_major_version_upgrade,
  :db_instance_parameter_group_name,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint,
  :copy_tags_to_snapshot,
  :enable_global_write_forwarding,
  :db_cluster_instance_class,
  :allocated_storage,
  :storage_type,
  :iops,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :rotate_master_user_password,
  :master_user_secret_kms_key_id,
  :engine_mode,
  :allow_engine_mode_change,
  :enable_local_write_forwarding,
  :aws_backup_recovery_point_arn)
  SENSITIVE = []
  include Aws::Structure
end

#monitoring_interval ⇒ `Integer`

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify ‘0`.

If ‘MonitoringRoleArn` is specified, also set `MonitoringInterval` to a value other than `0`.

Valid for Cluster Type: Multi-AZ DB clusters only

Valid Values: ‘0 | 1 | 5 | 10 | 15 | 30 | 60`

Default: ‘0`

Returns:

(Integer)

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

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,
  :allow_major_version_upgrade,
  :db_instance_parameter_group_name,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint,
  :copy_tags_to_snapshot,
  :enable_global_write_forwarding,
  :db_cluster_instance_class,
  :allocated_storage,
  :storage_type,
  :iops,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :rotate_master_user_password,
  :master_user_secret_kms_key_id,
  :engine_mode,
  :allow_engine_mode_change,
  :enable_local_write_forwarding,
  :aws_backup_recovery_point_arn)
  SENSITIVE = []
  include Aws::Structure
end

#monitoring_role_arn ⇒ `String`

The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is ‘arn:aws:iam:123456789012:role/emaccess`. For information on creating a monitoring role, see [To create an IAM role for Amazon RDS Enhanced Monitoring] in the *Amazon RDS User Guide.*

If ‘MonitoringInterval` is set to a value other than `0`, supply a `MonitoringRoleArn` value.

Valid for Cluster Type: Multi-AZ DB clusters only

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole

Returns:

(String)

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

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,
  :allow_major_version_upgrade,
  :db_instance_parameter_group_name,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint,
  :copy_tags_to_snapshot,
  :enable_global_write_forwarding,
  :db_cluster_instance_class,
  :allocated_storage,
  :storage_type,
  :iops,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :rotate_master_user_password,
  :master_user_secret_kms_key_id,
  :engine_mode,
  :allow_engine_mode_change,
  :enable_local_write_forwarding,
  :aws_backup_recovery_point_arn)
  SENSITIVE = []
  include Aws::Structure
end

#network_type ⇒ `String`

The network type of the DB cluster.

The network type is determined by the ‘DBSubnetGroup` specified for the DB cluster. A `DBSubnetGroup` can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (`DUAL`).

For more information, see [ Working with a DB instance in a VPC] in the *Amazon Aurora User Guide.*

Valid for Cluster Type: Aurora DB clusters only

Valid Values: ‘IPV4 | DUAL`

[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html

Returns:

(String)

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

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,
  :allow_major_version_upgrade,
  :db_instance_parameter_group_name,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint,
  :copy_tags_to_snapshot,
  :enable_global_write_forwarding,
  :db_cluster_instance_class,
  :allocated_storage,
  :storage_type,
  :iops,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :rotate_master_user_password,
  :master_user_secret_kms_key_id,
  :engine_mode,
  :allow_engine_mode_change,
  :enable_local_write_forwarding,
  :aws_backup_recovery_point_arn)
  SENSITIVE = []
  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.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

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 16510

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,
  :allow_major_version_upgrade,
  :db_instance_parameter_group_name,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint,
  :copy_tags_to_snapshot,
  :enable_global_write_forwarding,
  :db_cluster_instance_class,
  :allocated_storage,
  :storage_type,
  :iops,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :rotate_master_user_password,
  :master_user_secret_kms_key_id,
  :engine_mode,
  :allow_engine_mode_change,
  :enable_local_write_forwarding,
  :aws_backup_recovery_point_arn)
  SENSITIVE = []
  include Aws::Structure
end

#option_group_name ⇒ `String`

The option group to associate the DB cluster with.

DB clusters are associated with a default option group that can’t be modified.

Returns:

(String)

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

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,
  :allow_major_version_upgrade,
  :db_instance_parameter_group_name,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint,
  :copy_tags_to_snapshot,
  :enable_global_write_forwarding,
  :db_cluster_instance_class,
  :allocated_storage,
  :storage_type,
  :iops,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :rotate_master_user_password,
  :master_user_secret_kms_key_id,
  :engine_mode,
  :allow_engine_mode_change,
  :enable_local_write_forwarding,
  :aws_backup_recovery_point_arn)
  SENSITIVE = []
  include Aws::Structure
end

#performance_insights_kms_key_id ⇒ `String`

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

If you don’t specify a value for ‘PerformanceInsightsKMSKeyId`, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

Valid for Cluster Type: Multi-AZ DB clusters only

Returns:

(String)

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

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,
  :allow_major_version_upgrade,
  :db_instance_parameter_group_name,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint,
  :copy_tags_to_snapshot,
  :enable_global_write_forwarding,
  :db_cluster_instance_class,
  :allocated_storage,
  :storage_type,
  :iops,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :rotate_master_user_password,
  :master_user_secret_kms_key_id,
  :engine_mode,
  :allow_engine_mode_change,
  :enable_local_write_forwarding,
  :aws_backup_recovery_point_arn)
  SENSITIVE = []
  include Aws::Structure
end

#performance_insights_retention_period ⇒ `Integer`

The number of days to retain Performance Insights data.

Valid for Cluster Type: Multi-AZ DB clusters only

Valid Values:

‘7`
month * 31, where month is a number of months from 1-23. Examples: ‘93` (3 months * 31), `341` (11 months * 31), `589` (19 months * 31)
‘731`

Default: ‘7` days

If you specify a retention period that isn’t valid, such as ‘94`, Amazon RDS issues an error.

Returns:

(Integer)

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

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,
  :allow_major_version_upgrade,
  :db_instance_parameter_group_name,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint,
  :copy_tags_to_snapshot,
  :enable_global_write_forwarding,
  :db_cluster_instance_class,
  :allocated_storage,
  :storage_type,
  :iops,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :rotate_master_user_password,
  :master_user_secret_kms_key_id,
  :engine_mode,
  :allow_engine_mode_change,
  :enable_local_write_forwarding,
  :aws_backup_recovery_point_arn)
  SENSITIVE = []
  include Aws::Structure
end

#port ⇒ `Integer`

The port number on which the DB cluster accepts connections.

Valid for Cluster Type: Aurora DB clusters only

Valid Values: ‘1150-65535`

Default: The same port as the original DB cluster.

Returns:

(Integer)

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

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,
  :allow_major_version_upgrade,
  :db_instance_parameter_group_name,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint,
  :copy_tags_to_snapshot,
  :enable_global_write_forwarding,
  :db_cluster_instance_class,
  :allocated_storage,
  :storage_type,
  :iops,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :rotate_master_user_password,
  :master_user_secret_kms_key_id,
  :engine_mode,
  :allow_engine_mode_change,
  :enable_local_write_forwarding,
  :aws_backup_recovery_point_arn)
  SENSITIVE = []
  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 Amazon Web Services Region. To view the time blocks available, see [ Backup window] in the *Amazon Aurora User Guide*.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

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/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow

Returns:

(String)

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

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,
  :allow_major_version_upgrade,
  :db_instance_parameter_group_name,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint,
  :copy_tags_to_snapshot,
  :enable_global_write_forwarding,
  :db_cluster_instance_class,
  :allocated_storage,
  :storage_type,
  :iops,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :rotate_master_user_password,
  :master_user_secret_kms_key_id,
  :engine_mode,
  :allow_engine_mode_change,
  :enable_local_write_forwarding,
  :aws_backup_recovery_point_arn)
  SENSITIVE = []
  include Aws::Structure
end

#preferred_maintenance_window ⇒ `String`

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

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services 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*.

Constraints:

Must be in the format ‘ddd:hh24:mi-ddd:hh24:mi`.
Days must be one of ‘Mon | Tue | Wed | Thu | Fri | Sat | Sun`.
Must be in Universal Coordinated Time (UTC).
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 16510

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,
  :allow_major_version_upgrade,
  :db_instance_parameter_group_name,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint,
  :copy_tags_to_snapshot,
  :enable_global_write_forwarding,
  :db_cluster_instance_class,
  :allocated_storage,
  :storage_type,
  :iops,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :rotate_master_user_password,
  :master_user_secret_kms_key_id,
  :engine_mode,
  :allow_engine_mode_change,
  :enable_local_write_forwarding,
  :aws_backup_recovery_point_arn)
  SENSITIVE = []
  include Aws::Structure
end

#rotate_master_user_password ⇒ `Boolean`

Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster. The secret value contains the updated password.

For more information, see [Password management with Amazon Web Services Secrets Manager] in the *Amazon RDS User Guide* and

Password management with Amazon Web Services Secrets Manager][2: in

the *Amazon Aurora User Guide.*

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Constraints:

You must apply the change immediately when rotating the master user password.

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html [2]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html

Returns:

(Boolean)

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

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,
  :allow_major_version_upgrade,
  :db_instance_parameter_group_name,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint,
  :copy_tags_to_snapshot,
  :enable_global_write_forwarding,
  :db_cluster_instance_class,
  :allocated_storage,
  :storage_type,
  :iops,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :rotate_master_user_password,
  :master_user_secret_kms_key_id,
  :engine_mode,
  :allow_engine_mode_change,
  :enable_local_write_forwarding,
  :aws_backup_recovery_point_arn)
  SENSITIVE = []
  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.

Valid for Cluster Type: Aurora DB clusters only

Returns:

(Types::ScalingConfiguration)

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

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,
  :allow_major_version_upgrade,
  :db_instance_parameter_group_name,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint,
  :copy_tags_to_snapshot,
  :enable_global_write_forwarding,
  :db_cluster_instance_class,
  :allocated_storage,
  :storage_type,
  :iops,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :rotate_master_user_password,
  :master_user_secret_kms_key_id,
  :engine_mode,
  :allow_engine_mode_change,
  :enable_local_write_forwarding,
  :aws_backup_recovery_point_arn)
  SENSITIVE = []
  include Aws::Structure
end

#serverless_v2_scaling_configuration ⇒ `Types::ServerlessV2ScalingConfiguration`

Contains the scaling configuration of an Aurora Serverless v2 DB cluster.

For more information, see [Using Amazon Aurora Serverless v2] in the *Amazon Aurora User Guide*.

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

Returns:

(Types::ServerlessV2ScalingConfiguration)

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

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,
  :allow_major_version_upgrade,
  :db_instance_parameter_group_name,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint,
  :copy_tags_to_snapshot,
  :enable_global_write_forwarding,
  :db_cluster_instance_class,
  :allocated_storage,
  :storage_type,
  :iops,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :rotate_master_user_password,
  :master_user_secret_kms_key_id,
  :engine_mode,
  :allow_engine_mode_change,
  :enable_local_write_forwarding,
  :aws_backup_recovery_point_arn)
  SENSITIVE = []
  include Aws::Structure
end

#storage_type ⇒ `String`

The storage type to associate with the DB cluster.

For information on storage types for Aurora DB clusters, see [Storage configurations for Amazon Aurora DB clusters]. For information on storage types for Multi-AZ DB clusters, see [Settings for creating Multi-AZ DB clusters].

When specified for a Multi-AZ DB cluster, a value for the ‘Iops` parameter is required.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Valid Values:

Aurora DB clusters - ‘aurora | aurora-iopt1`
Multi-AZ DB clusters - ‘io1`

Default:

Aurora DB clusters - ‘aurora`
Multi-AZ DB clusters - ‘io1`

[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.StorageReliability.html#aurora-storage-type [2]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html#create-multi-az-db-cluster-settings

Returns:

(String)

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

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,
  :allow_major_version_upgrade,
  :db_instance_parameter_group_name,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint,
  :copy_tags_to_snapshot,
  :enable_global_write_forwarding,
  :db_cluster_instance_class,
  :allocated_storage,
  :storage_type,
  :iops,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :rotate_master_user_password,
  :master_user_secret_kms_key_id,
  :engine_mode,
  :allow_engine_mode_change,
  :enable_local_write_forwarding,
  :aws_backup_recovery_point_arn)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_security_group_ids ⇒ `Array<String>`

A list of EC2 VPC security groups to associate with this DB cluster.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Returns:

(Array<String>)

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

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,
  :allow_major_version_upgrade,
  :db_instance_parameter_group_name,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :deletion_protection,
  :enable_http_endpoint,
  :copy_tags_to_snapshot,
  :enable_global_write_forwarding,
  :db_cluster_instance_class,
  :allocated_storage,
  :storage_type,
  :iops,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :rotate_master_user_password,
  :master_user_secret_kms_key_id,
  :engine_mode,
  :allow_engine_mode_change,
  :enable_local_write_forwarding,
  :aws_backup_recovery_point_arn)
  SENSITIVE = []
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#allocated_storage ⇒ Integer

#allow_engine_mode_change ⇒ Boolean

#allow_major_version_upgrade ⇒ Boolean

#apply_immediately ⇒ Boolean

#auto_minor_version_upgrade ⇒ Boolean

#aws_backup_recovery_point_arn ⇒ String

#backtrack_window ⇒ Integer

#backup_retention_period ⇒ Integer

#cloudwatch_logs_export_configuration ⇒ Types::CloudwatchLogsExportConfiguration

#copy_tags_to_snapshot ⇒ Boolean

#db_cluster_identifier ⇒ String

#db_cluster_instance_class ⇒ String

#db_cluster_parameter_group_name ⇒ String

#db_instance_parameter_group_name ⇒ String

#deletion_protection ⇒ Boolean

#domain ⇒ String

#domain_iam_role_name ⇒ String

#enable_global_write_forwarding ⇒ Boolean

#enable_http_endpoint ⇒ Boolean

#enable_iam_database_authentication ⇒ Boolean

#enable_local_write_forwarding ⇒ Boolean

#enable_performance_insights ⇒ Boolean

#engine_mode ⇒ String

#engine_version ⇒ String

#iops ⇒ Integer

#manage_master_user_password ⇒ Boolean

#master_user_password ⇒ String

#master_user_secret_kms_key_id ⇒ String

#monitoring_interval ⇒ Integer

#monitoring_role_arn ⇒ String

#network_type ⇒ String

#new_db_cluster_identifier ⇒ String

#option_group_name ⇒ String

#performance_insights_kms_key_id ⇒ String

#performance_insights_retention_period ⇒ Integer

#port ⇒ Integer

#preferred_backup_window ⇒ String

#preferred_maintenance_window ⇒ String

#rotate_master_user_password ⇒ Boolean

#scaling_configuration ⇒ Types::ScalingConfiguration

#serverless_v2_scaling_configuration ⇒ Types::ServerlessV2ScalingConfiguration

#storage_type ⇒ String

#vpc_security_group_ids ⇒ Array<String>

#allocated_storage ⇒ `Integer`

#allow_engine_mode_change ⇒ `Boolean`

#allow_major_version_upgrade ⇒ `Boolean`

#apply_immediately ⇒ `Boolean`

#auto_minor_version_upgrade ⇒ `Boolean`

#aws_backup_recovery_point_arn ⇒ `String`

#backtrack_window ⇒ `Integer`

#backup_retention_period ⇒ `Integer`

#cloudwatch_logs_export_configuration ⇒ `Types::CloudwatchLogsExportConfiguration`

#copy_tags_to_snapshot ⇒ `Boolean`

#db_cluster_identifier ⇒ `String`

#db_cluster_instance_class ⇒ `String`

#db_cluster_parameter_group_name ⇒ `String`

#db_instance_parameter_group_name ⇒ `String`

#deletion_protection ⇒ `Boolean`

#domain ⇒ `String`

#domain_iam_role_name ⇒ `String`

#enable_global_write_forwarding ⇒ `Boolean`

#enable_http_endpoint ⇒ `Boolean`

#enable_iam_database_authentication ⇒ `Boolean`

#enable_local_write_forwarding ⇒ `Boolean`

#enable_performance_insights ⇒ `Boolean`

#engine_mode ⇒ `String`

#engine_version ⇒ `String`

#iops ⇒ `Integer`

#manage_master_user_password ⇒ `Boolean`

#master_user_password ⇒ `String`

#master_user_secret_kms_key_id ⇒ `String`

#monitoring_interval ⇒ `Integer`

#monitoring_role_arn ⇒ `String`

#network_type ⇒ `String`

#new_db_cluster_identifier ⇒ `String`

#option_group_name ⇒ `String`

#performance_insights_kms_key_id ⇒ `String`

#performance_insights_retention_period ⇒ `Integer`

#port ⇒ `Integer`

#preferred_backup_window ⇒ `String`

#preferred_maintenance_window ⇒ `String`

#rotate_master_user_password ⇒ `Boolean`

#scaling_configuration ⇒ `Types::ScalingConfiguration`

#serverless_v2_scaling_configuration ⇒ `Types::ServerlessV2ScalingConfiguration`

#storage_type ⇒ `String`

#vpc_security_group_ids ⇒ `Array<String>`