Paws::ApiGateway::CreateDeployment - Arguments for method CreateDeployment on Paws::ApiGateway


This class represents the parameters used for calling the method CreateDeployment on the Amazon API Gateway service. Use the attributes of this class as arguments to method CreateDeployment.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateDeployment.


    my $apigateway = Paws->service('ApiGateway');
    my $Deployment = $apigateway->CreateDeployment(
      RestApiId           => 'MyString',
      CacheClusterEnabled => 1,            # OPTIONAL
      CacheClusterSize    => '0.5',        # OPTIONAL
      CanarySettings      => {
        PercentTraffic         => 1,                                # OPTIONAL
        StageVariableOverrides => { 'MyString' => 'MyString', },    # OPTIONAL
        UseStageCache          => 1,                                # OPTIONAL
      },    # OPTIONAL
      Description      => 'MyString',                       # OPTIONAL
      StageDescription => 'MyString',                       # OPTIONAL
      StageName        => 'MyString',                       # OPTIONAL
      TracingEnabled   => 1,                                # OPTIONAL
      Variables        => { 'MyString' => 'MyString', },    # OPTIONAL

    # Results:
    my $ApiSummary  = $Deployment->ApiSummary;
    my $CreatedDate = $Deployment->CreatedDate;
    my $Description = $Deployment->Description;
    my $Id          = $Deployment->Id;

    # Returns a L<Paws::ApiGateway::Deployment> object.

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. For the AWS API documentation, see


CacheClusterEnabled => Bool

Enables a cache cluster for the Stage resource specified in the input.

CacheClusterSize => Str

Specifies the cache cluster size for the Stage resource specified in the input, if a cache cluster is enabled.

Valid values are: "0.5", "1.6", "6.1", "13.5", "28.4", "58.2", "118", "237"

CanarySettings => Paws::ApiGateway::DeploymentCanarySettings

The input configuration for the canary deployment when the deployment is a canary release deployment.

Description => Str

The description for the Deployment resource to create.

REQUIRED RestApiId => Str

[Required] The string identifier of the associated RestApi.

StageDescription => Str

The description of the Stage resource for the Deployment resource to create.

StageName => Str

The name of the Stage resource for the Deployment resource to create.

TracingEnabled => Bool

Specifies whether active tracing with X-ray is enabled for the Stage.

Variables => Paws::ApiGateway::MapOfStringToString

A map that defines the stage variables for the Stage resource that is associated with the new deployment. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?&num;&=,]+.


This class forms part of Paws, documenting arguments for method CreateDeployment in Paws::ApiGateway


The source code is located here:

Please report bugs to: