software.amazon.awscdk.services.apigateway

Interface CfnStageV2Props

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnStageV2Props.Jsii$Proxy

Deprecated.

moved to package aws-apigatewayv2

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-05-19T23:09:31.431Z")
 @Stability(value=Deprecated)
 @Deprecated
public interface CfnStageV2Props
extends software.amazon.jsii.JsiiSerializable

(deprecated) 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.apigateway.*;
 Object routeSettings;
 Object stageVariables;
 Object tags;
 CfnStageV2Props cfnStageV2Props = CfnStageV2Props.builder()
         .apiId("apiId")
         .stageName("stageName")
         // the properties below are optional
         .accessLogSettings(AccessLogSettingsProperty.builder()
                 .destinationArn("destinationArn")
                 .format("format")
                 .build())
         .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();
 

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnStageV2Props.Builder Deprecated.
static class	CfnStageV2Props.Jsii$Proxy Deprecated.

Method Summary

Modifier and Type	Method and Description
static CfnStageV2Props.Builder	builder() Deprecated.
default Object	getAccessLogSettings() Deprecated.
String	getApiId() Deprecated.
default Object	getAutoDeploy() Deprecated.
default String	getClientCertificateId() Deprecated.
default Object	getDefaultRouteSettings() Deprecated.
default String	getDeploymentId() Deprecated.
default String	getDescription() Deprecated.
default Object	getRouteSettings() Deprecated.
String	getStageName() Deprecated.
default Object	getStageVariables() Deprecated.
default Object	getTags() Deprecated.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getApiId

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

Deprecated.

(deprecated) `AWS::ApiGatewayV2::Stage.ApiId`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-apiid

getStageName

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

Deprecated.

(deprecated) `AWS::ApiGatewayV2::Stage.StageName`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-stagename

getAccessLogSettings

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

Deprecated.

(deprecated) `AWS::ApiGatewayV2::Stage.AccessLogSettings`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-accesslogsettings

getAutoDeploy

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

Deprecated.

(deprecated) `AWS::ApiGatewayV2::Stage.AutoDeploy`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-autodeploy

getClientCertificateId

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

Deprecated.

(deprecated) `AWS::ApiGatewayV2::Stage.ClientCertificateId`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-clientcertificateid

getDefaultRouteSettings

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

Deprecated.

(deprecated) `AWS::ApiGatewayV2::Stage.DefaultRouteSettings`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-defaultroutesettings

getDeploymentId

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

Deprecated.

(deprecated) `AWS::ApiGatewayV2::Stage.DeploymentId`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-deploymentid

getDescription

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

Deprecated.

(deprecated) `AWS::ApiGatewayV2::Stage.Description`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-description

getRouteSettings

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

Deprecated.

(deprecated) `AWS::ApiGatewayV2::Stage.RouteSettings`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-routesettings

getStageVariables

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

Deprecated.

(deprecated) `AWS::ApiGatewayV2::Stage.StageVariables`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-stagevariables

getTags

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

Deprecated.

(deprecated) `AWS::ApiGatewayV2::Stage.Tags`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-tags

builder

@Stability(value=Deprecated)
 @Deprecated
static CfnStageV2Props.Builder builder()

Deprecated.

Returns:

a CfnStageV2Props.Builder of CfnStageV2Props