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

Class: Aws::DatabaseMigrationService::Types::ModifyEndpointMessage

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb

Overview

Note:

When making an API call, you may pass ModifyEndpointMessage data as a hash:

{
  endpoint_arn: "String", # required
  endpoint_identifier: "String",
  endpoint_type: "source", # accepts source, target
  engine_name: "String",
  username: "String",
  password: "SecretString",
  server_name: "String",
  port: 1,
  database_name: "String",
  extra_connection_attributes: "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) of the certificate used for SSL connection.

Returns:

  • (String)


2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2805

class ModifyEndpointMessage < Struct.new(
  :endpoint_arn,
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :username,
  :password,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :elasticsearch_settings)
  include Aws::Structure
end

#database_nameString

The name of the endpoint database.

Returns:

  • (String)


2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2805

class ModifyEndpointMessage < Struct.new(
  :endpoint_arn,
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :username,
  :password,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :elasticsearch_settings)
  include Aws::Structure
end

#dms_transfer_settingsTypes::DmsTransferSettings

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

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. Set to NONE (the default) or do not use to leave the files uncompressed.

Shorthand syntax: ServiceAccessRoleArn=string ,BucketName=string,CompressionType=string

JSON syntax:

\{ "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" \}



2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2805

class ModifyEndpointMessage < Struct.new(
  :endpoint_arn,
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :username,
  :password,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :elasticsearch_settings)
  include Aws::Structure
end

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



2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2805

class ModifyEndpointMessage < Struct.new(
  :endpoint_arn,
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :username,
  :password,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :elasticsearch_settings)
  include Aws::Structure
end

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



2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2805

class ModifyEndpointMessage < Struct.new(
  :endpoint_arn,
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :username,
  :password,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :elasticsearch_settings)
  include Aws::Structure
end

#endpoint_arnString

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

Returns:

  • (String)


2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2805

class ModifyEndpointMessage < Struct.new(
  :endpoint_arn,
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :username,
  :password,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :elasticsearch_settings)
  include Aws::Structure
end

#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)


2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2805

class ModifyEndpointMessage < Struct.new(
  :endpoint_arn,
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :username,
  :password,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :elasticsearch_settings)
  include Aws::Structure
end

#endpoint_typeString

The type of endpoint.

Returns:

  • (String)


2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2805

class ModifyEndpointMessage < Struct.new(
  :endpoint_arn,
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :username,
  :password,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :elasticsearch_settings)
  include Aws::Structure
end

#engine_nameString

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

Returns:

  • (String)


2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2805

class ModifyEndpointMessage < Struct.new(
  :endpoint_arn,
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :username,
  :password,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :elasticsearch_settings)
  include Aws::Structure
end

#external_table_definitionString

The external table definition.

Returns:

  • (String)


2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2805

class ModifyEndpointMessage < Struct.new(
  :endpoint_arn,
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :username,
  :password,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :elasticsearch_settings)
  include Aws::Structure
end

#extra_connection_attributesString

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

Returns:

  • (String)


2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2805

class ModifyEndpointMessage < Struct.new(
  :endpoint_arn,
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :username,
  :password,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :elasticsearch_settings)
  include Aws::Structure
end

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



2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2805

class ModifyEndpointMessage < Struct.new(
  :endpoint_arn,
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :username,
  :password,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :elasticsearch_settings)
  include Aws::Structure
end

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



2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2805

class ModifyEndpointMessage < Struct.new(
  :endpoint_arn,
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :username,
  :password,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :elasticsearch_settings)
  include Aws::Structure
end

#passwordString

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

Returns:

  • (String)


2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2805

class ModifyEndpointMessage < Struct.new(
  :endpoint_arn,
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :username,
  :password,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :elasticsearch_settings)
  include Aws::Structure
end

#portInteger

The port used by the endpoint database.

Returns:

  • (Integer)


2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2805

class ModifyEndpointMessage < Struct.new(
  :endpoint_arn,
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :username,
  :password,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :elasticsearch_settings)
  include Aws::Structure
end

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



2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2805

class ModifyEndpointMessage < Struct.new(
  :endpoint_arn,
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :username,
  :password,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :elasticsearch_settings)
  include Aws::Structure
end

#server_nameString

The name of the server where the endpoint database resides.

Returns:

  • (String)


2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2805

class ModifyEndpointMessage < Struct.new(
  :endpoint_arn,
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :username,
  :password,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :elasticsearch_settings)
  include Aws::Structure
end

#service_access_role_arnString

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

Returns:

  • (String)


2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2805

class ModifyEndpointMessage < Struct.new(
  :endpoint_arn,
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :username,
  :password,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :elasticsearch_settings)
  include Aws::Structure
end

#ssl_modeString

The SSL mode to be used.

SSL mode can be one of four values: none, require, verify-ca, verify-full.

The default value is none.

Returns:

  • (String)


2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2805

class ModifyEndpointMessage < Struct.new(
  :endpoint_arn,
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :username,
  :password,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :elasticsearch_settings)
  include Aws::Structure
end

#usernameString

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

Returns:

  • (String)


2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 2805

class ModifyEndpointMessage < Struct.new(
  :endpoint_arn,
  :endpoint_identifier,
  :endpoint_type,
  :engine_name,
  :username,
  :password,
  :server_name,
  :port,
  :database_name,
  :extra_connection_attributes,
  :certificate_arn,
  :ssl_mode,
  :service_access_role_arn,
  :external_table_definition,
  :dynamo_db_settings,
  :s3_settings,
  :dms_transfer_settings,
  :mongo_db_settings,
  :kinesis_settings,
  :elasticsearch_settings)
  include Aws::Structure
end