logo
pub struct Endpoint {
Show 33 fields pub certificate_arn: Option<String>, pub database_name: Option<String>, pub dms_transfer_settings: Option<DmsTransferSettings>, pub doc_db_settings: Option<DocDbSettings>, pub dynamo_db_settings: Option<DynamoDbSettings>, pub elasticsearch_settings: Option<ElasticsearchSettings>, pub endpoint_arn: Option<String>, pub endpoint_identifier: Option<String>, pub endpoint_type: Option<String>, pub engine_display_name: Option<String>, pub engine_name: Option<String>, pub external_id: Option<String>, pub external_table_definition: Option<String>, pub extra_connection_attributes: Option<String>, pub ibm_db_2_settings: Option<IBMDb2Settings>, pub kafka_settings: Option<KafkaSettings>, pub kinesis_settings: Option<KinesisSettings>, pub kms_key_id: Option<String>, pub microsoft_sql_server_settings: Option<MicrosoftSQLServerSettings>, pub mongo_db_settings: Option<MongoDbSettings>, pub my_sql_settings: Option<MySQLSettings>, pub neptune_settings: Option<NeptuneSettings>, pub oracle_settings: Option<OracleSettings>, pub port: Option<i64>, pub postgre_sql_settings: Option<PostgreSQLSettings>, pub redshift_settings: Option<RedshiftSettings>, pub s3_settings: Option<S3Settings>, pub server_name: Option<String>, pub service_access_role_arn: Option<String>, pub ssl_mode: Option<String>, pub status: Option<String>, pub sybase_settings: Option<SybaseSettings>, pub username: Option<String>,
}
Expand description

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

  • CreateEndpoint

  • DescribeEndpoint

  • DescribeEndpointTypes

  • ModifyEndpoint

Fields

certificate_arn: Option<String>

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

database_name: Option<String>

The name of the database at the endpoint.

dms_transfer_settings: Option<DmsTransferSettings>

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

Possible settings include the following:

  • ServiceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket.

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

  • CompressionType - An optional parameter to use GZIP to compress the target files. To use GZIP, set this value to NONE (the default). To keep the files uncompressed, don't use this value.

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

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

doc_db_settings: Option<DocDbSettings>dynamo_db_settings: Option<DynamoDbSettings>

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

elasticsearch_settings: Option<ElasticsearchSettings>

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

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<String>

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

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."

engine_name: Option<String>

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

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.

external_table_definition: Option<String>

The external table definition.

extra_connection_attributes: Option<String>

Additional connection attributes used to connect to the endpoint.

ibm_db_2_settings: Option<IBMDb2Settings>

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

kafka_settings: Option<KafkaSettings>

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

kinesis_settings: Option<KinesisSettings>

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

kms_key_id: Option<String>

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, 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.

microsoft_sql_server_settings: Option<MicrosoftSQLServerSettings>

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

mongo_db_settings: Option<MongoDbSettings>

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

my_sql_settings: Option<MySQLSettings>

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

neptune_settings: Option<NeptuneSettings>

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

oracle_settings: Option<OracleSettings>

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

port: Option<i64>

The port value used to access the endpoint.

postgre_sql_settings: Option<PostgreSQLSettings>

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

redshift_settings: Option<RedshiftSettings>

Settings for the Amazon Redshift endpoint.

s3_settings: Option<S3Settings>

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

server_name: Option<String>

The name of the server at the endpoint.

service_access_role_arn: Option<String>

The Amazon Resource Name (ARN) used by the service access IAM role.

ssl_mode: Option<String>

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

status: Option<String>

The status of the endpoint.

sybase_settings: Option<SybaseSettings>

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

username: Option<String>

The user name used to connect to the endpoint.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Returns the “default value” for a type. Read more

Deserialize this value from the given Serde deserializer. Read more

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

This method tests for !=.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Should always be Self

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more