GSP
Quick Navigator
Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Paws::DMS::Endpoint(3) User Contributed Perl Documentation Paws::DMS::Endpoint(3)

Paws::DMS::Endpoint

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::DMS::Endpoint object:

  $service_obj->Method(Att1 => { CertificateArn => $value, ..., Username => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::DMS::Endpoint object:

  $result = $service_obj->Method(...);
  $result->Att1->CertificateArn

Describes an endpoint of a database instance in response to operations such as the following:

  • "CreateEndpoint"
  • "DescribeEndpoint"
  • "DescribeEndpointTypes"
  • "ModifyEndpoint"

The Amazon Resource Name (ARN) used for SSL connection to the endpoint.

The name of the database at the endpoint.

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

The settings for the DynamoDB target endpoint. For more information, see the "DynamoDBSettings" structure.

The settings for the Elasticsearch source endpoint. For more information, see the "ElasticsearchSettings" structure.

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

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.

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

The expanded name for the engine name. For example, if the "EngineName" parameter is "aurora," this value would be "Amazon Aurora MySQL."

The database engine name. Valid values, depending on the EndpointType, include "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", "redshift", "s3", "db2", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "documentdb", "sqlserver", and "neptune".

Value returned by a call to CreateEndpoint that can be used for cross-account validation. Use it on a subsequent call to CreateEndpoint to create the endpoint with a cross-account.

The external table definition.

Additional connection attributes used to connect to the endpoint.

The settings for the IBM Db2 LUW source endpoint. For more information, see the "IBMDb2Settings" structure.

The settings for the Apache Kafka target endpoint. For more information, see the "KafkaSettings" structure.

The settings for the Amazon Kinesis target endpoint. For more information, see the "KinesisSettings" structure.

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.

The settings for the Microsoft SQL Server source and target endpoint. For more information, see the "MicrosoftSQLServerSettings" structure.

The settings for the MongoDB source endpoint. For more information, see the "MongoDbSettings" structure.

The settings for the MySQL source and target endpoint. For more information, see the "MySQLSettings" structure.

The settings for the Amazon Neptune target endpoint. For more information, see the "NeptuneSettings" structure.

The settings for the Oracle source and target endpoint. For more information, see the "OracleSettings" structure.

The port value used to access the endpoint.

The settings for the PostgreSQL source and target endpoint. For more information, see the "PostgreSQLSettings" structure.

Settings for the Amazon Redshift endpoint.

The settings for the S3 target endpoint. For more information, see the "S3Settings" structure.

The name of the server at the endpoint.

The Amazon Resource Name (ARN) used by the service access IAM role.

The SSL mode used to connect to the endpoint. The default value is "none".

The status of the endpoint.

The settings for the SAP ASE source and target endpoint. For more information, see the "SybaseSettings" structure.

The user name used to connect to the endpoint.

This class forms part of Paws, describing an object used in Paws::DMS

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>

2022-06-01 perl v5.40.2
Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.