UNPKG

@pulumi/gcp

Version:

A Pulumi package for creating and managing Google Cloud Platform resources.

179 lines 7.7 kB
import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * You can combine policies and resources into a shared flow that you can consume from multiple API proxies, and even from other shared flows. Although it's like a proxy, a shared flow has no endpoint. It can be used only from an API proxy or shared flow that's in the same organization as the shared flow itself. * * To get more information about SharedFlow, see: * * * [API documentation](https://cloud.google.com/apigee/docs/reference/apis/apigee/rest/v1/organizations.sharedflows) * * How-to Guides * * [Sharedflows](https://cloud.google.com/apigee/docs/resources) * * ## Example Usage * * ## Import * * SharedFlow can be imported using any of these accepted formats: * * * `{{org_id}}/sharedflows/{{name}}` * * `{{org_id}}/{{name}}` * * When using the `pulumi import` command, SharedFlow can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:apigee/sharedflow:Sharedflow default {{org_id}}/sharedflows/{{name}} * $ pulumi import gcp:apigee/sharedflow:Sharedflow default {{org_id}}/{{name}} * ``` */ export declare class Sharedflow extends pulumi.CustomResource { /** * Get an existing Sharedflow 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?: SharedflowState, opts?: pulumi.CustomResourceOptions): Sharedflow; /** * Returns true if the given object is an instance of Sharedflow. 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 Sharedflow; /** * Path to the config zip bundle. */ readonly configBundle: pulumi.Output<string>; /** * (Optional) 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>; /** * (Optional) Detect changes to local config bundle file or changes made outside of Terraform. MD5 hash of the data, encoded using base64. Hash is automatically computed without need for user input. */ readonly detectMd5hash: pulumi.Output<string | undefined>; /** * The id of the most recently created revision for this shared flow. */ readonly latestRevisionId: pulumi.Output<string>; /** * (Computed) Base 64 MD5 hash of the uploaded data. It is speculative as remote does not return hash of the bundle. Remote changes are detected using returned lastModified timestamp. */ readonly md5hash: pulumi.Output<string>; /** * Metadata describing the shared flow. * Structure is documented below. */ readonly metaDatas: pulumi.Output<outputs.apigee.SharedflowMetaData[]>; /** * The ID of the shared flow. */ readonly name: pulumi.Output<string>; /** * The Apigee Organization name associated with the Apigee instance. */ readonly orgId: pulumi.Output<string>; /** * A list of revisions of this shared flow. */ readonly revisions: pulumi.Output<string[]>; /** * Create a Sharedflow 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: SharedflowArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Sharedflow resources. */ export interface SharedflowState { /** * Path to the config zip bundle. */ configBundle?: pulumi.Input<string | undefined>; /** * (Optional) 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>; /** * (Optional) Detect changes to local config bundle file or changes made outside of Terraform. MD5 hash of the data, encoded using base64. Hash is automatically computed without need for user input. */ detectMd5hash?: pulumi.Input<string | undefined>; /** * The id of the most recently created revision for this shared flow. */ latestRevisionId?: pulumi.Input<string | undefined>; /** * (Computed) Base 64 MD5 hash of the uploaded data. It is speculative as remote does not return hash of the bundle. Remote changes are detected using returned lastModified timestamp. */ md5hash?: pulumi.Input<string | undefined>; /** * Metadata describing the shared flow. * Structure is documented below. */ metaDatas?: pulumi.Input<pulumi.Input<inputs.apigee.SharedflowMetaData>[] | undefined>; /** * The ID of the shared flow. */ name?: pulumi.Input<string | undefined>; /** * The Apigee Organization name associated with the Apigee instance. */ orgId?: pulumi.Input<string | undefined>; /** * A list of revisions of this shared flow. */ revisions?: pulumi.Input<pulumi.Input<string>[] | undefined>; } /** * The set of arguments for constructing a Sharedflow resource. */ export interface SharedflowArgs { /** * Path to the config zip bundle. */ configBundle: pulumi.Input<string>; /** * (Optional) 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>; /** * (Optional) Detect changes to local config bundle file or changes made outside of Terraform. MD5 hash of the data, encoded using base64. Hash is automatically computed without need for user input. */ detectMd5hash?: pulumi.Input<string | undefined>; /** * The ID of the shared flow. */ name?: pulumi.Input<string | undefined>; /** * The Apigee Organization name associated with the Apigee instance. */ orgId: pulumi.Input<string>; } //# sourceMappingURL=sharedflow.d.ts.map