@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)", date="2023-01-31T18:36:56.670Z") public class CfnStage extends CfnResource implements IInspectable
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();
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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
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) |
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` .
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnStage(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnStage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnStage(Construct scope, java.lang.String id, CfnStageProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
Each tag element is associated with a given resource.
public java.lang.String getApiId()
public void setApiId(java.lang.String value)
public java.lang.Object getRouteSettings()
public void setRouteSettings(java.lang.Object value)
public java.lang.String getStageName()
Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default
. Maximum length is 128 characters.
public void setStageName(java.lang.String value)
Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default
. Maximum length is 128 characters.
public java.lang.Object getStageVariables()
Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
public void setStageVariables(java.lang.Object value)
Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
public java.lang.Object getAccessLogSettings()
public void setAccessLogSettings(IResolvable value)
public void setAccessLogSettings(CfnStage.AccessLogSettingsProperty value)
public java.lang.String getAccessPolicyId()
public void setAccessPolicyId(java.lang.String value)
public java.lang.Object getAutoDeploy()
The default value is false
.
public void setAutoDeploy(java.lang.Boolean value)
The default value is false
.
public void setAutoDeploy(IResolvable value)
The default value is false
.
public java.lang.String getClientCertificateId()
Supported only for WebSocket APIs.
public void setClientCertificateId(java.lang.String value)
Supported only for WebSocket APIs.
public java.lang.Object getDefaultRouteSettings()
public void setDefaultRouteSettings(IResolvable value)
public void setDefaultRouteSettings(CfnStage.RouteSettingsProperty value)
public java.lang.String getDeploymentId()
Can't be updated if autoDeploy
is enabled.
public void setDeploymentId(java.lang.String value)
Can't be updated if autoDeploy
is enabled.
public java.lang.String getDescription()
public void setDescription(java.lang.String value)