« blib/lib/Paws/ApiGateway/BasePathMappings.pm
↑ Summary
blib/lib/Paws/ApiGateway/ClientCertificate.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ApiGateway::CanarySettings; | ||
| 3 | use Moose; | ||
| 4 | has DeploymentId => (is => 'ro', isa => 'Str', request_name => 'deploymentId', traits => ['NameInRequest']); | ||
| 5 | has PercentTraffic => (is => 'ro', isa => 'Num', request_name => 'percentTraffic', traits => ['NameInRequest']); | ||
| 6 | has StageVariableOverrides => (is => 'ro', isa => 'Paws::ApiGateway::MapOfStringToString', request_name => 'stageVariableOverrides', traits => ['NameInRequest']); | ||
| 7 | has UseStageCache => (is => 'ro', isa => 'Bool', request_name => 'useStageCache', traits => ['NameInRequest']); | ||
| 8 | |||
| 9 | 1; | ||
| 10 | |||
| 11 | ### main pod documentation begin ### | ||
| 12 | |||
| 13 | =head1 NAME | ||
| 14 | |||
| 15 | Paws::ApiGateway::CanarySettings | ||
| 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::ApiGateway::CanarySettings object: | ||
| 27 | |||
| 28 | $service_obj->Method(Att1 => { DeploymentId => $value, ..., UseStageCache => $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::ApiGateway::CanarySettings object: | ||
| 33 | |||
| 34 | $result = $service_obj->Method(...); | ||
| 35 | $result->Att1->DeploymentId | ||
| 36 | |||
| 37 | =head1 DESCRIPTION | ||
| 38 | |||
| 39 | Configuration settings of a canary deployment. | ||
| 40 | |||
| 41 | =head1 ATTRIBUTES | ||
| 42 | |||
| 43 | |||
| 44 | =head2 DeploymentId => Str | ||
| 45 | |||
| 46 | The ID of the canary deployment. | ||
| 47 | |||
| 48 | |||
| 49 | =head2 PercentTraffic => Num | ||
| 50 | |||
| 51 | The percent (0-100) of traffic diverted to a canary deployment. | ||
| 52 | |||
| 53 | |||
| 54 | =head2 StageVariableOverrides => L<Paws::ApiGateway::MapOfStringToString> | ||
| 55 | |||
| 56 | Stage variables overridden for a canary release deployment, including | ||
| 57 | new stage variables introduced in the canary. These stage variables are | ||
| 58 | represented as a string-to-string map between stage variable names and | ||
| 59 | their values. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 UseStageCache => Bool | ||
| 63 | |||
| 64 | A Boolean flag to indicate whether the canary deployment uses the stage | ||
| 65 | cache or not. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head1 SEE ALSO | ||
| 70 | |||
| 71 | This class forms part of L<Paws>, describing an object used in L<Paws::ApiGateway> | ||
| 72 | |||
| 73 | =head1 BUGS and CONTRIBUTIONS | ||
| 74 | |||
| 75 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 76 | |||
| 77 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 78 | |||
| 79 | =cut | ||
| 80 |