@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
355 lines • 13.1 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* An Entry Type is a template for creating Entries.
*
* ## Example Usage
*
* ### Dataplex Entry Type Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const testEntryTypeBasic = new gcp.dataplex.EntryType("test_entry_type_basic", {
* entryTypeId: "entry-type-basic",
* project: "my-project-name",
* location: "us-central1",
* });
* ```
* ### Dataplex Entry Type Full
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const testEntryTypeFull = new gcp.dataplex.AspectType("test_entry_type_full", {
* aspectTypeId: "tf-test-aspect-type_26317",
* location: "us-central1",
* project: "my-project-name",
* metadataTemplate: `{
* \\"name\\": \\"tf-test-template\\",
* \\"type\\": \\"record\\",
* \\"recordFields\\": [
* {
* \\"name\\": \\"type\\",
* \\"type\\": \\"enum\\",
* \\"annotations\\": {
* \\"displayName\\": \\"Type\\",
* \\"description\\": \\"Specifies the type of view represented by the entry.\\"
* },
* \\"index\\": 1,
* \\"constraints\\": {
* \\"required\\": true
* },
* \\"enumValues\\": [
* {
* \\"name\\": \\"VIEW\\",
* \\"index\\": 1
* }
* ]
* }
* ]
* }
* `,
* });
* const testEntryTypeFullEntryType = new gcp.dataplex.EntryType("test_entry_type_full", {
* entryTypeId: "entry-type-full",
* project: "my-project-name",
* location: "us-central1",
* labels: {
* tag: "test-tf",
* },
* displayName: "terraform entry type",
* description: "entry type created by Terraform",
* typeAliases: [
* "TABLE",
* "DATABASE",
* ],
* platform: "GCS",
* system: "CloudSQL",
* requiredAspects: [{
* type: testEntryTypeFull.name,
* }],
* });
* ```
*
* ## Import
*
* EntryType can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/entryTypes/{{entry_type_id}}`
* * `{{project}}/{{location}}/{{entry_type_id}}`
* * `{{location}}/{{entry_type_id}}`
*
* When using the `pulumi import` command, EntryType can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:dataplex/entryType:EntryType default projects/{{project}}/locations/{{location}}/entryTypes/{{entry_type_id}}
* $ pulumi import gcp:dataplex/entryType:EntryType default {{project}}/{{location}}/{{entry_type_id}}
* $ pulumi import gcp:dataplex/entryType:EntryType default {{location}}/{{entry_type_id}}
* ```
*/
export declare class EntryType extends pulumi.CustomResource {
/**
* Get an existing EntryType 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?: EntryTypeState, opts?: pulumi.CustomResourceOptions): EntryType;
/**
* Returns true if the given object is an instance of EntryType. 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 EntryType;
/**
* The time when the EntryType 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>;
/**
* Description of the EntryType.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* User friendly display name.
*/
readonly displayName: 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;
}>;
/**
* The entry type id of the entry type.
*/
readonly entryTypeId: pulumi.Output<string | undefined>;
/**
* User-defined labels for the EntryType.
*
* **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>;
/**
* The location where entry type will be created in.
*/
readonly location: pulumi.Output<string | undefined>;
/**
* The relative resource name of the EntryType, of the form: projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}
*/
readonly name: pulumi.Output<string>;
/**
* The platform that Entries of this type belongs to.
*/
readonly platform: pulumi.Output<string | undefined>;
/**
* 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;
}>;
/**
* AspectInfo for the entry type.
* Structure is documented below.
*/
readonly requiredAspects: pulumi.Output<outputs.dataplex.EntryTypeRequiredAspect[] | undefined>;
/**
* The system that Entries of this type belongs to.
*/
readonly system: pulumi.Output<string | undefined>;
/**
* Indicates the class this Entry Type belongs to, for example, TABLE, DATABASE, MODEL.
*/
readonly typeAliases: pulumi.Output<string[] | undefined>;
/**
* System generated globally unique ID for the EntryType. This ID will be different if the EntryType is deleted and re-created with the same name.
*/
readonly uid: pulumi.Output<string>;
/**
* The time when the EntryType was last updated.
*/
readonly updateTime: pulumi.Output<string>;
/**
* Create a EntryType 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?: EntryTypeArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering EntryType resources.
*/
export interface EntryTypeState {
/**
* The time when the EntryType 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>;
/**
* Description of the EntryType.
*/
description?: pulumi.Input<string | undefined>;
/**
* User friendly display name.
*/
displayName?: 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>;
/**
* The entry type id of the entry type.
*/
entryTypeId?: pulumi.Input<string | undefined>;
/**
* User-defined labels for the EntryType.
*
* **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>;
/**
* The location where entry type will be created in.
*/
location?: pulumi.Input<string | undefined>;
/**
* The relative resource name of the EntryType, of the form: projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}
*/
name?: pulumi.Input<string | undefined>;
/**
* The platform that Entries of this type belongs to.
*/
platform?: 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>;
/**
* AspectInfo for the entry type.
* Structure is documented below.
*/
requiredAspects?: pulumi.Input<pulumi.Input<inputs.dataplex.EntryTypeRequiredAspect>[] | undefined>;
/**
* The system that Entries of this type belongs to.
*/
system?: pulumi.Input<string | undefined>;
/**
* Indicates the class this Entry Type belongs to, for example, TABLE, DATABASE, MODEL.
*/
typeAliases?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* System generated globally unique ID for the EntryType. This ID will be different if the EntryType is deleted and re-created with the same name.
*/
uid?: pulumi.Input<string | undefined>;
/**
* The time when the EntryType was last updated.
*/
updateTime?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a EntryType resource.
*/
export interface EntryTypeArgs {
/**
* 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 EntryType.
*/
description?: pulumi.Input<string | undefined>;
/**
* User friendly display name.
*/
displayName?: pulumi.Input<string | undefined>;
/**
* The entry type id of the entry type.
*/
entryTypeId?: pulumi.Input<string | undefined>;
/**
* User-defined labels for the EntryType.
*
* **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>;
/**
* The location where entry type will be created in.
*/
location?: pulumi.Input<string | undefined>;
/**
* The platform that Entries of this type belongs to.
*/
platform?: 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>;
/**
* AspectInfo for the entry type.
* Structure is documented below.
*/
requiredAspects?: pulumi.Input<pulumi.Input<inputs.dataplex.EntryTypeRequiredAspect>[] | undefined>;
/**
* The system that Entries of this type belongs to.
*/
system?: pulumi.Input<string | undefined>;
/**
* Indicates the class this Entry Type belongs to, for example, TABLE, DATABASE, MODEL.
*/
typeAliases?: pulumi.Input<pulumi.Input<string>[] | undefined>;
}
//# sourceMappingURL=entryType.d.ts.map