software.amazon.awscdk.services.apigateway

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

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.46.0 (build cd08c55)",
           date="2021-11-25T20:11:04.757Z")
 @Stability(value=Stable)
public class CfnStage
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ApiGateway::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.*;
 CfnStage cfnStage = CfnStage.Builder.create(this, "MyCfnStage")
         .restApiId("restApiId")
         // the properties below are optional
         .accessLogSetting(AccessLogSettingProperty.builder()
                 .destinationArn("destinationArn")
                 .format("format")
                 .build())
         .cacheClusterEnabled(false)
         .cacheClusterSize("cacheClusterSize")
         .canarySetting(CanarySettingProperty.builder()
                 .deploymentId("deploymentId")
                 .percentTraffic(123)
                 .stageVariableOverrides(Map.of(
                         "stageVariableOverridesKey", "stageVariableOverrides"))
                 .useStageCache(false)
                 .build())
         .clientCertificateId("clientCertificateId")
         .deploymentId("deploymentId")
         .description("description")
         .documentationVersion("documentationVersion")
         .methodSettings(List.of(MethodSettingProperty.builder()
                 .cacheDataEncrypted(false)
                 .cacheTtlInSeconds(123)
                 .cachingEnabled(false)
                 .dataTraceEnabled(false)
                 .httpMethod("httpMethod")
                 .loggingLevel("loggingLevel")
                 .metricsEnabled(false)
                 .resourcePath("resourcePath")
                 .throttlingBurstLimit(123)
                 .throttlingRateLimit(123)
                 .build()))
         .stageName("stageName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .tracingEnabled(false)
         .variables(Map.of(
                 "variablesKey", "variables"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnStage.AccessLogSettingProperty Example:
static class	CfnStage.Builder A fluent builder for CfnStage.
static interface	CfnStage.CanarySettingProperty Example:
static interface	CfnStage.MethodSettingProperty Example:

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::ApiGateway::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	getAccessLogSetting() `AWS::ApiGateway::Stage.AccessLogSetting`.
Object	getCacheClusterEnabled() `AWS::ApiGateway::Stage.CacheClusterEnabled`.
String	getCacheClusterSize() `AWS::ApiGateway::Stage.CacheClusterSize`.
Object	getCanarySetting() `AWS::ApiGateway::Stage.CanarySetting`.
protected Map<String,Object>	getCfnProperties()
String	getClientCertificateId() `AWS::ApiGateway::Stage.ClientCertificateId`.
String	getDeploymentId() `AWS::ApiGateway::Stage.DeploymentId`.
String	getDescription() `AWS::ApiGateway::Stage.Description`.
String	getDocumentationVersion() `AWS::ApiGateway::Stage.DocumentationVersion`.
Object	getMethodSettings() `AWS::ApiGateway::Stage.MethodSettings`.
String	getRestApiId() `AWS::ApiGateway::Stage.RestApiId`.
String	getStageName() `AWS::ApiGateway::Stage.StageName`.
TagManager	getTags() `AWS::ApiGateway::Stage.Tags`.
Object	getTracingEnabled() `AWS::ApiGateway::Stage.TracingEnabled`.
Object	getVariables() `AWS::ApiGateway::Stage.Variables`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAccessLogSetting(CfnStage.AccessLogSettingProperty value) `AWS::ApiGateway::Stage.AccessLogSetting`.
void	setAccessLogSetting(IResolvable value) `AWS::ApiGateway::Stage.AccessLogSetting`.
void	setCacheClusterEnabled(Boolean value) `AWS::ApiGateway::Stage.CacheClusterEnabled`.
void	setCacheClusterEnabled(IResolvable value) `AWS::ApiGateway::Stage.CacheClusterEnabled`.
void	setCacheClusterSize(String value) `AWS::ApiGateway::Stage.CacheClusterSize`.
void	setCanarySetting(CfnStage.CanarySettingProperty value) `AWS::ApiGateway::Stage.CanarySetting`.
void	setCanarySetting(IResolvable value) `AWS::ApiGateway::Stage.CanarySetting`.
void	setClientCertificateId(String value) `AWS::ApiGateway::Stage.ClientCertificateId`.
void	setDeploymentId(String value) `AWS::ApiGateway::Stage.DeploymentId`.
void	setDescription(String value) `AWS::ApiGateway::Stage.Description`.
void	setDocumentationVersion(String value) `AWS::ApiGateway::Stage.DocumentationVersion`.
void	setMethodSettings(IResolvable value) `AWS::ApiGateway::Stage.MethodSettings`.
void	setMethodSettings(List<Object> value) `AWS::ApiGateway::Stage.MethodSettings`.
void	setRestApiId(String value) `AWS::ApiGateway::Stage.RestApiId`.
void	setStageName(String value) `AWS::ApiGateway::Stage.StageName`.
void	setTracingEnabled(Boolean value) `AWS::ApiGateway::Stage.TracingEnabled`.
void	setTracingEnabled(IResolvable value) `AWS::ApiGateway::Stage.TracingEnabled`.
void	setVariables(IResolvable value) `AWS::ApiGateway::Stage.Variables`.
void	setVariables(Map<String,String> value) `AWS::ApiGateway::Stage.Variables`.

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::ApiGateway::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.

getAccessLogSetting

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

`AWS::ApiGateway::Stage.AccessLogSetting`.

setAccessLogSetting

@Stability(value=Stable)
public void setAccessLogSetting(@Nullable
                                                         CfnStage.AccessLogSettingProperty value)

`AWS::ApiGateway::Stage.AccessLogSetting`.

setAccessLogSetting

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

`AWS::ApiGateway::Stage.AccessLogSetting`.

getCacheClusterEnabled

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

`AWS::ApiGateway::Stage.CacheClusterEnabled`.

setCacheClusterEnabled

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

`AWS::ApiGateway::Stage.CacheClusterEnabled`.

setCacheClusterEnabled

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

`AWS::ApiGateway::Stage.CacheClusterEnabled`.

getCacheClusterSize

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

`AWS::ApiGateway::Stage.CacheClusterSize`.

setCacheClusterSize

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

`AWS::ApiGateway::Stage.CacheClusterSize`.

getCanarySetting

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

`AWS::ApiGateway::Stage.CanarySetting`.

setCanarySetting

@Stability(value=Stable)
public void setCanarySetting(@Nullable
                                                      CfnStage.CanarySettingProperty value)

`AWS::ApiGateway::Stage.CanarySetting`.

setCanarySetting

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

`AWS::ApiGateway::Stage.CanarySetting`.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getClientCertificateId

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

`AWS::ApiGateway::Stage.ClientCertificateId`.

setClientCertificateId

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

`AWS::ApiGateway::Stage.ClientCertificateId`.

getDeploymentId

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

`AWS::ApiGateway::Stage.DeploymentId`.

setDeploymentId

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

`AWS::ApiGateway::Stage.DeploymentId`.

getDescription

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

`AWS::ApiGateway::Stage.Description`.

setDescription

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

`AWS::ApiGateway::Stage.Description`.

getDocumentationVersion

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

`AWS::ApiGateway::Stage.DocumentationVersion`.

setDocumentationVersion

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

`AWS::ApiGateway::Stage.DocumentationVersion`.

getMethodSettings

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

`AWS::ApiGateway::Stage.MethodSettings`.

setMethodSettings

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

`AWS::ApiGateway::Stage.MethodSettings`.

setMethodSettings

@Stability(value=Stable)
public void setMethodSettings(@Nullable
                                                       List<Object> value)

`AWS::ApiGateway::Stage.MethodSettings`.

getRestApiId

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

`AWS::ApiGateway::Stage.RestApiId`.

setRestApiId

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

`AWS::ApiGateway::Stage.RestApiId`.

getStageName

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

`AWS::ApiGateway::Stage.StageName`.

setStageName

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

`AWS::ApiGateway::Stage.StageName`.

getTags

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

`AWS::ApiGateway::Stage.Tags`.

getTracingEnabled

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

`AWS::ApiGateway::Stage.TracingEnabled`.

setTracingEnabled

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

`AWS::ApiGateway::Stage.TracingEnabled`.

setTracingEnabled

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

`AWS::ApiGateway::Stage.TracingEnabled`.

getVariables

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

`AWS::ApiGateway::Stage.Variables`.

setVariables

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

`AWS::ApiGateway::Stage.Variables`.

setVariables

@Stability(value=Stable)
public void setVariables(@Nullable
                                                  Map<String,String> value)

`AWS::ApiGateway::Stage.Variables`.