« blib/lib/Paws/KinesisAnalyticsV2/CheckpointConfigurationDescription.pm
↑ Summary
blib/lib/Paws/KinesisAnalyticsV2/CloudWatchLoggingOption.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::KinesisAnalyticsV2::CheckpointConfigurationUpdate; | ||
| 3 | use Moose; | ||
| 4 | has CheckpointingEnabledUpdate => (is => 'ro', isa => 'Bool'); | ||
| 5 | has CheckpointIntervalUpdate => (is => 'ro', isa => 'Int'); | ||
| 6 | has ConfigurationTypeUpdate => (is => 'ro', isa => 'Str'); | ||
| 7 | has MinPauseBetweenCheckpointsUpdate => (is => 'ro', isa => 'Int'); | ||
| 8 | |||
| 9 | 1; | ||
| 10 | |||
| 11 | ### main pod documentation begin ### | ||
| 12 | |||
| 13 | =head1 NAME | ||
| 14 | |||
| 15 | Paws::KinesisAnalyticsV2::CheckpointConfigurationUpdate | ||
| 16 | |||
| 17 | =head1 USAGE | ||
| 18 | |||
| 19 | This class represents one of two things: | ||
| 20 | |||
| 21 | =head3 Arguments in a call to a service | ||
| 22 | |||
| 23 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 24 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 25 | |||
| 26 | As an example, if Att1 is expected to be a Paws::KinesisAnalyticsV2::CheckpointConfigurationUpdate object: | ||
| 27 | |||
| 28 | $service_obj->Method(Att1 => { CheckpointingEnabledUpdate => $value, ..., MinPauseBetweenCheckpointsUpdate => $value }); | ||
| 29 | |||
| 30 | =head3 Results returned from an API call | ||
| 31 | |||
| 32 | Use accessors for each attribute. If Att1 is expected to be an Paws::KinesisAnalyticsV2::CheckpointConfigurationUpdate object: | ||
| 33 | |||
| 34 | $result = $service_obj->Method(...); | ||
| 35 | $result->Att1->CheckpointingEnabledUpdate | ||
| 36 | |||
| 37 | =head1 DESCRIPTION | ||
| 38 | |||
| 39 | Describes updates to the checkpointing parameters for a Flink-based | ||
| 40 | Kinesis Data Analytics application. | ||
| 41 | |||
| 42 | =head1 ATTRIBUTES | ||
| 43 | |||
| 44 | |||
| 45 | =head2 CheckpointingEnabledUpdate => Bool | ||
| 46 | |||
| 47 | Describes updates to whether checkpointing is enabled for an | ||
| 48 | application. | ||
| 49 | |||
| 50 | If C<CheckpointConfiguration.ConfigurationType> is C<DEFAULT>, the | ||
| 51 | application will use a C<CheckpointingEnabled> value of C<true>, even | ||
| 52 | if this value is set to another value using this API or in application | ||
| 53 | code. | ||
| 54 | |||
| 55 | |||
| 56 | =head2 CheckpointIntervalUpdate => Int | ||
| 57 | |||
| 58 | Describes updates to the interval in milliseconds between checkpoint | ||
| 59 | operations. | ||
| 60 | |||
| 61 | If C<CheckpointConfiguration.ConfigurationType> is C<DEFAULT>, the | ||
| 62 | application will use a C<CheckpointInterval> value of 60000, even if | ||
| 63 | this value is set to another value using this API or in application | ||
| 64 | code. | ||
| 65 | |||
| 66 | |||
| 67 | =head2 ConfigurationTypeUpdate => Str | ||
| 68 | |||
| 69 | Describes updates to whether the application uses the default | ||
| 70 | checkpointing behavior of Kinesis Data Analytics. You must set this | ||
| 71 | property to C<CUSTOM> in order to set the C<CheckpointingEnabled>, | ||
| 72 | C<CheckpointInterval>, or C<MinPauseBetweenCheckpoints> parameters. | ||
| 73 | |||
| 74 | If this value is set to C<DEFAULT>, the application will use the | ||
| 75 | following values, even if they are set to other values using APIs or | ||
| 76 | application code: | ||
| 77 | |||
| 78 | =over | ||
| 79 | |||
| 80 | =item * | ||
| 81 | |||
| 82 | B<CheckpointingEnabled:> true | ||
| 83 | |||
| 84 | =item * | ||
| 85 | |||
| 86 | B<CheckpointInterval:> 60000 | ||
| 87 | |||
| 88 | =item * | ||
| 89 | |||
| 90 | B<MinPauseBetweenCheckpoints:> 5000 | ||
| 91 | |||
| 92 | =back | ||
| 93 | |||
| 94 | |||
| 95 | |||
| 96 | =head2 MinPauseBetweenCheckpointsUpdate => Int | ||
| 97 | |||
| 98 | Describes updates to the minimum time in milliseconds after a | ||
| 99 | checkpoint operation completes that a new checkpoint operation can | ||
| 100 | start. | ||
| 101 | |||
| 102 | If C<CheckpointConfiguration.ConfigurationType> is C<DEFAULT>, the | ||
| 103 | application will use a C<MinPauseBetweenCheckpoints> value of 5000, | ||
| 104 | even if this value is set using this API or in application code. | ||
| 105 | |||
| 106 | |||
| 107 | |||
| 108 | =head1 SEE ALSO | ||
| 109 | |||
| 110 | This class forms part of L<Paws>, describing an object used in L<Paws::KinesisAnalyticsV2> | ||
| 111 | |||
| 112 | =head1 BUGS and CONTRIBUTIONS | ||
| 113 | |||
| 114 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 115 | |||
| 116 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 117 | |||
| 118 | =cut | ||
| 119 |