@pulumi/gcp

import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * EntryLink represents a link between two Entries. * * To get more information about EntryLink, see: * * * [API documentation](https://cloud.google.com/dataplex/docs/reference/rest/v1/projects.locations.entryGroups.entryLinks) * * How-to Guides * * [Official Documentation](https://cloud.google.com/dataplex/docs) * * ## Example Usage * * ### Dataplex Entry Link Basic * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const entry_group_basic = new gcp.dataplex.EntryGroup("entry-group-basic", { * location: "us-central1", * entryGroupId: "tf-test-entry-group_1443", * project: "1111111111111", * }); * const entry_type_basic = new gcp.dataplex.EntryType("entry-type-basic", { * entryTypeId: "tf-test-entry-type_8647", * location: "us-central1", * project: "1111111111111", * }); * const source = new gcp.dataplex.Entry("source", { * location: "us-central1", * entryGroupId: entry_group_basic.entryGroupId, * entryId: "tf-test-source-entry_26032", * entryType: entry_type_basic.name, * project: "1111111111111", * }); * const target = new gcp.dataplex.Entry("target", { * location: "us-central1", * entryGroupId: entry_group_basic.entryGroupId, * entryId: "tf-test-target-entry_50610", * entryType: entry_type_basic.name, * project: "1111111111111", * }); * const basicEntryLink = new gcp.dataplex.EntryLink("basic_entry_link", { * project: "1111111111111", * location: "us-central1", * entryGroupId: entry_group_basic.entryGroupId, * entryLinkId: "tf-test-entry-link_77124", * entryLinkType: "projects/655216118709/locations/global/entryLinkTypes/related", * entryReferences: [ * { * name: source.name, * }, * { * name: target.name, * }, * ], * }); * ``` * ### Dataplex Entry Link Full * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * import * as time from "@pulumiverse/time"; * * const entry_group_full = new gcp.dataplex.EntryGroup("entry-group-full", { * location: "us-central1", * entryGroupId: "tf-test-entry-group_15335", * project: "1111111111111", * }); * const entry_type_full = new gcp.dataplex.EntryType("entry-type-full", { * entryTypeId: "tf-test-entry-type_85160", * location: "us-central1", * project: "1111111111111", * }); * const source = new gcp.dataplex.Entry("source", { * location: "us-central1", * entryGroupId: entry_group_full.entryGroupId, * entryId: "tf-test-source-entry_20665", * entryType: entry_type_full.name, * project: "1111111111111", * }); * const termTestIdFull = new gcp.dataplex.Glossary("term_test_id_full", { * glossaryId: "tf-test-glossary_92130", * location: "us-central1", * }); * const termTestIdFullGlossaryTerm = new gcp.dataplex.GlossaryTerm("term_test_id_full", { * parent: pulumi.interpolate`projects/${termTestIdFull.project}/locations/us-central1/glossaries/${termTestIdFull.glossaryId}`, * glossaryId: termTestIdFull.glossaryId, * location: "us-central1", * termId: "tf-test-term-full_16199", * labels: { * tag: "test-tf", * }, * displayName: "terraform term", * description: "term created by Terraform", * }); * // Introduce a 45-second wait after the glossary resource creation * const wait_for_sync = new time.Sleep("wait-for-sync", {createDuration: "45s"}, { * dependsOn: [termTestIdFullGlossaryTerm], * }); * const fullEntryLink = new gcp.dataplex.EntryLink("full_entry_link", { * project: "1111111111111", * location: "us-central1", * entryGroupId: entry_group_full.entryGroupId, * entryLinkId: "tf-test-entry-link_21563", * entryLinkType: "projects/655216118709/locations/global/entryLinkTypes/definition", * entryReferences: [ * { * name: source.name, * type: "SOURCE", * path: "", * }, * { * name: pulumi.all([entry_group_full.project, entry_group_full.project, termTestIdFull.glossaryId, termTestIdFullGlossaryTerm.termId]).apply(([entry-group-fullProject, entry-group-fullProject1, glossaryId, termId]) => `projects/${entry_group_fullProject}/locations/us-central1/entryGroups/@dataplex/entries/projects/${entry_group_fullProject1}/locations/us-central1/glossaries/${glossaryId}/terms/${termId}`), * type: "TARGET", * }, * ], * }, { * dependsOn: [wait_for_sync], * }); * ``` * ## Import * * EntryLink can be imported using any of these accepted formats: * * * `projects/{{project}}/locations/{{location}}/entryGroups/{{entry_group_id}}/entryLinks/{{entry_link_id}}` * * `{{project}}/{{location}}/{{entry_group_id}}/{{entry_link_id}}` * * `{{location}}/{{entry_group_id}}/{{entry_link_id}}` * * When using the `pulumi import` command, EntryLink can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:dataplex/entryLink:EntryLink default projects/{{project}}/locations/{{location}}/entryGroups/{{entry_group_id}}/entryLinks/{{entry_link_id}} * $ pulumi import gcp:dataplex/entryLink:EntryLink default {{project}}/{{location}}/{{entry_group_id}}/{{entry_link_id}} * $ pulumi import gcp:dataplex/entryLink:EntryLink default {{location}}/{{entry_group_id}}/{{entry_link_id}} * ``` */ export declare class EntryLink extends pulumi.CustomResource { /** * Get an existing EntryLink 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?: EntryLinkState, opts?: pulumi.CustomResourceOptions): EntryLink; /** * Returns true if the given object is an instance of EntryLink. 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 EntryLink; /** * The Aspects attached to the Entry Link. * Structure is documented below. */ readonly aspects: pulumi.Output<outputs.dataplex.EntryLinkAspect[] | undefined>; /** * The time when the Entry Link was created. */ 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>; /** * The id of the entry group this entry link is in. */ readonly entryGroupId: pulumi.Output<string>; /** * The id of the entry link to create. */ readonly entryLinkId: pulumi.Output<string>; /** * Relative resource name of the Entry Link Type used to create this Entry Link. For example: * projects/dataplex-types/locations/global/entryLinkTypes/definition */ readonly entryLinkType: pulumi.Output<string>; /** * Specifies the Entries referenced in the Entry Link. There should be exactly two entry references. * Structure is documented below. */ readonly entryReferences: pulumi.Output<outputs.dataplex.EntryLinkEntryReference[]>; /** * The location for the entry. */ readonly location: pulumi.Output<string>; /** * The relative resource name of the Entry Link, of the form: * projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id} */ 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 time when the Entry Link was last updated. */ readonly updateTime: pulumi.Output<string>; /** * Create a EntryLink 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: EntryLinkArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering EntryLink resources. */ export interface EntryLinkState { /** * The Aspects attached to the Entry Link. * Structure is documented below. */ aspects?: pulumi.Input<pulumi.Input<inputs.dataplex.EntryLinkAspect>[] | undefined>; /** * The time when the Entry Link was created. */ 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>; /** * The id of the entry group this entry link is in. */ entryGroupId?: pulumi.Input<string | undefined>; /** * The id of the entry link to create. */ entryLinkId?: pulumi.Input<string | undefined>; /** * Relative resource name of the Entry Link Type used to create this Entry Link. For example: * projects/dataplex-types/locations/global/entryLinkTypes/definition */ entryLinkType?: pulumi.Input<string | undefined>; /** * Specifies the Entries referenced in the Entry Link. There should be exactly two entry references. * Structure is documented below. */ entryReferences?: pulumi.Input<pulumi.Input<inputs.dataplex.EntryLinkEntryReference>[] | undefined>; /** * The location for the entry. */ location?: pulumi.Input<string | undefined>; /** * The relative resource name of the Entry Link, of the form: * projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id} */ 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 time when the Entry Link was last updated. */ updateTime?: pulumi.Input<string | undefined>; } /** * The set of arguments for constructing a EntryLink resource. */ export interface EntryLinkArgs { /** * The Aspects attached to the Entry Link. * Structure is documented below. */ aspects?: pulumi.Input<pulumi.Input<inputs.dataplex.EntryLinkAspect>[] | 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>; /** * The id of the entry group this entry link is in. */ entryGroupId: pulumi.Input<string>; /** * The id of the entry link to create. */ entryLinkId: pulumi.Input<string>; /** * Relative resource name of the Entry Link Type used to create this Entry Link. For example: * projects/dataplex-types/locations/global/entryLinkTypes/definition */ entryLinkType: pulumi.Input<string>; /** * Specifies the Entries referenced in the Entry Link. There should be exactly two entry references. * Structure is documented below. */ entryReferences: pulumi.Input<pulumi.Input<inputs.dataplex.EntryLinkEntryReference>[]>; /** * The location for the entry. */ location: pulumi.Input<string>; /** * 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>; } //# sourceMappingURL=entryLink.d.ts.map