Try AWS Native preview for resources not in the classic version.
aws.apigateway.Deployment
Explore with Pulumi AI
Try AWS Native preview for resources not in the classic version.
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
resourcebody
argument), no special dependency setup is needed beyond referencing theid
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 thetriggers
argument or explicit resource references using the resourcedependsOn
custom option. Thetriggers
argument should be preferred overdepends_on
, sincedepends_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
OpenAPI Specification
using System.Collections.Generic;
using System.Linq;
using System.Security.Cryptography;
using System.Text;
using System.Text.Json;
using Pulumi;
using Aws = Pulumi.Aws;
private static string ComputeSHA1(string input) {
return BitConverter.ToString(
SHA1.Create().ComputeHash(Encoding.UTF8.GetBytes(input))
).Replace("-","").ToLowerInvariant());
}
return await Deployment.RunAsync(() =>
{
var exampleRestApi = new Aws.ApiGateway.RestApi("exampleRestApi", new()
{
Body = JsonSerializer.Serialize(new Dictionary<string, object?>
{
["openapi"] = "3.0.1",
["info"] = new Dictionary<string, object?>
{
["title"] = "example",
["version"] = "1.0",
},
["paths"] = new Dictionary<string, object?>
{
["/path1"] = new Dictionary<string, object?>
{
["get"] = new Dictionary<string, object?>
{
["x-amazon-apigateway-integration"] = new Dictionary<string, object?>
{
["httpMethod"] = "GET",
["payloadFormatVersion"] = "1.0",
["type"] = "HTTP_PROXY",
["uri"] = "https://ip-ranges.amazonaws.com/ip-ranges.json",
},
},
},
},
}),
});
var exampleDeployment = new Aws.ApiGateway.Deployment("exampleDeployment", new()
{
RestApi = exampleRestApi.Id,
Triggers =
{
{ "redeployment", exampleRestApi.Body.Apply(body => JsonSerializer.Serialize(body)).Apply(toJSON => ComputeSHA1(toJSON)) },
},
});
var exampleStage = new Aws.ApiGateway.Stage("exampleStage", new()
{
Deployment = exampleDeployment.Id,
RestApi = exampleRestApi.Id,
StageName = "example",
});
});
package main
import (
"crypto/sha1"
"encoding/json"
"fmt"
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/apigateway"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func sha1Hash(input string) string {
hash := sha1.Sum([]byte(input))
return hex.EncodeToString(hash[:])
}
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
tmpJSON0, err := json.Marshal(map[string]interface{}{
"openapi": "3.0.1",
"info": map[string]interface{}{
"title": "example",
"version": "1.0",
},
"paths": map[string]interface{}{
"/path1": map[string]interface{}{
"get": map[string]interface{}{
"x-amazon-apigateway-integration": map[string]interface{}{
"httpMethod": "GET",
"payloadFormatVersion": "1.0",
"type": "HTTP_PROXY",
"uri": "https://ip-ranges.amazonaws.com/ip-ranges.json",
},
},
},
},
})
if err != nil {
return err
}
json0 := string(tmpJSON0)
exampleRestApi, err := apigateway.NewRestApi(ctx, "exampleRestApi", &apigateway.RestApiArgs{
Body: pulumi.String(json0),
})
if err != nil {
return err
}
exampleDeployment, err := apigateway.NewDeployment(ctx, "exampleDeployment", &apigateway.DeploymentArgs{
RestApi: exampleRestApi.ID(),
Triggers: pulumi.StringMap{
"redeployment": exampleRestApi.Body.ApplyT(func(body *string) (pulumi.String, error) {
var _zero pulumi.String
tmpJSON1, err := json.Marshal(body)
if err != nil {
return _zero, err
}
json1 := string(tmpJSON1)
return pulumi.String(json1), nil
}).(pulumi.StringOutput).ApplyT(func(toJSON string) (pulumi.String, error) {
return pulumi.String(sha1Hash(toJSON)), nil
}).(pulumi.StringOutput),
},
})
if err != nil {
return err
}
_, err = apigateway.NewStage(ctx, "exampleStage", &apigateway.StageArgs{
Deployment: exampleDeployment.ID(),
RestApi: exampleRestApi.ID(),
StageName: pulumi.String("example"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.apigateway.RestApi;
import com.pulumi.aws.apigateway.RestApiArgs;
import com.pulumi.aws.apigateway.Deployment;
import com.pulumi.aws.apigateway.DeploymentArgs;
import com.pulumi.aws.apigateway.Stage;
import com.pulumi.aws.apigateway.StageArgs;
import static com.pulumi.codegen.internal.Serialization.*;
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 exampleRestApi = new RestApi("exampleRestApi", RestApiArgs.builder()
.body(serializeJson(
jsonObject(
jsonProperty("openapi", "3.0.1"),
jsonProperty("info", jsonObject(
jsonProperty("title", "example"),
jsonProperty("version", "1.0")
)),
jsonProperty("paths", jsonObject(
jsonProperty("/path1", jsonObject(
jsonProperty("get", jsonObject(
jsonProperty("x-amazon-apigateway-integration", jsonObject(
jsonProperty("httpMethod", "GET"),
jsonProperty("payloadFormatVersion", "1.0"),
jsonProperty("type", "HTTP_PROXY"),
jsonProperty("uri", "https://ip-ranges.amazonaws.com/ip-ranges.json")
))
))
))
))
)))
.build());
var exampleDeployment = new Deployment("exampleDeployment", DeploymentArgs.builder()
.restApi(exampleRestApi.id())
.triggers(Map.of("redeployment", exampleRestApi.body().applyValue(body -> serializeJson(
body)).applyValue(toJSON -> computeSHA1(toJSON))))
.build());
var exampleStage = new Stage("exampleStage", StageArgs.builder()
.deployment(exampleDeployment.id())
.restApi(exampleRestApi.id())
.stageName("example")
.build());
}
}
import pulumi
import hashlib
import json
import pulumi_aws as aws
example_rest_api = aws.apigateway.RestApi("exampleRestApi", body=json.dumps({
"openapi": "3.0.1",
"info": {
"title": "example",
"version": "1.0",
},
"paths": {
"/path1": {
"get": {
"x-amazon-apigateway-integration": {
"httpMethod": "GET",
"payloadFormatVersion": "1.0",
"type": "HTTP_PROXY",
"uri": "https://ip-ranges.amazonaws.com/ip-ranges.json",
},
},
},
},
}))
example_deployment = aws.apigateway.Deployment("exampleDeployment",
rest_api=example_rest_api.id,
triggers={
"redeployment": example_rest_api.body.apply(lambda body: json.dumps(body)).apply(lambda to_json: hashlib.sha1(to_json.encode()).hexdigest()),
})
example_stage = aws.apigateway.Stage("exampleStage",
deployment=example_deployment.id,
rest_api=example_rest_api.id,
stage_name="example")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
import * as crypto from "crypto";
const exampleRestApi = new aws.apigateway.RestApi("exampleRestApi", {body: JSON.stringify({
openapi: "3.0.1",
info: {
title: "example",
version: "1.0",
},
paths: {
"/path1": {
get: {
"x-amazon-apigateway-integration": {
httpMethod: "GET",
payloadFormatVersion: "1.0",
type: "HTTP_PROXY",
uri: "https://ip-ranges.amazonaws.com/ip-ranges.json",
},
},
},
},
})});
const exampleDeployment = new aws.apigateway.Deployment("exampleDeployment", {
restApi: exampleRestApi.id,
triggers: {
redeployment: exampleRestApi.body.apply(body => JSON.stringify(body)).apply(toJSON => crypto.createHash('sha1').update(toJSON).digest('hex')),
},
});
const exampleStage = new aws.apigateway.Stage("exampleStage", {
deployment: exampleDeployment.id,
restApi: exampleRestApi.id,
stageName: "example",
});
Coming soon!
Resources
using System.Collections.Generic;
using System.Linq;
using System.Security.Cryptography;
using System.Text;
using System.Text.Json;
using Pulumi;
using Aws = Pulumi.Aws;
private static string ComputeSHA1(string input) {
return BitConverter.ToString(
SHA1.Create().ComputeHash(Encoding.UTF8.GetBytes(input))
).Replace("-","").ToLowerInvariant());
}
return await Deployment.RunAsync(() =>
{
var exampleRestApi = new Aws.ApiGateway.RestApi("exampleRestApi");
var exampleResource = new Aws.ApiGateway.Resource("exampleResource", new()
{
ParentId = exampleRestApi.RootResourceId,
PathPart = "example",
RestApi = exampleRestApi.Id,
});
var exampleMethod = new Aws.ApiGateway.Method("exampleMethod", new()
{
Authorization = "NONE",
HttpMethod = "GET",
ResourceId = exampleResource.Id,
RestApi = exampleRestApi.Id,
});
var exampleIntegration = new Aws.ApiGateway.Integration("exampleIntegration", new()
{
HttpMethod = exampleMethod.HttpMethod,
ResourceId = exampleResource.Id,
RestApi = exampleRestApi.Id,
Type = "MOCK",
});
var exampleDeployment = new Aws.ApiGateway.Deployment("exampleDeployment", new()
{
RestApi = exampleRestApi.Id,
Triggers =
{
{ "redeployment", Output.Tuple(exampleResource.Id, exampleMethod.Id, exampleIntegration.Id).Apply(values =>
{
var exampleResourceId = values.Item1;
var exampleMethodId = values.Item2;
var exampleIntegrationId = values.Item3;
return JsonSerializer.Serialize(new[]
{
exampleResourceId,
exampleMethodId,
exampleIntegrationId,
});
}).Apply(toJSON => ComputeSHA1(toJSON)) },
},
});
var exampleStage = new Aws.ApiGateway.Stage("exampleStage", new()
{
Deployment = exampleDeployment.Id,
RestApi = exampleRestApi.Id,
StageName = "example",
});
});
package main
import (
"crypto/sha1"
"encoding/json"
"fmt"
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/apigateway"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func sha1Hash(input string) string {
hash := sha1.Sum([]byte(input))
return hex.EncodeToString(hash[:])
}
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
exampleRestApi, err := apigateway.NewRestApi(ctx, "exampleRestApi", nil)
if err != nil {
return err
}
exampleResource, err := apigateway.NewResource(ctx, "exampleResource", &apigateway.ResourceArgs{
ParentId: exampleRestApi.RootResourceId,
PathPart: pulumi.String("example"),
RestApi: exampleRestApi.ID(),
})
if err != nil {
return err
}
exampleMethod, err := apigateway.NewMethod(ctx, "exampleMethod", &apigateway.MethodArgs{
Authorization: pulumi.String("NONE"),
HttpMethod: pulumi.String("GET"),
ResourceId: exampleResource.ID(),
RestApi: exampleRestApi.ID(),
})
if err != nil {
return err
}
exampleIntegration, err := apigateway.NewIntegration(ctx, "exampleIntegration", &apigateway.IntegrationArgs{
HttpMethod: exampleMethod.HttpMethod,
ResourceId: exampleResource.ID(),
RestApi: exampleRestApi.ID(),
Type: pulumi.String("MOCK"),
})
if err != nil {
return err
}
exampleDeployment, err := apigateway.NewDeployment(ctx, "exampleDeployment", &apigateway.DeploymentArgs{
RestApi: exampleRestApi.ID(),
Triggers: pulumi.StringMap{
"redeployment": pulumi.All(exampleResource.ID(), exampleMethod.ID(), exampleIntegration.ID()).ApplyT(func(_args []interface{}) (string, error) {
exampleResourceId := _args[0].(string)
exampleMethodId := _args[1].(string)
exampleIntegrationId := _args[2].(string)
var _zero string
tmpJSON0, err := json.Marshal([]string{
exampleResourceId,
exampleMethodId,
exampleIntegrationId,
})
if err != nil {
return _zero, err
}
json0 := string(tmpJSON0)
return json0, nil
}).(pulumi.StringOutput).ApplyT(func(toJSON string) (pulumi.String, error) {
return pulumi.String(sha1Hash(toJSON)), nil
}).(pulumi.StringOutput),
},
})
if err != nil {
return err
}
_, err = apigateway.NewStage(ctx, "exampleStage", &apigateway.StageArgs{
Deployment: exampleDeployment.ID(),
RestApi: exampleRestApi.ID(),
StageName: pulumi.String("example"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.apigateway.RestApi;
import com.pulumi.aws.apigateway.Resource;
import com.pulumi.aws.apigateway.ResourceArgs;
import com.pulumi.aws.apigateway.Method;
import com.pulumi.aws.apigateway.MethodArgs;
import com.pulumi.aws.apigateway.Integration;
import com.pulumi.aws.apigateway.IntegrationArgs;
import com.pulumi.aws.apigateway.Deployment;
import com.pulumi.aws.apigateway.DeploymentArgs;
import com.pulumi.aws.apigateway.Stage;
import com.pulumi.aws.apigateway.StageArgs;
import static com.pulumi.codegen.internal.Serialization.*;
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 exampleRestApi = new RestApi("exampleRestApi");
var exampleResource = new Resource("exampleResource", ResourceArgs.builder()
.parentId(exampleRestApi.rootResourceId())
.pathPart("example")
.restApi(exampleRestApi.id())
.build());
var exampleMethod = new Method("exampleMethod", MethodArgs.builder()
.authorization("NONE")
.httpMethod("GET")
.resourceId(exampleResource.id())
.restApi(exampleRestApi.id())
.build());
var exampleIntegration = new Integration("exampleIntegration", IntegrationArgs.builder()
.httpMethod(exampleMethod.httpMethod())
.resourceId(exampleResource.id())
.restApi(exampleRestApi.id())
.type("MOCK")
.build());
var exampleDeployment = new Deployment("exampleDeployment", DeploymentArgs.builder()
.restApi(exampleRestApi.id())
.triggers(Map.of("redeployment", Output.tuple(exampleResource.id(), exampleMethod.id(), exampleIntegration.id()).applyValue(values -> {
var exampleResourceId = values.t1;
var exampleMethodId = values.t2;
var exampleIntegrationId = values.t3;
return serializeJson(
jsonArray(
exampleResourceId,
exampleMethodId,
exampleIntegrationId
));
}).applyValue(toJSON -> computeSHA1(toJSON))))
.build());
var exampleStage = new Stage("exampleStage", StageArgs.builder()
.deployment(exampleDeployment.id())
.restApi(exampleRestApi.id())
.stageName("example")
.build());
}
}
import pulumi
import hashlib
import json
import pulumi_aws as aws
example_rest_api = aws.apigateway.RestApi("exampleRestApi")
example_resource = aws.apigateway.Resource("exampleResource",
parent_id=example_rest_api.root_resource_id,
path_part="example",
rest_api=example_rest_api.id)
example_method = aws.apigateway.Method("exampleMethod",
authorization="NONE",
http_method="GET",
resource_id=example_resource.id,
rest_api=example_rest_api.id)
example_integration = aws.apigateway.Integration("exampleIntegration",
http_method=example_method.http_method,
resource_id=example_resource.id,
rest_api=example_rest_api.id,
type="MOCK")
example_deployment = aws.apigateway.Deployment("exampleDeployment",
rest_api=example_rest_api.id,
triggers={
"redeployment": pulumi.Output.all(example_resource.id, example_method.id, example_integration.id).apply(lambda exampleResourceId, exampleMethodId, exampleIntegrationId: json.dumps([
example_resource_id,
example_method_id,
example_integration_id,
])).apply(lambda to_json: hashlib.sha1(to_json.encode()).hexdigest()),
})
example_stage = aws.apigateway.Stage("exampleStage",
deployment=example_deployment.id,
rest_api=example_rest_api.id,
stage_name="example")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
import * as crypto from "crypto";
const exampleRestApi = new aws.apigateway.RestApi("exampleRestApi", {});
const exampleResource = new aws.apigateway.Resource("exampleResource", {
parentId: exampleRestApi.rootResourceId,
pathPart: "example",
restApi: exampleRestApi.id,
});
const exampleMethod = new aws.apigateway.Method("exampleMethod", {
authorization: "NONE",
httpMethod: "GET",
resourceId: exampleResource.id,
restApi: exampleRestApi.id,
});
const exampleIntegration = new aws.apigateway.Integration("exampleIntegration", {
httpMethod: exampleMethod.httpMethod,
resourceId: exampleResource.id,
restApi: exampleRestApi.id,
type: "MOCK",
});
const exampleDeployment = new aws.apigateway.Deployment("exampleDeployment", {
restApi: exampleRestApi.id,
triggers: {
redeployment: pulumi.all([exampleResource.id, exampleMethod.id, exampleIntegration.id]).apply(([exampleResourceId, exampleMethodId, exampleIntegrationId]) => JSON.stringify([
exampleResourceId,
exampleMethodId,
exampleIntegrationId,
])).apply(toJSON => crypto.createHash('sha1').update(toJSON).digest('hex')),
},
});
const exampleStage = new aws.apigateway.Stage("exampleStage", {
deployment: exampleDeployment.id,
restApi: exampleRestApi.id,
stageName: "example",
});
Coming soon!
Create Deployment Resource
new Deployment(name: string, args: DeploymentArgs, opts?: CustomResourceOptions);
@overload
def Deployment(resource_name: str,
opts: Optional[ResourceOptions] = None,
description: 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)
@overload
def Deployment(resource_name: str,
args: DeploymentArgs,
opts: Optional[ResourceOptions] = 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.
- name string
- The unique name of the resource.
- args DeploymentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args DeploymentArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args DeploymentArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DeploymentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DeploymentArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
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:
- Rest
Api string | string REST API identifier.
- Description string
Description of the deployment
- Stage
Description string Description to set on the stage managed by the
stage_name
argument.- Stage
Name string Name of the stage to create with this deployment. If the specified stage already exists, it will be updated to point to the new deployment. We recommend using the
aws.apigateway.Stage
resource instead to manage stages.- Triggers Dictionary<string, string>
Map of arbitrary keys and values that, when changed, will trigger a redeployment.
- Variables Dictionary<string, string>
Map to set on the stage managed by the
stage_name
argument.
- Rest
Api string | string REST API identifier.
- Description string
Description of the deployment
- Stage
Description string Description to set on the stage managed by the
stage_name
argument.- Stage
Name string Name of the stage to create with this deployment. If the specified stage already exists, it will be updated to point to the new deployment. We recommend using the
aws.apigateway.Stage
resource instead to manage stages.- Triggers map[string]string
Map of arbitrary keys and values that, when changed, will trigger a redeployment.
- Variables map[string]string
Map to set on the stage managed by the
stage_name
argument.
- rest
Api String | String REST API identifier.
- description String
Description of the deployment
- stage
Description String Description to set on the stage managed by the
stage_name
argument.- stage
Name String Name of the stage to create with this deployment. If the specified stage already exists, it will be updated to point to the new deployment. We recommend using the
aws.apigateway.Stage
resource instead to manage stages.- triggers Map<String,String>
Map of arbitrary keys and values that, when changed, will trigger a redeployment.
- variables Map<String,String>
Map to set on the stage managed by the
stage_name
argument.
- rest
Api string | RestApi REST API identifier.
- description string
Description of the deployment
- stage
Description string Description to set on the stage managed by the
stage_name
argument.- stage
Name string Name of the stage to create with this deployment. If the specified stage already exists, it will be updated to point to the new deployment. We recommend using the
aws.apigateway.Stage
resource instead to manage stages.- triggers {[key: string]: string}
Map of arbitrary keys and values that, when changed, will trigger a redeployment.
- variables {[key: string]: string}
Map to set on the stage managed by the
stage_name
argument.
- rest_
api str | str REST API identifier.
- description str
Description of the deployment
- stage_
description str Description to set on the stage managed by the
stage_name
argument.- stage_
name str Name of the stage to create with this deployment. If the specified stage already exists, it will be updated to point to the new deployment. We recommend using the
aws.apigateway.Stage
resource instead to manage stages.- triggers Mapping[str, str]
Map of arbitrary keys and values that, when changed, will trigger a redeployment.
- variables Mapping[str, str]
Map to set on the stage managed by the
stage_name
argument.
- rest
Api String | REST API identifier.
- description String
Description of the deployment
- stage
Description String Description to set on the stage managed by the
stage_name
argument.- stage
Name String Name of the stage to create with this deployment. If the specified stage already exists, it will be updated to point to the new deployment. We recommend using the
aws.apigateway.Stage
resource instead to manage stages.- triggers Map<String>
Map of arbitrary keys and values that, when changed, will trigger a redeployment.
- variables Map<String>
Map to set on the stage managed by the
stage_name
argument.
Outputs
All input properties are implicitly available as output properties. Additionally, the Deployment resource produces the following output properties:
- Created
Date string Creation date of the deployment
- Execution
Arn string Execution ARN to be used in
lambda_permission
'ssource_arn
when allowing API Gateway to invoke a Lambda function, e.g.,arn:aws:execute-api:eu-west-2:123456789012:z4675bid1j/prod
- Id string
The provider-assigned unique ID for this managed resource.
- Invoke
Url string URL to invoke the API pointing to the stage, e.g.,
https://z4675bid1j.execute-api.eu-west-2.amazonaws.com/prod
- Created
Date string Creation date of the deployment
- Execution
Arn string Execution ARN to be used in
lambda_permission
'ssource_arn
when allowing API Gateway to invoke a Lambda function, e.g.,arn:aws:execute-api:eu-west-2:123456789012:z4675bid1j/prod
- Id string
The provider-assigned unique ID for this managed resource.
- Invoke
Url string URL to invoke the API pointing to the stage, e.g.,
https://z4675bid1j.execute-api.eu-west-2.amazonaws.com/prod
- created
Date String Creation date of the deployment
- execution
Arn String Execution ARN to be used in
lambda_permission
'ssource_arn
when allowing API Gateway to invoke a Lambda function, e.g.,arn:aws:execute-api:eu-west-2:123456789012:z4675bid1j/prod
- id String
The provider-assigned unique ID for this managed resource.
- invoke
Url String URL to invoke the API pointing to the stage, e.g.,
https://z4675bid1j.execute-api.eu-west-2.amazonaws.com/prod
- created
Date string Creation date of the deployment
- execution
Arn string Execution ARN to be used in
lambda_permission
'ssource_arn
when allowing API Gateway to invoke a Lambda function, e.g.,arn:aws:execute-api:eu-west-2:123456789012:z4675bid1j/prod
- id string
The provider-assigned unique ID for this managed resource.
- invoke
Url string URL to invoke the API pointing to the stage, e.g.,
https://z4675bid1j.execute-api.eu-west-2.amazonaws.com/prod
- created_
date str Creation date of the deployment
- execution_
arn str Execution ARN to be used in
lambda_permission
'ssource_arn
when allowing API Gateway to invoke a Lambda function, e.g.,arn:aws:execute-api:eu-west-2:123456789012:z4675bid1j/prod
- id str
The provider-assigned unique ID for this managed resource.
- invoke_
url str URL to invoke the API pointing to the stage, e.g.,
https://z4675bid1j.execute-api.eu-west-2.amazonaws.com/prod
- created
Date String Creation date of the deployment
- execution
Arn String Execution ARN to be used in
lambda_permission
'ssource_arn
when allowing API Gateway to invoke a Lambda function, e.g.,arn:aws:execute-api:eu-west-2:123456789012:z4675bid1j/prod
- id String
The provider-assigned unique ID for this managed resource.
- invoke
Url String URL to invoke the API pointing to the stage, e.g.,
https://z4675bid1j.execute-api.eu-west-2.amazonaws.com/prod
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,
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)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Created
Date string Creation date of the deployment
- Description string
Description of the deployment
- Execution
Arn string Execution ARN to be used in
lambda_permission
'ssource_arn
when allowing API Gateway to invoke a Lambda function, e.g.,arn:aws:execute-api:eu-west-2:123456789012:z4675bid1j/prod
- Invoke
Url string URL to invoke the API pointing to the stage, e.g.,
https://z4675bid1j.execute-api.eu-west-2.amazonaws.com/prod
- Rest
Api string | string REST API identifier.
- Stage
Description string Description to set on the stage managed by the
stage_name
argument.- Stage
Name string Name of the stage to create with this deployment. If the specified stage already exists, it will be updated to point to the new deployment. We recommend using the
aws.apigateway.Stage
resource instead to manage stages.- Triggers Dictionary<string, string>
Map of arbitrary keys and values that, when changed, will trigger a redeployment.
- Variables Dictionary<string, string>
Map to set on the stage managed by the
stage_name
argument.
- Created
Date string Creation date of the deployment
- Description string
Description of the deployment
- Execution
Arn string Execution ARN to be used in
lambda_permission
'ssource_arn
when allowing API Gateway to invoke a Lambda function, e.g.,arn:aws:execute-api:eu-west-2:123456789012:z4675bid1j/prod
- Invoke
Url string URL to invoke the API pointing to the stage, e.g.,
https://z4675bid1j.execute-api.eu-west-2.amazonaws.com/prod
- Rest
Api string | string REST API identifier.
- Stage
Description string Description to set on the stage managed by the
stage_name
argument.- Stage
Name string Name of the stage to create with this deployment. If the specified stage already exists, it will be updated to point to the new deployment. We recommend using the
aws.apigateway.Stage
resource instead to manage stages.- Triggers map[string]string
Map of arbitrary keys and values that, when changed, will trigger a redeployment.
- Variables map[string]string
Map to set on the stage managed by the
stage_name
argument.
- created
Date String Creation date of the deployment
- description String
Description of the deployment
- execution
Arn String Execution ARN to be used in
lambda_permission
'ssource_arn
when allowing API Gateway to invoke a Lambda function, e.g.,arn:aws:execute-api:eu-west-2:123456789012:z4675bid1j/prod
- invoke
Url String URL to invoke the API pointing to the stage, e.g.,
https://z4675bid1j.execute-api.eu-west-2.amazonaws.com/prod
- rest
Api String | String REST API identifier.
- stage
Description String Description to set on the stage managed by the
stage_name
argument.- stage
Name String Name of the stage to create with this deployment. If the specified stage already exists, it will be updated to point to the new deployment. We recommend using the
aws.apigateway.Stage
resource instead to manage stages.- triggers Map<String,String>
Map of arbitrary keys and values that, when changed, will trigger a redeployment.
- variables Map<String,String>
Map to set on the stage managed by the
stage_name
argument.
- created
Date string Creation date of the deployment
- description string
Description of the deployment
- execution
Arn string Execution ARN to be used in
lambda_permission
'ssource_arn
when allowing API Gateway to invoke a Lambda function, e.g.,arn:aws:execute-api:eu-west-2:123456789012:z4675bid1j/prod
- invoke
Url string URL to invoke the API pointing to the stage, e.g.,
https://z4675bid1j.execute-api.eu-west-2.amazonaws.com/prod
- rest
Api string | RestApi REST API identifier.
- stage
Description string Description to set on the stage managed by the
stage_name
argument.- stage
Name string Name of the stage to create with this deployment. If the specified stage already exists, it will be updated to point to the new deployment. We recommend using the
aws.apigateway.Stage
resource instead to manage stages.- triggers {[key: string]: string}
Map of arbitrary keys and values that, when changed, will trigger a redeployment.
- variables {[key: string]: string}
Map to set on the stage managed by the
stage_name
argument.
- created_
date str Creation date of the deployment
- description str
Description of the deployment
- execution_
arn str Execution ARN to be used in
lambda_permission
'ssource_arn
when allowing API Gateway to invoke a Lambda function, e.g.,arn:aws:execute-api:eu-west-2:123456789012:z4675bid1j/prod
- invoke_
url str URL to invoke the API pointing to the stage, e.g.,
https://z4675bid1j.execute-api.eu-west-2.amazonaws.com/prod
- rest_
api str | str REST API identifier.
- stage_
description str Description to set on the stage managed by the
stage_name
argument.- stage_
name str Name of the stage to create with this deployment. If the specified stage already exists, it will be updated to point to the new deployment. We recommend using the
aws.apigateway.Stage
resource instead to manage stages.- triggers Mapping[str, str]
Map of arbitrary keys and values that, when changed, will trigger a redeployment.
- variables Mapping[str, str]
Map to set on the stage managed by the
stage_name
argument.
- created
Date String Creation date of the deployment
- description String
Description of the deployment
- execution
Arn String Execution ARN to be used in
lambda_permission
'ssource_arn
when allowing API Gateway to invoke a Lambda function, e.g.,arn:aws:execute-api:eu-west-2:123456789012:z4675bid1j/prod
- invoke
Url String URL to invoke the API pointing to the stage, e.g.,
https://z4675bid1j.execute-api.eu-west-2.amazonaws.com/prod
- rest
Api String | REST API identifier.
- stage
Description String Description to set on the stage managed by the
stage_name
argument.- stage
Name String Name of the stage to create with this deployment. If the specified stage already exists, it will be updated to point to the new deployment. We recommend using the
aws.apigateway.Stage
resource instead to manage stages.- triggers Map<String>
Map of arbitrary keys and values that, when changed, will trigger a redeployment.
- variables Map<String>
Map to set on the stage managed by the
stage_name
argument.
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.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
aws
Terraform Provider.
Try AWS Native preview for resources not in the classic version.