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