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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#allocated_storage ⇒ Integer

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

Returns:

  • (Integer) 


1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
 
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1638

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,
  :dns_name_servers,
  :resource_identifier,
  :network_type,
  :kerberos_authentication_settings)
  SENSITIVE = []
  include Aws::Structure
end

#auto_minor_version_upgrade ⇒ Boolean

A value that indicates whether minor engine upgrades are applied automatically to the replication instance during the maintenance window. This parameter defaults to ‘true`.

Default: ‘true`

Returns:

  • (Boolean) 


1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
 
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1638

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,
  :dns_name_servers,
  :resource_identifier,
  :network_type,
  :kerberos_authentication_settings)
  SENSITIVE = []
  include Aws::Structure
end

#availability_zone ⇒ String

The Availability Zone where the replication instance will be created. The default value is a random, system-chosen Availability Zone in the endpoint’s Amazon Web Services Region, for example: ‘us-east-1d`.

Returns:

  • (String) 


1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
 
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1638

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,
  :dns_name_servers,
  :resource_identifier,
  :network_type,
  :kerberos_authentication_settings)
  SENSITIVE = []
  include Aws::Structure
end

#dns_name_servers ⇒ String

A list of custom DNS name servers supported for the replication instance to access your on-premise source or target database. This list overrides the default name servers supported by the replication instance. You can specify a comma-separated list of internet addresses for up to four on-premise DNS name servers. For example: ‘“1.1.1.1,2.2.2.2,3.3.3.3,4.4.4.4”`

Returns:

  • (String) 


1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
 
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1638

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,
  :dns_name_servers,
  :resource_identifier,
  :network_type,
  :kerberos_authentication_settings)
  SENSITIVE = []
  include Aws::Structure
end

#engine_version ⇒ String

The engine version number of the replication instance.

If an engine version number is not specified when a replication instance is created, the default is the latest engine version available.

Returns:

  • (String) 


1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
 
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1638

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,
  :dns_name_servers,
  :resource_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 creating a replication instance.

Returns:



1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
 
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1638

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,
  :dns_name_servers,
  :resource_identifier,
  :network_type,
  :kerberos_authentication_settings)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

An KMS key identifier that is used to encrypt the data on the replication instance.

If you don’t specify a value for the ‘KmsKeyId` parameter, then DMS uses your default encryption key.

KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.

Returns:

  • (String) 


1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
 
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1638

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,
  :dns_name_servers,
  :resource_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) 


1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
 
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1638

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,
  :dns_name_servers,
  :resource_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) 


1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
 
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1638

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,
  :dns_name_servers,
  :resource_identifier,
  :network_type,
  :kerberos_authentication_settings)
  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`

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


1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
 
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1638

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,
  :dns_name_servers,
  :resource_identifier,
  :network_type,
  :kerberos_authentication_settings)
  SENSITIVE = []
  include Aws::Structure
end

#publicly_accessible ⇒ Boolean

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) 


1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
 
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1638

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,
  :dns_name_servers,
  :resource_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 [ Choosing the right DMS replication instance]; and, [Selecting the best size for a replication instance].

[1]: docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.Types.html [2]: docs.aws.amazon.com/dms/latest/userguide/CHAP_BestPractices.SizingReplicationInstance.html

Returns:

  • (String) 


1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
 
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1638

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,
  :dns_name_servers,
  :resource_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.

Constraints:

  • Must contain 1-63 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Can’t end with a hyphen or contain two consecutive hyphens.

Example: ‘myrepinstance`

Returns:

  • (String) 


1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
 
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1638

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,
  :dns_name_servers,
  :resource_identifier,
  :network_type,
  :kerberos_authentication_settings)
  SENSITIVE = []
  include Aws::Structure
end

#replication_subnet_group_identifier ⇒ String

A subnet group to associate with the replication instance.

Returns:

  • (String) 


1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
 
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1638

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,
  :dns_name_servers,
  :resource_identifier,
  :network_type,
  :kerberos_authentication_settings)
  SENSITIVE = []
  include Aws::Structure
end

#resource_identifier ⇒ String

A friendly name for the resource identifier at the end of the ‘EndpointArn` response parameter that is returned in the created `Endpoint` object. The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen (’-‘). Also, it can’t end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as ‘Example-App-ARN1`. For example, this value might result in the `EndpointArn` value `arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1`. If you don’t specify a ‘ResourceIdentifier` value, DMS generates a default identifier value for the end of `EndpointArn`.

Returns:

  • (String) 


1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
 
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1638

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,
  :dns_name_servers,
  :resource_identifier,
  :network_type,
  :kerberos_authentication_settings)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

One or more tags to be assigned to the replication instance.

Returns:



1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
 
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1638

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,
  :dns_name_servers,
  :resource_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>) 


1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
 
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 1638

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,
  :dns_name_servers,
  :resource_identifier,
  :network_type,
  :kerberos_authentication_settings)
  SENSITIVE = []
  include Aws::Structure
end