CfnStage

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.apigatewayv2.CfnStage

All Implemented Interfaces:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:56.670Z")
public class CfnStage
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ApiGatewayV2::Stage`.

The AWS::ApiGatewayV2::Stage resource specifies a stage for an API. Each stage is a named reference to a deployment of the API and is made available for client applications to call. To learn more, see Working with stages for HTTP APIs and Deploy a WebSocket API in API Gateway .

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;
 CfnStage cfnStage = CfnStage.Builder.create(this, "MyCfnStage")
         .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	Class and Description
`static interface`	`CfnStage.AccessLogSettingsProperty` Settings for logging access in a stage.
`static class`	`CfnStage.Builder` A fluent builder for `CfnStage`.
`static interface`	`CfnStage.RouteSettingsProperty` Represents a collection of route settings.

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
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnStage(Construct scope, java.lang.String id, CfnStageProps props)` Create a new `AWS::ApiGatewayV2::Stage`.
`protected`	`CfnStage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnStage(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`getAccessLogSettings()` Settings for logging access in this stage.
`java.lang.String`	`getAccessPolicyId()` This parameter is not currently supported.
`java.lang.String`	`getApiId()` The API identifier.
`java.lang.Object`	`getAutoDeploy()` Specifies whether updates to an API automatically trigger a new deployment.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.String`	`getClientCertificateId()` The identifier of a client certificate for a `Stage` .
`java.lang.Object`	`getDefaultRouteSettings()` The default route settings for the stage.
`java.lang.String`	`getDeploymentId()` The deployment identifier for the API stage.
`java.lang.String`	`getDescription()` The description for the API stage.
`java.lang.Object`	`getRouteSettings()` Route settings for the stage.
`java.lang.String`	`getStageName()` The stage name.
`java.lang.Object`	`getStageVariables()` A map that defines the stage variables for a `Stage` .
`TagManager`	`getTags()` The collection of tags.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setAccessLogSettings(CfnStage.AccessLogSettingsProperty value)` Settings for logging access in this stage.
`void`	`setAccessLogSettings(IResolvable value)` Settings for logging access in this stage.
`void`	`setAccessPolicyId(java.lang.String value)` This parameter is not currently supported.
`void`	`setApiId(java.lang.String value)` The API identifier.
`void`	`setAutoDeploy(java.lang.Boolean value)` Specifies whether updates to an API automatically trigger a new deployment.
`void`	`setAutoDeploy(IResolvable value)` Specifies whether updates to an API automatically trigger a new deployment.
`void`	`setClientCertificateId(java.lang.String value)` The identifier of a client certificate for a `Stage` .
`void`	`setDefaultRouteSettings(CfnStage.RouteSettingsProperty value)` The default route settings for the stage.
`void`	`setDefaultRouteSettings(IResolvable value)` The default route settings for the stage.
`void`	`setDeploymentId(java.lang.String value)` The deployment identifier for the API stage.
`void`	`setDescription(java.lang.String value)` The description for the API stage.
`void`	`setRouteSettings(java.lang.Object value)` Route settings for the stage.
`void`	`setStageName(java.lang.String value)` The stage name.
`void`	`setStageVariables(java.lang.Object value)` A map that defines the stage variables for a `Stage` .

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
```
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnStage
```
protected CfnStage(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnStage
```
protected CfnStage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnStage
```
public CfnStage(Construct scope,
                java.lang.String id,
                CfnStageProps props)
```
    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
```
public void inspect(TreeInspector inspector)
```
    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
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
public TagManager getTags()
```
    The collection of tags.
    Each tag element is associated with a given resource.
  - getApiId
```
public java.lang.String getApiId()
```
    The API identifier.
  - setApiId
```
public void setApiId(java.lang.String value)
```
    The API identifier.
  - getRouteSettings
```
public java.lang.Object getRouteSettings()
```
    Route settings for the stage.
  - setRouteSettings
```
public void setRouteSettings(java.lang.Object value)
```
    Route settings for the stage.
  - getStageName
```
public 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.
  - setStageName
```
public void setStageName(java.lang.String value)
```
    The stage name.
    Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default . Maximum length is 128 characters.
  - getStageVariables
```
public 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-._~:/?#&=,]+.
  - setStageVariables
```
public void setStageVariables(java.lang.Object value)
```
    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-._~:/?#&=,]+.
  - getAccessLogSettings
```
public java.lang.Object getAccessLogSettings()
```
    Settings for logging access in this stage.
  - setAccessLogSettings
```
public void setAccessLogSettings(IResolvable value)
```
    Settings for logging access in this stage.
  - setAccessLogSettings
```
public void setAccessLogSettings(CfnStage.AccessLogSettingsProperty value)
```
    Settings for logging access in this stage.
  - getAccessPolicyId
```
public java.lang.String getAccessPolicyId()
```
    This parameter is not currently supported.
  - setAccessPolicyId
```
public void setAccessPolicyId(java.lang.String value)
```
    This parameter is not currently supported.
  - getAutoDeploy
```
public java.lang.Object getAutoDeploy()
```
    Specifies whether updates to an API automatically trigger a new deployment.
    The default value is false .
  - setAutoDeploy
```
public void setAutoDeploy(java.lang.Boolean value)
```
    Specifies whether updates to an API automatically trigger a new deployment.
    The default value is false .
  - setAutoDeploy
```
public void setAutoDeploy(IResolvable value)
```
    Specifies whether updates to an API automatically trigger a new deployment.
    The default value is false .
  - getClientCertificateId
```
public java.lang.String getClientCertificateId()
```
    The identifier of a client certificate for a `Stage` .
    Supported only for WebSocket APIs.
  - setClientCertificateId
```
public void setClientCertificateId(java.lang.String value)
```
    The identifier of a client certificate for a `Stage` .
    Supported only for WebSocket APIs.
  - getDefaultRouteSettings
```
public java.lang.Object getDefaultRouteSettings()
```
    The default route settings for the stage.
  - setDefaultRouteSettings
```
public void setDefaultRouteSettings(IResolvable value)
```
    The default route settings for the stage.
  - setDefaultRouteSettings
```
public void setDefaultRouteSettings(CfnStage.RouteSettingsProperty value)
```
    The default route settings for the stage.
  - getDeploymentId
```
public java.lang.String getDeploymentId()
```
    The deployment identifier for the API stage.
    Can't be updated if autoDeploy is enabled.
  - setDeploymentId
```
public void setDeploymentId(java.lang.String value)
```
    The deployment identifier for the API stage.
    Can't be updated if autoDeploy is enabled.
  - getDescription
```
public java.lang.String getDescription()
```
    The description for the API stage.
  - setDescription
```
public void setDescription(java.lang.String value)
```
    The description for the API stage.

Class CfnStage

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

CfnStage

CfnStage

CfnStage

Method Detail

inspect

renderProperties

getCfnProperties

getTags

getApiId

setApiId

getRouteSettings

setRouteSettings

getStageName

setStageName

getStageVariables

setStageVariables

getAccessLogSettings

setAccessLogSettings

setAccessLogSettings

getAccessPolicyId

setAccessPolicyId

getAutoDeploy

setAutoDeploy

setAutoDeploy

getClientCertificateId

setClientCertificateId

getDefaultRouteSettings

setDefaultRouteSettings

setDefaultRouteSettings

getDeploymentId

setDeploymentId

getDescription

setDescription