AWS Classic v5.41.0, May 15 23

aws.dms.getEndpoint

Explore with Pulumi AI

Data source for managing an AWS DMS (Database Migration) Endpoint.

Example Usage

Basic Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var test = Aws.Dms.GetEndpoint.Invoke(new()
    {
        EndpointId = "test_id",
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dms.LookupEndpoint(ctx, &dms.LookupEndpointArgs{
			EndpointId: "test_id",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.dms.DmsFunctions;
import com.pulumi.aws.dms.inputs.GetEndpointArgs;
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) {
        final var test = DmsFunctions.getEndpoint(GetEndpointArgs.builder()
            .endpointId("test_id")
            .build());

    }
}

import pulumi
import pulumi_aws as aws

test = aws.dms.get_endpoint(endpoint_id="test_id")

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

const test = aws.dms.getEndpoint({
    endpointId: "test_id",
});

variables:
  test:
    fn::invoke:
      Function: aws:dms:getEndpoint
      Arguments:
        endpointId: test_id

Using getEndpoint

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getEndpoint(args: GetEndpointArgs, opts?: InvokeOptions): Promise<GetEndpointResult>
function getEndpointOutput(args: GetEndpointOutputArgs, opts?: InvokeOptions): Output<GetEndpointResult>

def get_endpoint(elasticsearch_settings: Optional[Sequence[GetEndpointElasticsearchSetting]] = None,
                 endpoint_id: Optional[str] = None,
                 extra_connection_attributes: Optional[str] = None,
                 kafka_settings: Optional[Sequence[GetEndpointKafkaSetting]] = None,
                 mongodb_settings: Optional[Sequence[GetEndpointMongodbSetting]] = None,
                 tags: Optional[Mapping[str, str]] = None,
                 opts: Optional[InvokeOptions] = None) -> GetEndpointResult
def get_endpoint_output(elasticsearch_settings: Optional[pulumi.Input[Sequence[pulumi.Input[GetEndpointElasticsearchSettingArgs]]]] = None,
                 endpoint_id: Optional[pulumi.Input[str]] = None,
                 extra_connection_attributes: Optional[pulumi.Input[str]] = None,
                 kafka_settings: Optional[pulumi.Input[Sequence[pulumi.Input[GetEndpointKafkaSettingArgs]]]] = None,
                 mongodb_settings: Optional[pulumi.Input[Sequence[pulumi.Input[GetEndpointMongodbSettingArgs]]]] = None,
                 tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetEndpointResult]

func LookupEndpoint(ctx *Context, args *LookupEndpointArgs, opts ...InvokeOption) (*LookupEndpointResult, error)
func LookupEndpointOutput(ctx *Context, args *LookupEndpointOutputArgs, opts ...InvokeOption) LookupEndpointResultOutput

> Note: This function is named LookupEndpoint in the Go SDK.

public static class GetEndpoint 
{
    public static Task<GetEndpointResult> InvokeAsync(GetEndpointArgs args, InvokeOptions? opts = null)
    public static Output<GetEndpointResult> Invoke(GetEndpointInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetEndpointResult> getEndpoint(GetEndpointArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws:dms/getEndpoint:getEndpoint
  arguments:
    # arguments dictionary

The following arguments are supported:

EndpointId 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.
ElasticsearchSettings List<GetEndpointElasticsearchSetting>
ExtraConnectionAttributes string
KafkaSettings List<GetEndpointKafkaSetting>
MongodbSettings List<GetEndpointMongodbSetting>
Tags Dictionary<string, string>

EndpointId 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.
ElasticsearchSettings []GetEndpointElasticsearchSetting
ExtraConnectionAttributes string
KafkaSettings []GetEndpointKafkaSetting
MongodbSettings []GetEndpointMongodbSetting
Tags map[string]string

endpointId 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.
elasticsearchSettings List<GetEndpointElasticsearchSetting>
extraConnectionAttributes String
kafkaSettings List<GetEndpointKafkaSetting>
mongodbSettings List<GetEndpointMongodbSetting>
tags Map<String,String>

endpointId 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.
elasticsearchSettings GetEndpointElasticsearchSetting[]
extraConnectionAttributes string
kafkaSettings GetEndpointKafkaSetting[]
mongodbSettings GetEndpointMongodbSetting[]
tags {[key: string]: string}

endpoint_id str: 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.
elasticsearch_settings Sequence[GetEndpointElasticsearchSetting]
extra_connection_attributes str
kafka_settings Sequence[GetEndpointKafkaSetting]
mongodb_settings Sequence[GetEndpointMongodbSetting]
tags Mapping[str, str]

endpointId 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.
elasticsearchSettings List<Property Map>
extraConnectionAttributes String
kafkaSettings List<Property Map>
mongodbSettings List<Property Map>
tags Map<String>