software.amazon.awscdk.services.apigatewayv2

Class CfnStage

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.apigatewayv2.CfnStage

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.290Z")
 @Stability(value=Stable)
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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnStage(software.constructs.Construct scope, 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

Modifier and Type	Method and Description
Object	getAccessLogSettings() Settings for logging access in this stage.
String	getAccessPolicyId() This parameter is not currently supported.
String	getApiId() The API identifier.
Object	getAutoDeploy() Specifies whether updates to an API automatically trigger a new deployment.
protected Map<String,Object>	getCfnProperties()
String	getClientCertificateId() The identifier of a client certificate for a `Stage` .
Object	getDefaultRouteSettings() The default route settings for the stage.
String	getDeploymentId() The deployment identifier for the API stage.
String	getDescription() The description for the API stage.
Object	getRouteSettings() Route settings for the stage.
String	getStageName() The stage name.
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 Map<String,Object>	renderProperties(Map<String,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(String value) This parameter is not currently supported.
void	setApiId(String value) The API identifier.
void	setAutoDeploy(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(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(String value) The deployment identifier for the API stage.
void	setDescription(String value) The description for the API stage.
void	setRouteSettings(Object value) Route settings for the stage.
void	setStageName(String value) The stage name.
void	setStageVariables(Object value) A map that defines the stage variables for a `Stage` .

Methods inherited from class software.amazon.awscdk.CfnResource

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

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnStage(@NotNull
                                         software.constructs.Construct scope,
                                         @NotNull
                                         String id,
                                         @NotNull
                                         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

@Stability(value=Stable)
public void inspect(@NotNull
                                             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

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

The collection of tags.

Each tag element is associated with a given resource.

getApiId

@Stability(value=Stable)
 @NotNull
public String getApiId()

The API identifier.

setApiId

@Stability(value=Stable)
public void setApiId(@NotNull
                                              String value)

The API identifier.

getRouteSettings

@Stability(value=Stable)
 @NotNull
public Object getRouteSettings()

Route settings for the stage.

setRouteSettings

@Stability(value=Stable)
public void setRouteSettings(@NotNull
                                                      Object value)

Route settings for the stage.

getStageName

@Stability(value=Stable)
 @NotNull
public String getStageName()

The stage name.

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

setStageName

@Stability(value=Stable)
public void setStageName(@NotNull
                                                  String value)

The stage name.

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

getStageVariables

@Stability(value=Stable)
 @NotNull
public 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

@Stability(value=Stable)
public void setStageVariables(@NotNull
                                                       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

@Stability(value=Stable)
 @Nullable
public Object getAccessLogSettings()

Settings for logging access in this stage.

setAccessLogSettings

@Stability(value=Stable)
public void setAccessLogSettings(@Nullable
                                                          CfnStage.AccessLogSettingsProperty value)

Settings for logging access in this stage.

setAccessLogSettings

@Stability(value=Stable)
public void setAccessLogSettings(@Nullable
                                                          IResolvable value)

Settings for logging access in this stage.

getAccessPolicyId

@Stability(value=Stable)
 @Nullable
public String getAccessPolicyId()

This parameter is not currently supported.

setAccessPolicyId

@Stability(value=Stable)
public void setAccessPolicyId(@Nullable
                                                       String value)

This parameter is not currently supported.

getAutoDeploy

@Stability(value=Stable)
 @Nullable
public Object getAutoDeploy()

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

The default value is false .

setAutoDeploy

@Stability(value=Stable)
public void setAutoDeploy(@Nullable
                                                   Boolean value)

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

The default value is false .

setAutoDeploy

@Stability(value=Stable)
public void setAutoDeploy(@Nullable
                                                   IResolvable value)

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

The default value is false .

getClientCertificateId

@Stability(value=Stable)
 @Nullable
public String getClientCertificateId()

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

Supported only for WebSocket APIs.

setClientCertificateId

@Stability(value=Stable)
public void setClientCertificateId(@Nullable
                                                            String value)

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

Supported only for WebSocket APIs.

getDefaultRouteSettings

@Stability(value=Stable)
 @Nullable
public Object getDefaultRouteSettings()

The default route settings for the stage.

setDefaultRouteSettings

@Stability(value=Stable)
public void setDefaultRouteSettings(@Nullable
                                                             CfnStage.RouteSettingsProperty value)

The default route settings for the stage.

setDefaultRouteSettings

@Stability(value=Stable)
public void setDefaultRouteSettings(@Nullable
                                                             IResolvable value)

The default route settings for the stage.

getDeploymentId

@Stability(value=Stable)
 @Nullable
public String getDeploymentId()

The deployment identifier for the API stage.

Can't be updated if autoDeploy is enabled.

setDeploymentId

@Stability(value=Stable)
public void setDeploymentId(@Nullable
                                                     String value)

The deployment identifier for the API stage.

Can't be updated if autoDeploy is enabled.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

The description for the API stage.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

The description for the API stage.