The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
57 ++
/ Paws::DMS::CreateEndpoint

NAME

Paws::DMS::CreateEndpoint - Arguments for method CreateEndpoint on Paws::DMS

DESCRIPTION

This class represents the parameters used for calling the method CreateEndpoint on the AWS Database Migration Service service. Use the attributes of this class as arguments to method CreateEndpoint.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateEndpoint.

SYNOPSIS

    my $dms = Paws->service('DMS');
    # Create endpoint
    # Creates an endpoint using the provided settings.
    my $CreateEndpointResponse = $dms->CreateEndpoint(
      'CertificateArn'            => '',
      'DatabaseName'              => 'testdb',
      'EndpointIdentifier'        => 'test-endpoint-1',
      'EndpointType'              => 'source',
      'EngineName'                => 'mysql',
      'ExtraConnectionAttributes' => '',
      'KmsKeyId'                  =>
'arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd',
      'Password'   => 'pasword',
      'Port'       => 3306,
      'ServerName' => 'mydb.cx1llnox7iyx.us-west-2.rds.amazonaws.com',
      'SslMode'    => 'require',
      'Tags'       => [

        {
          'Key'   => 'Acount',
          'Value' => 143327655
        }
      ],
      'Username' => 'username'
    );

    # Results:
    my $Endpoint = $CreateEndpointResponse->Endpoint;

    # Returns a L<Paws::DMS::CreateEndpointResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/dms/CreateEndpoint

ATTRIBUTES

CertificateArn => Str

The Amazon Resource Name (ARN) for the certificate.

DatabaseName => Str

The name of the endpoint database.

DmsTransferSettings => Paws::DMS::DmsTransferSettings

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

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

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

DocDbSettings => Paws::DMS::DocDbSettings

DynamoDbSettings => Paws::DMS::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 (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DynamoDB.html) in the AWS Database Migration Service User Guide.

ElasticsearchSettings => Paws::DMS::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 (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Elasticsearch.html#CHAP_Target.Elasticsearch.Configuration) in the AWS Database Migration Service User Guide.

REQUIRED EndpointIdentifier => Str

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.

REQUIRED EndpointType => Str

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

Valid values are: "source", "target"

REQUIRED EngineName => Str

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", "kinesis", "kafka", "elasticsearch", "docdb", "sqlserver", and "neptune".

ExternalTableDefinition => Str

The external table definition.

ExtraConnectionAttributes => Str

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 AWS DMS Endpoints (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.html) in the AWS Database Migration Service User Guide.

IBMDb2Settings => Paws::DMS::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 AWS DMS (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DB2.html) in the AWS Database Migration Service User Guide.

KafkaSettings => Paws::DMS::KafkaSettings

Settings in JSON format for the target Apache Kafka endpoint. For more information about the available settings, see Using Apache Kafka as a Target for AWS Database Migration Service (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html) in the AWS Database Migration Service User Guide.

KinesisSettings => Paws::DMS::KinesisSettings

Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about the available settings, see Using Amazon Kinesis Data Streams as a Target for AWS Database Migration Service (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html) in the AWS Database Migration Service User Guide.

KmsKeyId => Str

An AWS 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 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.

MicrosoftSQLServerSettings => Paws::DMS::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 AWS DMS (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SQLServer.html) and Extra connection attributes when using SQL Server as a target for AWS DMS (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SQLServer.html) in the AWS Database Migration Service User Guide.

MongoDbSettings => Paws::DMS::MongoDbSettings

Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see Using MongoDB as a Target for AWS Database Migration Service (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MongoDB.html#CHAP_Source.MongoDB.Configuration) in the AWS Database Migration Service User Guide.

MySQLSettings => Paws::DMS::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 AWS DMS (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MySQL.html) and Extra connection attributes when using a MySQL-compatible database as a target for AWS DMS (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.MySQL.html) in the AWS Database Migration Service User Guide.

NeptuneSettings => Paws::DMS::NeptuneSettings

Settings in JSON format for the target Amazon Neptune endpoint. For more information about the available settings, see Specifying Endpoint Settings for Amazon Neptune as a Target (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.EndpointSettings) in the AWS Database Migration Service User Guide.

OracleSettings => Paws::DMS::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 AWS DMS (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html) and Extra connection attributes when using Oracle as a target for AWS DMS (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Oracle.html) in the AWS Database Migration Service User Guide.

Password => Str

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

Port => Int

The port used by the endpoint database.

PostgreSQLSettings => Paws::DMS::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 AWS DMS (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html) and Extra connection attributes when using PostgreSQL as a target for AWS DMS (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.PostgreSQL.html) in the AWS Database Migration Service User Guide.

RedshiftSettings => Paws::DMS::RedshiftSettings

ResourceIdentifier => Str

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, AWS DMS generates a default identifier value for the end of EndpointArn.

S3Settings => Paws::DMS::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 (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring) in the AWS Database Migration Service User Guide.

ServerName => Str

The name of the server where the endpoint database resides.

ServiceAccessRoleArn => Str

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

SslMode => Str

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

Valid values are: "none", "require", "verify-ca", "verify-full"

SybaseSettings => Paws::DMS::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 AWS DMS (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SAP.html) and Extra connection attributes when using SAP ASE as a target for AWS DMS (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SAP.html) in the AWS Database Migration Service User Guide.

Tags => ArrayRef[Paws::DMS::Tag]

One or more tags to be assigned to the endpoint.

Username => Str

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

SEE ALSO

This class forms part of Paws, documenting arguments for method CreateEndpoint in Paws::DMS

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues