Class CfnEndpointProps
Properties for defining a CfnEndpoint
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.DMS
Assembly: Amazon.CDK.AWS.DMS.dll
Syntax (csharp)
public class CfnEndpointProps : Object, ICfnEndpointProps
Syntax (vb)
Public Class CfnEndpointProps
Inherits Object
Implements ICfnEndpointProps
Remarks
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.DMS;
var cfnEndpointProps = new CfnEndpointProps {
EndpointType = "endpointType",
EngineName = "engineName",
// the properties below are optional
CertificateArn = "certificateArn",
DatabaseName = "databaseName",
DocDbSettings = new DocDbSettingsProperty {
DocsToInvestigate = 123,
ExtractDocId = false,
NestingLevel = "nestingLevel",
SecretsManagerAccessRoleArn = "secretsManagerAccessRoleArn",
SecretsManagerSecretId = "secretsManagerSecretId"
},
DynamoDbSettings = new DynamoDbSettingsProperty {
ServiceAccessRoleArn = "serviceAccessRoleArn"
},
ElasticsearchSettings = new ElasticsearchSettingsProperty {
EndpointUri = "endpointUri",
ErrorRetryDuration = 123,
FullLoadErrorPercentage = 123,
ServiceAccessRoleArn = "serviceAccessRoleArn"
},
EndpointIdentifier = "endpointIdentifier",
ExtraConnectionAttributes = "extraConnectionAttributes",
GcpMySqlSettings = new GcpMySQLSettingsProperty {
AfterConnectScript = "afterConnectScript",
CleanSourceMetadataOnMismatch = false,
DatabaseName = "databaseName",
EventsPollInterval = 123,
MaxFileSize = 123,
ParallelLoadThreads = 123,
Password = "password",
Port = 123,
SecretsManagerAccessRoleArn = "secretsManagerAccessRoleArn",
SecretsManagerSecretId = "secretsManagerSecretId",
ServerName = "serverName",
ServerTimezone = "serverTimezone",
Username = "username"
},
IbmDb2Settings = new IbmDb2SettingsProperty {
CurrentLsn = "currentLsn",
MaxKBytesPerRead = 123,
SecretsManagerAccessRoleArn = "secretsManagerAccessRoleArn",
SecretsManagerSecretId = "secretsManagerSecretId",
SetDataCaptureChanges = false
},
KafkaSettings = new KafkaSettingsProperty {
Broker = "broker",
IncludeControlDetails = false,
IncludeNullAndEmpty = false,
IncludePartitionValue = false,
IncludeTableAlterOperations = false,
IncludeTransactionDetails = false,
MessageFormat = "messageFormat",
MessageMaxBytes = 123,
NoHexPrefix = false,
PartitionIncludeSchemaTable = false,
SaslPassword = "saslPassword",
SaslUserName = "saslUserName",
SecurityProtocol = "securityProtocol",
SslCaCertificateArn = "sslCaCertificateArn",
SslClientCertificateArn = "sslClientCertificateArn",
SslClientKeyArn = "sslClientKeyArn",
SslClientKeyPassword = "sslClientKeyPassword",
Topic = "topic"
},
KinesisSettings = new KinesisSettingsProperty {
IncludeControlDetails = false,
IncludeNullAndEmpty = false,
IncludePartitionValue = false,
IncludeTableAlterOperations = false,
IncludeTransactionDetails = false,
MessageFormat = "messageFormat",
NoHexPrefix = false,
PartitionIncludeSchemaTable = false,
ServiceAccessRoleArn = "serviceAccessRoleArn",
StreamArn = "streamArn"
},
KmsKeyId = "kmsKeyId",
MicrosoftSqlServerSettings = new MicrosoftSqlServerSettingsProperty {
BcpPacketSize = 123,
ControlTablesFileGroup = "controlTablesFileGroup",
QuerySingleAlwaysOnNode = false,
ReadBackupOnly = false,
SafeguardPolicy = "safeguardPolicy",
SecretsManagerAccessRoleArn = "secretsManagerAccessRoleArn",
SecretsManagerSecretId = "secretsManagerSecretId",
UseBcpFullLoad = false,
UseThirdPartyBackupDevice = false
},
MongoDbSettings = new MongoDbSettingsProperty {
AuthMechanism = "authMechanism",
AuthSource = "authSource",
AuthType = "authType",
DatabaseName = "databaseName",
DocsToInvestigate = "docsToInvestigate",
ExtractDocId = "extractDocId",
NestingLevel = "nestingLevel",
Password = "password",
Port = 123,
SecretsManagerAccessRoleArn = "secretsManagerAccessRoleArn",
SecretsManagerSecretId = "secretsManagerSecretId",
ServerName = "serverName",
Username = "username"
},
MySqlSettings = new MySqlSettingsProperty {
AfterConnectScript = "afterConnectScript",
CleanSourceMetadataOnMismatch = false,
EventsPollInterval = 123,
MaxFileSize = 123,
ParallelLoadThreads = 123,
SecretsManagerAccessRoleArn = "secretsManagerAccessRoleArn",
SecretsManagerSecretId = "secretsManagerSecretId",
ServerTimezone = "serverTimezone",
TargetDbType = "targetDbType"
},
NeptuneSettings = new NeptuneSettingsProperty {
ErrorRetryDuration = 123,
IamAuthEnabled = false,
MaxFileSize = 123,
MaxRetryCount = 123,
S3BucketFolder = "s3BucketFolder",
S3BucketName = "s3BucketName",
ServiceAccessRoleArn = "serviceAccessRoleArn"
},
OracleSettings = new OracleSettingsProperty {
AccessAlternateDirectly = false,
AdditionalArchivedLogDestId = 123,
AddSupplementalLogging = false,
AllowSelectNestedTables = false,
ArchivedLogDestId = 123,
ArchivedLogsOnly = false,
AsmPassword = "asmPassword",
AsmServer = "asmServer",
AsmUser = "asmUser",
CharLengthSemantics = "charLengthSemantics",
DirectPathNoLog = false,
DirectPathParallelLoad = false,
EnableHomogenousTablespace = false,
ExtraArchivedLogDestIds = new [] { 123 },
FailTasksOnLobTruncation = false,
NumberDatatypeScale = 123,
OraclePathPrefix = "oraclePathPrefix",
ParallelAsmReadThreads = 123,
ReadAheadBlocks = 123,
ReadTableSpaceName = false,
ReplacePathPrefix = false,
RetryInterval = 123,
SecretsManagerAccessRoleArn = "secretsManagerAccessRoleArn",
SecretsManagerOracleAsmAccessRoleArn = "secretsManagerOracleAsmAccessRoleArn",
SecretsManagerOracleAsmSecretId = "secretsManagerOracleAsmSecretId",
SecretsManagerSecretId = "secretsManagerSecretId",
SecurityDbEncryption = "securityDbEncryption",
SecurityDbEncryptionName = "securityDbEncryptionName",
SpatialDataOptionToGeoJsonFunctionName = "spatialDataOptionToGeoJsonFunctionName",
StandbyDelayTime = 123,
UseAlternateFolderForOnline = false,
UseBFile = false,
UseDirectPathFullLoad = false,
UseLogminerReader = false,
UsePathPrefix = "usePathPrefix"
},
Password = "password",
Port = 123,
PostgreSqlSettings = new PostgreSqlSettingsProperty {
AfterConnectScript = "afterConnectScript",
CaptureDdls = false,
DdlArtifactsSchema = "ddlArtifactsSchema",
ExecuteTimeout = 123,
FailTasksOnLobTruncation = false,
HeartbeatEnable = false,
HeartbeatFrequency = 123,
HeartbeatSchema = "heartbeatSchema",
MapBooleanAsBoolean = false,
MaxFileSize = 123,
PluginName = "pluginName",
SecretsManagerAccessRoleArn = "secretsManagerAccessRoleArn",
SecretsManagerSecretId = "secretsManagerSecretId",
SlotName = "slotName"
},
RedisSettings = new RedisSettingsProperty {
AuthPassword = "authPassword",
AuthType = "authType",
AuthUserName = "authUserName",
Port = 123,
ServerName = "serverName",
SslCaCertificateArn = "sslCaCertificateArn",
SslSecurityProtocol = "sslSecurityProtocol"
},
RedshiftSettings = new RedshiftSettingsProperty {
AcceptAnyDate = false,
AfterConnectScript = "afterConnectScript",
BucketFolder = "bucketFolder",
BucketName = "bucketName",
CaseSensitiveNames = false,
CompUpdate = false,
ConnectionTimeout = 123,
DateFormat = "dateFormat",
EmptyAsNull = false,
EncryptionMode = "encryptionMode",
ExplicitIds = false,
FileTransferUploadStreams = 123,
LoadTimeout = 123,
MapBooleanAsBoolean = false,
MaxFileSize = 123,
RemoveQuotes = false,
ReplaceChars = "replaceChars",
ReplaceInvalidChars = "replaceInvalidChars",
SecretsManagerAccessRoleArn = "secretsManagerAccessRoleArn",
SecretsManagerSecretId = "secretsManagerSecretId",
ServerSideEncryptionKmsKeyId = "serverSideEncryptionKmsKeyId",
ServiceAccessRoleArn = "serviceAccessRoleArn",
TimeFormat = "timeFormat",
TrimBlanks = false,
TruncateColumns = false,
WriteBufferSize = 123
},
ResourceIdentifier = "resourceIdentifier",
S3Settings = new S3SettingsProperty {
AddColumnName = false,
BucketFolder = "bucketFolder",
BucketName = "bucketName",
CannedAclForObjects = "cannedAclForObjects",
CdcInsertsAndUpdates = false,
CdcInsertsOnly = false,
CdcMaxBatchInterval = 123,
CdcMinFileSize = 123,
CdcPath = "cdcPath",
CompressionType = "compressionType",
CsvDelimiter = "csvDelimiter",
CsvNoSupValue = "csvNoSupValue",
CsvNullValue = "csvNullValue",
CsvRowDelimiter = "csvRowDelimiter",
DataFormat = "dataFormat",
DataPageSize = 123,
DatePartitionDelimiter = "datePartitionDelimiter",
DatePartitionEnabled = false,
DatePartitionSequence = "datePartitionSequence",
DatePartitionTimezone = "datePartitionTimezone",
DictPageSizeLimit = 123,
EnableStatistics = false,
EncodingType = "encodingType",
EncryptionMode = "encryptionMode",
ExternalTableDefinition = "externalTableDefinition",
IgnoreHeaderRows = 123,
IncludeOpForFullLoad = false,
MaxFileSize = 123,
ParquetTimestampInMillisecond = false,
ParquetVersion = "parquetVersion",
PreserveTransactions = false,
Rfc4180 = false,
RowGroupLength = 123,
ServerSideEncryptionKmsKeyId = "serverSideEncryptionKmsKeyId",
ServiceAccessRoleArn = "serviceAccessRoleArn",
TimestampColumnName = "timestampColumnName",
UseCsvNoSupValue = false,
UseTaskStartTimeForFullLoadTimestamp = false
},
ServerName = "serverName",
SslMode = "sslMode",
SybaseSettings = new SybaseSettingsProperty {
SecretsManagerAccessRoleArn = "secretsManagerAccessRoleArn",
SecretsManagerSecretId = "secretsManagerSecretId"
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
Username = "username"
};
Synopsis
Constructors
CfnEndpointProps() |
Properties
CertificateArn | The Amazon Resource Name (ARN) for the certificate. |
DatabaseName | The name of the endpoint database. |
DocDbSettings | Settings in JSON format for the source and target DocumentDB endpoint. |
DynamoDbSettings | Settings in JSON format for the target Amazon DynamoDB endpoint. |
ElasticsearchSettings | Settings in JSON format for the target OpenSearch endpoint. |
EndpointIdentifier | The database endpoint identifier. |
EndpointType | The type of endpoint. |
EngineName | The type of engine for the endpoint, depending on the |
ExtraConnectionAttributes | Additional attributes associated with the connection. |
GcpMySqlSettings | Settings in JSON format for the source GCP MySQL endpoint. |
IbmDb2Settings | Settings in JSON format for the source IBM Db2 LUW endpoint. |
KafkaSettings | Settings in JSON format for the target Apache Kafka endpoint. |
KinesisSettings | Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. |
KmsKeyId | An AWS KMS key identifier that is used to encrypt the connection parameters for the endpoint. |
MicrosoftSqlServerSettings | Settings in JSON format for the source and target Microsoft SQL Server endpoint. |
MongoDbSettings | Settings in JSON format for the source MongoDB endpoint. |
MySqlSettings | Settings in JSON format for the source and target MySQL endpoint. |
NeptuneSettings | Settings in JSON format for the target Amazon Neptune endpoint. |
OracleSettings | Settings in JSON format for the source and target Oracle endpoint. |
Password | The password to be used to log in to the endpoint database. |
Port | The port used by the endpoint database. |
PostgreSqlSettings | Settings in JSON format for the source and target PostgreSQL endpoint. |
RedisSettings | Settings in JSON format for the target Redis endpoint. |
RedshiftSettings | Settings in JSON format for the Amazon Redshift endpoint. |
ResourceIdentifier | A display name for the resource identifier at the end of the |
S3Settings | Settings in JSON format for the source and target Amazon S3 endpoint. |
ServerName | The name of the server where the endpoint database resides. |
SslMode | The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is |
SybaseSettings | Settings in JSON format for the source and target SAP ASE endpoint. |
Tags | One or more tags to be assigned to the endpoint. |
Username | The user name to be used to log in to the endpoint database. |
Constructors
CfnEndpointProps()
public CfnEndpointProps()
Properties
CertificateArn
The Amazon Resource Name (ARN) for the certificate.
public string CertificateArn { get; set; }
Property Value
System.String
Remarks
DatabaseName
The name of the endpoint database.
public string DatabaseName { get; set; }
Property Value
System.String
Remarks
For a MySQL source or target endpoint, don't specify DatabaseName
. To migrate to a specific database, use this setting and targetDbType
.
DocDbSettings
Settings in JSON format for the source and target DocumentDB endpoint.
public object DocDbSettings { get; set; }
Property Value
System.Object
Remarks
For more information about other available settings, see Using extra connections attributes with Amazon DocumentDB as a source and Using Amazon DocumentDB as a target for AWS Database Migration Service in the AWS Database Migration Service User Guide .
DynamoDbSettings
Settings in JSON format for the target Amazon DynamoDB endpoint.
public object DynamoDbSettings { get; set; }
Property Value
System.Object
Remarks
For information about other available settings, see Using object mapping to migrate data to DynamoDB in the AWS Database Migration Service User Guide .
ElasticsearchSettings
Settings in JSON format for the target OpenSearch endpoint.
public object ElasticsearchSettings { get; set; }
Property Value
System.Object
Remarks
For more information about the available settings, see Extra connection attributes when using OpenSearch as a target for AWS DMS in the AWS Database Migration Service User Guide .
EndpointIdentifier
The database endpoint identifier.
public string EndpointIdentifier { get; set; }
Property Value
System.String
Remarks
Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen, or contain two consecutive hyphens.
EndpointType
The type of endpoint.
public string EndpointType { get; set; }
Property Value
System.String
Remarks
Valid values are source
and target
.
EngineName
The type of engine for the endpoint, depending on the EndpointType
value.
public string EngineName { get; set; }
Property Value
System.String
Remarks
Valid values : mysql
| oracle
| postgres
| mariadb
| aurora
| aurora-postgresql
| opensearch
| redshift
| s3
| db2
| azuredb
| sybase
| dynamodb
| mongodb
| kinesis
| kafka
| elasticsearch
| docdb
| sqlserver
| neptune
ExtraConnectionAttributes
Additional attributes associated with the connection.
public string ExtraConnectionAttributes { get; set; }
Property Value
System.String
Remarks
Each attribute is specified as a name-value pair associated by an equal sign (=). Multiple attributes are separated by a semicolon (;) with no additional white space. For information on the attributes available for connecting your source or target endpoint, see Working with AWS DMS Endpoints in the AWS Database Migration Service User Guide .
GcpMySqlSettings
Settings in JSON format for the source GCP MySQL endpoint.
public object GcpMySqlSettings { get; set; }
Property Value
System.Object
Remarks
These settings are much the same as the settings for any MySQL-compatible endpoint. For more information, see Extra connection attributes when using MySQL as a source for AWS DMS in the AWS Database Migration Service User Guide .
IbmDb2Settings
Settings in JSON format for the source IBM Db2 LUW endpoint.
public object IbmDb2Settings { get; set; }
Property Value
System.Object
Remarks
For information about other available settings, see Extra connection attributes when using Db2 LUW as a source for AWS DMS in the AWS Database Migration Service User Guide .
KafkaSettings
Settings in JSON format for the target Apache Kafka endpoint.
public object KafkaSettings { get; set; }
Property Value
System.Object
Remarks
For more information about other available settings, see Using object mapping to migrate data to a Kafka topic in the AWS Database Migration Service User Guide .
KinesisSettings
Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams.
public object KinesisSettings { get; set; }
Property Value
System.Object
Remarks
For more information about other available settings, see Using object mapping to migrate data to a Kinesis data stream in the AWS Database Migration Service User Guide .
KmsKeyId
An AWS KMS key identifier that is used to encrypt the connection parameters for the endpoint.
public string KmsKeyId { get; set; }
Property Value
System.String
Remarks
If you don't specify a value for the KmsKeyId
parameter, AWS DMS uses 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 .
MicrosoftSqlServerSettings
Settings in JSON format for the source and target Microsoft SQL Server endpoint.
public object MicrosoftSqlServerSettings { get; set; }
Property Value
System.Object
Remarks
For information about other available settings, see Extra connection attributes when using SQL Server as a source for AWS DMS and Extra connection attributes when using SQL Server as a target for AWS DMS in the AWS Database Migration Service User Guide .
MongoDbSettings
Settings in JSON format for the source MongoDB endpoint.
public object MongoDbSettings { get; set; }
Property Value
System.Object
Remarks
For more information about the available settings, see Using MongoDB as a target for AWS Database Migration Service in the AWS Database Migration Service User Guide .
MySqlSettings
Settings in JSON format for the source and target MySQL endpoint.
public object MySqlSettings { get; set; }
Property Value
System.Object
Remarks
For information about other available settings, see Extra connection attributes when using MySQL as a source for AWS DMS and Extra connection attributes when using a MySQL-compatible database as a target for AWS DMS in the AWS Database Migration Service User Guide .
NeptuneSettings
Settings in JSON format for the target Amazon Neptune endpoint.
public object NeptuneSettings { get; set; }
Property Value
System.Object
Remarks
For more information about the available settings, see Specifying endpoint settings for Amazon Neptune as a target in the AWS Database Migration Service User Guide .
OracleSettings
Settings in JSON format for the source and target Oracle endpoint.
public object OracleSettings { get; set; }
Property Value
System.Object
Remarks
For information about other available settings, see Extra connection attributes when using Oracle as a source for AWS DMS and Extra connection attributes when using Oracle as a target for AWS DMS in the AWS Database Migration Service User Guide .
Password
The password to be used to log in to the endpoint database.
public string Password { get; set; }
Property Value
System.String
Remarks
Port
The port used by the endpoint database.
public Nullable<double> Port { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
PostgreSqlSettings
Settings in JSON format for the source and target PostgreSQL endpoint.
public object PostgreSqlSettings { get; set; }
Property Value
System.Object
Remarks
For information about other available settings, see Extra connection attributes when using PostgreSQL as a source for AWS DMS and Extra connection attributes when using PostgreSQL as a target for AWS DMS in the AWS Database Migration Service User Guide .
RedisSettings
Settings in JSON format for the target Redis endpoint.
public object RedisSettings { get; set; }
Property Value
System.Object
Remarks
For information about other available settings, see Specifying endpoint settings for Redis as a target in the AWS Database Migration Service User Guide .
RedshiftSettings
Settings in JSON format for the Amazon Redshift endpoint.
public object RedshiftSettings { get; set; }
Property Value
System.Object
Remarks
For more information about other available settings, see Extra connection attributes when using Amazon Redshift as a target for AWS DMS in the AWS Database Migration Service User Guide .
ResourceIdentifier
A display name for the resource identifier at the end of the EndpointArn
response parameter that is returned in the created Endpoint
object.
public string ResourceIdentifier { get; set; }
Property Value
System.String
Remarks
The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as Example-App-ARN1
.
For example, this value might result in the EndpointArn
value arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1
. If you don't specify a ResourceIdentifier
value, AWS DMS generates a default identifier value for the end of EndpointArn
.
S3Settings
Settings in JSON format for the source and target Amazon S3 endpoint.
public object S3Settings { get; set; }
Property Value
System.Object
Remarks
For more information about other available settings, see Extra connection attributes when using Amazon S3 as a source for AWS DMS and Extra connection attributes when using Amazon S3 as a target for AWS DMS in the AWS Database Migration Service User Guide .
ServerName
The name of the server where the endpoint database resides.
public string ServerName { get; set; }
Property Value
System.String
Remarks
SslMode
The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is none
.
public string SslMode { get; set; }
Property Value
System.String
Remarks
When engine_name
is set to S3, the only allowed value is none
.
SybaseSettings
Settings in JSON format for the source and target SAP ASE endpoint.
public object SybaseSettings { get; set; }
Property Value
System.Object
Remarks
For information about other available settings, see Extra connection attributes when using SAP ASE as a source for AWS DMS and Extra connection attributes when using SAP ASE as a target for AWS DMS in the AWS Database Migration Service User Guide .
Tags
One or more tags to be assigned to the endpoint.
public ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]
Remarks
Username
The user name to be used to log in to the endpoint database.
public string Username { get; set; }
Property Value
System.String