Endpoint

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

Example Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.dms.Endpoint;
import com.pulumi.aws.dms.EndpointArgs;
import java.util.List;
import java.util.ArrayList;
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 test = new Endpoint("test", EndpointArgs.builder()
.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(Map.of("Name", "test"))
.username("test")
.build());
}
}

Import

Endpoints can be imported using the endpoint_id, e.g.,

$ pulumi import aws:dms/endpoint:Endpoint test test-dms-endpoint-tf

Properties

Link copied to clipboard
val certificateArn: Output<String>

ARN for the certificate.

Link copied to clipboard
val databaseName: Output<String>?

Name of the endpoint database.

Link copied to clipboard

Configuration block for OpenSearch settings. See below.

Link copied to clipboard
val endpointArn: Output<String>

ARN for the endpoint.

Link copied to clipboard
val endpointId: Output<String>

Database endpoint identifier. Identifiers must contain from 1 to 255 alphanumeric characters or hyphens, begin with a letter, contain only ASCII letters, digits, and hyphens, not end with a hyphen, and not contain two consecutive hyphens.

Link copied to clipboard
val endpointType: Output<String>

Type of endpoint. Valid values are source, target.

Link copied to clipboard
val engineName: Output<String>

Type of engine for the endpoint. Valid values are aurora, aurora-postgresql, azuredb, db2, docdb, dynamodb, elasticsearch, kafka, kinesis, mariadb, mongodb, mysql, opensearch, oracle, postgres, redshift, s3, sqlserver, sybase. Please note that some of engine names are available only for target endpoint type (e.g. redshift).

Link copied to clipboard

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

Link copied to clipboard
val id: Output<String>
Link copied to clipboard

Configuration block for Kafka settings. See below.

Link copied to clipboard

Configuration block for Kinesis settings. See below.

Link copied to clipboard
val kmsKeyArn: Output<String>

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.

Link copied to clipboard

Configuration block for MongoDB settings. See below.

Link copied to clipboard
val password: Output<String>?

Password to be used to login to the endpoint database.

Link copied to clipboard
val port: Output<Int>?

Port used by the endpoint database.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Configuration block for Redshift settings. See below.

Link copied to clipboard

Configuration block for S3 settings. See below.

Link copied to clipboard

ARN of the IAM role that specifies AWS DMS as the trusted entity and has the required permissions to access the value in SecretsManagerSecret.

Link copied to clipboard

Full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the endpoint connection details. Supported only for engine_name as aurora, aurora-postgresql, mariadb, mongodb, mysql, oracle, postgres, redshift or sqlserver.

Link copied to clipboard
val serverName: Output<String>?

Host name of the server.

Link copied to clipboard

ARN used by the service access IAM role for dynamodb endpoints.

Link copied to clipboard
val sslMode: Output<String>

SSL mode to use for the connection. Valid values are none, require, verify-ca, verify-full

Link copied to clipboard
val tags: Output<Map<String, String>>?

Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Link copied to clipboard
val tagsAll: Output<Map<String, String>>

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Link copied to clipboard
val urn: Output<String>
Link copied to clipboard
val username: Output<String>?

User name to be used to login to the endpoint database.