create_endpoint `async` ¶

create_endpoint(
    endpoint_identifier: String,
    endpoint_type: ReplicationEndpointTypeValue,
    engine_name: String,
    *,
    config_overrides: Optional[AsyncDatabaseMigrationServiceClientConfig] = None,
    username: Optional[String] = None,
    password: Optional[SecretString] = None,
    server_name: Optional[String] = None,
    port: Optional[IntegerOptional] = None,
    database_name: Optional[String] = None,
    extra_connection_attributes: Optional[String] = None,
    kms_key_id: Optional[String] = None,
    tags: Optional[TagList] = None,
    certificate_arn: Optional[String] = None,
    ssl_mode: Optional[DmsSslModeValue] = None,
    service_access_role_arn: Optional[String] = None,
    external_table_definition: Optional[String] = None,
    dynamo_db_settings: Optional[DynamoDbSettings] = None,
    s3_settings: Optional[S3Settings] = None,
    dms_transfer_settings: Optional[DmsTransferSettings] = None,
    mongo_db_settings: Optional[MongoDbSettings] = None,
    kinesis_settings: Optional[KinesisSettings] = None,
    kafka_settings: Optional[KafkaSettings] = None,
    elasticsearch_settings: Optional[ElasticsearchSettings] = None,
    neptune_settings: Optional[NeptuneSettings] = None,
    redshift_settings: Optional[RedshiftSettings] = None,
    postgre_sql_settings: Optional[PostgreSQLSettings] = None,
    my_sql_settings: Optional[MySQLSettings] = None,
    oracle_settings: Optional[OracleSettings] = None,
    sybase_settings: Optional[SybaseSettings] = None,
    microsoft_sql_server_settings: Optional[MicrosoftSQLServerSettings] = None,
    ibm_db2_settings: Optional[IBMDb2Settings] = None,
    resource_identifier: Optional[String] = None,
    doc_db_settings: Optional[DocDbSettings] = None,
    redis_settings: Optional[RedisSettings] = None,
    gcp_my_sql_settings: Optional[GcpMySQLSettings] = None,
    timestream_settings: Optional[TimestreamSettings] = None,
) -> CreateEndpointResponse

Creates an endpoint using the provided settings.

For a MySQL source or target endpoint, don't explicitly specify the database using the DatabaseName request parameter on the CreateEndpoint API call. Specifying DatabaseName when you create a MySQL endpoint replicates all the task tables to this single database. For MySQL endpoints, you specify the database only when you specify the schema in the table-mapping rules of the DMS task.

Parameters:

endpoint_identifier (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.
endpoint_type (ReplicationEndpointTypeValue) –

The type of endpoint. Valid values are source and target.
engine_name (String) –

The type of engine for the endpoint. Valid values, depending on the EndpointType value, include "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", "opensearch", "redshift", "s3", "db2", "db2-zos", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "docdb", "sqlserver", "neptune", "babelfish", redshift-serverless, aurora-serverless, aurora-postgresql-serverless, gcp-mysql, azure-sql-managed-instance, redis, dms-transfer.
username (Optional[String], default: None ) –

The user name to be used to log in to the endpoint database.
password (Optional[SecretString], default: None ) –

The password to be used to log in to the endpoint database.
server_name (Optional[String], default: None ) –

The name of the server where the endpoint database resides.
port (Optional[IntegerOptional], default: None ) –

The port used by the endpoint database.
database_name (Optional[String], default: None ) –

The name of the endpoint database. For a MySQL source or target endpoint, do not specify DatabaseName. To migrate to a specific database, use this setting and targetDbType.
extra_connection_attributes (Optional[String], default: None ) –

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 DMS Endpoints in the Database Migration Service User Guide.
kms_key_id (Optional[String], default: None ) –

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.
tags (Optional[TagList], default: None ) –

One or more tags to be assigned to the endpoint.
certificate_arn (Optional[String], default: None ) –

The Amazon Resource Name (ARN) for the certificate.
ssl_mode (Optional[DmsSslModeValue], default: None ) –

The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is none
service_access_role_arn (Optional[String], default: None ) –

The Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint. The role must allow the iam:PassRole action.
external_table_definition (Optional[String], default: None ) –

The external table definition.
dynamo_db_settings (Optional[DynamoDbSettings], default: None ) –

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 Database Migration Service User Guide.
s3_settings (Optional[S3Settings], default: None ) –

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 DMS in the Database Migration Service User Guide.
dms_transfer_settings (Optional[DmsTransferSettings], default: None ) –
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", }
mongo_db_settings (Optional[MongoDbSettings], default: None ) –

Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see Endpoint configuration settings when using MongoDB as a source for Database Migration Service in the Database Migration Service User Guide.
kinesis_settings (Optional[KinesisSettings], default: None ) –

Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about the available settings, see Using object mapping to migrate data to a Kinesis data stream in the Database Migration Service User Guide.
kafka_settings (Optional[KafkaSettings], default: None ) –

Settings in JSON format for the target Apache Kafka endpoint. For more information about the available settings, see Using object mapping to migrate data to a Kafka topic in the Database Migration Service User Guide.
elasticsearch_settings (Optional[ElasticsearchSettings], default: None ) –

Settings in JSON format for the target OpenSearch endpoint. For more information about the available settings, see Extra Connection Attributes When Using OpenSearch as a Target for DMS in the Database Migration Service User Guide.
neptune_settings (Optional[NeptuneSettings], default: None ) –

Settings in JSON format for the target Amazon Neptune endpoint. For more information about the available settings, see Specifying graph-mapping rules using Gremlin and R2RML for Amazon Neptune as a target in the Database Migration Service User Guide.
postgre_sql_settings (Optional[PostgreSQLSettings], default: None ) –

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 DMS and Extra connection attributes when using PostgreSQL as a target for DMS in the Database Migration Service User Guide.
my_sql_settings (Optional[MySQLSettings], default: None ) –

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 DMS and Extra connection attributes when using a MySQL-compatible database as a target for DMS in the Database Migration Service User Guide.
oracle_settings (Optional[OracleSettings], default: None ) –

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 DMS and Extra connection attributes when using Oracle as a target for DMS in the Database Migration Service User Guide.
sybase_settings (Optional[SybaseSettings], default: None ) –

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 DMS and Extra connection attributes when using SAP ASE as a target for DMS in the Database Migration Service User Guide.
microsoft_sql_server_settings (Optional[MicrosoftSQLServerSettings], default: None ) –

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 DMS and Extra connection attributes when using SQL Server as a target for DMS in the Database Migration Service User Guide.
ibm_db2_settings (Optional[IBMDb2Settings], default: None ) –

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 DMS in the Database Migration Service User Guide.
resource_identifier (Optional[String], default: None ) –

A friendly name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object. The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as Example-App-ARN1. For example, this value might result in the EndpointArn value arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't specify a ResourceIdentifier value, DMS generates a default identifier value for the end of EndpointArn.
redis_settings (Optional[RedisSettings], default: None ) –

Settings in JSON format for the target Redis endpoint.
gcp_my_sql_settings (Optional[GcpMySQLSettings], default: None ) –

Settings in JSON format for the source GCP MySQL endpoint.
timestream_settings (Optional[TimestreamSettings], default: None ) –

Settings in JSON format for the target Amazon Timestream endpoint.

Raises:

AccessDeniedFault –

DMS was denied access to the endpoint. Check that the role is correctly configured.
InvalidResourceStateFault –

The resource is in a state that prevents it from being used for database migration.
KMSKeyNotAccessibleFault –

DMS cannot access the KMS key.
ResourceAlreadyExistsFault –

The resource you are attempting to create already exists.
ResourceNotFoundFault –

The resource could not be found.
ResourceQuotaExceededFault –

The quota for this resource quota has been exceeded.
S3AccessDeniedFault –

Insufficient privileges are preventing access to an Amazon S3 object.
UnknownServiceError –

The service returned an error code this client does not model.

Examples:

Create endpoint Creates an endpoint using the provided settings.

>>> await client.create_endpoint(endpoint_identifier='test-endpoint-1', endpoint_type='source', engine_name='mysql', username='username', password='pasword', server_name='mydb.cx1llnox7iyx.us-west-2.rds.amazonaws.com', port=3306, database_name='testdb', extra_connection_attributes='', kms_key_id='arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd', tags=[{'Key': 'Acount', 'Value': '143327655'}], certificate_arn='', ssl_mode='require')

Source code in docs_src/capo_database_migration_service/_services/async_database_migration_service.py

async def create_endpoint(
    self,
    endpoint_identifier: "capo_database_migration_service.types.string.String",
    endpoint_type: "capo_database_migration_service.types.replication_endpoint_type_value.ReplicationEndpointTypeValue",
    engine_name: "capo_database_migration_service.types.string.String",
    *,
    config_overrides: Optional[AsyncDatabaseMigrationServiceClientConfig] = None,
    username: Optional[
        "capo_database_migration_service.types.string.String"
    ] = None,
    password: Optional[
        "capo_database_migration_service.types.secret_string.SecretString"
    ] = None,
    server_name: Optional[
        "capo_database_migration_service.types.string.String"
    ] = None,
    port: Optional[
        "capo_database_migration_service.types.integer_optional.IntegerOptional"
    ] = None,
    database_name: Optional[
        "capo_database_migration_service.types.string.String"
    ] = None,
    extra_connection_attributes: Optional[
        "capo_database_migration_service.types.string.String"
    ] = None,
    kms_key_id: Optional[
        "capo_database_migration_service.types.string.String"
    ] = None,
    tags: Optional["capo_database_migration_service.types.tag_list.TagList"] = None,
    certificate_arn: Optional[
        "capo_database_migration_service.types.string.String"
    ] = None,
    ssl_mode: Optional[
        "capo_database_migration_service.types.dms_ssl_mode_value.DmsSslModeValue"
    ] = None,
    service_access_role_arn: Optional[
        "capo_database_migration_service.types.string.String"
    ] = None,
    external_table_definition: Optional[
        "capo_database_migration_service.types.string.String"
    ] = None,
    dynamo_db_settings: Optional[
        "capo_database_migration_service.types.dynamo_db_settings.DynamoDbSettings"
    ] = None,
    s3_settings: Optional[
        "capo_database_migration_service.types.s3_settings.S3Settings"
    ] = None,
    dms_transfer_settings: Optional[
        "capo_database_migration_service.types.dms_transfer_settings.DmsTransferSettings"
    ] = None,
    mongo_db_settings: Optional[
        "capo_database_migration_service.types.mongo_db_settings.MongoDbSettings"
    ] = None,
    kinesis_settings: Optional[
        "capo_database_migration_service.types.kinesis_settings.KinesisSettings"
    ] = None,
    kafka_settings: Optional[
        "capo_database_migration_service.types.kafka_settings.KafkaSettings"
    ] = None,
    elasticsearch_settings: Optional[
        "capo_database_migration_service.types.elasticsearch_settings.ElasticsearchSettings"
    ] = None,
    neptune_settings: Optional[
        "capo_database_migration_service.types.neptune_settings.NeptuneSettings"
    ] = None,
    redshift_settings: Optional[
        "capo_database_migration_service.types.redshift_settings.RedshiftSettings"
    ] = None,
    postgre_sql_settings: Optional[
        "capo_database_migration_service.types.postgre_sql_settings.PostgreSQLSettings"
    ] = None,
    my_sql_settings: Optional[
        "capo_database_migration_service.types.my_sql_settings.MySQLSettings"
    ] = None,
    oracle_settings: Optional[
        "capo_database_migration_service.types.oracle_settings.OracleSettings"
    ] = None,
    sybase_settings: Optional[
        "capo_database_migration_service.types.sybase_settings.SybaseSettings"
    ] = None,
    microsoft_sql_server_settings: Optional[
        "capo_database_migration_service.types.microsoft_sql_server_settings.MicrosoftSQLServerSettings"
    ] = None,
    ibm_db2_settings: Optional[
        "capo_database_migration_service.types.ibm_db2_settings.IBMDb2Settings"
    ] = None,
    resource_identifier: Optional[
        "capo_database_migration_service.types.string.String"
    ] = None,
    doc_db_settings: Optional[
        "capo_database_migration_service.types.doc_db_settings.DocDbSettings"
    ] = None,
    redis_settings: Optional[
        "capo_database_migration_service.types.redis_settings.RedisSettings"
    ] = None,
    gcp_my_sql_settings: Optional[
        "capo_database_migration_service.types.gcp_my_sql_settings.GcpMySQLSettings"
    ] = None,
    timestream_settings: Optional[
        "capo_database_migration_service.types.timestream_settings.TimestreamSettings"
    ] = None,
) -> "capo_database_migration_service.types.create_endpoint_response.CreateEndpointResponse":
    """<p>Creates an endpoint using the provided settings.</p> <note> <p>For a MySQL source or target endpoint, don't explicitly specify the database using the <code>DatabaseName</code> request parameter on the <code>CreateEndpoint</code> API call. Specifying <code>DatabaseName</code> when you create a MySQL endpoint replicates all the task tables to this single database. For MySQL endpoints, you specify the database only when you specify the schema in the table-mapping rules of the DMS task.</p> </note>

    Args:
        endpoint_identifier: <p>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.</p>
        endpoint_type: <p>The type of endpoint. Valid values are <code>source</code> and <code>target</code>.</p>
        engine_name: <p>The type of engine for the endpoint. Valid values, depending on the <code>EndpointType</code> value, include <code>"mysql"</code>, <code>"oracle"</code>, <code>"postgres"</code>, <code>"mariadb"</code>, <code>"aurora"</code>, <code>"aurora-postgresql"</code>, <code>"opensearch"</code>, <code>"redshift"</code>, <code>"s3"</code>, <code>"db2"</code>, <code>"db2-zos"</code>, <code>"azuredb"</code>, <code>"sybase"</code>, <code>"dynamodb"</code>, <code>"mongodb"</code>, <code>"kinesis"</code>, <code>"kafka"</code>, <code>"elasticsearch"</code>, <code>"docdb"</code>, <code>"sqlserver"</code>, <code>"neptune"</code>, <code>"babelfish"</code>, <code>redshift-serverless</code>, <code>aurora-serverless</code>, <code>aurora-postgresql-serverless</code>, <code>gcp-mysql</code>, <code>azure-sql-managed-instance</code>, <code>redis</code>, <code>dms-transfer</code>.</p>
        username: <p>The user name to be used to log in to the endpoint database.</p>
        password: <p>The password to be used to log in to the endpoint database.</p>
        server_name: <p>The name of the server where the endpoint database resides.</p>
        port: <p>The port used by the endpoint database.</p>
        database_name: <p>The name of the endpoint database. For a MySQL source or target endpoint, do not specify DatabaseName. To migrate to a specific database, use this setting and <code>targetDbType</code>.</p>
        extra_connection_attributes: <p>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 <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.html">Working with DMS Endpoints</a> in the <i>Database Migration Service User Guide.</i> </p>
        kms_key_id: <p>An KMS key identifier that is used to encrypt the connection parameters for the endpoint.</p> <p>If you don't specify a value for the <code>KmsKeyId</code> parameter, then DMS uses your default encryption key.</p> <p>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.</p>
        tags: <p>One or more tags to be assigned to the endpoint.</p>
        certificate_arn: <p>The Amazon Resource Name (ARN) for the certificate.</p>
        ssl_mode: <p>The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is <code>none</code> </p>
        service_access_role_arn: <p> The Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint. The role must allow the <code>iam:PassRole</code> action.</p>
        external_table_definition: <p>The external table definition. </p>
        dynamo_db_settings: <p>Settings in JSON format for the target Amazon DynamoDB endpoint. For information about other available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DynamoDB.html#CHAP_Target.DynamoDB.ObjectMapping">Using Object Mapping to Migrate Data to DynamoDB</a> in the <i>Database Migration Service User Guide.</i> </p>
        s3_settings: <p>Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring">Extra Connection Attributes When Using Amazon S3 as a Target for DMS</a> in the <i>Database Migration Service User Guide.</i> </p>
        dms_transfer_settings: <p>The settings in JSON format for the DMS transfer type of source endpoint. </p> <p>Possible settings include the following:</p> <ul> <li> <p> <code>ServiceAccessRoleArn</code> - The Amazon Resource Name (ARN) used by the service access IAM role. The role must allow the <code>iam:PassRole</code> action.</p> </li> <li> <p> <code>BucketName</code> - The name of the S3 bucket to use.</p> </li> </ul> <p>Shorthand syntax for these settings is as follows: <code>ServiceAccessRoleArn=string,BucketName=string</code> </p> <p>JSON syntax for these settings is as follows: <code>{ "ServiceAccessRoleArn": "string", "BucketName": "string", } </code> </p>
        mongo_db_settings: <p>Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MongoDB.html#CHAP_Source.MongoDB.Configuration">Endpoint configuration settings when using MongoDB as a source for Database Migration Service</a> in the <i>Database Migration Service User Guide.</i> </p>
        kinesis_settings: <p>Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about the available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html#CHAP_Target.Kinesis.ObjectMapping">Using object mapping to migrate data to a Kinesis data stream</a> in the <i>Database Migration Service User Guide.</i> </p>
        kafka_settings: <p>Settings in JSON format for the target Apache Kafka endpoint. For more information about the available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html#CHAP_Target.Kafka.ObjectMapping">Using object mapping to migrate data to a Kafka topic</a> in the <i>Database Migration Service User Guide.</i> </p>
        elasticsearch_settings: <p>Settings in JSON format for the target OpenSearch endpoint. For more information about the available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Elasticsearch.html#CHAP_Target.Elasticsearch.Configuration">Extra Connection Attributes When Using OpenSearch as a Target for DMS</a> in the <i>Database Migration Service User Guide</i>.</p>
        neptune_settings: <p>Settings in JSON format for the target Amazon Neptune endpoint. For more information about the available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.EndpointSettings">Specifying graph-mapping rules using Gremlin and R2RML for Amazon Neptune as a target</a> in the <i>Database Migration Service User Guide.</i> </p>
        postgre_sql_settings: <p>Settings in JSON format for the source and target PostgreSQL endpoint. For information about other available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html#CHAP_Source.PostgreSQL.ConnectionAttrib">Extra connection attributes when using PostgreSQL as a source for DMS</a> and <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.PostgreSQL.html#CHAP_Target.PostgreSQL.ConnectionAttrib"> Extra connection attributes when using PostgreSQL as a target for DMS</a> in the <i>Database Migration Service User Guide.</i> </p>
        my_sql_settings: <p>Settings in JSON format for the source and target MySQL endpoint. For information about other available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MySQL.html#CHAP_Source.MySQL.ConnectionAttrib">Extra connection attributes when using MySQL as a source for DMS</a> and <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.MySQL.html#CHAP_Target.MySQL.ConnectionAttrib">Extra connection attributes when using a MySQL-compatible database as a target for DMS</a> in the <i>Database Migration Service User Guide.</i> </p>
        oracle_settings: <p>Settings in JSON format for the source and target Oracle endpoint. For information about other available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.ConnectionAttrib">Extra connection attributes when using Oracle as a source for DMS</a> and <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Oracle.html#CHAP_Target.Oracle.ConnectionAttrib"> Extra connection attributes when using Oracle as a target for DMS</a> in the <i>Database Migration Service User Guide.</i> </p>
        sybase_settings: <p>Settings in JSON format for the source and target SAP ASE endpoint. For information about other available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SAP.html#CHAP_Source.SAP.ConnectionAttrib">Extra connection attributes when using SAP ASE as a source for DMS</a> and <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SAP.html#CHAP_Target.SAP.ConnectionAttrib">Extra connection attributes when using SAP ASE as a target for DMS</a> in the <i>Database Migration Service User Guide.</i> </p>
        microsoft_sql_server_settings: <p>Settings in JSON format for the source and target Microsoft SQL Server endpoint. For information about other available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SQLServer.html#CHAP_Source.SQLServer.ConnectionAttrib">Extra connection attributes when using SQL Server as a source for DMS</a> and <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SQLServer.html#CHAP_Target.SQLServer.ConnectionAttrib"> Extra connection attributes when using SQL Server as a target for DMS</a> in the <i>Database Migration Service User Guide.</i> </p>
        ibm_db2_settings: <p>Settings in JSON format for the source IBM Db2 LUW endpoint. For information about other available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DB2.html#CHAP_Source.DB2.ConnectionAttrib">Extra connection attributes when using Db2 LUW as a source for DMS</a> in the <i>Database Migration Service User Guide.</i> </p>
        resource_identifier: <p>A friendly name for the resource identifier at the end of the <code>EndpointArn</code> response parameter that is returned in the created <code>Endpoint</code> object. The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as <code>Example-App-ARN1</code>. For example, this value might result in the <code>EndpointArn</code> value <code>arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1</code>. If you don't specify a <code>ResourceIdentifier</code> value, DMS generates a default identifier value for the end of <code>EndpointArn</code>.</p>
        redis_settings: <p>Settings in JSON format for the target Redis endpoint.</p>
        gcp_my_sql_settings: <p>Settings in JSON format for the source GCP MySQL endpoint.</p>
        timestream_settings: <p>Settings in JSON format for the target Amazon Timestream endpoint.</p>

    Raises:
        capo_database_migration_service.errors.access_denied_fault.AccessDeniedFault: <p>DMS was denied access to the endpoint. Check that the role is correctly configured.</p>
        capo_database_migration_service.errors.invalid_resource_state_fault.InvalidResourceStateFault: <p>The resource is in a state that prevents it from being used for database migration.</p>
        capo_database_migration_service.errors.kms_key_not_accessible_fault.KMSKeyNotAccessibleFault: <p>DMS cannot access the KMS key.</p>
        capo_database_migration_service.errors.resource_already_exists_fault.ResourceAlreadyExistsFault: <p>The resource you are attempting to create already exists.</p>
        capo_database_migration_service.errors.resource_not_found_fault.ResourceNotFoundFault: <p>The resource could not be found.</p>
        capo_database_migration_service.errors.resource_quota_exceeded_fault.ResourceQuotaExceededFault: <p>The quota for this resource quota has been exceeded.</p>
        capo_database_migration_service.errors.s3_access_denied_fault.S3AccessDeniedFault: <p>Insufficient privileges are preventing access to an Amazon S3 object.</p>
        capo_database_migration_service.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Create endpoint
        Creates an endpoint using the provided settings.

        >>> await client.create_endpoint(endpoint_identifier='test-endpoint-1', endpoint_type='source', engine_name='mysql', username='username', password='pasword', server_name='mydb.cx1llnox7iyx.us-west-2.rds.amazonaws.com', port=3306, database_name='testdb', extra_connection_attributes='', kms_key_id='arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd', tags=[{'Key': 'Acount', 'Value': '143327655'}], certificate_arn='', ssl_mode='require')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_database_migration_service.types.create_endpoint_message.CreateEndpointMessage]",
    ) -> AsyncOperationResponse[
        "capo_database_migration_service.types.create_endpoint_response.CreateEndpointResponse"
    ]:
        import capo_database_migration_service._operations.amazon_dm_sv20160101.create_endpoint

        (
            output,
            http_response,
        ) = await capo_database_migration_service._operations.amazon_dm_sv20160101.create_endpoint.async_create_endpoint(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_database_migration_service.types.create_endpoint_message.CreateEndpointMessage",
    ) -> dict[str, Any]:
        import capo_database_migration_service.types.create_endpoint_message

        return capo_database_migration_service.types.create_endpoint_message.redact_sensitive(
            input_
        )

    def _redact_output(
        output: "capo_database_migration_service.types.create_endpoint_response.CreateEndpointResponse",
    ) -> dict[str, Any]:
        import capo_database_migration_service.types.create_endpoint_response

        return capo_database_migration_service.types.create_endpoint_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "CreateEndpoint",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_database_migration_service.types.create_endpoint_message.CreateEndpointMessage = {
        "endpoint_identifier": endpoint_identifier,
        "endpoint_type": endpoint_type,
        "engine_name": engine_name,
    }
    if username is not None:
        input_["username"] = username
    if password is not None:
        input_["password"] = password
    if server_name is not None:
        input_["server_name"] = server_name
    if port is not None:
        input_["port"] = port
    if database_name is not None:
        input_["database_name"] = database_name
    if extra_connection_attributes is not None:
        input_["extra_connection_attributes"] = extra_connection_attributes
    if kms_key_id is not None:
        input_["kms_key_id"] = kms_key_id
    if tags is not None:
        input_["tags"] = tags
    if certificate_arn is not None:
        input_["certificate_arn"] = certificate_arn
    if ssl_mode is not None:
        input_["ssl_mode"] = ssl_mode
    if service_access_role_arn is not None:
        input_["service_access_role_arn"] = service_access_role_arn
    if external_table_definition is not None:
        input_["external_table_definition"] = external_table_definition
    if dynamo_db_settings is not None:
        input_["dynamo_db_settings"] = dynamo_db_settings
    if s3_settings is not None:
        input_["s3_settings"] = s3_settings
    if dms_transfer_settings is not None:
        input_["dms_transfer_settings"] = dms_transfer_settings
    if mongo_db_settings is not None:
        input_["mongo_db_settings"] = mongo_db_settings
    if kinesis_settings is not None:
        input_["kinesis_settings"] = kinesis_settings
    if kafka_settings is not None:
        input_["kafka_settings"] = kafka_settings
    if elasticsearch_settings is not None:
        input_["elasticsearch_settings"] = elasticsearch_settings
    if neptune_settings is not None:
        input_["neptune_settings"] = neptune_settings
    if redshift_settings is not None:
        input_["redshift_settings"] = redshift_settings
    if postgre_sql_settings is not None:
        input_["postgre_sql_settings"] = postgre_sql_settings
    if my_sql_settings is not None:
        input_["my_sql_settings"] = my_sql_settings
    if oracle_settings is not None:
        input_["oracle_settings"] = oracle_settings
    if sybase_settings is not None:
        input_["sybase_settings"] = sybase_settings
    if microsoft_sql_server_settings is not None:
        input_["microsoft_sql_server_settings"] = microsoft_sql_server_settings
    if ibm_db2_settings is not None:
        input_["ibm_db2_settings"] = ibm_db2_settings
    if resource_identifier is not None:
        input_["resource_identifier"] = resource_identifier
    if doc_db_settings is not None:
        input_["doc_db_settings"] = doc_db_settings
    if redis_settings is not None:
        input_["redis_settings"] = redis_settings
    if gcp_my_sql_settings is not None:
        input_["gcp_my_sql_settings"] = gcp_my_sql_settings
    if timestream_settings is not None:
        input_["timestream_settings"] = timestream_settings

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

create_endpoint async ¶

create_endpoint `async` ¶