| 1 | |||
| 2 | package Paws::DMS::CreateEndpoint; | ||
| 3 | use Moose; | ||
| 4 | has CertificateArn => (is => 'ro', isa => 'Str'); | ||
| 5 | has DatabaseName => (is => 'ro', isa => 'Str'); | ||
| 6 | has DmsTransferSettings => (is => 'ro', isa => 'Paws::DMS::DmsTransferSettings'); | ||
| 7 | has DocDbSettings => (is => 'ro', isa => 'Paws::DMS::DocDbSettings'); | ||
| 8 | has DynamoDbSettings => (is => 'ro', isa => 'Paws::DMS::DynamoDbSettings'); | ||
| 9 | has ElasticsearchSettings => (is => 'ro', isa => 'Paws::DMS::ElasticsearchSettings'); | ||
| 10 | has EndpointIdentifier => (is => 'ro', isa => 'Str', required => 1); | ||
| 11 | has EndpointType => (is => 'ro', isa => 'Str', required => 1); | ||
| 12 | has EngineName => (is => 'ro', isa => 'Str', required => 1); | ||
| 13 | has ExternalTableDefinition => (is => 'ro', isa => 'Str'); | ||
| 14 | has ExtraConnectionAttributes => (is => 'ro', isa => 'Str'); | ||
| 15 | has IBMDb2Settings => (is => 'ro', isa => 'Paws::DMS::IBMDb2Settings'); | ||
| 16 | has KafkaSettings => (is => 'ro', isa => 'Paws::DMS::KafkaSettings'); | ||
| 17 | has KinesisSettings => (is => 'ro', isa => 'Paws::DMS::KinesisSettings'); | ||
| 18 | has KmsKeyId => (is => 'ro', isa => 'Str'); | ||
| 19 | has MicrosoftSQLServerSettings => (is => 'ro', isa => 'Paws::DMS::MicrosoftSQLServerSettings'); | ||
| 20 | has MongoDbSettings => (is => 'ro', isa => 'Paws::DMS::MongoDbSettings'); | ||
| 21 | has MySQLSettings => (is => 'ro', isa => 'Paws::DMS::MySQLSettings'); | ||
| 22 | has NeptuneSettings => (is => 'ro', isa => 'Paws::DMS::NeptuneSettings'); | ||
| 23 | has OracleSettings => (is => 'ro', isa => 'Paws::DMS::OracleSettings'); | ||
| 24 | has Password => (is => 'ro', isa => 'Str'); | ||
| 25 | has Port => (is => 'ro', isa => 'Int'); | ||
| 26 | has PostgreSQLSettings => (is => 'ro', isa => 'Paws::DMS::PostgreSQLSettings'); | ||
| 27 | has RedshiftSettings => (is => 'ro', isa => 'Paws::DMS::RedshiftSettings'); | ||
| 28 | has ResourceIdentifier => (is => 'ro', isa => 'Str'); | ||
| 29 | has S3Settings => (is => 'ro', isa => 'Paws::DMS::S3Settings'); | ||
| 30 | has ServerName => (is => 'ro', isa => 'Str'); | ||
| 31 | has ServiceAccessRoleArn => (is => 'ro', isa => 'Str'); | ||
| 32 | has SslMode => (is => 'ro', isa => 'Str'); | ||
| 33 | has SybaseSettings => (is => 'ro', isa => 'Paws::DMS::SybaseSettings'); | ||
| 34 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::DMS::Tag]'); | ||
| 35 | has Username => (is => 'ro', isa => 'Str'); | ||
| 36 | |||
| 37 | use MooseX::ClassAttribute; | ||
| 38 | |||
| 39 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateEndpoint'); | ||
| 40 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DMS::CreateEndpointResponse'); | ||
| 41 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 42 | 1; | ||
| 43 | |||
| 44 | ### main pod documentation begin ### | ||
| 45 | |||
| 46 | =head1 NAME | ||
| 47 | |||
| 48 | Paws::DMS::CreateEndpoint - Arguments for method CreateEndpoint on L<Paws::DMS> | ||
| 49 | |||
| 50 | =head1 DESCRIPTION | ||
| 51 | |||
| 52 | This class represents the parameters used for calling the method CreateEndpoint on the | ||
| 53 | L<AWS Database Migration Service|Paws::DMS> service. Use the attributes of this class | ||
| 54 | as arguments to method CreateEndpoint. | ||
| 55 | |||
| 56 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateEndpoint. | ||
| 57 | |||
| 58 | =head1 SYNOPSIS | ||
| 59 | |||
| 60 | my $dms = Paws->service('DMS'); | ||
| 61 | # Create endpoint | ||
| 62 | # Creates an endpoint using the provided settings. | ||
| 63 | my $CreateEndpointResponse = $dms->CreateEndpoint( | ||
| 64 | 'CertificateArn' => '', | ||
| 65 | 'DatabaseName' => 'testdb', | ||
| 66 | 'EndpointIdentifier' => 'test-endpoint-1', | ||
| 67 | 'EndpointType' => 'source', | ||
| 68 | 'EngineName' => 'mysql', | ||
| 69 | 'ExtraConnectionAttributes' => '', | ||
| 70 | 'KmsKeyId' => | ||
| 71 | 'arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd', | ||
| 72 | 'Password' => 'pasword', | ||
| 73 | 'Port' => 3306, | ||
| 74 | 'ServerName' => 'mydb.cx1llnox7iyx.us-west-2.rds.amazonaws.com', | ||
| 75 | 'SslMode' => 'require', | ||
| 76 | 'Tags' => [ | ||
| 77 | |||
| 78 | { | ||
| 79 | 'Key' => 'Acount', | ||
| 80 | 'Value' => 143327655 | ||
| 81 | } | ||
| 82 | ], | ||
| 83 | 'Username' => 'username' | ||
| 84 | ); | ||
| 85 | |||
| 86 | # Results: | ||
| 87 | my $Endpoint = $CreateEndpointResponse->Endpoint; | ||
| 88 | |||
| 89 | # Returns a L<Paws::DMS::CreateEndpointResponse> object. | ||
| 90 | |||
| 91 | 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. | ||
| 92 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/dms/CreateEndpoint> | ||
| 93 | |||
| 94 | =head1 ATTRIBUTES | ||
| 95 | |||
| 96 | |||
| 97 | =head2 CertificateArn => Str | ||
| 98 | |||
| 99 | The Amazon Resource Name (ARN) for the certificate. | ||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | =head2 DatabaseName => Str | ||
| 104 | |||
| 105 | The name of the endpoint database. | ||
| 106 | |||
| 107 | |||
| 108 | |||
| 109 | =head2 DmsTransferSettings => L<Paws::DMS::DmsTransferSettings> | ||
| 110 | |||
| 111 | The settings in JSON format for the DMS transfer type of source | ||
| 112 | endpoint. | ||
| 113 | |||
| 114 | Possible settings include the following: | ||
| 115 | |||
| 116 | =over | ||
| 117 | |||
| 118 | =item * | ||
| 119 | |||
| 120 | C<ServiceAccessRoleArn> - The IAM role that has permission to access | ||
| 121 | the Amazon S3 bucket. | ||
| 122 | |||
| 123 | =item * | ||
| 124 | |||
| 125 | C<BucketName> - The name of the S3 bucket to use. | ||
| 126 | |||
| 127 | =item * | ||
| 128 | |||
| 129 | C<CompressionType> - An optional parameter to use GZIP to compress the | ||
| 130 | target files. To use GZIP, set this value to C<NONE> (the default). To | ||
| 131 | keep the files uncompressed, don't use this value. | ||
| 132 | |||
| 133 | =back | ||
| 134 | |||
| 135 | Shorthand syntax for these settings is as follows: | ||
| 136 | C<ServiceAccessRoleArn=string,BucketName=string,CompressionType=string> | ||
| 137 | |||
| 138 | JSON syntax for these settings is as follows: C<{ | ||
| 139 | "ServiceAccessRoleArn": "string", "BucketName": "string", | ||
| 140 | "CompressionType": "none"|"gzip" }> | ||
| 141 | |||
| 142 | |||
| 143 | |||
| 144 | =head2 DocDbSettings => L<Paws::DMS::DocDbSettings> | ||
| 145 | |||
| 146 | |||
| 147 | |||
| 148 | |||
| 149 | |||
| 150 | =head2 DynamoDbSettings => L<Paws::DMS::DynamoDbSettings> | ||
| 151 | |||
| 152 | Settings in JSON format for the target Amazon DynamoDB endpoint. For | ||
| 153 | information about other available settings, see Using Object Mapping to | ||
| 154 | Migrate Data to DynamoDB | ||
| 155 | (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DynamoDB.html) | ||
| 156 | in the I<AWS Database Migration Service User Guide.> | ||
| 157 | |||
| 158 | |||
| 159 | |||
| 160 | =head2 ElasticsearchSettings => L<Paws::DMS::ElasticsearchSettings> | ||
| 161 | |||
| 162 | Settings in JSON format for the target Elasticsearch endpoint. For more | ||
| 163 | information about the available settings, see Extra Connection | ||
| 164 | Attributes When Using Elasticsearch as a Target for AWS DMS | ||
| 165 | (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Elasticsearch.html#CHAP_Target.Elasticsearch.Configuration) | ||
| 166 | in the I<AWS Database Migration Service User Guide>. | ||
| 167 | |||
| 168 | |||
| 169 | |||
| 170 | =head2 B<REQUIRED> EndpointIdentifier => Str | ||
| 171 | |||
| 172 | The database endpoint identifier. Identifiers must begin with a letter | ||
| 173 | and must contain only ASCII letters, digits, and hyphens. They can't | ||
| 174 | end with a hyphen, or contain two consecutive hyphens. | ||
| 175 | |||
| 176 | |||
| 177 | |||
| 178 | =head2 B<REQUIRED> EndpointType => Str | ||
| 179 | |||
| 180 | The type of endpoint. Valid values are C<source> and C<target>. | ||
| 181 | |||
| 182 | Valid values are: C<"source">, C<"target"> | ||
| 183 | |||
| 184 | =head2 B<REQUIRED> EngineName => Str | ||
| 185 | |||
| 186 | The type of engine for the endpoint. Valid values, depending on the | ||
| 187 | C<EndpointType> value, include C<"mysql">, C<"oracle">, C<"postgres">, | ||
| 188 | C<"mariadb">, C<"aurora">, C<"aurora-postgresql">, C<"redshift">, | ||
| 189 | C<"s3">, C<"db2">, C<"azuredb">, C<"sybase">, C<"dynamodb">, | ||
| 190 | C<"mongodb">, C<"kinesis">, C<"kafka">, C<"elasticsearch">, C<"docdb">, | ||
| 191 | C<"sqlserver">, and C<"neptune">. | ||
| 192 | |||
| 193 | |||
| 194 | |||
| 195 | =head2 ExternalTableDefinition => Str | ||
| 196 | |||
| 197 | The external table definition. | ||
| 198 | |||
| 199 | |||
| 200 | |||
| 201 | =head2 ExtraConnectionAttributes => Str | ||
| 202 | |||
| 203 | Additional attributes associated with the connection. Each attribute is | ||
| 204 | specified as a name-value pair associated by an equal sign (=). | ||
| 205 | Multiple attributes are separated by a semicolon (;) with no additional | ||
| 206 | white space. For information on the attributes available for connecting | ||
| 207 | your source or target endpoint, see Working with AWS DMS Endpoints | ||
| 208 | (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.html) | ||
| 209 | in the I<AWS Database Migration Service User Guide.> | ||
| 210 | |||
| 211 | |||
| 212 | |||
| 213 | =head2 IBMDb2Settings => L<Paws::DMS::IBMDb2Settings> | ||
| 214 | |||
| 215 | Settings in JSON format for the source IBM Db2 LUW endpoint. For | ||
| 216 | information about other available settings, see Extra connection | ||
| 217 | attributes when using Db2 LUW as a source for AWS DMS | ||
| 218 | (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DB2.html) | ||
| 219 | in the I<AWS Database Migration Service User Guide.> | ||
| 220 | |||
| 221 | |||
| 222 | |||
| 223 | =head2 KafkaSettings => L<Paws::DMS::KafkaSettings> | ||
| 224 | |||
| 225 | Settings in JSON format for the target Apache Kafka endpoint. For more | ||
| 226 | information about the available settings, see Using Apache Kafka as a | ||
| 227 | Target for AWS Database Migration Service | ||
| 228 | (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html) | ||
| 229 | in the I<AWS Database Migration Service User Guide.> | ||
| 230 | |||
| 231 | |||
| 232 | |||
| 233 | =head2 KinesisSettings => L<Paws::DMS::KinesisSettings> | ||
| 234 | |||
| 235 | Settings in JSON format for the target endpoint for Amazon Kinesis Data | ||
| 236 | Streams. For more information about the available settings, see Using | ||
| 237 | Amazon Kinesis Data Streams as a Target for AWS Database Migration | ||
| 238 | Service | ||
| 239 | (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html) | ||
| 240 | in the I<AWS Database Migration Service User Guide.> | ||
| 241 | |||
| 242 | |||
| 243 | |||
| 244 | =head2 KmsKeyId => Str | ||
| 245 | |||
| 246 | An AWS KMS key identifier that is used to encrypt the connection | ||
| 247 | parameters for the endpoint. | ||
| 248 | |||
| 249 | If you don't specify a value for the C<KmsKeyId> parameter, then AWS | ||
| 250 | DMS uses your default encryption key. | ||
| 251 | |||
| 252 | AWS KMS creates the default encryption key for your AWS account. Your | ||
| 253 | AWS account has a different default encryption key for each AWS Region. | ||
| 254 | |||
| 255 | |||
| 256 | |||
| 257 | =head2 MicrosoftSQLServerSettings => L<Paws::DMS::MicrosoftSQLServerSettings> | ||
| 258 | |||
| 259 | Settings in JSON format for the source and target Microsoft SQL Server | ||
| 260 | endpoint. For information about other available settings, see Extra | ||
| 261 | connection attributes when using SQL Server as a source for AWS DMS | ||
| 262 | (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SQLServer.html) | ||
| 263 | and Extra connection attributes when using SQL Server as a target for | ||
| 264 | AWS DMS | ||
| 265 | (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SQLServer.html) | ||
| 266 | in the I<AWS Database Migration Service User Guide.> | ||
| 267 | |||
| 268 | |||
| 269 | |||
| 270 | =head2 MongoDbSettings => L<Paws::DMS::MongoDbSettings> | ||
| 271 | |||
| 272 | Settings in JSON format for the source MongoDB endpoint. For more | ||
| 273 | information about the available settings, see Using MongoDB as a Target | ||
| 274 | for AWS Database Migration Service | ||
| 275 | (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MongoDB.html#CHAP_Source.MongoDB.Configuration) | ||
| 276 | in the I<AWS Database Migration Service User Guide.> | ||
| 277 | |||
| 278 | |||
| 279 | |||
| 280 | =head2 MySQLSettings => L<Paws::DMS::MySQLSettings> | ||
| 281 | |||
| 282 | Settings in JSON format for the source and target MySQL endpoint. For | ||
| 283 | information about other available settings, see Extra connection | ||
| 284 | attributes when using MySQL as a source for AWS DMS | ||
| 285 | (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MySQL.html) | ||
| 286 | and Extra connection attributes when using a MySQL-compatible database | ||
| 287 | as a target for AWS DMS | ||
| 288 | (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.MySQL.html) | ||
| 289 | in the I<AWS Database Migration Service User Guide.> | ||
| 290 | |||
| 291 | |||
| 292 | |||
| 293 | =head2 NeptuneSettings => L<Paws::DMS::NeptuneSettings> | ||
| 294 | |||
| 295 | Settings in JSON format for the target Amazon Neptune endpoint. For | ||
| 296 | more information about the available settings, see Specifying Endpoint | ||
| 297 | Settings for Amazon Neptune as a Target | ||
| 298 | (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.EndpointSettings) | ||
| 299 | in the I<AWS Database Migration Service User Guide.> | ||
| 300 | |||
| 301 | |||
| 302 | |||
| 303 | =head2 OracleSettings => L<Paws::DMS::OracleSettings> | ||
| 304 | |||
| 305 | Settings in JSON format for the source and target Oracle endpoint. For | ||
| 306 | information about other available settings, see Extra connection | ||
| 307 | attributes when using Oracle as a source for AWS DMS | ||
| 308 | (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html) | ||
| 309 | and Extra connection attributes when using Oracle as a target for AWS | ||
| 310 | DMS | ||
| 311 | (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Oracle.html) | ||
| 312 | in the I<AWS Database Migration Service User Guide.> | ||
| 313 | |||
| 314 | |||
| 315 | |||
| 316 | =head2 Password => Str | ||
| 317 | |||
| 318 | The password to be used to log in to the endpoint database. | ||
| 319 | |||
| 320 | |||
| 321 | |||
| 322 | =head2 Port => Int | ||
| 323 | |||
| 324 | The port used by the endpoint database. | ||
| 325 | |||
| 326 | |||
| 327 | |||
| 328 | =head2 PostgreSQLSettings => L<Paws::DMS::PostgreSQLSettings> | ||
| 329 | |||
| 330 | Settings in JSON format for the source and target PostgreSQL endpoint. | ||
| 331 | For information about other available settings, see Extra connection | ||
| 332 | attributes when using PostgreSQL as a source for AWS DMS | ||
| 333 | (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html) | ||
| 334 | and Extra connection attributes when using PostgreSQL as a target for | ||
| 335 | AWS DMS | ||
| 336 | (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.PostgreSQL.html) | ||
| 337 | in the I<AWS Database Migration Service User Guide.> | ||
| 338 | |||
| 339 | |||
| 340 | |||
| 341 | =head2 RedshiftSettings => L<Paws::DMS::RedshiftSettings> | ||
| 342 | |||
| 343 | |||
| 344 | |||
| 345 | |||
| 346 | |||
| 347 | =head2 ResourceIdentifier => Str | ||
| 348 | |||
| 349 | A friendly name for the resource identifier at the end of the | ||
| 350 | C<EndpointArn> response parameter that is returned in the created | ||
| 351 | C<Endpoint> object. The value for this parameter can have up to 31 | ||
| 352 | characters. It can contain only ASCII letters, digits, and hyphen | ||
| 353 | ('-'). Also, it can't end with a hyphen or contain two consecutive | ||
| 354 | hyphens, and can only begin with a letter, such as C<Example-App-ARN1>. | ||
| 355 | For example, this value might result in the C<EndpointArn> value | ||
| 356 | C<arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1>. If you | ||
| 357 | don't specify a C<ResourceIdentifier> value, AWS DMS generates a | ||
| 358 | default identifier value for the end of C<EndpointArn>. | ||
| 359 | |||
| 360 | |||
| 361 | |||
| 362 | =head2 S3Settings => L<Paws::DMS::S3Settings> | ||
| 363 | |||
| 364 | Settings in JSON format for the target Amazon S3 endpoint. For more | ||
| 365 | information about the available settings, see Extra Connection | ||
| 366 | Attributes When Using Amazon S3 as a Target for AWS DMS | ||
| 367 | (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring) | ||
| 368 | in the I<AWS Database Migration Service User Guide.> | ||
| 369 | |||
| 370 | |||
| 371 | |||
| 372 | =head2 ServerName => Str | ||
| 373 | |||
| 374 | The name of the server where the endpoint database resides. | ||
| 375 | |||
| 376 | |||
| 377 | |||
| 378 | =head2 ServiceAccessRoleArn => Str | ||
| 379 | |||
| 380 | The Amazon Resource Name (ARN) for the service access role that you | ||
| 381 | want to use to create the endpoint. | ||
| 382 | |||
| 383 | |||
| 384 | |||
| 385 | =head2 SslMode => Str | ||
| 386 | |||
| 387 | The Secure Sockets Layer (SSL) mode to use for the SSL connection. The | ||
| 388 | default is C<none> | ||
| 389 | |||
| 390 | Valid values are: C<"none">, C<"require">, C<"verify-ca">, C<"verify-full"> | ||
| 391 | |||
| 392 | =head2 SybaseSettings => L<Paws::DMS::SybaseSettings> | ||
| 393 | |||
| 394 | Settings in JSON format for the source and target SAP ASE endpoint. For | ||
| 395 | information about other available settings, see Extra connection | ||
| 396 | attributes when using SAP ASE as a source for AWS DMS | ||
| 397 | (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SAP.html) | ||
| 398 | and Extra connection attributes when using SAP ASE as a target for AWS | ||
| 399 | DMS | ||
| 400 | (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SAP.html) | ||
| 401 | in the I<AWS Database Migration Service User Guide.> | ||
| 402 | |||
| 403 | |||
| 404 | |||
| 405 | =head2 Tags => ArrayRef[L<Paws::DMS::Tag>] | ||
| 406 | |||
| 407 | One or more tags to be assigned to the endpoint. | ||
| 408 | |||
| 409 | |||
| 410 | |||
| 411 | =head2 Username => Str | ||
| 412 | |||
| 413 | The user name to be used to log in to the endpoint database. | ||
| 414 | |||
| 415 | |||
| 416 | |||
| 417 | |||
| 418 | =head1 SEE ALSO | ||
| 419 | |||
| 420 | This class forms part of L<Paws>, documenting arguments for method CreateEndpoint in L<Paws::DMS> | ||
| 421 | |||
| 422 | =head1 BUGS and CONTRIBUTIONS | ||
| 423 | |||
| 424 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 425 | |||
| 426 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 427 | |||
| 428 | =cut | ||
| 429 |