aws-native.apigatewayv2.getStage

AWS Cloud Control v1.63.0, May 4 26

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.63.0
published on Monday, May 4, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aws-native

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.63.0
published on Monday, May 4, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aws-native

Using getStage

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getStage(args: GetStageArgs, opts?: InvokeOptions): Promise<GetStageResult>
function getStageOutput(args: GetStageOutputArgs, opts?: InvokeOptions): Output<GetStageResult>

def get_stage(id: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetStageResult
def get_stage_output(id: pulumi.Input[Optional[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetStageResult]

func LookupStage(ctx *Context, args *LookupStageArgs, opts ...InvokeOption) (*LookupStageResult, error)
func LookupStageOutput(ctx *Context, args *LookupStageOutputArgs, opts ...InvokeOption) LookupStageResultOutput

> Note: This function is named LookupStage in the Go SDK.

public static class GetStage 
{
    public static Task<GetStageResult> InvokeAsync(GetStageArgs args, InvokeOptions? opts = null)
    public static Output<GetStageResult> Invoke(GetStageInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetStageResult> getStage(GetStageArgs args, InvokeOptions options)
public static Output<GetStageResult> getStage(GetStageArgs args, InvokeOptions options)

fn::invoke:
  function: aws-native:apigatewayv2:getStage
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string: The identifier.

Id string: The identifier.

id String: The identifier.

id string: The identifier.

id str: The identifier.

id String: The identifier.

getStage Result

The following output properties are available:

AccessLogSettings Pulumi.AwsNative.ApiGatewayV2.Outputs.StageAccessLogSettings

Settings for logging access in this stage.

AutoDeploy bool

Specifies whether updates to an API automatically trigger a new deployment. The default value is false .

ClientCertificateId string

The identifier of a client certificate for a Stage . Supported only for WebSocket APIs.

DefaultRouteSettings Pulumi.AwsNative.ApiGatewayV2.Outputs.StageRouteSettings

The default route settings for the stage.

DeploymentId string

The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled.

Description string

The description for the API stage.

Id string

The identifier.

RouteSettings object

Route settings for the stage.

Search the CloudFormation User Guide for AWS::ApiGatewayV2::Stage for more information about the expected schema for this property.

StageVariables object

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-._~:/?#&=,]+.

Search the CloudFormation User Guide for AWS::ApiGatewayV2::Stage for more information about the expected schema for this property.

Tags object

The collection of tags. Each tag element is associated with a given resource.

Search the CloudFormation User Guide for AWS::ApiGatewayV2::Stage for more information about the expected schema for this property.

AccessLogSettings StageAccessLogSettings

Settings for logging access in this stage.

AutoDeploy bool

Specifies whether updates to an API automatically trigger a new deployment. The default value is false .

ClientCertificateId string

The identifier of a client certificate for a Stage . Supported only for WebSocket APIs.

DefaultRouteSettings StageRouteSettings

The default route settings for the stage.

DeploymentId string

The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled.

Description string

The description for the API stage.

Id string

The identifier.

RouteSettings interface{}

Route settings for the stage.

Search the CloudFormation User Guide for AWS::ApiGatewayV2::Stage for more information about the expected schema for this property.

StageVariables interface{}

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-._~:/?#&=,]+.

Search the CloudFormation User Guide for AWS::ApiGatewayV2::Stage for more information about the expected schema for this property.

Tags interface{}

The collection of tags. Each tag element is associated with a given resource.

Search the CloudFormation User Guide for AWS::ApiGatewayV2::Stage for more information about the expected schema for this property.

accessLogSettings StageAccessLogSettings

Settings for logging access in this stage.

autoDeploy Boolean

Specifies whether updates to an API automatically trigger a new deployment. The default value is false .

clientCertificateId String

The identifier of a client certificate for a Stage . Supported only for WebSocket APIs.

defaultRouteSettings StageRouteSettings

The default route settings for the stage.

deploymentId String

The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled.

description String

The description for the API stage.

id String

The identifier.

routeSettings Object

Route settings for the stage.

Search the CloudFormation User Guide for AWS::ApiGatewayV2::Stage for more information about the expected schema for this property.

stageVariables Object

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-._~:/?#&=,]+.

Search the CloudFormation User Guide for AWS::ApiGatewayV2::Stage for more information about the expected schema for this property.

tags Object

The collection of tags. Each tag element is associated with a given resource.

Search the CloudFormation User Guide for AWS::ApiGatewayV2::Stage for more information about the expected schema for this property.

accessLogSettings StageAccessLogSettings

Settings for logging access in this stage.

autoDeploy boolean

Specifies whether updates to an API automatically trigger a new deployment. The default value is false .

clientCertificateId string

The identifier of a client certificate for a Stage . Supported only for WebSocket APIs.

defaultRouteSettings StageRouteSettings

The default route settings for the stage.

deploymentId string

The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled.

description string

The description for the API stage.

id string

The identifier.

routeSettings any

Route settings for the stage.

Search the CloudFormation User Guide for AWS::ApiGatewayV2::Stage for more information about the expected schema for this property.

stageVariables any

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-._~:/?#&=,]+.

Search the CloudFormation User Guide for AWS::ApiGatewayV2::Stage for more information about the expected schema for this property.

tags any

The collection of tags. Each tag element is associated with a given resource.

Search the CloudFormation User Guide for AWS::ApiGatewayV2::Stage for more information about the expected schema for this property.

access_log_settings StageAccessLogSettings

Settings for logging access in this stage.

auto_deploy bool

Specifies whether updates to an API automatically trigger a new deployment. The default value is false .

client_certificate_id str

The identifier of a client certificate for a Stage . Supported only for WebSocket APIs.

default_route_settings StageRouteSettings

The default route settings for the stage.

deployment_id str

The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled.

description str

The description for the API stage.

id str

The identifier.

route_settings Any

Route settings for the stage.

Search the CloudFormation User Guide for AWS::ApiGatewayV2::Stage for more information about the expected schema for this property.

stage_variables Any

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-._~:/?#&=,]+.

Search the CloudFormation User Guide for AWS::ApiGatewayV2::Stage for more information about the expected schema for this property.

tags Any

The collection of tags. Each tag element is associated with a given resource.

Search the CloudFormation User Guide for AWS::ApiGatewayV2::Stage for more information about the expected schema for this property.

accessLogSettings Property Map

Settings for logging access in this stage.

autoDeploy Boolean

Specifies whether updates to an API automatically trigger a new deployment. The default value is false .

clientCertificateId String

The identifier of a client certificate for a Stage . Supported only for WebSocket APIs.

defaultRouteSettings Property Map

The default route settings for the stage.

deploymentId String

The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled.

description String

The description for the API stage.

id String

The identifier.

routeSettings Any

Route settings for the stage.

Search the CloudFormation User Guide for AWS::ApiGatewayV2::Stage for more information about the expected schema for this property.

stageVariables Any

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-._~:/?#&=,]+.

Search the CloudFormation User Guide for AWS::ApiGatewayV2::Stage for more information about the expected schema for this property.

tags Any

The collection of tags. Each tag element is associated with a given resource.

Search the CloudFormation User Guide for AWS::ApiGatewayV2::Stage for more information about the expected schema for this property.

Supporting Types

StageAccessLogSettings

DestinationArn string: The ARN of the CloudWatch Logs log group to receive access logs. This parameter is required to enable access logging.
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. This parameter is required to enable access logging.

DestinationArn string: The ARN of the CloudWatch Logs log group to receive access logs. This parameter is required to enable access logging.
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. This parameter is required to enable access logging.

destinationArn String: The ARN of the CloudWatch Logs log group to receive access logs. This parameter is required to enable access logging.
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. This parameter is required to enable access logging.

destinationArn string: The ARN of the CloudWatch Logs log group to receive access logs. This parameter is required to enable access logging.
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. This parameter is required to enable access logging.

destination_arn str: The ARN of the CloudWatch Logs log group to receive access logs. This parameter is required to enable access logging.
format str: A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId. This parameter is required to enable access logging.

destinationArn String: The ARN of the CloudWatch Logs log group to receive access logs. This parameter is required to enable access logging.
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. This parameter is required to enable access logging.

StageRouteSettings

DataTraceEnabled bool: 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.
DetailedMetricsEnabled bool: Specifies whether detailed metrics are enabled.
LoggingLevel string: 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.
ThrottlingBurstLimit int: Specifies the throttling burst limit.
ThrottlingRateLimit double: Specifies the throttling rate limit.

DataTraceEnabled bool: 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.
DetailedMetricsEnabled bool: Specifies whether detailed metrics are enabled.
LoggingLevel string: 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.
ThrottlingBurstLimit int: Specifies the throttling burst limit.
ThrottlingRateLimit float64: Specifies the throttling rate limit.

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.
detailedMetricsEnabled Boolean: Specifies whether detailed metrics are enabled.
loggingLevel String: 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.
throttlingBurstLimit Integer: Specifies the throttling burst limit.
throttlingRateLimit Double: Specifies the throttling rate limit.

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.
detailedMetricsEnabled boolean: Specifies whether detailed metrics are enabled.
loggingLevel string: 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.
throttlingBurstLimit number: Specifies the throttling burst limit.
throttlingRateLimit number: Specifies the throttling rate limit.

data_trace_enabled bool: 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.
detailed_metrics_enabled bool: Specifies whether detailed metrics are enabled.
logging_level str: 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.
throttling_burst_limit int: Specifies the throttling burst limit.
throttling_rate_limit float: Specifies the throttling rate limit.

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.
detailedMetricsEnabled Boolean: Specifies whether detailed metrics are enabled.
loggingLevel String: 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.
throttlingBurstLimit Number: Specifies the throttling burst limit.
throttlingRateLimit Number: Specifies the throttling rate limit.