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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.292Z")
 @Stability(value=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();
 

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

getApiId

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

The API identifier.

getStageName

@Stability(value=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(value=Stable)
 @Nullable
default Object getAccessLogSettings()

Settings for logging access in this stage.

getAccessPolicyId

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

This parameter is not currently supported.

getAutoDeploy

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

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

The default value is false .

getClientCertificateId

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

The identifier of a client certificate for a `Stage` .

Supported only for WebSocket APIs.

getDefaultRouteSettings

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

The default route settings for the stage.

getDeploymentId

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

The deployment identifier for the API stage.

Can't be updated if autoDeploy is enabled.

getDescription

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

The description for the API stage.

getRouteSettings

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

Route settings for the stage.

getStageVariables

@Stability(value=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(value=Stable)
 @Nullable
default Object getTags()

The collection of tags.

Each tag element is associated with a given resource.

builder

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

Returns:

a CfnStageProps.Builder of CfnStageProps