NAME
Paws::DMS::Endpoint
USAGE
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->CertificateArnDESCRIPTION
Describes an endpoint of a database instance in response to operations such as the following:
CreateEndpointDescribeEndpointDescribeEndpointTypesModifyEndpoint
ATTRIBUTES
CertificateArn => Str
The Amazon Resource Name (ARN) used for SSL connection to the endpoint.
DatabaseName => Str
The name of the database at the endpoint.
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 toNONE(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
The settings for the DynamoDB target endpoint. For more information, see the DynamoDBSettings structure.
ElasticsearchSettings => Paws::DMS::ElasticsearchSettings
The settings for the Elasticsearch source endpoint. For more information, see the ElasticsearchSettings structure.
EndpointArn => Str
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
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.
EndpointType => Str
The type of endpoint. Valid values are source and target.
EngineDisplayName => Str
The expanded name for the engine name. For example, if the EngineName parameter is "aurora," this value would be "Amazon Aurora MySQL."
EngineName => Str
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".
ExternalId => Str
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.
ExternalTableDefinition => Str
The external table definition.
ExtraConnectionAttributes => Str
Additional connection attributes used to connect to the endpoint.
IBMDb2Settings => Paws::DMS::IBMDb2Settings
The settings for the IBM Db2 LUW source endpoint. For more information, see the IBMDb2Settings structure.
KafkaSettings => Paws::DMS::KafkaSettings
The settings for the Apache Kafka target endpoint. For more information, see the KafkaSettings structure.
KinesisSettings => Paws::DMS::KinesisSettings
The settings for the Amazon Kinesis target endpoint. For more information, see the KinesisSettings structure.
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
The settings for the Microsoft SQL Server source and target endpoint. For more information, see the MicrosoftSQLServerSettings structure.
MongoDbSettings => Paws::DMS::MongoDbSettings
The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings structure.
MySQLSettings => Paws::DMS::MySQLSettings
The settings for the MySQL source and target endpoint. For more information, see the MySQLSettings structure.
NeptuneSettings => Paws::DMS::NeptuneSettings
The settings for the Amazon Neptune target endpoint. For more information, see the NeptuneSettings structure.
OracleSettings => Paws::DMS::OracleSettings
The settings for the Oracle source and target endpoint. For more information, see the OracleSettings structure.
Port => Int
The port value used to access the endpoint.
PostgreSQLSettings => Paws::DMS::PostgreSQLSettings
The settings for the PostgreSQL source and target endpoint. For more information, see the PostgreSQLSettings structure.
RedshiftSettings => Paws::DMS::RedshiftSettings
Settings for the Amazon Redshift endpoint.
S3Settings => Paws::DMS::S3Settings
The settings for the S3 target endpoint. For more information, see the S3Settings structure.
ServerName => Str
The name of the server at the endpoint.
ServiceAccessRoleArn => Str
The Amazon Resource Name (ARN) used by the service access IAM role.
SslMode => Str
The SSL mode used to connect to the endpoint. The default value is none.
Status => Str
The status of the endpoint.
SybaseSettings => Paws::DMS::SybaseSettings
The settings for the SAP ASE source and target endpoint. For more information, see the SybaseSettings structure.
Username => Str
The user name used to connect to the endpoint.
SEE ALSO
This class forms part of Paws, describing an object used 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