Struct aws_sdk_databasemigration::input::ModifyEndpointInput

#[non_exhaustive]
pub struct ModifyEndpointInput {

    pub endpoint_arn: Option<String>,
    pub endpoint_identifier: Option<String>,
    pub endpoint_type: Option<ReplicationEndpointTypeValue>,
    pub engine_name: Option<String>,
    pub username: Option<String>,
    pub password: Option<String>,
    pub server_name: Option<String>,
    pub port: Option<i32>,
    pub database_name: Option<String>,
    pub extra_connection_attributes: Option<String>,
    pub certificate_arn: Option<String>,
    pub ssl_mode: Option<DmsSslModeValue>,
    pub service_access_role_arn: Option<String>,
    pub external_table_definition: Option<String>,
    pub dynamo_db_settings: Option<DynamoDbSettings>,
    pub s3_settings: Option<S3Settings>,
    pub dms_transfer_settings: Option<DmsTransferSettings>,
    pub mongo_db_settings: Option<MongoDbSettings>,
    pub kinesis_settings: Option<KinesisSettings>,
    pub kafka_settings: Option<KafkaSettings>,
    pub elasticsearch_settings: Option<ElasticsearchSettings>,
    pub neptune_settings: Option<NeptuneSettings>,
    pub redshift_settings: Option<RedshiftSettings>,
    pub postgre_sql_settings: Option<PostgreSqlSettings>,
    pub my_sql_settings: Option<MySqlSettings>,
    pub oracle_settings: Option<OracleSettings>,
    pub sybase_settings: Option<SybaseSettings>,
    pub microsoft_sql_server_settings: Option<MicrosoftSqlServerSettings>,
    pub ibm_db2_settings: Option<IbmDb2Settings>,
    pub doc_db_settings: Option<DocDbSettings>,
    pub redis_settings: Option<RedisSettings>,
    pub exact_settings: Option<bool>,
    pub gcp_my_sql_settings: Option<GcpMySqlSettings>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

endpoint_arn: Option<String>

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

endpoint_identifier: Option<String>

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.

endpoint_type: Option<ReplicationEndpointTypeValue>

The type of endpoint. Valid values are source and target.

engine_name: Option<String>

The type of engine for the endpoint. Valid values, depending on the EndpointType, include "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", "opensearch", "redshift", "s3", "db2", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "documentdb", "sqlserver", and "neptune".

username: Option<String>

The user name to be used to login to the endpoint database.

password: Option<String>

The password to be used to login to the endpoint database.

server_name: Option<String>

The name of the server where the endpoint database resides.

port: Option<i32>

The port used by the endpoint database.

database_name: Option<String>

The name of the endpoint database. For a MySQL source or target endpoint, do not specify DatabaseName.

extra_connection_attributes: Option<String>

Additional attributes associated with the connection. To reset this parameter, pass the empty string ("") as an argument.

certificate_arn: Option<String>

The Amazon Resource Name (ARN) of the certificate used for SSL connection.

ssl_mode: Option<DmsSslModeValue>

The SSL mode used to connect to the endpoint. The default value is none.

service_access_role_arn: Option<String>

The Amazon Resource Name (ARN) for the IAM role you want to use to modify the endpoint. The role must allow the iam:PassRole action.

external_table_definition: Option<String>

The external table definition.

dynamo_db_settings: Option<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 Database Migration Service User Guide.

s3_settings: Option<S3Settings>

Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see Extra Connection Attributes When Using Amazon S3 as a Target for DMS in the Database Migration Service User Guide.

dms_transfer_settings: Option<DmsTransferSettings>

The settings in JSON format for the DMS transfer type of source endpoint.

Attributes include the following:

• serviceAccessRoleArn - The Amazon Resource Name (ARN) used by the service access IAM role. The role must allow the iam:PassRole action.

• BucketName - The name of the S3 bucket to use.

Shorthand syntax for these settings is as follows: ServiceAccessRoleArn=string ,BucketName=string

JSON syntax for these settings is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string"}

mongo_db_settings: Option<MongoDbSettings>

Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the configuration properties section in Endpoint configuration settings when using MongoDB as a source for Database Migration Service in the Database Migration Service User Guide.

kinesis_settings: Option<KinesisSettings>

Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about the available settings, see Using object mapping to migrate data to a Kinesis data stream in the Database Migration Service User Guide.

kafka_settings: Option<KafkaSettings>

Settings in JSON format for the target Apache Kafka endpoint. For more information about the available settings, see Using object mapping to migrate data to a Kafka topic in the Database Migration Service User Guide.

elasticsearch_settings: Option<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 DMS in the Database Migration Service User Guide.

neptune_settings: Option<NeptuneSettings>

Settings in JSON format for the target Amazon Neptune endpoint. For more information about the available settings, see Specifying graph-mapping rules using Gremlin and R2RML for Amazon Neptune as a target in the Database Migration Service User Guide.

redshift_settings: Option<RedshiftSettings>

Provides information that defines an Amazon Redshift endpoint.

postgre_sql_settings: Option<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 DMS and Extra connection attributes when using PostgreSQL as a target for DMS in the Database Migration Service User Guide.

my_sql_settings: Option<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 DMS and Extra connection attributes when using a MySQL-compatible database as a target for DMS in the Database Migration Service User Guide.

oracle_settings: Option<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 DMS and Extra connection attributes when using Oracle as a target for DMS in the Database Migration Service User Guide.

sybase_settings: Option<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 DMS and Extra connection attributes when using SAP ASE as a target for DMS in the Database Migration Service User Guide.

microsoft_sql_server_settings: Option<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 DMS and Extra connection attributes when using SQL Server as a target for DMS in the Database Migration Service User Guide.

ibm_db2_settings: Option<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 DMS in the Database Migration Service User Guide.

doc_db_settings: Option<DocDbSettings>

Settings in JSON format for the source DocumentDB endpoint. For more information about the available settings, see the configuration properties section in Using DocumentDB as a Target for Database Migration Service in the Database Migration Service User Guide.

redis_settings: Option<RedisSettings>

Settings in JSON format for the Redis target endpoint.

exact_settings: Option<bool>

If this attribute is Y, the current call to ModifyEndpoint replaces all existing endpoint settings with the exact settings that you specify in this call. If this attribute is N, the current call to ModifyEndpoint does two things:

• It replaces any endpoint settings that already exist with new values, for settings with the same names.

• It creates new endpoint settings that you specify in the call, for settings with different names.

For example, if you call create-endpoint ... --endpoint-settings '{"a":1}' ..., the endpoint has the following endpoint settings: '{"a":1}'. If you then call modify-endpoint ... --endpoint-settings '{"b":2}' ... for the same endpoint, the endpoint has the following settings: '{"a":1,"b":2}'.

However, suppose that you follow this with a call to modify-endpoint ... --endpoint-settings '{"b":2}' --exact-settings ... for that same endpoint again. Then the endpoint has the following settings: '{"b":2}'. All existing settings are replaced with the exact settings that you specify.

gcp_my_sql_settings: Option<GcpMySqlSettings>

Settings in JSON format for the source GCP MySQL endpoint.

Implementations

impl ModifyEndpointInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<ModifyEndpoint, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<ModifyEndpoint>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture ModifyEndpointInput

impl ModifyEndpointInput

pub fn endpoint_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

pub fn endpoint_identifier(&self) -> Option<&str>

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.

pub fn endpoint_type(&self) -> Option<&ReplicationEndpointTypeValue>

The type of endpoint. Valid values are source and target.

pub fn engine_name(&self) -> Option<&str>

The type of engine for the endpoint. Valid values, depending on the EndpointType, include "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", "opensearch", "redshift", "s3", "db2", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "documentdb", "sqlserver", and "neptune".

pub fn username(&self) -> Option<&str>

The user name to be used to login to the endpoint database.

pub fn password(&self) -> Option<&str>

The password to be used to login to the endpoint database.

pub fn server_name(&self) -> Option<&str>

The name of the server where the endpoint database resides.

pub fn port(&self) -> Option<i32>

The port used by the endpoint database.

pub fn database_name(&self) -> Option<&str>

The name of the endpoint database. For a MySQL source or target endpoint, do not specify DatabaseName.

pub fn extra_connection_attributes(&self) -> Option<&str>

Additional attributes associated with the connection. To reset this parameter, pass the empty string ("") as an argument.

pub fn certificate_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of the certificate used for SSL connection.

pub fn ssl_mode(&self) -> Option<&DmsSslModeValue>

The SSL mode used to connect to the endpoint. The default value is none.

pub fn service_access_role_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) for the IAM role you want to use to modify the endpoint. The role must allow the iam:PassRole action.

pub fn external_table_definition(&self) -> Option<&str>

The external table definition.

pub fn dynamo_db_settings(&self) -> Option<&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 Database Migration Service User Guide.

pub fn s3_settings(&self) -> Option<&S3Settings>

Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see Extra Connection Attributes When Using Amazon S3 as a Target for DMS in the Database Migration Service User Guide.

pub fn dms_transfer_settings(&self) -> Option<&DmsTransferSettings>

The settings in JSON format for the DMS transfer type of source endpoint.

Attributes include the following:

• serviceAccessRoleArn - The Amazon Resource Name (ARN) used by the service access IAM role. The role must allow the iam:PassRole action.

• BucketName - The name of the S3 bucket to use.

Shorthand syntax for these settings is as follows: ServiceAccessRoleArn=string ,BucketName=string

JSON syntax for these settings is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string"}

pub fn mongo_db_settings(&self) -> Option<&MongoDbSettings>

Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the configuration properties section in Endpoint configuration settings when using MongoDB as a source for Database Migration Service in the Database Migration Service User Guide.

pub fn kinesis_settings(&self) -> Option<&KinesisSettings>

Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about the available settings, see Using object mapping to migrate data to a Kinesis data stream in the Database Migration Service User Guide.

pub fn kafka_settings(&self) -> Option<&KafkaSettings>

Settings in JSON format for the target Apache Kafka endpoint. For more information about the available settings, see Using object mapping to migrate data to a Kafka topic in the Database Migration Service User Guide.

pub fn elasticsearch_settings(&self) -> Option<&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 DMS in the Database Migration Service User Guide.

pub fn neptune_settings(&self) -> Option<&NeptuneSettings>

Settings in JSON format for the target Amazon Neptune endpoint. For more information about the available settings, see Specifying graph-mapping rules using Gremlin and R2RML for Amazon Neptune as a target in the Database Migration Service User Guide.

pub fn redshift_settings(&self) -> Option<&RedshiftSettings>

Provides information that defines an Amazon Redshift endpoint.

pub fn postgre_sql_settings(&self) -> Option<&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 DMS and Extra connection attributes when using PostgreSQL as a target for DMS in the Database Migration Service User Guide.

pub fn my_sql_settings(&self) -> Option<&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 DMS and Extra connection attributes when using a MySQL-compatible database as a target for DMS in the Database Migration Service User Guide.

pub fn oracle_settings(&self) -> Option<&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 DMS and Extra connection attributes when using Oracle as a target for DMS in the Database Migration Service User Guide.

pub fn sybase_settings(&self) -> Option<&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 DMS and Extra connection attributes when using SAP ASE as a target for DMS in the Database Migration Service User Guide.

pub fn microsoft_sql_server_settings(
    &self
) -> Option<&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 DMS and Extra connection attributes when using SQL Server as a target for DMS in the Database Migration Service User Guide.

pub fn ibm_db2_settings(&self) -> Option<&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 DMS in the Database Migration Service User Guide.

pub fn doc_db_settings(&self) -> Option<&DocDbSettings>

Settings in JSON format for the source DocumentDB endpoint. For more information about the available settings, see the configuration properties section in Using DocumentDB as a Target for Database Migration Service in the Database Migration Service User Guide.

pub fn redis_settings(&self) -> Option<&RedisSettings>

Settings in JSON format for the Redis target endpoint.

pub fn exact_settings(&self) -> Option<bool>

If this attribute is Y, the current call to ModifyEndpoint replaces all existing endpoint settings with the exact settings that you specify in this call. If this attribute is N, the current call to ModifyEndpoint does two things:

• It replaces any endpoint settings that already exist with new values, for settings with the same names.

• It creates new endpoint settings that you specify in the call, for settings with different names.

For example, if you call create-endpoint ... --endpoint-settings '{"a":1}' ..., the endpoint has the following endpoint settings: '{"a":1}'. If you then call modify-endpoint ... --endpoint-settings '{"b":2}' ... for the same endpoint, the endpoint has the following settings: '{"a":1,"b":2}'.

However, suppose that you follow this with a call to modify-endpoint ... --endpoint-settings '{"b":2}' --exact-settings ... for that same endpoint again. Then the endpoint has the following settings: '{"b":2}'. All existing settings are replaced with the exact settings that you specify.

pub fn gcp_my_sql_settings(&self) -> Option<&GcpMySqlSettings>

Settings in JSON format for the source GCP MySQL endpoint.

Trait Implementations

impl Clone for ModifyEndpointInput

fn clone(&self) -> ModifyEndpointInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ModifyEndpointInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<ModifyEndpointInput> for ModifyEndpointInput

fn eq(&self, other: &ModifyEndpointInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ModifyEndpointInput) -> bool

This method tests for !=.

impl StructuralPartialEq for ModifyEndpointInput