Package software.amazon.awscdk.services.apigatewayv2

Class CfnStage

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.apigatewayv2.CfnStage
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:43.229Z") @Stability(Stable) public class CfnStage extends CfnResource implements IInspectable
A CloudFormation AWS::ApiGatewayV2::Stage.

The AWS::ApiGatewayV2::Stage resource specifies a stage for an API. Each stage is a named reference to a deployment of the API and is made available for client applications to call. To learn more, see Working with stages for HTTP APIs and Deploy a WebSocket API in API Gateway .

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;
 CfnStage cfnStage = CfnStage.Builder.create(this, "MyCfnStage")
         .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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnStage

      protected CfnStage(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnStage

      protected CfnStage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnStage

      @Stability(Stable) public CfnStage(@NotNull Construct scope, @NotNull String id, @NotNull CfnStageProps props)
      Create a new AWS::ApiGatewayV2::Stage.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      The collection of tags.

      Each tag element is associated with a given resource.

    • getApiId

      @Stability(Stable) @NotNull public String getApiId()
      The API identifier.

    • setApiId

      @Stability(Stable) public void setApiId(@NotNull String value)
      The API identifier.

    • getRouteSettings

      @Stability(Stable) @NotNull public Object getRouteSettings()
      Route settings for the stage.

    • setRouteSettings

      @Stability(Stable) public void setRouteSettings(@NotNull Object value)
      Route settings for the stage.

    • getStageName

      @Stability(Stable) @NotNull public String getStageName()
      The stage name.

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

    • setStageName

      @Stability(Stable) public void setStageName(@NotNull String value)
      The stage name.

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

    • getStageVariables

      @Stability(Stable) @NotNull public 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-._~:/?#&=,]+.

    • setStageVariables

      @Stability(Stable) public void setStageVariables(@NotNull Object value)
      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-._~:/?#&=,]+.

    • getAccessLogSettings

      @Stability(Stable) @Nullable public Object getAccessLogSettings()
      Settings for logging access in this stage.

    • setAccessLogSettings

      @Stability(Stable) public void setAccessLogSettings(@Nullable IResolvable value)
      Settings for logging access in this stage.

    • setAccessLogSettings

      @Stability(Stable) public void setAccessLogSettings(@Nullable CfnStage.AccessLogSettingsProperty value)
      Settings for logging access in this stage.

    • getAccessPolicyId

      @Stability(Stable) @Nullable public String getAccessPolicyId()
      This parameter is not currently supported.

    • setAccessPolicyId

      @Stability(Stable) public void setAccessPolicyId(@Nullable String value)
      This parameter is not currently supported.

    • getAutoDeploy

      @Stability(Stable) @Nullable public Object getAutoDeploy()
      Specifies whether updates to an API automatically trigger a new deployment.

      The default value is false .

    • setAutoDeploy

      @Stability(Stable) public void setAutoDeploy(@Nullable Boolean value)
      Specifies whether updates to an API automatically trigger a new deployment.

      The default value is false .

    • setAutoDeploy

      @Stability(Stable) public void setAutoDeploy(@Nullable IResolvable value)
      Specifies whether updates to an API automatically trigger a new deployment.

      The default value is false .

    • getClientCertificateId

      @Stability(Stable) @Nullable public String getClientCertificateId()
      The identifier of a client certificate for a Stage .

      Supported only for WebSocket APIs.

    • setClientCertificateId

      @Stability(Stable) public void setClientCertificateId(@Nullable String value)
      The identifier of a client certificate for a Stage .

      Supported only for WebSocket APIs.

    • getDefaultRouteSettings

      @Stability(Stable) @Nullable public Object getDefaultRouteSettings()
      The default route settings for the stage.

    • setDefaultRouteSettings

      @Stability(Stable) public void setDefaultRouteSettings(@Nullable IResolvable value)
      The default route settings for the stage.

    • setDefaultRouteSettings

      @Stability(Stable) public void setDefaultRouteSettings(@Nullable CfnStage.RouteSettingsProperty value)
      The default route settings for the stage.

    • getDeploymentId

      @Stability(Stable) @Nullable public String getDeploymentId()
      The deployment identifier for the API stage.

      Can't be updated if autoDeploy is enabled.

    • setDeploymentId

      @Stability(Stable) public void setDeploymentId(@Nullable String value)
      The deployment identifier for the API stage.

      Can't be updated if autoDeploy is enabled.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description for the API stage.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description for the API stage.