| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.DMS.Types.Endpoint
Description
Synopsis
- data Endpoint = Endpoint' {
- certificateArn :: Maybe Text
- databaseName :: Maybe Text
- dmsTransferSettings :: Maybe DmsTransferSettings
- docDbSettings :: Maybe DocDbSettings
- dynamoDbSettings :: Maybe DynamoDbSettings
- elasticsearchSettings :: Maybe ElasticsearchSettings
- endpointArn :: Maybe Text
- endpointIdentifier :: Maybe Text
- endpointType :: Maybe ReplicationEndpointTypeValue
- engineDisplayName :: Maybe Text
- engineName :: Maybe Text
- externalId :: Maybe Text
- externalTableDefinition :: Maybe Text
- extraConnectionAttributes :: Maybe Text
- gcpMySQLSettings :: Maybe GcpMySQLSettings
- iBMDb2Settings :: Maybe IBMDb2Settings
- kafkaSettings :: Maybe KafkaSettings
- kinesisSettings :: Maybe KinesisSettings
- kmsKeyId :: Maybe Text
- microsoftSQLServerSettings :: Maybe MicrosoftSQLServerSettings
- mongoDbSettings :: Maybe MongoDbSettings
- mySQLSettings :: Maybe MySQLSettings
- neptuneSettings :: Maybe NeptuneSettings
- oracleSettings :: Maybe OracleSettings
- port :: Maybe Int
- postgreSQLSettings :: Maybe PostgreSQLSettings
- redisSettings :: Maybe RedisSettings
- redshiftSettings :: Maybe RedshiftSettings
- s3Settings :: Maybe S3Settings
- serverName :: Maybe Text
- serviceAccessRoleArn :: Maybe Text
- sslMode :: Maybe DmsSslModeValue
- status :: Maybe Text
- sybaseSettings :: Maybe SybaseSettings
- username :: Maybe Text
- newEndpoint :: Endpoint
- endpoint_certificateArn :: Lens' Endpoint (Maybe Text)
- endpoint_databaseName :: Lens' Endpoint (Maybe Text)
- endpoint_dmsTransferSettings :: Lens' Endpoint (Maybe DmsTransferSettings)
- endpoint_docDbSettings :: Lens' Endpoint (Maybe DocDbSettings)
- endpoint_dynamoDbSettings :: Lens' Endpoint (Maybe DynamoDbSettings)
- endpoint_elasticsearchSettings :: Lens' Endpoint (Maybe ElasticsearchSettings)
- endpoint_endpointArn :: Lens' Endpoint (Maybe Text)
- endpoint_endpointIdentifier :: Lens' Endpoint (Maybe Text)
- endpoint_endpointType :: Lens' Endpoint (Maybe ReplicationEndpointTypeValue)
- endpoint_engineDisplayName :: Lens' Endpoint (Maybe Text)
- endpoint_engineName :: Lens' Endpoint (Maybe Text)
- endpoint_externalId :: Lens' Endpoint (Maybe Text)
- endpoint_externalTableDefinition :: Lens' Endpoint (Maybe Text)
- endpoint_extraConnectionAttributes :: Lens' Endpoint (Maybe Text)
- endpoint_gcpMySQLSettings :: Lens' Endpoint (Maybe GcpMySQLSettings)
- endpoint_iBMDb2Settings :: Lens' Endpoint (Maybe IBMDb2Settings)
- endpoint_kafkaSettings :: Lens' Endpoint (Maybe KafkaSettings)
- endpoint_kinesisSettings :: Lens' Endpoint (Maybe KinesisSettings)
- endpoint_kmsKeyId :: Lens' Endpoint (Maybe Text)
- endpoint_microsoftSQLServerSettings :: Lens' Endpoint (Maybe MicrosoftSQLServerSettings)
- endpoint_mongoDbSettings :: Lens' Endpoint (Maybe MongoDbSettings)
- endpoint_mySQLSettings :: Lens' Endpoint (Maybe MySQLSettings)
- endpoint_neptuneSettings :: Lens' Endpoint (Maybe NeptuneSettings)
- endpoint_oracleSettings :: Lens' Endpoint (Maybe OracleSettings)
- endpoint_port :: Lens' Endpoint (Maybe Int)
- endpoint_postgreSQLSettings :: Lens' Endpoint (Maybe PostgreSQLSettings)
- endpoint_redisSettings :: Lens' Endpoint (Maybe RedisSettings)
- endpoint_redshiftSettings :: Lens' Endpoint (Maybe RedshiftSettings)
- endpoint_s3Settings :: Lens' Endpoint (Maybe S3Settings)
- endpoint_serverName :: Lens' Endpoint (Maybe Text)
- endpoint_serviceAccessRoleArn :: Lens' Endpoint (Maybe Text)
- endpoint_sslMode :: Lens' Endpoint (Maybe DmsSslModeValue)
- endpoint_status :: Lens' Endpoint (Maybe Text)
- endpoint_sybaseSettings :: Lens' Endpoint (Maybe SybaseSettings)
- endpoint_username :: Lens' Endpoint (Maybe Text)
Documentation
Describes an endpoint of a database instance in response to operations such as the following:
CreateEndpoint
DescribeEndpoint
ModifyEndpoint
See: newEndpoint smart constructor.
Constructors
| Endpoint' | |
Fields
| |
Instances
newEndpoint :: Endpoint Source #
Create a value of Endpoint with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:certificateArn:Endpoint', endpoint_certificateArn - The Amazon Resource Name (ARN) used for SSL connection to the endpoint.
Endpoint, endpoint_databaseName - The name of the database at the endpoint.
$sel:dmsTransferSettings:Endpoint', endpoint_dmsTransferSettings - The settings for the DMS Transfer type source. For more information, see
the DmsTransferSettings structure.
$sel:docDbSettings:Endpoint', endpoint_docDbSettings - Undocumented member.
$sel:dynamoDbSettings:Endpoint', endpoint_dynamoDbSettings - The settings for the DynamoDB target endpoint. For more information, see
the DynamoDBSettings structure.
$sel:elasticsearchSettings:Endpoint', endpoint_elasticsearchSettings - The settings for the OpenSearch source endpoint. For more information,
see the ElasticsearchSettings structure.
$sel:endpointArn:Endpoint', endpoint_endpointArn - The Amazon Resource Name (ARN) string that uniquely identifies the
endpoint.
$sel:endpointIdentifier:Endpoint', endpoint_endpointIdentifier - 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.
$sel:endpointType:Endpoint', endpoint_endpointType - The type of endpoint. Valid values are source and target.
$sel:engineDisplayName:Endpoint', endpoint_engineDisplayName - The expanded name for the engine name. For example, if the EngineName
parameter is "aurora", this value would be "Amazon Aurora MySQL".
$sel:engineName:Endpoint', endpoint_engineName - The database engine name. Valid values, depending on the EndpointType,
include "mysql", "oracle", "postgres", "mariadb",
"aurora", "aurora-postgresql", "redshift", "s3",
"db2", "db2-zos", "azuredb", "sybase", "dynamodb",
"mongodb", "kinesis", "kafka", "elasticsearch",
"documentdb", "sqlserver", "neptune", and "babelfish".
$sel:externalId:Endpoint', endpoint_externalId - 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.
Endpoint, endpoint_externalTableDefinition - The external table definition.
$sel:extraConnectionAttributes:Endpoint', endpoint_extraConnectionAttributes - Additional connection attributes used to connect to the endpoint.
$sel:gcpMySQLSettings:Endpoint', endpoint_gcpMySQLSettings - Settings in JSON format for the source GCP MySQL endpoint.
$sel:iBMDb2Settings:Endpoint', endpoint_iBMDb2Settings - The settings for the IBM Db2 LUW source endpoint. For more information,
see the IBMDb2Settings structure.
$sel:kafkaSettings:Endpoint', endpoint_kafkaSettings - The settings for the Apache Kafka target endpoint. For more information,
see the KafkaSettings structure.
$sel:kinesisSettings:Endpoint', endpoint_kinesisSettings - The settings for the Amazon Kinesis target endpoint. For more
information, see the KinesisSettings structure.
Endpoint, endpoint_kmsKeyId - 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.
$sel:microsoftSQLServerSettings:Endpoint', endpoint_microsoftSQLServerSettings - The settings for the Microsoft SQL Server source and target endpoint.
For more information, see the MicrosoftSQLServerSettings structure.
$sel:mongoDbSettings:Endpoint', endpoint_mongoDbSettings - The settings for the MongoDB source endpoint. For more information, see
the MongoDbSettings structure.
$sel:mySQLSettings:Endpoint', endpoint_mySQLSettings - The settings for the MySQL source and target endpoint. For more
information, see the MySQLSettings structure.
$sel:neptuneSettings:Endpoint', endpoint_neptuneSettings - The settings for the Amazon Neptune target endpoint. For more
information, see the NeptuneSettings structure.
$sel:oracleSettings:Endpoint', endpoint_oracleSettings - The settings for the Oracle source and target endpoint. For more
information, see the OracleSettings structure.
Endpoint, endpoint_port - The port value used to access the endpoint.
$sel:postgreSQLSettings:Endpoint', endpoint_postgreSQLSettings - The settings for the PostgreSQL source and target endpoint. For more
information, see the PostgreSQLSettings structure.
$sel:redisSettings:Endpoint', endpoint_redisSettings - The settings for the Redis target endpoint. For more information, see
the RedisSettings structure.
$sel:redshiftSettings:Endpoint', endpoint_redshiftSettings - Settings for the Amazon Redshift endpoint.
$sel:s3Settings:Endpoint', endpoint_s3Settings - The settings for the S3 target endpoint. For more information, see the
S3Settings structure.
Endpoint, endpoint_serverName - The name of the server at the endpoint.
Endpoint, endpoint_serviceAccessRoleArn - The Amazon Resource Name (ARN) used by the service to access the IAM
role. The role must allow the iam:PassRole action.
$sel:sslMode:Endpoint', endpoint_sslMode - The SSL mode used to connect to the endpoint. The default value is
none.
$sel:status:Endpoint', endpoint_status - The status of the endpoint.
$sel:sybaseSettings:Endpoint', endpoint_sybaseSettings - The settings for the SAP ASE source and target endpoint. For more
information, see the SybaseSettings structure.
Endpoint, endpoint_username - The user name used to connect to the endpoint.
endpoint_certificateArn :: Lens' Endpoint (Maybe Text) Source #
The Amazon Resource Name (ARN) used for SSL connection to the endpoint.
endpoint_databaseName :: Lens' Endpoint (Maybe Text) Source #
The name of the database at the endpoint.
endpoint_dmsTransferSettings :: Lens' Endpoint (Maybe DmsTransferSettings) Source #
The settings for the DMS Transfer type source. For more information, see the DmsTransferSettings structure.
endpoint_docDbSettings :: Lens' Endpoint (Maybe DocDbSettings) Source #
Undocumented member.
endpoint_dynamoDbSettings :: Lens' Endpoint (Maybe DynamoDbSettings) Source #
The settings for the DynamoDB target endpoint. For more information, see
the DynamoDBSettings structure.
endpoint_elasticsearchSettings :: Lens' Endpoint (Maybe ElasticsearchSettings) Source #
The settings for the OpenSearch source endpoint. For more information,
see the ElasticsearchSettings structure.
endpoint_endpointArn :: Lens' Endpoint (Maybe Text) Source #
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
endpoint_endpointIdentifier :: Lens' Endpoint (Maybe Text) Source #
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_endpointType :: Lens' Endpoint (Maybe ReplicationEndpointTypeValue) Source #
The type of endpoint. Valid values are source and target.
endpoint_engineDisplayName :: Lens' Endpoint (Maybe Text) Source #
The expanded name for the engine name. For example, if the EngineName
parameter is "aurora", this value would be "Amazon Aurora MySQL".
endpoint_engineName :: Lens' Endpoint (Maybe Text) Source #
The database engine name. Valid values, depending on the EndpointType,
include "mysql", "oracle", "postgres", "mariadb",
"aurora", "aurora-postgresql", "redshift", "s3",
"db2", "db2-zos", "azuredb", "sybase", "dynamodb",
"mongodb", "kinesis", "kafka", "elasticsearch",
"documentdb", "sqlserver", "neptune", and "babelfish".
endpoint_externalId :: Lens' Endpoint (Maybe Text) Source #
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.
endpoint_externalTableDefinition :: Lens' Endpoint (Maybe Text) Source #
The external table definition.
endpoint_extraConnectionAttributes :: Lens' Endpoint (Maybe Text) Source #
Additional connection attributes used to connect to the endpoint.
endpoint_gcpMySQLSettings :: Lens' Endpoint (Maybe GcpMySQLSettings) Source #
Settings in JSON format for the source GCP MySQL endpoint.
endpoint_iBMDb2Settings :: Lens' Endpoint (Maybe IBMDb2Settings) Source #
The settings for the IBM Db2 LUW source endpoint. For more information,
see the IBMDb2Settings structure.
endpoint_kafkaSettings :: Lens' Endpoint (Maybe KafkaSettings) Source #
The settings for the Apache Kafka target endpoint. For more information,
see the KafkaSettings structure.
endpoint_kinesisSettings :: Lens' Endpoint (Maybe KinesisSettings) Source #
The settings for the Amazon Kinesis target endpoint. For more
information, see the KinesisSettings structure.
endpoint_kmsKeyId :: Lens' Endpoint (Maybe Text) Source #
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_microsoftSQLServerSettings :: Lens' Endpoint (Maybe MicrosoftSQLServerSettings) Source #
The settings for the Microsoft SQL Server source and target endpoint.
For more information, see the MicrosoftSQLServerSettings structure.
endpoint_mongoDbSettings :: Lens' Endpoint (Maybe MongoDbSettings) Source #
The settings for the MongoDB source endpoint. For more information, see
the MongoDbSettings structure.
endpoint_mySQLSettings :: Lens' Endpoint (Maybe MySQLSettings) Source #
The settings for the MySQL source and target endpoint. For more
information, see the MySQLSettings structure.
endpoint_neptuneSettings :: Lens' Endpoint (Maybe NeptuneSettings) Source #
The settings for the Amazon Neptune target endpoint. For more
information, see the NeptuneSettings structure.
endpoint_oracleSettings :: Lens' Endpoint (Maybe OracleSettings) Source #
The settings for the Oracle source and target endpoint. For more
information, see the OracleSettings structure.
endpoint_postgreSQLSettings :: Lens' Endpoint (Maybe PostgreSQLSettings) Source #
The settings for the PostgreSQL source and target endpoint. For more
information, see the PostgreSQLSettings structure.
endpoint_redisSettings :: Lens' Endpoint (Maybe RedisSettings) Source #
The settings for the Redis target endpoint. For more information, see
the RedisSettings structure.
endpoint_redshiftSettings :: Lens' Endpoint (Maybe RedshiftSettings) Source #
Settings for the Amazon Redshift endpoint.
endpoint_s3Settings :: Lens' Endpoint (Maybe S3Settings) Source #
The settings for the S3 target endpoint. For more information, see the
S3Settings structure.
endpoint_serviceAccessRoleArn :: Lens' Endpoint (Maybe Text) Source #
The Amazon Resource Name (ARN) used by the service to access the IAM
role. The role must allow the iam:PassRole action.
endpoint_sslMode :: Lens' Endpoint (Maybe DmsSslModeValue) Source #
The SSL mode used to connect to the endpoint. The default value is
none.
endpoint_sybaseSettings :: Lens' Endpoint (Maybe SybaseSettings) Source #
The settings for the SAP ASE source and target endpoint. For more
information, see the SybaseSettings structure.