Package software.amazon.awscdk.services.apigatewayv2

Interface CfnStageProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnStageProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.110.0 (build 336b265)",
           date="2025-04-22T23:08:06.548Z")
@Stability(Stable)
public interface CfnStageProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnStage.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apigatewayv2.*;
 Object routeSettings;
 Object stageVariables;
 Object tags;
 CfnStageProps cfnStageProps = CfnStageProps.builder()
         .apiId("apiId")
         .stageName("stageName")
         // the properties below are optional
         .accessLogSettings(AccessLogSettingsProperty.builder()
                 .destinationArn("destinationArn")
                 .format("format")
                 .build())
         .accessPolicyId("accessPolicyId")
         .autoDeploy(false)
         .clientCertificateId("clientCertificateId")
         .defaultRouteSettings(RouteSettingsProperty.builder()
                 .dataTraceEnabled(false)
                 .detailedMetricsEnabled(false)
                 .loggingLevel("loggingLevel")
                 .throttlingBurstLimit(123)
                 .throttlingRateLimit(123)
                 .build())
         .deploymentId("deploymentId")
         .description("description")
         .routeSettings(routeSettings)
         .stageVariables(stageVariables)
         .tags(tags)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnStageProps.Builder	A builder for CfnStageProps
static final class	CfnStageProps.Jsii$Proxy	An implementation for CfnStageProps

Method Summary

Modifier and Type	Method	Description
static CfnStageProps.Builder	builder()
default Object	getAccessLogSettings()	Settings for logging access in this stage.
default String	getAccessPolicyId()	This parameter is not currently supported.
String	getApiId()	The API identifier.
default Object	getAutoDeploy()	Specifies whether updates to an API automatically trigger a new deployment.
default String	getClientCertificateId()	The identifier of a client certificate for a Stage .
default Object	getDefaultRouteSettings()	The default route settings for the stage.
default String	getDeploymentId()	The deployment identifier for the API stage.
default String	getDescription()	The description for the API stage.
default Object	getRouteSettings()	Route settings for the stage.
String	getStageName()	The stage name.
default Object	getStageVariables()	A map that defines the stage variables for a Stage .
default Object	getTags()	The collection of tags.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApiId

@Stability(Stable)
@NotNull
String getApiId()

The API identifier.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-apiid

getStageName

@Stability(Stable)
@NotNull
String getStageName()

The stage name.

Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default . Maximum length is 128 characters.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-stagename

getAccessLogSettings

@Stability(Stable)
@Nullable
default Object getAccessLogSettings()

Settings for logging access in this stage.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-accesslogsettings

getAccessPolicyId

@Stability(Stable)
@Nullable
default String getAccessPolicyId()

This parameter is not currently supported.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-accesspolicyid

getAutoDeploy

@Stability(Stable)
@Nullable
default Object getAutoDeploy()

Specifies whether updates to an API automatically trigger a new deployment.

The default value is false .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-autodeploy

getClientCertificateId

@Stability(Stable)
@Nullable
default String getClientCertificateId()

The identifier of a client certificate for a Stage .

Supported only for WebSocket APIs.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-clientcertificateid

getDefaultRouteSettings

@Stability(Stable)
@Nullable
default Object getDefaultRouteSettings()

The default route settings for the stage.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-defaultroutesettings

getDeploymentId

@Stability(Stable)
@Nullable
default String getDeploymentId()

The deployment identifier for the API stage.

Can't be updated if autoDeploy is enabled.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-deploymentid

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description for the API stage.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-description

getRouteSettings

@Stability(Stable)
@Nullable
default Object getRouteSettings()

Route settings for the stage.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-routesettings

getStageVariables

@Stability(Stable)
@Nullable
default Object getStageVariables()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-stagevariables

getTags

@Stability(Stable)
@Nullable
default Object getTags()

The collection of tags.

Each tag element is associated with a given resource.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-tags

builder

@Stability(Stable)
static CfnStageProps.Builder builder()

Returns:

a CfnStageProps.Builder of CfnStageProps