Package 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.104.0 (build e79254c)",
           date="2024-11-21T06:34:02.562Z")
@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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnStageProps.Builder	builder()
default Object	getAccessLogSetting()	Access log settings, including the access log format and access log destination ARN.
default Object	getCacheClusterEnabled()	Specifies whether a cache cluster is enabled for the stage.
default String	getCacheClusterSize()	The stage's cache capacity in GB.
default Object	getCanarySetting()	Settings for the canary deployment in this stage.
default String	getClientCertificateId()	The identifier of a client certificate for an API stage.
default String	getDeploymentId()	The identifier of the Deployment that the stage points to.
default String	getDescription()	The stage's description.
default String	getDocumentationVersion()	The version of the associated API documentation.
default Object	getMethodSettings()	A map that defines the method settings for a Stage resource.
String	getRestApiId()	The string identifier of the associated RestApi.
default String	getStageName()	The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway.
default List<CfnTag>	getTags()	The collection of tags.
default Object	getTracingEnabled()	Specifies whether active tracing with X-ray is enabled for the 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 Details

getRestApiId

@Stability(Stable)
@NotNull
String getRestApiId()

The string identifier of the associated RestApi.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-restapiid

getAccessLogSetting

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

Access log settings, including the access log format and access log destination ARN.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-accesslogsetting

getCacheClusterEnabled

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

Specifies whether a cache cluster is enabled for the stage.

To activate a method-level cache, set CachingEnabled to true for a method.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-cacheclusterenabled

getCacheClusterSize

@Stability(Stable)
@Nullable
default String 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-cacheclustersize

getCanarySetting

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

Settings for the canary deployment in this stage.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-canarysetting

getClientCertificateId

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

The identifier of a client certificate for an API stage.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-clientcertificateid

getDeploymentId

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

The identifier of the Deployment that the stage points to.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-deploymentid

getDescription

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

The stage's description.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-description

getDocumentationVersion

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

The version of the associated API documentation.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-documentationversion

getMethodSettings

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-methodsettings

getStageName

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-stagename

getTags

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

The collection of tags.

Each tag element is associated with a given resource.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-tags

getTracingEnabled

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

Specifies whether active tracing with X-ray is enabled for the Stage.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-tracingenabled

getVariables

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-variables

builder

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

Returns:

a CfnStageProps.Builder of CfnStageProps