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.46.0 (build cd08c55)",
           date="2021-11-25T20:11:04.868Z")
 @Stability(value=Stable)
public interface CfnStageProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::ApiGatewayV2::Stage`.

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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnStageProps.Builder	builder()
default Object	getAccessLogSettings() `AWS::ApiGatewayV2::Stage.AccessLogSettings`.
default String	getAccessPolicyId() `AWS::ApiGatewayV2::Stage.AccessPolicyId`.
String	getApiId() `AWS::ApiGatewayV2::Stage.ApiId`.
default Object	getAutoDeploy() `AWS::ApiGatewayV2::Stage.AutoDeploy`.
default String	getClientCertificateId() `AWS::ApiGatewayV2::Stage.ClientCertificateId`.
default Object	getDefaultRouteSettings() `AWS::ApiGatewayV2::Stage.DefaultRouteSettings`.
default String	getDeploymentId() `AWS::ApiGatewayV2::Stage.DeploymentId`.
default String	getDescription() `AWS::ApiGatewayV2::Stage.Description`.
default Object	getRouteSettings() `AWS::ApiGatewayV2::Stage.RouteSettings`.
String	getStageName() `AWS::ApiGatewayV2::Stage.StageName`.
default Object	getStageVariables() `AWS::ApiGatewayV2::Stage.StageVariables`.
default Object	getTags() `AWS::ApiGatewayV2::Stage.Tags`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAccessLogSettings

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

`AWS::ApiGatewayV2::Stage.AccessLogSettings`.

getAccessPolicyId

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

`AWS::ApiGatewayV2::Stage.AccessPolicyId`.

getApiId

@Stability(value=Stable)
 @NotNull
String getApiId()

`AWS::ApiGatewayV2::Stage.ApiId`.

getAutoDeploy

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

`AWS::ApiGatewayV2::Stage.AutoDeploy`.

getClientCertificateId

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

`AWS::ApiGatewayV2::Stage.ClientCertificateId`.

getDefaultRouteSettings

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

`AWS::ApiGatewayV2::Stage.DefaultRouteSettings`.

getDeploymentId

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

`AWS::ApiGatewayV2::Stage.DeploymentId`.

getDescription

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

`AWS::ApiGatewayV2::Stage.Description`.

getRouteSettings

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

`AWS::ApiGatewayV2::Stage.RouteSettings`.

getStageName

@Stability(value=Stable)
 @NotNull
String getStageName()

`AWS::ApiGatewayV2::Stage.StageName`.

getStageVariables

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

`AWS::ApiGatewayV2::Stage.StageVariables`.

getTags

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

`AWS::ApiGatewayV2::Stage.Tags`.

builder

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

Returns:

a CfnStageProps.Builder of CfnStageProps