Package software.amazon.awscdk.services.apigateway

Interface DeploymentProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DeploymentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-04T09:27:33.372Z")
@Stability(Stable)
public interface DeploymentProps
extends software.amazon.jsii.JsiiSerializable

Example:

 // production stage
 LogGroup prodLogGroup = new LogGroup(this, "PrdLogs");
 RestApi api = RestApi.Builder.create(this, "books")
         .deployOptions(StageOptions.builder()
                 .accessLogDestination(new LogGroupLogDestination(prodLogGroup))
                 .accessLogFormat(AccessLogFormat.jsonWithStandardFields())
                 .build())
         .build();
 Deployment deployment = Deployment.Builder.create(this, "Deployment").api(api).build();
 // development stage
 LogGroup devLogGroup = new LogGroup(this, "DevLogs");
 Stage.Builder.create(this, "dev")
         .deployment(deployment)
         .accessLogDestination(new LogGroupLogDestination(devLogGroup))
         .accessLogFormat(AccessLogFormat.jsonWithStandardFields(JsonWithStandardFieldProps.builder()
                 .caller(false)
                 .httpMethod(true)
                 .ip(true)
                 .protocol(true)
                 .requestTime(true)
                 .resourcePath(true)
                 .responseLength(true)
                 .status(true)
                 .user(true)
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static DeploymentProps.Builder	builder()
IRestApi	getApi()	The Rest API to deploy.
default String	getDescription()	A description of the purpose of the API Gateway deployment.
default Boolean	getRetainDeployments()	When an API Gateway model is updated, a new deployment will automatically be created.
default String	getStageName()	The name of the stage the API Gateway deployment deploys to.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApi

@Stability(Stable)
@NotNull
IRestApi getApi()

The Rest API to deploy.

getDescription

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

A description of the purpose of the API Gateway deployment.

Default: - No description.

getRetainDeployments

@Stability(Stable)
@Nullable
default Boolean getRetainDeployments()

When an API Gateway model is updated, a new deployment will automatically be created.

If this is true, the old API Gateway Deployment resource will not be deleted. This will allow manually reverting back to a previous deployment in case for example

Default: false

getStageName

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

The name of the stage the API Gateway deployment deploys to.

Default: - No stage name. If the `stageName` property is set but a stage with the corresponding name does not exist, a new stage resource will be created with the provided stage name.

builder

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

Returns:

a DeploymentProps.Builder of DeploymentProps