Package software.amazon.awscdk.services.dms

Interface CfnReplicationConfigProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnReplicationConfigProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-21T06:34:06.349Z")
@Stability(Stable)
public interface CfnReplicationConfigProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnReplicationConfig.

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.*;
 Object replicationSettings;
 Object supplementalSettings;
 Object tableMappings;
 CfnReplicationConfigProps cfnReplicationConfigProps = CfnReplicationConfigProps.builder()
         .computeConfig(ComputeConfigProperty.builder()
                 .maxCapacityUnits(123)
                 // the properties below are optional
                 .availabilityZone("availabilityZone")
                 .dnsNameServers("dnsNameServers")
                 .kmsKeyId("kmsKeyId")
                 .minCapacityUnits(123)
                 .multiAz(false)
                 .preferredMaintenanceWindow("preferredMaintenanceWindow")
                 .replicationSubnetGroupId("replicationSubnetGroupId")
                 .vpcSecurityGroupIds(List.of("vpcSecurityGroupIds"))
                 .build())
         .replicationConfigIdentifier("replicationConfigIdentifier")
         .replicationType("replicationType")
         .sourceEndpointArn("sourceEndpointArn")
         .tableMappings(tableMappings)
         .targetEndpointArn("targetEndpointArn")
         // the properties below are optional
         .replicationSettings(replicationSettings)
         .resourceIdentifier("resourceIdentifier")
         .supplementalSettings(supplementalSettings)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationconfig.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnReplicationConfigProps.Builder	A builder for CfnReplicationConfigProps
static final class	CfnReplicationConfigProps.Jsii$Proxy	An implementation for CfnReplicationConfigProps

Method Summary

Modifier and Type	Method	Description
static CfnReplicationConfigProps.Builder	builder()
Object	getComputeConfig()	Configuration parameters for provisioning an AWS DMS Serverless replication.
String	getReplicationConfigIdentifier()	A unique identifier that you want to use to create a ReplicationConfigArn that is returned as part of the output from this action.
default Object	getReplicationSettings()	Optional JSON settings for AWS DMS Serverless replications that are provisioned using this replication configuration.
String	getReplicationType()	The type of AWS DMS Serverless replication to provision using this replication configuration.
default String	getResourceIdentifier()	Optional unique value or name that you set for a given resource that can be used to construct an Amazon Resource Name (ARN) for that resource.
String	getSourceEndpointArn()	The Amazon Resource Name (ARN) of the source endpoint for this AWS DMS Serverless replication configuration.
default Object	getSupplementalSettings()	Optional JSON settings for specifying supplemental data.
Object	getTableMappings()	JSON table mappings for AWS DMS Serverless replications that are provisioned using this replication configuration.
default List<CfnTag>	getTags()	One or more optional tags associated with resources used by the AWS DMS Serverless replication.
String	getTargetEndpointArn()	The Amazon Resource Name (ARN) of the target endpoint for this AWS DMS serverless replication configuration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getComputeConfig

@Stability(Stable)
@NotNull
Object getComputeConfig()

Configuration parameters for provisioning an AWS DMS Serverless replication.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationconfig.html#cfn-dms-replicationconfig-computeconfig

getReplicationConfigIdentifier

@Stability(Stable)
@NotNull
String getReplicationConfigIdentifier()

A unique identifier that you want to use to create a ReplicationConfigArn that is returned as part of the output from this action.

You can then pass this output ReplicationConfigArn as the value of the ReplicationConfigArn option for other actions to identify both AWS DMS Serverless replications and replication configurations that you want those actions to operate on. For some actions, you can also use either this unique identifier or a corresponding ARN in action filters to identify the specific replication and replication configuration to operate on.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationconfig.html#cfn-dms-replicationconfig-replicationconfigidentifier

getReplicationType

@Stability(Stable)
@NotNull
String getReplicationType()

The type of AWS DMS Serverless replication to provision using this replication configuration.

Possible values:

• "full-load"
• "cdc"
• "full-load-and-cdc"

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationconfig.html#cfn-dms-replicationconfig-replicationtype

getSourceEndpointArn

@Stability(Stable)
@NotNull
String getSourceEndpointArn()

The Amazon Resource Name (ARN) of the source endpoint for this AWS DMS Serverless replication configuration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationconfig.html#cfn-dms-replicationconfig-sourceendpointarn

getTableMappings

@Stability(Stable)
@NotNull
Object getTableMappings()

JSON table mappings for AWS DMS Serverless replications that are provisioned using this replication configuration.

For more information, see Specifying table selection and transformations rules using JSON .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationconfig.html#cfn-dms-replicationconfig-tablemappings

getTargetEndpointArn

@Stability(Stable)
@NotNull
String getTargetEndpointArn()

The Amazon Resource Name (ARN) of the target endpoint for this AWS DMS serverless replication configuration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationconfig.html#cfn-dms-replicationconfig-targetendpointarn

getReplicationSettings

@Stability(Stable)
@Nullable
default Object getReplicationSettings()

Optional JSON settings for AWS DMS Serverless replications that are provisioned using this replication configuration.

For example, see Change processing tuning settings .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationconfig.html#cfn-dms-replicationconfig-replicationsettings

getResourceIdentifier

@Stability(Stable)
@Nullable
default String getResourceIdentifier()

Optional unique value or name that you set for a given resource that can be used to construct an Amazon Resource Name (ARN) for that resource.

For more information, see Fine-grained access control using resource names and tags .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationconfig.html#cfn-dms-replicationconfig-resourceidentifier

getSupplementalSettings

@Stability(Stable)
@Nullable
default Object getSupplementalSettings()

Optional JSON settings for specifying supplemental data.

For more information, see Specifying supplemental data for task settings .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationconfig.html#cfn-dms-replicationconfig-supplementalsettings

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

One or more optional tags associated with resources used by the AWS DMS Serverless replication.

For more information, see Tagging resources in AWS Database Migration Service .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationconfig.html#cfn-dms-replicationconfig-tags

builder

@Stability(Stable)
static CfnReplicationConfigProps.Builder builder()

Returns:

a CfnReplicationConfigProps.Builder of CfnReplicationConfigProps