Class: Aws::DatabaseMigrationService::Types::ModifyReplicationInstanceMessage

Inherits:

Struct

Object
Struct
Aws::DatabaseMigrationService::Types::ModifyReplicationInstanceMessage

show all

Includes:: Structure

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

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#allocated_storage ⇒ Integer

The amount of storage (in gigabytes) to be allocated for the replication instance.
#allow_major_version_upgrade ⇒ Boolean

Indicates that major version upgrades are allowed.
#apply_immediately ⇒ Boolean

Indicates whether the changes should be applied immediately or during the next maintenance window.
#auto_minor_version_upgrade ⇒ Boolean

A value that indicates that minor version upgrades are applied automatically to the replication instance during the maintenance window.
#engine_version ⇒ String

The engine version number of the replication instance.
#kerberos_authentication_settings ⇒ Types::KerberosAuthenticationSettings

Specifies the ID of the secret that stores the key cache file required for kerberos authentication, when modifying a replication instance.
#multi_az ⇒ Boolean

Specifies whether the replication instance is a Multi-AZ deployment.
#network_type ⇒ String

The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing.
#preferred_maintenance_window ⇒ String

The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage.
#replication_instance_arn ⇒ String

The Amazon Resource Name (ARN) of the replication instance.
#replication_instance_class ⇒ String

The compute and memory capacity of the replication instance as defined for the specified replication instance class.
#replication_instance_identifier ⇒ String

The replication instance identifier.
#vpc_security_group_ids ⇒ Array<String>

Specifies the VPC security group to be used with the replication instance.

Instance Attribute Details

#allocated_storage ⇒ `Integer`

The amount of storage (in gigabytes) to be allocated for the replication instance.

Returns:

(Integer)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 8203

class ModifyReplicationInstanceMessage < Struct.new(
  :replication_instance_arn,
  :allocated_storage,
  :apply_immediately,
  :replication_instance_class,
  :vpc_security_group_ids,
  :preferred_maintenance_window,
  :multi_az,
  :engine_version,
  :allow_major_version_upgrade,
  :auto_minor_version_upgrade,
  :replication_instance_identifier,
  :network_type,
  :kerberos_authentication_settings)
  SENSITIVE = []
  include Aws::Structure
end

#allow_major_version_upgrade ⇒ `Boolean`

Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage, and the change is asynchronously applied as soon as possible.

This parameter must be set to ‘true` when specifying a value for the `EngineVersion` parameter that is a different major version than the replication instance’s current version.

Returns:

(Boolean)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 8203

class ModifyReplicationInstanceMessage < Struct.new(
  :replication_instance_arn,
  :allocated_storage,
  :apply_immediately,
  :replication_instance_class,
  :vpc_security_group_ids,
  :preferred_maintenance_window,
  :multi_az,
  :engine_version,
  :allow_major_version_upgrade,
  :auto_minor_version_upgrade,
  :replication_instance_identifier,
  :network_type,
  :kerberos_authentication_settings)
  SENSITIVE = []
  include Aws::Structure
end

#apply_immediately ⇒ `Boolean`

Indicates whether the changes should be applied immediately or during the next maintenance window.

Returns:

(Boolean)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 8203

class ModifyReplicationInstanceMessage < Struct.new(
  :replication_instance_arn,
  :allocated_storage,
  :apply_immediately,
  :replication_instance_class,
  :vpc_security_group_ids,
  :preferred_maintenance_window,
  :multi_az,
  :engine_version,
  :allow_major_version_upgrade,
  :auto_minor_version_upgrade,
  :replication_instance_identifier,
  :network_type,
  :kerberos_authentication_settings)
  SENSITIVE = []
  include Aws::Structure
end

#auto_minor_version_upgrade ⇒ `Boolean`

A value that indicates that minor version upgrades are applied automatically to the replication instance during the maintenance window. Changing this parameter doesn’t result in an outage, except in the case described following. The change is asynchronously applied as soon as possible.

An outage does result if these factors apply:

This parameter is set to ‘true` during the maintenance window.
A newer minor version is available.
DMS has enabled automatic patching for the given engine version.

Returns:

(Boolean)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 8203

class ModifyReplicationInstanceMessage < Struct.new(
  :replication_instance_arn,
  :allocated_storage,
  :apply_immediately,
  :replication_instance_class,
  :vpc_security_group_ids,
  :preferred_maintenance_window,
  :multi_az,
  :engine_version,
  :allow_major_version_upgrade,
  :auto_minor_version_upgrade,
  :replication_instance_identifier,
  :network_type,
  :kerberos_authentication_settings)
  SENSITIVE = []
  include Aws::Structure
end

#engine_version ⇒ `String`

The engine version number of the replication instance.

When modifying a major engine version of an instance, also set ‘AllowMajorVersionUpgrade` to `true`.

Returns:

(String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 8203

class ModifyReplicationInstanceMessage < Struct.new(
  :replication_instance_arn,
  :allocated_storage,
  :apply_immediately,
  :replication_instance_class,
  :vpc_security_group_ids,
  :preferred_maintenance_window,
  :multi_az,
  :engine_version,
  :allow_major_version_upgrade,
  :auto_minor_version_upgrade,
  :replication_instance_identifier,
  :network_type,
  :kerberos_authentication_settings)
  SENSITIVE = []
  include Aws::Structure
end

#kerberos_authentication_settings ⇒ `Types::KerberosAuthenticationSettings`

Specifies the ID of the secret that stores the key cache file required for kerberos authentication, when modifying a replication instance.

Returns:

(Types::KerberosAuthenticationSettings)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 8203

class ModifyReplicationInstanceMessage < Struct.new(
  :replication_instance_arn,
  :allocated_storage,
  :apply_immediately,
  :replication_instance_class,
  :vpc_security_group_ids,
  :preferred_maintenance_window,
  :multi_az,
  :engine_version,
  :allow_major_version_upgrade,
  :auto_minor_version_upgrade,
  :replication_instance_identifier,
  :network_type,
  :kerberos_authentication_settings)
  SENSITIVE = []
  include Aws::Structure
end

#multi_az ⇒ `Boolean`

Specifies whether the replication instance is a Multi-AZ deployment. You can’t set the ‘AvailabilityZone` parameter if the Multi-AZ parameter is set to `true`.

Returns:

(Boolean)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 8203

class ModifyReplicationInstanceMessage < Struct.new(
  :replication_instance_arn,
  :allocated_storage,
  :apply_immediately,
  :replication_instance_class,
  :vpc_security_group_ids,
  :preferred_maintenance_window,
  :multi_az,
  :engine_version,
  :allow_major_version_upgrade,
  :auto_minor_version_upgrade,
  :replication_instance_identifier,
  :network_type,
  :kerberos_authentication_settings)
  SENSITIVE = []
  include Aws::Structure
end

#network_type ⇒ `String`

The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.

Returns:

(String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 8203

class ModifyReplicationInstanceMessage < Struct.new(
  :replication_instance_arn,
  :allocated_storage,
  :apply_immediately,
  :replication_instance_class,
  :vpc_security_group_ids,
  :preferred_maintenance_window,
  :multi_az,
  :engine_version,
  :allow_major_version_upgrade,
  :auto_minor_version_upgrade,
  :replication_instance_identifier,
  :network_type,
  :kerberos_authentication_settings)
  SENSITIVE = []
  include Aws::Structure
end

#preferred_maintenance_window ⇒ `String`

The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter does not result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.

Default: Uses existing setting

Format: ddd:hh24:mi-ddd:hh24:mi

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Must be at least 30 minutes

Returns:

(String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 8203

class ModifyReplicationInstanceMessage < Struct.new(
  :replication_instance_arn,
  :allocated_storage,
  :apply_immediately,
  :replication_instance_class,
  :vpc_security_group_ids,
  :preferred_maintenance_window,
  :multi_az,
  :engine_version,
  :allow_major_version_upgrade,
  :auto_minor_version_upgrade,
  :replication_instance_identifier,
  :network_type,
  :kerberos_authentication_settings)
  SENSITIVE = []
  include Aws::Structure
end

#replication_instance_arn ⇒ `String`

The Amazon Resource Name (ARN) of the replication instance.

Returns:

(String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 8203

class ModifyReplicationInstanceMessage < Struct.new(
  :replication_instance_arn,
  :allocated_storage,
  :apply_immediately,
  :replication_instance_class,
  :vpc_security_group_ids,
  :preferred_maintenance_window,
  :multi_az,
  :engine_version,
  :allow_major_version_upgrade,
  :auto_minor_version_upgrade,
  :replication_instance_identifier,
  :network_type,
  :kerberos_authentication_settings)
  SENSITIVE = []
  include Aws::Structure
end

#replication_instance_class ⇒ `String`

The compute and memory capacity of the replication instance as defined for the specified replication instance class. For example to specify the instance class dms.c4.large, set this parameter to ‘“dms.c4.large”`.

For more information on the settings and capacities for the available replication instance classes, see [ Selecting the right DMS replication instance for your migration].

[1]: docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html#CHAP_ReplicationInstance.InDepth

Returns:

(String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 8203

class ModifyReplicationInstanceMessage < Struct.new(
  :replication_instance_arn,
  :allocated_storage,
  :apply_immediately,
  :replication_instance_class,
  :vpc_security_group_ids,
  :preferred_maintenance_window,
  :multi_az,
  :engine_version,
  :allow_major_version_upgrade,
  :auto_minor_version_upgrade,
  :replication_instance_identifier,
  :network_type,
  :kerberos_authentication_settings)
  SENSITIVE = []
  include Aws::Structure
end

#replication_instance_identifier ⇒ `String`

The replication instance identifier. This parameter is stored as a lowercase string.

Returns:

(String)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 8203

class ModifyReplicationInstanceMessage < Struct.new(
  :replication_instance_arn,
  :allocated_storage,
  :apply_immediately,
  :replication_instance_class,
  :vpc_security_group_ids,
  :preferred_maintenance_window,
  :multi_az,
  :engine_version,
  :allow_major_version_upgrade,
  :auto_minor_version_upgrade,
  :replication_instance_identifier,
  :network_type,
  :kerberos_authentication_settings)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_security_group_ids ⇒ `Array<String>`

Specifies the VPC security group to be used with the replication instance. The VPC security group must work with the VPC containing the replication instance.

Returns:

(Array<String>)

# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 8203

class ModifyReplicationInstanceMessage < Struct.new(
  :replication_instance_arn,
  :allocated_storage,
  :apply_immediately,
  :replication_instance_class,
  :vpc_security_group_ids,
  :preferred_maintenance_window,
  :multi_az,
  :engine_version,
  :allow_major_version_upgrade,
  :auto_minor_version_upgrade,
  :replication_instance_identifier,
  :network_type,
  :kerberos_authentication_settings)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::DatabaseMigrationService::Types::ModifyReplicationInstanceMessage

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#allocated_storage ⇒ Integer

#allow_major_version_upgrade ⇒ Boolean

#apply_immediately ⇒ Boolean

#auto_minor_version_upgrade ⇒ Boolean

#engine_version ⇒ String

#kerberos_authentication_settings ⇒ Types::KerberosAuthenticationSettings

#multi_az ⇒ Boolean

#network_type ⇒ String

#preferred_maintenance_window ⇒ String

#replication_instance_arn ⇒ String

#replication_instance_class ⇒ String

#replication_instance_identifier ⇒ String

#vpc_security_group_ids ⇒ Array<String>

#allocated_storage ⇒ `Integer`

#allow_major_version_upgrade ⇒ `Boolean`

#apply_immediately ⇒ `Boolean`

#auto_minor_version_upgrade ⇒ `Boolean`

#engine_version ⇒ `String`

#kerberos_authentication_settings ⇒ `Types::KerberosAuthenticationSettings`

#multi_az ⇒ `Boolean`

#network_type ⇒ `String`

#preferred_maintenance_window ⇒ `String`

#replication_instance_arn ⇒ `String`

#replication_instance_class ⇒ `String`

#replication_instance_identifier ⇒ `String`

#vpc_security_group_ids ⇒ `Array<String>`