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

Class: Aws::DatabaseMigrationService::Types::ReplicationInstance

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

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#allocated_storageInteger

The amount of storage (in gigabytes) that is allocated for the replication instance.

Returns:

  • (Integer)


3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3075

class ReplicationInstance < Struct.new(
  :replication_instance_identifier,
  :replication_instance_class,
  :replication_instance_status,
  :allocated_storage,
  :instance_create_time,
  :vpc_security_groups,
  :availability_zone,
  :replication_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :kms_key_id,
  :replication_instance_arn,
  :replication_instance_public_ip_address,
  :replication_instance_private_ip_address,
  :replication_instance_public_ip_addresses,
  :replication_instance_private_ip_addresses,
  :publicly_accessible,
  :secondary_availability_zone)
  include Aws::Structure
end

#auto_minor_version_upgradeBoolean

Boolean value indicating if minor version upgrades will be automatically applied to the instance.

Returns:

  • (Boolean)


3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3075

class ReplicationInstance < Struct.new(
  :replication_instance_identifier,
  :replication_instance_class,
  :replication_instance_status,
  :allocated_storage,
  :instance_create_time,
  :vpc_security_groups,
  :availability_zone,
  :replication_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :kms_key_id,
  :replication_instance_arn,
  :replication_instance_public_ip_address,
  :replication_instance_private_ip_address,
  :replication_instance_public_ip_addresses,
  :replication_instance_private_ip_addresses,
  :publicly_accessible,
  :secondary_availability_zone)
  include Aws::Structure
end

#availability_zoneString

The Availability Zone for the instance.

Returns:

  • (String)


3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3075

class ReplicationInstance < Struct.new(
  :replication_instance_identifier,
  :replication_instance_class,
  :replication_instance_status,
  :allocated_storage,
  :instance_create_time,
  :vpc_security_groups,
  :availability_zone,
  :replication_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :kms_key_id,
  :replication_instance_arn,
  :replication_instance_public_ip_address,
  :replication_instance_private_ip_address,
  :replication_instance_public_ip_addresses,
  :replication_instance_private_ip_addresses,
  :publicly_accessible,
  :secondary_availability_zone)
  include Aws::Structure
end

#engine_versionString

The engine version number of the replication instance.

Returns:

  • (String)


3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3075

class ReplicationInstance < Struct.new(
  :replication_instance_identifier,
  :replication_instance_class,
  :replication_instance_status,
  :allocated_storage,
  :instance_create_time,
  :vpc_security_groups,
  :availability_zone,
  :replication_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :kms_key_id,
  :replication_instance_arn,
  :replication_instance_public_ip_address,
  :replication_instance_private_ip_address,
  :replication_instance_public_ip_addresses,
  :replication_instance_private_ip_addresses,
  :publicly_accessible,
  :secondary_availability_zone)
  include Aws::Structure
end

#instance_create_timeTime

The time the replication instance was created.

Returns:

  • (Time)


3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3075

class ReplicationInstance < Struct.new(
  :replication_instance_identifier,
  :replication_instance_class,
  :replication_instance_status,
  :allocated_storage,
  :instance_create_time,
  :vpc_security_groups,
  :availability_zone,
  :replication_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :kms_key_id,
  :replication_instance_arn,
  :replication_instance_public_ip_address,
  :replication_instance_private_ip_address,
  :replication_instance_public_ip_addresses,
  :replication_instance_private_ip_addresses,
  :publicly_accessible,
  :secondary_availability_zone)
  include Aws::Structure
end

#kms_key_idString

The KMS key identifier that is 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)


3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3075

class ReplicationInstance < Struct.new(
  :replication_instance_identifier,
  :replication_instance_class,
  :replication_instance_status,
  :allocated_storage,
  :instance_create_time,
  :vpc_security_groups,
  :availability_zone,
  :replication_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :kms_key_id,
  :replication_instance_arn,
  :replication_instance_public_ip_address,
  :replication_instance_private_ip_address,
  :replication_instance_public_ip_addresses,
  :replication_instance_private_ip_addresses,
  :publicly_accessible,
  :secondary_availability_zone)
  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)


3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3075

class ReplicationInstance < Struct.new(
  :replication_instance_identifier,
  :replication_instance_class,
  :replication_instance_status,
  :allocated_storage,
  :instance_create_time,
  :vpc_security_groups,
  :availability_zone,
  :replication_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :kms_key_id,
  :replication_instance_arn,
  :replication_instance_public_ip_address,
  :replication_instance_private_ip_address,
  :replication_instance_public_ip_addresses,
  :replication_instance_private_ip_addresses,
  :publicly_accessible,
  :secondary_availability_zone)
  include Aws::Structure
end

#pending_modified_valuesTypes::ReplicationPendingModifiedValues

The pending modification values.



3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3075

class ReplicationInstance < Struct.new(
  :replication_instance_identifier,
  :replication_instance_class,
  :replication_instance_status,
  :allocated_storage,
  :instance_create_time,
  :vpc_security_groups,
  :availability_zone,
  :replication_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :kms_key_id,
  :replication_instance_arn,
  :replication_instance_public_ip_address,
  :replication_instance_private_ip_address,
  :replication_instance_public_ip_addresses,
  :replication_instance_private_ip_addresses,
  :publicly_accessible,
  :secondary_availability_zone)
  include Aws::Structure
end

#preferred_maintenance_windowString

The maintenance window times for the replication instance.

Returns:

  • (String)


3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3075

class ReplicationInstance < Struct.new(
  :replication_instance_identifier,
  :replication_instance_class,
  :replication_instance_status,
  :allocated_storage,
  :instance_create_time,
  :vpc_security_groups,
  :availability_zone,
  :replication_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :kms_key_id,
  :replication_instance_arn,
  :replication_instance_public_ip_address,
  :replication_instance_private_ip_address,
  :replication_instance_public_ip_addresses,
  :replication_instance_private_ip_addresses,
  :publicly_accessible,
  :secondary_availability_zone)
  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)


3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3075

class ReplicationInstance < Struct.new(
  :replication_instance_identifier,
  :replication_instance_class,
  :replication_instance_status,
  :allocated_storage,
  :instance_create_time,
  :vpc_security_groups,
  :availability_zone,
  :replication_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :kms_key_id,
  :replication_instance_arn,
  :replication_instance_public_ip_address,
  :replication_instance_private_ip_address,
  :replication_instance_public_ip_addresses,
  :replication_instance_private_ip_addresses,
  :publicly_accessible,
  :secondary_availability_zone)
  include Aws::Structure
end

#replication_instance_arnString

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

Returns:

  • (String)


3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3075

class ReplicationInstance < Struct.new(
  :replication_instance_identifier,
  :replication_instance_class,
  :replication_instance_status,
  :allocated_storage,
  :instance_create_time,
  :vpc_security_groups,
  :availability_zone,
  :replication_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :kms_key_id,
  :replication_instance_arn,
  :replication_instance_public_ip_address,
  :replication_instance_private_ip_address,
  :replication_instance_public_ip_addresses,
  :replication_instance_private_ip_addresses,
  :publicly_accessible,
  :secondary_availability_zone)
  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)


3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3075

class ReplicationInstance < Struct.new(
  :replication_instance_identifier,
  :replication_instance_class,
  :replication_instance_status,
  :allocated_storage,
  :instance_create_time,
  :vpc_security_groups,
  :availability_zone,
  :replication_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :kms_key_id,
  :replication_instance_arn,
  :replication_instance_public_ip_address,
  :replication_instance_private_ip_address,
  :replication_instance_public_ip_addresses,
  :replication_instance_private_ip_addresses,
  :publicly_accessible,
  :secondary_availability_zone)
  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)


3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3075

class ReplicationInstance < Struct.new(
  :replication_instance_identifier,
  :replication_instance_class,
  :replication_instance_status,
  :allocated_storage,
  :instance_create_time,
  :vpc_security_groups,
  :availability_zone,
  :replication_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :kms_key_id,
  :replication_instance_arn,
  :replication_instance_public_ip_address,
  :replication_instance_private_ip_address,
  :replication_instance_public_ip_addresses,
  :replication_instance_private_ip_addresses,
  :publicly_accessible,
  :secondary_availability_zone)
  include Aws::Structure
end

#replication_instance_private_ip_addressString

The private IP address of the replication instance.

Returns:

  • (String)


3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3075

class ReplicationInstance < Struct.new(
  :replication_instance_identifier,
  :replication_instance_class,
  :replication_instance_status,
  :allocated_storage,
  :instance_create_time,
  :vpc_security_groups,
  :availability_zone,
  :replication_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :kms_key_id,
  :replication_instance_arn,
  :replication_instance_public_ip_address,
  :replication_instance_private_ip_address,
  :replication_instance_public_ip_addresses,
  :replication_instance_private_ip_addresses,
  :publicly_accessible,
  :secondary_availability_zone)
  include Aws::Structure
end

#replication_instance_private_ip_addressesArray<String>

The private IP address of the replication instance.

Returns:

  • (Array<String>)


3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3075

class ReplicationInstance < Struct.new(
  :replication_instance_identifier,
  :replication_instance_class,
  :replication_instance_status,
  :allocated_storage,
  :instance_create_time,
  :vpc_security_groups,
  :availability_zone,
  :replication_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :kms_key_id,
  :replication_instance_arn,
  :replication_instance_public_ip_address,
  :replication_instance_private_ip_address,
  :replication_instance_public_ip_addresses,
  :replication_instance_private_ip_addresses,
  :publicly_accessible,
  :secondary_availability_zone)
  include Aws::Structure
end

#replication_instance_public_ip_addressString

The public IP address of the replication instance.

Returns:

  • (String)


3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3075

class ReplicationInstance < Struct.new(
  :replication_instance_identifier,
  :replication_instance_class,
  :replication_instance_status,
  :allocated_storage,
  :instance_create_time,
  :vpc_security_groups,
  :availability_zone,
  :replication_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :kms_key_id,
  :replication_instance_arn,
  :replication_instance_public_ip_address,
  :replication_instance_private_ip_address,
  :replication_instance_public_ip_addresses,
  :replication_instance_private_ip_addresses,
  :publicly_accessible,
  :secondary_availability_zone)
  include Aws::Structure
end

#replication_instance_public_ip_addressesArray<String>

The public IP address of the replication instance.

Returns:

  • (Array<String>)


3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3075

class ReplicationInstance < Struct.new(
  :replication_instance_identifier,
  :replication_instance_class,
  :replication_instance_status,
  :allocated_storage,
  :instance_create_time,
  :vpc_security_groups,
  :availability_zone,
  :replication_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :kms_key_id,
  :replication_instance_arn,
  :replication_instance_public_ip_address,
  :replication_instance_private_ip_address,
  :replication_instance_public_ip_addresses,
  :replication_instance_private_ip_addresses,
  :publicly_accessible,
  :secondary_availability_zone)
  include Aws::Structure
end

#replication_instance_statusString

The status of the replication instance.

Returns:

  • (String)


3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3075

class ReplicationInstance < Struct.new(
  :replication_instance_identifier,
  :replication_instance_class,
  :replication_instance_status,
  :allocated_storage,
  :instance_create_time,
  :vpc_security_groups,
  :availability_zone,
  :replication_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :kms_key_id,
  :replication_instance_arn,
  :replication_instance_public_ip_address,
  :replication_instance_private_ip_address,
  :replication_instance_public_ip_addresses,
  :replication_instance_private_ip_addresses,
  :publicly_accessible,
  :secondary_availability_zone)
  include Aws::Structure
end

#replication_subnet_groupTypes::ReplicationSubnetGroup

The subnet group for the replication instance.



3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3075

class ReplicationInstance < Struct.new(
  :replication_instance_identifier,
  :replication_instance_class,
  :replication_instance_status,
  :allocated_storage,
  :instance_create_time,
  :vpc_security_groups,
  :availability_zone,
  :replication_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :kms_key_id,
  :replication_instance_arn,
  :replication_instance_public_ip_address,
  :replication_instance_private_ip_address,
  :replication_instance_public_ip_addresses,
  :replication_instance_private_ip_addresses,
  :publicly_accessible,
  :secondary_availability_zone)
  include Aws::Structure
end

#secondary_availability_zoneString

The availability zone of the standby replication instance in a Multi-AZ deployment.

Returns:

  • (String)


3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3075

class ReplicationInstance < Struct.new(
  :replication_instance_identifier,
  :replication_instance_class,
  :replication_instance_status,
  :allocated_storage,
  :instance_create_time,
  :vpc_security_groups,
  :availability_zone,
  :replication_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :kms_key_id,
  :replication_instance_arn,
  :replication_instance_public_ip_address,
  :replication_instance_private_ip_address,
  :replication_instance_public_ip_addresses,
  :replication_instance_private_ip_addresses,
  :publicly_accessible,
  :secondary_availability_zone)
  include Aws::Structure
end

#vpc_security_groupsArray<Types::VpcSecurityGroupMembership>

The VPC security group for the instance.



3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 3075

class ReplicationInstance < Struct.new(
  :replication_instance_identifier,
  :replication_instance_class,
  :replication_instance_status,
  :allocated_storage,
  :instance_create_time,
  :vpc_security_groups,
  :availability_zone,
  :replication_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :kms_key_id,
  :replication_instance_arn,
  :replication_instance_public_ip_address,
  :replication_instance_private_ip_address,
  :replication_instance_public_ip_addresses,
  :replication_instance_private_ip_addresses,
  :publicly_accessible,
  :secondary_availability_zone)
  include Aws::Structure
end