AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon API Gateway CreateStage API operation.

Syntax

New-AGStage
-RestApiId <String>
-CacheClusterEnabled <Boolean>
-CacheClusterSize <CacheClusterSize>
-CanarySettings_DeploymentId <String>
-DeploymentId <String>
-Description <String>
-DocumentationVersion <String>
-CanarySettings_PercentTraffic <Double>
-StageName <String>
-CanarySettings_StageVariableOverride <Hashtable>
-Tag <Hashtable>
-TracingEnabled <Boolean>
-CanarySettings_UseStageCache <Boolean>
-Variable <Hashtable>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonAPIGatewayConfig>

Description

Creates a new Stage resource that references a pre-existing Deployment for the API.

Parameters

-CacheClusterEnabled <Boolean>
Whether cache clustering is enabled for the stage.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CacheClusterSize <CacheClusterSize>
The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CanarySettings_DeploymentId <String>
The ID of the canary deployment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CanarySettings_PercentTraffic <Double>
The percent (0-100) of traffic diverted to a canary deployment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CanarySettings_StageVariableOverride <Hashtable>
Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCanarySettings_StageVariableOverrides
-CanarySettings_UseStageCache <Boolean>
A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonAPIGatewayConfig>
Amazon.PowerShell.Cmdlets.AG.AmazonAPIGatewayClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeploymentId <String>
The identifier of the Deployment resource for the Stage resource.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
The description of the Stage resource.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DocumentationVersion <String>
The version of the associated API documentation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the RestApiId parameter. The -PassThru parameter is deprecated, use -Select '^RestApiId' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestApiId <String>
The string identifier of the associated RestApi.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.APIGateway.Model.CreateStageResponse). Specifying the name of a property of type Amazon.APIGateway.Model.CreateStageResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StageName <String>
The name for the Stage resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Hashtable>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-TracingEnabled <Boolean>
Specifies whether active tracing with X-ray is enabled for the Stage.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Variable <Hashtable>
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-._~:/?#&=,]+.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVariables

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

This cmdlet returns an Amazon.APIGateway.Model.CreateStageResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

AWS Tools for PowerShell: 2.x.y.z