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.29.0 (build 41df200)",
           date="2021-06-02T09:54:56.915Z")
 @Stability(value=Stable)
public class CfnStage
extends CfnResource
implements IInspectable

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnStage.AccessLogSettingsProperty
static class	CfnStage.Builder A fluent builder for CfnStage.
static interface	CfnStage.RouteSettingsProperty

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() `AWS::ApiGatewayV2::Stage.AccessLogSettings`.
String	getAccessPolicyId() `AWS::ApiGatewayV2::Stage.AccessPolicyId`.
String	getApiId() `AWS::ApiGatewayV2::Stage.ApiId`.
Object	getAutoDeploy() `AWS::ApiGatewayV2::Stage.AutoDeploy`.
protected Map<String,Object>	getCfnProperties()
String	getClientCertificateId() `AWS::ApiGatewayV2::Stage.ClientCertificateId`.
Object	getDefaultRouteSettings() `AWS::ApiGatewayV2::Stage.DefaultRouteSettings`.
String	getDeploymentId() `AWS::ApiGatewayV2::Stage.DeploymentId`.
String	getDescription() `AWS::ApiGatewayV2::Stage.Description`.
Object	getRouteSettings() `AWS::ApiGatewayV2::Stage.RouteSettings`.
String	getStageName() `AWS::ApiGatewayV2::Stage.StageName`.
Object	getStageVariables() `AWS::ApiGatewayV2::Stage.StageVariables`.
TagManager	getTags() `AWS::ApiGatewayV2::Stage.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) `AWS::ApiGatewayV2::Stage.AccessLogSettings`.
void	setAccessLogSettings(IResolvable value) `AWS::ApiGatewayV2::Stage.AccessLogSettings`.
void	setAccessPolicyId(String value) `AWS::ApiGatewayV2::Stage.AccessPolicyId`.
void	setApiId(String value) `AWS::ApiGatewayV2::Stage.ApiId`.
void	setAutoDeploy(Boolean value) `AWS::ApiGatewayV2::Stage.AutoDeploy`.
void	setAutoDeploy(IResolvable value) `AWS::ApiGatewayV2::Stage.AutoDeploy`.
void	setClientCertificateId(String value) `AWS::ApiGatewayV2::Stage.ClientCertificateId`.
void	setDefaultRouteSettings(CfnStage.RouteSettingsProperty value) `AWS::ApiGatewayV2::Stage.DefaultRouteSettings`.
void	setDefaultRouteSettings(IResolvable value) `AWS::ApiGatewayV2::Stage.DefaultRouteSettings`.
void	setDeploymentId(String value) `AWS::ApiGatewayV2::Stage.DeploymentId`.
void	setDescription(String value) `AWS::ApiGatewayV2::Stage.Description`.
void	setRouteSettings(Object value) `AWS::ApiGatewayV2::Stage.RouteSettings`.
void	setStageName(String value) `AWS::ApiGatewayV2::Stage.StageName`.
void	setStageVariables(Object value) `AWS::ApiGatewayV2::Stage.StageVariables`.

Methods inherited from class software.amazon.awscdk.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.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()

`AWS::ApiGatewayV2::Stage.Tags`.

getApiId

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

`AWS::ApiGatewayV2::Stage.ApiId`.

setApiId

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

`AWS::ApiGatewayV2::Stage.ApiId`.

getRouteSettings

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

`AWS::ApiGatewayV2::Stage.RouteSettings`.

setRouteSettings

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

`AWS::ApiGatewayV2::Stage.RouteSettings`.

getStageName

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

`AWS::ApiGatewayV2::Stage.StageName`.

setStageName

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

`AWS::ApiGatewayV2::Stage.StageName`.

getStageVariables

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

`AWS::ApiGatewayV2::Stage.StageVariables`.

setStageVariables

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

`AWS::ApiGatewayV2::Stage.StageVariables`.

getAccessLogSettings

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

`AWS::ApiGatewayV2::Stage.AccessLogSettings`.

setAccessLogSettings

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

`AWS::ApiGatewayV2::Stage.AccessLogSettings`.

setAccessLogSettings

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

`AWS::ApiGatewayV2::Stage.AccessLogSettings`.

getAccessPolicyId

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

`AWS::ApiGatewayV2::Stage.AccessPolicyId`.

setAccessPolicyId

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

`AWS::ApiGatewayV2::Stage.AccessPolicyId`.

getAutoDeploy

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

`AWS::ApiGatewayV2::Stage.AutoDeploy`.

setAutoDeploy

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

`AWS::ApiGatewayV2::Stage.AutoDeploy`.

setAutoDeploy

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

`AWS::ApiGatewayV2::Stage.AutoDeploy`.

getClientCertificateId

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

`AWS::ApiGatewayV2::Stage.ClientCertificateId`.

setClientCertificateId

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

`AWS::ApiGatewayV2::Stage.ClientCertificateId`.

getDefaultRouteSettings

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

`AWS::ApiGatewayV2::Stage.DefaultRouteSettings`.

setDefaultRouteSettings

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

`AWS::ApiGatewayV2::Stage.DefaultRouteSettings`.

setDefaultRouteSettings

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

`AWS::ApiGatewayV2::Stage.DefaultRouteSettings`.

getDeploymentId

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

`AWS::ApiGatewayV2::Stage.DeploymentId`.

setDeploymentId

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

`AWS::ApiGatewayV2::Stage.DeploymentId`.

getDescription

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

`AWS::ApiGatewayV2::Stage.Description`.

setDescription

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

`AWS::ApiGatewayV2::Stage.Description`.