@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
date="2023-01-25T18:29:08.453Z")
public class Deployment
extends Resource
An immutable representation of a RestApi resource that can be called by users using Stages. A deployment must be associated with a Stage for it to be callable over the Internet.
Normally, you don't need to define deployments manually. The RestApi
construct manages a Deployment resource that represents the latest model. It
can be accessed through restApi.latestDeployment (unless deploy: false is
set when defining the RestApi).
If you manually define this resource, you will need to know that since deployments are immutable, as long as the resource's logical ID doesn't change, the deployment will represent the snapshot in time in which the resource was created. This means that if you modify the RestApi model (i.e. add methods or resources), these changes will not be reflected unless a new deployment resource is created.
To achieve this behavior, the method addToLogicalId(data) can be used to
augment the logical ID generated for the deployment resource such that it
will include arbitrary data. This is done automatically for the
restApi.latestDeployment deployment.
Furthermore, since a deployment does not reference any of the REST API
resources and methods, CloudFormation will likely provision it before these
resources are created, which means that it will represent a "half-baked"
model. Use the node.addDependency(dep) method to circumvent that. This is done
automatically for the restApi.latestDeployment deployment.
Example:
// production stage
LogGroup prdLogGroup = new LogGroup(this, "PrdLogs");
RestApi api = RestApi.Builder.create(this, "books")
.deployOptions(StageOptions.builder()
.accessLogDestination(new LogGroupLogDestination(prdLogGroup))
.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();
| Modifier and Type | Class and Description |
|---|---|
static class |
Deployment.Builder
A fluent builder for
Deployment. |
IResource.Jsii$Default| Modifier | Constructor and Description |
|---|---|
protected |
Deployment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
Deployment(software.amazon.jsii.JsiiObjectRef objRef) |
|
Deployment(software.constructs.Construct scope,
java.lang.String id,
DeploymentProps props) |
| Modifier and Type | Method and Description |
|---|---|
void |
addToLogicalId(java.lang.Object data)
Adds a component to the hash that determines this Deployment resource's logical ID.
|
IRestApi |
getApi() |
java.lang.String |
getDeploymentId() |
applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResourcegetNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validateclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetNodeprotected Deployment(software.amazon.jsii.JsiiObjectRef objRef)
protected Deployment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public Deployment(software.constructs.Construct scope,
java.lang.String id,
DeploymentProps props)
scope - This parameter is required.id - This parameter is required.props - This parameter is required.public void addToLogicalId(java.lang.Object data)
This should be called by constructs of the API Gateway model that want to invalidate the deployment when their settings change. The component will be resolve()ed during synthesis so tokens are welcome.
data - This parameter is required.public IRestApi getApi()
public java.lang.String getDeploymentId()