Google Cloud v9.3.0 published on Tuesday, Oct 7, 2025 by Pulumi
gcp.apigee.ApiDeployment
Manages a deployment of an API proxy.
To get more information about ApiDeployment, see:
- API documentation
- How-to Guides
Example Usage
Create ApiDeployment Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ApiDeployment(name: string, args: ApiDeploymentArgs, opts?: CustomResourceOptions);@overload
def ApiDeployment(resource_name: str,
args: ApiDeploymentArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ApiDeployment(resource_name: str,
opts: Optional[ResourceOptions] = None,
environment: Optional[str] = None,
org_id: Optional[str] = None,
proxy_id: Optional[str] = None,
revision: Optional[str] = None)func NewApiDeployment(ctx *Context, name string, args ApiDeploymentArgs, opts ...ResourceOption) (*ApiDeployment, error)public ApiDeployment(string name, ApiDeploymentArgs args, CustomResourceOptions? opts = null)
public ApiDeployment(String name, ApiDeploymentArgs args)
public ApiDeployment(String name, ApiDeploymentArgs args, CustomResourceOptions options)
type: gcp:apigee:ApiDeployment
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 ApiDeploymentArgs
- 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 ApiDeploymentArgs
- 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 ApiDeploymentArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ApiDeploymentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ApiDeploymentArgs
- 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 apiDeploymentResource = new Gcp.Apigee.ApiDeployment("apiDeploymentResource", new()
{
Environment = "string",
OrgId = "string",
ProxyId = "string",
Revision = "string",
});
example, err := apigee.NewApiDeployment(ctx, "apiDeploymentResource", &apigee.ApiDeploymentArgs{
Environment: pulumi.String("string"),
OrgId: pulumi.String("string"),
ProxyId: pulumi.String("string"),
Revision: pulumi.String("string"),
})
var apiDeploymentResource = new ApiDeployment("apiDeploymentResource", ApiDeploymentArgs.builder()
.environment("string")
.orgId("string")
.proxyId("string")
.revision("string")
.build());
api_deployment_resource = gcp.apigee.ApiDeployment("apiDeploymentResource",
environment="string",
org_id="string",
proxy_id="string",
revision="string")
const apiDeploymentResource = new gcp.apigee.ApiDeployment("apiDeploymentResource", {
environment: "string",
orgId: "string",
proxyId: "string",
revision: "string",
});
type: gcp:apigee:ApiDeployment
properties:
environment: string
orgId: string
proxyId: string
revision: string
ApiDeployment 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 ApiDeployment resource accepts the following input properties:
- Environment string
- The Apigee Environment associated with the Apigee API deployment.
- Org
Id string - The Apigee Organization associated with the Apigee API deployment.
- Proxy
Id string - The Apigee API associated with the Apigee API deployment.
- Revision string
- The revision of the API proxy to be deployed.
- Environment string
- The Apigee Environment associated with the Apigee API deployment.
- Org
Id string - The Apigee Organization associated with the Apigee API deployment.
- Proxy
Id string - The Apigee API associated with the Apigee API deployment.
- Revision string
- The revision of the API proxy to be deployed.
- environment String
- The Apigee Environment associated with the Apigee API deployment.
- org
Id String - The Apigee Organization associated with the Apigee API deployment.
- proxy
Id String - The Apigee API associated with the Apigee API deployment.
- revision String
- The revision of the API proxy to be deployed.
- environment string
- The Apigee Environment associated with the Apigee API deployment.
- org
Id string - The Apigee Organization associated with the Apigee API deployment.
- proxy
Id string - The Apigee API associated with the Apigee API deployment.
- revision string
- The revision of the API proxy to be deployed.
- environment str
- The Apigee Environment associated with the Apigee API deployment.
- org_
id str - The Apigee Organization associated with the Apigee API deployment.
- proxy_
id str - The Apigee API associated with the Apigee API deployment.
- revision str
- The revision of the API proxy to be deployed.
- environment String
- The Apigee Environment associated with the Apigee API deployment.
- org
Id String - The Apigee Organization associated with the Apigee API deployment.
- proxy
Id String - The Apigee API associated with the Apigee API deployment.
- revision String
- The revision of the API proxy to be deployed.
Outputs
All input properties are implicitly available as output properties. Additionally, the ApiDeployment resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing ApiDeployment Resource
Get an existing ApiDeployment 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?: ApiDeploymentState, opts?: CustomResourceOptions): ApiDeployment@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
environment: Optional[str] = None,
org_id: Optional[str] = None,
proxy_id: Optional[str] = None,
revision: Optional[str] = None) -> ApiDeploymentfunc GetApiDeployment(ctx *Context, name string, id IDInput, state *ApiDeploymentState, opts ...ResourceOption) (*ApiDeployment, error)public static ApiDeployment Get(string name, Input<string> id, ApiDeploymentState? state, CustomResourceOptions? opts = null)public static ApiDeployment get(String name, Output<String> id, ApiDeploymentState state, CustomResourceOptions options)resources: _: type: gcp:apigee:ApiDeployment 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.
- Environment string
- The Apigee Environment associated with the Apigee API deployment.
- Org
Id string - The Apigee Organization associated with the Apigee API deployment.
- Proxy
Id string - The Apigee API associated with the Apigee API deployment.
- Revision string
- The revision of the API proxy to be deployed.
- Environment string
- The Apigee Environment associated with the Apigee API deployment.
- Org
Id string - The Apigee Organization associated with the Apigee API deployment.
- Proxy
Id string - The Apigee API associated with the Apigee API deployment.
- Revision string
- The revision of the API proxy to be deployed.
- environment String
- The Apigee Environment associated with the Apigee API deployment.
- org
Id String - The Apigee Organization associated with the Apigee API deployment.
- proxy
Id String - The Apigee API associated with the Apigee API deployment.
- revision String
- The revision of the API proxy to be deployed.
- environment string
- The Apigee Environment associated with the Apigee API deployment.
- org
Id string - The Apigee Organization associated with the Apigee API deployment.
- proxy
Id string - The Apigee API associated with the Apigee API deployment.
- revision string
- The revision of the API proxy to be deployed.
- environment str
- The Apigee Environment associated with the Apigee API deployment.
- org_
id str - The Apigee Organization associated with the Apigee API deployment.
- proxy_
id str - The Apigee API associated with the Apigee API deployment.
- revision str
- The revision of the API proxy to be deployed.
- environment String
- The Apigee Environment associated with the Apigee API deployment.
- org
Id String - The Apigee Organization associated with the Apigee API deployment.
- proxy
Id String - The Apigee API associated with the Apigee API deployment.
- revision String
- The revision of the API proxy to be deployed.
Import
ApiDeployment can be imported using any of these accepted formats:
organizations/{{org_id}}/environments/{{environment}}/apis/{{proxy_id}}/revisions/{{revision}}/deploymentsorganizations/{{org_id}}/environments/{{environment}}/apis/{{proxy_id}}/revisions/{{revision}}{{org_id}}/{{environment}}/{{proxy_id}}/{{revision}}/deployments{{org_id}}/{{environment}}/{{proxy_id}}/{{revision}}
When using the pulumi import command, ApiDeployment can be imported using one of the formats above. For example:
$ pulumi import gcp:apigee/apiDeployment:ApiDeployment default organizations/{{org_id}}/environments/{{environment}}/apis/{{proxy_id}}/revisions/{{revision}}/deployments
$ pulumi import gcp:apigee/apiDeployment:ApiDeployment default organizations/{{org_id}}/environments/{{environment}}/apis/{{proxy_id}}/revisions/{{revision}}
$ pulumi import gcp:apigee/apiDeployment:ApiDeployment default {{org_id}}/{{environment}}/{{proxy_id}}/{{revision}}/deployments
$ pulumi import gcp:apigee/apiDeployment:ApiDeployment default {{org_id}}/{{environment}}/{{proxy_id}}/{{revision}}
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-betaTerraform Provider.
