Class CfnReplicationInstance
A CloudFormation AWS::DMS::ReplicationInstance
.
Inherited Members
Namespace: Amazon.CDK.AWS.DMS
Assembly: Amazon.CDK.AWS.DMS.dll
Syntax (csharp)
public class CfnReplicationInstance : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnReplicationInstance
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::DMS::ReplicationInstance
resource creates an AWS 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.
CloudformationResource: AWS::DMS::ReplicationInstance
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.DMS;
var cfnReplicationInstance = new CfnReplicationInstance(this, "MyCfnReplicationInstance", new CfnReplicationInstanceProps {
ReplicationInstanceClass = "replicationInstanceClass",
// the properties below are optional
AllocatedStorage = 123,
AllowMajorVersionUpgrade = false,
AutoMinorVersionUpgrade = false,
AvailabilityZone = "availabilityZone",
EngineVersion = "engineVersion",
KmsKeyId = "kmsKeyId",
MultiAz = false,
PreferredMaintenanceWindow = "preferredMaintenanceWindow",
PubliclyAccessible = false,
ReplicationInstanceIdentifier = "replicationInstanceIdentifier",
ReplicationSubnetGroupIdentifier = "replicationSubnetGroupIdentifier",
ResourceIdentifier = "resourceIdentifier",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
VpcSecurityGroupIds = new [] { "vpcSecurityGroupIds" }
});
Synopsis
Constructors
CfnReplicationInstance(Construct, String, ICfnReplicationInstanceProps) | Create a new |
CfnReplicationInstance(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnReplicationInstance(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AllocatedStorage | The amount of storage (in gigabytes) to be initially allocated for the replication instance. |
AllowMajorVersionUpgrade | Indicates that major version upgrades are allowed. |
AttrReplicationInstancePrivateIpAddresses | One or more private IP addresses for the replication instance. |
AttrReplicationInstancePublicIpAddresses | One or more public IP addresses for the replication instance. |
AutoMinorVersionUpgrade | A value that indicates whether minor engine upgrades are applied automatically to the replication instance during the maintenance window. |
AvailabilityZone | The Availability Zone that the replication instance will be created in. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
EngineVersion | The engine version number of the replication instance. |
KmsKeyId | An AWS KMS key identifier that is used to encrypt the data on the replication instance. |
MultiAz | Specifies whether the replication instance is a Multi-AZ deployment. |
PreferredMaintenanceWindow | The weekly time range during which system maintenance can occur, in UTC. |
PubliclyAccessible | Specifies the accessibility options for the replication instance. |
ReplicationInstanceClass | The compute and memory capacity of the replication instance as defined for the specified replication instance class. |
ReplicationInstanceIdentifier | The replication instance identifier. This parameter is stored as a lowercase string. |
ReplicationSubnetGroupIdentifier | A subnet group to associate with the replication instance. |
ResourceIdentifier | A display name for the resource identifier at the end of the |
Tags | One or more tags to be assigned to the replication instance. |
VpcSecurityGroupIds | Specifies the virtual private cloud (VPC) security group to be used with the replication instance. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnReplicationInstance(Construct, String, ICfnReplicationInstanceProps)
Create a new AWS::DMS::ReplicationInstance
.
public CfnReplicationInstance(Construct scope, string id, ICfnReplicationInstanceProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnReplicationInstanceProps
- resource properties.
CfnReplicationInstance(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnReplicationInstance(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnReplicationInstance(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnReplicationInstance(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AllocatedStorage
The amount of storage (in gigabytes) to be initially allocated for the replication instance.
public virtual Nullable<double> AllocatedStorage { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
AllowMajorVersionUpgrade
Indicates that major version upgrades are allowed.
public virtual object AllowMajorVersionUpgrade { get; set; }
Property Value
System.Object
Remarks
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 the EngineVersion
parameter that is a different major version than the replication instance's current version.
AttrReplicationInstancePrivateIpAddresses
One or more private IP addresses for the replication instance.
public virtual string AttrReplicationInstancePrivateIpAddresses { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ReplicationInstancePrivateIpAddresses
AttrReplicationInstancePublicIpAddresses
One or more public IP addresses for the replication instance.
public virtual string AttrReplicationInstancePublicIpAddresses { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ReplicationInstancePublicIpAddresses
AutoMinorVersionUpgrade
A value that indicates whether minor engine upgrades are applied automatically to the replication instance during the maintenance window.
public virtual object AutoMinorVersionUpgrade { get; set; }
Property Value
System.Object
Remarks
This parameter defaults to true
.
Default: true
AvailabilityZone
The Availability Zone that the replication instance will be created in.
public virtual string AvailabilityZone { get; set; }
Property Value
System.String
Remarks
The default value is a random, system-chosen Availability Zone in the endpoint's AWS Region , for example us-east-1d
.
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
EngineVersion
The engine version number of the replication instance.
public virtual string EngineVersion { get; set; }
Property Value
System.String
Remarks
If an engine version number is not specified when a replication instance is created, the default is the latest engine version available.
KmsKeyId
An AWS KMS key identifier that is used to encrypt the data on the replication instance.
public virtual string KmsKeyId { get; set; }
Property Value
System.String
Remarks
If you don't specify a value for the KmsKeyId
parameter, 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 .
MultiAz
Specifies whether the replication instance is a Multi-AZ deployment.
public virtual object MultiAz { get; set; }
Property Value
System.Object
Remarks
You can't set the AvailabilityZone
parameter if the Multi-AZ parameter is set to true
.
PreferredMaintenanceWindow
The weekly time range during which system maintenance can occur, in UTC.
public virtual string PreferredMaintenanceWindow { get; set; }
Property Value
System.String
Remarks
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 ( ddd
): Mon
| Tue
| Wed
| Thu
| Fri
| Sat
| Sun
Constraints : Minimum 30-minute window.
PubliclyAccessible
Specifies the accessibility options for the replication instance.
public virtual object PubliclyAccessible { get; set; }
Property Value
System.Object
Remarks
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
.
ReplicationInstanceClass
The compute and memory capacity of the replication instance as defined for the specified replication instance class.
public virtual string ReplicationInstanceClass { get; set; }
Property Value
System.String
Remarks
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 in the AWS Database Migration Service User Guide .
ReplicationInstanceIdentifier
The replication instance identifier. This parameter is stored as a lowercase string.
public virtual string ReplicationInstanceIdentifier { get; set; }
Property Value
System.String
Remarks
Constraints:
Example: myrepinstance
ReplicationSubnetGroupIdentifier
A subnet group to associate with the replication instance.
public virtual string ReplicationSubnetGroupIdentifier { get; set; }
Property Value
System.String
Remarks
ResourceIdentifier
A display name for the resource identifier at the end of the EndpointArn
response parameter that is returned in the created Endpoint
object.
public virtual string ResourceIdentifier { get; set; }
Property Value
System.String
Remarks
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
One or more tags to be assigned to the replication instance.
public virtual TagManager Tags { get; }
Property Value
Remarks
VpcSecurityGroupIds
Specifies the virtual private cloud (VPC) security group to be used with the replication instance.
public virtual string[] VpcSecurityGroupIds { get; set; }
Property Value
System.String[]
Remarks
The VPC security group must work with the VPC containing the replication instance.
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>