NAME
Paws::DMS::ModifyEndpoint - Arguments for method ModifyEndpoint on Paws::DMS
DESCRIPTION
This class represents the parameters used for calling the method ModifyEndpoint on the AWS Database Migration Service service. Use the attributes of this class as arguments to method ModifyEndpoint.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ModifyEndpoint.
SYNOPSIS
my $dms = Paws->service('DMS');
my $ModifyEndpointResponse = $dms->ModifyEndpoint(
EndpointArn => '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
EndpointIdentifier => 'MyString', # OPTIONAL
EndpointType => 'source', # OPTIONAL
EngineName => 'MyString', # OPTIONAL
ExternalTableDefinition => 'MyString', # OPTIONAL
ExtraConnectionAttributes => 'MyString', # OPTIONAL
KinesisSettings => {
MessageFormat => 'json', # values: json; OPTIONAL
ServiceAccessRoleArn => 'MyString',
StreamArn => '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
Username => 'MyString', # OPTIONAL
);
# Results:
my $Endpoint = $ModifyEndpointResponse->Endpoint;
# Returns a L<Paws::DMS::ModifyEndpointResponse> 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/ModifyEndpoint
ATTRIBUTES
CertificateArn => Str
The Amazon Resource Name (ARN) of the certificate used for SSL connection.
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.
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" }
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 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; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.
EndpointType => Str
The type of endpoint. Valid values are source and target.
Valid values are: "source", "target"
EngineName => Str
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, dynamodb, mongodb, and sqlserver.
ExternalTableDefinition => Str
The external table definition.
ExtraConnectionAttributes => Str
Additional attributes associated with the connection. To reset this parameter, pass the empty string ("") as an argument.
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.
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 login 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 you want to use to modify the endpoint.
SslMode => Str
The SSL mode used to connect to the endpoint. The default value is none.
Valid values are: "none", "require", "verify-ca", "verify-full"
Username => Str
The user name to be used to login to the endpoint database.
SEE ALSO
This class forms part of Paws, documenting arguments for method ModifyEndpoint 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