@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
215 lines • 8.45 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Deploys a specific Apigee API Proxy revision to a given Apigee environment.
*
* To get more information about EnvironmentApiRevisionDeployment, see:
*
* * [API documentation](https://cloud.google.com/apigee/docs/reference/apis/apigee/rest/v1/organizations.environments.apis.revisions.deployments/deploy)
* * How-to Guides
* * [Deploying an API proxy](https://cloud.google.com/apigee/docs/api-platform/deploy/ui-deploy-new#apigee-api)
*
* ## Example Usage
*
* ### Apigee Environment Api Revision Deployment Basic
*
* ```typescript
* 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
*
* 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:
*
* ```sh
* $ 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}}
* ```
*/
export declare class EnvironmentApiRevisionDeployment extends pulumi.CustomResource {
/**
* Get an existing EnvironmentApiRevisionDeployment 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?: EnvironmentApiRevisionDeploymentState, opts?: pulumi.CustomResourceOptions): EnvironmentApiRevisionDeployment;
/**
* Returns true if the given object is an instance of EnvironmentApiRevisionDeployment. 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 EnvironmentApiRevisionDeployment;
/**
* Apigee API proxy name.
*/
readonly api: pulumi.Output<string>;
/**
* Basepaths associated with the deployed proxy.
*/
readonly basepaths: pulumi.Output<string[]>;
/**
* 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>;
/**
* RFC3339 timestamp when deployment started.
*/
readonly deployStartTime: pulumi.Output<string>;
/**
* Apigee environment name.
*/
readonly environment: pulumi.Output<string>;
/**
* Apigee organization ID.
*/
readonly orgId: pulumi.Output<string>;
/**
* If true, replaces other deployed revisions of this proxy in the environment.
*/
readonly override: pulumi.Output<boolean | undefined>;
/**
* API proxy revision number to deploy.
*/
readonly revision: pulumi.Output<number>;
/**
* If true, enables sequenced rollout for safe traffic switching.
*/
readonly sequencedRollout: pulumi.Output<boolean | undefined>;
/**
* Optional service account the deployed proxy runs as.
*/
readonly serviceAccount: pulumi.Output<string | undefined>;
/**
* Deployment state reported by Apigee.
*/
readonly state: pulumi.Output<string>;
/**
* Create a EnvironmentApiRevisionDeployment 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: EnvironmentApiRevisionDeploymentArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering EnvironmentApiRevisionDeployment resources.
*/
export interface EnvironmentApiRevisionDeploymentState {
/**
* Apigee API proxy name.
*/
api?: pulumi.Input<string | undefined>;
/**
* Basepaths associated with the deployed proxy.
*/
basepaths?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* 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>;
/**
* RFC3339 timestamp when deployment started.
*/
deployStartTime?: pulumi.Input<string | undefined>;
/**
* Apigee environment name.
*/
environment?: pulumi.Input<string | undefined>;
/**
* Apigee organization ID.
*/
orgId?: pulumi.Input<string | undefined>;
/**
* If true, replaces other deployed revisions of this proxy in the environment.
*/
override?: pulumi.Input<boolean | undefined>;
/**
* API proxy revision number to deploy.
*/
revision?: pulumi.Input<number | undefined>;
/**
* If true, enables sequenced rollout for safe traffic switching.
*/
sequencedRollout?: pulumi.Input<boolean | undefined>;
/**
* Optional service account the deployed proxy runs as.
*/
serviceAccount?: pulumi.Input<string | undefined>;
/**
* Deployment state reported by Apigee.
*/
state?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a EnvironmentApiRevisionDeployment resource.
*/
export interface EnvironmentApiRevisionDeploymentArgs {
/**
* Apigee API proxy name.
*/
api: pulumi.Input<string>;
/**
* 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>;
/**
* Apigee environment name.
*/
environment: pulumi.Input<string>;
/**
* Apigee organization ID.
*/
orgId: pulumi.Input<string>;
/**
* If true, replaces other deployed revisions of this proxy in the environment.
*/
override?: pulumi.Input<boolean | undefined>;
/**
* API proxy revision number to deploy.
*/
revision: pulumi.Input<number>;
/**
* If true, enables sequenced rollout for safe traffic switching.
*/
sequencedRollout?: pulumi.Input<boolean | undefined>;
/**
* Optional service account the deployed proxy runs as.
*/
serviceAccount?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=environmentApiRevisionDeployment.d.ts.map