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.29.0 (build 41df200)",
           date="2021-06-02T09:54:56.847Z")
 @Stability(value=Experimental)
public interface DeploymentProps
extends software.amazon.jsii.JsiiSerializable

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getApi

@Stability(value=Experimental)
 @NotNull
IRestApi getApi()

(experimental) The Rest API to deploy.

getDescription

@Stability(value=Experimental)
 @Nullable
default String getDescription()

(experimental) A description of the purpose of the API Gateway deployment.

Default: - No description.

getRetainDeployments

@Stability(value=Experimental)
 @Nullable
default Boolean getRetainDeployments()

(experimental) 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

builder

@Stability(value=Experimental)
static DeploymentProps.Builder builder()

Returns:

a DeploymentProps.Builder of DeploymentProps