@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:35.851Z") public class CfnEndpoint extends CfnResource implements IInspectable
The AWS::DMS::Endpoint
resource specifies an AWS DMS endpoint.
Currently, AWS CloudFormation supports all AWS DMS endpoint types.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.dms.*; CfnEndpoint cfnEndpoint = CfnEndpoint.Builder.create(this, "MyCfnEndpoint") .endpointType("endpointType") .engineName("engineName") // the properties below are optional .certificateArn("certificateArn") .databaseName("databaseName") .docDbSettings(DocDbSettingsProperty.builder() .docsToInvestigate(123) .extractDocId(false) .nestingLevel("nestingLevel") .secretsManagerAccessRoleArn("secretsManagerAccessRoleArn") .secretsManagerSecretId("secretsManagerSecretId") .build()) .dynamoDbSettings(DynamoDbSettingsProperty.builder() .serviceAccessRoleArn("serviceAccessRoleArn") .build()) .elasticsearchSettings(ElasticsearchSettingsProperty.builder() .endpointUri("endpointUri") .errorRetryDuration(123) .fullLoadErrorPercentage(123) .serviceAccessRoleArn("serviceAccessRoleArn") .build()) .endpointIdentifier("endpointIdentifier") .extraConnectionAttributes("extraConnectionAttributes") .gcpMySqlSettings(GcpMySQLSettingsProperty.builder() .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") .build()) .ibmDb2Settings(IbmDb2SettingsProperty.builder() .currentLsn("currentLsn") .maxKBytesPerRead(123) .secretsManagerAccessRoleArn("secretsManagerAccessRoleArn") .secretsManagerSecretId("secretsManagerSecretId") .setDataCaptureChanges(false) .build()) .kafkaSettings(KafkaSettingsProperty.builder() .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") .build()) .kinesisSettings(KinesisSettingsProperty.builder() .includeControlDetails(false) .includeNullAndEmpty(false) .includePartitionValue(false) .includeTableAlterOperations(false) .includeTransactionDetails(false) .messageFormat("messageFormat") .noHexPrefix(false) .partitionIncludeSchemaTable(false) .serviceAccessRoleArn("serviceAccessRoleArn") .streamArn("streamArn") .build()) .kmsKeyId("kmsKeyId") .microsoftSqlServerSettings(MicrosoftSqlServerSettingsProperty.builder() .bcpPacketSize(123) .controlTablesFileGroup("controlTablesFileGroup") .querySingleAlwaysOnNode(false) .readBackupOnly(false) .safeguardPolicy("safeguardPolicy") .secretsManagerAccessRoleArn("secretsManagerAccessRoleArn") .secretsManagerSecretId("secretsManagerSecretId") .useBcpFullLoad(false) .useThirdPartyBackupDevice(false) .build()) .mongoDbSettings(MongoDbSettingsProperty.builder() .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") .build()) .mySqlSettings(MySqlSettingsProperty.builder() .afterConnectScript("afterConnectScript") .cleanSourceMetadataOnMismatch(false) .eventsPollInterval(123) .maxFileSize(123) .parallelLoadThreads(123) .secretsManagerAccessRoleArn("secretsManagerAccessRoleArn") .secretsManagerSecretId("secretsManagerSecretId") .serverTimezone("serverTimezone") .targetDbType("targetDbType") .build()) .neptuneSettings(NeptuneSettingsProperty.builder() .errorRetryDuration(123) .iamAuthEnabled(false) .maxFileSize(123) .maxRetryCount(123) .s3BucketFolder("s3BucketFolder") .s3BucketName("s3BucketName") .serviceAccessRoleArn("serviceAccessRoleArn") .build()) .oracleSettings(OracleSettingsProperty.builder() .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(List.of(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") .build()) .password("password") .port(123) .postgreSqlSettings(PostgreSqlSettingsProperty.builder() .afterConnectScript("afterConnectScript") .captureDdls(false) .ddlArtifactsSchema("ddlArtifactsSchema") .executeTimeout(123) .failTasksOnLobTruncation(false) .heartbeatEnable(false) .heartbeatFrequency(123) .heartbeatSchema("heartbeatSchema") .maxFileSize(123) .pluginName("pluginName") .secretsManagerAccessRoleArn("secretsManagerAccessRoleArn") .secretsManagerSecretId("secretsManagerSecretId") .slotName("slotName") .build()) .redisSettings(RedisSettingsProperty.builder() .authPassword("authPassword") .authType("authType") .authUserName("authUserName") .port(123) .serverName("serverName") .sslCaCertificateArn("sslCaCertificateArn") .sslSecurityProtocol("sslSecurityProtocol") .build()) .redshiftSettings(RedshiftSettingsProperty.builder() .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) .maxFileSize(123) .removeQuotes(false) .replaceChars("replaceChars") .replaceInvalidChars("replaceInvalidChars") .secretsManagerAccessRoleArn("secretsManagerAccessRoleArn") .secretsManagerSecretId("secretsManagerSecretId") .serverSideEncryptionKmsKeyId("serverSideEncryptionKmsKeyId") .serviceAccessRoleArn("serviceAccessRoleArn") .timeFormat("timeFormat") .trimBlanks(false) .truncateColumns(false) .writeBufferSize(123) .build()) .resourceIdentifier("resourceIdentifier") .s3Settings(S3SettingsProperty.builder() .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) .build()) .serverName("serverName") .sslMode("sslMode") .sybaseSettings(SybaseSettingsProperty.builder() .secretsManagerAccessRoleArn("secretsManagerAccessRoleArn") .secretsManagerSecretId("secretsManagerSecretId") .build()) .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .username("username") .build();
Modifier and Type | Class and Description |
---|---|
static class |
CfnEndpoint.Builder
A fluent builder for
CfnEndpoint . |
static interface |
CfnEndpoint.DocDbSettingsProperty
Provides information that defines a DocumentDB endpoint.
|
static interface |
CfnEndpoint.DynamoDbSettingsProperty
Provides information, including the Amazon Resource Name (ARN) of the IAM role used to define an Amazon DynamoDB target endpoint.
|
static interface |
CfnEndpoint.ElasticsearchSettingsProperty
Provides information that defines an OpenSearch endpoint.
|
static interface |
CfnEndpoint.GcpMySQLSettingsProperty
Provides information that defines a GCP MySQL endpoint.
|
static interface |
CfnEndpoint.IbmDb2SettingsProperty
Provides information that defines an IBMDB2 endpoint.
|
static interface |
CfnEndpoint.KafkaSettingsProperty
Provides information that describes an Apache Kafka endpoint.
|
static interface |
CfnEndpoint.KinesisSettingsProperty
Provides information that describes an Amazon Kinesis Data Stream endpoint.
|
static interface |
CfnEndpoint.MicrosoftSqlServerSettingsProperty
Provides information that defines a Microsoft SQL Server endpoint.
|
static interface |
CfnEndpoint.MongoDbSettingsProperty
Provides information that defines a MongoDB endpoint.
|
static interface |
CfnEndpoint.MySqlSettingsProperty
Provides information that defines a MySQL endpoint.
|
static interface |
CfnEndpoint.NeptuneSettingsProperty
Provides information that defines an Amazon Neptune endpoint.
|
static interface |
CfnEndpoint.OracleSettingsProperty
Provides information that defines an Oracle endpoint.
|
static interface |
CfnEndpoint.PostgreSqlSettingsProperty
Provides information that defines a PostgreSQL endpoint.
|
static interface |
CfnEndpoint.RedisSettingsProperty
Provides information that defines a Redis target endpoint.
|
static interface |
CfnEndpoint.RedshiftSettingsProperty
Provides information that defines an Amazon Redshift endpoint.
|
static interface |
CfnEndpoint.S3SettingsProperty
Provides information that defines an Amazon S3 endpoint.
|
static interface |
CfnEndpoint.SybaseSettingsProperty
Provides information that defines a SAP ASE endpoint.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnEndpoint(Construct scope,
java.lang.String id,
CfnEndpointProps props)
Create a new `AWS::DMS::Endpoint`.
|
protected |
CfnEndpoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnEndpoint(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttrExternalId()
A value that can be used for cross-account validation.
|
java.lang.String |
getCertificateArn()
The Amazon Resource Name (ARN) for the certificate.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getDatabaseName()
The name of the endpoint database.
|
java.lang.Object |
getDocDbSettings()
Settings in JSON format for the source and target DocumentDB endpoint.
|
java.lang.Object |
getDynamoDbSettings()
Settings in JSON format for the target Amazon DynamoDB endpoint.
|
java.lang.Object |
getElasticsearchSettings()
Settings in JSON format for the target OpenSearch endpoint.
|
java.lang.String |
getEndpointIdentifier()
The database endpoint identifier.
|
java.lang.String |
getEndpointType()
The type of endpoint.
|
java.lang.String |
getEngineName()
The type of engine for the endpoint, depending on the `EndpointType` value.
|
java.lang.String |
getExtraConnectionAttributes()
Additional attributes associated with the connection.
|
java.lang.Object |
getGcpMySqlSettings()
Settings in JSON format for the source GCP MySQL endpoint.
|
java.lang.Object |
getIbmDb2Settings()
Settings in JSON format for the source IBM Db2 LUW endpoint.
|
java.lang.Object |
getKafkaSettings()
Settings in JSON format for the target Apache Kafka endpoint.
|
java.lang.Object |
getKinesisSettings()
Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams.
|
java.lang.String |
getKmsKeyId()
An AWS KMS key identifier that is used to encrypt the connection parameters for the endpoint.
|
java.lang.Object |
getMicrosoftSqlServerSettings()
Settings in JSON format for the source and target Microsoft SQL Server endpoint.
|
java.lang.Object |
getMongoDbSettings()
Settings in JSON format for the source MongoDB endpoint.
|
java.lang.Object |
getMySqlSettings()
Settings in JSON format for the source and target MySQL endpoint.
|
java.lang.Object |
getNeptuneSettings()
Settings in JSON format for the target Amazon Neptune endpoint.
|
java.lang.Object |
getOracleSettings()
Settings in JSON format for the source and target Oracle endpoint.
|
java.lang.String |
getPassword()
The password to be used to log in to the endpoint database.
|
java.lang.Number |
getPort()
The port used by the endpoint database.
|
java.lang.Object |
getPostgreSqlSettings()
Settings in JSON format for the source and target PostgreSQL endpoint.
|
java.lang.Object |
getRedisSettings()
Settings in JSON format for the target Redis endpoint.
|
java.lang.Object |
getRedshiftSettings()
Settings in JSON format for the Amazon Redshift endpoint.
|
java.lang.String |
getResourceIdentifier()
A display name for the resource identifier at the end of the `EndpointArn` response parameter that is returned in the created `Endpoint` object.
|
java.lang.Object |
getS3Settings()
Settings in JSON format for the source and target Amazon S3 endpoint.
|
java.lang.String |
getServerName()
The name of the server where the endpoint database resides.
|
java.lang.String |
getSslMode()
The Secure Sockets Layer (SSL) mode to use for the SSL connection.
|
java.lang.Object |
getSybaseSettings()
Settings in JSON format for the source and target SAP ASE endpoint.
|
TagManager |
getTags()
One or more tags to be assigned to the endpoint.
|
java.lang.String |
getUsername()
The user name to be used to log in to the endpoint database.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setCertificateArn(java.lang.String value)
The Amazon Resource Name (ARN) for the certificate.
|
void |
setDatabaseName(java.lang.String value)
The name of the endpoint database.
|
void |
setDocDbSettings(CfnEndpoint.DocDbSettingsProperty value)
Settings in JSON format for the source and target DocumentDB endpoint.
|
void |
setDocDbSettings(IResolvable value)
Settings in JSON format for the source and target DocumentDB endpoint.
|
void |
setDynamoDbSettings(CfnEndpoint.DynamoDbSettingsProperty value)
Settings in JSON format for the target Amazon DynamoDB endpoint.
|
void |
setDynamoDbSettings(IResolvable value)
Settings in JSON format for the target Amazon DynamoDB endpoint.
|
void |
setElasticsearchSettings(CfnEndpoint.ElasticsearchSettingsProperty value)
Settings in JSON format for the target OpenSearch endpoint.
|
void |
setElasticsearchSettings(IResolvable value)
Settings in JSON format for the target OpenSearch endpoint.
|
void |
setEndpointIdentifier(java.lang.String value)
The database endpoint identifier.
|
void |
setEndpointType(java.lang.String value)
The type of endpoint.
|
void |
setEngineName(java.lang.String value)
The type of engine for the endpoint, depending on the `EndpointType` value.
|
void |
setExtraConnectionAttributes(java.lang.String value)
Additional attributes associated with the connection.
|
void |
setGcpMySqlSettings(CfnEndpoint.GcpMySQLSettingsProperty value)
Settings in JSON format for the source GCP MySQL endpoint.
|
void |
setGcpMySqlSettings(IResolvable value)
Settings in JSON format for the source GCP MySQL endpoint.
|
void |
setIbmDb2Settings(CfnEndpoint.IbmDb2SettingsProperty value)
Settings in JSON format for the source IBM Db2 LUW endpoint.
|
void |
setIbmDb2Settings(IResolvable value)
Settings in JSON format for the source IBM Db2 LUW endpoint.
|
void |
setKafkaSettings(CfnEndpoint.KafkaSettingsProperty value)
Settings in JSON format for the target Apache Kafka endpoint.
|
void |
setKafkaSettings(IResolvable value)
Settings in JSON format for the target Apache Kafka endpoint.
|
void |
setKinesisSettings(CfnEndpoint.KinesisSettingsProperty value)
Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams.
|
void |
setKinesisSettings(IResolvable value)
Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams.
|
void |
setKmsKeyId(java.lang.String value)
An AWS KMS key identifier that is used to encrypt the connection parameters for the endpoint.
|
void |
setMicrosoftSqlServerSettings(CfnEndpoint.MicrosoftSqlServerSettingsProperty value)
Settings in JSON format for the source and target Microsoft SQL Server endpoint.
|
void |
setMicrosoftSqlServerSettings(IResolvable value)
Settings in JSON format for the source and target Microsoft SQL Server endpoint.
|
void |
setMongoDbSettings(CfnEndpoint.MongoDbSettingsProperty value)
Settings in JSON format for the source MongoDB endpoint.
|
void |
setMongoDbSettings(IResolvable value)
Settings in JSON format for the source MongoDB endpoint.
|
void |
setMySqlSettings(CfnEndpoint.MySqlSettingsProperty value)
Settings in JSON format for the source and target MySQL endpoint.
|
void |
setMySqlSettings(IResolvable value)
Settings in JSON format for the source and target MySQL endpoint.
|
void |
setNeptuneSettings(CfnEndpoint.NeptuneSettingsProperty value)
Settings in JSON format for the target Amazon Neptune endpoint.
|
void |
setNeptuneSettings(IResolvable value)
Settings in JSON format for the target Amazon Neptune endpoint.
|
void |
setOracleSettings(CfnEndpoint.OracleSettingsProperty value)
Settings in JSON format for the source and target Oracle endpoint.
|
void |
setOracleSettings(IResolvable value)
Settings in JSON format for the source and target Oracle endpoint.
|
void |
setPassword(java.lang.String value)
The password to be used to log in to the endpoint database.
|
void |
setPort(java.lang.Number value)
The port used by the endpoint database.
|
void |
setPostgreSqlSettings(CfnEndpoint.PostgreSqlSettingsProperty value)
Settings in JSON format for the source and target PostgreSQL endpoint.
|
void |
setPostgreSqlSettings(IResolvable value)
Settings in JSON format for the source and target PostgreSQL endpoint.
|
void |
setRedisSettings(CfnEndpoint.RedisSettingsProperty value)
Settings in JSON format for the target Redis endpoint.
|
void |
setRedisSettings(IResolvable value)
Settings in JSON format for the target Redis endpoint.
|
void |
setRedshiftSettings(CfnEndpoint.RedshiftSettingsProperty value)
Settings in JSON format for the Amazon Redshift endpoint.
|
void |
setRedshiftSettings(IResolvable value)
Settings in JSON format for the Amazon Redshift endpoint.
|
void |
setResourceIdentifier(java.lang.String value)
A display name for the resource identifier at the end of the `EndpointArn` response parameter that is returned in the created `Endpoint` object.
|
void |
setS3Settings(CfnEndpoint.S3SettingsProperty value)
Settings in JSON format for the source and target Amazon S3 endpoint.
|
void |
setS3Settings(IResolvable value)
Settings in JSON format for the source and target Amazon S3 endpoint.
|
void |
setServerName(java.lang.String value)
The name of the server where the endpoint database resides.
|
void |
setSslMode(java.lang.String value)
The Secure Sockets Layer (SSL) mode to use for the SSL connection.
|
void |
setSybaseSettings(CfnEndpoint.SybaseSettingsProperty value)
Settings in JSON format for the source and target SAP ASE endpoint.
|
void |
setSybaseSettings(IResolvable value)
Settings in JSON format for the source and target SAP ASE endpoint.
|
void |
setUsername(java.lang.String value)
The user name to be used to log in to the endpoint database.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnEndpoint(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnEndpoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnEndpoint(Construct scope, java.lang.String id, CfnEndpointProps props)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.props
- - resource properties. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrExternalId()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
public java.lang.String getEndpointType()
Valid values are source
and target
.
public void setEndpointType(java.lang.String value)
Valid values are source
and target
.
public java.lang.String getEngineName()
Valid values : mysql
| oracle
| postgres
| mariadb
| aurora
| aurora-postgresql
| opensearch
| redshift
| s3
| db2
| azuredb
| sybase
| dynamodb
| mongodb
| kinesis
| kafka
| elasticsearch
| docdb
| sqlserver
| neptune
public void setEngineName(java.lang.String value)
Valid values : mysql
| oracle
| postgres
| mariadb
| aurora
| aurora-postgresql
| opensearch
| redshift
| s3
| db2
| azuredb
| sybase
| dynamodb
| mongodb
| kinesis
| kafka
| elasticsearch
| docdb
| sqlserver
| neptune
public java.lang.String getCertificateArn()
public void setCertificateArn(java.lang.String value)
public java.lang.String getDatabaseName()
For a MySQL source or target endpoint, don't specify DatabaseName
. To migrate to a specific database, use this setting and targetDbType
.
public void setDatabaseName(java.lang.String value)
For a MySQL source or target endpoint, don't specify DatabaseName
. To migrate to a specific database, use this setting and targetDbType
.
public java.lang.Object getDocDbSettings()
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 .
public void setDocDbSettings(CfnEndpoint.DocDbSettingsProperty value)
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 .
public void setDocDbSettings(IResolvable value)
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 .
public java.lang.Object getDynamoDbSettings()
For information about other available settings, see Using object mapping to migrate data to DynamoDB in the AWS Database Migration Service User Guide .
public void setDynamoDbSettings(IResolvable value)
For information about other available settings, see Using object mapping to migrate data to DynamoDB in the AWS Database Migration Service User Guide .
public void setDynamoDbSettings(CfnEndpoint.DynamoDbSettingsProperty value)
For information about other available settings, see Using object mapping to migrate data to DynamoDB in the AWS Database Migration Service User Guide .
public java.lang.Object getElasticsearchSettings()
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 .
public void setElasticsearchSettings(IResolvable value)
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 .
public void setElasticsearchSettings(CfnEndpoint.ElasticsearchSettingsProperty value)
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 .
public java.lang.String getEndpointIdentifier()
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.
public void setEndpointIdentifier(java.lang.String value)
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.
public java.lang.String getExtraConnectionAttributes()
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 .
public void setExtraConnectionAttributes(java.lang.String value)
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 .
public java.lang.Object getGcpMySqlSettings()
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 .
public void setGcpMySqlSettings(IResolvable value)
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 .
public void setGcpMySqlSettings(CfnEndpoint.GcpMySQLSettingsProperty value)
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 .
public java.lang.Object getIbmDb2Settings()
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 .
public void setIbmDb2Settings(IResolvable value)
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 .
public void setIbmDb2Settings(CfnEndpoint.IbmDb2SettingsProperty value)
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 .
public java.lang.Object getKafkaSettings()
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 .
public void setKafkaSettings(IResolvable value)
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 .
public void setKafkaSettings(CfnEndpoint.KafkaSettingsProperty value)
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 .
public java.lang.Object getKinesisSettings()
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 .
public void setKinesisSettings(IResolvable value)
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 .
public void setKinesisSettings(CfnEndpoint.KinesisSettingsProperty value)
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 .
public java.lang.String getKmsKeyId()
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 .
public void setKmsKeyId(java.lang.String value)
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 .
public java.lang.Object getMicrosoftSqlServerSettings()
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 .
public void setMicrosoftSqlServerSettings(IResolvable value)
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 .
public void setMicrosoftSqlServerSettings(CfnEndpoint.MicrosoftSqlServerSettingsProperty value)
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 .
public java.lang.Object getMongoDbSettings()
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 .
public void setMongoDbSettings(IResolvable value)
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 .
public void setMongoDbSettings(CfnEndpoint.MongoDbSettingsProperty value)
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 .
public java.lang.Object getMySqlSettings()
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 .
public void setMySqlSettings(IResolvable value)
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 .
public void setMySqlSettings(CfnEndpoint.MySqlSettingsProperty value)
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 .
public java.lang.Object getNeptuneSettings()
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 .
public void setNeptuneSettings(IResolvable value)
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 .
public void setNeptuneSettings(CfnEndpoint.NeptuneSettingsProperty value)
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 .
public java.lang.Object getOracleSettings()
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 .
public void setOracleSettings(IResolvable value)
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 .
public void setOracleSettings(CfnEndpoint.OracleSettingsProperty value)
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 .
public java.lang.String getPassword()
public void setPassword(java.lang.String value)
public java.lang.Number getPort()
public void setPort(java.lang.Number value)
public java.lang.Object getPostgreSqlSettings()
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 .
public void setPostgreSqlSettings(IResolvable value)
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 .
public void setPostgreSqlSettings(CfnEndpoint.PostgreSqlSettingsProperty value)
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 .
public java.lang.Object getRedisSettings()
For information about other available settings, see Specifying endpoint settings for Redis as a target in the AWS Database Migration Service User Guide .
public void setRedisSettings(IResolvable value)
For information about other available settings, see Specifying endpoint settings for Redis as a target in the AWS Database Migration Service User Guide .
public void setRedisSettings(CfnEndpoint.RedisSettingsProperty value)
For information about other available settings, see Specifying endpoint settings for Redis as a target in the AWS Database Migration Service User Guide .
public java.lang.Object getRedshiftSettings()
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 .
public void setRedshiftSettings(IResolvable value)
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 .
public void setRedshiftSettings(CfnEndpoint.RedshiftSettingsProperty value)
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 .
public java.lang.String getResourceIdentifier()
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
.
public void setResourceIdentifier(java.lang.String value)
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
.
public java.lang.Object getS3Settings()
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 .
public void setS3Settings(IResolvable value)
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 .
public void setS3Settings(CfnEndpoint.S3SettingsProperty value)
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 .
public java.lang.String getServerName()
public void setServerName(java.lang.String value)
public java.lang.String getSslMode()
When
engine_name
is set to S3, the only allowed value isnone
.
public void setSslMode(java.lang.String value)
When
engine_name
is set to S3, the only allowed value isnone
.
public java.lang.Object getSybaseSettings()
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 .
public void setSybaseSettings(IResolvable value)
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 .
public void setSybaseSettings(CfnEndpoint.SybaseSettingsProperty value)
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 .
public java.lang.String getUsername()
public void setUsername(java.lang.String value)