@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
164 lines • 6.91 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Apigee Endpoint Attachment.
*
* To get more information about EndpointAttachment, see:
*
* * [API documentation](https://cloud.google.com/apigee/docs/reference/apis/apigee/rest/v1/organizations.endpointAttachments/create)
* * How-to Guides
* * [Creating an environment](https://cloud.google.com/apigee/docs/api-platform/get-started/create-environment)
*
* ## Import
*
* EndpointAttachment can be imported using any of these accepted formats:
*
* * `{{org_id}}/endpointAttachments/{{endpoint_attachment_id}}`
* * `{{org_id}}/{{endpoint_attachment_id}}`
*
* When using the `pulumi import` command, EndpointAttachment can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:apigee/endpointAttachment:EndpointAttachment default {{org_id}}/endpointAttachments/{{endpoint_attachment_id}}
* $ pulumi import gcp:apigee/endpointAttachment:EndpointAttachment default {{org_id}}/{{endpoint_attachment_id}}
* ```
*/
export declare class EndpointAttachment extends pulumi.CustomResource {
/**
* Get an existing EndpointAttachment 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?: EndpointAttachmentState, opts?: pulumi.CustomResourceOptions): EndpointAttachment;
/**
* Returns true if the given object is an instance of EndpointAttachment. 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 EndpointAttachment;
/**
* State of the endpoint attachment connection to the service attachment.
*/
readonly connectionState: 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>;
/**
* ID of the endpoint attachment.
*/
readonly endpointAttachmentId: pulumi.Output<string>;
/**
* Host that can be used in either HTTP Target Endpoint directly, or as the host in Target Server.
*/
readonly host: pulumi.Output<string>;
/**
* Location of the endpoint attachment.
*/
readonly location: pulumi.Output<string>;
/**
* Name of the Endpoint Attachment in the following format:
* organizations/{organization}/endpointAttachments/{endpointAttachment}.
*/
readonly name: pulumi.Output<string>;
/**
* The Apigee Organization associated with the Apigee instance,
* in the format `organizations/{{org_name}}`.
*/
readonly orgId: pulumi.Output<string>;
/**
* Format: projects/*/regions/*/serviceAttachments/*
*/
readonly serviceAttachment: pulumi.Output<string>;
/**
* Create a EndpointAttachment 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: EndpointAttachmentArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering EndpointAttachment resources.
*/
export interface EndpointAttachmentState {
/**
* State of the endpoint attachment connection to the service attachment.
*/
connectionState?: 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>;
/**
* ID of the endpoint attachment.
*/
endpointAttachmentId?: pulumi.Input<string | undefined>;
/**
* Host that can be used in either HTTP Target Endpoint directly, or as the host in Target Server.
*/
host?: pulumi.Input<string | undefined>;
/**
* Location of the endpoint attachment.
*/
location?: pulumi.Input<string | undefined>;
/**
* Name of the Endpoint Attachment in the following format:
* organizations/{organization}/endpointAttachments/{endpointAttachment}.
*/
name?: pulumi.Input<string | undefined>;
/**
* The Apigee Organization associated with the Apigee instance,
* in the format `organizations/{{org_name}}`.
*/
orgId?: pulumi.Input<string | undefined>;
/**
* Format: projects/*/regions/*/serviceAttachments/*
*/
serviceAttachment?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a EndpointAttachment resource.
*/
export interface EndpointAttachmentArgs {
/**
* 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>;
/**
* ID of the endpoint attachment.
*/
endpointAttachmentId: pulumi.Input<string>;
/**
* Location of the endpoint attachment.
*/
location: pulumi.Input<string>;
/**
* The Apigee Organization associated with the Apigee instance,
* in the format `organizations/{{org_name}}`.
*/
orgId: pulumi.Input<string>;
/**
* Format: projects/*/regions/*/serviceAttachments/*
*/
serviceAttachment: pulumi.Input<string>;
}
//# sourceMappingURL=endpointAttachment.d.ts.map