CfnStage

java.lang.Object
- software.constructs.Construct
- - software.amazon.awscdk.core.Construct
  - - software.amazon.awscdk.core.CfnElement
    - - software.amazon.awscdk.core.CfnRefElement
      - software.amazon.awscdk.core.CfnResource
        
        software.amazon.awscdk.services.apigateway.CfnStage

All Implemented Interfaces:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:47.572Z")
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` Configuration settings of a canary deployment.
`static interface`	`CfnStage.MethodSettingProperty` The `MethodSetting` property type configures settings for all methods in a stage.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

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

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnStage(Construct scope, java.lang.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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`getAccessLogSetting()` Access log settings, including the access log format and access log destination ARN.
`java.lang.Object`	`getCacheClusterEnabled()` Specifies whether a cache cluster is enabled for the stage.
`java.lang.String`	`getCacheClusterSize()` The stage's cache capacity in GB.
`java.lang.Object`	`getCanarySetting()` Settings for the canary deployment in this stage.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.String`	`getClientCertificateId()` The identifier of a client certificate for an API stage.
`java.lang.String`	`getDeploymentId()` The identifier of the Deployment that the stage points to.
`java.lang.String`	`getDescription()` The stage's description.
`java.lang.String`	`getDocumentationVersion()` The version of the associated API documentation.
`java.lang.Object`	`getMethodSettings()` A map that defines the method settings for a Stage resource.
`java.lang.String`	`getRestApiId()` The string identifier of the associated RestApi.
`java.lang.String`	`getStageName()` The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway.
`TagManager`	`getTags()` The collection of tags.
`java.lang.Object`	`getTracingEnabled()` Specifies whether active tracing with X-ray is enabled for the Stage.
`java.lang.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 java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setAccessLogSetting(CfnStage.AccessLogSettingProperty value)` Access log settings, including the access log format and access log destination ARN.
`void`	`setAccessLogSetting(IResolvable value)` Access log settings, including the access log format and access log destination ARN.
`void`	`setCacheClusterEnabled(java.lang.Boolean value)` Specifies whether a cache cluster is enabled for the stage.
`void`	`setCacheClusterEnabled(IResolvable value)` Specifies whether a cache cluster is enabled for the stage.
`void`	`setCacheClusterSize(java.lang.String value)` The stage's cache capacity in GB.
`void`	`setCanarySetting(CfnStage.CanarySettingProperty value)` Settings for the canary deployment in this stage.
`void`	`setCanarySetting(IResolvable value)` Settings for the canary deployment in this stage.
`void`	`setClientCertificateId(java.lang.String value)` The identifier of a client certificate for an API stage.
`void`	`setDeploymentId(java.lang.String value)` The identifier of the Deployment that the stage points to.
`void`	`setDescription(java.lang.String value)` The stage's description.
`void`	`setDocumentationVersion(java.lang.String value)` The version of the associated API documentation.
`void`	`setMethodSettings(IResolvable value)` A map that defines the method settings for a Stage resource.
`void`	`setMethodSettings(java.util.List<java.lang.Object> value)` A map that defines the method settings for a Stage resource.
`void`	`setRestApiId(java.lang.String value)` The string identifier of the associated RestApi.
`void`	`setStageName(java.lang.String value)` The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway.
`void`	`setTracingEnabled(java.lang.Boolean value)` Specifies whether active tracing with X-ray is enabled for the Stage.
`void`	`setTracingEnabled(IResolvable value)` Specifies whether active tracing with X-ray is enabled for the 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(java.util.Map<java.lang.String,java.lang.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.core.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.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.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
```
public CfnStage(Construct scope,
                java.lang.String id,
                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
```
public void inspect(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
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
public TagManager getTags()
```
    The collection of tags.
    Each tag element is associated with a given resource.
  - getRestApiId
```
public java.lang.String getRestApiId()
```
    The string identifier of the associated RestApi.
  - setRestApiId
```
public void setRestApiId(java.lang.String value)
```
    The string identifier of the associated RestApi.
  - getAccessLogSetting
```
public java.lang.Object getAccessLogSetting()
```
    Access log settings, including the access log format and access log destination ARN.
  - setAccessLogSetting
```
public void setAccessLogSetting(IResolvable value)
```
    Access log settings, including the access log format and access log destination ARN.
  - setAccessLogSetting
```
public void setAccessLogSetting(CfnStage.AccessLogSettingProperty value)
```
    Access log settings, including the access log format and access log destination ARN.
  - getCacheClusterEnabled
```
public java.lang.Object getCacheClusterEnabled()
```
    Specifies whether a cache cluster is enabled for the stage.
  - setCacheClusterEnabled
```
public void setCacheClusterEnabled(java.lang.Boolean value)
```
    Specifies whether a cache cluster is enabled for the stage.
  - setCacheClusterEnabled
```
public void setCacheClusterEnabled(IResolvable value)
```
    Specifies whether a cache cluster is enabled for the stage.
  - getCacheClusterSize
```
public java.lang.String getCacheClusterSize()
```
    The stage's cache capacity in GB.
    For more information about choosing a cache size, see Enabling API caching to enhance responsiveness .
  - setCacheClusterSize
```
public void setCacheClusterSize(java.lang.String value)
```
    The stage's cache capacity in GB.
    For more information about choosing a cache size, see Enabling API caching to enhance responsiveness .
  - getCanarySetting
```
public java.lang.Object getCanarySetting()
```
    Settings for the canary deployment in this stage.
  - setCanarySetting
```
public void setCanarySetting(IResolvable value)
```
    Settings for the canary deployment in this stage.
  - setCanarySetting
```
public void setCanarySetting(CfnStage.CanarySettingProperty value)
```
    Settings for the canary deployment in this stage.
  - getClientCertificateId
```
public java.lang.String getClientCertificateId()
```
    The identifier of a client certificate for an API stage.
  - setClientCertificateId
```
public void setClientCertificateId(java.lang.String value)
```
    The identifier of a client certificate for an API stage.
  - getDeploymentId
```
public java.lang.String getDeploymentId()
```
    The identifier of the Deployment that the stage points to.
  - setDeploymentId
```
public void setDeploymentId(java.lang.String value)
```
    The identifier of the Deployment that the stage points to.
  - getDescription
```
public java.lang.String getDescription()
```
    The stage's description.
  - setDescription
```
public void setDescription(java.lang.String value)
```
    The stage's description.
  - getDocumentationVersion
```
public java.lang.String getDocumentationVersion()
```
    The version of the associated API documentation.
  - setDocumentationVersion
```
public void setDocumentationVersion(java.lang.String value)
```
    The version of the associated API documentation.
  - getMethodSettings
```
public java.lang.Object getMethodSettings()
```
    A map that defines the method settings for a Stage resource.
    Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\* /\* for overriding all methods in the stage.
  - setMethodSettings
```
public void setMethodSettings(IResolvable value)
```
    A map that defines the method settings for a Stage resource.
    Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\* /\* for overriding all methods in the stage.
  - setMethodSettings
```
public void setMethodSettings(java.util.List<java.lang.Object> value)
```
    A map that defines the method settings for a Stage resource.
    Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\* /\* for overriding all methods in the stage.
  - getStageName
```
public java.lang.String getStageName()
```
    The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway.
    Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
  - setStageName
```
public void setStageName(java.lang.String value)
```
    The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway.
    Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
  - getTracingEnabled
```
public java.lang.Object getTracingEnabled()
```
    Specifies whether active tracing with X-ray is enabled for the Stage.
  - setTracingEnabled
```
public void setTracingEnabled(java.lang.Boolean value)
```
    Specifies whether active tracing with X-ray is enabled for the Stage.
  - setTracingEnabled
```
public void setTracingEnabled(IResolvable value)
```
    Specifies whether active tracing with X-ray is enabled for the Stage.
  - getVariables
```
public java.lang.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
```
public 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.
    Variable names are limited to alphanumeric characters. Values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+ .
  - setVariables
```
public void setVariables(java.util.Map<java.lang.String,java.lang.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-._~:/?#&=,]+ .

Class CfnStage

Nested Class Summary

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnStage

CfnStage

CfnStage

Method Detail

inspect

renderProperties

getCfnProperties

getTags

getRestApiId

setRestApiId

getAccessLogSetting

setAccessLogSetting

setAccessLogSetting

getCacheClusterEnabled

setCacheClusterEnabled

setCacheClusterEnabled

getCacheClusterSize

setCacheClusterSize

getCanarySetting

setCanarySetting

setCanarySetting

getClientCertificateId

setClientCertificateId

getDeploymentId

setDeploymentId

getDescription

setDescription

getDocumentationVersion

setDocumentationVersion

getMethodSettings

setMethodSettings

setMethodSettings

getStageName

setStageName

getTracingEnabled

setTracingEnabled

setTracingEnabled

getVariables

setVariables

setVariables