Endpoint
Describes an endpoint of a database instance in response to operations such as the following:
CreateEndpointDescribeEndpointModifyEndpoint
Types
Properties
The Amazon Resource Name (ARN) used for SSL connection to the endpoint.
The name of the database at the endpoint.
The settings for the DMS Transfer type source. For more information, see the DmsTransferSettings structure.
Provides information that defines a DocumentDB endpoint.
The settings for the DynamoDB target endpoint. For more information, see the DynamoDBSettings structure.
The settings for the OpenSearch source endpoint. For more information, see the ElasticsearchSettings structure.
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
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.
The type of endpoint. Valid values are source and target.
The expanded name for the engine name. For example, if the EngineName parameter is "aurora", this value would be "Amazon Aurora MySQL".
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".
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.
The external table definition.
Additional connection attributes used to connect to the endpoint.
Settings in JSON format for the source GCP MySQL endpoint.
The settings for the IBM Db2 LUW source endpoint. For more information, see the IBMDb2Settings structure.
The settings for the Apache Kafka target endpoint. For more information, see the KafkaSettings structure.
The settings for the Amazon Kinesis target endpoint. For more information, see the KinesisSettings structure.
The settings for the Microsoft SQL Server source and target endpoint. For more information, see the MicrosoftSQLServerSettings structure.
The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings structure.
The settings for the MySQL source and target endpoint. For more information, see the MySQLSettings structure.
The settings for the Amazon Neptune target endpoint. For more information, see the NeptuneSettings structure.
The settings for the Oracle source and target endpoint. For more information, see the OracleSettings structure.
The settings for the PostgreSQL source and target endpoint. For more information, see the PostgreSQLSettings structure.
The settings for the Redis target endpoint. For more information, see the RedisSettings structure.
Settings for the Amazon Redshift endpoint.
The settings for the S3 target endpoint. For more information, see the S3Settings structure.
The name of the server at the endpoint.
The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the iam:PassRole action.
The SSL mode used to connect to the endpoint. The default value is none.
The settings for the SAP ASE source and target endpoint. For more information, see the SybaseSettings structure.
The settings for the Amazon Timestream target endpoint. For more information, see the TimestreamSettings structure.