CfnStageV2

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

Deprecated.

moved to package aws-apigatewayv2

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:47.581Z")
 @Deprecated
public class CfnStageV2
extends CfnResource
implements IInspectable

(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 and Description
`static interface`	`CfnStageV2.AccessLogSettingsProperty` Deprecated. moved to package aws-apigatewayv2
`static class`	`CfnStageV2.Builder` Deprecated.
`static interface`	`CfnStageV2.RouteSettingsProperty` Deprecated. moved to package aws-apigatewayv2

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
Deprecated.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CFN_RESOURCE_TYPE_NAME` Deprecated.

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`java.lang.Object`	`getAccessLogSettings()` Deprecated.
`java.lang.String`	`getApiId()` Deprecated.
`java.lang.Object`	`getAutoDeploy()` Deprecated.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()` Deprecated.
`java.lang.String`	`getClientCertificateId()` Deprecated.
`java.lang.Object`	`getDefaultRouteSettings()` Deprecated.
`java.lang.String`	`getDeploymentId()` Deprecated.
`java.lang.String`	`getDescription()` Deprecated.
`java.lang.Object`	`getRouteSettings()` Deprecated.
`java.lang.String`	`getStageName()` Deprecated.
`java.lang.Object`	`getStageVariables()` Deprecated.
`TagManager`	`getTags()` Deprecated.
`void`	`inspect(TreeInspector inspector)` Deprecated.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)` Deprecated.
`void`	`setAccessLogSettings(CfnStageV2.AccessLogSettingsProperty value)` Deprecated.
`void`	`setAccessLogSettings(IResolvable value)` Deprecated.
`void`	`setApiId(java.lang.String value)` Deprecated.
`void`	`setAutoDeploy(java.lang.Boolean value)` Deprecated.
`void`	`setAutoDeploy(IResolvable value)` Deprecated.
`void`	`setClientCertificateId(java.lang.String value)` Deprecated.
`void`	`setDefaultRouteSettings(CfnStageV2.RouteSettingsProperty value)` Deprecated.
`void`	`setDefaultRouteSettings(IResolvable value)` Deprecated.
`void`	`setDeploymentId(java.lang.String value)` Deprecated.
`void`	`setDescription(java.lang.String value)` Deprecated.
`void`	`setRouteSettings(java.lang.Object value)` Deprecated.
`void`	`setStageName(java.lang.String value)` Deprecated.
`void`	`setStageVariables(java.lang.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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
@Deprecated
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
```
    Deprecated.
    
    (deprecated) The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnStageV2
```
protected CfnStageV2(software.amazon.jsii.JsiiObjectRef objRef)
```
    Deprecated.
  - CfnStageV2
```
protected CfnStageV2(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
    Deprecated.
  - CfnStageV2
```
@Deprecated
public CfnStageV2(Construct scope,
                              java.lang.String id,
                              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 Detail
  - inspect
```
@Deprecated
public void inspect(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
```
@Deprecated
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Deprecated.
    
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getCfnProperties
```
@Deprecated
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Deprecated.
    
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
@Deprecated
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
```
@Deprecated
public java.lang.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
```
@Deprecated
public void setApiId(java.lang.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
```
@Deprecated
public java.lang.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
```
@Deprecated
public void setRouteSettings(java.lang.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
```
@Deprecated
public java.lang.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
```
@Deprecated
public void setStageName(java.lang.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
```
@Deprecated
public java.lang.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
```
@Deprecated
public void setStageVariables(java.lang.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
```
@Deprecated
public java.lang.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
```
@Deprecated
public void setAccessLogSettings(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
```
@Deprecated
public void setAccessLogSettings(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
```
@Deprecated
public java.lang.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
```
@Deprecated
public void setAutoDeploy(java.lang.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
```
@Deprecated
public void setAutoDeploy(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
```
@Deprecated
public java.lang.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
```
@Deprecated
public void setClientCertificateId(java.lang.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
```
@Deprecated
public java.lang.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
```
@Deprecated
public void setDefaultRouteSettings(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
```
@Deprecated
public void setDefaultRouteSettings(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
```
@Deprecated
public java.lang.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
```
@Deprecated
public void setDeploymentId(java.lang.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
```
@Deprecated
public java.lang.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
```
@Deprecated
public void setDescription(java.lang.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

Class CfnStageV2

Nested Class Summary

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

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

Field Summary

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnStageV2

CfnStageV2

CfnStageV2

Method Detail

inspect

renderProperties

getCfnProperties

getTags

getApiId

setApiId

getRouteSettings

setRouteSettings

getStageName

setStageName

getStageVariables

setStageVariables

getAccessLogSettings

setAccessLogSettings

setAccessLogSettings

getAutoDeploy

setAutoDeploy

setAutoDeploy

getClientCertificateId

setClientCertificateId

getDefaultRouteSettings

setDefaultRouteSettings

setDefaultRouteSettings

getDeploymentId

setDeploymentId

getDescription

setDescription