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.84.0 (build 5404dcf)", date="2023-06-19T16:30:43.233Z") @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();

  • Method Details

    • getApiId

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

    • 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.

    • getAccessLogSettings

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

    • getAccessPolicyId

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

    • getAutoDeploy

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

      The default value is false .

    • getClientCertificateId

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

      Supported only for WebSocket APIs.

    • getDefaultRouteSettings

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

    • getDeploymentId

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

      Can't be updated if autoDeploy is enabled.

    • getDescription

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

    • getRouteSettings

      @Stability(Stable) @Nullable default Object getRouteSettings()
      Route settings for the stage.

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

    • getTags

      @Stability(Stable) @Nullable default Object getTags()
      The collection of tags.

      Each tag element is associated with a given resource.

    • builder

      @Stability(Stable) static CfnStageProps.Builder builder()
      Returns:
      a CfnStageProps.Builder of CfnStageProps