Skip to content
v2.277.0

StageReference Struct ​

A reference to a Stage resource.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigateway as interfaces_apigateway } from 'aws-cdk-lib/interfaces';
const stageReference: interfaces_apigateway.StageReference = {
  restApiId: 'restApiId',
  stageName: 'stageName',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.interfaces import aws_apigateway as interfaces_apigateway

stage_reference = interfaces_apigateway.StageReference(
    rest_api_id="restApiId",
    stage_name="stageName"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.interfaces.apigateway.*;

StageReference stageReference = StageReference.builder()
        .restApiId("restApiId")
        .stageName("stageName")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.Interfaces.APIGateway;

var stageReference = new StageReference {
    RestApiId = "restApiId",
    StageName = "stageName"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

stageReference := &StageReference{
	RestApiId: jsii.String("restApiId"),
	StageName: jsii.String("stageName"),
}

Properties ​

restApiIdstringrest_api_idstrrestApiIdStringRestApiIdstringRestApiId*stringrequired#
The RestApiId of the Stage resource.
stageNamestringstage_namestrstageNameStringStageNamestringStageName*stringrequired#
The StageName of the Stage resource.