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
  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
  },
  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",
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#certificate_arnString

The Amazon Resource Number (ARN) for the certificate.

Returns:

  • (String)

    The Amazon Resource Number (ARN) for the certificate.

#database_nameString

The name of the endpoint database.

Returns:

  • (String)

    The name of the endpoint database.

#dynamo_db_settingsTypes::DynamoDbSettings

Settings in JSON format for the target Amazon DynamoDB endpoint. For more information about the available settings, see the Using Object Mapping to Migrate Data to DynamoDB section at Using an Amazon DynamoDB Database as a Target for AWS Database Migration Service.

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, include MYSQL, ORACLE, POSTGRES, MARIADB, AURORA, REDSHIFT, S3, SYBASE, DYNAMODB, MONGODB, and SQLSERVER.

Returns:

  • (String)

    The type of engine for the endpoint.

#extra_connection_attributesString

Additional attributes associated with the connection.

Returns:

  • (String)

    Additional attributes associated with the connection.

#kms_key_idString

The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use 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 KMS key identifier that will be used 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 When Using MongoDB as a Source for AWS Database Migration Service section at Using Amazon S3 as a Target for AWS Database Migration Service.

Returns:

#passwordString

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

Returns:

  • (String)

    The password to be used to login 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 S3 endpoint. For more information about the available settings, see the Extra Connection Attributes section at Using Amazon S3 as a Target for AWS Database Migration Service.

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.

#ssl_modeString

The SSL mode to use for the SSL connection.

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 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 login to the endpoint database.

Returns:

  • (String)

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