1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. apigee
  5. EnvironmentApiRevisionDeployment
Google Cloud v9.4.0 published on Tuesday, Nov 4, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.apigee.EnvironmentApiRevisionDeployment

Start a Neo task
Explain and create a gcp.apigee.EnvironmentApiRevisionDeployment resource
gcp logo
Google Cloud v9.4.0 published on Tuesday, Nov 4, 2025 by Pulumi
pulumi/pulumi-gcp

    Deploys a specific Apigee API Proxy revision to a given Apigee environment.

    To get more information about EnvironmentApiRevisionDeployment, see:

    Example Usage

    Apigee Environment Api Revision Deployment Basic

    import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const proxyDeploymentBasic = new gcp.apigee.EnvironmentApiRevisionDeployment("proxy_deployment_basic", {
    orgId: "my-org",
    environment: "dev",
    api: "hello-proxy",
    revision: 1,
    override: true,
    sequencedRollout: true,
});

    import pulumi
import pulumi_gcp as gcp

proxy_deployment_basic = gcp.apigee.EnvironmentApiRevisionDeployment("proxy_deployment_basic",
    org_id="my-org",
    environment="dev",
    api="hello-proxy",
    revision=1,
    override=True,
    sequenced_rollout=True)

    package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/apigee"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apigee.NewEnvironmentApiRevisionDeployment(ctx, "proxy_deployment_basic", &apigee.EnvironmentApiRevisionDeploymentArgs{
			OrgId:            pulumi.String("my-org"),
			Environment:      pulumi.String("dev"),
			Api:              pulumi.String("hello-proxy"),
			Revision:         pulumi.Int(1),
			Override:         pulumi.Bool(true),
			SequencedRollout: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var proxyDeploymentBasic = new Gcp.Apigee.EnvironmentApiRevisionDeployment("proxy_deployment_basic", new()
    {
        OrgId = "my-org",
        Environment = "dev",
        Api = "hello-proxy",
        Revision = 1,
        Override = true,
        SequencedRollout = true,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.apigee.EnvironmentApiRevisionDeployment;
import com.pulumi.gcp.apigee.EnvironmentApiRevisionDeploymentArgs;
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 proxyDeploymentBasic = new EnvironmentApiRevisionDeployment("proxyDeploymentBasic", EnvironmentApiRevisionDeploymentArgs.builder()
            .orgId("my-org")
            .environment("dev")
            .api("hello-proxy")
            .revision(1)
            .override(true)
            .sequencedRollout(true)
            .build());

    }
}

    resources:
  proxyDeploymentBasic:
    type: gcp:apigee:EnvironmentApiRevisionDeployment
    name: proxy_deployment_basic
    properties:
      orgId: my-org
      environment: dev
      api: hello-proxy
      revision: 1
      override: true
      sequencedRollout: true

    Create EnvironmentApiRevisionDeployment Resource

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

    Constructor syntax

    new EnvironmentApiRevisionDeployment(name: string, args: EnvironmentApiRevisionDeploymentArgs, opts?: CustomResourceOptions);
    @overload
def EnvironmentApiRevisionDeployment(resource_name: str,
                                     args: EnvironmentApiRevisionDeploymentArgs,
                                     opts: Optional[ResourceOptions] = None)

@overload
def EnvironmentApiRevisionDeployment(resource_name: str,
                                     opts: Optional[ResourceOptions] = None,
                                     api: Optional[str] = None,
                                     environment: Optional[str] = None,
                                     org_id: Optional[str] = None,
                                     revision: Optional[int] = None,
                                     override: Optional[bool] = None,
                                     sequenced_rollout: Optional[bool] = None,
                                     service_account: Optional[str] = None)
    func NewEnvironmentApiRevisionDeployment(ctx *Context, name string, args EnvironmentApiRevisionDeploymentArgs, opts ...ResourceOption) (*EnvironmentApiRevisionDeployment, error)
    public EnvironmentApiRevisionDeployment(string name, EnvironmentApiRevisionDeploymentArgs args, CustomResourceOptions? opts = null)
    public EnvironmentApiRevisionDeployment(String name, EnvironmentApiRevisionDeploymentArgs args)
public EnvironmentApiRevisionDeployment(String name, EnvironmentApiRevisionDeploymentArgs args, CustomResourceOptions options)

    type: gcp:apigee:EnvironmentApiRevisionDeployment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args EnvironmentApiRevisionDeploymentArgs
    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 EnvironmentApiRevisionDeploymentArgs
    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 EnvironmentApiRevisionDeploymentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EnvironmentApiRevisionDeploymentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EnvironmentApiRevisionDeploymentArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var environmentApiRevisionDeploymentResource = new Gcp.Apigee.EnvironmentApiRevisionDeployment("environmentApiRevisionDeploymentResource", new()
{
    Api = "string",
    Environment = "string",
    OrgId = "string",
    Revision = 0,
    Override = false,
    SequencedRollout = false,
    ServiceAccount = "string",
});

    example, err := apigee.NewEnvironmentApiRevisionDeployment(ctx, "environmentApiRevisionDeploymentResource", &apigee.EnvironmentApiRevisionDeploymentArgs{
	Api:              pulumi.String("string"),
	Environment:      pulumi.String("string"),
	OrgId:            pulumi.String("string"),
	Revision:         pulumi.Int(0),
	Override:         pulumi.Bool(false),
	SequencedRollout: pulumi.Bool(false),
	ServiceAccount:   pulumi.String("string"),
})

    var environmentApiRevisionDeploymentResource = new EnvironmentApiRevisionDeployment("environmentApiRevisionDeploymentResource", EnvironmentApiRevisionDeploymentArgs.builder()
    .api("string")
    .environment("string")
    .orgId("string")
    .revision(0)
    .override(false)
    .sequencedRollout(false)
    .serviceAccount("string")
    .build());

    environment_api_revision_deployment_resource = gcp.apigee.EnvironmentApiRevisionDeployment("environmentApiRevisionDeploymentResource",
    api="string",
    environment="string",
    org_id="string",
    revision=0,
    override=False,
    sequenced_rollout=False,
    service_account="string")

    const environmentApiRevisionDeploymentResource = new gcp.apigee.EnvironmentApiRevisionDeployment("environmentApiRevisionDeploymentResource", {
    api: "string",
    environment: "string",
    orgId: "string",
    revision: 0,
    override: false,
    sequencedRollout: false,
    serviceAccount: "string",
});

    type: gcp:apigee:EnvironmentApiRevisionDeployment
properties:
    api: string
    environment: string
    orgId: string
    override: false
    revision: 0
    sequencedRollout: false
    serviceAccount: string

    EnvironmentApiRevisionDeployment Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The EnvironmentApiRevisionDeployment resource accepts the following input properties:

    Api string
    Apigee API proxy name.
    Environment string
    Apigee environment name.
    OrgId string
    Apigee organization ID.
    Revision int
    API proxy revision number to deploy.
    Override bool
    If true, replaces other deployed revisions of this proxy in the environment.
    SequencedRollout bool
    If true, enables sequenced rollout for safe traffic switching.
    ServiceAccount string
    Optional service account the deployed proxy runs as.
    Api string
    Apigee API proxy name.
    Environment string
    Apigee environment name.
    OrgId string
    Apigee organization ID.
    Revision int
    API proxy revision number to deploy.
    Override bool
    If true, replaces other deployed revisions of this proxy in the environment.
    SequencedRollout bool
    If true, enables sequenced rollout for safe traffic switching.
    ServiceAccount string
    Optional service account the deployed proxy runs as.
    api String
    Apigee API proxy name.
    environment String
    Apigee environment name.
    orgId String
    Apigee organization ID.
    revision Integer
    API proxy revision number to deploy.
    override Boolean
    If true, replaces other deployed revisions of this proxy in the environment.
    sequencedRollout Boolean
    If true, enables sequenced rollout for safe traffic switching.
    serviceAccount String
    Optional service account the deployed proxy runs as.
    api string
    Apigee API proxy name.
    environment string
    Apigee environment name.
    orgId string
    Apigee organization ID.
    revision number
    API proxy revision number to deploy.
    override boolean
    If true, replaces other deployed revisions of this proxy in the environment.
    sequencedRollout boolean
    If true, enables sequenced rollout for safe traffic switching.
    serviceAccount string
    Optional service account the deployed proxy runs as.
    api str
    Apigee API proxy name.
    environment str
    Apigee environment name.
    org_id str
    Apigee organization ID.
    revision int
    API proxy revision number to deploy.
    override bool
    If true, replaces other deployed revisions of this proxy in the environment.
    sequenced_rollout bool
    If true, enables sequenced rollout for safe traffic switching.
    service_account str
    Optional service account the deployed proxy runs as.
    api String
    Apigee API proxy name.
    environment String
    Apigee environment name.
    orgId String
    Apigee organization ID.
    revision Number
    API proxy revision number to deploy.
    override Boolean
    If true, replaces other deployed revisions of this proxy in the environment.
    sequencedRollout Boolean
    If true, enables sequenced rollout for safe traffic switching.
    serviceAccount String
    Optional service account the deployed proxy runs as.

    Outputs

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

    Basepaths List<string>
    Basepaths associated with the deployed proxy.
    DeployStartTime string
    RFC3339 timestamp when deployment started.
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    Deployment state reported by Apigee.
    Basepaths []string
    Basepaths associated with the deployed proxy.
    DeployStartTime string
    RFC3339 timestamp when deployment started.
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    Deployment state reported by Apigee.
    basepaths List<String>
    Basepaths associated with the deployed proxy.
    deployStartTime String
    RFC3339 timestamp when deployment started.
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    Deployment state reported by Apigee.
    basepaths string[]
    Basepaths associated with the deployed proxy.
    deployStartTime string
    RFC3339 timestamp when deployment started.
    id string
    The provider-assigned unique ID for this managed resource.
    state string
    Deployment state reported by Apigee.
    basepaths Sequence[str]
    Basepaths associated with the deployed proxy.
    deploy_start_time str
    RFC3339 timestamp when deployment started.
    id str
    The provider-assigned unique ID for this managed resource.
    state str
    Deployment state reported by Apigee.
    basepaths List<String>
    Basepaths associated with the deployed proxy.
    deployStartTime String
    RFC3339 timestamp when deployment started.
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    Deployment state reported by Apigee.

    Look up Existing EnvironmentApiRevisionDeployment Resource

    Get an existing EnvironmentApiRevisionDeployment 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?: EnvironmentApiRevisionDeploymentState, opts?: CustomResourceOptions): EnvironmentApiRevisionDeployment
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api: Optional[str] = None,
        basepaths: Optional[Sequence[str]] = None,
        deploy_start_time: Optional[str] = None,
        environment: Optional[str] = None,
        org_id: Optional[str] = None,
        override: Optional[bool] = None,
        revision: Optional[int] = None,
        sequenced_rollout: Optional[bool] = None,
        service_account: Optional[str] = None,
        state: Optional[str] = None) -> EnvironmentApiRevisionDeployment
    func GetEnvironmentApiRevisionDeployment(ctx *Context, name string, id IDInput, state *EnvironmentApiRevisionDeploymentState, opts ...ResourceOption) (*EnvironmentApiRevisionDeployment, error)
    public static EnvironmentApiRevisionDeployment Get(string name, Input<string> id, EnvironmentApiRevisionDeploymentState? state, CustomResourceOptions? opts = null)
    public static EnvironmentApiRevisionDeployment get(String name, Output<String> id, EnvironmentApiRevisionDeploymentState state, CustomResourceOptions options)
    resources:  _:    type: gcp:apigee:EnvironmentApiRevisionDeployment    get:      id: ${id}
    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.
    The following state arguments are supported:
    Api string
    Apigee API proxy name.
    Basepaths List<string>
    Basepaths associated with the deployed proxy.
    DeployStartTime string
    RFC3339 timestamp when deployment started.
    Environment string
    Apigee environment name.
    OrgId string
    Apigee organization ID.
    Override bool
    If true, replaces other deployed revisions of this proxy in the environment.
    Revision int
    API proxy revision number to deploy.
    SequencedRollout bool
    If true, enables sequenced rollout for safe traffic switching.
    ServiceAccount string
    Optional service account the deployed proxy runs as.
    State string
    Deployment state reported by Apigee.
    Api string
    Apigee API proxy name.
    Basepaths []string
    Basepaths associated with the deployed proxy.
    DeployStartTime string
    RFC3339 timestamp when deployment started.
    Environment string
    Apigee environment name.
    OrgId string
    Apigee organization ID.
    Override bool
    If true, replaces other deployed revisions of this proxy in the environment.
    Revision int
    API proxy revision number to deploy.
    SequencedRollout bool
    If true, enables sequenced rollout for safe traffic switching.
    ServiceAccount string
    Optional service account the deployed proxy runs as.
    State string
    Deployment state reported by Apigee.
    api String
    Apigee API proxy name.
    basepaths List<String>
    Basepaths associated with the deployed proxy.
    deployStartTime String
    RFC3339 timestamp when deployment started.
    environment String
    Apigee environment name.
    orgId String
    Apigee organization ID.
    override Boolean
    If true, replaces other deployed revisions of this proxy in the environment.
    revision Integer
    API proxy revision number to deploy.
    sequencedRollout Boolean
    If true, enables sequenced rollout for safe traffic switching.
    serviceAccount String
    Optional service account the deployed proxy runs as.
    state String
    Deployment state reported by Apigee.
    api string
    Apigee API proxy name.
    basepaths string[]
    Basepaths associated with the deployed proxy.
    deployStartTime string
    RFC3339 timestamp when deployment started.
    environment string
    Apigee environment name.
    orgId string
    Apigee organization ID.
    override boolean
    If true, replaces other deployed revisions of this proxy in the environment.
    revision number
    API proxy revision number to deploy.
    sequencedRollout boolean
    If true, enables sequenced rollout for safe traffic switching.
    serviceAccount string
    Optional service account the deployed proxy runs as.
    state string
    Deployment state reported by Apigee.
    api str
    Apigee API proxy name.
    basepaths Sequence[str]
    Basepaths associated with the deployed proxy.
    deploy_start_time str
    RFC3339 timestamp when deployment started.
    environment str
    Apigee environment name.
    org_id str
    Apigee organization ID.
    override bool
    If true, replaces other deployed revisions of this proxy in the environment.
    revision int
    API proxy revision number to deploy.
    sequenced_rollout bool
    If true, enables sequenced rollout for safe traffic switching.
    service_account str
    Optional service account the deployed proxy runs as.
    state str
    Deployment state reported by Apigee.
    api String
    Apigee API proxy name.
    basepaths List<String>
    Basepaths associated with the deployed proxy.
    deployStartTime String
    RFC3339 timestamp when deployment started.
    environment String
    Apigee environment name.
    orgId String
    Apigee organization ID.
    override Boolean
    If true, replaces other deployed revisions of this proxy in the environment.
    revision Number
    API proxy revision number to deploy.
    sequencedRollout Boolean
    If true, enables sequenced rollout for safe traffic switching.
    serviceAccount String
    Optional service account the deployed proxy runs as.
    state String
    Deployment state reported by Apigee.

    Import

    EnvironmentApiRevisionDeployment can be imported using any of these accepted formats:

    • organizations/{{org_id}}/environments/{{environment}}/apis/{{api}}/revisions/{{revision}}

    • {{org_id}}/{{environment}}/{{api}}/{{revision}}

    • {{id}}

    When using the pulumi import command, EnvironmentApiRevisionDeployment can be imported using one of the formats above. For example:

    $ pulumi import gcp:apigee/environmentApiRevisionDeployment:EnvironmentApiRevisionDeployment default organizations/{{org_id}}/environments/{{environment}}/apis/{{api}}/revisions/{{revision}}

    $ pulumi import gcp:apigee/environmentApiRevisionDeployment:EnvironmentApiRevisionDeployment default {{org_id}}/{{environment}}/{{api}}/{{revision}}

    $ pulumi import gcp:apigee/environmentApiRevisionDeployment:EnvironmentApiRevisionDeployment default {{id}}

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

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud v9.4.0 published on Tuesday, Nov 4, 2025 by Pulumi
    pulumi/pulumi-gcp
      Meet Neo: Your AI Platform Teammate