You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::DatabaseMigrationService::Types::CreateReplicationInstanceMessage
- Inherits:
-
Struct
- Object
- Struct
- Aws::DatabaseMigrationService::Types::CreateReplicationInstanceMessage
- Defined in:
- (unknown)
Overview
When passing CreateReplicationInstanceMessage as input to an Aws::Client method, you can use a vanilla 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,
dns_name_servers: "String",
resource_identifier: "String",
}
Instance Attribute Summary collapse
-
#allocated_storage ⇒ Integer
The amount of storage (in gigabytes) to be initially allocated for the replication instance.
-
#auto_minor_version_upgrade ⇒ Boolean
A value that indicates whether minor engine upgrades are applied automatically to the replication instance during the maintenance window.
-
#availability_zone ⇒ String
The Availability Zone where the replication instance will be created.
-
#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.
-
#engine_version ⇒ String
The engine version number of the replication instance.
-
#kms_key_id ⇒ String
An AWS KMS key identifier that is used to encrypt the data on the replication instance.
-
#multi_az ⇒ Boolean
Specifies whether the replication instance is a Multi-AZ deployment.
-
#preferred_maintenance_window ⇒ String
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
-
#publicly_accessible ⇒ Boolean
Specifies the accessibility options for 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.
-
#replication_subnet_group_identifier ⇒ String
A subnet group to associate with the replication instance.
-
#resource_identifier ⇒ String
A friendly name for the resource identifier at the end of the
EndpointArn
response parameter that is returned in the createdEndpoint
object. -
#tags ⇒ Array<Types::Tag>
One or more tags to be assigned to the replication instance.
-
#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 initially allocated for the replication instance.
#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
#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 AWS Region, for example: us-east-1d
#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"
#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.
#kms_key_id ⇒ String
An AWS 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 AWS DMS
uses 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.
#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
.
#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 AWS Region, occurring on a random day of the week.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
#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
.
#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 AWS DMS replication instance for your migration.
#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
#replication_subnet_group_identifier ⇒ String
A subnet group to associate with the replication instance.
#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, AWS DMS generates a default
identifier value for the end of EndpointArn
.
#tags ⇒ Array<Types::Tag>
One or more tags to be assigned to the replication instance.
#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.