@Stability(value=Stable) public static final class CfnEndpointProps.Builder extends Object implements software.amazon.jsii.Builder<CfnEndpointProps>
CfnEndpointProps| Constructor and Description |
|---|
Builder() |
@Stability(value=Stable) public CfnEndpointProps.Builder endpointType(String endpointType)
CfnEndpointProps.getEndpointType()endpointType - The type of endpoint. This parameter is required.
Valid values are source and target .this@Stability(value=Stable) public CfnEndpointProps.Builder engineName(String engineName)
CfnEndpointProps.getEngineName()engineName - The type of engine for the endpoint, depending on the `EndpointType` value. This parameter is required.
Valid values : mysql | oracle | postgres | mariadb | aurora | aurora-postgresql | opensearch | redshift | s3 | db2 | azuredb | sybase | dynamodb | mongodb | kinesis | kafka | elasticsearch | docdb | sqlserver | neptunethis@Stability(value=Stable) public CfnEndpointProps.Builder certificateArn(String certificateArn)
CfnEndpointProps.getCertificateArn()certificateArn - The Amazon Resource Name (ARN) for the certificate.this@Stability(value=Stable) public CfnEndpointProps.Builder databaseName(String databaseName)
CfnEndpointProps.getDatabaseName()databaseName - The name of the endpoint database.
For a MySQL source or target endpoint, don't specify DatabaseName . To migrate to a specific database, use this setting and targetDbType .this@Stability(value=Stable) public CfnEndpointProps.Builder docDbSettings(CfnEndpoint.DocDbSettingsProperty docDbSettings)
CfnEndpointProps.getDocDbSettings()docDbSettings - Settings in JSON format for the source and target DocumentDB endpoint.
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 .this@Stability(value=Stable) public CfnEndpointProps.Builder docDbSettings(IResolvable docDbSettings)
CfnEndpointProps.getDocDbSettings()docDbSettings - Settings in JSON format for the source and target DocumentDB endpoint.
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 .this@Stability(value=Stable) public CfnEndpointProps.Builder dynamoDbSettings(CfnEndpoint.DynamoDbSettingsProperty dynamoDbSettings)
CfnEndpointProps.getDynamoDbSettings()dynamoDbSettings - Settings in JSON format for the target Amazon DynamoDB endpoint.
For information about other available settings, see Using object mapping to migrate data to DynamoDB in the AWS Database Migration Service User Guide .this@Stability(value=Stable) public CfnEndpointProps.Builder dynamoDbSettings(IResolvable dynamoDbSettings)
CfnEndpointProps.getDynamoDbSettings()dynamoDbSettings - Settings in JSON format for the target Amazon DynamoDB endpoint.
For information about other available settings, see Using object mapping to migrate data to DynamoDB in the AWS Database Migration Service User Guide .this@Stability(value=Stable) public CfnEndpointProps.Builder elasticsearchSettings(CfnEndpoint.ElasticsearchSettingsProperty elasticsearchSettings)
CfnEndpointProps.getElasticsearchSettings()elasticsearchSettings - Settings in JSON format for the target OpenSearch endpoint.
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 .this@Stability(value=Stable) public CfnEndpointProps.Builder elasticsearchSettings(IResolvable elasticsearchSettings)
CfnEndpointProps.getElasticsearchSettings()elasticsearchSettings - Settings in JSON format for the target OpenSearch endpoint.
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 .this@Stability(value=Stable) public CfnEndpointProps.Builder endpointIdentifier(String endpointIdentifier)
CfnEndpointProps.getEndpointIdentifier()endpointIdentifier - The database endpoint identifier.
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.this@Stability(value=Stable) public CfnEndpointProps.Builder extraConnectionAttributes(String extraConnectionAttributes)
CfnEndpointProps.getExtraConnectionAttributes()extraConnectionAttributes - Additional attributes associated with the connection.
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 .this@Stability(value=Stable) public CfnEndpointProps.Builder gcpMySqlSettings(CfnEndpoint.GcpMySQLSettingsProperty gcpMySqlSettings)
CfnEndpointProps.getGcpMySqlSettings()gcpMySqlSettings - Settings in JSON format for the source GCP MySQL endpoint.
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 .this@Stability(value=Stable) public CfnEndpointProps.Builder gcpMySqlSettings(IResolvable gcpMySqlSettings)
CfnEndpointProps.getGcpMySqlSettings()gcpMySqlSettings - Settings in JSON format for the source GCP MySQL endpoint.
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 .this@Stability(value=Stable) public CfnEndpointProps.Builder ibmDb2Settings(CfnEndpoint.IbmDb2SettingsProperty ibmDb2Settings)
CfnEndpointProps.getIbmDb2Settings()ibmDb2Settings - Settings in JSON format for the source IBM Db2 LUW endpoint.
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 .this@Stability(value=Stable) public CfnEndpointProps.Builder ibmDb2Settings(IResolvable ibmDb2Settings)
CfnEndpointProps.getIbmDb2Settings()ibmDb2Settings - Settings in JSON format for the source IBM Db2 LUW endpoint.
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 .this@Stability(value=Stable) public CfnEndpointProps.Builder kafkaSettings(CfnEndpoint.KafkaSettingsProperty kafkaSettings)
CfnEndpointProps.getKafkaSettings()kafkaSettings - Settings in JSON format for the target Apache Kafka endpoint.
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 .this@Stability(value=Stable) public CfnEndpointProps.Builder kafkaSettings(IResolvable kafkaSettings)
CfnEndpointProps.getKafkaSettings()kafkaSettings - Settings in JSON format for the target Apache Kafka endpoint.
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 .this@Stability(value=Stable) public CfnEndpointProps.Builder kinesisSettings(CfnEndpoint.KinesisSettingsProperty kinesisSettings)
CfnEndpointProps.getKinesisSettings()kinesisSettings - Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams.
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 .this@Stability(value=Stable) public CfnEndpointProps.Builder kinesisSettings(IResolvable kinesisSettings)
CfnEndpointProps.getKinesisSettings()kinesisSettings - Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams.
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 .this@Stability(value=Stable) public CfnEndpointProps.Builder kmsKeyId(String kmsKeyId)
CfnEndpointProps.getKmsKeyId()kmsKeyId - An AWS KMS key identifier that is used to encrypt the connection parameters for the endpoint.
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 .
this@Stability(value=Stable) public CfnEndpointProps.Builder microsoftSqlServerSettings(CfnEndpoint.MicrosoftSqlServerSettingsProperty microsoftSqlServerSettings)
CfnEndpointProps.getMicrosoftSqlServerSettings()microsoftSqlServerSettings - Settings in JSON format for the source and target Microsoft SQL Server endpoint.
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 .this@Stability(value=Stable) public CfnEndpointProps.Builder microsoftSqlServerSettings(IResolvable microsoftSqlServerSettings)
CfnEndpointProps.getMicrosoftSqlServerSettings()microsoftSqlServerSettings - Settings in JSON format for the source and target Microsoft SQL Server endpoint.
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 .this@Stability(value=Stable) public CfnEndpointProps.Builder mongoDbSettings(CfnEndpoint.MongoDbSettingsProperty mongoDbSettings)
CfnEndpointProps.getMongoDbSettings()mongoDbSettings - Settings in JSON format for the source MongoDB endpoint.
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 .this@Stability(value=Stable) public CfnEndpointProps.Builder mongoDbSettings(IResolvable mongoDbSettings)
CfnEndpointProps.getMongoDbSettings()mongoDbSettings - Settings in JSON format for the source MongoDB endpoint.
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 .this@Stability(value=Stable) public CfnEndpointProps.Builder mySqlSettings(CfnEndpoint.MySqlSettingsProperty mySqlSettings)
CfnEndpointProps.getMySqlSettings()mySqlSettings - Settings in JSON format for the source and target MySQL endpoint.
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 .this@Stability(value=Stable) public CfnEndpointProps.Builder mySqlSettings(IResolvable mySqlSettings)
CfnEndpointProps.getMySqlSettings()mySqlSettings - Settings in JSON format for the source and target MySQL endpoint.
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 .this@Stability(value=Stable) public CfnEndpointProps.Builder neptuneSettings(CfnEndpoint.NeptuneSettingsProperty neptuneSettings)
CfnEndpointProps.getNeptuneSettings()neptuneSettings - Settings in JSON format for the target Amazon Neptune endpoint.
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 .this@Stability(value=Stable) public CfnEndpointProps.Builder neptuneSettings(IResolvable neptuneSettings)
CfnEndpointProps.getNeptuneSettings()neptuneSettings - Settings in JSON format for the target Amazon Neptune endpoint.
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 .this@Stability(value=Stable) public CfnEndpointProps.Builder oracleSettings(CfnEndpoint.OracleSettingsProperty oracleSettings)
CfnEndpointProps.getOracleSettings()oracleSettings - Settings in JSON format for the source and target Oracle endpoint.
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 .this@Stability(value=Stable) public CfnEndpointProps.Builder oracleSettings(IResolvable oracleSettings)
CfnEndpointProps.getOracleSettings()oracleSettings - Settings in JSON format for the source and target Oracle endpoint.
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 .this@Stability(value=Stable) public CfnEndpointProps.Builder password(String password)
CfnEndpointProps.getPassword()password - The password to be used to log in to the endpoint database.this@Stability(value=Stable) public CfnEndpointProps.Builder port(Number port)
CfnEndpointProps.getPort()port - The port used by the endpoint database.this@Stability(value=Stable) public CfnEndpointProps.Builder postgreSqlSettings(CfnEndpoint.PostgreSqlSettingsProperty postgreSqlSettings)
CfnEndpointProps.getPostgreSqlSettings()postgreSqlSettings - Settings in JSON format for the source and target PostgreSQL endpoint.
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 .this@Stability(value=Stable) public CfnEndpointProps.Builder postgreSqlSettings(IResolvable postgreSqlSettings)
CfnEndpointProps.getPostgreSqlSettings()postgreSqlSettings - Settings in JSON format for the source and target PostgreSQL endpoint.
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 .this@Stability(value=Stable) public CfnEndpointProps.Builder redisSettings(CfnEndpoint.RedisSettingsProperty redisSettings)
CfnEndpointProps.getRedisSettings()redisSettings - Settings in JSON format for the target Redis endpoint.
For information about other available settings, see Specifying endpoint settings for Redis as a target in the AWS Database Migration Service User Guide .this@Stability(value=Stable) public CfnEndpointProps.Builder redisSettings(IResolvable redisSettings)
CfnEndpointProps.getRedisSettings()redisSettings - Settings in JSON format for the target Redis endpoint.
For information about other available settings, see Specifying endpoint settings for Redis as a target in the AWS Database Migration Service User Guide .this@Stability(value=Stable) public CfnEndpointProps.Builder redshiftSettings(CfnEndpoint.RedshiftSettingsProperty redshiftSettings)
CfnEndpointProps.getRedshiftSettings()redshiftSettings - Settings in JSON format for the Amazon Redshift endpoint.
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 .this@Stability(value=Stable) public CfnEndpointProps.Builder redshiftSettings(IResolvable redshiftSettings)
CfnEndpointProps.getRedshiftSettings()redshiftSettings - Settings in JSON format for the Amazon Redshift endpoint.
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 .this@Stability(value=Stable) public CfnEndpointProps.Builder resourceIdentifier(String resourceIdentifier)
CfnEndpointProps.getResourceIdentifier()resourceIdentifier - A display name for the resource identifier at the end of the `EndpointArn` response parameter that is returned in the created `Endpoint` object.
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 .
this@Stability(value=Stable) public CfnEndpointProps.Builder s3Settings(CfnEndpoint.S3SettingsProperty s3Settings)
CfnEndpointProps.getS3Settings()s3Settings - Settings in JSON format for the source and target Amazon S3 endpoint.
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 .this@Stability(value=Stable) public CfnEndpointProps.Builder s3Settings(IResolvable s3Settings)
CfnEndpointProps.getS3Settings()s3Settings - Settings in JSON format for the source and target Amazon S3 endpoint.
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 .this@Stability(value=Stable) public CfnEndpointProps.Builder serverName(String serverName)
CfnEndpointProps.getServerName()serverName - The name of the server where the endpoint database resides.this@Stability(value=Stable) public CfnEndpointProps.Builder sslMode(String sslMode)
CfnEndpointProps.getSslMode()sslMode - The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is `none` .
When
engine_nameis set to S3, the only allowed value isnone.
this@Stability(value=Stable) public CfnEndpointProps.Builder sybaseSettings(CfnEndpoint.SybaseSettingsProperty sybaseSettings)
CfnEndpointProps.getSybaseSettings()sybaseSettings - Settings in JSON format for the source and target SAP ASE endpoint.
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 .this@Stability(value=Stable) public CfnEndpointProps.Builder sybaseSettings(IResolvable sybaseSettings)
CfnEndpointProps.getSybaseSettings()sybaseSettings - Settings in JSON format for the source and target SAP ASE endpoint.
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 .this@Stability(value=Stable) public CfnEndpointProps.Builder tags(List<? extends CfnTag> tags)
CfnEndpointProps.getTags()tags - One or more tags to be assigned to the endpoint.this@Stability(value=Stable) public CfnEndpointProps.Builder username(String username)
CfnEndpointProps.getUsername()username - The user name to be used to log in to the endpoint database.this@Stability(value=Stable) public CfnEndpointProps build()
build in interface software.amazon.jsii.Builder<CfnEndpointProps>CfnEndpointPropsNullPointerException - if any required attribute was not providedCopyright © 2022. All rights reserved.