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.46.0 (build cd08c55)",
           date="2021-11-25T20:11:04.759Z")
 @Stability(value=Stable)
public interface CfnStageProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `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.*;
 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() `AWS::ApiGateway::Stage.AccessLogSetting`.
default Object	getCacheClusterEnabled() `AWS::ApiGateway::Stage.CacheClusterEnabled`.
default String	getCacheClusterSize() `AWS::ApiGateway::Stage.CacheClusterSize`.
default Object	getCanarySetting() `AWS::ApiGateway::Stage.CanarySetting`.
default String	getClientCertificateId() `AWS::ApiGateway::Stage.ClientCertificateId`.
default String	getDeploymentId() `AWS::ApiGateway::Stage.DeploymentId`.
default String	getDescription() `AWS::ApiGateway::Stage.Description`.
default String	getDocumentationVersion() `AWS::ApiGateway::Stage.DocumentationVersion`.
default Object	getMethodSettings() `AWS::ApiGateway::Stage.MethodSettings`.
String	getRestApiId() `AWS::ApiGateway::Stage.RestApiId`.
default String	getStageName() `AWS::ApiGateway::Stage.StageName`.
default List<CfnTag>	getTags() `AWS::ApiGateway::Stage.Tags`.
default Object	getTracingEnabled() `AWS::ApiGateway::Stage.TracingEnabled`.
default Object	getVariables() `AWS::ApiGateway::Stage.Variables`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAccessLogSetting

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

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

getCacheClusterEnabled

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

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

getCacheClusterSize

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

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

getCanarySetting

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

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

getClientCertificateId

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

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

getDeploymentId

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

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

getDescription

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

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

getDocumentationVersion

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

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

getMethodSettings

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

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

getRestApiId

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

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

getStageName

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

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

getTags

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

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

getTracingEnabled

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

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

getVariables

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

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

builder

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

Returns:

a CfnStageProps.Builder of CfnStageProps