aws logo
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>

getEndpoint Result

The following output properties are available:

Supporting Types

GetEndpointElasticsearchSetting

GetEndpointKafkaSetting

GetEndpointKinesisSetting

GetEndpointMongodbSetting

GetEndpointRedisSetting

GetEndpointRedshiftSetting

GetEndpointS3Setting

AddColumnName bool
BucketFolder string
BucketName string
CannedAclForObjects string
CdcInsertsAndUpdates bool
CdcInsertsOnly bool
CdcMaxBatchInterval int
CdcMinFileSize int
CdcPath string
CompressionType string
CsvDelimiter string
CsvNoSupValue string
CsvNullValue string
CsvRowDelimiter string
DataFormat string
DataPageSize int
DatePartitionDelimiter string
DatePartitionEnabled bool
DatePartitionSequence string
DictPageSizeLimit int
EnableStatistics bool
EncodingType string
EncryptionMode string
ExternalTableDefinition string
IgnoreHeaderRows int
IgnoreHeadersRow int
IncludeOpForFullLoad bool
MaxFileSize int
ParquetTimestampInMillisecond bool
ParquetVersion string
PreserveTransactions bool
Rfc4180 bool
RowGroupLength int
ServerSideEncryptionKmsKeyId string
ServiceAccessRoleArn string
TimestampColumnName string
UseCsvNoSupValue bool
UseTaskStartTimeForFullLoadTimestamp bool
AddColumnName bool
BucketFolder string
BucketName string
CannedAclForObjects string
CdcInsertsAndUpdates bool
CdcInsertsOnly bool
CdcMaxBatchInterval int
CdcMinFileSize int
CdcPath string
CompressionType string
CsvDelimiter string
CsvNoSupValue string
CsvNullValue string
CsvRowDelimiter string
DataFormat string
DataPageSize int
DatePartitionDelimiter string
DatePartitionEnabled bool
DatePartitionSequence string
DictPageSizeLimit int
EnableStatistics bool
EncodingType string
EncryptionMode string
ExternalTableDefinition string
IgnoreHeaderRows int
IgnoreHeadersRow int
IncludeOpForFullLoad bool
MaxFileSize int
ParquetTimestampInMillisecond bool
ParquetVersion string
PreserveTransactions bool
Rfc4180 bool
RowGroupLength int
ServerSideEncryptionKmsKeyId string
ServiceAccessRoleArn string
TimestampColumnName string
UseCsvNoSupValue bool
UseTaskStartTimeForFullLoadTimestamp bool
addColumnName Boolean
bucketFolder String
bucketName String
cannedAclForObjects String
cdcInsertsAndUpdates Boolean
cdcInsertsOnly Boolean
cdcMaxBatchInterval Integer
cdcMinFileSize Integer
cdcPath String
compressionType String
csvDelimiter String
csvNoSupValue String
csvNullValue String
csvRowDelimiter String
dataFormat String
dataPageSize Integer
datePartitionDelimiter String
datePartitionEnabled Boolean
datePartitionSequence String
dictPageSizeLimit Integer
enableStatistics Boolean
encodingType String
encryptionMode String
externalTableDefinition String
ignoreHeaderRows Integer
ignoreHeadersRow Integer
includeOpForFullLoad Boolean
maxFileSize Integer
parquetTimestampInMillisecond Boolean
parquetVersion String
preserveTransactions Boolean
rfc4180 Boolean
rowGroupLength Integer
serverSideEncryptionKmsKeyId String
serviceAccessRoleArn String
timestampColumnName String
useCsvNoSupValue Boolean
useTaskStartTimeForFullLoadTimestamp Boolean
addColumnName boolean
bucketFolder string
bucketName string
cannedAclForObjects string
cdcInsertsAndUpdates boolean
cdcInsertsOnly boolean
cdcMaxBatchInterval number
cdcMinFileSize number
cdcPath string
compressionType string
csvDelimiter string
csvNoSupValue string
csvNullValue string
csvRowDelimiter string
dataFormat string
dataPageSize number
datePartitionDelimiter string
datePartitionEnabled boolean
datePartitionSequence string
dictPageSizeLimit number
enableStatistics boolean
encodingType string
encryptionMode string
externalTableDefinition string
ignoreHeaderRows number
ignoreHeadersRow number
includeOpForFullLoad boolean
maxFileSize number
parquetTimestampInMillisecond boolean
parquetVersion string
preserveTransactions boolean
rfc4180 boolean
rowGroupLength number
serverSideEncryptionKmsKeyId string
serviceAccessRoleArn string
timestampColumnName string
useCsvNoSupValue boolean
useTaskStartTimeForFullLoadTimestamp boolean
add_column_name bool
bucket_folder str
bucket_name str
canned_acl_for_objects str
cdc_inserts_and_updates bool
cdc_inserts_only bool
cdc_max_batch_interval int
cdc_min_file_size int
cdc_path str
compression_type str
csv_delimiter str
csv_no_sup_value str
csv_null_value str
csv_row_delimiter str
data_format str
data_page_size int
date_partition_delimiter str
date_partition_enabled bool
date_partition_sequence str
dict_page_size_limit int
enable_statistics bool
encoding_type str
encryption_mode str
external_table_definition str
ignore_header_rows int
ignore_headers_row int
include_op_for_full_load bool
max_file_size int
parquet_timestamp_in_millisecond bool
parquet_version str
preserve_transactions bool
rfc4180 bool
row_group_length int
server_side_encryption_kms_key_id str
service_access_role_arn str
timestamp_column_name str
use_csv_no_sup_value bool
use_task_start_time_for_full_load_timestamp bool
addColumnName Boolean
bucketFolder String
bucketName String
cannedAclForObjects String
cdcInsertsAndUpdates Boolean
cdcInsertsOnly Boolean
cdcMaxBatchInterval Number
cdcMinFileSize Number
cdcPath String
compressionType String
csvDelimiter String
csvNoSupValue String
csvNullValue String
csvRowDelimiter String
dataFormat String
dataPageSize Number
datePartitionDelimiter String
datePartitionEnabled Boolean
datePartitionSequence String
dictPageSizeLimit Number
enableStatistics Boolean
encodingType String
encryptionMode String
externalTableDefinition String
ignoreHeaderRows Number
ignoreHeadersRow Number
includeOpForFullLoad Boolean
maxFileSize Number
parquetTimestampInMillisecond Boolean
parquetVersion String
preserveTransactions Boolean
rfc4180 Boolean
rowGroupLength Number
serverSideEncryptionKmsKeyId String
serviceAccessRoleArn String
timestampColumnName String
useCsvNoSupValue Boolean
useTaskStartTimeForFullLoadTimestamp Boolean

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.