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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.134Z")
 @Stability(value=Stable)
public class CfnStage
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ApiGateway::Stage`.

The AWS::ApiGateway::Stage resource creates a stage for a deployment.

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 The `AccessLogSetting` property type specifies settings for logging access in this stage.
static class	CfnStage.Builder A fluent builder for CfnStage.
static interface	CfnStage.CanarySettingProperty The `CanarySetting` property type specifies settings for the canary deployment in this stage.
static interface	CfnStage.MethodSettingProperty The `MethodSetting` property type configures settings for all methods in a stage.

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() Specifies settings for logging access in this stage.
Object	getCacheClusterEnabled() Indicates whether cache clustering is enabled for the stage.
String	getCacheClusterSize() The stage's cache cluster size.
Object	getCanarySetting() Specifies settings for the canary deployment in this stage.
protected Map<String,Object>	getCfnProperties()
String	getClientCertificateId() The ID of the client certificate that API Gateway uses to call your integration endpoints in the stage.
String	getDeploymentId() The ID of the deployment that the stage is associated with.
String	getDescription() A description of the stage.
String	getDocumentationVersion() The version ID of the API documentation snapshot.
Object	getMethodSettings() Settings for all methods in the stage.
String	getRestApiId() The ID of the `RestApi` resource that you're deploying with this stage.
String	getStageName() The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI).
TagManager	getTags() An array of arbitrary tags (key-value pairs) to associate with the stage.
Object	getTracingEnabled() Specifies whether active X-Ray tracing is enabled for this stage.
Object	getVariables() A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value.
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) Specifies settings for logging access in this stage.
void	setAccessLogSetting(IResolvable value) Specifies settings for logging access in this stage.
void	setCacheClusterEnabled(Boolean value) Indicates whether cache clustering is enabled for the stage.
void	setCacheClusterEnabled(IResolvable value) Indicates whether cache clustering is enabled for the stage.
void	setCacheClusterSize(String value) The stage's cache cluster size.
void	setCanarySetting(CfnStage.CanarySettingProperty value) Specifies settings for the canary deployment in this stage.
void	setCanarySetting(IResolvable value) Specifies settings for the canary deployment in this stage.
void	setClientCertificateId(String value) The ID of the client certificate that API Gateway uses to call your integration endpoints in the stage.
void	setDeploymentId(String value) The ID of the deployment that the stage is associated with.
void	setDescription(String value) A description of the stage.
void	setDocumentationVersion(String value) The version ID of the API documentation snapshot.
void	setMethodSettings(IResolvable value) Settings for all methods in the stage.
void	setMethodSettings(List<Object> value) Settings for all methods in the stage.
void	setRestApiId(String value) The ID of the `RestApi` resource that you're deploying with this stage.
void	setStageName(String value) The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI).
void	setTracingEnabled(Boolean value) Specifies whether active X-Ray tracing is enabled for this stage.
void	setTracingEnabled(IResolvable value) Specifies whether active X-Ray tracing is enabled for this stage.
void	setVariables(IResolvable value) A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value.
void	setVariables(Map<String,String> value) A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value.

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

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

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

An array of arbitrary tags (key-value pairs) to associate with the stage.

getRestApiId

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

The ID of the `RestApi` resource that you're deploying with this stage.

setRestApiId

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

The ID of the `RestApi` resource that you're deploying with this stage.

getAccessLogSetting

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

Specifies settings for logging access in this stage.

setAccessLogSetting

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

Specifies settings for logging access in this stage.

setAccessLogSetting

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

Specifies settings for logging access in this stage.

getCacheClusterEnabled

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

Indicates whether cache clustering is enabled for the stage.

setCacheClusterEnabled

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

Indicates whether cache clustering is enabled for the stage.

setCacheClusterEnabled

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

Indicates whether cache clustering is enabled for the stage.

getCacheClusterSize

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

The stage's cache cluster size.

setCacheClusterSize

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

The stage's cache cluster size.

getCanarySetting

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

Specifies settings for the canary deployment in this stage.

setCanarySetting

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

Specifies settings for the canary deployment in this stage.

setCanarySetting

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

Specifies settings for the canary deployment in this stage.

getClientCertificateId

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

The ID of the client certificate that API Gateway uses to call your integration endpoints in the stage.

setClientCertificateId

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

The ID of the client certificate that API Gateway uses to call your integration endpoints in the stage.

getDeploymentId

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

The ID of the deployment that the stage is associated with.

This parameter is required to create a stage.

setDeploymentId

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

The ID of the deployment that the stage is associated with.

This parameter is required to create a stage.

getDescription

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

A description of the stage.

setDescription

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

A description of the stage.

getDocumentationVersion

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

The version ID of the API documentation snapshot.

setDocumentationVersion

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

The version ID of the API documentation snapshot.

getMethodSettings

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

Settings for all methods in the stage.

setMethodSettings

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

Settings for all methods in the stage.

setMethodSettings

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

Settings for all methods in the stage.

getStageName

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

The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI).

setStageName

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

The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI).

getTracingEnabled

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

Specifies whether active X-Ray tracing is enabled for this stage.

For more information, see Trace API Gateway API Execution with AWS X-Ray in the API Gateway Developer Guide .

setTracingEnabled

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

Specifies whether active X-Ray tracing is enabled for this stage.

For more information, see Trace API Gateway API Execution with AWS X-Ray in the API Gateway Developer Guide .

setTracingEnabled

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

Specifies whether active X-Ray tracing is enabled for this stage.

For more information, see Trace API Gateway API Execution with AWS X-Ray in the API Gateway Developer Guide .

getVariables

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

A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value.

Variable names are limited to alphanumeric characters. Values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+ .

setVariables

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

A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value.

Variable names are limited to alphanumeric characters. Values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+ .

setVariables

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

A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value.

Variable names are limited to alphanumeric characters. Values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+ .