| 1 | |||
| 2 | package Paws::ApiGateway::CreateStage; | ||
| 3 | use Moose; | ||
| 4 | has CacheClusterEnabled => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'cacheClusterEnabled'); | ||
| 5 | has CacheClusterSize => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'cacheClusterSize'); | ||
| 6 | has CanarySettings => (is => 'ro', isa => 'Paws::ApiGateway::CanarySettings', traits => ['NameInRequest'], request_name => 'canarySettings'); | ||
| 7 | has DeploymentId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'deploymentId', required => 1); | ||
| 8 | has Description => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'description'); | ||
| 9 | has DocumentationVersion => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'documentationVersion'); | ||
| 10 | has RestApiId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'restapi_id', required => 1); | ||
| 11 | has StageName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'stageName', required => 1); | ||
| 12 | has Tags => (is => 'ro', isa => 'Paws::ApiGateway::MapOfStringToString', traits => ['NameInRequest'], request_name => 'tags'); | ||
| 13 | has TracingEnabled => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'tracingEnabled'); | ||
| 14 | has Variables => (is => 'ro', isa => 'Paws::ApiGateway::MapOfStringToString', traits => ['NameInRequest'], request_name => 'variables'); | ||
| 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 => '/restapis/{restapi_id}/stages'); | ||
| 20 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 21 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ApiGateway::Stage'); | ||
| 22 | 1; | ||
| 23 | |||
| 24 | ### main pod documentation begin ### | ||
| 25 | |||
| 26 | =head1 NAME | ||
| 27 | |||
| 28 | Paws::ApiGateway::CreateStage - Arguments for method CreateStage on L<Paws::ApiGateway> | ||
| 29 | |||
| 30 | =head1 DESCRIPTION | ||
| 31 | |||
| 32 | This class represents the parameters used for calling the method CreateStage on the | ||
| 33 | L<Amazon API Gateway|Paws::ApiGateway> 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('ApiGateway'); | ||
| 41 | my $Stage = $apigateway->CreateStage( | ||
| 42 | DeploymentId => 'MyString', | ||
| 43 | RestApiId => 'MyString', | ||
| 44 | StageName => 'MyString', | ||
| 45 | CacheClusterEnabled => 1, # OPTIONAL | ||
| 46 | CacheClusterSize => '0.5', # OPTIONAL | ||
| 47 | CanarySettings => { | ||
| 48 | DeploymentId => 'MyString', | ||
| 49 | PercentTraffic => 1, # OPTIONAL | ||
| 50 | StageVariableOverrides => { 'MyString' => 'MyString', }, # OPTIONAL | ||
| 51 | UseStageCache => 1, | ||
| 52 | }, # OPTIONAL | ||
| 53 | Description => 'MyString', # OPTIONAL | ||
| 54 | DocumentationVersion => 'MyString', # OPTIONAL | ||
| 55 | Tags => { 'MyString' => 'MyString', }, # OPTIONAL | ||
| 56 | TracingEnabled => 1, # OPTIONAL | ||
| 57 | Variables => { 'MyString' => 'MyString', }, # OPTIONAL | ||
| 58 | ); | ||
| 59 | |||
| 60 | # Results: | ||
| 61 | my $AccessLogSettings = $Stage->AccessLogSettings; | ||
| 62 | my $CacheClusterEnabled = $Stage->CacheClusterEnabled; | ||
| 63 | my $CacheClusterSize = $Stage->CacheClusterSize; | ||
| 64 | my $CacheClusterStatus = $Stage->CacheClusterStatus; | ||
| 65 | my $CanarySettings = $Stage->CanarySettings; | ||
| 66 | my $ClientCertificateId = $Stage->ClientCertificateId; | ||
| 67 | my $CreatedDate = $Stage->CreatedDate; | ||
| 68 | my $DeploymentId = $Stage->DeploymentId; | ||
| 69 | my $Description = $Stage->Description; | ||
| 70 | my $DocumentationVersion = $Stage->DocumentationVersion; | ||
| 71 | my $LastUpdatedDate = $Stage->LastUpdatedDate; | ||
| 72 | my $MethodSettings = $Stage->MethodSettings; | ||
| 73 | my $StageName = $Stage->StageName; | ||
| 74 | my $Tags = $Stage->Tags; | ||
| 75 | my $TracingEnabled = $Stage->TracingEnabled; | ||
| 76 | my $Variables = $Stage->Variables; | ||
| 77 | my $WebAclArn = $Stage->WebAclArn; | ||
| 78 | |||
| 79 | # Returns a L<Paws::ApiGateway::Stage> object. | ||
| 80 | |||
| 81 | 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. | ||
| 82 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/apigateway/CreateStage> | ||
| 83 | |||
| 84 | =head1 ATTRIBUTES | ||
| 85 | |||
| 86 | |||
| 87 | =head2 CacheClusterEnabled => Bool | ||
| 88 | |||
| 89 | Whether cache clustering is enabled for the stage. | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | =head2 CacheClusterSize => Str | ||
| 94 | |||
| 95 | The stage's cache cluster size. | ||
| 96 | |||
| 97 | Valid values are: C<"0.5">, C<"1.6">, C<"6.1">, C<"13.5">, C<"28.4">, C<"58.2">, C<"118">, C<"237"> | ||
| 98 | |||
| 99 | =head2 CanarySettings => L<Paws::ApiGateway::CanarySettings> | ||
| 100 | |||
| 101 | The canary deployment settings of this stage. | ||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head2 B<REQUIRED> DeploymentId => Str | ||
| 106 | |||
| 107 | [Required] The identifier of the Deployment resource for the Stage | ||
| 108 | resource. | ||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | =head2 Description => Str | ||
| 113 | |||
| 114 | The description of the Stage resource. | ||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | =head2 DocumentationVersion => Str | ||
| 119 | |||
| 120 | The version of the associated API documentation. | ||
| 121 | |||
| 122 | |||
| 123 | |||
| 124 | =head2 B<REQUIRED> RestApiId => Str | ||
| 125 | |||
| 126 | [Required] The string identifier of the associated RestApi. | ||
| 127 | |||
| 128 | |||
| 129 | |||
| 130 | =head2 B<REQUIRED> StageName => Str | ||
| 131 | |||
| 132 | [Required] The name for the Stage resource. Stage names can only | ||
| 133 | contain alphanumeric characters, hyphens, and underscores. Maximum | ||
| 134 | length is 128 characters. | ||
| 135 | |||
| 136 | |||
| 137 | |||
| 138 | =head2 Tags => L<Paws::ApiGateway::MapOfStringToString> | ||
| 139 | |||
| 140 | The key-value map of strings. The valid character set is | ||
| 141 | [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not | ||
| 142 | start with C<aws:>. The tag value can be up to 256 characters. | ||
| 143 | |||
| 144 | |||
| 145 | |||
| 146 | =head2 TracingEnabled => Bool | ||
| 147 | |||
| 148 | Specifies whether active tracing with X-ray is enabled for the Stage. | ||
| 149 | |||
| 150 | |||
| 151 | |||
| 152 | =head2 Variables => L<Paws::ApiGateway::MapOfStringToString> | ||
| 153 | |||
| 154 | A map that defines the stage variables for the new Stage resource. | ||
| 155 | Variable names can have alphanumeric and underscore characters, and the | ||
| 156 | values must match C<[A-Za-z0-9-._~:/?#&=,]+>. | ||
| 157 | |||
| 158 | |||
| 159 | |||
| 160 | |||
| 161 | =head1 SEE ALSO | ||
| 162 | |||
| 163 | This class forms part of L<Paws>, documenting arguments for method CreateStage in L<Paws::ApiGateway> | ||
| 164 | |||
| 165 | =head1 BUGS and CONTRIBUTIONS | ||
| 166 | |||
| 167 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 168 | |||
| 169 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 170 | |||
| 171 | =cut | ||
| 172 |