« blib/lib/Paws/ApiGateway/CreateBasePathMapping.pm
↑ Summary
blib/lib/Paws/ApiGateway/CreateDocumentationPart.pm »
| 1 | |||
| 2 | package Paws::ApiGateway::CreateDeployment; | ||
| 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::DeploymentCanarySettings', traits => ['NameInRequest'], request_name => 'canarySettings'); | ||
| 7 | has Description => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'description'); | ||
| 8 | has RestApiId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'restapi_id', required => 1); | ||
| 9 | has StageDescription => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'stageDescription'); | ||
| 10 | has StageName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'stageName'); | ||
| 11 | has TracingEnabled => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'tracingEnabled'); | ||
| 12 | has Variables => (is => 'ro', isa => 'Paws::ApiGateway::MapOfStringToString', traits => ['NameInRequest'], request_name => 'variables'); | ||
| 13 | |||
| 14 | use MooseX::ClassAttribute; | ||
| 15 | |||
| 16 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateDeployment'); | ||
| 17 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/restapis/{restapi_id}/deployments'); | ||
| 18 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 19 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ApiGateway::Deployment'); | ||
| 20 | 1; | ||
| 21 | |||
| 22 | ### main pod documentation begin ### | ||
| 23 | |||
| 24 | =head1 NAME | ||
| 25 | |||
| 26 | Paws::ApiGateway::CreateDeployment - Arguments for method CreateDeployment on L<Paws::ApiGateway> | ||
| 27 | |||
| 28 | =head1 DESCRIPTION | ||
| 29 | |||
| 30 | This class represents the parameters used for calling the method CreateDeployment on the | ||
| 31 | L<Amazon API Gateway|Paws::ApiGateway> service. Use the attributes of this class | ||
| 32 | as arguments to method CreateDeployment. | ||
| 33 | |||
| 34 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateDeployment. | ||
| 35 | |||
| 36 | =head1 SYNOPSIS | ||
| 37 | |||
| 38 | my $apigateway = Paws->service('ApiGateway'); | ||
| 39 | my $Deployment = $apigateway->CreateDeployment( | ||
| 40 | RestApiId => 'MyString', | ||
| 41 | CacheClusterEnabled => 1, # OPTIONAL | ||
| 42 | CacheClusterSize => '0.5', # OPTIONAL | ||
| 43 | CanarySettings => { | ||
| 44 | PercentTraffic => 1, # OPTIONAL | ||
| 45 | StageVariableOverrides => { 'MyString' => 'MyString', }, # OPTIONAL | ||
| 46 | UseStageCache => 1, # OPTIONAL | ||
| 47 | }, # OPTIONAL | ||
| 48 | Description => 'MyString', # OPTIONAL | ||
| 49 | StageDescription => 'MyString', # OPTIONAL | ||
| 50 | StageName => 'MyString', # OPTIONAL | ||
| 51 | TracingEnabled => 1, # OPTIONAL | ||
| 52 | Variables => { 'MyString' => 'MyString', }, # OPTIONAL | ||
| 53 | ); | ||
| 54 | |||
| 55 | # Results: | ||
| 56 | my $ApiSummary = $Deployment->ApiSummary; | ||
| 57 | my $CreatedDate = $Deployment->CreatedDate; | ||
| 58 | my $Description = $Deployment->Description; | ||
| 59 | my $Id = $Deployment->Id; | ||
| 60 | |||
| 61 | # Returns a L<Paws::ApiGateway::Deployment> object. | ||
| 62 | |||
| 63 | 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. | ||
| 64 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/apigateway/CreateDeployment> | ||
| 65 | |||
| 66 | =head1 ATTRIBUTES | ||
| 67 | |||
| 68 | |||
| 69 | =head2 CacheClusterEnabled => Bool | ||
| 70 | |||
| 71 | Enables a cache cluster for the Stage resource specified in the input. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 CacheClusterSize => Str | ||
| 76 | |||
| 77 | Specifies the cache cluster size for the Stage resource specified in | ||
| 78 | the input, if a cache cluster is enabled. | ||
| 79 | |||
| 80 | 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"> | ||
| 81 | |||
| 82 | =head2 CanarySettings => L<Paws::ApiGateway::DeploymentCanarySettings> | ||
| 83 | |||
| 84 | The input configuration for the canary deployment when the deployment | ||
| 85 | is a canary release deployment. | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | =head2 Description => Str | ||
| 90 | |||
| 91 | The description for the Deployment resource to create. | ||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | =head2 B<REQUIRED> RestApiId => Str | ||
| 96 | |||
| 97 | [Required] The string identifier of the associated RestApi. | ||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | =head2 StageDescription => Str | ||
| 102 | |||
| 103 | The description of the Stage resource for the Deployment resource to | ||
| 104 | create. | ||
| 105 | |||
| 106 | |||
| 107 | |||
| 108 | =head2 StageName => Str | ||
| 109 | |||
| 110 | The name of the Stage resource for the Deployment resource to create. | ||
| 111 | |||
| 112 | |||
| 113 | |||
| 114 | =head2 TracingEnabled => Bool | ||
| 115 | |||
| 116 | Specifies whether active tracing with X-ray is enabled for the Stage. | ||
| 117 | |||
| 118 | |||
| 119 | |||
| 120 | =head2 Variables => L<Paws::ApiGateway::MapOfStringToString> | ||
| 121 | |||
| 122 | A map that defines the stage variables for the Stage resource that is | ||
| 123 | associated with the new deployment. Variable names can have | ||
| 124 | alphanumeric and underscore characters, and the values must match | ||
| 125 | C<[A-Za-z0-9-._~:/?#&=,]+>. | ||
| 126 | |||
| 127 | |||
| 128 | |||
| 129 | |||
| 130 | =head1 SEE ALSO | ||
| 131 | |||
| 132 | This class forms part of L<Paws>, documenting arguments for method CreateDeployment in L<Paws::ApiGateway> | ||
| 133 | |||
| 134 | =head1 BUGS and CONTRIBUTIONS | ||
| 135 | |||
| 136 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 137 | |||
| 138 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 139 | |||
| 140 | =cut | ||
| 141 |