Class: Aws::DocDB::Types::ModifyDBClusterMessage

Inherits:

Struct

Object
Struct
Aws::DocDB::Types::ModifyDBClusterMessage

show all

Includes:: Structure

Defined in:: lib/aws-sdk-docdb/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",
  preferred_backup_window: "String",
  preferred_maintenance_window: "String",
  cloudwatch_logs_export_configuration: {
    enable_log_types: ["String"],
    disable_log_types: ["String"],
  },
  engine_version: "String",
  deletion_protection: false,
}

Represents the input to ModifyDBCluster.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#apply_immediately ⇒ Boolean

A value that specifies whether the changes in this request and any pending changes are asynchronously applied as soon as possible, regardless of the `PreferredMaintenanceWindow` setting for the cluster.
#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 Amazon CloudWatch Logs for a specific instance or cluster.
#db_cluster_identifier ⇒ String

The cluster identifier for the cluster that is being modified.
#db_cluster_parameter_group_name ⇒ String

The name of the cluster parameter group to use for the cluster.
#deletion_protection ⇒ Boolean

Specifies whether this cluster can be deleted.
#engine_version ⇒ String

The version number of the database engine to which you want to upgrade.
#master_user_password ⇒ String

The password for the master database user.
#new_db_cluster_identifier ⇒ String

The new cluster identifier for the cluster when renaming a cluster.
#port ⇒ Integer

The port number on which the 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).
#vpc_security_group_ids ⇒ Array<String>

A list of virtual private cloud (VPC) security groups that the cluster will belong to.

Instance Attribute Details

#apply_immediately ⇒ `Boolean`

A value that specifies whether the changes in this request and any pending changes are asynchronously applied as soon as possible, regardless of the `PreferredMaintenanceWindow` setting for the cluster. If this parameter is set to `false`, changes to the cluster are applied during the next maintenance window.

The `ApplyImmediately` parameter affects only the `NewDBClusterIdentifier` and `MasterUserPassword` values. If you set this parameter value to `false`, the changes to the `NewDBClusterIdentifier` and `MasterUserPassword` values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the `ApplyImmediately` parameter.

Default: `false`

Returns:

(Boolean)

# File 'lib/aws-sdk-docdb/types.rb', line 4552

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,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :cloudwatch_logs_export_configuration,
  :engine_version,
  :deletion_protection)
  SENSITIVE = []
  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-docdb/types.rb', line 4552

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,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :cloudwatch_logs_export_configuration,
  :engine_version,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#cloudwatch_logs_export_configuration ⇒ `Types::CloudwatchLogsExportConfiguration`

The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster. The `EnableLogTypes` and `DisableLogTypes` arrays determine which logs are exported (or not exported) to CloudWatch Logs.

Returns:

(Types::CloudwatchLogsExportConfiguration)

# File 'lib/aws-sdk-docdb/types.rb', line 4552

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,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :cloudwatch_logs_export_configuration,
  :engine_version,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_identifier ⇒ `String`

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

Constraints:

Must match the identifier of an existing `DBCluster`.

Returns:

(String)

# File 'lib/aws-sdk-docdb/types.rb', line 4552

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,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :cloudwatch_logs_export_configuration,
  :engine_version,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_parameter_group_name ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-docdb/types.rb', line 4552

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,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :cloudwatch_logs_export_configuration,
  :engine_version,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#deletion_protection ⇒ `Boolean`

Specifies whether this cluster can be deleted. If `DeletionProtection` is enabled, the cluster cannot be deleted unless it is modified and `DeletionProtection` is disabled. `DeletionProtection` protects clusters from being accidentally deleted.

Returns:

(Boolean)

# File 'lib/aws-sdk-docdb/types.rb', line 4552

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,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :cloudwatch_logs_export_configuration,
  :engine_version,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#engine_version ⇒ `String`

The version number of the database engine to which you want to upgrade. Modifying engine version is not supported on Amazon DocumentDB.

Returns:

(String)

# File 'lib/aws-sdk-docdb/types.rb', line 4552

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,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :cloudwatch_logs_export_configuration,
  :engine_version,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#master_user_password ⇒ `String`

The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote (“), or the ”at“ symbol (@).

Constraints: Must contain from 8 to 100 characters.

Returns:

(String)

# File 'lib/aws-sdk-docdb/types.rb', line 4552

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,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :cloudwatch_logs_export_configuration,
  :engine_version,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#new_db_cluster_identifier ⇒ `String`

The new cluster identifier for the cluster when renaming a cluster. This value is stored as a lowercase string.

Constraints:

Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.

Example: `my-cluster2`

Returns:

(String)

# File 'lib/aws-sdk-docdb/types.rb', line 4552

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,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :cloudwatch_logs_export_configuration,
  :engine_version,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#port ⇒ `Integer`

The port number on which the cluster accepts connections.

Constraints: Must be a value from `1150` to `65535`.

Default: The same port as the original cluster.

Returns:

(Integer)

# File 'lib/aws-sdk-docdb/types.rb', line 4552

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,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :cloudwatch_logs_export_configuration,
  :engine_version,
  :deletion_protection)
  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.

Constraints:

Must be in the format `hh24:mi-hh24:mi`.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.

Returns:

(String)

# File 'lib/aws-sdk-docdb/types.rb', line 4552

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,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :cloudwatch_logs_export_configuration,
  :engine_version,
  :deletion_protection)
  SENSITIVE = []
  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 Amazon Web Services Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

Returns:

(String)

# File 'lib/aws-sdk-docdb/types.rb', line 4552

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,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :cloudwatch_logs_export_configuration,
  :engine_version,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_security_group_ids ⇒ `Array<String>`

A list of virtual private cloud (VPC) security groups that the cluster will belong to.

Returns:

(Array<String>)

# File 'lib/aws-sdk-docdb/types.rb', line 4552

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,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :cloudwatch_logs_export_configuration,
  :engine_version,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::DocDB::Types::ModifyDBClusterMessage

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#apply_immediately ⇒ Boolean

#backup_retention_period ⇒ Integer

#cloudwatch_logs_export_configuration ⇒ Types::CloudwatchLogsExportConfiguration

#db_cluster_identifier ⇒ String

#db_cluster_parameter_group_name ⇒ String

#deletion_protection ⇒ Boolean

#engine_version ⇒ String

#master_user_password ⇒ String

#new_db_cluster_identifier ⇒ String

#port ⇒ Integer

#preferred_backup_window ⇒ String

#preferred_maintenance_window ⇒ String

#vpc_security_group_ids ⇒ Array<String>

#apply_immediately ⇒ `Boolean`

#backup_retention_period ⇒ `Integer`

#cloudwatch_logs_export_configuration ⇒ `Types::CloudwatchLogsExportConfiguration`

#db_cluster_identifier ⇒ `String`

#db_cluster_parameter_group_name ⇒ `String`

#deletion_protection ⇒ `Boolean`

#engine_version ⇒ `String`

#master_user_password ⇒ `String`

#new_db_cluster_identifier ⇒ `String`

#port ⇒ `Integer`

#preferred_backup_window ⇒ `String`

#preferred_maintenance_window ⇒ `String`

#vpc_security_group_ids ⇒ `Array<String>`