Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

AWS Tools for Windows PowerShell
Command Reference

Synopsis

Calls the Amazon API Gateway V2 CreateStage API operation.

Syntax

New-AG2Stage
-ApiId <String>
-AutoDeploy <Boolean>
-ClientCertificateId <String>
-DefaultRouteSettings_DataTraceEnabled <Boolean>
-DeploymentId <String>
-Description <String>
-AccessLogSettings_DestinationArn <String>
-DefaultRouteSettings_DetailedMetricsEnabled <Boolean>
-AccessLogSettings_Format <String>
-DefaultRouteSettings_LoggingLevel <LoggingLevel>
-RouteSetting <Hashtable>
-StageName <String>
-StageVariable <Hashtable>
-Tag <Hashtable>
-DefaultRouteSettings_ThrottlingBurstLimit <Int32>
-DefaultRouteSettings_ThrottlingRateLimit <Double>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonApiGatewayV2Config>

Description

Creates a Stage for an API.

Parameters

-AccessLogSettings_DestinationArn <String>
The ARN of the CloudWatch Logs log group to receive access logs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AccessLogSettings_Format <String>
A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ApiId <String>
The API identifier.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-AutoDeploy <Boolean>
Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientCertificateId <String>
The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonApiGatewayV2Config>
Amazon.PowerShell.Cmdlets.AG2.AmazonApiGatewayV2ClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultRouteSettings_DataTraceEnabled <Boolean>
Specifies whether (true) or not (false) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultRouteSettings_DetailedMetricsEnabled <Boolean>
Specifies whether detailed metrics are enabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultRouteSettings_LoggingLevel <LoggingLevel>
Specifies the logging level for this route: INFO, ERROR, or OFF. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultRouteSettings_ThrottlingBurstLimit <Int32>
Specifies the throttling burst limit.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultRouteSettings_ThrottlingRateLimit <Double>
Specifies the throttling rate limit.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeploymentId <String>
The deployment identifier of the API stage.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
The description for the API stage.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
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 ApiId parameter. The -PassThru parameter is deprecated, use -Select '^ApiId' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RouteSetting <Hashtable>
Route settings for the stage, by routeKey.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRouteSettings
-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.ApiGatewayV2.Model.CreateStageResponse). Specifying the name of a property of type Amazon.ApiGatewayV2.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 of the stage.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-StageVariable <Hashtable>
A map that defines the stage variables for a Stage. 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)
AliasesStageVariables
-Tag <Hashtable>
The collection of tags. Each tag element is associated with a given resource.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags

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

Amazon.ApiGatewayV2.Model.CreateStageResponse
This cmdlet returns an Amazon.ApiGatewayV2.Model.CreateStageResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 4.1.801.0