aws.apigateway.Deployment

Manages an API Gateway REST Deployment. A deployment is a snapshot of the REST API configuration. The deployment can then be published to callable endpoints via the aws.apigateway.Stage resource and optionally managed further with the aws.apigateway.BasePathMapping resource, aws.apigateway.DomainName resource, and aws_api_method_settings resource. For more information, see the API Gateway Developer Guide.

To properly capture all REST API configuration in a deployment, this resource must have dependencies on all prior resources that manage resources/paths, methods, integrations, etc.

• For REST APIs that are configured via OpenAPI specification (aws.apigateway.RestApi resource body argument), no special dependency setup is needed beyond referencing the id attribute of that resource unless additional resources have further customized the REST API.
• When the REST API configuration involves other resources (aws.apigateway.Integration resource), the dependency setup can be done with implicit resource references in the triggers argument or explicit resource references using the resource dependsOn custom option. The triggers argument should be preferred over depends_on, since depends_on can only capture dependency ordering and will not cause the resource to recreate (redeploy the REST API) with upstream configuration changes.

!> WARNING: It is recommended to use the aws.apigateway.Stage resource instead of managing an API Gateway Stage via the stage_name argument of this resource. When this resource is recreated (REST API redeployment) with the stage_name configured, the stage is deleted and recreated. This will cause a temporary service interruption, increase provide plan differences, and can require a second apply to recreate any downstream stage configuration such as associated aws_api_method_settings resources.

Example Usage

Create Deployment Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Deployment(name: string, args: DeploymentArgs, opts?: CustomResourceOptions);

@overload
def Deployment(resource_name: str,
               args: DeploymentArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def Deployment(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               rest_api: Optional[str] = None,
               canary_settings: Optional[DeploymentCanarySettingsArgs] = None,
               description: Optional[str] = None,
               stage_description: Optional[str] = None,
               stage_name: Optional[str] = None,
               triggers: Optional[Mapping[str, str]] = None,
               variables: Optional[Mapping[str, str]] = None)

func NewDeployment(ctx *Context, name string, args DeploymentArgs, opts ...ResourceOption) (*Deployment, error)

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

public Deployment(String name, DeploymentArgs args)
public Deployment(String name, DeploymentArgs args, CustomResourceOptions options)

type: aws:apigateway:Deployment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

Constructor example

The following reference example uses placeholder values for all input properties.

var deploymentResource = new Aws.ApiGateway.Deployment("deploymentResource", new()
{
    RestApi = "string",
    Description = "string",
    Triggers = 
    {
        { "string", "string" },
    },
    Variables = 
    {
        { "string", "string" },
    },
});

example, err := apigateway.NewDeployment(ctx, "deploymentResource", &apigateway.DeploymentArgs{
	RestApi:     pulumi.Any("string"),
	Description: pulumi.String("string"),
	Triggers: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Variables: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

var deploymentResource = new Deployment("deploymentResource", DeploymentArgs.builder()
    .restApi("string")
    .description("string")
    .triggers(Map.of("string", "string"))
    .variables(Map.of("string", "string"))
    .build());

deployment_resource = aws.apigateway.Deployment("deploymentResource",
    rest_api="string",
    description="string",
    triggers={
        "string": "string",
    },
    variables={
        "string": "string",
    })

const deploymentResource = new aws.apigateway.Deployment("deploymentResource", {
    restApi: "string",
    description: "string",
    triggers: {
        string: "string",
    },
    variables: {
        string: "string",
    },
});

type: aws:apigateway:Deployment
properties:
    description: string
    restApi: string
    triggers:
        string: string
    variables:
        string: string

Deployment Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Deployment resource accepts the following input properties:

Outputs

All input properties are implicitly available as output properties. Additionally, the Deployment resource produces the following output properties:

Look up Existing Deployment Resource

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

public static get(name: string, id: Input<ID>, state?: DeploymentState, opts?: CustomResourceOptions): Deployment

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        canary_settings: Optional[DeploymentCanarySettingsArgs] = None,
        created_date: Optional[str] = None,
        description: Optional[str] = None,
        execution_arn: Optional[str] = None,
        invoke_url: Optional[str] = None,
        rest_api: Optional[str] = None,
        stage_description: Optional[str] = None,
        stage_name: Optional[str] = None,
        triggers: Optional[Mapping[str, str]] = None,
        variables: Optional[Mapping[str, str]] = None) -> Deployment

func GetDeployment(ctx *Context, name string, id IDInput, state *DeploymentState, opts ...ResourceOption) (*Deployment, error)

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

public static Deployment get(String name, Output<String> id, DeploymentState state, CustomResourceOptions options)

resources:  _:    type: aws:apigateway:Deployment    get:      id: ${id}

Supporting Types

DeploymentCanarySettings, DeploymentCanarySettingsArgs

Import

Using pulumi import, import aws_api_gateway_deployment using REST-API-ID/DEPLOYMENT-ID. For example:

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

The stage_name, stage_description, and variables arguments cannot be imported. Use the aws_api_gateway_stage resource to import and manage stages.

The triggers argument cannot be imported.

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository

AWS Classic pulumi/pulumi-aws

License

Apache-2.0

Notes

This Pulumi package is based on the aws Terraform Provider.