Package software.amazon.awscdk.services.apigateway

Class CfnStageV2

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.apigateway.CfnStageV2

All Implemented Interfaces:

IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:44.889Z")
@Stability(Deprecated)
@Deprecated
public class CfnStageV2
extends CfnResource
implements IInspectable

Deprecated.

moved to package aws-apigatewayv2

(deprecated) A CloudFormation 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;
 CfnStageV2 cfnStageV2 = CfnStageV2.Builder.create(this, "MyCfnStageV2")
         .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	Class	Description
static interface	CfnStageV2.AccessLogSettingsProperty	Deprecated. moved to package aws-apigatewayv2
static final class	CfnStageV2.Builder	Deprecated.
static interface	CfnStageV2.RouteSettingsProperty	Deprecated. moved to package aws-apigatewayv2

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	Deprecated.

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnStageV2(Construct scope, String id, CfnStageV2Props props)	Deprecated.
protected	CfnStageV2(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)	Deprecated.
protected	CfnStageV2(software.amazon.jsii.JsiiObjectRef objRef)	Deprecated.

Method Summary

Modifier and Type	Method	Description
Object	getAccessLogSettings()	Deprecated.
String	getApiId()	Deprecated.
Object	getAutoDeploy()	Deprecated.
protected Map<String,Object>	getCfnProperties()	Deprecated.
String	getClientCertificateId()	Deprecated.
Object	getDefaultRouteSettings()	Deprecated.
String	getDeploymentId()	Deprecated.
String	getDescription()	Deprecated.
Object	getRouteSettings()	Deprecated.
String	getStageName()	Deprecated.
Object	getStageVariables()	Deprecated.
TagManager	getTags()	Deprecated.
void	inspect(TreeInspector inspector)	Deprecated.
protected Map<String,Object>	renderProperties(Map<String,Object> props)	Deprecated.
void	setAccessLogSettings(IResolvable value)	Deprecated.
void	setAccessLogSettings(CfnStageV2.AccessLogSettingsProperty value)	Deprecated.
void	setApiId(String value)	Deprecated.
void	setAutoDeploy(Boolean value)	Deprecated.
void	setAutoDeploy(IResolvable value)	Deprecated.
void	setClientCertificateId(String value)	Deprecated.
void	setDefaultRouteSettings(IResolvable value)	Deprecated.
void	setDefaultRouteSettings(CfnStageV2.RouteSettingsProperty value)	Deprecated.
void	setDeploymentId(String value)	Deprecated.
void	setDescription(String value)	Deprecated.
void	setRouteSettings(Object value)	Deprecated.
void	setStageName(String value)	Deprecated.
void	setStageVariables(Object value)	Deprecated.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Deprecated)
@Deprecated
public static final String CFN_RESOURCE_TYPE_NAME

Deprecated.

(deprecated) The CloudFormation resource type name for this resource class.

Constructor Details

CfnStageV2

protected CfnStageV2(software.amazon.jsii.JsiiObjectRef objRef)

Deprecated.

CfnStageV2

protected CfnStageV2(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Deprecated.

CfnStageV2

@Stability(Deprecated)
@Deprecated
public CfnStageV2(@NotNull
 Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnStageV2Props props)

Deprecated.

(deprecated) Create a new AWS::ApiGatewayV2::Stage.

Parameters:

scope -

• scope in which this resource is defined.

This parameter is required.

id -

• scoped id of the resource.

This parameter is required.

props -

• resource properties.

This parameter is required.

Method Details

inspect

@Stability(Deprecated)
@Deprecated
public void inspect(@NotNull
 TreeInspector inspector)

Deprecated.

(deprecated) Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector -

• tree inspector to collect and process attributes.

This parameter is required.

renderProperties

@Stability(Deprecated)
@Deprecated
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Deprecated.

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(Deprecated)
@Deprecated
@NotNull
protected Map<String,Object> getCfnProperties()

Deprecated.

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(Deprecated)
@Deprecated
@NotNull
public TagManager 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

getApiId

@Stability(Deprecated)
@Deprecated
@NotNull
public 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

setApiId

@Stability(Deprecated)
@Deprecated
public void setApiId(@NotNull
 String value)

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

getRouteSettings

@Stability(Deprecated)
@Deprecated
@NotNull
public 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

setRouteSettings

@Stability(Deprecated)
@Deprecated
public void setRouteSettings(@NotNull
 Object value)

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

getStageName

@Stability(Deprecated)
@Deprecated
@NotNull
public 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

setStageName

@Stability(Deprecated)
@Deprecated
public void setStageName(@NotNull
 String value)

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

getStageVariables

@Stability(Deprecated)
@Deprecated
@NotNull
public 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

setStageVariables

@Stability(Deprecated)
@Deprecated
public void setStageVariables(@NotNull
 Object value)

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

getAccessLogSettings

@Stability(Deprecated)
@Deprecated
@Nullable
public 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

setAccessLogSettings

@Stability(Deprecated)
@Deprecated
public void setAccessLogSettings(@Nullable
 IResolvable value)

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

setAccessLogSettings

@Stability(Deprecated)
@Deprecated
public void setAccessLogSettings(@Nullable
 CfnStageV2.AccessLogSettingsProperty value)

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(Deprecated)
@Deprecated
@Nullable
public 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

setAutoDeploy

@Stability(Deprecated)
@Deprecated
public void setAutoDeploy(@Nullable
 Boolean value)

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

setAutoDeploy

@Stability(Deprecated)
@Deprecated
public void setAutoDeploy(@Nullable
 IResolvable value)

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(Deprecated)
@Deprecated
@Nullable
public 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

setClientCertificateId

@Stability(Deprecated)
@Deprecated
public void setClientCertificateId(@Nullable
 String value)

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(Deprecated)
@Deprecated
@Nullable
public 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

setDefaultRouteSettings

@Stability(Deprecated)
@Deprecated
public void setDefaultRouteSettings(@Nullable
 IResolvable value)

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

setDefaultRouteSettings

@Stability(Deprecated)
@Deprecated
public void setDefaultRouteSettings(@Nullable
 CfnStageV2.RouteSettingsProperty value)

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(Deprecated)
@Deprecated
@Nullable
public 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

setDeploymentId

@Stability(Deprecated)
@Deprecated
public void setDeploymentId(@Nullable
 String value)

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(Deprecated)
@Deprecated
@Nullable
public 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

setDescription

@Stability(Deprecated)
@Deprecated
public void setDescription(@Nullable
 String value)

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