DeploymentArgs

data class DeploymentArgs(val apiId: Output<String>? = null, val description: Output<String>? = null, val triggers: Output<Map<String, String>>? = null) : ConvertibleToJava<DeploymentArgs>

Manages an Amazon API Gateway Version 2 deployment. More information can be found in the Amazon API Gateway Developer Guide.

Note: Creating a deployment for an API requires at least one aws.apigatewayv2.Route resource associated with that API. To avoid race conditions when all resources are being created together, you need to add implicit resource references via the triggers argument or explicit resource references using the resource dependsOn meta-argument.

Example Usage

Basic

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.apigatewayv2.Deployment;
import com.pulumi.aws.apigatewayv2.DeploymentArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Deployment("example", DeploymentArgs.builder()
.apiId(aws_apigatewayv2_api.example().id())
.description("Example deployment")
.build());
}
}

Import

aws_apigatewayv2_deployment can be imported by using the API identifier and deployment identifier, e.g.,

$ pulumi import aws:apigatewayv2/deployment:Deployment example aabbccddee/1122334

The triggers argument cannot be imported.

Constructors

Link copied to clipboard
constructor(apiId: Output<String>? = null, description: Output<String>? = null, triggers: Output<Map<String, String>>? = null)

Properties

Link copied to clipboard
val apiId: Output<String>? = null

API identifier.

Link copied to clipboard
val description: Output<String>? = null

Description for the deployment resource. Must be less than or equal to 1024 characters in length.

Link copied to clipboard
val triggers: Output<Map<String, String>>? = null

Map of arbitrary keys and values that, when changed, will trigger a redeployment.

Functions

Link copied to clipboard
open override fun toJava(): DeploymentArgs