@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
141 lines • 6.35 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Manages a deployment of an API proxy.
*
* To get more information about ApiDeployment, see:
*
* * [API documentation](https://cloud.google.com/apigee/docs/reference/apis/apigee/rest/v1/organizations.environments.apis.revisions.deployments)
* * How-to Guides
* * [QUICKSTART_TITLE](https://cloud.google.com/apigee/docs/api-platform/deploy/ui-deploy-overview)
*
* ## Example Usage
*
* ## Import
*
* ApiDeployment can be imported using any of these accepted formats:
*
* * `organizations/{{org_id}}/environments/{{environment}}/apis/{{proxy_id}}/revisions/{{revision}}/deployments`
* * `organizations/{{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:
*
* ```sh
* $ 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}}
* ```
*/
export declare class ApiDeployment extends pulumi.CustomResource {
/**
* Get an existing ApiDeployment resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ApiDeploymentState, opts?: pulumi.CustomResourceOptions): ApiDeployment;
/**
* Returns true if the given object is an instance of ApiDeployment. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is ApiDeployment;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
readonly deletionPolicy: pulumi.Output<string>;
/**
* The Apigee Environment associated with the Apigee API deployment.
*/
readonly environment: pulumi.Output<string>;
/**
* The Apigee Organization associated with the Apigee API deployment.
*/
readonly orgId: pulumi.Output<string>;
/**
* The Apigee API associated with the Apigee API deployment.
*/
readonly proxyId: pulumi.Output<string>;
/**
* The revision of the API proxy to be deployed.
*/
readonly revision: pulumi.Output<string>;
/**
* Create a ApiDeployment resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: ApiDeploymentArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ApiDeployment resources.
*/
export interface ApiDeploymentState {
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* The Apigee Environment associated with the Apigee API deployment.
*/
environment?: pulumi.Input<string | undefined>;
/**
* The Apigee Organization associated with the Apigee API deployment.
*/
orgId?: pulumi.Input<string | undefined>;
/**
* The Apigee API associated with the Apigee API deployment.
*/
proxyId?: pulumi.Input<string | undefined>;
/**
* The revision of the API proxy to be deployed.
*/
revision?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a ApiDeployment resource.
*/
export interface ApiDeploymentArgs {
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* The Apigee Environment associated with the Apigee API deployment.
*/
environment: pulumi.Input<string>;
/**
* The Apigee Organization associated with the Apigee API deployment.
*/
orgId: pulumi.Input<string>;
/**
* The Apigee API associated with the Apigee API deployment.
*/
proxyId: pulumi.Input<string>;
/**
* The revision of the API proxy to be deployed.
*/
revision: pulumi.Input<string>;
}
//# sourceMappingURL=apiDeployment.d.ts.map