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

Class: Aws::DatabaseMigrationService::Types::CreateReplicationInstanceMessage

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 CreateReplicationInstanceMessage data as a hash:

{
  replication_instance_identifier: "String", # required
  allocated_storage: 1,
  replication_instance_class: "String", # required
  vpc_security_group_ids: ["String"],
  availability_zone: "String",
  replication_subnet_group_identifier: "String",
  preferred_maintenance_window: "String",
  multi_az: false,
  engine_version: "String",
  auto_minor_version_upgrade: false,
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
  kms_key_id: "String",
  publicly_accessible: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#allocated_storageInteger

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

Returns:

  • (Integer)


583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 583

class CreateReplicationInstanceMessage < Struct.new(
  :replication_instance_identifier,
  :allocated_storage,
  :replication_instance_class,
  :vpc_security_group_ids,
  :availability_zone,
  :replication_subnet_group_identifier,
  :preferred_maintenance_window,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :tags,
  :kms_key_id,
  :publicly_accessible)
  include Aws::Structure
end

#auto_minor_version_upgradeBoolean

Indicates that minor engine upgrades will be applied automatically to the replication instance during the maintenance window.

Default: true

Returns:

  • (Boolean)


583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 583

class CreateReplicationInstanceMessage < Struct.new(
  :replication_instance_identifier,
  :allocated_storage,
  :replication_instance_class,
  :vpc_security_group_ids,
  :availability_zone,
  :replication_subnet_group_identifier,
  :preferred_maintenance_window,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :tags,
  :kms_key_id,
  :publicly_accessible)
  include Aws::Structure
end

#availability_zoneString

The EC2 Availability Zone that the replication instance will be created in.

Default: A random, system-chosen Availability Zone in the endpoint's region.

Example: us-east-1d

Returns:

  • (String)


583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 583

class CreateReplicationInstanceMessage < Struct.new(
  :replication_instance_identifier,
  :allocated_storage,
  :replication_instance_class,
  :vpc_security_group_ids,
  :availability_zone,
  :replication_subnet_group_identifier,
  :preferred_maintenance_window,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :tags,
  :kms_key_id,
  :publicly_accessible)
  include Aws::Structure
end

#engine_versionString

The engine version number of the replication instance.

Returns:

  • (String)


583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 583

class CreateReplicationInstanceMessage < Struct.new(
  :replication_instance_identifier,
  :allocated_storage,
  :replication_instance_class,
  :vpc_security_group_ids,
  :availability_zone,
  :replication_subnet_group_identifier,
  :preferred_maintenance_window,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :tags,
  :kms_key_id,
  :publicly_accessible)
  include Aws::Structure
end

#kms_key_idString

The KMS key identifier that will be used to encrypt the content on the replication instance. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.

Returns:

  • (String)


583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 583

class CreateReplicationInstanceMessage < Struct.new(
  :replication_instance_identifier,
  :allocated_storage,
  :replication_instance_class,
  :vpc_security_group_ids,
  :availability_zone,
  :replication_subnet_group_identifier,
  :preferred_maintenance_window,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :tags,
  :kms_key_id,
  :publicly_accessible)
  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)


583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 583

class CreateReplicationInstanceMessage < Struct.new(
  :replication_instance_identifier,
  :allocated_storage,
  :replication_instance_class,
  :vpc_security_group_ids,
  :availability_zone,
  :replication_subnet_group_identifier,
  :preferred_maintenance_window,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :tags,
  :kms_key_id,
  :publicly_accessible)
  include Aws::Structure
end

#preferred_maintenance_windowString

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

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

Default: A 30-minute window selected at random from an 8-hour block of time per 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)


583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 583

class CreateReplicationInstanceMessage < Struct.new(
  :replication_instance_identifier,
  :allocated_storage,
  :replication_instance_class,
  :vpc_security_group_ids,
  :availability_zone,
  :replication_subnet_group_identifier,
  :preferred_maintenance_window,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :tags,
  :kms_key_id,
  :publicly_accessible)
  include Aws::Structure
end

#publicly_accessibleBoolean

Specifies the accessibility options for the replication instance. A value of true represents an instance with a public IP address. A value of false represents an instance with a private IP address. The default value is true.

Returns:

  • (Boolean)


583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 583

class CreateReplicationInstanceMessage < Struct.new(
  :replication_instance_identifier,
  :allocated_storage,
  :replication_instance_class,
  :vpc_security_group_ids,
  :availability_zone,
  :replication_subnet_group_identifier,
  :preferred_maintenance_window,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :tags,
  :kms_key_id,
  :publicly_accessible)
  include Aws::Structure
end

#replication_instance_classString

The compute and memory capacity of the replication instance as specified by the replication instance class.

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)


583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 583

class CreateReplicationInstanceMessage < Struct.new(
  :replication_instance_identifier,
  :allocated_storage,
  :replication_instance_class,
  :vpc_security_group_ids,
  :availability_zone,
  :replication_subnet_group_identifier,
  :preferred_maintenance_window,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :tags,
  :kms_key_id,
  :publicly_accessible)
  include Aws::Structure
end

#replication_instance_identifierString

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

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: myrepinstance

Returns:

  • (String)


583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 583

class CreateReplicationInstanceMessage < Struct.new(
  :replication_instance_identifier,
  :allocated_storage,
  :replication_instance_class,
  :vpc_security_group_ids,
  :availability_zone,
  :replication_subnet_group_identifier,
  :preferred_maintenance_window,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :tags,
  :kms_key_id,
  :publicly_accessible)
  include Aws::Structure
end

#replication_subnet_group_identifierString

A subnet group to associate with the replication instance.

Returns:

  • (String)


583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 583

class CreateReplicationInstanceMessage < Struct.new(
  :replication_instance_identifier,
  :allocated_storage,
  :replication_instance_class,
  :vpc_security_group_ids,
  :availability_zone,
  :replication_subnet_group_identifier,
  :preferred_maintenance_window,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :tags,
  :kms_key_id,
  :publicly_accessible)
  include Aws::Structure
end

#tagsArray<Types::Tag>

Tags to be associated with the replication instance.

Returns:



583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 583

class CreateReplicationInstanceMessage < Struct.new(
  :replication_instance_identifier,
  :allocated_storage,
  :replication_instance_class,
  :vpc_security_group_ids,
  :availability_zone,
  :replication_subnet_group_identifier,
  :preferred_maintenance_window,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :tags,
  :kms_key_id,
  :publicly_accessible)
  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>)


583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 583

class CreateReplicationInstanceMessage < Struct.new(
  :replication_instance_identifier,
  :allocated_storage,
  :replication_instance_class,
  :vpc_security_group_ids,
  :availability_zone,
  :replication_subnet_group_identifier,
  :preferred_maintenance_window,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :tags,
  :kms_key_id,
  :publicly_accessible)
  include Aws::Structure
end