Package software.amazon.awscdk.cfnpropertymixins.services.apigateway

Interface CfnDeploymentMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDeploymentMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:55.430Z")
@Stability(Stable)
public interface CfnDeploymentMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnDeploymentPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.apigateway.*;
 CfnDeploymentMixinProps cfnDeploymentMixinProps = CfnDeploymentMixinProps.builder()
         .deploymentCanarySettings(DeploymentCanarySettingsProperty.builder()
                 .percentTraffic(123)
                 .stageVariableOverrides(Map.of(
                         "stageVariableOverridesKey", "stageVariableOverrides"))
                 .useStageCache(false)
                 .build())
         .description("description")
         .restApiId("restApiId")
         .stageDescription(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())
         .stageName("stageName")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDeploymentMixinProps.Builder	builder()
default Object	getDeploymentCanarySettings()	The input configuration for a canary deployment.
default String	getDescription()	The description for the Deployment resource to create.
default Object	getRestApiId()	The string identifier of the associated RestApi.
default Object	getStageDescription()	The description of the Stage resource for the Deployment resource to create.
default String	getStageName()	The name of the Stage resource for the Deployment resource to create.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDeploymentCanarySettings

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

The input configuration for a canary deployment.

Returns union: either IResolvable or CfnDeploymentPropsMixin.DeploymentCanarySettingsProperty

See Also:

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

getDescription

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

The description for the Deployment resource to create.

See Also:

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

getRestApiId

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

The string identifier of the associated RestApi.

Returns union: either String or IRestApiRef

See Also:

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

getStageDescription

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

The description of the Stage resource for the Deployment resource to create.

To specify a stage description, you must also provide a stage name.

Returns union: either IResolvable or CfnDeploymentPropsMixin.StageDescriptionProperty

See Also:

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

getStageName

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

The name of the Stage resource for the Deployment resource to create.

See Also:

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

builder

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

Returns:

a CfnDeploymentMixinProps.Builder of CfnDeploymentMixinProps