Package software.amazon.awscdk.services.apigateway

Class DeploymentProps.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.DeploymentProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<DeploymentProps>

Enclosing interface:

DeploymentProps

@Stability(Stable)
public static final class DeploymentProps.Builder
extends Object
implements software.amazon.jsii.Builder<DeploymentProps>

A builder for DeploymentProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DeploymentProps.Builder	api(IRestApi api)	Sets the value of DeploymentProps.getApi()
DeploymentProps	build()	Builds the configured instance.
DeploymentProps.Builder	description(String description)	Sets the value of DeploymentProps.getDescription()
DeploymentProps.Builder	retainDeployments(Boolean retainDeployments)	Sets the value of DeploymentProps.getRetainDeployments()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

api

@Stability(Stable)
public DeploymentProps.Builder api(IRestApi api)

Sets the value of DeploymentProps.getApi()

Parameters:

api - The Rest API to deploy. This parameter is required.

Returns:

this

description

@Stability(Stable)
public DeploymentProps.Builder description(String description)

Sets the value of DeploymentProps.getDescription()

Parameters:

description - A description of the purpose of the API Gateway deployment.

Returns:

this

retainDeployments

@Stability(Stable)
public DeploymentProps.Builder retainDeployments(Boolean retainDeployments)

Sets the value of DeploymentProps.getRetainDeployments()

Parameters:

retainDeployments - 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

Returns:

this

build

@Stability(Stable)
public DeploymentProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<DeploymentProps>

Returns:

a new instance of DeploymentProps

Throws:

NullPointerException - if any required attribute was not provided