Package software.amazon.awscdk.services.dms

Interface CfnReplicationInstanceProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnReplicationInstanceProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.405Z") @Stability(Stable) public interface CfnReplicationInstanceProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnReplicationInstance.

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.*;
 CfnReplicationInstanceProps cfnReplicationInstanceProps = CfnReplicationInstanceProps.builder()
         .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();

  • Method Details

    • getReplicationInstanceClass

      @Stability(Stable) @NotNull 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 .

    • getAllocatedStorage

      @Stability(Stable) @Nullable default Number getAllocatedStorage()
      The amount of storage (in gigabytes) to be initially allocated for the replication instance.

    • getAllowMajorVersionUpgrade

      @Stability(Stable) @Nullable default 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.

    • getAutoMinorVersionUpgrade

      @Stability(Stable) @Nullable default 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

    • getAvailabilityZone

      @Stability(Stable) @Nullable default 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 .

    • getEngineVersion

      @Stability(Stable) @Nullable default 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.

    • getKmsKeyId

      @Stability(Stable) @Nullable default 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 .

    • getMultiAz

      @Stability(Stable) @Nullable default 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 .

    • getPreferredMaintenanceWindow

      @Stability(Stable) @Nullable default 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.

    • getPubliclyAccessible

      @Stability(Stable) @Nullable default 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 .

    • getReplicationInstanceIdentifier

      @Stability(Stable) @Nullable default 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

    • getReplicationSubnetGroupIdentifier

      @Stability(Stable) @Nullable default String getReplicationSubnetGroupIdentifier()
      A subnet group to associate with the replication instance.

    • getResourceIdentifier

      @Stability(Stable) @Nullable default 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 .

    • getTags

      @Stability(Stable) @Nullable default List<CfnTag> getTags()
      One or more tags to be assigned to the replication instance.

    • getVpcSecurityGroupIds

      @Stability(Stable) @Nullable default List<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.

    • builder

      @Stability(Stable) static CfnReplicationInstanceProps.Builder builder()
      Returns:
      a CfnReplicationInstanceProps.Builder of CfnReplicationInstanceProps