Endpoint

public struct Endpoint : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

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

    Declaration

    Swift

    public let certificateArn: String?

  • The name of the database at the endpoint.

    Declaration

    Swift

    public let databaseName: String?

  • 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” }

    Declaration

    Swift

    public let dmsTransferSettings: DmsTransferSettings?

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

    Declaration

    Swift

    public let dynamoDbSettings: DynamoDbSettings?

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

    Declaration

    Swift

    public let elasticsearchSettings: ElasticsearchSettings?

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

    Declaration

    Swift

    public let endpointArn: 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.

    Declaration

    Swift

    public let endpointIdentifier: String?

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

    Declaration

    Swift

    public let endpointType: ReplicationEndpointTypeValue?

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

    Declaration

    Swift

    public let engineDisplayName: 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”.

    Declaration

    Swift

    public let engineName: 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.

    Declaration

    Swift

    public let externalId: String?

  • The external table definition.

    Declaration

    Swift

    public let externalTableDefinition: String?

  • Additional connection attributes used to connect to the endpoint.

    Declaration

    Swift

    public let extraConnectionAttributes: String?

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

    Declaration

    Swift

    public let iBMDb2Settings: IBMDb2Settings?

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

    Declaration

    Swift

    public let kafkaSettings: KafkaSettings?

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

    Declaration

    Swift

    public let kinesisSettings: KinesisSettings?

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

    Declaration

    Swift

    public let kmsKeyId: String?

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

    Declaration

    Swift

    public let microsoftSQLServerSettings: MicrosoftSQLServerSettings?

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

    Declaration

    Swift

    public let mongoDbSettings: MongoDbSettings?

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

    Declaration

    Swift

    public let mySQLSettings: MySQLSettings?

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

    Declaration

    Swift

    public let neptuneSettings: NeptuneSettings?

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

    Declaration

    Swift

    public let oracleSettings: OracleSettings?

  • The port value used to access the endpoint.

    Declaration

    Swift

    public let port: Int?

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

    Declaration

    Swift

    public let postgreSQLSettings: PostgreSQLSettings?

  • Settings for the Amazon Redshift endpoint.

    Declaration

    Swift

    public let redshiftSettings: RedshiftSettings?

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

    Declaration

    Swift

    public let s3Settings: S3Settings?

  • The name of the server at the endpoint.

    Declaration

    Swift

    public let serverName: String?

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

    Declaration

    Swift

    public let serviceAccessRoleArn: String?

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

    Declaration

    Swift

    public let sslMode: DmsSslModeValue?

  • The status of the endpoint.

    Declaration

    Swift

    public let status: String?

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

    Declaration

    Swift

    public let sybaseSettings: SybaseSettings?

  • The user name used to connect to the endpoint.

    Declaration

    Swift

    public let username: String?

  • Undocumented

    Declaration

    Swift

    public init(certificateArn: String? = nil, databaseName: String? = nil, dmsTransferSettings: DmsTransferSettings? = nil, dynamoDbSettings: DynamoDbSettings? = nil, elasticsearchSettings: ElasticsearchSettings? = nil, endpointArn: String? = nil, endpointIdentifier: String? = nil, endpointType: ReplicationEndpointTypeValue? = nil, engineDisplayName: String? = nil, engineName: String? = nil, externalId: String? = nil, externalTableDefinition: String? = nil, extraConnectionAttributes: String? = nil, iBMDb2Settings: IBMDb2Settings? = nil, kafkaSettings: KafkaSettings? = nil, kinesisSettings: KinesisSettings? = nil, kmsKeyId: String? = nil, microsoftSQLServerSettings: MicrosoftSQLServerSettings? = nil, mongoDbSettings: MongoDbSettings? = nil, mySQLSettings: MySQLSettings? = nil, neptuneSettings: NeptuneSettings? = nil, oracleSettings: OracleSettings? = nil, port: Int? = nil, postgreSQLSettings: PostgreSQLSettings? = nil, redshiftSettings: RedshiftSettings? = nil, s3Settings: S3Settings? = nil, serverName: String? = nil, serviceAccessRoleArn: String? = nil, sslMode: DmsSslModeValue? = nil, status: String? = nil, sybaseSettings: SybaseSettings? = nil, username: String? = nil)