@Stability(value=Stable) public static final class CfnEndpoint.Builder extends Object implements software.amazon.jsii.Builder<CfnEndpoint>
CfnEndpoint.| Modifier and Type | Method and Description |
|---|---|
CfnEndpoint |
build() |
CfnEndpoint.Builder |
certificateArn(String certificateArn)
The Amazon Resource Name (ARN) for the certificate.
|
static CfnEndpoint.Builder |
create(Construct scope,
String id) |
CfnEndpoint.Builder |
databaseName(String databaseName)
The name of the endpoint database.
|
CfnEndpoint.Builder |
docDbSettings(CfnEndpoint.DocDbSettingsProperty docDbSettings)
Settings in JSON format for the source DocumentDB endpoint.
|
CfnEndpoint.Builder |
docDbSettings(IResolvable docDbSettings)
Settings in JSON format for the source DocumentDB endpoint.
|
CfnEndpoint.Builder |
dynamoDbSettings(CfnEndpoint.DynamoDbSettingsProperty dynamoDbSettings)
Settings in JSON format for the target Amazon DynamoDB endpoint.
|
CfnEndpoint.Builder |
dynamoDbSettings(IResolvable dynamoDbSettings)
Settings in JSON format for the target Amazon DynamoDB endpoint.
|
CfnEndpoint.Builder |
elasticsearchSettings(CfnEndpoint.ElasticsearchSettingsProperty elasticsearchSettings)
Settings in JSON format for the target OpenSearch endpoint.
|
CfnEndpoint.Builder |
elasticsearchSettings(IResolvable elasticsearchSettings)
Settings in JSON format for the target OpenSearch endpoint.
|
CfnEndpoint.Builder |
endpointIdentifier(String endpointIdentifier)
The database endpoint identifier.
|
CfnEndpoint.Builder |
endpointType(String endpointType)
The type of endpoint.
|
CfnEndpoint.Builder |
engineName(String engineName)
The type of engine for the endpoint.
|
CfnEndpoint.Builder |
extraConnectionAttributes(String extraConnectionAttributes)
Additional attributes associated with the connection.
|
CfnEndpoint.Builder |
ibmDb2Settings(CfnEndpoint.IbmDb2SettingsProperty ibmDb2Settings)
Not currently supported by AWS CloudFormation .
|
CfnEndpoint.Builder |
ibmDb2Settings(IResolvable ibmDb2Settings)
Not currently supported by AWS CloudFormation .
|
CfnEndpoint.Builder |
kafkaSettings(CfnEndpoint.KafkaSettingsProperty kafkaSettings)
Settings in JSON format for the target Apache Kafka endpoint.
|
CfnEndpoint.Builder |
kafkaSettings(IResolvable kafkaSettings)
Settings in JSON format for the target Apache Kafka endpoint.
|
CfnEndpoint.Builder |
kinesisSettings(CfnEndpoint.KinesisSettingsProperty kinesisSettings)
Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams.
|
CfnEndpoint.Builder |
kinesisSettings(IResolvable kinesisSettings)
Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams.
|
CfnEndpoint.Builder |
kmsKeyId(String kmsKeyId)
An AWS KMS key identifier that is used to encrypt the connection parameters for the endpoint.
|
CfnEndpoint.Builder |
microsoftSqlServerSettings(CfnEndpoint.MicrosoftSqlServerSettingsProperty microsoftSqlServerSettings)
Not currently supported by AWS CloudFormation .
|
CfnEndpoint.Builder |
microsoftSqlServerSettings(IResolvable microsoftSqlServerSettings)
Not currently supported by AWS CloudFormation .
|
CfnEndpoint.Builder |
mongoDbSettings(CfnEndpoint.MongoDbSettingsProperty mongoDbSettings)
Not currently supported by AWS CloudFormation .
|
CfnEndpoint.Builder |
mongoDbSettings(IResolvable mongoDbSettings)
Not currently supported by AWS CloudFormation .
|
CfnEndpoint.Builder |
mySqlSettings(CfnEndpoint.MySqlSettingsProperty mySqlSettings)
Settings in JSON format for the source and target MySQL endpoint.
|
CfnEndpoint.Builder |
mySqlSettings(IResolvable mySqlSettings)
Settings in JSON format for the source and target MySQL endpoint.
|
CfnEndpoint.Builder |
neptuneSettings(CfnEndpoint.NeptuneSettingsProperty neptuneSettings)
`AWS::DMS::Endpoint.NeptuneSettings`.
|
CfnEndpoint.Builder |
neptuneSettings(IResolvable neptuneSettings)
`AWS::DMS::Endpoint.NeptuneSettings`.
|
CfnEndpoint.Builder |
oracleSettings(CfnEndpoint.OracleSettingsProperty oracleSettings)
Settings in JSON format for the source and target Oracle endpoint.
|
CfnEndpoint.Builder |
oracleSettings(IResolvable oracleSettings)
Settings in JSON format for the source and target Oracle endpoint.
|
CfnEndpoint.Builder |
password(String password)
The password to be used to log in to the endpoint database.
|
CfnEndpoint.Builder |
port(Number port)
The port used by the endpoint database.
|
CfnEndpoint.Builder |
postgreSqlSettings(CfnEndpoint.PostgreSqlSettingsProperty postgreSqlSettings)
Not currently supported by AWS CloudFormation .
|
CfnEndpoint.Builder |
postgreSqlSettings(IResolvable postgreSqlSettings)
Not currently supported by AWS CloudFormation .
|
CfnEndpoint.Builder |
redisSettings(CfnEndpoint.RedisSettingsProperty redisSettings)
Settings in JSON format for the target Redis endpoint.
|
CfnEndpoint.Builder |
redisSettings(IResolvable redisSettings)
Settings in JSON format for the target Redis endpoint.
|
CfnEndpoint.Builder |
redshiftSettings(CfnEndpoint.RedshiftSettingsProperty redshiftSettings)
Not currently supported by AWS CloudFormation .
|
CfnEndpoint.Builder |
redshiftSettings(IResolvable redshiftSettings)
Not currently supported by AWS CloudFormation .
|
CfnEndpoint.Builder |
resourceIdentifier(String resourceIdentifier)
A friendly name for the resource identifier at the end of the `EndpointArn` response parameter that is returned in the created `Endpoint` object.
|
CfnEndpoint.Builder |
s3Settings(CfnEndpoint.S3SettingsProperty s3Settings)
Settings in JSON format for the target Amazon S3 endpoint.
|
CfnEndpoint.Builder |
s3Settings(IResolvable s3Settings)
Settings in JSON format for the target Amazon S3 endpoint.
|
CfnEndpoint.Builder |
serverName(String serverName)
The name of the server where the endpoint database resides.
|
CfnEndpoint.Builder |
sslMode(String sslMode)
The Secure Sockets Layer (SSL) mode to use for the SSL connection.
|
CfnEndpoint.Builder |
sybaseSettings(CfnEndpoint.SybaseSettingsProperty sybaseSettings)
Settings in JSON format for the source and target SAP ASE endpoint.
|
CfnEndpoint.Builder |
sybaseSettings(IResolvable sybaseSettings)
Settings in JSON format for the source and target SAP ASE endpoint.
|
CfnEndpoint.Builder |
tags(List<? extends CfnTag> tags)
One or more tags to be assigned to the endpoint.
|
CfnEndpoint.Builder |
username(String username)
The user name to be used to log in to the endpoint database.
|
@Stability(value=Stable) public static CfnEndpoint.Builder create(Construct scope, String id)
scope - - scope in which this resource is defined. This parameter is required.id - - scoped id of the resource. This parameter is required.CfnEndpoint.DocDbSettingsProperty.Builder.@Stability(value=Stable) public CfnEndpoint.Builder endpointType(String endpointType)
Valid values are source and target .
endpointType - The type of endpoint. This parameter is required.this@Stability(value=Stable) public CfnEndpoint.Builder engineName(String engineName)
Valid values, depending on the EndpointType value, include "mysql" , "oracle" , "postgres" , "mariadb" , "aurora" , "aurora-postgresql" , "opensearch" , "redshift" , "s3" , "db2" , "azuredb" , "sybase" , "dynamodb" , "mongodb" , "kinesis" , "kafka" , "elasticsearch" , "docdb" , "sqlserver" , and "neptune" .
engineName - The type of engine for the endpoint. This parameter is required.this@Stability(value=Stable) public CfnEndpoint.Builder certificateArn(String certificateArn)
certificateArn - The Amazon Resource Name (ARN) for the certificate. This parameter is required.this@Stability(value=Stable) public CfnEndpoint.Builder databaseName(String databaseName)
For a MySQL source or target endpoint, do not specify DatabaseName.
databaseName - The name of the endpoint database. This parameter is required.this@Stability(value=Stable) public CfnEndpoint.Builder docDbSettings(CfnEndpoint.DocDbSettingsProperty docDbSettings)
For more information about the available settings, see the configuration properties section in Using DocumentDB as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.
docDbSettings - Settings in JSON format for the source DocumentDB endpoint. This parameter is required.this@Stability(value=Stable) public CfnEndpoint.Builder docDbSettings(IResolvable docDbSettings)
For more information about the available settings, see the configuration properties section in Using DocumentDB as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.
docDbSettings - Settings in JSON format for the source DocumentDB endpoint. This parameter is required.this@Stability(value=Stable) public CfnEndpoint.Builder dynamoDbSettings(CfnEndpoint.DynamoDbSettingsProperty dynamoDbSettings)
For information about other available settings, see Using Object Mapping to Migrate Data to DynamoDB in the AWS Database Migration Service User Guide.
dynamoDbSettings - Settings in JSON format for the target Amazon DynamoDB endpoint. This parameter is required.this@Stability(value=Stable) public CfnEndpoint.Builder dynamoDbSettings(IResolvable dynamoDbSettings)
For information about other available settings, see Using Object Mapping to Migrate Data to DynamoDB in the AWS Database Migration Service User Guide.
dynamoDbSettings - Settings in JSON format for the target Amazon DynamoDB endpoint. This parameter is required.this@Stability(value=Stable) public CfnEndpoint.Builder elasticsearchSettings(CfnEndpoint.ElasticsearchSettingsProperty elasticsearchSettings)
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 .
elasticsearchSettings - Settings in JSON format for the target OpenSearch endpoint. This parameter is required.this@Stability(value=Stable) public CfnEndpoint.Builder elasticsearchSettings(IResolvable elasticsearchSettings)
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 .
elasticsearchSettings - Settings in JSON format for the target OpenSearch endpoint. This parameter is required.this@Stability(value=Stable) public CfnEndpoint.Builder endpointIdentifier(String endpointIdentifier)
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.
endpointIdentifier - The database endpoint identifier. This parameter is required.this@Stability(value=Stable) public CfnEndpoint.Builder extraConnectionAttributes(String extraConnectionAttributes)
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.
extraConnectionAttributes - Additional attributes associated with the connection. This parameter is required.this@Stability(value=Stable) public CfnEndpoint.Builder ibmDb2Settings(CfnEndpoint.IbmDb2SettingsProperty ibmDb2Settings)
ibmDb2Settings - Not currently supported by AWS CloudFormation . This parameter is required.this@Stability(value=Stable) public CfnEndpoint.Builder ibmDb2Settings(IResolvable ibmDb2Settings)
ibmDb2Settings - Not currently supported by AWS CloudFormation . This parameter is required.this@Stability(value=Stable) public CfnEndpoint.Builder kafkaSettings(CfnEndpoint.KafkaSettingsProperty kafkaSettings)
For more information about the available settings, see Using object mapping to migrate data to a Kafka topic in the AWS Database Migration Service User Guide.
kafkaSettings - Settings in JSON format for the target Apache Kafka endpoint. This parameter is required.this@Stability(value=Stable) public CfnEndpoint.Builder kafkaSettings(IResolvable kafkaSettings)
For more information about the available settings, see Using object mapping to migrate data to a Kafka topic in the AWS Database Migration Service User Guide.
kafkaSettings - Settings in JSON format for the target Apache Kafka endpoint. This parameter is required.this@Stability(value=Stable) public CfnEndpoint.Builder kinesisSettings(CfnEndpoint.KinesisSettingsProperty kinesisSettings)
For more information about the available settings, see Using Amazon Kinesis Data Streams as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.
kinesisSettings - Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. This parameter is required.this@Stability(value=Stable) public CfnEndpoint.Builder kinesisSettings(IResolvable kinesisSettings)
For more information about the available settings, see Using Amazon Kinesis Data Streams as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.
kinesisSettings - Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. This parameter is required.this@Stability(value=Stable) public CfnEndpoint.Builder kmsKeyId(String kmsKeyId)
If you don't specify a value for the KmsKeyId parameter, then 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 .
kmsKeyId - An AWS KMS key identifier that is used to encrypt the connection parameters for the endpoint. This parameter is required.this@Stability(value=Stable) public CfnEndpoint.Builder microsoftSqlServerSettings(CfnEndpoint.MicrosoftSqlServerSettingsProperty microsoftSqlServerSettings)
microsoftSqlServerSettings - Not currently supported by AWS CloudFormation . This parameter is required.this@Stability(value=Stable) public CfnEndpoint.Builder microsoftSqlServerSettings(IResolvable microsoftSqlServerSettings)
microsoftSqlServerSettings - Not currently supported by AWS CloudFormation . This parameter is required.this@Stability(value=Stable) public CfnEndpoint.Builder mongoDbSettings(CfnEndpoint.MongoDbSettingsProperty mongoDbSettings)
mongoDbSettings - Not currently supported by AWS CloudFormation . This parameter is required.this@Stability(value=Stable) public CfnEndpoint.Builder mongoDbSettings(IResolvable mongoDbSettings)
mongoDbSettings - Not currently supported by AWS CloudFormation . This parameter is required.this@Stability(value=Stable) public CfnEndpoint.Builder mySqlSettings(CfnEndpoint.MySqlSettingsProperty mySqlSettings)
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.
mySqlSettings - Settings in JSON format for the source and target MySQL endpoint. This parameter is required.this@Stability(value=Stable) public CfnEndpoint.Builder mySqlSettings(IResolvable mySqlSettings)
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.
mySqlSettings - Settings in JSON format for the source and target MySQL endpoint. This parameter is required.this@Stability(value=Stable) public CfnEndpoint.Builder neptuneSettings(CfnEndpoint.NeptuneSettingsProperty neptuneSettings)
neptuneSettings - `AWS::DMS::Endpoint.NeptuneSettings`. This parameter is required.this@Stability(value=Stable) public CfnEndpoint.Builder neptuneSettings(IResolvable neptuneSettings)
neptuneSettings - `AWS::DMS::Endpoint.NeptuneSettings`. This parameter is required.this@Stability(value=Stable) public CfnEndpoint.Builder oracleSettings(CfnEndpoint.OracleSettingsProperty oracleSettings)
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.
oracleSettings - Settings in JSON format for the source and target Oracle endpoint. This parameter is required.this@Stability(value=Stable) public CfnEndpoint.Builder oracleSettings(IResolvable oracleSettings)
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.
oracleSettings - Settings in JSON format for the source and target Oracle endpoint. This parameter is required.this@Stability(value=Stable) public CfnEndpoint.Builder password(String password)
password - The password to be used to log in to the endpoint database. This parameter is required.this@Stability(value=Stable) public CfnEndpoint.Builder port(Number port)
port - The port used by the endpoint database. This parameter is required.this@Stability(value=Stable) public CfnEndpoint.Builder postgreSqlSettings(CfnEndpoint.PostgreSqlSettingsProperty postgreSqlSettings)
postgreSqlSettings - Not currently supported by AWS CloudFormation . This parameter is required.this@Stability(value=Stable) public CfnEndpoint.Builder postgreSqlSettings(IResolvable postgreSqlSettings)
postgreSqlSettings - Not currently supported by AWS CloudFormation . This parameter is required.this@Stability(value=Stable) public CfnEndpoint.Builder redisSettings(CfnEndpoint.RedisSettingsProperty redisSettings)
redisSettings - Settings in JSON format for the target Redis endpoint. This parameter is required.this@Stability(value=Stable) public CfnEndpoint.Builder redisSettings(IResolvable redisSettings)
redisSettings - Settings in JSON format for the target Redis endpoint. This parameter is required.this@Stability(value=Stable) public CfnEndpoint.Builder redshiftSettings(CfnEndpoint.RedshiftSettingsProperty redshiftSettings)
redshiftSettings - Not currently supported by AWS CloudFormation . This parameter is required.this@Stability(value=Stable) public CfnEndpoint.Builder redshiftSettings(IResolvable redshiftSettings)
redshiftSettings - Not currently supported by AWS CloudFormation . This parameter is required.this@Stability(value=Stable) public CfnEndpoint.Builder resourceIdentifier(String resourceIdentifier)
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 .
resourceIdentifier - A friendly name for the resource identifier at the end of the `EndpointArn` response parameter that is returned in the created `Endpoint` object. This parameter is required.this@Stability(value=Stable) public CfnEndpoint.Builder s3Settings(CfnEndpoint.S3SettingsProperty s3Settings)
For more information about the available settings, see Extra Connection Attributes When Using Amazon S3 as a Target for AWS DMS in the AWS Database Migration Service User Guide.
s3Settings - Settings in JSON format for the target Amazon S3 endpoint. This parameter is required.this@Stability(value=Stable) public CfnEndpoint.Builder s3Settings(IResolvable s3Settings)
For more information about the available settings, see Extra Connection Attributes When Using Amazon S3 as a Target for AWS DMS in the AWS Database Migration Service User Guide.
s3Settings - Settings in JSON format for the target Amazon S3 endpoint. This parameter is required.this@Stability(value=Stable) public CfnEndpoint.Builder serverName(String serverName)
serverName - The name of the server where the endpoint database resides. This parameter is required.this@Stability(value=Stable) public CfnEndpoint.Builder sslMode(String sslMode)
When
engine_nameis set to S3, then the only allowed value isnone.
sslMode - The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is `none` . This parameter is required.this@Stability(value=Stable) public CfnEndpoint.Builder sybaseSettings(CfnEndpoint.SybaseSettingsProperty sybaseSettings)
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.
sybaseSettings - Settings in JSON format for the source and target SAP ASE endpoint. This parameter is required.this@Stability(value=Stable) public CfnEndpoint.Builder sybaseSettings(IResolvable sybaseSettings)
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.
sybaseSettings - Settings in JSON format for the source and target SAP ASE endpoint. This parameter is required.this@Stability(value=Stable) public CfnEndpoint.Builder tags(List<? extends CfnTag> tags)
tags - One or more tags to be assigned to the endpoint. This parameter is required.this@Stability(value=Stable) public CfnEndpoint.Builder username(String username)
username - The user name to be used to log in to the endpoint database. This parameter is required.this@Stability(value=Stable) public CfnEndpoint build()
build in interface software.amazon.jsii.Builder<CfnEndpoint>Copyright © 2022. All rights reserved.