Module dms

This page documents the language specification for the aws package. If you're looking for help working with the inputs, outputs, or functions of aws resources in a Pulumi program, please see the resource documentation for examples and API reference.

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

Others

CertificateArgs
CertificateState
EndpointArgs
EndpointState
EventSubscriptionArgs
EventSubscriptionState
ReplicationInstanceArgs
ReplicationInstanceState
ReplicationSubnetGroupArgs
ReplicationSubnetGroupState
ReplicationTaskArgs
ReplicationTaskState

Resources

Resource Certificate

class Certificate extends CustomResource

Provides a DMS (Data Migration Service) certificate resource. DMS certificates can be created, deleted, and imported.

Note: All arguments including the PEM encoded certificate will be stored in the raw state as plain-text.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

// Create a new certificate
const test = new aws.dms.Certificate("test", {
    certificateId: "test-dms-certificate-tf",
    certificatePem: "...",
});

constructor

new Certificate(name: string, args: CertificateArgs, opts?: pulumi.CustomResourceOptions)

Create a Certificate resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: CertificateState, opts?: pulumi.CustomResourceOptions): Certificate

Get an existing Certificate resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Certificate

Returns true if the given object is an instance of Certificate. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property certificateArn

public certificateArn: pulumi.Output<string>;

The Amazon Resource Name (ARN) for the certificate.

property certificateId

public certificateId: pulumi.Output<string>;

The certificate identifier.

property certificatePem

public certificatePem: pulumi.Output<string | undefined>;

The contents of the .pem X.509 certificate file for the certificate. Either certificatePem or certificateWallet must be set.

property certificateWallet

public certificateWallet: pulumi.Output<string | undefined>;

The contents of the Oracle Wallet certificate for use with SSL. Either certificatePem or certificateWallet must be set.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Endpoint

class Endpoint extends CustomResource

Provides a DMS (Data Migration Service) endpoint resource. DMS endpoints can be created, updated, deleted, and imported.

Note: All arguments including the password will be stored in the raw state as plain-text.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

// Create a new endpoint
const test = new aws.dms.Endpoint("test", {
    certificateArn: "arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012",
    databaseName: "test",
    endpointId: "test-dms-endpoint-tf",
    endpointType: "source",
    engineName: "aurora",
    extraConnectionAttributes: "",
    kmsKeyArn: "arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012",
    password: "test",
    port: 3306,
    serverName: "test",
    sslMode: "none",
    tags: {
        Name: "test",
    },
    username: "test",
});

constructor

new Endpoint(name: string, args: EndpointArgs, opts?: pulumi.CustomResourceOptions)

Create a Endpoint resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: EndpointState, opts?: pulumi.CustomResourceOptions): Endpoint

Get an existing Endpoint resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Endpoint

Returns true if the given object is an instance of Endpoint. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property certificateArn

public certificateArn: pulumi.Output<string>;

The Amazon Resource Name (ARN) for the certificate.

property databaseName

public databaseName: pulumi.Output<string | undefined>;

The name of the endpoint database.

property elasticsearchSettings

public elasticsearchSettings: pulumi.Output<EndpointElasticsearchSettings | undefined>;

Configuration block with Elasticsearch settings. Detailed below.

property endpointArn

public endpointArn: pulumi.Output<string>;

The Amazon Resource Name (ARN) for the endpoint.

property endpointId

public endpointId: pulumi.Output<string>;

The database endpoint identifier.

property endpointType

public endpointType: pulumi.Output<string>;

The type of endpoint. Can be one of source | target.

property engineName

public engineName: pulumi.Output<string>;

property extraConnectionAttributes

public extraConnectionAttributes: pulumi.Output<string>;

Additional attributes associated with the connection. For available attributes see Using Extra Connection Attributes with AWS Database Migration Service.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property kafkaSettings

public kafkaSettings: pulumi.Output<EndpointKafkaSettings | undefined>;

Configuration block with Kafka settings. Detailed below.

property kinesisSettings

public kinesisSettings: pulumi.Output<EndpointKinesisSettings | undefined>;

Configuration block with Kinesis settings. Detailed below.

property kmsKeyArn

public kmsKeyArn: pulumi.Output<string>;

The Amazon Resource Name (ARN) for the KMS key that will be used to encrypt the connection parameters. If you do not specify a value for kmsKeyArn, then AWS DMS will use 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.

property mongodbSettings

public mongodbSettings: pulumi.Output<EndpointMongodbSettings | undefined>;

Configuration block with MongoDB settings. Detailed below.

property password

public password: pulumi.Output<string | undefined>;

The password to be used to login to the endpoint database.

property port

public port: pulumi.Output<number | undefined>;

The port used by the endpoint database.

property s3Settings

public s3Settings: pulumi.Output<EndpointS3Settings | undefined>;

Configuration block with S3 settings. Detailed below.

property serverName

public serverName: pulumi.Output<string | undefined>;

The host name of the server.

property serviceAccessRole

public serviceAccessRole: pulumi.Output<string | undefined>;

The Amazon Resource Name (ARN) used by the service access IAM role for dynamodb endpoints.

property sslMode

public sslMode: pulumi.Output<string>;

The SSL mode to use for the connection. Can be one of none | require | verify-ca | verify-full

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

A map of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property username

public username: pulumi.Output<string | undefined>;

The user name to be used to login to the endpoint database.

Resource EventSubscription

class EventSubscription extends CustomResource

Provides a DMS (Data Migration Service) event subscription resource.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.dms.EventSubscription("example", {
    enabled: true,
    eventCategories: [
        "creation",
        "failure",
    ],
    snsTopicArn: aws_sns_topic.example.arn,
    sourceIds: [aws_dms_replication_task.example.replication_task_id],
    sourceType: "replication-task",
    tags: {
        Name: "example",
    },
});

constructor

new EventSubscription(name: string, args: EventSubscriptionArgs, opts?: pulumi.CustomResourceOptions)

Create a EventSubscription resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: EventSubscriptionState, opts?: pulumi.CustomResourceOptions): EventSubscription

Get an existing EventSubscription resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is EventSubscription

Returns true if the given object is an instance of EventSubscription. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

property enabled

public enabled: pulumi.Output<boolean | undefined>;

Whether the event subscription should be enabled.

property eventCategories

public eventCategories: pulumi.Output<string[]>;

List of event categories to listen for, see DescribeEventCategories for a canonical list.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

Name of event subscription.

property snsTopicArn

public snsTopicArn: pulumi.Output<string>;

SNS topic arn to send events on.

property sourceIds

public sourceIds: pulumi.Output<string[] | undefined>;

Ids of sources to listen to.

property sourceType

public sourceType: pulumi.Output<string | undefined>;

Type of source for events. Valid values: replication-instance or replication-task

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ReplicationInstance

class ReplicationInstance extends CustomResource

Provides a DMS (Data Migration Service) replication instance resource. DMS replication instances can be created, updated, deleted, and imported.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const dmsAssumeRole = pulumi.output(aws.iam.getPolicyDocument({
    statements: [{
        actions: ["sts:AssumeRole"],
        principals: [{
            identifiers: ["dms.amazonaws.com"],
            type: "Service",
        }],
    }],
}, { async: true }));
const dms_access_for_endpoint = new aws.iam.Role("dms-access-for-endpoint", {
    assumeRolePolicy: dmsAssumeRole.json,
});
const dms_access_for_endpoint_AmazonDMSRedshiftS3Role = new aws.iam.RolePolicyAttachment("dms-access-for-endpoint-AmazonDMSRedshiftS3Role", {
    policyArn: "arn:aws:iam::aws:policy/service-role/AmazonDMSRedshiftS3Role",
    role: dms_access_for_endpoint.name,
});
const dms_cloudwatch_logs_role = new aws.iam.Role("dms-cloudwatch-logs-role", {
    assumeRolePolicy: dmsAssumeRole.json,
});
const dms_cloudwatch_logs_role_AmazonDMSCloudWatchLogsRole = new aws.iam.RolePolicyAttachment("dms-cloudwatch-logs-role-AmazonDMSCloudWatchLogsRole", {
    policyArn: "arn:aws:iam::aws:policy/service-role/AmazonDMSCloudWatchLogsRole",
    role: dms_cloudwatch_logs_role.name,
});
const dms_vpc_role = new aws.iam.Role("dms-vpc-role", {
    assumeRolePolicy: dmsAssumeRole.json,
});
const dms_vpc_role_AmazonDMSVPCManagementRole = new aws.iam.RolePolicyAttachment("dms-vpc-role-AmazonDMSVPCManagementRole", {
    policyArn: "arn:aws:iam::aws:policy/service-role/AmazonDMSVPCManagementRole",
    role: dms_vpc_role.name,
});
// Create a new replication instance
const test = new aws.dms.ReplicationInstance("test", {
    allocatedStorage: 20,
    applyImmediately: true,
    autoMinorVersionUpgrade: true,
    availabilityZone: "us-west-2c",
    engineVersion: "3.1.4",
    kmsKeyArn: "arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012",
    multiAz: false,
    preferredMaintenanceWindow: "sun:10:30-sun:14:30",
    publiclyAccessible: true,
    replicationInstanceClass: "dms.t2.micro",
    replicationInstanceId: "test-dms-replication-instance-tf",
    replicationSubnetGroupId: aws_dms_replication_subnet_group_test_dms_replication_subnet_group_tf.id,
    tags: {
        Name: "test",
    },
    vpcSecurityGroupIds: ["sg-12345678"],
});

constructor

new ReplicationInstance(name: string, args: ReplicationInstanceArgs, opts?: pulumi.CustomResourceOptions)

Create a ReplicationInstance resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ReplicationInstanceState, opts?: pulumi.CustomResourceOptions): ReplicationInstance

Get an existing ReplicationInstance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ReplicationInstance

Returns true if the given object is an instance of ReplicationInstance. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property allocatedStorage

public allocatedStorage: pulumi.Output<number>;

The amount of storage (in gigabytes) to be initially allocated for the replication instance.

property applyImmediately

public applyImmediately: pulumi.Output<boolean | undefined>;

Indicates whether the changes should be applied immediately or during the next maintenance window. Only used when updating an existing resource.

property autoMinorVersionUpgrade

public autoMinorVersionUpgrade: pulumi.Output<boolean>;

Indicates that minor engine upgrades will be applied automatically to the replication instance during the maintenance window.

property availabilityZone

public availabilityZone: pulumi.Output<string>;

The EC2 Availability Zone that the replication instance will be created in.

property engineVersion

public engineVersion: pulumi.Output<string>;

The engine version number of the replication instance.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property kmsKeyArn

public kmsKeyArn: pulumi.Output<string>;

property multiAz

public multiAz: pulumi.Output<boolean>;

Specifies if the replication instance is a multi-az deployment. You cannot set the availabilityZone parameter if the multiAz parameter is set to true.

property preferredMaintenanceWindow

public preferredMaintenanceWindow: pulumi.Output<string>;

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

property publiclyAccessible

public publiclyAccessible: pulumi.Output<boolean>;

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.

property replicationInstanceArn

public replicationInstanceArn: pulumi.Output<string>;

The Amazon Resource Name (ARN) of the replication instance.

property replicationInstanceClass

public replicationInstanceClass: pulumi.Output<string>;

property replicationInstanceId

public replicationInstanceId: pulumi.Output<string>;

The replication instance identifier. This parameter is stored as a lowercase string.

property replicationInstancePrivateIps

public replicationInstancePrivateIps: pulumi.Output<string[]>;

A list of the private IP addresses of the replication instance.

property replicationInstancePublicIps

public replicationInstancePublicIps: pulumi.Output<string[]>;

A list of the public IP addresses of the replication instance.

property replicationSubnetGroupId

public replicationSubnetGroupId: pulumi.Output<string>;

A subnet group to associate with the replication instance.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

A map of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vpcSecurityGroupIds

public vpcSecurityGroupIds: pulumi.Output<string[]>;

A list of VPC security group IDs to be used with the replication instance. The VPC security groups must work with the VPC containing the replication instance.

Resource ReplicationSubnetGroup

class ReplicationSubnetGroup extends CustomResource

Provides a DMS (Data Migration Service) replication subnet group resource. DMS replication subnet groups can be created, updated, deleted, and imported.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

// Create a new replication subnet group
const test = new aws.dms.ReplicationSubnetGroup("test", {
    replicationSubnetGroupDescription: "Test replication subnet group",
    replicationSubnetGroupId: "test-dms-replication-subnet-group-tf",
    subnetIds: ["subnet-12345678"],
    tags: {
        Name: "test",
    },
});

constructor

new ReplicationSubnetGroup(name: string, args: ReplicationSubnetGroupArgs, opts?: pulumi.CustomResourceOptions)

Create a ReplicationSubnetGroup resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ReplicationSubnetGroupState, opts?: pulumi.CustomResourceOptions): ReplicationSubnetGroup

Get an existing ReplicationSubnetGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ReplicationSubnetGroup

Returns true if the given object is an instance of ReplicationSubnetGroup. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property replicationSubnetGroupArn

public replicationSubnetGroupArn: pulumi.Output<string>;

property replicationSubnetGroupDescription

public replicationSubnetGroupDescription: pulumi.Output<string>;

The description for the subnet group.

property replicationSubnetGroupId

public replicationSubnetGroupId: pulumi.Output<string>;

The name for the replication subnet group. This value is stored as a lowercase string.

property subnetIds

public subnetIds: pulumi.Output<string[]>;

A list of the EC2 subnet IDs for the subnet group.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

A map of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vpcId

public vpcId: pulumi.Output<string>;

The ID of the VPC the subnet group is in.

Resource ReplicationTask

class ReplicationTask extends CustomResource

Provides a DMS (Data Migration Service) replication task resource. DMS replication tasks can be created, updated, deleted, and imported.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

// Create a new replication task
const test = new aws.dms.ReplicationTask("test", {
    cdcStartTime: "1.48434688e+09",
    migrationType: "full-load",
    replicationInstanceArn: aws_dms_replication_instance_test_dms_replication_instance_tf.replicationInstanceArn,
    replicationTaskId: "test-dms-replication-task-tf",
    replicationTaskSettings: "...",
    sourceEndpointArn: aws_dms_endpoint_test_dms_source_endpoint_tf.endpointArn,
    tableMappings: "{\"rules\":[{\"rule-type\":\"selection\",\"rule-id\":\"1\",\"rule-name\":\"1\",\"object-locator\":{\"schema-name\":\"%\",\"table-name\":\"%\"},\"rule-action\":\"include\"}]}",
    tags: {
        Name: "test",
    },
    targetEndpointArn: aws_dms_endpoint_test_dms_target_endpoint_tf.endpointArn,
});

constructor

new ReplicationTask(name: string, args: ReplicationTaskArgs, opts?: pulumi.CustomResourceOptions)

Create a ReplicationTask resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ReplicationTaskState, opts?: pulumi.CustomResourceOptions): ReplicationTask

Get an existing ReplicationTask resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ReplicationTask

Returns true if the given object is an instance of ReplicationTask. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property cdcStartTime

public cdcStartTime: pulumi.Output<string | undefined>;

The Unix timestamp integer for the start of the Change Data Capture (CDC) operation.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property migrationType

public migrationType: pulumi.Output<string>;

The migration type. Can be one of full-load | cdc | full-load-and-cdc.

property replicationInstanceArn

public replicationInstanceArn: pulumi.Output<string>;

The Amazon Resource Name (ARN) of the replication instance.

property replicationTaskArn

public replicationTaskArn: pulumi.Output<string>;

The Amazon Resource Name (ARN) for the replication task.

property replicationTaskId

public replicationTaskId: pulumi.Output<string>;

The replication task identifier.

property replicationTaskSettings

public replicationTaskSettings: pulumi.Output<string | undefined>;

An escaped JSON string that contains the task settings. For a complete list of task settings, see Task Settings for AWS Database Migration Service Tasks.

property sourceEndpointArn

public sourceEndpointArn: pulumi.Output<string>;

The Amazon Resource Name (ARN) string that uniquely identifies the source endpoint.

property tableMappings

public tableMappings: pulumi.Output<string>;

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

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

A map of tags to assign to the resource.

property targetEndpointArn

public targetEndpointArn: pulumi.Output<string>;

The Amazon Resource Name (ARN) string that uniquely identifies the target endpoint.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Others

interface CertificateArgs

interface CertificateArgs

The set of arguments for constructing a Certificate resource.

property certificateId

certificateId: pulumi.Input<string>;

The certificate identifier.

property certificatePem

certificatePem?: pulumi.Input<string>;

The contents of the .pem X.509 certificate file for the certificate. Either certificatePem or certificateWallet must be set.

property certificateWallet

certificateWallet?: pulumi.Input<string>;

The contents of the Oracle Wallet certificate for use with SSL. Either certificatePem or certificateWallet must be set.

interface CertificateState

interface CertificateState

Input properties used for looking up and filtering Certificate resources.

property certificateArn

certificateArn?: pulumi.Input<string>;

The Amazon Resource Name (ARN) for the certificate.

property certificateId

certificateId?: pulumi.Input<string>;

The certificate identifier.

property certificatePem

certificatePem?: pulumi.Input<string>;

The contents of the .pem X.509 certificate file for the certificate. Either certificatePem or certificateWallet must be set.

property certificateWallet

certificateWallet?: pulumi.Input<string>;

The contents of the Oracle Wallet certificate for use with SSL. Either certificatePem or certificateWallet must be set.

interface EndpointArgs

interface EndpointArgs

The set of arguments for constructing a Endpoint resource.

property certificateArn

certificateArn?: pulumi.Input<string>;

The Amazon Resource Name (ARN) for the certificate.

property databaseName

databaseName?: pulumi.Input<string>;

The name of the endpoint database.

property elasticsearchSettings

elasticsearchSettings?: pulumi.Input<EndpointElasticsearchSettings>;

Configuration block with Elasticsearch settings. Detailed below.

property endpointId

endpointId: pulumi.Input<string>;

The database endpoint identifier.

property endpointType

endpointType: pulumi.Input<string>;

The type of endpoint. Can be one of source | target.

property engineName

engineName: pulumi.Input<string>;

property extraConnectionAttributes

extraConnectionAttributes?: pulumi.Input<string>;

Additional attributes associated with the connection. For available attributes see Using Extra Connection Attributes with AWS Database Migration Service.

property kafkaSettings

kafkaSettings?: pulumi.Input<EndpointKafkaSettings>;

Configuration block with Kafka settings. Detailed below.

property kinesisSettings

kinesisSettings?: pulumi.Input<EndpointKinesisSettings>;

Configuration block with Kinesis settings. Detailed below.

property kmsKeyArn

kmsKeyArn?: pulumi.Input<string>;

property mongodbSettings

mongodbSettings?: pulumi.Input<EndpointMongodbSettings>;

Configuration block with MongoDB settings. Detailed below.

property password

password?: pulumi.Input<string>;

The password to be used to login to the endpoint database.

property port

port?: pulumi.Input<number>;

The port used by the endpoint database.

property s3Settings

s3Settings?: pulumi.Input<EndpointS3Settings>;

Configuration block with S3 settings. Detailed below.

property serverName

serverName?: pulumi.Input<string>;

The host name of the server.

property serviceAccessRole

serviceAccessRole?: pulumi.Input<string>;

The Amazon Resource Name (ARN) used by the service access IAM role for dynamodb endpoints.

property sslMode

sslMode?: pulumi.Input<string>;

The SSL mode to use for the connection. Can be one of none | require | verify-ca | verify-full

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the resource.

property username

username?: pulumi.Input<string>;

The user name to be used to login to the endpoint database.

interface EndpointState

interface EndpointState

Input properties used for looking up and filtering Endpoint resources.

property certificateArn

certificateArn?: pulumi.Input<string>;

The Amazon Resource Name (ARN) for the certificate.

property databaseName

databaseName?: pulumi.Input<string>;

The name of the endpoint database.

property elasticsearchSettings

elasticsearchSettings?: pulumi.Input<EndpointElasticsearchSettings>;

Configuration block with Elasticsearch settings. Detailed below.

property endpointArn

endpointArn?: pulumi.Input<string>;

The Amazon Resource Name (ARN) for the endpoint.

property endpointId

endpointId?: pulumi.Input<string>;

The database endpoint identifier.

property endpointType

endpointType?: pulumi.Input<string>;

The type of endpoint. Can be one of source | target.

property engineName

engineName?: pulumi.Input<string>;

property extraConnectionAttributes

extraConnectionAttributes?: pulumi.Input<string>;

Additional attributes associated with the connection. For available attributes see Using Extra Connection Attributes with AWS Database Migration Service.

property kafkaSettings

kafkaSettings?: pulumi.Input<EndpointKafkaSettings>;

Configuration block with Kafka settings. Detailed below.

property kinesisSettings

kinesisSettings?: pulumi.Input<EndpointKinesisSettings>;

Configuration block with Kinesis settings. Detailed below.

property kmsKeyArn

kmsKeyArn?: pulumi.Input<string>;

property mongodbSettings

mongodbSettings?: pulumi.Input<EndpointMongodbSettings>;

Configuration block with MongoDB settings. Detailed below.

property password

password?: pulumi.Input<string>;

The password to be used to login to the endpoint database.

property port

port?: pulumi.Input<number>;

The port used by the endpoint database.

property s3Settings

s3Settings?: pulumi.Input<EndpointS3Settings>;

Configuration block with S3 settings. Detailed below.

property serverName

serverName?: pulumi.Input<string>;

The host name of the server.

property serviceAccessRole

serviceAccessRole?: pulumi.Input<string>;

The Amazon Resource Name (ARN) used by the service access IAM role for dynamodb endpoints.

property sslMode

sslMode?: pulumi.Input<string>;

The SSL mode to use for the connection. Can be one of none | require | verify-ca | verify-full

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the resource.

property username

username?: pulumi.Input<string>;

The user name to be used to login to the endpoint database.

interface EventSubscriptionArgs

interface EventSubscriptionArgs

The set of arguments for constructing a EventSubscription resource.

property enabled

enabled?: pulumi.Input<boolean>;

Whether the event subscription should be enabled.

property eventCategories

eventCategories: pulumi.Input<pulumi.Input<string>[]>;

List of event categories to listen for, see DescribeEventCategories for a canonical list.

property name

name?: pulumi.Input<string>;

Name of event subscription.

property snsTopicArn

snsTopicArn: pulumi.Input<string>;

SNS topic arn to send events on.

property sourceIds

sourceIds?: pulumi.Input<pulumi.Input<string>[]>;

Ids of sources to listen to.

property sourceType

sourceType?: pulumi.Input<string>;

Type of source for events. Valid values: replication-instance or replication-task

property tags

tags?: pulumi.Input<{[key: string]: any}>;

interface EventSubscriptionState

interface EventSubscriptionState

Input properties used for looking up and filtering EventSubscription resources.

property arn

arn?: pulumi.Input<string>;

property enabled

enabled?: pulumi.Input<boolean>;

Whether the event subscription should be enabled.

property eventCategories

eventCategories?: pulumi.Input<pulumi.Input<string>[]>;

List of event categories to listen for, see DescribeEventCategories for a canonical list.

property name

name?: pulumi.Input<string>;

Name of event subscription.

property snsTopicArn

snsTopicArn?: pulumi.Input<string>;

SNS topic arn to send events on.

property sourceIds

sourceIds?: pulumi.Input<pulumi.Input<string>[]>;

Ids of sources to listen to.

property sourceType

sourceType?: pulumi.Input<string>;

Type of source for events. Valid values: replication-instance or replication-task

property tags

tags?: pulumi.Input<{[key: string]: any}>;

interface ReplicationInstanceArgs

interface ReplicationInstanceArgs

The set of arguments for constructing a ReplicationInstance resource.

property allocatedStorage

allocatedStorage?: pulumi.Input<number>;

The amount of storage (in gigabytes) to be initially allocated for the replication instance.

property applyImmediately

applyImmediately?: pulumi.Input<boolean>;

Indicates whether the changes should be applied immediately or during the next maintenance window. Only used when updating an existing resource.

property autoMinorVersionUpgrade

autoMinorVersionUpgrade?: pulumi.Input<boolean>;

Indicates that minor engine upgrades will be applied automatically to the replication instance during the maintenance window.

property availabilityZone

availabilityZone?: pulumi.Input<string>;

The EC2 Availability Zone that the replication instance will be created in.

property engineVersion

engineVersion?: pulumi.Input<string>;

The engine version number of the replication instance.

property kmsKeyArn

kmsKeyArn?: pulumi.Input<string>;

property multiAz

multiAz?: pulumi.Input<boolean>;

Specifies if the replication instance is a multi-az deployment. You cannot set the availabilityZone parameter if the multiAz parameter is set to true.

property preferredMaintenanceWindow

preferredMaintenanceWindow?: pulumi.Input<string>;

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

property publiclyAccessible

publiclyAccessible?: pulumi.Input<boolean>;

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.

property replicationInstanceClass

replicationInstanceClass: pulumi.Input<string>;

property replicationInstanceId

replicationInstanceId: pulumi.Input<string>;

The replication instance identifier. This parameter is stored as a lowercase string.

property replicationSubnetGroupId

replicationSubnetGroupId?: pulumi.Input<string>;

A subnet group to associate with the replication instance.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the resource.

property vpcSecurityGroupIds

vpcSecurityGroupIds?: pulumi.Input<pulumi.Input<string>[]>;

A list of VPC security group IDs to be used with the replication instance. The VPC security groups must work with the VPC containing the replication instance.

interface ReplicationInstanceState

interface ReplicationInstanceState

Input properties used for looking up and filtering ReplicationInstance resources.

property allocatedStorage

allocatedStorage?: pulumi.Input<number>;

The amount of storage (in gigabytes) to be initially allocated for the replication instance.

property applyImmediately

applyImmediately?: pulumi.Input<boolean>;

Indicates whether the changes should be applied immediately or during the next maintenance window. Only used when updating an existing resource.

property autoMinorVersionUpgrade

autoMinorVersionUpgrade?: pulumi.Input<boolean>;

Indicates that minor engine upgrades will be applied automatically to the replication instance during the maintenance window.

property availabilityZone

availabilityZone?: pulumi.Input<string>;

The EC2 Availability Zone that the replication instance will be created in.

property engineVersion

engineVersion?: pulumi.Input<string>;

The engine version number of the replication instance.

property kmsKeyArn

kmsKeyArn?: pulumi.Input<string>;

property multiAz

multiAz?: pulumi.Input<boolean>;

Specifies if the replication instance is a multi-az deployment. You cannot set the availabilityZone parameter if the multiAz parameter is set to true.

property preferredMaintenanceWindow

preferredMaintenanceWindow?: pulumi.Input<string>;

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

property publiclyAccessible

publiclyAccessible?: pulumi.Input<boolean>;

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.

property replicationInstanceArn

replicationInstanceArn?: pulumi.Input<string>;

The Amazon Resource Name (ARN) of the replication instance.

property replicationInstanceClass

replicationInstanceClass?: pulumi.Input<string>;

property replicationInstanceId

replicationInstanceId?: pulumi.Input<string>;

The replication instance identifier. This parameter is stored as a lowercase string.

property replicationInstancePrivateIps

replicationInstancePrivateIps?: pulumi.Input<pulumi.Input<string>[]>;

A list of the private IP addresses of the replication instance.

property replicationInstancePublicIps

replicationInstancePublicIps?: pulumi.Input<pulumi.Input<string>[]>;

A list of the public IP addresses of the replication instance.

property replicationSubnetGroupId

replicationSubnetGroupId?: pulumi.Input<string>;

A subnet group to associate with the replication instance.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the resource.

property vpcSecurityGroupIds

vpcSecurityGroupIds?: pulumi.Input<pulumi.Input<string>[]>;

A list of VPC security group IDs to be used with the replication instance. The VPC security groups must work with the VPC containing the replication instance.

interface ReplicationSubnetGroupArgs

interface ReplicationSubnetGroupArgs

The set of arguments for constructing a ReplicationSubnetGroup resource.

property replicationSubnetGroupDescription

replicationSubnetGroupDescription: pulumi.Input<string>;

The description for the subnet group.

property replicationSubnetGroupId

replicationSubnetGroupId: pulumi.Input<string>;

The name for the replication subnet group. This value is stored as a lowercase string.

property subnetIds

subnetIds: pulumi.Input<pulumi.Input<string>[]>;

A list of the EC2 subnet IDs for the subnet group.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the resource.

interface ReplicationSubnetGroupState

interface ReplicationSubnetGroupState

Input properties used for looking up and filtering ReplicationSubnetGroup resources.

property replicationSubnetGroupArn

replicationSubnetGroupArn?: pulumi.Input<string>;

property replicationSubnetGroupDescription

replicationSubnetGroupDescription?: pulumi.Input<string>;

The description for the subnet group.

property replicationSubnetGroupId

replicationSubnetGroupId?: pulumi.Input<string>;

The name for the replication subnet group. This value is stored as a lowercase string.

property subnetIds

subnetIds?: pulumi.Input<pulumi.Input<string>[]>;

A list of the EC2 subnet IDs for the subnet group.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the resource.

property vpcId

vpcId?: pulumi.Input<string>;

The ID of the VPC the subnet group is in.

interface ReplicationTaskArgs

interface ReplicationTaskArgs

The set of arguments for constructing a ReplicationTask resource.

property cdcStartTime

cdcStartTime?: pulumi.Input<string>;

The Unix timestamp integer for the start of the Change Data Capture (CDC) operation.

property migrationType

migrationType: pulumi.Input<string>;

The migration type. Can be one of full-load | cdc | full-load-and-cdc.

property replicationInstanceArn

replicationInstanceArn: pulumi.Input<string>;

The Amazon Resource Name (ARN) of the replication instance.

property replicationTaskId

replicationTaskId: pulumi.Input<string>;

The replication task identifier.

property replicationTaskSettings

replicationTaskSettings?: pulumi.Input<string>;

An escaped JSON string that contains the task settings. For a complete list of task settings, see Task Settings for AWS Database Migration Service Tasks.

property sourceEndpointArn

sourceEndpointArn: pulumi.Input<string>;

The Amazon Resource Name (ARN) string that uniquely identifies the source endpoint.

property tableMappings

tableMappings: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the resource.

property targetEndpointArn

targetEndpointArn: pulumi.Input<string>;

The Amazon Resource Name (ARN) string that uniquely identifies the target endpoint.

interface ReplicationTaskState

interface ReplicationTaskState

Input properties used for looking up and filtering ReplicationTask resources.

property cdcStartTime

cdcStartTime?: pulumi.Input<string>;

The Unix timestamp integer for the start of the Change Data Capture (CDC) operation.

property migrationType

migrationType?: pulumi.Input<string>;

The migration type. Can be one of full-load | cdc | full-load-and-cdc.

property replicationInstanceArn

replicationInstanceArn?: pulumi.Input<string>;

The Amazon Resource Name (ARN) of the replication instance.

property replicationTaskArn

replicationTaskArn?: pulumi.Input<string>;

The Amazon Resource Name (ARN) for the replication task.

property replicationTaskId

replicationTaskId?: pulumi.Input<string>;

The replication task identifier.

property replicationTaskSettings

replicationTaskSettings?: pulumi.Input<string>;

An escaped JSON string that contains the task settings. For a complete list of task settings, see Task Settings for AWS Database Migration Service Tasks.

property sourceEndpointArn

sourceEndpointArn?: pulumi.Input<string>;

The Amazon Resource Name (ARN) string that uniquely identifies the source endpoint.

property tableMappings

tableMappings?: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the resource.

property targetEndpointArn

targetEndpointArn?: pulumi.Input<string>;

The Amazon Resource Name (ARN) string that uniquely identifies the target endpoint.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Module dms

Resources

Others

Resources

Example Usage

Example Usage

Example Usage

Example Usage

Example Usage

Example Usage

Others