ModifyEndpointMessage Structure Reference


                    
                    
                    _members

Declaration

Swift

public static var _members: [AWSShapeMember]


                    
                    
                    certificateArn

The Amazon Resource Name (ARN) of the certificate used for SSL connection.

Declaration

Swift

public let certificateArn: String?


                    
                    
                    databaseName

The name of the endpoint database.

Declaration

Swift

public let databaseName: String?


                    
                    
                    dmsTransferSettings

The settings in JSON format for the DMS transfer type of source endpoint. Attributes include the following: serviceAccessRoleArn - The AWS Identity and Access Management (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. Either set this parameter to NONE (the default) or don’t use it to leave the files uncompressed. 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?


                    
                    
                    dynamoDbSettings

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?


                    
                    
                    elasticsearchSettings

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?


                    
                    
                    endpointArn

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

Declaration

Swift

public let endpointArn: String


                    
                    
                    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.

Declaration

Swift

public let endpointIdentifier: String?


                    
                    
                    endpointType

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

Declaration

Swift

public let endpointType: ReplicationEndpointTypeValue?


                    
                    
                    engineName

The type of engine for the endpoint. 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?


                    
                    
                    externalTableDefinition

The external table definition.

Declaration

Swift

public let externalTableDefinition: String?


                    
                    
                    extraConnectionAttributes

Additional attributes associated with the connection. To reset this parameter, pass the empty string (“”) as an argument.

Declaration

Swift

public let extraConnectionAttributes: String?


                    
                    
                    iBMDb2Settings

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?


                    
                    
                    kafkaSettings

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?


                    
                    
                    kinesisSettings

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?


                    
                    
                    microsoftSQLServerSettings

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?


                    
                    
                    mongoDbSettings

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

Declaration

Swift

public let mongoDbSettings: MongoDbSettings?


                    
                    
                    mySQLSettings

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?


                    
                    
                    neptuneSettings

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?


                    
                    
                    oracleSettings

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?


                    
                    
                    password

The password to be used to login to the endpoint database.

Declaration

Swift

public let password: String?


                    
                    
                    port

The port used by the endpoint database.

Declaration

Swift

public let port: Int?


                    
                    
                    postgreSQLSettings

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?


                    
                    
                    redshiftSettings

Undocumented

Declaration

Swift

public let redshiftSettings: RedshiftSettings?


                    
                    
                    s3Settings

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?


                    
                    
                    serverName

The name of the server where the endpoint database resides.

Declaration

Swift

public let serverName: String?


                    
                    
                    serviceAccessRoleArn

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

Declaration

Swift

public let serviceAccessRoleArn: String?


                    
                    
                    sslMode

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

Declaration

Swift

public let sslMode: DmsSslModeValue?


                    
                    
                    sybaseSettings

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?


                    
                    
                    username

The user name to be used to login to the endpoint database.

Declaration

Swift

public let username: String?


                    
                    
                    init(certificateArn:databaseName:dmsTransferSettings:dynamoDbSettings:elasticsearchSettings:endpointArn:endpointIdentifier:endpointType:engineName:externalTableDefinition:extraConnectionAttributes:iBMDb2Settings:kafkaSettings:kinesisSettings:microsoftSQLServerSettings:mongoDbSettings:mySQLSettings:neptuneSettings:oracleSettings:password:port:postgreSQLSettings:redshiftSettings:s3Settings:serverName:serviceAccessRoleArn:sslMode:sybaseSettings:username:)

Undocumented

Declaration

Swift

public init(certificateArn: String? = nil, databaseName: String? = nil, dmsTransferSettings: DmsTransferSettings? = nil, dynamoDbSettings: DynamoDbSettings? = nil, elasticsearchSettings: ElasticsearchSettings? = nil, endpointArn: String, endpointIdentifier: String? = nil, endpointType: ReplicationEndpointTypeValue? = nil, engineName: String? = nil, externalTableDefinition: String? = nil, extraConnectionAttributes: String? = nil, iBMDb2Settings: IBMDb2Settings? = nil, kafkaSettings: KafkaSettings? = nil, kinesisSettings: KinesisSettings? = 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, username: String? = nil)