software.amazon.awscdk.services.apigatewayv2

Interface CfnStageProps

All Known Implementing Classes:

CfnStageProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:31.899Z")
public interface CfnStageProps

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 java.lang.Object	getAccessLogSettings() Settings for logging access in this stage.
default java.lang.String	getAccessPolicyId() This parameter is not currently supported.
java.lang.String	getApiId() The API identifier.
default java.lang.Object	getAutoDeploy() Specifies whether updates to an API automatically trigger a new deployment.
default java.lang.String	getClientCertificateId() The identifier of a client certificate for a `Stage` .
default java.lang.Object	getDefaultRouteSettings() The default route settings for the stage.
default java.lang.String	getDeploymentId() The deployment identifier for the API stage.
default java.lang.String	getDescription() The description for the API stage.
default java.lang.Object	getRouteSettings() Route settings for the stage.
java.lang.String	getStageName() The stage name.
default java.lang.Object	getStageVariables() A map that defines the stage variables for a `Stage` .
default java.lang.Object	getTags() The collection of tags.

Method Detail

getApiId

java.lang.String getApiId()

The API identifier.

getStageName

java.lang.String getStageName()

The stage name.

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

getAccessLogSettings

default java.lang.Object getAccessLogSettings()

Settings for logging access in this stage.

getAccessPolicyId

default java.lang.String getAccessPolicyId()

This parameter is not currently supported.

getAutoDeploy

default java.lang.Object getAutoDeploy()

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

The default value is false .

getClientCertificateId

default java.lang.String getClientCertificateId()

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

Supported only for WebSocket APIs.

getDefaultRouteSettings

default java.lang.Object getDefaultRouteSettings()

The default route settings for the stage.

getDeploymentId

default java.lang.String getDeploymentId()

The deployment identifier for the API stage.

Can't be updated if autoDeploy is enabled.

getDescription

default java.lang.String getDescription()

The description for the API stage.

getRouteSettings

default java.lang.Object getRouteSettings()

Route settings for the stage.

getStageVariables

default java.lang.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

default java.lang.Object getTags()

The collection of tags.

Each tag element is associated with a given resource.

builder

static CfnStageProps.Builder builder()

Returns:

a CfnStageProps.Builder of CfnStageProps