CreateEndpointMessage

public struct CreateEndpointMessage : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • The Amazon Resource Name (ARN) for the certificate.

    Declaration

    Swift

    public let certificateArn: String?

  • The name of the endpoint database.

    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?

  • Settings in JSON format for the target Amazon DynamoDB endpoint. For information about other available settings, see Using Object Mapping to Migrate Data to DynamoDB in the AWS Database Migration Service User Guide.

    Declaration

    Swift

    public let dynamoDbSettings: DynamoDbSettings?

  • Settings in JSON format for the target Elasticsearch endpoint. For more information about the available settings, see Extra Connection Attributes When Using Elasticsearch as a Target for AWS DMS in the AWS Database Migration Service User Guide.

    Declaration

    Swift

    public let elasticsearchSettings: ElasticsearchSettings?

  • 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 type of engine for the endpoint. Valid values, depending on the EndpointType value, include “mysql”, “oracle”, “postgres”, “mariadb”, “aurora”, “aurora-postgresql”, “redshift”, “s3”, “db2”, “azuredb”, “sybase”, “dynamodb”, “mongodb”, “kinesis”, “kafka”, “elasticsearch”, “docdb”, “sqlserver”, and “neptune”.

    Declaration

    Swift

    public let engineName: String

  • The external table definition.

    Declaration

    Swift

    public let externalTableDefinition: String?

  • Additional attributes associated with the connection. Each attribute is specified as a name-value pair associated by an equal sign (=). Multiple attributes are separated by a semicolon (;) with no additional white space. For information on the attributes available for connecting your source or target endpoint, see Working with AWS DMS Endpoints in the AWS Database Migration Service User Guide.

    Declaration

    Swift

    public let extraConnectionAttributes: String?

  • Settings in JSON format for the source IBM Db2 LUW endpoint. For information about other available settings, see Extra connection attributes when using Db2 LUW as a source for AWS DMS in the AWS Database Migration Service User Guide.

    Declaration

    Swift

    public let iBMDb2Settings: IBMDb2Settings?

  • Settings in JSON format for the target Apache Kafka endpoint. For more information about the available settings, see Using Apache Kafka as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.

    Declaration

    Swift

    public let kafkaSettings: KafkaSettings?

  • Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about the available settings, see Using Amazon Kinesis Data Streams as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.

    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?

  • Settings in JSON format for the source and target Microsoft SQL Server endpoint. For information about other available settings, see Extra connection attributes when using SQL Server as a source for AWS DMS and Extra connection attributes when using SQL Server as a target for AWS DMS in the AWS Database Migration Service User Guide.

    Declaration

    Swift

    public let microsoftSQLServerSettings: MicrosoftSQLServerSettings?

  • Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see Using MongoDB as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.

    Declaration

    Swift

    public let mongoDbSettings: MongoDbSettings?

  • Settings in JSON format for the source and target MySQL endpoint. For information about other available settings, see Extra connection attributes when using MySQL as a source for AWS DMS and Extra connection attributes when using a MySQL-compatible database as a target for AWS DMS in the AWS Database Migration Service User Guide.

    Declaration

    Swift

    public let mySQLSettings: MySQLSettings?

  • Settings in JSON format for the target Amazon Neptune endpoint. For more information about the available settings, see Specifying Endpoint Settings for Amazon Neptune as a Target in the AWS Database Migration Service User Guide.

    Declaration

    Swift

    public let neptuneSettings: NeptuneSettings?

  • Settings in JSON format for the source and target Oracle endpoint. For information about other available settings, see Extra connection attributes when using Oracle as a source for AWS DMS and Extra connection attributes when using Oracle as a target for AWS DMS in the AWS Database Migration Service User Guide.

    Declaration

    Swift

    public let oracleSettings: OracleSettings?

  • The password to be used to log in to the endpoint database.

    Declaration

    Swift

    public let password: String?

  • The port used by the endpoint database.

    Declaration

    Swift

    public let port: Int?

  • Settings in JSON format for the source and target PostgreSQL endpoint. For information about other available settings, see Extra connection attributes when using PostgreSQL as a source for AWS DMS and Extra connection attributes when using PostgreSQL as a target for AWS DMS in the AWS Database Migration Service User Guide.

    Declaration

    Swift

    public let postgreSQLSettings: PostgreSQLSettings?

  • Undocumented

    Declaration

    Swift

    public let redshiftSettings: RedshiftSettings?

  • Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see Extra Connection Attributes When Using Amazon S3 as a Target for AWS DMS in the AWS Database Migration Service User Guide.

    Declaration

    Swift

    public let s3Settings: S3Settings?

  • The name of the server where the endpoint database resides.

    Declaration

    Swift

    public let serverName: String?

  • The Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint.

    Declaration

    Swift

    public let serviceAccessRoleArn: String?

  • The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is none

    Declaration

    Swift

    public let sslMode: DmsSslModeValue?

  • Settings in JSON format for the source and target SAP ASE endpoint. For information about other available settings, see Extra connection attributes when using SAP ASE as a source for AWS DMS and Extra connection attributes when using SAP ASE as a target for AWS DMS in the AWS Database Migration Service User Guide.

    Declaration

    Swift

    public let sybaseSettings: SybaseSettings?

  • One or more tags to be assigned to the endpoint.

    Declaration

    Swift

    public let tags: [Tag]?

  • The user name to be used to log in to the endpoint database.

    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, endpointIdentifier: String, endpointType: ReplicationEndpointTypeValue, engineName: String, 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, password: String? = nil, port: Int? = nil, postgreSQLSettings: PostgreSQLSettings? = nil, redshiftSettings: RedshiftSettings? = nil, s3Settings: S3Settings? = nil, serverName: String? = nil, serviceAccessRoleArn: String? = nil, sslMode: DmsSslModeValue? = nil, sybaseSettings: SybaseSettings? = nil, tags: [Tag]? = nil, username: String? = nil)