software.amazon.awscdk.services.apigateway

Interface CfnStageProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnStageProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.138Z")
 @Stability(value=Stable)
public interface CfnStageProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnStage`.

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.*;
 CfnStageProps cfnStageProps = CfnStageProps.builder()
         .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	Interface and Description
static class	CfnStageProps.Builder A builder for CfnStageProps
static class	CfnStageProps.Jsii$Proxy An implementation for CfnStageProps

Method Summary

Modifier and Type	Method and Description
static CfnStageProps.Builder	builder()
default Object	getAccessLogSetting() Specifies settings for logging access in this stage.
default Object	getCacheClusterEnabled() Indicates whether cache clustering is enabled for the stage.
default String	getCacheClusterSize() The stage's cache cluster size.
default Object	getCanarySetting() Specifies settings for the canary deployment in this stage.
default String	getClientCertificateId() The ID of the client certificate that API Gateway uses to call your integration endpoints in the stage.
default String	getDeploymentId() The ID of the deployment that the stage is associated with.
default String	getDescription() A description of the stage.
default String	getDocumentationVersion() The version ID of the API documentation snapshot.
default Object	getMethodSettings() Settings for all methods in the stage.
String	getRestApiId() The ID of the `RestApi` resource that you're deploying with this stage.
default String	getStageName() The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI).
default List<CfnTag>	getTags() An array of arbitrary tags (key-value pairs) to associate with the stage.
default Object	getTracingEnabled() Specifies whether active X-Ray tracing is enabled for this stage.
default 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.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getRestApiId

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

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

getAccessLogSetting

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

Specifies settings for logging access in this stage.

getCacheClusterEnabled

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

Indicates whether cache clustering is enabled for the stage.

getCacheClusterSize

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

The stage's cache cluster size.

getCanarySetting

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

Specifies settings for the canary deployment in this stage.

getClientCertificateId

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

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

getDeploymentId

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

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

This parameter is required to create a stage.

getDescription

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

A description of the stage.

getDocumentationVersion

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

The version ID of the API documentation snapshot.

getMethodSettings

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

Settings for all methods in the stage.

getStageName

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

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

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

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

getTracingEnabled

@Stability(value=Stable)
 @Nullable
default 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 .

getVariables

@Stability(value=Stable)
 @Nullable
default 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-._~:/?#&=,]+ .

builder

@Stability(value=Stable)
static CfnStageProps.Builder builder()

Returns:

a CfnStageProps.Builder of CfnStageProps