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

Class CfnDeploymentPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.apigateway.CfnDeploymentPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:55.431Z")
@Stability(Stable)
public class CfnDeploymentPropsMixin
extends Mixin
implements software.constructs.IMixin

The AWS::ApiGateway::Deployment resource deploys an API Gateway RestApi resource to a stage so that clients can call the API over the internet.

The stage acts as an environment.

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.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnDeploymentPropsMixin cfnDeploymentPropsMixin = CfnDeploymentPropsMixin.Builder.create(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())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnDeploymentPropsMixin.AccessLogSettingProperty	The AccessLogSetting property type specifies settings for logging access in this stage.
static final class	CfnDeploymentPropsMixin.Builder	A fluent builder for CfnDeploymentPropsMixin.
static interface	CfnDeploymentPropsMixin.CanarySettingProperty	The CanarySetting property type specifies settings for the canary deployment in this stage.
static interface	CfnDeploymentPropsMixin.DeploymentCanarySettingsProperty	The DeploymentCanarySettings property type specifies settings for the canary deployment.
static interface	CfnDeploymentPropsMixin.MethodSettingProperty	The MethodSetting property type configures settings for all methods in a stage.
static interface	CfnDeploymentPropsMixin.StageDescriptionProperty	StageDescription is a property of the AWS::ApiGateway::Deployment resource that configures a deployment stage.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnDeploymentPropsMixin(CfnDeploymentMixinProps props)	Create a mixin to apply properties to AWS::ApiGateway::Deployment.
	CfnDeploymentPropsMixin(CfnDeploymentMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::ApiGateway::Deployment.
protected	CfnDeploymentPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDeploymentPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnDeploymentMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnDeploymentPropsMixin

protected CfnDeploymentPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnDeploymentPropsMixin

protected CfnDeploymentPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnDeploymentPropsMixin

@Stability(Stable)
public CfnDeploymentPropsMixin(@NotNull
 CfnDeploymentMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::ApiGateway::Deployment.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnDeploymentPropsMixin

@Stability(Stable)
public CfnDeploymentPropsMixin(@NotNull
 CfnDeploymentMixinProps props)

Create a mixin to apply properties to AWS::ApiGateway::Deployment.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnDeploymentMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()