aws_sdk_databasemigration::operation::create_endpoint

Struct CreateEndpointInput

#[non_exhaustive]
pub struct CreateEndpointInput {Show 35 fields
    pub endpoint_identifier: Option<String>,
    pub endpoint_type: Option<ReplicationEndpointTypeValue>,
    pub engine_name: Option<String>,
    pub username: Option<String>,
    pub password: Option<String>,
    pub server_name: Option<String>,
    pub port: Option<i32>,
    pub database_name: Option<String>,
    pub extra_connection_attributes: Option<String>,
    pub kms_key_id: Option<String>,
    pub tags: Option<Vec<Tag>>,
    pub certificate_arn: Option<String>,
    pub ssl_mode: Option<DmsSslModeValue>,
    pub service_access_role_arn: Option<String>,
    pub external_table_definition: Option<String>,
    pub dynamo_db_settings: Option<DynamoDbSettings>,
    pub s3_settings: Option<S3Settings>,
    pub dms_transfer_settings: Option<DmsTransferSettings>,
    pub mongo_db_settings: Option<MongoDbSettings>,
    pub kinesis_settings: Option<KinesisSettings>,
    pub kafka_settings: Option<KafkaSettings>,
    pub elasticsearch_settings: Option<ElasticsearchSettings>,
    pub neptune_settings: Option<NeptuneSettings>,
    pub redshift_settings: Option<RedshiftSettings>,
    pub postgre_sql_settings: Option<PostgreSqlSettings>,
    pub my_sql_settings: Option<MySqlSettings>,
    pub oracle_settings: Option<OracleSettings>,
    pub sybase_settings: Option<SybaseSettings>,
    pub microsoft_sql_server_settings: Option<MicrosoftSqlServerSettings>,
    pub ibm_db2_settings: Option<IbmDb2Settings>,
    pub resource_identifier: Option<String>,
    pub doc_db_settings: Option<DocDbSettings>,
    pub redis_settings: Option<RedisSettings>,
    pub gcp_my_sql_settings: Option<GcpMySqlSettings>,
    pub timestream_settings: Option<TimestreamSettings>,
}

Expand description

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

§endpoint_identifier: Option<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: Option<ReplicationEndpointTypeValue>

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

§engine_name: Option<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: Option<String>

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

§password: Option<String>

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

§server_name: Option<String>

The name of the server where the endpoint database resides.

§port: Option<i32>

The port used by the endpoint database.

§database_name: Option<String>

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: Option<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 DMS Endpoints in the Database Migration Service User Guide.

§kms_key_id: Option<String>

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: Option<Vec<Tag>>

One or more tags to be assigned to the endpoint.

§certificate_arn: Option<String>

The Amazon Resource Name (ARN) for the certificate.

§ssl_mode: Option<DmsSslModeValue>

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

§service_access_role_arn: Option<String>

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: Option<String>

The external table definition.

§dynamo_db_settings: Option<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 Database Migration Service User Guide.

§s3_settings: Option<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 DMS in the Database Migration Service User Guide.

§dms_transfer_settings: Option<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", }

§mongo_db_settings: Option<MongoDbSettings>

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: Option<KinesisSettings>

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: Option<KafkaSettings>

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: Option<ElasticsearchSettings>

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: Option<NeptuneSettings>

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.

§redshift_settings: Option<RedshiftSettings>

Provides information that defines an Amazon Redshift endpoint.

§postgre_sql_settings: Option<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 DMS and Extra connection attributes when using PostgreSQL as a target for DMS in the Database Migration Service User Guide.

§my_sql_settings: Option<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 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: Option<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 DMS and Extra connection attributes when using Oracle as a target for DMS in the Database Migration Service User Guide.

§sybase_settings: Option<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 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: Option<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 DMS and Extra connection attributes when using SQL Server as a target for DMS in the Database Migration Service User Guide.

§ibm_db2_settings: Option<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 DMS in the Database Migration Service User Guide.

§resource_identifier: Option<String>

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.

§doc_db_settings: Option<DocDbSettings>

Provides information that defines a DocumentDB endpoint.

§redis_settings: Option<RedisSettings>

Settings in JSON format for the target Redis endpoint.

§gcp_my_sql_settings: Option<GcpMySqlSettings>

Settings in JSON format for the source GCP MySQL endpoint.

§timestream_settings: Option<TimestreamSettings>

Settings in JSON format for the target Amazon Timestream endpoint.

Struct CreateEndpointInputCopy item path

Fields (Non-exhaustive)§

Implementations§

impl CreateEndpointInput

pub fn endpoint_identifier(&self) -> Option<&str>

pub fn endpoint_type(&self) -> Option<&ReplicationEndpointTypeValue>

pub fn engine_name(&self) -> Option<&str>

pub fn username(&self) -> Option<&str>

pub fn password(&self) -> Option<&str>

pub fn server_name(&self) -> Option<&str>

pub fn port(&self) -> Option<i32>

pub fn database_name(&self) -> Option<&str>

pub fn extra_connection_attributes(&self) -> Option<&str>

pub fn kms_key_id(&self) -> Option<&str>

pub fn tags(&self) -> &[Tag]

pub fn certificate_arn(&self) -> Option<&str>

pub fn ssl_mode(&self) -> Option<&DmsSslModeValue>

pub fn service_access_role_arn(&self) -> Option<&str>

pub fn external_table_definition(&self) -> Option<&str>

pub fn dynamo_db_settings(&self) -> Option<&DynamoDbSettings>

pub fn s3_settings(&self) -> Option<&S3Settings>

pub fn dms_transfer_settings(&self) -> Option<&DmsTransferSettings>

pub fn mongo_db_settings(&self) -> Option<&MongoDbSettings>

pub fn kinesis_settings(&self) -> Option<&KinesisSettings>

pub fn kafka_settings(&self) -> Option<&KafkaSettings>

pub fn elasticsearch_settings(&self) -> Option<&ElasticsearchSettings>

pub fn neptune_settings(&self) -> Option<&NeptuneSettings>

pub fn redshift_settings(&self) -> Option<&RedshiftSettings>

pub fn postgre_sql_settings(&self) -> Option<&PostgreSqlSettings>

pub fn my_sql_settings(&self) -> Option<&MySqlSettings>

pub fn oracle_settings(&self) -> Option<&OracleSettings>

pub fn sybase_settings(&self) -> Option<&SybaseSettings>

pub fn microsoft_sql_server_settings( &self, ) -> Option<&MicrosoftSqlServerSettings>

pub fn ibm_db2_settings(&self) -> Option<&IbmDb2Settings>

pub fn resource_identifier(&self) -> Option<&str>

pub fn doc_db_settings(&self) -> Option<&DocDbSettings>

pub fn redis_settings(&self) -> Option<&RedisSettings>

pub fn gcp_my_sql_settings(&self) -> Option<&GcpMySqlSettings>

pub fn timestream_settings(&self) -> Option<&TimestreamSettings>

impl CreateEndpointInput

pub fn builder() -> CreateEndpointInputBuilder

Trait Implementations§

impl Clone for CreateEndpointInput

fn clone(&self) -> CreateEndpointInput

fn clone_from(&mut self, source: &Self)

impl Debug for CreateEndpointInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

impl PartialEq for CreateEndpointInput

fn eq(&self, other: &CreateEndpointInput) -> bool

fn ne(&self, other: &Rhs) -> bool

impl StructuralPartialEq for CreateEndpointInput

Auto Trait Implementations§

impl Freeze for CreateEndpointInput

impl RefUnwindSafe for CreateEndpointInput

impl Send for CreateEndpointInput

impl Sync for CreateEndpointInput

impl Unpin for CreateEndpointInput

impl UnwindSafe for CreateEndpointInput

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> CloneToUninit for Twhere T: Clone,

unsafe fn clone_to_uninit(&self, dst: *mut u8)

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>where F: FnOnce(&Self) -> bool,

impl<Unshared, Shared> IntoShared<Shared> for Unsharedwhere Shared: FromUnshared<Unshared>,

fn into_shared(self) -> Shared

impl<T> Paint for Twhere T: ?Sized,

Struct CreateEndpointInput

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<T> CloneToUninit for T
where T: Clone,

impl<T, U> Into<U> for T
where U: From<T>,

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

impl<T> Paint for T
where T: ?Sized,