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


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

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


    my $apigateway = Paws->service('ApiGateway');
    my $Stage = $apigateway->CreateStage(
      DeploymentId        => 'MyString',
      RestApiId           => 'MyString',
      StageName           => 'MyString',
      CacheClusterEnabled => 1,            # OPTIONAL
      CacheClusterSize    => '0.5',        # OPTIONAL
      CanarySettings      => {
        deploymentId           => 'MyString',
        percentTraffic         => 1,                                # OPTIONAL
        stageVariableOverrides => { 'MyString' => 'MyString', },    # OPTIONAL
        useStageCache          => 1,
      },    # OPTIONAL
      Description          => 'MyString',                       # OPTIONAL
      DocumentationVersion => 'MyString',                       # OPTIONAL
      Tags                 => { 'MyString' => 'MyString', },    # OPTIONAL
      Variables            => { 'MyString' => 'MyString', },    # OPTIONAL

    # Results:
    my $AccessLogSettings    = $Stage->AccessLogSettings;
    my $CacheClusterEnabled  = $Stage->CacheClusterEnabled;
    my $CacheClusterSize     = $Stage->CacheClusterSize;
    my $CacheClusterStatus   = $Stage->CacheClusterStatus;
    my $CanarySettings       = $Stage->CanarySettings;
    my $ClientCertificateId  = $Stage->ClientCertificateId;
    my $CreatedDate          = $Stage->CreatedDate;
    my $DeploymentId         = $Stage->DeploymentId;
    my $Description          = $Stage->Description;
    my $DocumentationVersion = $Stage->DocumentationVersion;
    my $LastUpdatedDate      = $Stage->LastUpdatedDate;
    my $MethodSettings       = $Stage->MethodSettings;
    my $StageName            = $Stage->StageName;
    my $Tags                 = $Stage->Tags;
    my $Variables            = $Stage->Variables;

    # Returns a L<Paws::ApiGateway::Stage> 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

Whether cache clustering is enabled for the stage.

CacheClusterSize => Str

The stage's cache cluster size.

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

CanarySettings => Paws::ApiGateway::CanarySettings

The canary deployment settings of this stage.

REQUIRED DeploymentId => Str

[Required] The identifier of the Deployment resource for the Stage resource.

Description => Str

The description of the Stage resource.

DocumentationVersion => Str

The version of the associated API documentation.

REQUIRED RestApiId => Str

[Required] The string identifier of the associated RestApi.

REQUIRED StageName => Str

[Required] The name for the Stage resource.

Tags => Paws::ApiGateway::MapOfStringToString

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

Variables => Paws::ApiGateway::MapOfStringToString

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


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


The source code is located here:

Please report bugs to: