« blib/lib/Paws/DMS/ModifyReplicationSubnetGroupResponse.pm
↑ Summary
blib/lib/Paws/DMS/ModifyReplicationTaskResponse.pm »
| 1 | |||
| 2 | package Paws::DMS::ModifyReplicationTask; | ||
| 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'); | ||
| 8 | has ReplicationTaskArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has ReplicationTaskIdentifier => (is => 'ro', isa => 'Str'); | ||
| 10 | has ReplicationTaskSettings => (is => 'ro', isa => 'Str'); | ||
| 11 | has TableMappings => (is => 'ro', isa => 'Str'); | ||
| 12 | has TaskData => (is => 'ro', isa => 'Str'); | ||
| 13 | |||
| 14 | use MooseX::ClassAttribute; | ||
| 15 | |||
| 16 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ModifyReplicationTask'); | ||
| 17 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DMS::ModifyReplicationTaskResponse'); | ||
| 18 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::DMS::ModifyReplicationTask - Arguments for method ModifyReplicationTask on L<Paws::DMS> | ||
| 26 | |||
| 27 | =head1 DESCRIPTION | ||
| 28 | |||
| 29 | This class represents the parameters used for calling the method ModifyReplicationTask on the | ||
| 30 | L<AWS Database Migration Service|Paws::DMS> service. Use the attributes of this class | ||
| 31 | as arguments to method ModifyReplicationTask. | ||
| 32 | |||
| 33 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ModifyReplicationTask. | ||
| 34 | |||
| 35 | =head1 SYNOPSIS | ||
| 36 | |||
| 37 | my $dms = Paws->service('DMS'); | ||
| 38 | my $ModifyReplicationTaskResponse = $dms->ModifyReplicationTask( | ||
| 39 | ReplicationTaskArn => 'MyString', | ||
| 40 | CdcStartPosition => 'MyString', # OPTIONAL | ||
| 41 | CdcStartTime => '1970-01-01T01:00:00', # OPTIONAL | ||
| 42 | CdcStopPosition => 'MyString', # OPTIONAL | ||
| 43 | MigrationType => 'full-load', # OPTIONAL | ||
| 44 | ReplicationTaskIdentifier => 'MyString', # OPTIONAL | ||
| 45 | ReplicationTaskSettings => 'MyString', # OPTIONAL | ||
| 46 | TableMappings => 'MyString', # OPTIONAL | ||
| 47 | TaskData => 'MyString', # OPTIONAL | ||
| 48 | ); | ||
| 49 | |||
| 50 | # Results: | ||
| 51 | my $ReplicationTask = $ModifyReplicationTaskResponse->ReplicationTask; | ||
| 52 | |||
| 53 | # Returns a L<Paws::DMS::ModifyReplicationTaskResponse> object. | ||
| 54 | |||
| 55 | 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. | ||
| 56 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/dms/ModifyReplicationTask> | ||
| 57 | |||
| 58 | =head1 ATTRIBUTES | ||
| 59 | |||
| 60 | |||
| 61 | =head2 CdcStartPosition => Str | ||
| 62 | |||
| 63 | Indicates when you want a change data capture (CDC) operation to start. | ||
| 64 | Use either CdcStartPosition or CdcStartTime to specify when you want a | ||
| 65 | CDC operation to start. Specifying both values results in an error. | ||
| 66 | |||
| 67 | The value can be in date, checkpoint, or LSN/SCN format. | ||
| 68 | |||
| 69 | Date Example: --cdc-start-position E<ldquo>2018-03-08T12:12:12E<rdquo> | ||
| 70 | |||
| 71 | Checkpoint Example: --cdc-start-position | ||
| 72 | "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93" | ||
| 73 | |||
| 74 | LSN Example: --cdc-start-position | ||
| 75 | E<ldquo>mysql-bin-changelog.000024:373E<rdquo> | ||
| 76 | |||
| 77 | When you use this task setting with a source PostgreSQL database, a | ||
| 78 | logical replication slot should already be created and associated with | ||
| 79 | the source endpoint. You can verify this by setting the C<slotName> | ||
| 80 | extra connection attribute to the name of this logical replication | ||
| 81 | slot. For more information, see Extra Connection Attributes When Using | ||
| 82 | PostgreSQL as a Source for AWS DMS | ||
| 83 | (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html#CHAP_Source.PostgreSQL.ConnectionAttrib). | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | =head2 CdcStartTime => Str | ||
| 88 | |||
| 89 | Indicates the start time for a change data capture (CDC) operation. Use | ||
| 90 | either CdcStartTime or CdcStartPosition to specify when you want a CDC | ||
| 91 | operation to start. Specifying both values results in an error. | ||
| 92 | |||
| 93 | Timestamp Example: --cdc-start-time E<ldquo>2018-03-08T12:12:12E<rdquo> | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head2 CdcStopPosition => Str | ||
| 98 | |||
| 99 | Indicates when you want a change data capture (CDC) operation to stop. | ||
| 100 | The value can be either server time or commit time. | ||
| 101 | |||
| 102 | Server time example: --cdc-stop-position | ||
| 103 | E<ldquo>server_time:2018-02-09T12:12:12E<rdquo> | ||
| 104 | |||
| 105 | Commit time example: --cdc-stop-position E<ldquo>commit_time: | ||
| 106 | 2018-02-09T12:12:12 E<ldquo> | ||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | =head2 MigrationType => Str | ||
| 111 | |||
| 112 | The migration type. Valid values: C<full-load> | C<cdc> | | ||
| 113 | C<full-load-and-cdc> | ||
| 114 | |||
| 115 | Valid values are: C<"full-load">, C<"cdc">, C<"full-load-and-cdc"> | ||
| 116 | |||
| 117 | =head2 B<REQUIRED> ReplicationTaskArn => Str | ||
| 118 | |||
| 119 | The Amazon Resource Name (ARN) of the replication task. | ||
| 120 | |||
| 121 | |||
| 122 | |||
| 123 | =head2 ReplicationTaskIdentifier => Str | ||
| 124 | |||
| 125 | The replication task identifier. | ||
| 126 | |||
| 127 | Constraints: | ||
| 128 | |||
| 129 | =over | ||
| 130 | |||
| 131 | =item * | ||
| 132 | |||
| 133 | Must contain 1-255 alphanumeric characters or hyphens. | ||
| 134 | |||
| 135 | =item * | ||
| 136 | |||
| 137 | First character must be a letter. | ||
| 138 | |||
| 139 | =item * | ||
| 140 | |||
| 141 | Cannot end with a hyphen or contain two consecutive hyphens. | ||
| 142 | |||
| 143 | =back | ||
| 144 | |||
| 145 | |||
| 146 | |||
| 147 | |||
| 148 | =head2 ReplicationTaskSettings => Str | ||
| 149 | |||
| 150 | JSON file that contains settings for the task, such as task metadata | ||
| 151 | settings. | ||
| 152 | |||
| 153 | |||
| 154 | |||
| 155 | =head2 TableMappings => Str | ||
| 156 | |||
| 157 | When using the AWS CLI or boto3, provide the path of the JSON file that | ||
| 158 | contains the table mappings. Precede the path with C<file://>. For | ||
| 159 | example, C<--table-mappings file://mappingfile.json>. When working with | ||
| 160 | the DMS API, provide the JSON as the parameter value. | ||
| 161 | |||
| 162 | |||
| 163 | |||
| 164 | =head2 TaskData => Str | ||
| 165 | |||
| 166 | Supplemental information that the task requires to migrate the data for | ||
| 167 | certain source and target endpoints. For more information, see | ||
| 168 | Specifying Supplemental Data for Task Settings | ||
| 169 | (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.TaskData.html) | ||
| 170 | in the I<AWS Database Migration Service User Guide.> | ||
| 171 | |||
| 172 | |||
| 173 | |||
| 174 | |||
| 175 | =head1 SEE ALSO | ||
| 176 | |||
| 177 | This class forms part of L<Paws>, documenting arguments for method ModifyReplicationTask in L<Paws::DMS> | ||
| 178 | |||
| 179 | =head1 BUGS and CONTRIBUTIONS | ||
| 180 | |||
| 181 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 182 | |||
| 183 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 184 | |||
| 185 | =cut | ||
| 186 |