UNPKG

@pulumi/gcp

Version:

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

260 lines • 10.3 kB
import * as pulumi from "@pulumi/pulumi"; /** * An Integration connectors Endpoint Attachment. * * To get more information about EndpointAttachment, see: * * * [API documentation](https://cloud.google.com/integration-connectors/docs/reference/rest/v1/projects.locations.endpointAttachments) * * How-to Guides * * [Official Documentation](https://cloud.google.com/integration-connectors/docs/create-endpoint-attachment) * * ## Example Usage * * ### Integration Connectors Endpoint Attachment * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const sampleendpointattachment = new gcp.integrationconnectors.EndpointAttachment("sampleendpointattachment", { * name: "test-endpoint-attachment", * location: "us-central1", * description: "tf created description", * serviceAttachment: "projects/connectors-example/regions/us-central1/serviceAttachments/test", * labels: { * foo: "bar", * }, * }); * ``` * * ## Import * * EndpointAttachment can be imported using any of these accepted formats: * * * `projects/{{project}}/locations/{{location}}/endpointAttachments/{{name}}` * * `{{project}}/{{location}}/{{name}}` * * `{{location}}/{{name}}` * * When using the `pulumi import` command, EndpointAttachment can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:integrationconnectors/endpointAttachment:EndpointAttachment default projects/{{project}}/locations/{{location}}/endpointAttachments/{{name}} * $ pulumi import gcp:integrationconnectors/endpointAttachment:EndpointAttachment default {{project}}/{{location}}/{{name}} * $ pulumi import gcp:integrationconnectors/endpointAttachment:EndpointAttachment default {{location}}/{{name}} * ``` */ 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; /** * Time the Namespace was created in UTC. */ readonly createTime: 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>; /** * Description of the resource. */ readonly description: pulumi.Output<string | undefined>; /** * All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. */ readonly effectiveLabels: pulumi.Output<{ [key: string]: string; }>; /** * Enable global access for endpoint attachment. */ readonly endpointGlobalAccess: pulumi.Output<boolean | undefined>; /** * The Private Service Connect connection endpoint ip. */ readonly endpointIp: pulumi.Output<string>; /** * Resource labels to represent user provided metadata. * * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. * Please refer to the field `effectiveLabels` for all of the labels present on the resource. */ readonly labels: pulumi.Output<{ [key: string]: string; } | undefined>; /** * Location in which Endpoint Attachment needs to be created. */ readonly location: pulumi.Output<string>; /** * Name of Endpoint Attachment needs to be created. */ readonly name: pulumi.Output<string>; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ readonly project: pulumi.Output<string>; /** * The combination of labels configured directly on the resource * and default labels configured on the provider. */ readonly pulumiLabels: pulumi.Output<{ [key: string]: string; }>; /** * The path of the service attachment. */ readonly serviceAttachment: pulumi.Output<string>; /** * Time the Namespace was updated in UTC. */ readonly updateTime: 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 { /** * Time the Namespace was created in UTC. */ createTime?: 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>; /** * Description of the resource. */ description?: pulumi.Input<string | undefined>; /** * All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. */ effectiveLabels?: pulumi.Input<{ [key: string]: pulumi.Input<string>; } | undefined>; /** * Enable global access for endpoint attachment. */ endpointGlobalAccess?: pulumi.Input<boolean | undefined>; /** * The Private Service Connect connection endpoint ip. */ endpointIp?: pulumi.Input<string | undefined>; /** * Resource labels to represent user provided metadata. * * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. * Please refer to the field `effectiveLabels` for all of the labels present on the resource. */ labels?: pulumi.Input<{ [key: string]: pulumi.Input<string>; } | undefined>; /** * Location in which Endpoint Attachment needs to be created. */ location?: pulumi.Input<string | undefined>; /** * Name of Endpoint Attachment needs to be created. */ name?: pulumi.Input<string | undefined>; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input<string | undefined>; /** * The combination of labels configured directly on the resource * and default labels configured on the provider. */ pulumiLabels?: pulumi.Input<{ [key: string]: pulumi.Input<string>; } | undefined>; /** * The path of the service attachment. */ serviceAttachment?: pulumi.Input<string | undefined>; /** * Time the Namespace was updated in UTC. */ updateTime?: 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>; /** * Description of the resource. */ description?: pulumi.Input<string | undefined>; /** * Enable global access for endpoint attachment. */ endpointGlobalAccess?: pulumi.Input<boolean | undefined>; /** * Resource labels to represent user provided metadata. * * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. * Please refer to the field `effectiveLabels` for all of the labels present on the resource. */ labels?: pulumi.Input<{ [key: string]: pulumi.Input<string>; } | undefined>; /** * Location in which Endpoint Attachment needs to be created. */ location: pulumi.Input<string>; /** * Name of Endpoint Attachment needs to be created. */ name?: pulumi.Input<string | undefined>; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input<string | undefined>; /** * The path of the service attachment. */ serviceAttachment: pulumi.Input<string>; } //# sourceMappingURL=endpointAttachment.d.ts.map