Interface CfnStageProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnStageProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
date="2024-04-24T21:00:24.832Z")
@Stability(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();
- See Also:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnStageProps
static final class
An implementation forCfnStageProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnStageProps.Builder
builder()
default Object
Access log settings, including the access log format and access log destination ARN.default Object
Specifies whether a cache cluster is enabled for the stage.default String
The stage's cache capacity in GB.default Object
Settings for the canary deployment in this stage.default String
The identifier of a client certificate for an API stage.default String
The identifier of the Deployment that the stage points to.default String
The stage's description.default String
The version of the associated API documentation.default Object
A map that defines the method settings for a Stage resource.The string identifier of the associated RestApi.default String
The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway.getTags()
The collection of tags.default Object
Specifies whether active tracing with X-ray is enabled for the Stage.default Object
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 Details
-
getRestApiId
The string identifier of the associated RestApi.- See Also:
-
getAccessLogSetting
Access log settings, including the access log format and access log destination ARN.- See Also:
-
getCacheClusterEnabled
Specifies whether a cache cluster is enabled for the stage.To activate a method-level cache, set
CachingEnabled
totrue
for a method.- See Also:
-
getCacheClusterSize
The stage's cache capacity in GB.For more information about choosing a cache size, see Enabling API caching to enhance responsiveness .
- See Also:
-
getCanarySetting
Settings for the canary deployment in this stage.- See Also:
-
getClientCertificateId
The identifier of a client certificate for an API stage.- See Also:
-
getDeploymentId
The identifier of the Deployment that the stage points to.- See Also:
-
getDescription
The stage's description.- See Also:
-
getDocumentationVersion
The version of the associated API documentation.- See Also:
-
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.- See Also:
-
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.
- See Also:
-
getTags
The collection of tags.Each tag element is associated with a given resource.
- See Also:
-
getTracingEnabled
Specifies whether active tracing with X-ray is enabled for the Stage.- See Also:
-
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-._~:/?#&=,]+
.- See Also:
-
builder
- Returns:
- a
CfnStageProps.Builder
ofCfnStageProps
-