Class Deployment

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

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var example = new Aws.ApiGatewayV2.Deployment("example", new Aws.ApiGatewayV2.DeploymentArgs
    {
        ApiId = aws_apigatewayv2_route.Example.Api_id,
        Description = "Example deployment",
    });
}

}

Inheritance

System.Object

Resource

CustomResource

Deployment

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.ApiGatewayV2

Assembly: Pulumi.Aws.dll

Syntax

public class Deployment : CustomResource

Constructors

Deployment(String, DeploymentArgs, CustomResourceOptions)

Create a Deployment resource with the given unique name, arguments, and options.

Declaration

public Deployment(string name, DeploymentArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
DeploymentArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

ApiId

The API identifier.

Declaration

public Output<string> ApiId { get; }

Property Value

Type	Description
Output<System.String>

AutoDeployed

Whether the deployment was automatically released.

Declaration

public Output<bool> AutoDeployed { get; }

Property Value

Type	Description
Output<System.Boolean>

Description

The description for the deployment resource.

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

Triggers

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

Declaration

public Output<ImmutableDictionary<string, string>> Triggers { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.String>>

Methods

Get(String, Input<String>, DeploymentState, CustomResourceOptions)

Get an existing Deployment resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static Deployment Get(string name, Input<string> id, DeploymentState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
DeploymentState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Deployment