aws_sdk_databasemigration/client/
modify_endpoint.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ModifyEndpoint`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`endpoint_arn(impl Into<String>)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::endpoint_arn) / [`set_endpoint_arn(Option<String>)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::set_endpoint_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.</p><br>
    ///   - [`endpoint_identifier(impl Into<String>)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::endpoint_identifier) / [`set_endpoint_identifier(Option<String>)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::set_endpoint_identifier):<br>required: **false**<br><p>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.</p><br>
    ///   - [`endpoint_type(ReplicationEndpointTypeValue)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::endpoint_type) / [`set_endpoint_type(Option<ReplicationEndpointTypeValue>)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::set_endpoint_type):<br>required: **false**<br><p>The type of endpoint. Valid values are <code>source</code> and <code>target</code>.</p><br>
    ///   - [`engine_name(impl Into<String>)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::engine_name) / [`set_engine_name(Option<String>)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::set_engine_name):<br>required: **false**<br><p>The database engine name. Valid values, depending on the EndpointType, include <code>"mysql"</code>, <code>"oracle"</code>, <code>"postgres"</code>, <code>"mariadb"</code>, <code>"aurora"</code>, <code>"aurora-postgresql"</code>, <code>"redshift"</code>, <code>"s3"</code>, <code>"db2"</code>, <code>"db2-zos"</code>, <code>"azuredb"</code>, <code>"sybase"</code>, <code>"dynamodb"</code>, <code>"mongodb"</code>, <code>"kinesis"</code>, <code>"kafka"</code>, <code>"elasticsearch"</code>, <code>"documentdb"</code>, <code>"sqlserver"</code>, <code>"neptune"</code>, and <code>"babelfish"</code>.</p><br>
    ///   - [`username(impl Into<String>)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::username) / [`set_username(Option<String>)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::set_username):<br>required: **false**<br><p>The user name to be used to login to the endpoint database.</p><br>
    ///   - [`password(impl Into<String>)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::password) / [`set_password(Option<String>)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::set_password):<br>required: **false**<br><p>The password to be used to login to the endpoint database.</p><br>
    ///   - [`server_name(impl Into<String>)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::server_name) / [`set_server_name(Option<String>)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::set_server_name):<br>required: **false**<br><p>The name of the server where the endpoint database resides.</p><br>
    ///   - [`port(i32)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::port) / [`set_port(Option<i32>)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::set_port):<br>required: **false**<br><p>The port used by the endpoint database.</p><br>
    ///   - [`database_name(impl Into<String>)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::database_name) / [`set_database_name(Option<String>)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::set_database_name):<br>required: **false**<br><p>The name of the endpoint database. For a MySQL source or target endpoint, do not specify DatabaseName.</p><br>
    ///   - [`extra_connection_attributes(impl Into<String>)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::extra_connection_attributes) / [`set_extra_connection_attributes(Option<String>)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::set_extra_connection_attributes):<br>required: **false**<br><p>Additional attributes associated with the connection. To reset this parameter, pass the empty string ("") as an argument.</p><br>
    ///   - [`certificate_arn(impl Into<String>)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::certificate_arn) / [`set_certificate_arn(Option<String>)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::set_certificate_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of the certificate used for SSL connection.</p><br>
    ///   - [`ssl_mode(DmsSslModeValue)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::ssl_mode) / [`set_ssl_mode(Option<DmsSslModeValue>)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::set_ssl_mode):<br>required: **false**<br><p>The SSL mode used to connect to the endpoint. The default value is <code>none</code>.</p><br>
    ///   - [`service_access_role_arn(impl Into<String>)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::service_access_role_arn) / [`set_service_access_role_arn(Option<String>)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::set_service_access_role_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) for the IAM role you want to use to modify the endpoint. The role must allow the <code>iam:PassRole</code> action.</p><br>
    ///   - [`external_table_definition(impl Into<String>)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::external_table_definition) / [`set_external_table_definition(Option<String>)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::set_external_table_definition):<br>required: **false**<br><p>The external table definition.</p><br>
    ///   - [`dynamo_db_settings(DynamoDbSettings)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::dynamo_db_settings) / [`set_dynamo_db_settings(Option<DynamoDbSettings>)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::set_dynamo_db_settings):<br>required: **false**<br><p>Settings in JSON format for the target Amazon DynamoDB endpoint. For information about other available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DynamoDB.html#CHAP_Target.DynamoDB.ObjectMapping">Using Object Mapping to Migrate Data to DynamoDB</a> in the <i>Database Migration Service User Guide.</i></p><br>
    ///   - [`s3_settings(S3Settings)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::s3_settings) / [`set_s3_settings(Option<S3Settings>)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::set_s3_settings):<br>required: **false**<br><p>Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring">Extra Connection Attributes When Using Amazon S3 as a Target for DMS</a> in the <i>Database Migration Service User Guide.</i></p><br>
    ///   - [`dms_transfer_settings(DmsTransferSettings)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::dms_transfer_settings) / [`set_dms_transfer_settings(Option<DmsTransferSettings>)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::set_dms_transfer_settings):<br>required: **false**<br><p>The settings in JSON format for the DMS transfer type of source endpoint.</p> <p>Attributes include the following:</p> <ul>  <li>   <p>serviceAccessRoleArn - The Amazon Resource Name (ARN) used by the service access IAM role. The role must allow the <code>iam:PassRole</code> action.</p></li>  <li>   <p>BucketName - The name of the S3 bucket to use.</p></li> </ul> <p>Shorthand syntax for these settings is as follows: <code>ServiceAccessRoleArn=string ,BucketName=string</code></p> <p>JSON syntax for these settings is as follows: <code>{ "ServiceAccessRoleArn": "string", "BucketName": "string"} </code></p><br>
    ///   - [`mongo_db_settings(MongoDbSettings)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::mongo_db_settings) / [`set_mongo_db_settings(Option<MongoDbSettings>)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::set_mongo_db_settings):<br>required: **false**<br><p>Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the configuration properties section in <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MongoDB.html#CHAP_Source.MongoDB.Configuration">Endpoint configuration settings when using MongoDB as a source for Database Migration Service</a> in the <i>Database Migration Service User Guide.</i></p><br>
    ///   - [`kinesis_settings(KinesisSettings)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::kinesis_settings) / [`set_kinesis_settings(Option<KinesisSettings>)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::set_kinesis_settings):<br>required: **false**<br><p>Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about the available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html#CHAP_Target.Kinesis.ObjectMapping">Using object mapping to migrate data to a Kinesis data stream</a> in the <i>Database Migration Service User Guide.</i></p><br>
    ///   - [`kafka_settings(KafkaSettings)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::kafka_settings) / [`set_kafka_settings(Option<KafkaSettings>)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::set_kafka_settings):<br>required: **false**<br><p>Settings in JSON format for the target Apache Kafka endpoint. For more information about the available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html#CHAP_Target.Kafka.ObjectMapping">Using object mapping to migrate data to a Kafka topic</a> in the <i>Database Migration Service User Guide.</i></p><br>
    ///   - [`elasticsearch_settings(ElasticsearchSettings)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::elasticsearch_settings) / [`set_elasticsearch_settings(Option<ElasticsearchSettings>)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::set_elasticsearch_settings):<br>required: **false**<br><p>Settings in JSON format for the target OpenSearch endpoint. For more information about the available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Elasticsearch.html#CHAP_Target.Elasticsearch.Configuration">Extra Connection Attributes When Using OpenSearch as a Target for DMS</a> in the <i>Database Migration Service User Guide.</i></p><br>
    ///   - [`neptune_settings(NeptuneSettings)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::neptune_settings) / [`set_neptune_settings(Option<NeptuneSettings>)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::set_neptune_settings):<br>required: **false**<br><p>Settings in JSON format for the target Amazon Neptune endpoint. For more information about the available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.EndpointSettings">Specifying graph-mapping rules using Gremlin and R2RML for Amazon Neptune as a target</a> in the <i>Database Migration Service User Guide.</i></p><br>
    ///   - [`redshift_settings(RedshiftSettings)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::redshift_settings) / [`set_redshift_settings(Option<RedshiftSettings>)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::set_redshift_settings):<br>required: **false**<br><p>Provides information that defines an Amazon Redshift endpoint.</p><br>
    ///   - [`postgre_sql_settings(PostgreSqlSettings)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::postgre_sql_settings) / [`set_postgre_sql_settings(Option<PostgreSqlSettings>)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::set_postgre_sql_settings):<br>required: **false**<br><p>Settings in JSON format for the source and target PostgreSQL endpoint. For information about other available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html#CHAP_Source.PostgreSQL.ConnectionAttrib">Extra connection attributes when using PostgreSQL as a source for DMS</a> and <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.PostgreSQL.html#CHAP_Target.PostgreSQL.ConnectionAttrib"> Extra connection attributes when using PostgreSQL as a target for DMS</a> in the <i>Database Migration Service User Guide.</i></p><br>
    ///   - [`my_sql_settings(MySqlSettings)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::my_sql_settings) / [`set_my_sql_settings(Option<MySqlSettings>)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::set_my_sql_settings):<br>required: **false**<br><p>Settings in JSON format for the source and target MySQL endpoint. For information about other available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MySQL.html#CHAP_Source.MySQL.ConnectionAttrib">Extra connection attributes when using MySQL as a source for DMS</a> and <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.MySQL.html#CHAP_Target.MySQL.ConnectionAttrib">Extra connection attributes when using a MySQL-compatible database as a target for DMS</a> in the <i>Database Migration Service User Guide.</i></p><br>
    ///   - [`oracle_settings(OracleSettings)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::oracle_settings) / [`set_oracle_settings(Option<OracleSettings>)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::set_oracle_settings):<br>required: **false**<br><p>Settings in JSON format for the source and target Oracle endpoint. For information about other available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.ConnectionAttrib">Extra connection attributes when using Oracle as a source for DMS</a> and <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Oracle.html#CHAP_Target.Oracle.ConnectionAttrib"> Extra connection attributes when using Oracle as a target for DMS</a> in the <i>Database Migration Service User Guide.</i></p><br>
    ///   - [`sybase_settings(SybaseSettings)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::sybase_settings) / [`set_sybase_settings(Option<SybaseSettings>)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::set_sybase_settings):<br>required: **false**<br><p>Settings in JSON format for the source and target SAP ASE endpoint. For information about other available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SAP.html#CHAP_Source.SAP.ConnectionAttrib">Extra connection attributes when using SAP ASE as a source for DMS</a> and <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SAP.html#CHAP_Target.SAP.ConnectionAttrib">Extra connection attributes when using SAP ASE as a target for DMS</a> in the <i>Database Migration Service User Guide.</i></p><br>
    ///   - [`microsoft_sql_server_settings(MicrosoftSqlServerSettings)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::microsoft_sql_server_settings) / [`set_microsoft_sql_server_settings(Option<MicrosoftSqlServerSettings>)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::set_microsoft_sql_server_settings):<br>required: **false**<br><p>Settings in JSON format for the source and target Microsoft SQL Server endpoint. For information about other available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SQLServer.html#CHAP_Source.SQLServer.ConnectionAttrib">Extra connection attributes when using SQL Server as a source for DMS</a> and <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SQLServer.html#CHAP_Target.SQLServer.ConnectionAttrib"> Extra connection attributes when using SQL Server as a target for DMS</a> in the <i>Database Migration Service User Guide.</i></p><br>
    ///   - [`ibm_db2_settings(IbmDb2Settings)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::ibm_db2_settings) / [`set_ibm_db2_settings(Option<IbmDb2Settings>)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::set_ibm_db2_settings):<br>required: **false**<br><p>Settings in JSON format for the source IBM Db2 LUW endpoint. For information about other available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DB2.html#CHAP_Source.DB2.ConnectionAttrib">Extra connection attributes when using Db2 LUW as a source for DMS</a> in the <i>Database Migration Service User Guide.</i></p><br>
    ///   - [`doc_db_settings(DocDbSettings)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::doc_db_settings) / [`set_doc_db_settings(Option<DocDbSettings>)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::set_doc_db_settings):<br>required: **false**<br><p>Settings in JSON format for the source DocumentDB endpoint. For more information about the available settings, see the configuration properties section in <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DocumentDB.html"> Using DocumentDB as a Target for Database Migration Service </a> in the <i>Database Migration Service User Guide.</i></p><br>
    ///   - [`redis_settings(RedisSettings)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::redis_settings) / [`set_redis_settings(Option<RedisSettings>)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::set_redis_settings):<br>required: **false**<br><p>Settings in JSON format for the Redis target endpoint.</p><br>
    ///   - [`exact_settings(bool)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::exact_settings) / [`set_exact_settings(Option<bool>)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::set_exact_settings):<br>required: **false**<br><p>If this attribute is Y, the current call to <code>ModifyEndpoint</code> replaces all existing endpoint settings with the exact settings that you specify in this call. If this attribute is N, the current call to <code>ModifyEndpoint</code> does two things:</p> <ul>  <li>   <p>It replaces any endpoint settings that already exist with new values, for settings with the same names.</p></li>  <li>   <p>It creates new endpoint settings that you specify in the call, for settings with different names.</p></li> </ul> <p>For example, if you call <code>create-endpoint ... --endpoint-settings '{"a":1}' ...</code>, the endpoint has the following endpoint settings: <code>'{"a":1}'</code>. If you then call <code>modify-endpoint ... --endpoint-settings '{"b":2}' ...</code> for the same endpoint, the endpoint has the following settings: <code>'{"a":1,"b":2}'</code>.</p> <p>However, suppose that you follow this with a call to <code>modify-endpoint ... --endpoint-settings '{"b":2}' --exact-settings ...</code> for that same endpoint again. Then the endpoint has the following settings: <code>'{"b":2}'</code>. All existing settings are replaced with the exact settings that you specify.</p><br>
    ///   - [`gcp_my_sql_settings(GcpMySqlSettings)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::gcp_my_sql_settings) / [`set_gcp_my_sql_settings(Option<GcpMySqlSettings>)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::set_gcp_my_sql_settings):<br>required: **false**<br><p>Settings in JSON format for the source GCP MySQL endpoint.</p><br>
    ///   - [`timestream_settings(TimestreamSettings)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::timestream_settings) / [`set_timestream_settings(Option<TimestreamSettings>)`](crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::set_timestream_settings):<br>required: **false**<br><p>Settings in JSON format for the target Amazon Timestream endpoint.</p><br>
    /// - On success, responds with [`ModifyEndpointOutput`](crate::operation::modify_endpoint::ModifyEndpointOutput) with field(s):
    ///   - [`endpoint(Option<Endpoint>)`](crate::operation::modify_endpoint::ModifyEndpointOutput::endpoint): <p>The modified endpoint.</p>
    /// - On failure, responds with [`SdkError<ModifyEndpointError>`](crate::operation::modify_endpoint::ModifyEndpointError)
    pub fn modify_endpoint(&self) -> crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder {
        crate::operation::modify_endpoint::builders::ModifyEndpointFluentBuilder::new(self.handle.clone())
    }
}