« blib/lib/Paws/ApiGatewayV2/CreateRouteResponseShape.pm
↑ Summary
blib/lib/Paws/ApiGatewayV2/CreateStageInput.pm »
| 1 | |||
| 2 | package Paws::ApiGatewayV2::CreateStage; | ||
| 3 | use Moose; | ||
| 4 | has AccessLogSettings => (is => 'ro', isa => 'Paws::ApiGatewayV2::AccessLogSettings', traits => ['NameInRequest'], request_name => 'accessLogSettings'); | ||
| 5 | has ApiId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'apiId', required => 1); | ||
| 6 | has AutoDeploy => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'autoDeploy'); | ||
| 7 | has ClientCertificateId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'clientCertificateId'); | ||
| 8 | has DefaultRouteSettings => (is => 'ro', isa => 'Paws::ApiGatewayV2::RouteSettings', traits => ['NameInRequest'], request_name => 'defaultRouteSettings'); | ||
| 9 | has DeploymentId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'deploymentId'); | ||
| 10 | has Description => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'description'); | ||
| 11 | has RouteSettings => (is => 'ro', isa => 'Paws::ApiGatewayV2::RouteSettingsMap', traits => ['NameInRequest'], request_name => 'routeSettings'); | ||
| 12 | has StageName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'stageName', required => 1); | ||
| 13 | has StageVariables => (is => 'ro', isa => 'Paws::ApiGatewayV2::StageVariablesMap', traits => ['NameInRequest'], request_name => 'stageVariables'); | ||
| 14 | has Tags => (is => 'ro', isa => 'Paws::ApiGatewayV2::Tags', traits => ['NameInRequest'], request_name => 'tags'); | ||
| 15 | |||
| 16 | use MooseX::ClassAttribute; | ||
| 17 | |||
| 18 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateStage'); | ||
| 19 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v2/apis/{apiId}/stages'); | ||
| 20 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 21 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ApiGatewayV2::CreateStageResponse'); | ||
| 22 | 1; | ||
| 23 | |||
| 24 | ### main pod documentation begin ### | ||
| 25 | |||
| 26 | =head1 NAME | ||
| 27 | |||
| 28 | Paws::ApiGatewayV2::CreateStage - Arguments for method CreateStage on L<Paws::ApiGatewayV2> | ||
| 29 | |||
| 30 | =head1 DESCRIPTION | ||
| 31 | |||
| 32 | This class represents the parameters used for calling the method CreateStage on the | ||
| 33 | L<AmazonApiGatewayV2|Paws::ApiGatewayV2> service. Use the attributes of this class | ||
| 34 | as arguments to method CreateStage. | ||
| 35 | |||
| 36 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateStage. | ||
| 37 | |||
| 38 | =head1 SYNOPSIS | ||
| 39 | |||
| 40 | my $apigateway = Paws->service('ApiGatewayV2'); | ||
| 41 | my $CreateStageResponse = $apigateway->CreateStage( | ||
| 42 | ApiId => 'My__string', | ||
| 43 | StageName => 'MyStringWithLengthBetween1And128', | ||
| 44 | AccessLogSettings => { | ||
| 45 | DestinationArn => 'MyArn', # OPTIONAL | ||
| 46 | Format => 'MyStringWithLengthBetween1And1024', # OPTIONAL | ||
| 47 | }, # OPTIONAL | ||
| 48 | AutoDeploy => 1, # OPTIONAL | ||
| 49 | ClientCertificateId => 'MyId', # OPTIONAL | ||
| 50 | DefaultRouteSettings => { | ||
| 51 | DataTraceEnabled => 1, | ||
| 52 | DetailedMetricsEnabled => 1, | ||
| 53 | LoggingLevel => 'ERROR', # values: ERROR, INFO, OFF; OPTIONAL | ||
| 54 | ThrottlingBurstLimit => 1, # OPTIONAL | ||
| 55 | ThrottlingRateLimit => 1, # OPTIONAL | ||
| 56 | }, # OPTIONAL | ||
| 57 | DeploymentId => 'MyId', # OPTIONAL | ||
| 58 | Description => 'MyStringWithLengthBetween0And1024', # OPTIONAL | ||
| 59 | RouteSettings => { | ||
| 60 | 'My__string' => { | ||
| 61 | DataTraceEnabled => 1, | ||
| 62 | DetailedMetricsEnabled => 1, | ||
| 63 | LoggingLevel => 'ERROR', # values: ERROR, INFO, OFF; OPTIONAL | ||
| 64 | ThrottlingBurstLimit => 1, # OPTIONAL | ||
| 65 | ThrottlingRateLimit => 1, # OPTIONAL | ||
| 66 | }, | ||
| 67 | }, # OPTIONAL | ||
| 68 | StageVariables => | ||
| 69 | { 'My__string' => 'MyStringWithLengthBetween0And2048', }, # OPTIONAL | ||
| 70 | Tags => { 'My__string' => 'MyStringWithLengthBetween1And1600', } | ||
| 71 | , # OPTIONAL | ||
| 72 | ); | ||
| 73 | |||
| 74 | # Results: | ||
| 75 | my $AccessLogSettings = $CreateStageResponse->AccessLogSettings; | ||
| 76 | my $ApiGatewayManaged = $CreateStageResponse->ApiGatewayManaged; | ||
| 77 | my $AutoDeploy = $CreateStageResponse->AutoDeploy; | ||
| 78 | my $ClientCertificateId = $CreateStageResponse->ClientCertificateId; | ||
| 79 | my $CreatedDate = $CreateStageResponse->CreatedDate; | ||
| 80 | my $DefaultRouteSettings = $CreateStageResponse->DefaultRouteSettings; | ||
| 81 | my $DeploymentId = $CreateStageResponse->DeploymentId; | ||
| 82 | my $Description = $CreateStageResponse->Description; | ||
| 83 | my $LastDeploymentStatusMessage = | ||
| 84 | $CreateStageResponse->LastDeploymentStatusMessage; | ||
| 85 | my $LastUpdatedDate = $CreateStageResponse->LastUpdatedDate; | ||
| 86 | my $RouteSettings = $CreateStageResponse->RouteSettings; | ||
| 87 | my $StageName = $CreateStageResponse->StageName; | ||
| 88 | my $StageVariables = $CreateStageResponse->StageVariables; | ||
| 89 | my $Tags = $CreateStageResponse->Tags; | ||
| 90 | |||
| 91 | # Returns a L<Paws::ApiGatewayV2::CreateStageResponse> object. | ||
| 92 | |||
| 93 | 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. | ||
| 94 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/apigateway/CreateStage> | ||
| 95 | |||
| 96 | =head1 ATTRIBUTES | ||
| 97 | |||
| 98 | |||
| 99 | =head2 AccessLogSettings => L<Paws::ApiGatewayV2::AccessLogSettings> | ||
| 100 | |||
| 101 | Settings for logging access in this stage. | ||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head2 B<REQUIRED> ApiId => Str | ||
| 106 | |||
| 107 | The API identifier. | ||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | =head2 AutoDeploy => Bool | ||
| 112 | |||
| 113 | Specifies whether updates to an API automatically trigger a new | ||
| 114 | deployment. The default value is false. | ||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | =head2 ClientCertificateId => Str | ||
| 119 | |||
| 120 | The identifier of a client certificate for a Stage. Supported only for | ||
| 121 | WebSocket APIs. | ||
| 122 | |||
| 123 | |||
| 124 | |||
| 125 | =head2 DefaultRouteSettings => L<Paws::ApiGatewayV2::RouteSettings> | ||
| 126 | |||
| 127 | The default route settings for the stage. | ||
| 128 | |||
| 129 | |||
| 130 | |||
| 131 | =head2 DeploymentId => Str | ||
| 132 | |||
| 133 | The deployment identifier of the API stage. | ||
| 134 | |||
| 135 | |||
| 136 | |||
| 137 | =head2 Description => Str | ||
| 138 | |||
| 139 | The description for the API stage. | ||
| 140 | |||
| 141 | |||
| 142 | |||
| 143 | =head2 RouteSettings => L<Paws::ApiGatewayV2::RouteSettingsMap> | ||
| 144 | |||
| 145 | Route settings for the stage, by routeKey. | ||
| 146 | |||
| 147 | |||
| 148 | |||
| 149 | =head2 B<REQUIRED> StageName => Str | ||
| 150 | |||
| 151 | The name of the stage. | ||
| 152 | |||
| 153 | |||
| 154 | |||
| 155 | =head2 StageVariables => L<Paws::ApiGatewayV2::StageVariablesMap> | ||
| 156 | |||
| 157 | A map that defines the stage variables for a Stage. Variable names can | ||
| 158 | have alphanumeric and underscore characters, and the values must match | ||
| 159 | [A-Za-z0-9-._~:/?#&=,]+. | ||
| 160 | |||
| 161 | |||
| 162 | |||
| 163 | =head2 Tags => L<Paws::ApiGatewayV2::Tags> | ||
| 164 | |||
| 165 | The collection of tags. Each tag element is associated with a given | ||
| 166 | resource. | ||
| 167 | |||
| 168 | |||
| 169 | |||
| 170 | |||
| 171 | =head1 SEE ALSO | ||
| 172 | |||
| 173 | This class forms part of L<Paws>, documenting arguments for method CreateStage in L<Paws::ApiGatewayV2> | ||
| 174 | |||
| 175 | =head1 BUGS and CONTRIBUTIONS | ||
| 176 | |||
| 177 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 178 | |||
| 179 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 180 | |||
| 181 | =cut | ||
| 182 |