| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ApiGatewayV2::Stage; | ||
| 3 | use Moose; | ||
| 4 | has AccessLogSettings => (is => 'ro', isa => 'Paws::ApiGatewayV2::AccessLogSettings', request_name => 'accessLogSettings', traits => ['NameInRequest']); | ||
| 5 | has ApiGatewayManaged => (is => 'ro', isa => 'Bool', request_name => 'apiGatewayManaged', traits => ['NameInRequest']); | ||
| 6 | has AutoDeploy => (is => 'ro', isa => 'Bool', request_name => 'autoDeploy', traits => ['NameInRequest']); | ||
| 7 | has ClientCertificateId => (is => 'ro', isa => 'Str', request_name => 'clientCertificateId', traits => ['NameInRequest']); | ||
| 8 | has CreatedDate => (is => 'ro', isa => 'Str', request_name => 'createdDate', traits => ['NameInRequest']); | ||
| 9 | has DefaultRouteSettings => (is => 'ro', isa => 'Paws::ApiGatewayV2::RouteSettings', request_name => 'defaultRouteSettings', traits => ['NameInRequest']); | ||
| 10 | has DeploymentId => (is => 'ro', isa => 'Str', request_name => 'deploymentId', traits => ['NameInRequest']); | ||
| 11 | has Description => (is => 'ro', isa => 'Str', request_name => 'description', traits => ['NameInRequest']); | ||
| 12 | has LastDeploymentStatusMessage => (is => 'ro', isa => 'Str', request_name => 'lastDeploymentStatusMessage', traits => ['NameInRequest']); | ||
| 13 | has LastUpdatedDate => (is => 'ro', isa => 'Str', request_name => 'lastUpdatedDate', traits => ['NameInRequest']); | ||
| 14 | has RouteSettings => (is => 'ro', isa => 'Paws::ApiGatewayV2::RouteSettingsMap', request_name => 'routeSettings', traits => ['NameInRequest']); | ||
| 15 | has StageName => (is => 'ro', isa => 'Str', request_name => 'stageName', traits => ['NameInRequest'], required => 1); | ||
| 16 | has StageVariables => (is => 'ro', isa => 'Paws::ApiGatewayV2::StageVariablesMap', request_name => 'stageVariables', traits => ['NameInRequest']); | ||
| 17 | has Tags => (is => 'ro', isa => 'Paws::ApiGatewayV2::Tags', request_name => 'tags', traits => ['NameInRequest']); | ||
| 18 | |||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::ApiGatewayV2::Stage | ||
| 26 | |||
| 27 | =head1 USAGE | ||
| 28 | |||
| 29 | This class represents one of two things: | ||
| 30 | |||
| 31 | =head3 Arguments in a call to a service | ||
| 32 | |||
| 33 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 34 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 35 | |||
| 36 | As an example, if Att1 is expected to be a Paws::ApiGatewayV2::Stage object: | ||
| 37 | |||
| 38 | $service_obj->Method(Att1 => { AccessLogSettings => $value, ..., Tags => $value }); | ||
| 39 | |||
| 40 | =head3 Results returned from an API call | ||
| 41 | |||
| 42 | Use accessors for each attribute. If Att1 is expected to be an Paws::ApiGatewayV2::Stage object: | ||
| 43 | |||
| 44 | $result = $service_obj->Method(...); | ||
| 45 | $result->Att1->AccessLogSettings | ||
| 46 | |||
| 47 | =head1 DESCRIPTION | ||
| 48 | |||
| 49 | Represents an API stage. | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 AccessLogSettings => L<Paws::ApiGatewayV2::AccessLogSettings> | ||
| 55 | |||
| 56 | Settings for logging access in this stage. | ||
| 57 | |||
| 58 | |||
| 59 | =head2 ApiGatewayManaged => Bool | ||
| 60 | |||
| 61 | Specifies whether a stage is managed by API Gateway. If you created an | ||
| 62 | API using quick create, the $default stage is managed by API Gateway. | ||
| 63 | You can't modify the $default stage. | ||
| 64 | |||
| 65 | |||
| 66 | =head2 AutoDeploy => Bool | ||
| 67 | |||
| 68 | Specifies whether updates to an API automatically trigger a new | ||
| 69 | deployment. The default value is false. | ||
| 70 | |||
| 71 | |||
| 72 | =head2 ClientCertificateId => Str | ||
| 73 | |||
| 74 | The identifier of a client certificate for a Stage. Supported only for | ||
| 75 | WebSocket APIs. | ||
| 76 | |||
| 77 | |||
| 78 | =head2 CreatedDate => Str | ||
| 79 | |||
| 80 | The timestamp when the stage was created. | ||
| 81 | |||
| 82 | |||
| 83 | =head2 DefaultRouteSettings => L<Paws::ApiGatewayV2::RouteSettings> | ||
| 84 | |||
| 85 | Default route settings for the stage. | ||
| 86 | |||
| 87 | |||
| 88 | =head2 DeploymentId => Str | ||
| 89 | |||
| 90 | The identifier of the Deployment that the Stage is associated with. | ||
| 91 | Can't be updated if autoDeploy is enabled. | ||
| 92 | |||
| 93 | |||
| 94 | =head2 Description => Str | ||
| 95 | |||
| 96 | The description of the stage. | ||
| 97 | |||
| 98 | |||
| 99 | =head2 LastDeploymentStatusMessage => Str | ||
| 100 | |||
| 101 | Describes the status of the last deployment of a stage. Supported only | ||
| 102 | for stages with autoDeploy enabled. | ||
| 103 | |||
| 104 | |||
| 105 | =head2 LastUpdatedDate => Str | ||
| 106 | |||
| 107 | The timestamp when the stage was last updated. | ||
| 108 | |||
| 109 | |||
| 110 | =head2 RouteSettings => L<Paws::ApiGatewayV2::RouteSettingsMap> | ||
| 111 | |||
| 112 | Route settings for the stage, by routeKey. | ||
| 113 | |||
| 114 | |||
| 115 | =head2 B<REQUIRED> StageName => Str | ||
| 116 | |||
| 117 | The name of the stage. | ||
| 118 | |||
| 119 | |||
| 120 | =head2 StageVariables => L<Paws::ApiGatewayV2::StageVariablesMap> | ||
| 121 | |||
| 122 | A map that defines the stage variables for a stage resource. Variable | ||
| 123 | names can have alphanumeric and underscore characters, and the values | ||
| 124 | must match [A-Za-z0-9-._~:/?#&=,]+. | ||
| 125 | |||
| 126 | |||
| 127 | =head2 Tags => L<Paws::ApiGatewayV2::Tags> | ||
| 128 | |||
| 129 | The collection of tags. Each tag element is associated with a given | ||
| 130 | resource. | ||
| 131 | |||
| 132 | |||
| 133 | |||
| 134 | =head1 SEE ALSO | ||
| 135 | |||
| 136 | This class forms part of L<Paws>, describing an object used in L<Paws::ApiGatewayV2> | ||
| 137 | |||
| 138 | =head1 BUGS and CONTRIBUTIONS | ||
| 139 | |||
| 140 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 141 | |||
| 142 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 143 | |||
| 144 | =cut | ||
| 145 |