You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::DatabaseMigrationService::Types::CreateEndpointMessage

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateEndpointMessage as input to an Aws::Client method, you can use a vanilla Hash:

{
  endpoint_identifier: "String", # required
  endpoint_type: "source", # required, accepts source, target
  engine_name: "String", # required
  username: "String",
  password: "SecretString",
  server_name: "String",
  port: 1,
  database_name: "String",
  extra_connection_attributes: "String",
  kms_key_id: "String",
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
  certificate_arn: "String",
  ssl_mode: "none", # accepts none, require, verify-ca, verify-full
  service_access_role_arn: "String",
  external_table_definition: "String",
  dynamo_db_settings: {
    service_access_role_arn: "String", # required
  },
  s3_settings: {
    service_access_role_arn: "String",
    external_table_definition: "String",
    csv_row_delimiter: "String",
    csv_delimiter: "String",
    bucket_folder: "String",
    bucket_name: "String",
    compression_type: "none", # accepts none, gzip
  },
  dms_transfer_settings: {
    service_access_role_arn: "String",
    bucket_name: "String",
  },
  mongo_db_settings: {
    username: "String",
    password: "SecretString",
    server_name: "String",
    port: 1,
    database_name: "String",
    auth_type: "no", # accepts no, password
    auth_mechanism: "default", # accepts default, mongodb_cr, scram_sha_1
    nesting_level: "none", # accepts none, one
    extract_doc_id: "String",
    docs_to_investigate: "String",
    auth_source: "String",
    kms_key_id: "String",
  },
  kinesis_settings: {
    stream_arn: "String",
    message_format: "json", # accepts json
    service_access_role_arn: "String",
  },
  elasticsearch_settings: {
    service_access_role_arn: "String", # required
    endpoint_uri: "String", # required
    full_load_error_percentage: 1,
    error_retry_duration: 1,
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#certificate_arnString

The Amazon Resource Name (ARN) for the certificate.

Returns:

  • (String)

    The Amazon Resource Name (ARN) for the certificate.

#database_nameString

The name of the endpoint database.

Returns:

  • (String)

    The name of the endpoint database.

#dms_transfer_settingsTypes::DmsTransferSettings

The settings in JSON format for the DMS transfer type of source endpoint.

Possible attributes 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 attributes is as follows: ServiceAccessRoleArn=string,BucketName=string,CompressionType=string

JSON syntax for these attributes is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }

Returns:

#dynamo_db_settingsTypes::DynamoDbSettings

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

Returns:

#elasticsearch_settingsTypes::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 User Guide.

Returns:

#endpoint_identifierString

The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.

Returns:

  • (String)

    The database endpoint identifier.

#endpoint_typeString

The type of endpoint.

Possible values:

  • source
  • target

Returns:

  • (String)

    The type of endpoint.

#engine_nameString

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, and sqlserver.

Returns:

  • (String)

    The type of engine for the endpoint.

#external_table_definitionString

The external table definition.

Returns:

  • (String)

    The external table definition.

#extra_connection_attributesString

Additional attributes associated with the connection.

Returns:

  • (String)

    Additional attributes associated with the connection.

#kinesis_settingsTypes::KinesisSettings

Settings in JSON format for the target Amazon Kinesis Data Streams endpoint. For more information about the available settings, see Using Object Mapping to Migrate Data to a Kinesis Data Stream in the AWS Database Migration User Guide.

Returns:

#kms_key_idString

The AWS KMS key identifier to use to encrypt the connection parameters. 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.

Returns:

  • (String)

    The AWS KMS key identifier to use to encrypt the connection parameters.

#mongo_db_settingsTypes::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.

Returns:

#passwordString

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

Returns:

  • (String)

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

#portInteger

The port used by the endpoint database.

Returns:

  • (Integer)

    The port used by the endpoint database.

#s3_settingsTypes::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.

Returns:

#server_nameString

The name of the server where the endpoint database resides.

Returns:

  • (String)

    The name of the server where the endpoint database resides.

#service_access_role_arnString

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

Returns:

  • (String)

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

#ssl_modeString

The Secure Sockets Layer (SSL) mode to use for the SSL connection. The SSL mode can be one of four values: none, require, verify-ca, verify-full. The default value is none.

Possible values:

  • none
  • require
  • verify-ca
  • verify-full

Returns:

  • (String)

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

#tagsArray<Types::Tag>

Tags to be added to the endpoint.

Returns:

  • (Array<Types::Tag>)

    Tags to be added to the endpoint.

#usernameString

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

Returns:

  • (String)

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