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');
my $CreateEndpointResponse = $dms->CreateEndpoint(
EndpointIdentifier => 'MyString',
EndpointType => 'source',
EngineName => 'MyString',
CertificateArn => 'MyString', # OPTIONAL
DatabaseName => 'MyString', # OPTIONAL
DmsTransferSettings => {
BucketName => 'MyString',
ServiceAccessRoleArn => 'MyString',
}, # OPTIONAL
DynamoDbSettings => {
ServiceAccessRoleArn => 'MyString',
}, # OPTIONAL
ElasticsearchSettings => {
EndpointUri => 'MyString',
ServiceAccessRoleArn => 'MyString',
ErrorRetryDuration => 1, # OPTIONAL
FullLoadErrorPercentage => 1, # OPTIONAL
}, # OPTIONAL
ExternalTableDefinition => 'MyString', # OPTIONAL
ExtraConnectionAttributes => 'MyString', # OPTIONAL
KinesisSettings => {
MessageFormat => 'json', # values: json; OPTIONAL
ServiceAccessRoleArn => 'MyString',
StreamArn => 'MyString',
}, # OPTIONAL
KmsKeyId => 'MyString', # OPTIONAL
MongoDbSettings => {
AuthMechanism =>
'default', # values: default, mongodb_cr, scram_sha_1; OPTIONAL
AuthSource => 'MyString',
AuthType => 'no', # values: no, password; OPTIONAL
DatabaseName => 'MyString',
DocsToInvestigate => 'MyString',
ExtractDocId => 'MyString',
KmsKeyId => 'MyString',
NestingLevel => 'none', # values: none, one; OPTIONAL
Password => 'MySecretString', # OPTIONAL
Port => 1, # OPTIONAL
ServerName => 'MyString',
Username => 'MyString',
}, # OPTIONAL
Password => 'MySecretString', # OPTIONAL
Port => 1, # OPTIONAL
RedshiftSettings => {
AcceptAnyDate => 1, # OPTIONAL
AfterConnectScript => 'MyString',
BucketFolder => 'MyString',
BucketName => 'MyString',
ConnectionTimeout => 1, # OPTIONAL
DatabaseName => 'MyString',
DateFormat => 'MyString',
EmptyAsNull => 1, # OPTIONAL
EncryptionMode => 'sse-s3', # values: sse-s3, sse-kms; OPTIONAL
FileTransferUploadStreams => 1, # OPTIONAL
LoadTimeout => 1, # OPTIONAL
MaxFileSize => 1, # OPTIONAL
Password => 'MySecretString', # OPTIONAL
Port => 1, # OPTIONAL
RemoveQuotes => 1, # OPTIONAL
ReplaceChars => 'MyString',
ReplaceInvalidChars => 'MyString',
ServerName => 'MyString',
ServerSideEncryptionKmsKeyId => 'MyString',
ServiceAccessRoleArn => 'MyString',
TimeFormat => 'MyString',
TrimBlanks => 1, # OPTIONAL
TruncateColumns => 1, # OPTIONAL
Username => 'MyString',
WriteBufferSize => 1, # OPTIONAL
}, # OPTIONAL
S3Settings => {
BucketFolder => 'MyString',
BucketName => 'MyString',
CdcInsertsOnly => 1, # OPTIONAL
CompressionType => 'none', # values: none, gzip; OPTIONAL
CsvDelimiter => 'MyString',
CsvRowDelimiter => 'MyString',
DataFormat => 'csv', # values: csv, parquet; OPTIONAL
DataPageSize => 1, # OPTIONAL
DictPageSizeLimit => 1, # OPTIONAL
EnableStatistics => 1, # OPTIONAL
EncodingType =>
'plain', # values: plain, plain-dictionary, rle-dictionary; OPTIONAL
EncryptionMode => 'sse-s3', # values: sse-s3, sse-kms; OPTIONAL
ExternalTableDefinition => 'MyString',
IncludeOpForFullLoad => 1, # OPTIONAL
ParquetTimestampInMillisecond => 1, # OPTIONAL
ParquetVersion =>
'parquet-1-0', # values: parquet-1-0, parquet-2-0; OPTIONAL
RowGroupLength => 1, # OPTIONAL
ServerSideEncryptionKmsKeyId => 'MyString',
ServiceAccessRoleArn => 'MyString',
TimestampColumnName => 'MyString',
}, # OPTIONAL
ServerName => 'MyString', # OPTIONAL
ServiceAccessRoleArn => 'MyString', # OPTIONAL
SslMode => 'none', # OPTIONAL
Tags => [
{
Key => 'MyString',
Value => 'MyString',
},
...
], # OPTIONAL
Username => 'MyString', # OPTIONAL
);
# 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 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" }
DynamoDbSettings => Paws::DMS::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 (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 User Guide.
REQUIRED EndpointIdentifier => Str
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.
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, and sqlserver.
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.
KinesisSettings => Paws::DMS::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 (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html#CHAP_Target.Kinesis.ObjectMapping) in the AWS Database Migration 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.
MongoDbSettings => Paws::DMS::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 (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MongoDB.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.
RedshiftSettings => Paws::DMS::RedshiftSettings
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"
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