Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.DMS.Types.Endpoint

Description

Synopsis

data Endpoint = Endpoint' {
- status :: Maybe Text
- dmsTransferSettings :: Maybe DmsTransferSettings
- mySQLSettings :: Maybe MySQLSettings
- serverName :: Maybe Text
- microsoftSQLServerSettings :: Maybe MicrosoftSQLServerSettings
- certificateArn :: Maybe Text
- serviceAccessRoleArn :: Maybe Text
- docDbSettings :: Maybe DocDbSettings
- engineDisplayName :: Maybe Text
- postgreSQLSettings :: Maybe PostgreSQLSettings
- extraConnectionAttributes :: Maybe Text
- kafkaSettings :: Maybe KafkaSettings
- oracleSettings :: Maybe OracleSettings
- endpointType :: Maybe ReplicationEndpointTypeValue
- redshiftSettings :: Maybe RedshiftSettings
- elasticsearchSettings :: Maybe ElasticsearchSettings
- username :: Maybe Text
- externalTableDefinition :: Maybe Text
- engineName :: Maybe Text
- redisSettings :: Maybe RedisSettings
- neptuneSettings :: Maybe NeptuneSettings
- iBMDb2Settings :: Maybe IBMDb2Settings
- kmsKeyId :: Maybe Text
- mongoDbSettings :: Maybe MongoDbSettings
- sslMode :: Maybe DmsSslModeValue
- sybaseSettings :: Maybe SybaseSettings
- databaseName :: Maybe Text
- s3Settings :: Maybe S3Settings
- kinesisSettings :: Maybe KinesisSettings
- endpointIdentifier :: Maybe Text
- externalId :: Maybe Text
- dynamoDbSettings :: Maybe DynamoDbSettings
- endpointArn :: Maybe Text
- port :: Maybe Int
}
newEndpoint :: Endpoint
endpoint_status :: Lens' Endpoint (Maybe Text)
endpoint_dmsTransferSettings :: Lens' Endpoint (Maybe DmsTransferSettings)
endpoint_mySQLSettings :: Lens' Endpoint (Maybe MySQLSettings)
endpoint_serverName :: Lens' Endpoint (Maybe Text)
endpoint_microsoftSQLServerSettings :: Lens' Endpoint (Maybe MicrosoftSQLServerSettings)
endpoint_certificateArn :: Lens' Endpoint (Maybe Text)
endpoint_serviceAccessRoleArn :: Lens' Endpoint (Maybe Text)
endpoint_docDbSettings :: Lens' Endpoint (Maybe DocDbSettings)
endpoint_engineDisplayName :: Lens' Endpoint (Maybe Text)
endpoint_postgreSQLSettings :: Lens' Endpoint (Maybe PostgreSQLSettings)
endpoint_extraConnectionAttributes :: Lens' Endpoint (Maybe Text)
endpoint_kafkaSettings :: Lens' Endpoint (Maybe KafkaSettings)
endpoint_oracleSettings :: Lens' Endpoint (Maybe OracleSettings)
endpoint_endpointType :: Lens' Endpoint (Maybe ReplicationEndpointTypeValue)
endpoint_redshiftSettings :: Lens' Endpoint (Maybe RedshiftSettings)
endpoint_elasticsearchSettings :: Lens' Endpoint (Maybe ElasticsearchSettings)
endpoint_username :: Lens' Endpoint (Maybe Text)
endpoint_externalTableDefinition :: Lens' Endpoint (Maybe Text)
endpoint_engineName :: Lens' Endpoint (Maybe Text)
endpoint_redisSettings :: Lens' Endpoint (Maybe RedisSettings)
endpoint_neptuneSettings :: Lens' Endpoint (Maybe NeptuneSettings)
endpoint_iBMDb2Settings :: Lens' Endpoint (Maybe IBMDb2Settings)
endpoint_kmsKeyId :: Lens' Endpoint (Maybe Text)
endpoint_mongoDbSettings :: Lens' Endpoint (Maybe MongoDbSettings)
endpoint_sslMode :: Lens' Endpoint (Maybe DmsSslModeValue)
endpoint_sybaseSettings :: Lens' Endpoint (Maybe SybaseSettings)
endpoint_databaseName :: Lens' Endpoint (Maybe Text)
endpoint_s3Settings :: Lens' Endpoint (Maybe S3Settings)
endpoint_kinesisSettings :: Lens' Endpoint (Maybe KinesisSettings)
endpoint_endpointIdentifier :: Lens' Endpoint (Maybe Text)
endpoint_externalId :: Lens' Endpoint (Maybe Text)
endpoint_dynamoDbSettings :: Lens' Endpoint (Maybe DynamoDbSettings)
endpoint_endpointArn :: Lens' Endpoint (Maybe Text)
endpoint_port :: Lens' Endpoint (Maybe Int)

Documentation

data Endpoint Source #

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

status :: Maybe Text
The status of the endpoint.
dmsTransferSettings :: Maybe DmsTransferSettings
The settings in JSON format for the DMS transfer type of source endpoint.
Possible settings 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"}
mySQLSettings :: Maybe MySQLSettings
The settings for the MySQL source and target endpoint. For more information, see the MySQLSettings structure.
serverName :: Maybe Text
The name of the server at the endpoint.
microsoftSQLServerSettings :: Maybe MicrosoftSQLServerSettings
The settings for the Microsoft SQL Server source and target endpoint. For more information, see the MicrosoftSQLServerSettings structure.
certificateArn :: Maybe Text
The Amazon Resource Name (ARN) used for SSL connection to the endpoint.
serviceAccessRoleArn :: Maybe Text
The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the iam:PassRole action.
docDbSettings :: Maybe DocDbSettings
engineDisplayName :: Maybe Text
The expanded name for the engine name. For example, if the EngineName parameter is "aurora," this value would be "Amazon Aurora MySQL."
postgreSQLSettings :: Maybe PostgreSQLSettings
The settings for the PostgreSQL source and target endpoint. For more information, see the PostgreSQLSettings structure.
extraConnectionAttributes :: Maybe Text
Additional connection attributes used to connect to the endpoint.
kafkaSettings :: Maybe KafkaSettings
The settings for the Apache Kafka target endpoint. For more information, see the KafkaSettings structure.
oracleSettings :: Maybe OracleSettings
The settings for the Oracle source and target endpoint. For more information, see the OracleSettings structure.
endpointType :: Maybe ReplicationEndpointTypeValue
The type of endpoint. Valid values are source and target.
redshiftSettings :: Maybe RedshiftSettings
Settings for the Amazon Redshift endpoint.
elasticsearchSettings :: Maybe ElasticsearchSettings
The settings for the Elasticsearch source endpoint. For more information, see the ElasticsearchSettings structure.
username :: Maybe Text
The user name used to connect to the endpoint.
externalTableDefinition :: Maybe Text
The external table definition.
engineName :: Maybe Text
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".
redisSettings :: Maybe RedisSettings
The settings for the Redis target endpoint. For more information, see the RedisSettings structure.
neptuneSettings :: Maybe NeptuneSettings
The settings for the Amazon Neptune target endpoint. For more information, see the NeptuneSettings structure.
iBMDb2Settings :: Maybe IBMDb2Settings
The settings for the IBM Db2 LUW source endpoint. For more information, see the IBMDb2Settings structure.
kmsKeyId :: Maybe Text
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.
mongoDbSettings :: Maybe MongoDbSettings
The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings structure.
sslMode :: Maybe DmsSslModeValue
The SSL mode used to connect to the endpoint. The default value is none.
sybaseSettings :: Maybe SybaseSettings
The settings for the SAP ASE source and target endpoint. For more information, see the SybaseSettings structure.
databaseName :: Maybe Text
The name of the database at the endpoint.
s3Settings :: Maybe S3Settings
The settings for the S3 target endpoint. For more information, see the S3Settings structure.
kinesisSettings :: Maybe KinesisSettings
The settings for the Amazon Kinesis target endpoint. For more information, see the KinesisSettings structure.
endpointIdentifier :: Maybe Text
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.
externalId :: Maybe Text
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.
dynamoDbSettings :: Maybe DynamoDbSettings
The settings for the DynamoDB target endpoint. For more information, see the DynamoDBSettings structure.
endpointArn :: Maybe Text
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
port :: Maybe Int
The port value used to access the endpoint.

Instances

Instances details

Eq Endpoint Source #
Instance details Defined in Amazonka.DMS.Types.Endpoint Methods (==) :: Endpoint -> Endpoint -> Bool # (/=) :: Endpoint -> Endpoint -> Bool #
Show Endpoint Source #
Instance details Defined in Amazonka.DMS.Types.Endpoint Methods showsPrec :: Int -> Endpoint -> ShowS # show :: Endpoint -> String # showList :: [Endpoint] -> ShowS #
Generic Endpoint Source #
Instance details Defined in Amazonka.DMS.Types.Endpoint Associated Types type Rep Endpoint :: Type -> Type # Methods from :: Endpoint -> Rep Endpoint x # to :: Rep Endpoint x -> Endpoint #
NFData Endpoint Source #
Instance details Defined in Amazonka.DMS.Types.Endpoint Methods rnf :: Endpoint -> () #
Hashable Endpoint Source #
Instance details Defined in Amazonka.DMS.Types.Endpoint Methods hashWithSalt :: Int -> Endpoint -> Int # hash :: Endpoint -> Int #
FromJSON Endpoint Source #
Instance details Defined in Amazonka.DMS.Types.Endpoint Methods parseJSON :: Value -> Parser Endpoint # parseJSONList :: Value -> Parser [Endpoint] #
type Rep Endpoint Source #
Instance details Defined in Amazonka.DMS.Types.Endpoint type Rep Endpoint = D1 ('MetaData "Endpoint" "Amazonka.DMS.Types.Endpoint" "libZSservicesZSamazonka-dmsZSamazonka-dms" 'False) (C1 ('MetaCons "Endpoint'" 'PrefixI 'True) (((((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "dmsTransferSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DmsTransferSettings))) :: (S1 ('MetaSel ('Just "mySQLSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MySQLSettings)) :: S1 ('MetaSel ('Just "serverName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "microsoftSQLServerSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MicrosoftSQLServerSettings)) :: S1 ('MetaSel ('Just "certificateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "serviceAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "docDbSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocDbSettings))))) :: (((S1 ('MetaSel ('Just "engineDisplayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "postgreSQLSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PostgreSQLSettings))) :: (S1 ('MetaSel ('Just "extraConnectionAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "kafkaSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KafkaSettings)))) :: ((S1 ('MetaSel ('Just "oracleSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OracleSettings)) :: S1 ('MetaSel ('Just "endpointType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReplicationEndpointTypeValue))) :: (S1 ('MetaSel ('Just "redshiftSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RedshiftSettings)) :: (S1 ('MetaSel ('Just "elasticsearchSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ElasticsearchSettings)) :: S1 ('MetaSel ('Just "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))) :: ((((S1 ('MetaSel ('Just "externalTableDefinition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "engineName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "redisSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RedisSettings)) :: S1 ('MetaSel ('Just "neptuneSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NeptuneSettings)))) :: ((S1 ('MetaSel ('Just "iBMDb2Settings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IBMDb2Settings)) :: S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "mongoDbSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MongoDbSettings)) :: S1 ('MetaSel ('Just "sslMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DmsSslModeValue))))) :: (((S1 ('MetaSel ('Just "sybaseSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SybaseSettings)) :: S1 ('MetaSel ('Just "databaseName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "s3Settings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3Settings)) :: S1 ('MetaSel ('Just "kinesisSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KinesisSettings)))) :: ((S1 ('MetaSel ('Just "endpointIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "externalId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "dynamoDbSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DynamoDbSettings)) :: (S1 ('MetaSel ('Just "endpointArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))))))

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:status:Endpoint', endpoint_status - The status of the endpoint.

$sel:dmsTransferSettings:Endpoint', endpoint_dmsTransferSettings - The settings in JSON format for the DMS transfer type of source endpoint.

Possible settings 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"}

$sel:mySQLSettings:Endpoint', endpoint_mySQLSettings - The settings for the MySQL source and target endpoint. For more information, see the MySQLSettings structure.

$sel:serverName:Endpoint', endpoint_serverName - The name of the server at the endpoint.

$sel:microsoftSQLServerSettings:Endpoint', endpoint_microsoftSQLServerSettings - The settings for the Microsoft SQL Server source and target endpoint. For more information, see the MicrosoftSQLServerSettings structure.

$sel:certificateArn:Endpoint', endpoint_certificateArn - The Amazon Resource Name (ARN) used for SSL connection to the endpoint.

$sel:serviceAccessRoleArn: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:docDbSettings:Endpoint', endpoint_docDbSettings - Undocumented member.

$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:postgreSQLSettings:Endpoint', endpoint_postgreSQLSettings - The settings for the PostgreSQL source and target endpoint. For more information, see the PostgreSQLSettings structure.

$sel:extraConnectionAttributes:Endpoint', endpoint_extraConnectionAttributes - Additional connection attributes used to connect to the endpoint.

$sel:kafkaSettings:Endpoint', endpoint_kafkaSettings - The settings for the Apache Kafka target endpoint. For more information, see the KafkaSettings structure.

$sel:oracleSettings:Endpoint', endpoint_oracleSettings - The settings for the Oracle source and target endpoint. For more information, see the OracleSettings structure.

$sel:endpointType:Endpoint', endpoint_endpointType - The type of endpoint. Valid values are source and target.

$sel:redshiftSettings:Endpoint', endpoint_redshiftSettings - Settings for the Amazon Redshift endpoint.

$sel:elasticsearchSettings:Endpoint', endpoint_elasticsearchSettings - The settings for the Elasticsearch source endpoint. For more information, see the ElasticsearchSettings structure.

$sel:username:Endpoint', endpoint_username - The user name used to connect to the endpoint.

$sel:externalTableDefinition:Endpoint', endpoint_externalTableDefinition - The external table definition.

$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", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "documentdb", "sqlserver", and "neptune".

$sel:redisSettings:Endpoint', endpoint_redisSettings - The settings for the Redis target endpoint. For more information, see the RedisSettings structure.

$sel:neptuneSettings:Endpoint', endpoint_neptuneSettings - The settings for the Amazon Neptune target endpoint. For more information, see the NeptuneSettings structure.

$sel:iBMDb2Settings:Endpoint', endpoint_iBMDb2Settings - The settings for the IBM Db2 LUW source endpoint. For more information, see the IBMDb2Settings structure.

$sel:kmsKeyId: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:mongoDbSettings:Endpoint', endpoint_mongoDbSettings - The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings structure.

$sel:sslMode:Endpoint', endpoint_sslMode - The SSL mode used to connect to the endpoint. The default value is none.

$sel:sybaseSettings:Endpoint', endpoint_sybaseSettings - The settings for the SAP ASE source and target endpoint. For more information, see the SybaseSettings structure.

$sel:databaseName:Endpoint', endpoint_databaseName - The name of the database at the endpoint.

$sel:s3Settings:Endpoint', endpoint_s3Settings - The settings for the S3 target endpoint. For more information, see the S3Settings structure.

$sel:kinesisSettings:Endpoint', endpoint_kinesisSettings - The settings for the Amazon Kinesis target endpoint. For more information, see the KinesisSettings structure.

$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: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.

$sel:dynamoDbSettings:Endpoint', endpoint_dynamoDbSettings - The settings for the DynamoDB target endpoint. For more information, see the DynamoDBSettings structure.

$sel:endpointArn:Endpoint', endpoint_endpointArn - The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

$sel:port:Endpoint', endpoint_port - The port value used to access the endpoint.

endpoint_status :: Lens' Endpoint (Maybe Text) Source #

The status of the endpoint.

endpoint_dmsTransferSettings :: Lens' Endpoint (Maybe DmsTransferSettings) Source #

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

Possible settings 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"}

endpoint_mySQLSettings :: Lens' Endpoint (Maybe MySQLSettings) Source #

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

endpoint_serverName :: Lens' Endpoint (Maybe Text) Source #

The name of the server at the endpoint.

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_certificateArn :: Lens' Endpoint (Maybe Text) Source #

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

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_docDbSettings :: Lens' Endpoint (Maybe DocDbSettings) Source #

Undocumented member.

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_postgreSQLSettings :: Lens' Endpoint (Maybe PostgreSQLSettings) Source #

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

endpoint_extraConnectionAttributes :: Lens' Endpoint (Maybe Text) Source #

Additional connection attributes used to connect to the endpoint.

endpoint_kafkaSettings :: Lens' Endpoint (Maybe KafkaSettings) Source #

The settings for the Apache Kafka target endpoint. For more information, see the KafkaSettings 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_endpointType :: Lens' Endpoint (Maybe ReplicationEndpointTypeValue) Source #

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

endpoint_redshiftSettings :: Lens' Endpoint (Maybe RedshiftSettings) Source #

Settings for the Amazon Redshift endpoint.

endpoint_elasticsearchSettings :: Lens' Endpoint (Maybe ElasticsearchSettings) Source #

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

endpoint_username :: Lens' Endpoint (Maybe Text) Source #

The user name used to connect to the endpoint.

endpoint_externalTableDefinition :: Lens' Endpoint (Maybe Text) Source #

The external table definition.

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", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "documentdb", "sqlserver", and "neptune".

endpoint_redisSettings :: Lens' Endpoint (Maybe RedisSettings) Source #

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

endpoint_neptuneSettings :: Lens' Endpoint (Maybe NeptuneSettings) Source #

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

endpoint_iBMDb2Settings :: Lens' Endpoint (Maybe IBMDb2Settings) Source #

The settings for the IBM Db2 LUW source endpoint. For more information, see the IBMDb2Settings 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_mongoDbSettings :: Lens' Endpoint (Maybe MongoDbSettings) Source #

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

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.

endpoint_databaseName :: Lens' Endpoint (Maybe Text) Source #

The name of the database at the endpoint.

endpoint_s3Settings :: Lens' Endpoint (Maybe S3Settings) Source #

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

endpoint_kinesisSettings :: Lens' Endpoint (Maybe KinesisSettings) Source #

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

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_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_dynamoDbSettings :: Lens' Endpoint (Maybe DynamoDbSettings) Source #

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

endpoint_endpointArn :: Lens' Endpoint (Maybe Text) Source #

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

endpoint_port :: Lens' Endpoint (Maybe Int) Source #

The port value used to access the endpoint.