Class ReplicationConfig


  • public class ReplicationConfig
    extends com.pulumi.resources.CustomResource
    Provides a DMS Serverless replication config resource. > **NOTE:** Changing most arguments will stop the replication if it is running. You can set `startReplication` to resume the replication afterwards. ## Example Usage
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.dms.ReplicationConfig;
     import com.pulumi.aws.dms.ReplicationConfigArgs;
     import com.pulumi.aws.dms.inputs.ReplicationConfigComputeConfigArgs;
     import java.util.ArrayList;
     import java.util.Arrays;
     import java.util.Map;
     import java.io.File;
     import java.nio.file.Files;
     import java.nio.file.Paths;
     
     public class App {
         public static void main(String[] args) {
             Pulumi.run(App::stack);
         }
     
         public static void stack(Context ctx) {
             var name = new ReplicationConfig("name", ReplicationConfigArgs.builder()
                 .computeConfig(ReplicationConfigComputeConfigArgs.builder()
                     .replicationSubnetGroupId(default_.replicationSubnetGroupId())
                     .maxCapacityUnits(64)
                     .minCapacityUnits(2)
                     .preferredMaintenanceWindow("sun:23:45-mon:00:30")
                     .build())
                 .replicationConfigIdentifier("test-dms-serverless-replication-tf")
                 .resourceIdentifier("test-dms-serverless-replication-tf")
                 .replicationType("cdc")
                 .sourceEndpointArn(source.endpointArn())
                 .targetEndpointArn(target.endpointArn())
                 .tableMappings("""
       {
         \"rules\":[{\"rule-type\":\"selection\",\"rule-id\":\"1\",\"rule-name\":\"1\",\"rule-action\":\"include\",\"object-locator\":{\"schema-name\":\"%%\",\"table-name\":\"%%\"}}]
       }
                 """)
                 .startReplication(true)
                 .build());
     
         }
     }
     
     
    ## Import ### Identity Schema #### Required - `arn` (String) ARN of the DMS replication configuration. Using `pulumi import`, import a replication config using the `arn`. For example: ```sh $ pulumi import aws:dms/replicationConfig:ReplicationConfig example arn:aws:dms:us-east-1:123456789012:replication-config:UX6OL6MHMMJKFFOXE3H7LLJCMEKBDUG4ZV7DRSI ```
    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal
      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal
    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<ReplicationConfigComputeConfig> computeConfig()  
      static ReplicationConfig get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ReplicationConfigState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> replicationConfigIdentifier()  
      com.pulumi.core.Output<java.lang.String> replicationSettings()  
      com.pulumi.core.Output<java.lang.String> replicationType()  
      com.pulumi.core.Output<java.lang.String> resourceIdentifier()  
      com.pulumi.core.Output<java.lang.String> sourceEndpointArn()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> startReplication()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> supplementalSettings()  
      com.pulumi.core.Output<java.lang.String> tableMappings()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.lang.String> targetEndpointArn()  
      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture
      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • ReplicationConfig

        public ReplicationConfig​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.
      • ReplicationConfig

        public ReplicationConfig​(java.lang.String name,
                                 ReplicationConfigArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
      • ReplicationConfig

        public ReplicationConfig​(java.lang.String name,
                                 ReplicationConfigArgs args,
                                 @Nullable
                                 com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.
    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN for the serverless replication config.
      • computeConfig

        public com.pulumi.core.Output<ReplicationConfigComputeConfig> computeConfig()
        Returns:
        Configuration block for provisioning an DMS Serverless replication.
      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
      • replicationConfigIdentifier

        public com.pulumi.core.Output<java.lang.String> replicationConfigIdentifier()
        Returns:
        Unique identifier that you want to use to create the config.
      • replicationSettings

        public com.pulumi.core.Output<java.lang.String> replicationSettings()
        Returns:
        An escaped JSON string that are used to provision this replication configuration. For example, [Change processing tuning settings](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TaskSettings.ChangeProcessingTuning.html)
      • replicationType

        public com.pulumi.core.Output<java.lang.String> replicationType()
        Returns:
        The migration type. Can be one of `full-load | cdc | full-load-and-cdc`.
      • resourceIdentifier

        public com.pulumi.core.Output<java.lang.String> resourceIdentifier()
        Returns:
        Unique value or name that you set for a given resource that can be used to construct an ARN for that resource. For more information, see [Fine-grained access control using resource names and tags](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#CHAP_Security.FineGrainedAccess)
      • sourceEndpointArn

        public com.pulumi.core.Output<java.lang.String> sourceEndpointArn()
        Returns:
        ARN string that uniquely identifies the source endpoint.
      • startReplication

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> startReplication()
        Returns:
        Whether to run or stop the serverless replication, default is false.
      • supplementalSettings

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> supplementalSettings()
        Returns:
        JSON settings for specifying supplemental data. For more information see [Specifying supplemental data for task settings](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.TaskData.html)
      • tableMappings

        public com.pulumi.core.Output<java.lang.String> tableMappings()
        Returns:
        An escaped JSON string that contains the table mappings. For information on table mapping see [Using Table Mapping with an AWS Database Migration Service Task to Select and Filter Data](http://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TableMapping.html)
      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        A map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
      • targetEndpointArn

        public com.pulumi.core.Output<java.lang.String> targetEndpointArn()
        Returns:
        ARN string that uniquely identifies the target endpoint.
      • get

        public static ReplicationConfig get​(java.lang.String name,
                                            com.pulumi.core.Output<java.lang.String> id,
                                            @Nullable
                                            ReplicationConfigState state,
                                            @Nullable
                                            com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.