« blib/lib/Paws/DMS/CreateReplicationSubnetGroupResponse.pm
↑ Summary
blib/lib/Paws/DMS/CreateReplicationTaskResponse.pm »
| 1 | |||
| 2 | package Paws::DMS::CreateReplicationTask; | ||
| 3 | use Moose; | ||
| 4 | has CdcStartPosition => (is => 'ro', isa => 'Str'); | ||
| 5 | has CdcStartTime => (is => 'ro', isa => 'Str'); | ||
| 6 | has CdcStopPosition => (is => 'ro', isa => 'Str'); | ||
| 7 | has MigrationType => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has ReplicationInstanceArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has ReplicationTaskIdentifier => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | has ReplicationTaskSettings => (is => 'ro', isa => 'Str'); | ||
| 11 | has ResourceIdentifier => (is => 'ro', isa => 'Str'); | ||
| 12 | has SourceEndpointArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 13 | has TableMappings => (is => 'ro', isa => 'Str', required => 1); | ||
| 14 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::DMS::Tag]'); | ||
| 15 | has TargetEndpointArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 16 | has TaskData => (is => 'ro', isa => 'Str'); | ||
| 17 | |||
| 18 | use MooseX::ClassAttribute; | ||
| 19 | |||
| 20 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateReplicationTask'); | ||
| 21 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DMS::CreateReplicationTaskResponse'); | ||
| 22 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 23 | 1; | ||
| 24 | |||
| 25 | ### main pod documentation begin ### | ||
| 26 | |||
| 27 | =head1 NAME | ||
| 28 | |||
| 29 | Paws::DMS::CreateReplicationTask - Arguments for method CreateReplicationTask on L<Paws::DMS> | ||
| 30 | |||
| 31 | =head1 DESCRIPTION | ||
| 32 | |||
| 33 | This class represents the parameters used for calling the method CreateReplicationTask on the | ||
| 34 | L<AWS Database Migration Service|Paws::DMS> service. Use the attributes of this class | ||
| 35 | as arguments to method CreateReplicationTask. | ||
| 36 | |||
| 37 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateReplicationTask. | ||
| 38 | |||
| 39 | =head1 SYNOPSIS | ||
| 40 | |||
| 41 | my $dms = Paws->service('DMS'); | ||
| 42 | # Create replication task | ||
| 43 | # Creates a replication task using the specified parameters. | ||
| 44 | my $CreateReplicationTaskResponse = $dms->CreateReplicationTask( | ||
| 45 | 'CdcStartTime' => '2016-12-14T18:25:43Z', | ||
| 46 | 'MigrationType' => 'full-load', | ||
| 47 | 'ReplicationInstanceArn' => | ||
| 48 | 'arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ', | ||
| 49 | 'ReplicationTaskIdentifier' => 'task1', | ||
| 50 | 'ReplicationTaskSettings' => '', | ||
| 51 | 'SourceEndpointArn' => | ||
| 52 | 'arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE', | ||
| 53 | 'TableMappings' => 'file://mappingfile.json', | ||
| 54 | 'Tags' => [ | ||
| 55 | |||
| 56 | { | ||
| 57 | 'Key' => 'Acount', | ||
| 58 | 'Value' => 24352226 | ||
| 59 | } | ||
| 60 | ], | ||
| 61 | 'TargetEndpointArn' => | ||
| 62 | 'arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E' | ||
| 63 | ); | ||
| 64 | |||
| 65 | # Results: | ||
| 66 | my $ReplicationTask = $CreateReplicationTaskResponse->ReplicationTask; | ||
| 67 | |||
| 68 | # Returns a L<Paws::DMS::CreateReplicationTaskResponse> object. | ||
| 69 | |||
| 70 | 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. | ||
| 71 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/dms/CreateReplicationTask> | ||
| 72 | |||
| 73 | =head1 ATTRIBUTES | ||
| 74 | |||
| 75 | |||
| 76 | =head2 CdcStartPosition => Str | ||
| 77 | |||
| 78 | Indicates when you want a change data capture (CDC) operation to start. | ||
| 79 | Use either CdcStartPosition or CdcStartTime to specify when you want a | ||
| 80 | CDC operation to start. Specifying both values results in an error. | ||
| 81 | |||
| 82 | The value can be in date, checkpoint, or LSN/SCN format. | ||
| 83 | |||
| 84 | Date Example: --cdc-start-position E<ldquo>2018-03-08T12:12:12E<rdquo> | ||
| 85 | |||
| 86 | Checkpoint Example: --cdc-start-position | ||
| 87 | "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93" | ||
| 88 | |||
| 89 | LSN Example: --cdc-start-position | ||
| 90 | E<ldquo>mysql-bin-changelog.000024:373E<rdquo> | ||
| 91 | |||
| 92 | When you use this task setting with a source PostgreSQL database, a | ||
| 93 | logical replication slot should already be created and associated with | ||
| 94 | the source endpoint. You can verify this by setting the C<slotName> | ||
| 95 | extra connection attribute to the name of this logical replication | ||
| 96 | slot. For more information, see Extra Connection Attributes When Using | ||
| 97 | PostgreSQL as a Source for AWS DMS | ||
| 98 | (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html#CHAP_Source.PostgreSQL.ConnectionAttrib). | ||
| 99 | |||
| 100 | |||
| 101 | |||
| 102 | =head2 CdcStartTime => Str | ||
| 103 | |||
| 104 | Indicates the start time for a change data capture (CDC) operation. Use | ||
| 105 | either CdcStartTime or CdcStartPosition to specify when you want a CDC | ||
| 106 | operation to start. Specifying both values results in an error. | ||
| 107 | |||
| 108 | Timestamp Example: --cdc-start-time E<ldquo>2018-03-08T12:12:12E<rdquo> | ||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | =head2 CdcStopPosition => Str | ||
| 113 | |||
| 114 | Indicates when you want a change data capture (CDC) operation to stop. | ||
| 115 | The value can be either server time or commit time. | ||
| 116 | |||
| 117 | Server time example: --cdc-stop-position | ||
| 118 | E<ldquo>server_time:2018-02-09T12:12:12E<rdquo> | ||
| 119 | |||
| 120 | Commit time example: --cdc-stop-position E<ldquo>commit_time: | ||
| 121 | 2018-02-09T12:12:12 E<ldquo> | ||
| 122 | |||
| 123 | |||
| 124 | |||
| 125 | =head2 B<REQUIRED> MigrationType => Str | ||
| 126 | |||
| 127 | The migration type. Valid values: C<full-load> | C<cdc> | | ||
| 128 | C<full-load-and-cdc> | ||
| 129 | |||
| 130 | Valid values are: C<"full-load">, C<"cdc">, C<"full-load-and-cdc"> | ||
| 131 | |||
| 132 | =head2 B<REQUIRED> ReplicationInstanceArn => Str | ||
| 133 | |||
| 134 | The Amazon Resource Name (ARN) of a replication instance. | ||
| 135 | |||
| 136 | |||
| 137 | |||
| 138 | =head2 B<REQUIRED> ReplicationTaskIdentifier => Str | ||
| 139 | |||
| 140 | An identifier for the replication task. | ||
| 141 | |||
| 142 | Constraints: | ||
| 143 | |||
| 144 | =over | ||
| 145 | |||
| 146 | =item * | ||
| 147 | |||
| 148 | Must contain 1-255 alphanumeric characters or hyphens. | ||
| 149 | |||
| 150 | =item * | ||
| 151 | |||
| 152 | First character must be a letter. | ||
| 153 | |||
| 154 | =item * | ||
| 155 | |||
| 156 | Cannot end with a hyphen or contain two consecutive hyphens. | ||
| 157 | |||
| 158 | =back | ||
| 159 | |||
| 160 | |||
| 161 | |||
| 162 | |||
| 163 | =head2 ReplicationTaskSettings => Str | ||
| 164 | |||
| 165 | Overall settings for the task, in JSON format. For more information, | ||
| 166 | see Specifying Task Settings for AWS Database Migration Service Tasks | ||
| 167 | (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TaskSettings.html) | ||
| 168 | in the I<AWS Database Migration User Guide.> | ||
| 169 | |||
| 170 | |||
| 171 | |||
| 172 | =head2 ResourceIdentifier => Str | ||
| 173 | |||
| 174 | A friendly name for the resource identifier at the end of the | ||
| 175 | C<EndpointArn> response parameter that is returned in the created | ||
| 176 | C<Endpoint> object. The value for this parameter can have up to 31 | ||
| 177 | characters. It can contain only ASCII letters, digits, and hyphen | ||
| 178 | ('-'). Also, it can't end with a hyphen or contain two consecutive | ||
| 179 | hyphens, and can only begin with a letter, such as C<Example-App-ARN1>. | ||
| 180 | For example, this value might result in the C<EndpointArn> value | ||
| 181 | C<arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1>. If you | ||
| 182 | don't specify a C<ResourceIdentifier> value, AWS DMS generates a | ||
| 183 | default identifier value for the end of C<EndpointArn>. | ||
| 184 | |||
| 185 | |||
| 186 | |||
| 187 | =head2 B<REQUIRED> SourceEndpointArn => Str | ||
| 188 | |||
| 189 | An Amazon Resource Name (ARN) that uniquely identifies the source | ||
| 190 | endpoint. | ||
| 191 | |||
| 192 | |||
| 193 | |||
| 194 | =head2 B<REQUIRED> TableMappings => Str | ||
| 195 | |||
| 196 | The table mappings for the task, in JSON format. For more information, | ||
| 197 | see Using Table Mapping to Specify Task Settings | ||
| 198 | (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TableMapping.html) | ||
| 199 | in the I<AWS Database Migration Service User Guide.> | ||
| 200 | |||
| 201 | |||
| 202 | |||
| 203 | =head2 Tags => ArrayRef[L<Paws::DMS::Tag>] | ||
| 204 | |||
| 205 | One or more tags to be assigned to the replication task. | ||
| 206 | |||
| 207 | |||
| 208 | |||
| 209 | =head2 B<REQUIRED> TargetEndpointArn => Str | ||
| 210 | |||
| 211 | An Amazon Resource Name (ARN) that uniquely identifies the target | ||
| 212 | endpoint. | ||
| 213 | |||
| 214 | |||
| 215 | |||
| 216 | =head2 TaskData => Str | ||
| 217 | |||
| 218 | Supplemental information that the task requires to migrate the data for | ||
| 219 | certain source and target endpoints. For more information, see | ||
| 220 | Specifying Supplemental Data for Task Settings | ||
| 221 | (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.TaskData.html) | ||
| 222 | in the I<AWS Database Migration Service User Guide.> | ||
| 223 | |||
| 224 | |||
| 225 | |||
| 226 | |||
| 227 | =head1 SEE ALSO | ||
| 228 | |||
| 229 | This class forms part of L<Paws>, documenting arguments for method CreateReplicationTask in L<Paws::DMS> | ||
| 230 | |||
| 231 | =head1 BUGS and CONTRIBUTIONS | ||
| 232 | |||
| 233 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 234 | |||
| 235 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 236 | |||
| 237 | =cut | ||
| 238 |