CfnReplicationInstance

java.lang.Object
- software.constructs.Construct
- - software.amazon.awscdk.core.Construct
  - - software.amazon.awscdk.core.CfnElement
    - - software.amazon.awscdk.core.CfnRefElement
      - software.amazon.awscdk.core.CfnResource
        
        software.amazon.awscdk.services.dms.CfnReplicationInstance

All Implemented Interfaces:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:35.912Z")
public class CfnReplicationInstance
extends CfnResource
implements IInspectable

A CloudFormation `AWS::DMS::ReplicationInstance`.

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.dms.*;
 CfnReplicationInstance cfnReplicationInstance = CfnReplicationInstance.Builder.create(this, "MyCfnReplicationInstance")
         .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(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .vpcSecurityGroupIds(List.of("vpcSecurityGroupIds"))
         .build();

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CfnReplicationInstance.Builder
A fluent builder for CfnReplicationInstance.
- Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
  IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
- Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
  IConstruct.Jsii$Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`CfnReplicationInstance.Builder` A fluent builder for `CfnReplicationInstance`.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnReplicationInstance(Construct scope, java.lang.String id, CfnReplicationInstanceProps props)` Create a new `AWS::DMS::ReplicationInstance`.
`protected`	`CfnReplicationInstance(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnReplicationInstance(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Number`	`getAllocatedStorage()` The amount of storage (in gigabytes) to be initially allocated for the replication instance.
`java.lang.Object`	`getAllowMajorVersionUpgrade()` Indicates that major version upgrades are allowed.
`java.lang.String`	`getAttrReplicationInstancePrivateIpAddresses()` One or more private IP addresses for the replication instance.
`java.lang.String`	`getAttrReplicationInstancePublicIpAddresses()` One or more public IP addresses for the replication instance.
`java.lang.Object`	`getAutoMinorVersionUpgrade()` A value that indicates whether minor engine upgrades are applied automatically to the replication instance during the maintenance window.
`java.lang.String`	`getAvailabilityZone()` The Availability Zone that the replication instance will be created in.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.String`	`getEngineVersion()` The engine version number of the replication instance.
`java.lang.String`	`getKmsKeyId()` An AWS KMS key identifier that is used to encrypt the data on the replication instance.
`java.lang.Object`	`getMultiAz()` Specifies whether the replication instance is a Multi-AZ deployment.
`java.lang.String`	`getPreferredMaintenanceWindow()` The weekly time range during which system maintenance can occur, in UTC.
`java.lang.Object`	`getPubliclyAccessible()` Specifies the accessibility options for the replication instance.
`java.lang.String`	`getReplicationInstanceClass()` The compute and memory capacity of the replication instance as defined for the specified replication instance class.
`java.lang.String`	`getReplicationInstanceIdentifier()` The replication instance identifier.
`java.lang.String`	`getReplicationSubnetGroupIdentifier()` A subnet group to associate with the replication instance.
`java.lang.String`	`getResourceIdentifier()` A display name for the resource identifier at the end of the `EndpointArn` response parameter that is returned in the created `Endpoint` object.
`TagManager`	`getTags()` One or more tags to be assigned to the replication instance.
`java.util.List<java.lang.String>`	`getVpcSecurityGroupIds()` Specifies the virtual private cloud (VPC) security group to be used with the replication instance.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setAllocatedStorage(java.lang.Number value)` The amount of storage (in gigabytes) to be initially allocated for the replication instance.
`void`	`setAllowMajorVersionUpgrade(java.lang.Boolean value)` Indicates that major version upgrades are allowed.
`void`	`setAllowMajorVersionUpgrade(IResolvable value)` Indicates that major version upgrades are allowed.
`void`	`setAutoMinorVersionUpgrade(java.lang.Boolean value)` A value that indicates whether minor engine upgrades are applied automatically to the replication instance during the maintenance window.
`void`	`setAutoMinorVersionUpgrade(IResolvable value)` A value that indicates whether minor engine upgrades are applied automatically to the replication instance during the maintenance window.
`void`	`setAvailabilityZone(java.lang.String value)` The Availability Zone that the replication instance will be created in.
`void`	`setEngineVersion(java.lang.String value)` The engine version number of the replication instance.
`void`	`setKmsKeyId(java.lang.String value)` An AWS KMS key identifier that is used to encrypt the data on the replication instance.
`void`	`setMultiAz(java.lang.Boolean value)` Specifies whether the replication instance is a Multi-AZ deployment.
`void`	`setMultiAz(IResolvable value)` Specifies whether the replication instance is a Multi-AZ deployment.
`void`	`setPreferredMaintenanceWindow(java.lang.String value)` The weekly time range during which system maintenance can occur, in UTC.
`void`	`setPubliclyAccessible(java.lang.Boolean value)` Specifies the accessibility options for the replication instance.
`void`	`setPubliclyAccessible(IResolvable value)` Specifies the accessibility options for the replication instance.
`void`	`setReplicationInstanceClass(java.lang.String value)` The compute and memory capacity of the replication instance as defined for the specified replication instance class.
`void`	`setReplicationInstanceIdentifier(java.lang.String value)` The replication instance identifier.
`void`	`setReplicationSubnetGroupIdentifier(java.lang.String value)` A subnet group to associate with the replication instance.
`void`	`setResourceIdentifier(java.lang.String value)` A display name for the resource identifier at the end of the `EndpointArn` response parameter that is returned in the created `Endpoint` object.
`void`	`setVpcSecurityGroupIds(java.util.List<java.lang.String> value)` Specifies the virtual private cloud (VPC) security group to be used with the replication instance.

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnReplicationInstance
```
protected CfnReplicationInstance(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnReplicationInstance
```
protected CfnReplicationInstance(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnReplicationInstance
```
public CfnReplicationInstance(Construct scope,
                              java.lang.String id,
                              CfnReplicationInstanceProps props)
```
    Create a new `AWS::DMS::ReplicationInstance`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
    
    props - - resource properties. This parameter is required.
- Method Detail
  - inspect
```
public void inspect(TreeInspector inspector)
```
    Examines the CloudFormation resource and discloses attributes.
    
    Specified by:
    
    inspect in interface IInspectable
    
    Parameters:
    
    inspector - - tree inspector to collect and process attributes. This parameter is required.
  - renderProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrReplicationInstancePrivateIpAddresses
```
public java.lang.String getAttrReplicationInstancePrivateIpAddresses()
```
    One or more private IP addresses for the replication instance.
  - getAttrReplicationInstancePublicIpAddresses
```
public java.lang.String getAttrReplicationInstancePublicIpAddresses()
```
    One or more public IP addresses for the replication instance.
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
public TagManager getTags()
```
    One or more tags to be assigned to the replication instance.
  - getReplicationInstanceClass
```
public java.lang.String getReplicationInstanceClass()
```
    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 in the AWS Database Migration Service User Guide .
  - setReplicationInstanceClass
```
public void setReplicationInstanceClass(java.lang.String value)
```
    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 in the AWS Database Migration Service User Guide .
  - getAllocatedStorage
```
public java.lang.Number getAllocatedStorage()
```
    The amount of storage (in gigabytes) to be initially allocated for the replication instance.
  - setAllocatedStorage
```
public void setAllocatedStorage(java.lang.Number value)
```
    The amount of storage (in gigabytes) to be initially allocated for the replication instance.
  - getAllowMajorVersionUpgrade
```
public java.lang.Object getAllowMajorVersionUpgrade()
```
    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 the EngineVersion parameter that is a different major version than the replication instance's current version.
  - setAllowMajorVersionUpgrade
```
public void setAllowMajorVersionUpgrade(java.lang.Boolean value)
```
    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 the EngineVersion parameter that is a different major version than the replication instance's current version.
  - setAllowMajorVersionUpgrade
```
public void setAllowMajorVersionUpgrade(IResolvable value)
```
    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 the EngineVersion parameter that is a different major version than the replication instance's current version.
  - getAutoMinorVersionUpgrade
```
public java.lang.Object getAutoMinorVersionUpgrade()
```
    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
  - setAutoMinorVersionUpgrade
```
public void setAutoMinorVersionUpgrade(java.lang.Boolean value)
```
    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
  - setAutoMinorVersionUpgrade
```
public void setAutoMinorVersionUpgrade(IResolvable value)
```
    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
  - getAvailabilityZone
```
public java.lang.String getAvailabilityZone()
```
    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 AWS Region , for example us-east-1d .
  - setAvailabilityZone
```
public void setAvailabilityZone(java.lang.String value)
```
    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 AWS Region , for example us-east-1d .
  - getEngineVersion
```
public java.lang.String getEngineVersion()
```
    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.
  - setEngineVersion
```
public void setEngineVersion(java.lang.String value)
```
    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.
  - getKmsKeyId
```
public java.lang.String getKmsKeyId()
```
    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, 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 .
  - setKmsKeyId
```
public void setKmsKeyId(java.lang.String value)
```
    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, 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 .
  - getMultiAz
```
public java.lang.Object getMultiAz()
```
    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 .
  - setMultiAz
```
public void setMultiAz(java.lang.Boolean value)
```
    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 .
  - setMultiAz
```
public void setMultiAz(IResolvable value)
```
    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 .
  - getPreferredMaintenanceWindow
```
public java.lang.String getPreferredMaintenanceWindow()
```
    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 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.
  - setPreferredMaintenanceWindow
```
public void setPreferredMaintenanceWindow(java.lang.String value)
```
    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 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.
  - getPubliclyAccessible
```
public java.lang.Object getPubliclyAccessible()
```
    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 .
  - setPubliclyAccessible
```
public void setPubliclyAccessible(java.lang.Boolean value)
```
    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 .
  - setPubliclyAccessible
```
public void setPubliclyAccessible(IResolvable value)
```
    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 .
  - getReplicationInstanceIdentifier
```
public java.lang.String getReplicationInstanceIdentifier()
```
    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
  - setReplicationInstanceIdentifier
```
public void setReplicationInstanceIdentifier(java.lang.String value)
```
    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
  - getReplicationSubnetGroupIdentifier
```
public java.lang.String getReplicationSubnetGroupIdentifier()
```
    A subnet group to associate with the replication instance.
  - setReplicationSubnetGroupIdentifier
```
public void setReplicationSubnetGroupIdentifier(java.lang.String value)
```
    A subnet group to associate with the replication instance.
  - getResourceIdentifier
```
public java.lang.String getResourceIdentifier()
```
    A display 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 .
  - setResourceIdentifier
```
public void setResourceIdentifier(java.lang.String value)
```
    A display 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 .
  - getVpcSecurityGroupIds
```
public java.util.List<java.lang.String> getVpcSecurityGroupIds()
```
    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.
  - setVpcSecurityGroupIds
```
public void setVpcSecurityGroupIds(java.util.List<java.lang.String> value)
```
    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.

Class CfnReplicationInstance

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnReplicationInstance

CfnReplicationInstance

CfnReplicationInstance

Method Detail

inspect

renderProperties

getAttrReplicationInstancePrivateIpAddresses

getAttrReplicationInstancePublicIpAddresses

getCfnProperties

getTags

getReplicationInstanceClass

setReplicationInstanceClass

getAllocatedStorage

setAllocatedStorage

getAllowMajorVersionUpgrade

setAllowMajorVersionUpgrade

setAllowMajorVersionUpgrade

getAutoMinorVersionUpgrade

setAutoMinorVersionUpgrade

setAutoMinorVersionUpgrade

getAvailabilityZone

setAvailabilityZone

getEngineVersion

setEngineVersion

getKmsKeyId

setKmsKeyId

getMultiAz

setMultiAz

setMultiAz

getPreferredMaintenanceWindow

setPreferredMaintenanceWindow

getPubliclyAccessible

setPubliclyAccessible

setPubliclyAccessible

getReplicationInstanceIdentifier

setReplicationInstanceIdentifier

getReplicationSubnetGroupIdentifier

setReplicationSubnetGroupIdentifier

getResourceIdentifier

setResourceIdentifier

getVpcSecurityGroupIds

setVpcSecurityGroupIds