AWS::DMS::ReplicationInstance
The AWS::DMS::ReplicationInstance
resource creates an Amazon DMS replication instance.
To create a ReplicationInstance, you need permissions to create instances. You'll need similar permissions to terminate
instances when you delete stacks with instances.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::DMS::ReplicationInstance", "Properties" : { "AllocatedStorage" :
Integer
, "AllowMajorVersionUpgrade" :Boolean
, "AutoMinorVersionUpgrade" :Boolean
, "AvailabilityZone" :String
, "EngineVersion" :String
, "KmsKeyId" :String
, "MultiAZ" :Boolean
, "NetworkType" :String
, "PreferredMaintenanceWindow" :String
, "PubliclyAccessible" :Boolean
, "ReplicationInstanceClass" :String
, "ReplicationInstanceIdentifier" :String
, "ReplicationSubnetGroupIdentifier" :String
, "ResourceIdentifier" :String
, "Tags" :[ Tag, ... ]
, "VpcSecurityGroupIds" :[ String, ... ]
} }
YAML
Type: AWS::DMS::ReplicationInstance Properties: AllocatedStorage:
Integer
AllowMajorVersionUpgrade:Boolean
AutoMinorVersionUpgrade:Boolean
AvailabilityZone:String
EngineVersion:String
KmsKeyId:String
MultiAZ:Boolean
NetworkType:String
PreferredMaintenanceWindow:String
PubliclyAccessible:Boolean
ReplicationInstanceClass:String
ReplicationInstanceIdentifier:String
ReplicationSubnetGroupIdentifier:String
ResourceIdentifier:String
Tags:- Tag
VpcSecurityGroupIds:- String
Properties
AllocatedStorage
-
The amount of storage (in gigabytes) to be initially allocated for the replication instance.
Required: No
Type: Integer
Update requires: No interruption
AllowMajorVersionUpgrade
-
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.
This parameter must be set to
true
when specifying a value for theEngineVersion
parameter that is a different major version than the replication instance's current version.Required: No
Type: Boolean
Update requires: No interruption
AutoMinorVersionUpgrade
-
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
Required: No
Type: Boolean
Update requires: No interruption
AvailabilityZone
-
The Availability Zone that the replication instance will be created in.
The default value is a random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region, for example
us-east-1d
.Required: No
Type: String
Update requires: No interruption
EngineVersion
-
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.
Required: No
Type: String
Update requires: No interruption
KmsKeyId
-
An Amazon 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, Amazon DMS uses your default encryption key.Amazon 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.
Required: No
Type: String
Update requires: Replacement
MultiAZ
-
Specifies whether the replication instance is a Multi-AZ deployment. You can't set the
AvailabilityZone
parameter if the Multi-AZ parameter is set totrue
.Required: No
Type: Boolean
Update requires: No interruption
NetworkType
-
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.
Required: No
Type: String
Update requires: No interruption
PreferredMaintenanceWindow
-
The weekly time range during which system maintenance can occur, in 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 (
ddd
):Mon
|Tue
|Wed
|Thu
|Fri
|Sat
|Sun
Constraints: Minimum 30-minute window.
Required: No
Type: String
Update requires: No interruption
PubliclyAccessible
-
Specifies the accessibility options for the replication instance. A value of
true
represents an instance with a public IP address. A value offalse
represents an instance with a private IP address. The default value istrue
.Required: No
Type: Boolean
Update requires: Replacement
ReplicationInstanceClass
-
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 Amazon DMS replication instance for your migration in the Amazon Database Migration Service User Guide.Required: Yes
Type: String
Update requires: No interruption
ReplicationInstanceIdentifier
-
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
Required: No
Type: String
Update requires: No interruption
-
ReplicationSubnetGroupIdentifier
-
A subnet group to associate with the replication instance.
Required: No
Type: String
Update requires: Replacement
ResourceIdentifier
-
A display name for the resource identifier at the end of the
EndpointArn
response parameter that is returned in the createdEndpoint
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 asExample-App-ARN1
. For example, this value might result in theEndpointArn
valuearn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1
. If you don't specify aResourceIdentifier
value, Amazon DMS generates a default identifier value for the end ofEndpointArn
.Required: No
Type: String
Update requires: Replacement
-
One or more tags to be assigned to the replication instance.
Required: No
Type: Array of Tag
Update requires: No interruption
VpcSecurityGroupIds
-
Specifies the virtual private cloud (VPC) security group to be used with the replication instance. The VPC security group must work with the VPC containing the replication instance.
Required: No
Type: Array of String
Update requires: No interruption
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref
returns the replication instance ARN.
For more information about using the Ref
function, see Ref
.
Fn::GetAtt
The Fn::GetAtt
intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
For more information about using the Fn::GetAtt
intrinsic function, see Fn::GetAtt
.
ReplicationInstancePrivateIpAddresses
-
One or more private IP addresses for the replication instance.
ReplicationInstancePublicIpAddresses
-
One or more public IP addresses for the replication instance.
Examples
JSON
{ "AWSTemplateFormatVersion": "2010-09-09", "Resources": { "BasicReplicationInstance": { "Type": "AWS::DMS::ReplicationInstance", "Properties": { "ReplicationInstanceClass": "dms.t2.small" } } } }
YAML
AWSTemplateFormatVersion: 2010-09-09 Resources: BasicReplicationInstance: Properties: ReplicationInstanceClass: dms.t2.small Type: "AWS::DMS::ReplicationInstance"
See also
-
CreateReplicationInstance in the Amazon Database Migration Service API Reference