Class CfnEndpoint
The AWS::DMS::Endpoint
resource specifies an AWS DMS endpoint.
Inherited Members
Namespace: Amazon.CDK.AWS.DMS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnEndpoint : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnEndpoint
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
Currently, AWS CloudFormation supports all AWS DMS endpoint types.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html
CloudformationResource: AWS::DMS::Endpoint
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 cfnEndpoint = new CfnEndpoint(this, "MyCfnEndpoint", 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",
KeepCsvFiles = false,
LoadTimeout = 123,
MaxFileSize = 123,
MaxKBytesPerRead = 123,
SecretsManagerAccessRoleArn = "secretsManagerAccessRoleArn",
SecretsManagerSecretId = "secretsManagerSecretId",
SetDataCaptureChanges = false,
WriteBufferSize = 123
},
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",
DatabaseName = "databaseName",
ForceLobLookup = false,
Password = "password",
Port = 123,
QuerySingleAlwaysOnNode = false,
ReadBackupOnly = false,
SafeguardPolicy = "safeguardPolicy",
SecretsManagerAccessRoleArn = "secretsManagerAccessRoleArn",
SecretsManagerSecretId = "secretsManagerSecretId",
ServerName = "serverName",
TlogAccessMode = "tlogAccessMode",
TrimSpaceInChar = false,
UseBcpFullLoad = false,
Username = "username",
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",
BabelfishDatabaseName = "babelfishDatabaseName",
CaptureDdls = false,
DatabaseMode = "databaseMode",
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,
AddTrailingPaddingCharacter = 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",
ExpectedBucketOwner = "expectedBucketOwner",
ExternalTableDefinition = "externalTableDefinition",
GlueCatalogGeneration = false,
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
CfnEndpoint(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnEndpoint(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnEndpoint(Construct, String, ICfnEndpointProps) |
Properties
AttrExternalId | A value that can be used for cross-account validation. |
AttrId | |
CertificateArn | The Amazon Resource Name (ARN) for the certificate. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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. |
SybaseSettings | Settings in JSON format for the source and target SAP ASE endpoint. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | One or more tags to be assigned to the endpoint. |
Username | The user name to be used to log in to the endpoint database. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnEndpoint(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnEndpoint(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnEndpoint(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnEndpoint(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnEndpoint(Construct, String, ICfnEndpointProps)
public CfnEndpoint(Construct scope, string id, ICfnEndpointProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnEndpointProps
Resource properties.
Properties
AttrExternalId
A value that can be used for cross-account validation.
public virtual string AttrExternalId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ExternalId
AttrId
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
CertificateArn
The Amazon Resource Name (ARN) for the certificate.
public virtual string CertificateArn { get; set; }
Property Value
System.String
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DatabaseName
The name of the endpoint database.
public virtual string DatabaseName { get; set; }
Property Value
System.String
DocDbSettings
Settings in JSON format for the source and target DocumentDB endpoint.
public virtual object DocDbSettings { get; set; }
Property Value
System.Object
DynamoDbSettings
Settings in JSON format for the target Amazon DynamoDB endpoint.
public virtual object DynamoDbSettings { get; set; }
Property Value
System.Object
ElasticsearchSettings
Settings in JSON format for the target OpenSearch endpoint.
public virtual object ElasticsearchSettings { get; set; }
Property Value
System.Object
EndpointIdentifier
The database endpoint identifier.
public virtual string EndpointIdentifier { get; set; }
Property Value
System.String
EndpointType
The type of endpoint.
public virtual string EndpointType { get; set; }
Property Value
System.String
EngineName
The type of engine for the endpoint, depending on the EndpointType
value.
public virtual string EngineName { get; set; }
Property Value
System.String
ExtraConnectionAttributes
Additional attributes associated with the connection.
public virtual string ExtraConnectionAttributes { get; set; }
Property Value
System.String
GcpMySqlSettings
Settings in JSON format for the source GCP MySQL endpoint.
public virtual object GcpMySqlSettings { get; set; }
Property Value
System.Object
IbmDb2Settings
Settings in JSON format for the source IBM Db2 LUW endpoint.
public virtual object IbmDb2Settings { get; set; }
Property Value
System.Object
KafkaSettings
Settings in JSON format for the target Apache Kafka endpoint.
public virtual object KafkaSettings { get; set; }
Property Value
System.Object
KinesisSettings
Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams.
public virtual object KinesisSettings { get; set; }
Property Value
System.Object
KmsKeyId
An AWS KMS key identifier that is used to encrypt the connection parameters for the endpoint.
public virtual string KmsKeyId { get; set; }
Property Value
System.String
MicrosoftSqlServerSettings
Settings in JSON format for the source and target Microsoft SQL Server endpoint.
public virtual object MicrosoftSqlServerSettings { get; set; }
Property Value
System.Object
MongoDbSettings
Settings in JSON format for the source MongoDB endpoint.
public virtual object MongoDbSettings { get; set; }
Property Value
System.Object
MySqlSettings
Settings in JSON format for the source and target MySQL endpoint.
public virtual object MySqlSettings { get; set; }
Property Value
System.Object
NeptuneSettings
Settings in JSON format for the target Amazon Neptune endpoint.
public virtual object NeptuneSettings { get; set; }
Property Value
System.Object
OracleSettings
Settings in JSON format for the source and target Oracle endpoint.
public virtual object OracleSettings { get; set; }
Property Value
System.Object
Password
The password to be used to log in to the endpoint database.
public virtual string Password { get; set; }
Property Value
System.String
Port
The port used by the endpoint database.
public virtual Nullable<double> Port { get; set; }
Property Value
System.Nullable<System.Double>
PostgreSqlSettings
Settings in JSON format for the source and target PostgreSQL endpoint.
public virtual object PostgreSqlSettings { get; set; }
Property Value
System.Object
RedisSettings
Settings in JSON format for the target Redis endpoint.
public virtual object RedisSettings { get; set; }
Property Value
System.Object
RedshiftSettings
Settings in JSON format for the Amazon Redshift endpoint.
public virtual object RedshiftSettings { get; set; }
Property Value
System.Object
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 virtual string ResourceIdentifier { get; set; }
Property Value
System.String
S3Settings
Settings in JSON format for the source and target Amazon S3 endpoint.
public virtual object S3Settings { get; set; }
Property Value
System.Object
ServerName
The name of the server where the endpoint database resides.
public virtual string ServerName { get; set; }
Property Value
System.String
SslMode
The Secure Sockets Layer (SSL) mode to use for the SSL connection.
public virtual string SslMode { get; set; }
Property Value
System.String
Remarks
The default is none
.
SybaseSettings
Settings in JSON format for the source and target SAP ASE endpoint.
public virtual object SybaseSettings { get; set; }
Property Value
System.Object
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
One or more tags to be assigned to the endpoint.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
Username
The user name to be used to log in to the endpoint database.
public virtual string Username { get; set; }
Property Value
System.String
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>