Struct aws_sdk_databasemigration::types::Endpoint

#[non_exhaustive]
pub struct Endpoint {

    pub endpoint_identifier: Option<String>,
    pub endpoint_type: Option<ReplicationEndpointTypeValue>,
    pub engine_name: Option<String>,
    pub engine_display_name: Option<String>,
    pub username: Option<String>,
    pub server_name: Option<String>,
    pub port: Option<i32>,
    pub database_name: Option<String>,
    pub extra_connection_attributes: Option<String>,
    pub status: Option<String>,
    pub kms_key_id: Option<String>,
    pub endpoint_arn: 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 external_id: 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 gcp_my_sql_settings: Option<GcpMySqlSettings>,
    pub timestream_settings: Option<TimestreamSettings>,
}

Describes an endpoint of a database instance in response to operations such as the following:

• CreateEndpoint

• DescribeEndpoint

• ModifyEndpoint

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_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 database engine name. Valid values, depending on the EndpointType, include "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", "redshift", "redshift-serverless", "s3", "db2", "db2-zos", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "documentdb", "sqlserver", "neptune", and "babelfish".

engine_display_name: Option<String>

The expanded name for the engine name. For example, if the EngineName parameter is "aurora", this value would be "Amazon Aurora MySQL".

username: Option<String>

The user name used to connect to the endpoint.

server_name: Option<String>

The name of the server at the endpoint.

port: Option<i32>

The port value used to access the endpoint.

database_name: Option<String>

The name of the database at the endpoint.

extra_connection_attributes: Option<String>

Additional connection attributes used to connect to the endpoint.

status: Option<String>

The status of the endpoint.

kms_key_id: Option<String>

An 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, then DMS uses your default encryption key.

KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.

endpoint_arn: Option<String>

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

certificate_arn: Option<String>

The Amazon Resource Name (ARN) used for SSL connection to the endpoint.

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) used by the service to access the IAM role. The role must allow the iam:PassRole action.

external_table_definition: Option<String>

The external table definition.

external_id: Option<String>

Value returned by a call to CreateEndpoint that can be used for cross-account validation. Use it on a subsequent call to CreateEndpoint to create the endpoint with a cross-account.

dynamo_db_settings: Option<DynamoDbSettings>

The settings for the DynamoDB target endpoint. For more information, see the DynamoDBSettings structure.

s3_settings: Option<S3Settings>

The settings for the S3 target endpoint. For more information, see the S3Settings structure.

dms_transfer_settings: Option<DmsTransferSettings>

The settings for the DMS Transfer type source. For more information, see the DmsTransferSettings structure.

mongo_db_settings: Option<MongoDbSettings>

The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings structure.

kinesis_settings: Option<KinesisSettings>

The settings for the Amazon Kinesis target endpoint. For more information, see the KinesisSettings structure.

kafka_settings: Option<KafkaSettings>

The settings for the Apache Kafka target endpoint. For more information, see the KafkaSettings structure.

elasticsearch_settings: Option<ElasticsearchSettings>

The settings for the OpenSearch source endpoint. For more information, see the ElasticsearchSettings structure.

neptune_settings: Option<NeptuneSettings>

The settings for the Amazon Neptune target endpoint. For more information, see the NeptuneSettings structure.

redshift_settings: Option<RedshiftSettings>

Settings for the Amazon Redshift endpoint.

postgre_sql_settings: Option<PostgreSqlSettings>

The settings for the PostgreSQL source and target endpoint. For more information, see the PostgreSQLSettings structure.

my_sql_settings: Option<MySqlSettings>

The settings for the MySQL source and target endpoint. For more information, see the MySQLSettings structure.

oracle_settings: Option<OracleSettings>

The settings for the Oracle source and target endpoint. For more information, see the OracleSettings structure.

sybase_settings: Option<SybaseSettings>

The settings for the SAP ASE source and target endpoint. For more information, see the SybaseSettings structure.

microsoft_sql_server_settings: Option<MicrosoftSqlServerSettings>

The settings for the Microsoft SQL Server source and target endpoint. For more information, see the MicrosoftSQLServerSettings structure.

ibm_db2_settings: Option<IbmDb2Settings>

The settings for the IBM Db2 LUW source endpoint. For more information, see the IBMDb2Settings structure.

doc_db_settings: Option<DocDbSettings>

Provides information that defines a DocumentDB endpoint.

redis_settings: Option<RedisSettings>

The settings for the Redis target endpoint. For more information, see the RedisSettings structure.

gcp_my_sql_settings: Option<GcpMySqlSettings>

Settings in JSON format for the source GCP MySQL endpoint.

timestream_settings: Option<TimestreamSettings>

The settings for the Amazon Timestream target endpoint. For more information, see the TimestreamSettings structure.

Implementations

impl 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 database engine name. Valid values, depending on the EndpointType, include "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", "redshift", "redshift-serverless", "s3", "db2", "db2-zos", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "documentdb", "sqlserver", "neptune", and "babelfish".

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

The expanded name for the engine name. For example, if the EngineName parameter is "aurora", this value would be "Amazon Aurora MySQL".

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

The user name used to connect to the endpoint.

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

The name of the server at the endpoint.

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

The port value used to access the endpoint.

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

The name of the database at the endpoint.

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

Additional connection attributes used to connect to the endpoint.

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

The status of the endpoint.

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

An 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, then DMS uses your default encryption key.

KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.

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

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

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

The Amazon Resource Name (ARN) used for SSL connection to the endpoint.

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) used by the service to access the IAM role. The role must allow the iam:PassRole action.

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

The external table definition.

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

Value returned by a call to CreateEndpoint that can be used for cross-account validation. Use it on a subsequent call to CreateEndpoint to create the endpoint with a cross-account.

pub fn dynamo_db_settings(&self) -> Option<&DynamoDbSettings>

The settings for the DynamoDB target endpoint. For more information, see the DynamoDBSettings structure.

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

The settings for the S3 target endpoint. For more information, see the S3Settings structure.

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

The settings for the DMS Transfer type source. For more information, see the DmsTransferSettings structure.

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

The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings structure.

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

The settings for the Amazon Kinesis target endpoint. For more information, see the KinesisSettings structure.

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

The settings for the Apache Kafka target endpoint. For more information, see the KafkaSettings structure.

pub fn elasticsearch_settings(&self) -> Option<&ElasticsearchSettings>

The settings for the OpenSearch source endpoint. For more information, see the ElasticsearchSettings structure.

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

The settings for the Amazon Neptune target endpoint. For more information, see the NeptuneSettings structure.

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

Settings for the Amazon Redshift endpoint.

pub fn postgre_sql_settings(&self) -> Option<&PostgreSqlSettings>

The settings for the PostgreSQL source and target endpoint. For more information, see the PostgreSQLSettings structure.

pub fn my_sql_settings(&self) -> Option<&MySqlSettings>

The settings for the MySQL source and target endpoint. For more information, see the MySQLSettings structure.

pub fn oracle_settings(&self) -> Option<&OracleSettings>

The settings for the Oracle source and target endpoint. For more information, see the OracleSettings structure.

pub fn sybase_settings(&self) -> Option<&SybaseSettings>

The settings for the SAP ASE source and target endpoint. For more information, see the SybaseSettings structure.

pub fn microsoft_sql_server_settings( &self, ) -> Option<&MicrosoftSqlServerSettings>

The settings for the Microsoft SQL Server source and target endpoint. For more information, see the MicrosoftSQLServerSettings structure.

pub fn ibm_db2_settings(&self) -> Option<&IbmDb2Settings>

The settings for the IBM Db2 LUW source endpoint. For more information, see the IBMDb2Settings structure.

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

Provides information that defines a DocumentDB endpoint.

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

The settings for the Redis target endpoint. For more information, see the RedisSettings structure.

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

Settings in JSON format for the source GCP MySQL endpoint.

pub fn timestream_settings(&self) -> Option<&TimestreamSettings>

The settings for the Amazon Timestream target endpoint. For more information, see the TimestreamSettings structure.

impl Endpoint

pub fn builder() -> EndpointBuilder

Creates a new builder-style object to manufacture Endpoint.

Trait Implementations

impl Clone for Endpoint

fn clone(&self) -> Endpoint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Endpoint

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

Formats the value using the given formatter.

impl PartialEq for Endpoint

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Endpoint