1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. dataplex
  5. AspectType
Google Cloud Classic v7.27.0 published on Thursday, Jun 13, 2024 by Pulumi

gcp.dataplex.AspectType

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.27.0 published on Thursday, Jun 13, 2024 by Pulumi

    An Aspect Type is a template for creating Aspects.

    Example Usage

    Dataplex Aspect Type Basic

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const testAspectTypeBasic = new gcp.dataplex.AspectType("test_aspect_type_basic", {
        aspectTypeId: "aspect-type-basic",
        project: "my-project-name",
        location: "us-central1",
        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
            }
          ]
        }
      ]
    }
    `,
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    test_aspect_type_basic = gcp.dataplex.AspectType("test_aspect_type_basic",
        aspect_type_id="aspect-type-basic",
        project="my-project-name",
        location="us-central1",
        metadata_template="""{
      "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
            }
          ]
        }
      ]
    }
    """)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/dataplex"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := dataplex.NewAspectType(ctx, "test_aspect_type_basic", &dataplex.AspectTypeArgs{
    			AspectTypeId: pulumi.String("aspect-type-basic"),
    			Project:      pulumi.String("my-project-name"),
    			Location:     pulumi.String("us-central1"),
    			MetadataTemplate: pulumi.String(`{
      "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
            }
          ]
        }
      ]
    }
    `),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    
    return await Deployment.RunAsync(() => 
    {
        var testAspectTypeBasic = new Gcp.DataPlex.AspectType("test_aspect_type_basic", new()
        {
            AspectTypeId = "aspect-type-basic",
            Project = "my-project-name",
            Location = "us-central1",
            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
            }
          ]
        }
      ]
    }
    ",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.dataplex.AspectType;
    import com.pulumi.gcp.dataplex.AspectTypeArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var testAspectTypeBasic = new AspectType("testAspectTypeBasic", AspectTypeArgs.builder()
                .aspectTypeId("aspect-type-basic")
                .project("my-project-name")
                .location("us-central1")
                .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
            }
          ]
        }
      ]
    }
                """)
                .build());
    
        }
    }
    
    resources:
      testAspectTypeBasic:
        type: gcp:dataplex:AspectType
        name: test_aspect_type_basic
        properties:
          aspectTypeId: aspect-type-basic
          project: my-project-name
          location: us-central1
          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
                    }
                  ]
                }
              ]
            }        
    

    Dataplex Aspect Type Full

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const testAspectTypeFull = new gcp.dataplex.AspectType("test_aspect_type_full", {
        aspectTypeId: "aspect-type-full",
        project: "my-project-name",
        location: "us-central1",
        labels: {
            tag: "test-tf",
        },
        displayName: "terraform aspect type",
        description: "aspect type created by Terraform",
        metadataTemplate: `{
      "type": "record",
      "name": "Schema",
      "recordFields": [
        {
          "name": "fields",
          "type": "array",
          "index": 1,
          "arrayItems": {
            "name": "field",
            "type": "record",
            "typeId": "field",
            "recordFields": [
              {
                "name": "name",
                "type": "string",
                "index": 1,
                "constraints": {
                  "required": true
                }
              },
              {
                "name": "description",
                "type": "string",
                "index": 2
              },
              {
                "name": "dataType",
                "type": "string",
                "index": 3,
                "constraints": {
                  "required": true
                }
              },
              {
                "name": "metadataType",
                "type": "enum",
                "index": 4,
                "constraints": {
                  "required": true
                },
                "enumValues": [
                  {
                    "name": "BOOLEAN",
                    "index": 1
                  },
                  {
                    "name": "NUMBER",
                    "index": 2
                  },
                  {
                    "name": "STRING",
                    "index": 3
                  },
                  {
                    "name": "BYTES",
                    "index": 4
                  },
                  {
                    "name": "DATETIME",
                    "index": 5
                  },
                  {
                    "name": "TIMESTAMP",
                    "index": 6
                  },
                  {
                    "name": "GEOSPATIAL",
                    "index": 7
                  },
                  {
                    "name": "STRUCT",
                    "index": 8
                  },
                  {
                    "name": "OTHER",
                    "index": 100
                  }
                ]
              },
              {
                "name": "mode",
                "type": "enum",
                "index": 5,
                "enumValues": [
                  {
                    "name": "NULLABLE",
                    "index": 1
                  },
                  {
                    "name": "REPEATED",
                    "index": 2
                  },
                  {
                    "name": "REQUIRED",
                    "index": 3
                  }
                ]
              },
              {
                "name": "defaultValue",
                "type": "string",
                "index": 6
              },
              {
                "name": "annotations",
                "type": "map",
                "index": 7,
                "mapItems": {
                  "name": "label",
                  "type": "string"
                }
              },
              {
                "name": "fields",
                "type": "array",
                "index": 20,
                "arrayItems": {
                  "name": "field",
                  "type": "record",
                  "typeRef": "field"
                }
              }
            ]
          }
        }
      ]
    }
    `,
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    test_aspect_type_full = gcp.dataplex.AspectType("test_aspect_type_full",
        aspect_type_id="aspect-type-full",
        project="my-project-name",
        location="us-central1",
        labels={
            "tag": "test-tf",
        },
        display_name="terraform aspect type",
        description="aspect type created by Terraform",
        metadata_template="""{
      "type": "record",
      "name": "Schema",
      "recordFields": [
        {
          "name": "fields",
          "type": "array",
          "index": 1,
          "arrayItems": {
            "name": "field",
            "type": "record",
            "typeId": "field",
            "recordFields": [
              {
                "name": "name",
                "type": "string",
                "index": 1,
                "constraints": {
                  "required": true
                }
              },
              {
                "name": "description",
                "type": "string",
                "index": 2
              },
              {
                "name": "dataType",
                "type": "string",
                "index": 3,
                "constraints": {
                  "required": true
                }
              },
              {
                "name": "metadataType",
                "type": "enum",
                "index": 4,
                "constraints": {
                  "required": true
                },
                "enumValues": [
                  {
                    "name": "BOOLEAN",
                    "index": 1
                  },
                  {
                    "name": "NUMBER",
                    "index": 2
                  },
                  {
                    "name": "STRING",
                    "index": 3
                  },
                  {
                    "name": "BYTES",
                    "index": 4
                  },
                  {
                    "name": "DATETIME",
                    "index": 5
                  },
                  {
                    "name": "TIMESTAMP",
                    "index": 6
                  },
                  {
                    "name": "GEOSPATIAL",
                    "index": 7
                  },
                  {
                    "name": "STRUCT",
                    "index": 8
                  },
                  {
                    "name": "OTHER",
                    "index": 100
                  }
                ]
              },
              {
                "name": "mode",
                "type": "enum",
                "index": 5,
                "enumValues": [
                  {
                    "name": "NULLABLE",
                    "index": 1
                  },
                  {
                    "name": "REPEATED",
                    "index": 2
                  },
                  {
                    "name": "REQUIRED",
                    "index": 3
                  }
                ]
              },
              {
                "name": "defaultValue",
                "type": "string",
                "index": 6
              },
              {
                "name": "annotations",
                "type": "map",
                "index": 7,
                "mapItems": {
                  "name": "label",
                  "type": "string"
                }
              },
              {
                "name": "fields",
                "type": "array",
                "index": 20,
                "arrayItems": {
                  "name": "field",
                  "type": "record",
                  "typeRef": "field"
                }
              }
            ]
          }
        }
      ]
    }
    """)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/dataplex"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := dataplex.NewAspectType(ctx, "test_aspect_type_full", &dataplex.AspectTypeArgs{
    			AspectTypeId: pulumi.String("aspect-type-full"),
    			Project:      pulumi.String("my-project-name"),
    			Location:     pulumi.String("us-central1"),
    			Labels: pulumi.StringMap{
    				"tag": pulumi.String("test-tf"),
    			},
    			DisplayName: pulumi.String("terraform aspect type"),
    			Description: pulumi.String("aspect type created by Terraform"),
    			MetadataTemplate: pulumi.String(`{
      "type": "record",
      "name": "Schema",
      "recordFields": [
        {
          "name": "fields",
          "type": "array",
          "index": 1,
          "arrayItems": {
            "name": "field",
            "type": "record",
            "typeId": "field",
            "recordFields": [
              {
                "name": "name",
                "type": "string",
                "index": 1,
                "constraints": {
                  "required": true
                }
              },
              {
                "name": "description",
                "type": "string",
                "index": 2
              },
              {
                "name": "dataType",
                "type": "string",
                "index": 3,
                "constraints": {
                  "required": true
                }
              },
              {
                "name": "metadataType",
                "type": "enum",
                "index": 4,
                "constraints": {
                  "required": true
                },
                "enumValues": [
                  {
                    "name": "BOOLEAN",
                    "index": 1
                  },
                  {
                    "name": "NUMBER",
                    "index": 2
                  },
                  {
                    "name": "STRING",
                    "index": 3
                  },
                  {
                    "name": "BYTES",
                    "index": 4
                  },
                  {
                    "name": "DATETIME",
                    "index": 5
                  },
                  {
                    "name": "TIMESTAMP",
                    "index": 6
                  },
                  {
                    "name": "GEOSPATIAL",
                    "index": 7
                  },
                  {
                    "name": "STRUCT",
                    "index": 8
                  },
                  {
                    "name": "OTHER",
                    "index": 100
                  }
                ]
              },
              {
                "name": "mode",
                "type": "enum",
                "index": 5,
                "enumValues": [
                  {
                    "name": "NULLABLE",
                    "index": 1
                  },
                  {
                    "name": "REPEATED",
                    "index": 2
                  },
                  {
                    "name": "REQUIRED",
                    "index": 3
                  }
                ]
              },
              {
                "name": "defaultValue",
                "type": "string",
                "index": 6
              },
              {
                "name": "annotations",
                "type": "map",
                "index": 7,
                "mapItems": {
                  "name": "label",
                  "type": "string"
                }
              },
              {
                "name": "fields",
                "type": "array",
                "index": 20,
                "arrayItems": {
                  "name": "field",
                  "type": "record",
                  "typeRef": "field"
                }
              }
            ]
          }
        }
      ]
    }
    `),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    
    return await Deployment.RunAsync(() => 
    {
        var testAspectTypeFull = new Gcp.DataPlex.AspectType("test_aspect_type_full", new()
        {
            AspectTypeId = "aspect-type-full",
            Project = "my-project-name",
            Location = "us-central1",
            Labels = 
            {
                { "tag", "test-tf" },
            },
            DisplayName = "terraform aspect type",
            Description = "aspect type created by Terraform",
            MetadataTemplate = @"{
      ""type"": ""record"",
      ""name"": ""Schema"",
      ""recordFields"": [
        {
          ""name"": ""fields"",
          ""type"": ""array"",
          ""index"": 1,
          ""arrayItems"": {
            ""name"": ""field"",
            ""type"": ""record"",
            ""typeId"": ""field"",
            ""recordFields"": [
              {
                ""name"": ""name"",
                ""type"": ""string"",
                ""index"": 1,
                ""constraints"": {
                  ""required"": true
                }
              },
              {
                ""name"": ""description"",
                ""type"": ""string"",
                ""index"": 2
              },
              {
                ""name"": ""dataType"",
                ""type"": ""string"",
                ""index"": 3,
                ""constraints"": {
                  ""required"": true
                }
              },
              {
                ""name"": ""metadataType"",
                ""type"": ""enum"",
                ""index"": 4,
                ""constraints"": {
                  ""required"": true
                },
                ""enumValues"": [
                  {
                    ""name"": ""BOOLEAN"",
                    ""index"": 1
                  },
                  {
                    ""name"": ""NUMBER"",
                    ""index"": 2
                  },
                  {
                    ""name"": ""STRING"",
                    ""index"": 3
                  },
                  {
                    ""name"": ""BYTES"",
                    ""index"": 4
                  },
                  {
                    ""name"": ""DATETIME"",
                    ""index"": 5
                  },
                  {
                    ""name"": ""TIMESTAMP"",
                    ""index"": 6
                  },
                  {
                    ""name"": ""GEOSPATIAL"",
                    ""index"": 7
                  },
                  {
                    ""name"": ""STRUCT"",
                    ""index"": 8
                  },
                  {
                    ""name"": ""OTHER"",
                    ""index"": 100
                  }
                ]
              },
              {
                ""name"": ""mode"",
                ""type"": ""enum"",
                ""index"": 5,
                ""enumValues"": [
                  {
                    ""name"": ""NULLABLE"",
                    ""index"": 1
                  },
                  {
                    ""name"": ""REPEATED"",
                    ""index"": 2
                  },
                  {
                    ""name"": ""REQUIRED"",
                    ""index"": 3
                  }
                ]
              },
              {
                ""name"": ""defaultValue"",
                ""type"": ""string"",
                ""index"": 6
              },
              {
                ""name"": ""annotations"",
                ""type"": ""map"",
                ""index"": 7,
                ""mapItems"": {
                  ""name"": ""label"",
                  ""type"": ""string""
                }
              },
              {
                ""name"": ""fields"",
                ""type"": ""array"",
                ""index"": 20,
                ""arrayItems"": {
                  ""name"": ""field"",
                  ""type"": ""record"",
                  ""typeRef"": ""field""
                }
              }
            ]
          }
        }
      ]
    }
    ",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.dataplex.AspectType;
    import com.pulumi.gcp.dataplex.AspectTypeArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var testAspectTypeFull = new AspectType("testAspectTypeFull", AspectTypeArgs.builder()
                .aspectTypeId("aspect-type-full")
                .project("my-project-name")
                .location("us-central1")
                .labels(Map.of("tag", "test-tf"))
                .displayName("terraform aspect type")
                .description("aspect type created by Terraform")
                .metadataTemplate("""
    {
      "type": "record",
      "name": "Schema",
      "recordFields": [
        {
          "name": "fields",
          "type": "array",
          "index": 1,
          "arrayItems": {
            "name": "field",
            "type": "record",
            "typeId": "field",
            "recordFields": [
              {
                "name": "name",
                "type": "string",
                "index": 1,
                "constraints": {
                  "required": true
                }
              },
              {
                "name": "description",
                "type": "string",
                "index": 2
              },
              {
                "name": "dataType",
                "type": "string",
                "index": 3,
                "constraints": {
                  "required": true
                }
              },
              {
                "name": "metadataType",
                "type": "enum",
                "index": 4,
                "constraints": {
                  "required": true
                },
                "enumValues": [
                  {
                    "name": "BOOLEAN",
                    "index": 1
                  },
                  {
                    "name": "NUMBER",
                    "index": 2
                  },
                  {
                    "name": "STRING",
                    "index": 3
                  },
                  {
                    "name": "BYTES",
                    "index": 4
                  },
                  {
                    "name": "DATETIME",
                    "index": 5
                  },
                  {
                    "name": "TIMESTAMP",
                    "index": 6
                  },
                  {
                    "name": "GEOSPATIAL",
                    "index": 7
                  },
                  {
                    "name": "STRUCT",
                    "index": 8
                  },
                  {
                    "name": "OTHER",
                    "index": 100
                  }
                ]
              },
              {
                "name": "mode",
                "type": "enum",
                "index": 5,
                "enumValues": [
                  {
                    "name": "NULLABLE",
                    "index": 1
                  },
                  {
                    "name": "REPEATED",
                    "index": 2
                  },
                  {
                    "name": "REQUIRED",
                    "index": 3
                  }
                ]
              },
              {
                "name": "defaultValue",
                "type": "string",
                "index": 6
              },
              {
                "name": "annotations",
                "type": "map",
                "index": 7,
                "mapItems": {
                  "name": "label",
                  "type": "string"
                }
              },
              {
                "name": "fields",
                "type": "array",
                "index": 20,
                "arrayItems": {
                  "name": "field",
                  "type": "record",
                  "typeRef": "field"
                }
              }
            ]
          }
        }
      ]
    }
                """)
                .build());
    
        }
    }
    
    resources:
      testAspectTypeFull:
        type: gcp:dataplex:AspectType
        name: test_aspect_type_full
        properties:
          aspectTypeId: aspect-type-full
          project: my-project-name
          location: us-central1
          labels:
            tag: test-tf
          displayName: terraform aspect type
          description: aspect type created by Terraform
          metadataTemplate: |
            {
              "type": "record",
              "name": "Schema",
              "recordFields": [
                {
                  "name": "fields",
                  "type": "array",
                  "index": 1,
                  "arrayItems": {
                    "name": "field",
                    "type": "record",
                    "typeId": "field",
                    "recordFields": [
                      {
                        "name": "name",
                        "type": "string",
                        "index": 1,
                        "constraints": {
                          "required": true
                        }
                      },
                      {
                        "name": "description",
                        "type": "string",
                        "index": 2
                      },
                      {
                        "name": "dataType",
                        "type": "string",
                        "index": 3,
                        "constraints": {
                          "required": true
                        }
                      },
                      {
                        "name": "metadataType",
                        "type": "enum",
                        "index": 4,
                        "constraints": {
                          "required": true
                        },
                        "enumValues": [
                          {
                            "name": "BOOLEAN",
                            "index": 1
                          },
                          {
                            "name": "NUMBER",
                            "index": 2
                          },
                          {
                            "name": "STRING",
                            "index": 3
                          },
                          {
                            "name": "BYTES",
                            "index": 4
                          },
                          {
                            "name": "DATETIME",
                            "index": 5
                          },
                          {
                            "name": "TIMESTAMP",
                            "index": 6
                          },
                          {
                            "name": "GEOSPATIAL",
                            "index": 7
                          },
                          {
                            "name": "STRUCT",
                            "index": 8
                          },
                          {
                            "name": "OTHER",
                            "index": 100
                          }
                        ]
                      },
                      {
                        "name": "mode",
                        "type": "enum",
                        "index": 5,
                        "enumValues": [
                          {
                            "name": "NULLABLE",
                            "index": 1
                          },
                          {
                            "name": "REPEATED",
                            "index": 2
                          },
                          {
                            "name": "REQUIRED",
                            "index": 3
                          }
                        ]
                      },
                      {
                        "name": "defaultValue",
                        "type": "string",
                        "index": 6
                      },
                      {
                        "name": "annotations",
                        "type": "map",
                        "index": 7,
                        "mapItems": {
                          "name": "label",
                          "type": "string"
                        }
                      },
                      {
                        "name": "fields",
                        "type": "array",
                        "index": 20,
                        "arrayItems": {
                          "name": "field",
                          "type": "record",
                          "typeRef": "field"
                        }
                      }
                    ]
                  }
                }
              ]
            }        
    

    Create AspectType Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new AspectType(name: string, args?: AspectTypeArgs, opts?: CustomResourceOptions);
    @overload
    def AspectType(resource_name: str,
                   args: Optional[AspectTypeArgs] = None,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def AspectType(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   aspect_type_id: Optional[str] = None,
                   description: Optional[str] = None,
                   display_name: Optional[str] = None,
                   labels: Optional[Mapping[str, str]] = None,
                   location: Optional[str] = None,
                   metadata_template: Optional[str] = None,
                   project: Optional[str] = None)
    func NewAspectType(ctx *Context, name string, args *AspectTypeArgs, opts ...ResourceOption) (*AspectType, error)
    public AspectType(string name, AspectTypeArgs? args = null, CustomResourceOptions? opts = null)
    public AspectType(String name, AspectTypeArgs args)
    public AspectType(String name, AspectTypeArgs args, CustomResourceOptions options)
    
    type: gcp:dataplex:AspectType
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args AspectTypeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AspectTypeArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AspectTypeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AspectTypeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AspectTypeArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var aspectTypeResource = new Gcp.DataPlex.AspectType("aspectTypeResource", new()
    {
        AspectTypeId = "string",
        Description = "string",
        DisplayName = "string",
        Labels = 
        {
            { "string", "string" },
        },
        Location = "string",
        MetadataTemplate = "string",
        Project = "string",
    });
    
    example, err := dataplex.NewAspectType(ctx, "aspectTypeResource", &dataplex.AspectTypeArgs{
    	AspectTypeId: pulumi.String("string"),
    	Description:  pulumi.String("string"),
    	DisplayName:  pulumi.String("string"),
    	Labels: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Location:         pulumi.String("string"),
    	MetadataTemplate: pulumi.String("string"),
    	Project:          pulumi.String("string"),
    })
    
    var aspectTypeResource = new AspectType("aspectTypeResource", AspectTypeArgs.builder()
        .aspectTypeId("string")
        .description("string")
        .displayName("string")
        .labels(Map.of("string", "string"))
        .location("string")
        .metadataTemplate("string")
        .project("string")
        .build());
    
    aspect_type_resource = gcp.dataplex.AspectType("aspectTypeResource",
        aspect_type_id="string",
        description="string",
        display_name="string",
        labels={
            "string": "string",
        },
        location="string",
        metadata_template="string",
        project="string")
    
    const aspectTypeResource = new gcp.dataplex.AspectType("aspectTypeResource", {
        aspectTypeId: "string",
        description: "string",
        displayName: "string",
        labels: {
            string: "string",
        },
        location: "string",
        metadataTemplate: "string",
        project: "string",
    });
    
    type: gcp:dataplex:AspectType
    properties:
        aspectTypeId: string
        description: string
        displayName: string
        labels:
            string: string
        location: string
        metadataTemplate: string
        project: string
    

    AspectType Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The AspectType resource accepts the following input properties:

    AspectTypeId string
    The aspect type id of the aspect type.
    Description string
    Description of the AspectType.
    DisplayName string
    User friendly display name.
    Labels Dictionary<string, string>

    User-defined labels for the AspectType.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    Location string
    The location where aspect type will be created in.
    MetadataTemplate string
    MetadataTemplate of the Aspect.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    AspectTypeId string
    The aspect type id of the aspect type.
    Description string
    Description of the AspectType.
    DisplayName string
    User friendly display name.
    Labels map[string]string

    User-defined labels for the AspectType.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    Location string
    The location where aspect type will be created in.
    MetadataTemplate string
    MetadataTemplate of the Aspect.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    aspectTypeId String
    The aspect type id of the aspect type.
    description String
    Description of the AspectType.
    displayName String
    User friendly display name.
    labels Map<String,String>

    User-defined labels for the AspectType.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    location String
    The location where aspect type will be created in.
    metadataTemplate String
    MetadataTemplate of the Aspect.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    aspectTypeId string
    The aspect type id of the aspect type.
    description string
    Description of the AspectType.
    displayName string
    User friendly display name.
    labels {[key: string]: string}

    User-defined labels for the AspectType.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    location string
    The location where aspect type will be created in.
    metadataTemplate string
    MetadataTemplate of the Aspect.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    aspect_type_id str
    The aspect type id of the aspect type.
    description str
    Description of the AspectType.
    display_name str
    User friendly display name.
    labels Mapping[str, str]

    User-defined labels for the AspectType.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    location str
    The location where aspect type will be created in.
    metadata_template str
    MetadataTemplate of the Aspect.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    aspectTypeId String
    The aspect type id of the aspect type.
    description String
    Description of the AspectType.
    displayName String
    User friendly display name.
    labels Map<String>

    User-defined labels for the AspectType.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    location String
    The location where aspect type will be created in.
    metadataTemplate String
    MetadataTemplate of the Aspect.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AspectType resource produces the following output properties:

    CreateTime string
    The time when the AspectType was created.
    EffectiveLabels Dictionary<string, string>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The relative resource name of the AspectType, of the form: projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}
    PulumiLabels Dictionary<string, string>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    TransferStatus string
    Denotes the transfer status of the Aspect Type. It is unspecified for Aspect Type created from Dataplex API.
    Uid string
    System generated globally unique ID for the AspectType. This ID will be different if the AspectType is deleted and re-created with the same name.
    UpdateTime string
    The time when the AspectType was last updated.
    CreateTime string
    The time when the AspectType was created.
    EffectiveLabels map[string]string
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The relative resource name of the AspectType, of the form: projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}
    PulumiLabels map[string]string
    The combination of labels configured directly on the resource and default labels configured on the provider.
    TransferStatus string
    Denotes the transfer status of the Aspect Type. It is unspecified for Aspect Type created from Dataplex API.
    Uid string
    System generated globally unique ID for the AspectType. This ID will be different if the AspectType is deleted and re-created with the same name.
    UpdateTime string
    The time when the AspectType was last updated.
    createTime String
    The time when the AspectType was created.
    effectiveLabels Map<String,String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The relative resource name of the AspectType, of the form: projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}
    pulumiLabels Map<String,String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    transferStatus String
    Denotes the transfer status of the Aspect Type. It is unspecified for Aspect Type created from Dataplex API.
    uid String
    System generated globally unique ID for the AspectType. This ID will be different if the AspectType is deleted and re-created with the same name.
    updateTime String
    The time when the AspectType was last updated.
    createTime string
    The time when the AspectType was created.
    effectiveLabels {[key: string]: string}
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The relative resource name of the AspectType, of the form: projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}
    pulumiLabels {[key: string]: string}
    The combination of labels configured directly on the resource and default labels configured on the provider.
    transferStatus string
    Denotes the transfer status of the Aspect Type. It is unspecified for Aspect Type created from Dataplex API.
    uid string
    System generated globally unique ID for the AspectType. This ID will be different if the AspectType is deleted and re-created with the same name.
    updateTime string
    The time when the AspectType was last updated.
    create_time str
    The time when the AspectType was created.
    effective_labels Mapping[str, str]
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The relative resource name of the AspectType, of the form: projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}
    pulumi_labels Mapping[str, str]
    The combination of labels configured directly on the resource and default labels configured on the provider.
    transfer_status str
    Denotes the transfer status of the Aspect Type. It is unspecified for Aspect Type created from Dataplex API.
    uid str
    System generated globally unique ID for the AspectType. This ID will be different if the AspectType is deleted and re-created with the same name.
    update_time str
    The time when the AspectType was last updated.
    createTime String
    The time when the AspectType was created.
    effectiveLabels Map<String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The relative resource name of the AspectType, of the form: projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}
    pulumiLabels Map<String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    transferStatus String
    Denotes the transfer status of the Aspect Type. It is unspecified for Aspect Type created from Dataplex API.
    uid String
    System generated globally unique ID for the AspectType. This ID will be different if the AspectType is deleted and re-created with the same name.
    updateTime String
    The time when the AspectType was last updated.

    Look up Existing AspectType Resource

    Get an existing AspectType resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: AspectTypeState, opts?: CustomResourceOptions): AspectType
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            aspect_type_id: Optional[str] = None,
            create_time: Optional[str] = None,
            description: Optional[str] = None,
            display_name: Optional[str] = None,
            effective_labels: Optional[Mapping[str, str]] = None,
            labels: Optional[Mapping[str, str]] = None,
            location: Optional[str] = None,
            metadata_template: Optional[str] = None,
            name: Optional[str] = None,
            project: Optional[str] = None,
            pulumi_labels: Optional[Mapping[str, str]] = None,
            transfer_status: Optional[str] = None,
            uid: Optional[str] = None,
            update_time: Optional[str] = None) -> AspectType
    func GetAspectType(ctx *Context, name string, id IDInput, state *AspectTypeState, opts ...ResourceOption) (*AspectType, error)
    public static AspectType Get(string name, Input<string> id, AspectTypeState? state, CustomResourceOptions? opts = null)
    public static AspectType get(String name, Output<String> id, AspectTypeState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AspectTypeId string
    The aspect type id of the aspect type.
    CreateTime string
    The time when the AspectType was created.
    Description string
    Description of the AspectType.
    DisplayName string
    User friendly display name.
    EffectiveLabels Dictionary<string, string>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    Labels Dictionary<string, string>

    User-defined labels for the AspectType.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    Location string
    The location where aspect type will be created in.
    MetadataTemplate string
    MetadataTemplate of the Aspect.
    Name string
    The relative resource name of the AspectType, of the form: projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    PulumiLabels Dictionary<string, string>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    TransferStatus string
    Denotes the transfer status of the Aspect Type. It is unspecified for Aspect Type created from Dataplex API.
    Uid string
    System generated globally unique ID for the AspectType. This ID will be different if the AspectType is deleted and re-created with the same name.
    UpdateTime string
    The time when the AspectType was last updated.
    AspectTypeId string
    The aspect type id of the aspect type.
    CreateTime string
    The time when the AspectType was created.
    Description string
    Description of the AspectType.
    DisplayName string
    User friendly display name.
    EffectiveLabels map[string]string
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    Labels map[string]string

    User-defined labels for the AspectType.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    Location string
    The location where aspect type will be created in.
    MetadataTemplate string
    MetadataTemplate of the Aspect.
    Name string
    The relative resource name of the AspectType, of the form: projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    PulumiLabels map[string]string
    The combination of labels configured directly on the resource and default labels configured on the provider.
    TransferStatus string
    Denotes the transfer status of the Aspect Type. It is unspecified for Aspect Type created from Dataplex API.
    Uid string
    System generated globally unique ID for the AspectType. This ID will be different if the AspectType is deleted and re-created with the same name.
    UpdateTime string
    The time when the AspectType was last updated.
    aspectTypeId String
    The aspect type id of the aspect type.
    createTime String
    The time when the AspectType was created.
    description String
    Description of the AspectType.
    displayName String
    User friendly display name.
    effectiveLabels Map<String,String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    labels Map<String,String>

    User-defined labels for the AspectType.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    location String
    The location where aspect type will be created in.
    metadataTemplate String
    MetadataTemplate of the Aspect.
    name String
    The relative resource name of the AspectType, of the form: projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumiLabels Map<String,String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    transferStatus String
    Denotes the transfer status of the Aspect Type. It is unspecified for Aspect Type created from Dataplex API.
    uid String
    System generated globally unique ID for the AspectType. This ID will be different if the AspectType is deleted and re-created with the same name.
    updateTime String
    The time when the AspectType was last updated.
    aspectTypeId string
    The aspect type id of the aspect type.
    createTime string
    The time when the AspectType was created.
    description string
    Description of the AspectType.
    displayName string
    User friendly display name.
    effectiveLabels {[key: string]: string}
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    labels {[key: string]: string}

    User-defined labels for the AspectType.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    location string
    The location where aspect type will be created in.
    metadataTemplate string
    MetadataTemplate of the Aspect.
    name string
    The relative resource name of the AspectType, of the form: projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumiLabels {[key: string]: string}
    The combination of labels configured directly on the resource and default labels configured on the provider.
    transferStatus string
    Denotes the transfer status of the Aspect Type. It is unspecified for Aspect Type created from Dataplex API.
    uid string
    System generated globally unique ID for the AspectType. This ID will be different if the AspectType is deleted and re-created with the same name.
    updateTime string
    The time when the AspectType was last updated.
    aspect_type_id str
    The aspect type id of the aspect type.
    create_time str
    The time when the AspectType was created.
    description str
    Description of the AspectType.
    display_name str
    User friendly display name.
    effective_labels Mapping[str, str]
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    labels Mapping[str, str]

    User-defined labels for the AspectType.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    location str
    The location where aspect type will be created in.
    metadata_template str
    MetadataTemplate of the Aspect.
    name str
    The relative resource name of the AspectType, of the form: projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumi_labels Mapping[str, str]
    The combination of labels configured directly on the resource and default labels configured on the provider.
    transfer_status str
    Denotes the transfer status of the Aspect Type. It is unspecified for Aspect Type created from Dataplex API.
    uid str
    System generated globally unique ID for the AspectType. This ID will be different if the AspectType is deleted and re-created with the same name.
    update_time str
    The time when the AspectType was last updated.
    aspectTypeId String
    The aspect type id of the aspect type.
    createTime String
    The time when the AspectType was created.
    description String
    Description of the AspectType.
    displayName String
    User friendly display name.
    effectiveLabels Map<String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    labels Map<String>

    User-defined labels for the AspectType.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    location String
    The location where aspect type will be created in.
    metadataTemplate String
    MetadataTemplate of the Aspect.
    name String
    The relative resource name of the AspectType, of the form: projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumiLabels Map<String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    transferStatus String
    Denotes the transfer status of the Aspect Type. It is unspecified for Aspect Type created from Dataplex API.
    uid String
    System generated globally unique ID for the AspectType. This ID will be different if the AspectType is deleted and re-created with the same name.
    updateTime String
    The time when the AspectType was last updated.

    Import

    AspectType can be imported using any of these accepted formats:

    • projects/{{project}}/locations/{{location}}/aspectTypes/{{aspect_type_id}}

    • {{project}}/{{location}}/{{aspect_type_id}}

    • {{location}}/{{aspect_type_id}}

    When using the pulumi import command, AspectType can be imported using one of the formats above. For example:

    $ pulumi import gcp:dataplex/aspectType:AspectType default projects/{{project}}/locations/{{location}}/aspectTypes/{{aspect_type_id}}
    
    $ pulumi import gcp:dataplex/aspectType:AspectType default {{project}}/{{location}}/{{aspect_type_id}}
    
    $ pulumi import gcp:dataplex/aspectType:AspectType default {{location}}/{{aspect_type_id}}
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud Classic v7.27.0 published on Thursday, Jun 13, 2024 by Pulumi