Class 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. Read more about sensitive data in state.

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

}

Inheritance

System.Object

Resource

CustomResource

Endpoint

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.Dms

Assembly: Pulumi.Aws.dll

Syntax

public class Endpoint : CustomResource

Constructors

Endpoint(String, EndpointArgs, CustomResourceOptions)

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

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
EndpointArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

CertificateArn

The Amazon Resource Name (ARN) for the certificate.

Declaration

public Output<string> CertificateArn { get; }

Property Value

Type	Description
Output<System.String>

DatabaseName

The name of the endpoint database.

Declaration

public Output<string> DatabaseName { get; }

Property Value

Type	Description
Output<System.String>

ElasticsearchSettings

Configuration block with Elasticsearch settings. Detailed below.

Declaration

public Output<EndpointElasticsearchSettings> ElasticsearchSettings { get; }

Property Value

Type	Description
Output<EndpointElasticsearchSettings>

EndpointArn

The Amazon Resource Name (ARN) for the endpoint.

Declaration

public Output<string> EndpointArn { get; }

Property Value

Type	Description
Output<System.String>

EndpointId

The database endpoint identifier.

Declaration

public Output<string> EndpointId { get; }

Property Value

Type	Description
Output<System.String>

EndpointType

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

Declaration

public Output<string> EndpointType { get; }

Property Value

Type	Description
Output<System.String>

EngineName

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.

Declaration

public Output<string> EngineName { get; }

Property Value

Type	Description
Output<System.String>

ExtraConnectionAttributes

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

Declaration

public Output<string> ExtraConnectionAttributes { get; }

Property Value

Type	Description
Output<System.String>

KafkaSettings

Configuration block with Kafka settings. Detailed below.

Declaration

public Output<EndpointKafkaSettings> KafkaSettings { get; }

Property Value

Type	Description
Output<EndpointKafkaSettings>

KinesisSettings

Configuration block with Kinesis settings. Detailed below.

Declaration

public Output<EndpointKinesisSettings> KinesisSettings { get; }

Property Value

Type	Description
Output<EndpointKinesisSettings>

KmsKeyArn

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.

Declaration

public Output<string> KmsKeyArn { get; }

Property Value

Type	Description
Output<System.String>

MongodbSettings

Configuration block with MongoDB settings. Detailed below.

Declaration

public Output<EndpointMongodbSettings> MongodbSettings { get; }

Property Value

Type	Description
Output<EndpointMongodbSettings>

Password

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

Declaration

public Output<string> Password { get; }

Property Value

Type	Description
Output<System.String>

Port

The port used by the endpoint database.

Declaration

public Output<int?> Port { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

S3Settings

Configuration block with S3 settings. Detailed below.

Declaration

public Output<EndpointS3Settings> S3Settings { get; }

Property Value

Type	Description
Output<EndpointS3Settings>

ServerName

The host name of the server.

Declaration

public Output<string> ServerName { get; }

Property Value

Type	Description
Output<System.String>

ServiceAccessRole

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

Declaration

public Output<string> ServiceAccessRole { get; }

Property Value

Type	Description
Output<System.String>

SslMode

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

Declaration

public Output<string> SslMode { get; }

Property Value

Type	Description
Output<System.String>

Tags

A map of tags to assign to the resource.

Declaration

public Output<ImmutableDictionary<string, object>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

Username

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

Declaration

public Output<string> Username { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, EndpointState, CustomResourceOptions)

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

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
EndpointState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Endpoint