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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb

Overview

Note:

When making an API call, you may pass ModifyReplicationInstanceMessage data as a hash:

{
  replication_instance_arn: "String", # required
  allocated_storage: 1,
  apply_immediately: false,
  replication_instance_class: "String",
  vpc_security_group_ids: ["String"],
  preferred_maintenance_window: "String",
  multi_az: false,
  engine_version: "String",
  allow_major_version_upgrade: false,
  auto_minor_version_upgrade: false,
  replication_instance_identifier: "String",
}

Instance Attribute Summary collapse

Instance Attribute Details

#allocated_storageInteger

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

Returns:

  • (Integer)


2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2591

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)
  include Aws::Structure
end

#allow_major_version_upgradeBoolean

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.

Constraints: 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)


2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2591

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)
  include Aws::Structure
end

#apply_immediatelyBoolean

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

Returns:

  • (Boolean)


2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2591

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)
  include Aws::Structure
end

#auto_minor_version_upgradeBoolean

Indicates that minor version upgrades will be applied automatically to the replication instance during the maintenance window. Changing this parameter does not result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to true during the maintenance window, and a newer minor version is available, and AWS DMS has enabled auto patching for that engine version.

Returns:

  • (Boolean)


2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2591

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)
  include Aws::Structure
end

#engine_versionString

The engine version number of the replication instance.

Returns:

  • (String)


2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2591

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)
  include Aws::Structure
end

#multi_azBoolean

Specifies if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.

Returns:

  • (Boolean)


2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2591

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)
  include Aws::Structure
end

#preferred_maintenance_windowString

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)


2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2591

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)
  include Aws::Structure
end

#replication_instance_arnString

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

Returns:

  • (String)


2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2591

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)
  include Aws::Structure
end

#replication_instance_classString

The compute and memory capacity of the replication instance.

Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge

Returns:

  • (String)


2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2591

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)
  include Aws::Structure
end

#replication_instance_identifierString

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

Returns:

  • (String)


2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2591

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)
  include Aws::Structure
end

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


2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2591

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)
  include Aws::Structure
end