Endpoint

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

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        // Create a new endpoint
        var test = new Aws.Dms.Endpoint("test", new Aws.Dms.EndpointArgs
        {
            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",
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/dms"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := dms.NewEndpoint(ctx, "test", &dms.EndpointArgs{
            CertificateArn:            pulumi.String("arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012"),
            DatabaseName:              pulumi.String("test"),
            EndpointId:                pulumi.String("test-dms-endpoint-tf"),
            EndpointType:              pulumi.String("source"),
            EngineName:                pulumi.String("aurora"),
            ExtraConnectionAttributes: pulumi.String(""),
            KmsKeyArn:                 pulumi.String("arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012"),
            Password:                  pulumi.String("test"),
            Port:                      pulumi.Int(3306),
            ServerName:                pulumi.String("test"),
            SslMode:                   pulumi.String("none"),
            Tags: pulumi.StringMap{
                "Name": pulumi.String("test"),
            },
            Username: pulumi.String("test"),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

# Create a new endpoint
test = aws.dms.Endpoint("test",
    certificate_arn="arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012",
    database_name="test",
    endpoint_id="test-dms-endpoint-tf",
    endpoint_type="source",
    engine_name="aurora",
    extra_connection_attributes="",
    kms_key_arn="arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012",
    password="test",
    port=3306,
    server_name="test",
    ssl_mode="none",
    tags={
        "Name": "test",
    },
    username="test")

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",
});

Create a Endpoint Resource

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

def Endpoint(resource_name, opts=None, certificate_arn=None, database_name=None, elasticsearch_settings=None, endpoint_id=None, endpoint_type=None, engine_name=None, extra_connection_attributes=None, kafka_settings=None, kinesis_settings=None, kms_key_arn=None, mongodb_settings=None, password=None, port=None, s3_settings=None, server_name=None, service_access_role=None, ssl_mode=None, tags=None, username=None, __props__=None);

func NewEndpoint(ctx *Context, name string, args EndpointArgs, opts ...ResourceOption) (*Endpoint, error)

public Endpoint(string name, EndpointArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args EndpointArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args EndpointArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args EndpointArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Endpoint Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Endpoint resource accepts the following input properties:

EndpointId string: The database endpoint identifier.
EndpointType string: The type of endpoint. Can be one of source | target.
EngineName string: The type of engine for the endpoint. Can be one of aurora | aurora-postgresql| azuredb | db2 | docdb | dynamodb | elasticsearch | kafka | kinesis | mariadb | mongodb | mysql | oracle | postgres | redshift | s3 | sqlserver | sybase.
CertificateArn string: The Amazon Resource Name (ARN) for the certificate.
DatabaseName string: The name of the endpoint database.
ElasticsearchSettings EndpointElasticsearchSettingsArgs: Configuration block with Elasticsearch settings. Detailed below.
ExtraConnectionAttributes string: Additional attributes associated with the connection. For available attributes see Using Extra Connection Attributes with AWS Database Migration Service.
KafkaSettings EndpointKafkaSettingsArgs: Configuration block with Kafka settings. Detailed below.
KinesisSettings EndpointKinesisSettingsArgs: Configuration block with Kinesis settings. Detailed below.
KmsKeyArn 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 kms_key_arn, 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.
MongodbSettings EndpointMongodbSettingsArgs: Configuration block with MongoDB settings. Detailed below.
Password string: The password to be used to login to the endpoint database.
Port int: The port used by the endpoint database.
S3Settings EndpointS3SettingsArgs: Configuration block with S3 settings. Detailed below.
ServerName string: The host name of the server.
ServiceAccessRole string: The Amazon Resource Name (ARN) used by the service access IAM role for dynamodb endpoints.
SslMode string: The SSL mode to use for the connection. Can be one of none | require | verify-ca | verify-full
Tags Dictionary<string, string>: A map of tags to assign to the resource.
Username string: The user name to be used to login to the endpoint database.

EndpointId string: The database endpoint identifier.
EndpointType string: The type of endpoint. Can be one of source | target.
EngineName string: The type of engine for the endpoint. Can be one of aurora | aurora-postgresql| azuredb | db2 | docdb | dynamodb | elasticsearch | kafka | kinesis | mariadb | mongodb | mysql | oracle | postgres | redshift | s3 | sqlserver | sybase.
CertificateArn string: The Amazon Resource Name (ARN) for the certificate.
DatabaseName string: The name of the endpoint database.
ElasticsearchSettings EndpointElasticsearchSettings: Configuration block with Elasticsearch settings. Detailed below.
ExtraConnectionAttributes string: Additional attributes associated with the connection. For available attributes see Using Extra Connection Attributes with AWS Database Migration Service.
KafkaSettings EndpointKafkaSettings: Configuration block with Kafka settings. Detailed below.
KinesisSettings EndpointKinesisSettings: Configuration block with Kinesis settings. Detailed below.
KmsKeyArn 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 kms_key_arn, 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.
MongodbSettings EndpointMongodbSettings: Configuration block with MongoDB settings. Detailed below.
Password string: The password to be used to login to the endpoint database.
Port int: The port used by the endpoint database.
S3Settings EndpointS3Settings: Configuration block with S3 settings. Detailed below.
ServerName string: The host name of the server.
ServiceAccessRole string: The Amazon Resource Name (ARN) used by the service access IAM role for dynamodb endpoints.
SslMode string: The SSL mode to use for the connection. Can be one of none | require | verify-ca | verify-full
Tags map[string]string: A map of tags to assign to the resource.
Username string: The user name to be used to login to the endpoint database.

endpointId string: The database endpoint identifier.
endpointType string: The type of endpoint. Can be one of source | target.
engineName string: The type of engine for the endpoint. Can be one of aurora | aurora-postgresql| azuredb | db2 | docdb | dynamodb | elasticsearch | kafka | kinesis | mariadb | mongodb | mysql | oracle | postgres | redshift | s3 | sqlserver | sybase.
certificateArn string: The Amazon Resource Name (ARN) for the certificate.
databaseName string: The name of the endpoint database.
elasticsearchSettings EndpointElasticsearchSettings: Configuration block with Elasticsearch settings. Detailed below.
extraConnectionAttributes string: Additional attributes associated with the connection. For available attributes see Using Extra Connection Attributes with AWS Database Migration Service.
kafkaSettings EndpointKafkaSettings: Configuration block with Kafka settings. Detailed below.
kinesisSettings EndpointKinesisSettings: Configuration block with Kinesis settings. Detailed below.
kmsKeyArn 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 kms_key_arn, 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.
mongodbSettings EndpointMongodbSettings: Configuration block with MongoDB settings. Detailed below.
password string: The password to be used to login to the endpoint database.
port number: The port used by the endpoint database.
s3Settings EndpointS3Settings: Configuration block with S3 settings. Detailed below.
serverName string: The host name of the server.
serviceAccessRole string: The Amazon Resource Name (ARN) used by the service access IAM role for dynamodb endpoints.
sslMode string: The SSL mode to use for the connection. Can be one of none | require | verify-ca | verify-full
tags {[key: string]: string}: A map of tags to assign to the resource.
username string: The user name to be used to login to the endpoint database.

endpoint_id str: The database endpoint identifier.
endpoint_type str: The type of endpoint. Can be one of source | target.
engine_name str: The type of engine for the endpoint. Can be one of aurora | aurora-postgresql| azuredb | db2 | docdb | dynamodb | elasticsearch | kafka | kinesis | mariadb | mongodb | mysql | oracle | postgres | redshift | s3 | sqlserver | sybase.
certificate_arn str: The Amazon Resource Name (ARN) for the certificate.
database_name str: The name of the endpoint database.
elasticsearch_settings Dict[EndpointElasticsearchSettings]: Configuration block with Elasticsearch settings. Detailed below.
extra_connection_attributes str: Additional attributes associated with the connection. For available attributes see Using Extra Connection Attributes with AWS Database Migration Service.
kafka_settings Dict[EndpointKafkaSettings]: Configuration block with Kafka settings. Detailed below.
kinesis_settings Dict[EndpointKinesisSettings]: Configuration block with Kinesis settings. Detailed below.
kms_key_arn str: 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 kms_key_arn, 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.
mongodb_settings Dict[EndpointMongodbSettings]: Configuration block with MongoDB settings. Detailed below.
password str: The password to be used to login to the endpoint database.
port float: The port used by the endpoint database.
s3_settings Dict[EndpointS3Settings]: Configuration block with S3 settings. Detailed below.
server_name str: The host name of the server.
service_access_role str: The Amazon Resource Name (ARN) used by the service access IAM role for dynamodb endpoints.
ssl_mode str: The SSL mode to use for the connection. Can be one of none | require | verify-ca | verify-full
tags Dict[str, str]: A map of tags to assign to the resource.
username str: The user name to be used to login to the endpoint database.

Outputs

All input properties are implicitly available as output properties. Additionally, the Endpoint resource produces the following output properties:

EndpointArn string: The Amazon Resource Name (ARN) for the endpoint.
Id string: The provider-assigned unique ID for this managed resource.

EndpointArn string: The Amazon Resource Name (ARN) for the endpoint.
Id string: The provider-assigned unique ID for this managed resource.

endpointArn string: The Amazon Resource Name (ARN) for the endpoint.
id string: The provider-assigned unique ID for this managed resource.

endpoint_arn str: The Amazon Resource Name (ARN) for the endpoint.
id str: The provider-assigned unique ID for this managed resource.

Look up an Existing Endpoint Resource

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

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

static get(resource_name, id, opts=None, certificate_arn=None, database_name=None, elasticsearch_settings=None, endpoint_arn=None, endpoint_id=None, endpoint_type=None, engine_name=None, extra_connection_attributes=None, kafka_settings=None, kinesis_settings=None, kms_key_arn=None, mongodb_settings=None, password=None, port=None, s3_settings=None, server_name=None, service_access_role=None, ssl_mode=None, tags=None, username=None, __props__=None);

func GetEndpoint(ctx *Context, name string, id IDInput, state *EndpointState, opts ...ResourceOption) (*Endpoint, error)

public static Endpoint Get(string name, Input<string> id, EndpointState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

CertificateArn string: The Amazon Resource Name (ARN) for the certificate.
DatabaseName string: The name of the endpoint database.
ElasticsearchSettings EndpointElasticsearchSettingsArgs: Configuration block with Elasticsearch settings. Detailed below.
EndpointArn string: The Amazon Resource Name (ARN) for the endpoint.
EndpointId string: The database endpoint identifier.
EndpointType string: The type of endpoint. Can be one of source | target.
EngineName string: The type of engine for the endpoint. Can be one of aurora | aurora-postgresql| azuredb | db2 | docdb | dynamodb | elasticsearch | kafka | kinesis | mariadb | mongodb | mysql | oracle | postgres | redshift | s3 | sqlserver | sybase.
ExtraConnectionAttributes string: Additional attributes associated with the connection. For available attributes see Using Extra Connection Attributes with AWS Database Migration Service.
KafkaSettings EndpointKafkaSettingsArgs: Configuration block with Kafka settings. Detailed below.
KinesisSettings EndpointKinesisSettingsArgs: Configuration block with Kinesis settings. Detailed below.
KmsKeyArn 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 kms_key_arn, 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.
MongodbSettings EndpointMongodbSettingsArgs: Configuration block with MongoDB settings. Detailed below.
Password string: The password to be used to login to the endpoint database.
Port int: The port used by the endpoint database.
S3Settings EndpointS3SettingsArgs: Configuration block with S3 settings. Detailed below.
ServerName string: The host name of the server.
ServiceAccessRole string: The Amazon Resource Name (ARN) used by the service access IAM role for dynamodb endpoints.
SslMode string: The SSL mode to use for the connection. Can be one of none | require | verify-ca | verify-full
Tags Dictionary<string, string>: A map of tags to assign to the resource.
Username string: The user name to be used to login to the endpoint database.

CertificateArn string: The Amazon Resource Name (ARN) for the certificate.
DatabaseName string: The name of the endpoint database.
ElasticsearchSettings EndpointElasticsearchSettings: Configuration block with Elasticsearch settings. Detailed below.
EndpointArn string: The Amazon Resource Name (ARN) for the endpoint.
EndpointId string: The database endpoint identifier.
EndpointType string: The type of endpoint. Can be one of source | target.
EngineName string: The type of engine for the endpoint. Can be one of aurora | aurora-postgresql| azuredb | db2 | docdb | dynamodb | elasticsearch | kafka | kinesis | mariadb | mongodb | mysql | oracle | postgres | redshift | s3 | sqlserver | sybase.
ExtraConnectionAttributes string: Additional attributes associated with the connection. For available attributes see Using Extra Connection Attributes with AWS Database Migration Service.
KafkaSettings EndpointKafkaSettings: Configuration block with Kafka settings. Detailed below.
KinesisSettings EndpointKinesisSettings: Configuration block with Kinesis settings. Detailed below.
KmsKeyArn 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 kms_key_arn, 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.
MongodbSettings EndpointMongodbSettings: Configuration block with MongoDB settings. Detailed below.
Password string: The password to be used to login to the endpoint database.
Port int: The port used by the endpoint database.
S3Settings EndpointS3Settings: Configuration block with S3 settings. Detailed below.
ServerName string: The host name of the server.
ServiceAccessRole string: The Amazon Resource Name (ARN) used by the service access IAM role for dynamodb endpoints.
SslMode string: The SSL mode to use for the connection. Can be one of none | require | verify-ca | verify-full
Tags map[string]string: A map of tags to assign to the resource.
Username string: The user name to be used to login to the endpoint database.

certificateArn string: The Amazon Resource Name (ARN) for the certificate.
databaseName string: The name of the endpoint database.
elasticsearchSettings EndpointElasticsearchSettings: Configuration block with Elasticsearch settings. Detailed below.
endpointArn string: The Amazon Resource Name (ARN) for the endpoint.
endpointId string: The database endpoint identifier.
endpointType string: The type of endpoint. Can be one of source | target.
engineName string: The type of engine for the endpoint. Can be one of aurora | aurora-postgresql| azuredb | db2 | docdb | dynamodb | elasticsearch | kafka | kinesis | mariadb | mongodb | mysql | oracle | postgres | redshift | s3 | sqlserver | sybase.
extraConnectionAttributes string: Additional attributes associated with the connection. For available attributes see Using Extra Connection Attributes with AWS Database Migration Service.
kafkaSettings EndpointKafkaSettings: Configuration block with Kafka settings. Detailed below.
kinesisSettings EndpointKinesisSettings: Configuration block with Kinesis settings. Detailed below.
kmsKeyArn 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 kms_key_arn, 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.
mongodbSettings EndpointMongodbSettings: Configuration block with MongoDB settings. Detailed below.
password string: The password to be used to login to the endpoint database.
port number: The port used by the endpoint database.
s3Settings EndpointS3Settings: Configuration block with S3 settings. Detailed below.
serverName string: The host name of the server.
serviceAccessRole string: The Amazon Resource Name (ARN) used by the service access IAM role for dynamodb endpoints.
sslMode string: The SSL mode to use for the connection. Can be one of none | require | verify-ca | verify-full
tags {[key: string]: string}: A map of tags to assign to the resource.
username string: The user name to be used to login to the endpoint database.

certificate_arn str: The Amazon Resource Name (ARN) for the certificate.
database_name str: The name of the endpoint database.
elasticsearch_settings Dict[EndpointElasticsearchSettings]: Configuration block with Elasticsearch settings. Detailed below.
endpoint_arn str: The Amazon Resource Name (ARN) for the endpoint.
endpoint_id str: The database endpoint identifier.
endpoint_type str: The type of endpoint. Can be one of source | target.
engine_name str: The type of engine for the endpoint. Can be one of aurora | aurora-postgresql| azuredb | db2 | docdb | dynamodb | elasticsearch | kafka | kinesis | mariadb | mongodb | mysql | oracle | postgres | redshift | s3 | sqlserver | sybase.
extra_connection_attributes str: Additional attributes associated with the connection. For available attributes see Using Extra Connection Attributes with AWS Database Migration Service.
kafka_settings Dict[EndpointKafkaSettings]: Configuration block with Kafka settings. Detailed below.
kinesis_settings Dict[EndpointKinesisSettings]: Configuration block with Kinesis settings. Detailed below.
kms_key_arn str: 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 kms_key_arn, 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.
mongodb_settings Dict[EndpointMongodbSettings]: Configuration block with MongoDB settings. Detailed below.
password str: The password to be used to login to the endpoint database.
port float: The port used by the endpoint database.
s3_settings Dict[EndpointS3Settings]: Configuration block with S3 settings. Detailed below.
server_name str: The host name of the server.
service_access_role str: The Amazon Resource Name (ARN) used by the service access IAM role for dynamodb endpoints.
ssl_mode str: The SSL mode to use for the connection. Can be one of none | require | verify-ca | verify-full
tags Dict[str, str]: A map of tags to assign to the resource.
username str: The user name to be used to login to the endpoint database.

Supporting Types

EndpointElasticsearchSettings

See the input and output API doc for this type.

EndpointUri string: Endpoint for the Elasticsearch cluster.
ServiceAccessRoleArn string: Amazon Resource Name (ARN) of the IAM Role with permissions to write to the Elasticsearch cluster.
ErrorRetryDuration int: Maximum number of seconds for which DMS retries failed API requests to the Elasticsearch cluster. Defaults to 300.
FullLoadErrorPercentage int: Maximum percentage of records that can fail to be written before a full load operation stops. Defaults to 10.

EndpointUri string: Endpoint for the Elasticsearch cluster.
ServiceAccessRoleArn string: Amazon Resource Name (ARN) of the IAM Role with permissions to write to the Elasticsearch cluster.
ErrorRetryDuration int: Maximum number of seconds for which DMS retries failed API requests to the Elasticsearch cluster. Defaults to 300.
FullLoadErrorPercentage int: Maximum percentage of records that can fail to be written before a full load operation stops. Defaults to 10.

endpointUri string: Endpoint for the Elasticsearch cluster.
serviceAccessRoleArn string: Amazon Resource Name (ARN) of the IAM Role with permissions to write to the Elasticsearch cluster.
errorRetryDuration number: Maximum number of seconds for which DMS retries failed API requests to the Elasticsearch cluster. Defaults to 300.
fullLoadErrorPercentage number: Maximum percentage of records that can fail to be written before a full load operation stops. Defaults to 10.

endpointUri str: Endpoint for the Elasticsearch cluster.
serviceAccessRoleArn str: Amazon Resource Name (ARN) of the IAM Role with permissions to write to the Elasticsearch cluster.
errorRetryDuration float: Maximum number of seconds for which DMS retries failed API requests to the Elasticsearch cluster. Defaults to 300.
fullLoadErrorPercentage float: Maximum percentage of records that can fail to be written before a full load operation stops. Defaults to 10.

EndpointKafkaSettings

See the input and output API doc for this type.

Broker string: Kafka broker location. Specify in the form broker-hostname-or-ip:port.
Topic string: Kafka topic for migration. Defaults to kafka-default-topic.

Broker string: Kafka broker location. Specify in the form broker-hostname-or-ip:port.
Topic string: Kafka topic for migration. Defaults to kafka-default-topic.

broker string: Kafka broker location. Specify in the form broker-hostname-or-ip:port.
topic string: Kafka topic for migration. Defaults to kafka-default-topic.

broker str: Kafka broker location. Specify in the form broker-hostname-or-ip:port.
topic str: Kafka topic for migration. Defaults to kafka-default-topic.

EndpointKinesisSettings

See the input and output API doc for this type.

MessageFormat string: Output format for the records created. Defaults to json. Valid values are json and json_unformatted (a single line with no tab).
ServiceAccessRoleArn string: Amazon Resource Name (ARN) of the IAM Role with permissions to write to the Kinesis data stream.
StreamArn string: Amazon Resource Name (ARN) of the Kinesis data stream.

MessageFormat string: Output format for the records created. Defaults to json. Valid values are json and json_unformatted (a single line with no tab).
ServiceAccessRoleArn string: Amazon Resource Name (ARN) of the IAM Role with permissions to write to the Kinesis data stream.
StreamArn string: Amazon Resource Name (ARN) of the Kinesis data stream.

messageFormat string: Output format for the records created. Defaults to json. Valid values are json and json_unformatted (a single line with no tab).
serviceAccessRoleArn string: Amazon Resource Name (ARN) of the IAM Role with permissions to write to the Kinesis data stream.
streamArn string: Amazon Resource Name (ARN) of the Kinesis data stream.

messageFormat str: Output format for the records created. Defaults to json. Valid values are json and json_unformatted (a single line with no tab).
serviceAccessRoleArn str: Amazon Resource Name (ARN) of the IAM Role with permissions to write to the Kinesis data stream.
stream_arn str: Amazon Resource Name (ARN) of the Kinesis data stream.

EndpointMongodbSettings

See the input and output API doc for this type.

AuthMechanism string: Authentication mechanism to access the MongoDB source endpoint. Defaults to default.
AuthSource string: Authentication database name. Not used when auth_type is no. Defaults to admin.
AuthType string: Authentication type to access the MongoDB source endpoint. Defaults to password.
DocsToInvestigate string: Number of documents to preview to determine the document organization. Use this setting when nesting_level is set to one. Defaults to 1000.
ExtractDocId string: Document ID. Use this setting when nesting_level is set to none. Defaults to false.
NestingLevel string: Specifies either document or table mode. Defaults to none. Valid values are one (table mode) and none (document mode).

AuthMechanism string: Authentication mechanism to access the MongoDB source endpoint. Defaults to default.
AuthSource string: Authentication database name. Not used when auth_type is no. Defaults to admin.
AuthType string: Authentication type to access the MongoDB source endpoint. Defaults to password.
DocsToInvestigate string: Number of documents to preview to determine the document organization. Use this setting when nesting_level is set to one. Defaults to 1000.
ExtractDocId string: Document ID. Use this setting when nesting_level is set to none. Defaults to false.
NestingLevel string: Specifies either document or table mode. Defaults to none. Valid values are one (table mode) and none (document mode).

authMechanism string: Authentication mechanism to access the MongoDB source endpoint. Defaults to default.
authSource string: Authentication database name. Not used when auth_type is no. Defaults to admin.
authType string: Authentication type to access the MongoDB source endpoint. Defaults to password.
docsToInvestigate string: Number of documents to preview to determine the document organization. Use this setting when nesting_level is set to one. Defaults to 1000.
extractDocId string: Document ID. Use this setting when nesting_level is set to none. Defaults to false.
nestingLevel string: Specifies either document or table mode. Defaults to none. Valid values are one (table mode) and none (document mode).

authMechanism str: Authentication mechanism to access the MongoDB source endpoint. Defaults to default.
authSource str: Authentication database name. Not used when auth_type is no. Defaults to admin.
auth_type str: Authentication type to access the MongoDB source endpoint. Defaults to password.
docsToInvestigate str: Number of documents to preview to determine the document organization. Use this setting when nesting_level is set to one. Defaults to 1000.
extractDocId str: Document ID. Use this setting when nesting_level is set to none. Defaults to false.
nestingLevel str: Specifies either document or table mode. Defaults to none. Valid values are one (table mode) and none (document mode).

EndpointS3Settings

See the input and output API doc for this type.

BucketFolder string: S3 Bucket Object prefix.
BucketName string: S3 Bucket name.
CompressionType string: Set to compress target files. Defaults to NONE. Valid values are GZIP and NONE.
CsvDelimiter string: Delimiter used to separate columns in the source files. Defaults to ,.
CsvRowDelimiter string: Delimiter used to separate rows in the source files. Defaults to \n.
ExternalTableDefinition string: JSON document that describes how AWS DMS should interpret the data.
ServiceAccessRoleArn string: Amazon Resource Name (ARN) of the IAM Role with permissions to read from or write to the S3 Bucket.

BucketFolder string: S3 Bucket Object prefix.
BucketName string: S3 Bucket name.
CompressionType string: Set to compress target files. Defaults to NONE. Valid values are GZIP and NONE.
CsvDelimiter string: Delimiter used to separate columns in the source files. Defaults to ,.
CsvRowDelimiter string: Delimiter used to separate rows in the source files. Defaults to \n.
ExternalTableDefinition string: JSON document that describes how AWS DMS should interpret the data.
ServiceAccessRoleArn string: Amazon Resource Name (ARN) of the IAM Role with permissions to read from or write to the S3 Bucket.

bucketFolder string: S3 Bucket Object prefix.
bucketName string: S3 Bucket name.
compressionType string: Set to compress target files. Defaults to NONE. Valid values are GZIP and NONE.
csvDelimiter string: Delimiter used to separate columns in the source files. Defaults to ,.
csvRowDelimiter string: Delimiter used to separate rows in the source files. Defaults to \n.
externalTableDefinition string: JSON document that describes how AWS DMS should interpret the data.
serviceAccessRoleArn string: Amazon Resource Name (ARN) of the IAM Role with permissions to read from or write to the S3 Bucket.

bucketFolder str: S3 Bucket Object prefix.
bucket_name str: S3 Bucket name.
compressionType str: Set to compress target files. Defaults to NONE. Valid values are GZIP and NONE.
csvDelimiter str: Delimiter used to separate columns in the source files. Defaults to ,.
csvRowDelimiter str: Delimiter used to separate rows in the source files. Defaults to \n.
externalTableDefinition str: JSON document that describes how AWS DMS should interpret the data.
serviceAccessRoleArn str: Amazon Resource Name (ARN) of the IAM Role with permissions to read from or write to the S3 Bucket.

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Endpoint

Example Usage

Create a Endpoint Resource

Endpoint Resource Properties

Inputs

Outputs

Look up an Existing Endpoint Resource

Supporting Types

EndpointElasticsearchSettings

EndpointKafkaSettings

EndpointKinesisSettings

EndpointMongodbSettings

EndpointS3Settings

Package Details

On This Page