software.amazon.awscdk.services.apigateway

Interface CfnDeployment.StageDescriptionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDeployment.StageDescriptionProperty.Jsii$Proxy

Enclosing class:

CfnDeployment

@Stability(value=Stable)
public static interface CfnDeployment.StageDescriptionProperty
extends software.amazon.jsii.JsiiSerializable

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.*;
 StageDescriptionProperty stageDescriptionProperty = StageDescriptionProperty.builder()
         .accessLogSetting(AccessLogSettingProperty.builder()
                 .destinationArn("destinationArn")
                 .format("format")
                 .build())
         .cacheClusterEnabled(false)
         .cacheClusterSize("cacheClusterSize")
         .cacheDataEncrypted(false)
         .cacheTtlInSeconds(123)
         .cachingEnabled(false)
         .canarySetting(CanarySettingProperty.builder()
                 .percentTraffic(123)
                 .stageVariableOverrides(Map.of(
                         "stageVariableOverridesKey", "stageVariableOverrides"))
                 .useStageCache(false)
                 .build())
         .clientCertificateId("clientCertificateId")
         .dataTraceEnabled(false)
         .description("description")
         .documentationVersion("documentationVersion")
         .loggingLevel("loggingLevel")
         .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()))
         .metricsEnabled(false)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .throttlingBurstLimit(123)
         .throttlingRateLimit(123)
         .tracingEnabled(false)
         .variables(Map.of(
                 "variablesKey", "variables"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnDeployment.StageDescriptionProperty.Builder A builder for CfnDeployment.StageDescriptionProperty
static class	CfnDeployment.StageDescriptionProperty.Jsii$Proxy An implementation for CfnDeployment.StageDescriptionProperty

Method Summary

Modifier and Type	Method and Description
static CfnDeployment.StageDescriptionProperty.Builder	builder()
default Object	getAccessLogSetting() `CfnDeployment.StageDescriptionProperty.AccessLogSetting`.
default Object	getCacheClusterEnabled() `CfnDeployment.StageDescriptionProperty.CacheClusterEnabled`.
default String	getCacheClusterSize() `CfnDeployment.StageDescriptionProperty.CacheClusterSize`.
default Object	getCacheDataEncrypted() `CfnDeployment.StageDescriptionProperty.CacheDataEncrypted`.
default Number	getCacheTtlInSeconds() `CfnDeployment.StageDescriptionProperty.CacheTtlInSeconds`.
default Object	getCachingEnabled() `CfnDeployment.StageDescriptionProperty.CachingEnabled`.
default Object	getCanarySetting() `CfnDeployment.StageDescriptionProperty.CanarySetting`.
default String	getClientCertificateId() `CfnDeployment.StageDescriptionProperty.ClientCertificateId`.
default Object	getDataTraceEnabled() `CfnDeployment.StageDescriptionProperty.DataTraceEnabled`.
default String	getDescription() `CfnDeployment.StageDescriptionProperty.Description`.
default String	getDocumentationVersion() `CfnDeployment.StageDescriptionProperty.DocumentationVersion`.
default String	getLoggingLevel() `CfnDeployment.StageDescriptionProperty.LoggingLevel`.
default Object	getMethodSettings() `CfnDeployment.StageDescriptionProperty.MethodSettings`.
default Object	getMetricsEnabled() `CfnDeployment.StageDescriptionProperty.MetricsEnabled`.
default List<CfnTag>	getTags() `CfnDeployment.StageDescriptionProperty.Tags`.
default Number	getThrottlingBurstLimit() `CfnDeployment.StageDescriptionProperty.ThrottlingBurstLimit`.
default Number	getThrottlingRateLimit() `CfnDeployment.StageDescriptionProperty.ThrottlingRateLimit`.
default Object	getTracingEnabled() `CfnDeployment.StageDescriptionProperty.TracingEnabled`.
default Object	getVariables() `CfnDeployment.StageDescriptionProperty.Variables`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAccessLogSetting

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

`CfnDeployment.StageDescriptionProperty.AccessLogSetting`.

getCacheClusterEnabled

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

`CfnDeployment.StageDescriptionProperty.CacheClusterEnabled`.

getCacheClusterSize

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

`CfnDeployment.StageDescriptionProperty.CacheClusterSize`.

getCacheDataEncrypted

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

`CfnDeployment.StageDescriptionProperty.CacheDataEncrypted`.

getCacheTtlInSeconds

@Stability(value=Stable)
 @Nullable
default Number getCacheTtlInSeconds()

`CfnDeployment.StageDescriptionProperty.CacheTtlInSeconds`.

getCachingEnabled

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

`CfnDeployment.StageDescriptionProperty.CachingEnabled`.

getCanarySetting

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

`CfnDeployment.StageDescriptionProperty.CanarySetting`.

getClientCertificateId

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

`CfnDeployment.StageDescriptionProperty.ClientCertificateId`.

getDataTraceEnabled

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

`CfnDeployment.StageDescriptionProperty.DataTraceEnabled`.

getDescription

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

`CfnDeployment.StageDescriptionProperty.Description`.

getDocumentationVersion

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

`CfnDeployment.StageDescriptionProperty.DocumentationVersion`.

getLoggingLevel

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

`CfnDeployment.StageDescriptionProperty.LoggingLevel`.

getMethodSettings

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

`CfnDeployment.StageDescriptionProperty.MethodSettings`.

getMetricsEnabled

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

`CfnDeployment.StageDescriptionProperty.MetricsEnabled`.

getTags

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

`CfnDeployment.StageDescriptionProperty.Tags`.

getThrottlingBurstLimit

@Stability(value=Stable)
 @Nullable
default Number getThrottlingBurstLimit()

`CfnDeployment.StageDescriptionProperty.ThrottlingBurstLimit`.

getThrottlingRateLimit

@Stability(value=Stable)
 @Nullable
default Number getThrottlingRateLimit()

`CfnDeployment.StageDescriptionProperty.ThrottlingRateLimit`.

getTracingEnabled

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

`CfnDeployment.StageDescriptionProperty.TracingEnabled`.

getVariables

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

`CfnDeployment.StageDescriptionProperty.Variables`.

builder

@Stability(value=Stable)
static CfnDeployment.StageDescriptionProperty.Builder builder()

Returns:

a CfnDeployment.StageDescriptionProperty.Builder of CfnDeployment.StageDescriptionProperty