@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
110 lines (109 loc) • 3.88 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* An `Instance attachment` in Apigee.
*
* To get more information about InstanceAttachment, see:
*
* * [API documentation](https://cloud.google.com/apigee/docs/reference/apis/apigee/rest/v1/organizations.instances.attachments/create)
* * How-to Guides
* * [Creating an environment](https://cloud.google.com/apigee/docs/api-platform/get-started/create-environment)
*
* ## Example Usage
*
* ## Import
*
* InstanceAttachment can be imported using any of these accepted formats:
*
* * `{{instance_id}}/attachments/{{name}}`
*
* * `{{instance_id}}/{{name}}`
*
* When using the `pulumi import` command, InstanceAttachment can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:apigee/instanceAttachment:InstanceAttachment default {{instance_id}}/attachments/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:apigee/instanceAttachment:InstanceAttachment default {{instance_id}}/{{name}}
* ```
*/
export declare class InstanceAttachment extends pulumi.CustomResource {
/**
* Get an existing InstanceAttachment 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?: InstanceAttachmentState, opts?: pulumi.CustomResourceOptions): InstanceAttachment;
/**
* Returns true if the given object is an instance of InstanceAttachment. 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 InstanceAttachment;
/**
* The resource ID of the environment.
*/
readonly environment: pulumi.Output<string>;
/**
* The Apigee instance associated with the Apigee environment,
* in the format `organizations/{{org_name}}/instances/{{instance_name}}`.
*
*
* - - -
*/
readonly instanceId: pulumi.Output<string>;
/**
* The name of the newly created attachment (output parameter).
*/
readonly name: pulumi.Output<string>;
/**
* Create a InstanceAttachment 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: InstanceAttachmentArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering InstanceAttachment resources.
*/
export interface InstanceAttachmentState {
/**
* The resource ID of the environment.
*/
environment?: pulumi.Input<string>;
/**
* The Apigee instance associated with the Apigee environment,
* in the format `organizations/{{org_name}}/instances/{{instance_name}}`.
*
*
* - - -
*/
instanceId?: pulumi.Input<string>;
/**
* The name of the newly created attachment (output parameter).
*/
name?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a InstanceAttachment resource.
*/
export interface InstanceAttachmentArgs {
/**
* The resource ID of the environment.
*/
environment: pulumi.Input<string>;
/**
* The Apigee instance associated with the Apigee environment,
* in the format `organizations/{{org_name}}/instances/{{instance_name}}`.
*
*
* - - -
*/
instanceId: pulumi.Input<string>;
}