Google Cloud (GCP) Classic

Pulumi Official
Package maintained by Pulumi
v6.24.0 published on Tuesday, May 17, 2022 by Pulumi

AiDataset

A collection of DataItems and Annotations on them.

To get more information about Dataset, see:

Example Usage

Vertex Ai Dataset

using Pulumi;
using Gcp = Pulumi.Gcp;

class MyStack : Stack
{
    public MyStack()
    {
        var dataset = new Gcp.Vertex.AiDataset("dataset", new Gcp.Vertex.AiDatasetArgs
        {
            DisplayName = "terraform",
            MetadataSchemaUri = "gs://google-cloud-aiplatform/schema/dataset/metadata/image_1.0.0.yaml",
            Region = "us-central1",
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/vertex"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vertex.NewAiDataset(ctx, "dataset", &vertex.AiDatasetArgs{
			DisplayName:       pulumi.String("terraform"),
			MetadataSchemaUri: pulumi.String("gs://google-cloud-aiplatform/schema/dataset/metadata/image_1.0.0.yaml"),
			Region:            pulumi.String("us-central1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var dataset = new AiDataset("dataset", AiDatasetArgs.builder()        
            .displayName("terraform")
            .metadataSchemaUri("gs://google-cloud-aiplatform/schema/dataset/metadata/image_1.0.0.yaml")
            .region("us-central1")
            .build());

        }
}
import pulumi
import pulumi_gcp as gcp

dataset = gcp.vertex.AiDataset("dataset",
    display_name="terraform",
    metadata_schema_uri="gs://google-cloud-aiplatform/schema/dataset/metadata/image_1.0.0.yaml",
    region="us-central1")
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const dataset = new gcp.vertex.AiDataset("dataset", {
    displayName: "terraform",
    metadataSchemaUri: "gs://google-cloud-aiplatform/schema/dataset/metadata/image_1.0.0.yaml",
    region: "us-central1",
});
resources:
  dataset:
    type: gcp:vertex:AiDataset
    properties:
      displayName: terraform
      metadataSchemaUri: gs://google-cloud-aiplatform/schema/dataset/metadata/image_1.0.0.yaml
      region: us-central1

Create a AiDataset Resource

new AiDataset(name: string, args: AiDatasetArgs, opts?: CustomResourceOptions);
@overload
def AiDataset(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              display_name: Optional[str] = None,
              encryption_spec: Optional[AiDatasetEncryptionSpecArgs] = None,
              labels: Optional[Mapping[str, str]] = None,
              metadata_schema_uri: Optional[str] = None,
              project: Optional[str] = None,
              region: Optional[str] = None)
@overload
def AiDataset(resource_name: str,
              args: AiDatasetArgs,
              opts: Optional[ResourceOptions] = None)
func NewAiDataset(ctx *Context, name string, args AiDatasetArgs, opts ...ResourceOption) (*AiDataset, error)
public AiDataset(string name, AiDatasetArgs args, CustomResourceOptions? opts = null)
public AiDataset(String name, AiDatasetArgs args)
public AiDataset(String name, AiDatasetArgs args, CustomResourceOptions options)
type: gcp:vertex:AiDataset
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args AiDatasetArgs
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 AiDatasetArgs
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 AiDatasetArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args AiDatasetArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args AiDatasetArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

AiDataset 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 AiDataset resource accepts the following input properties:

DisplayName string

The user-defined name of the Dataset. The name can be up to 128 characters long and can be consist of any UTF-8 characters.

MetadataSchemaUri string

Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.

EncryptionSpec AiDatasetEncryptionSpecArgs

Customer-managed encryption key spec for a Dataset. If set, this Dataset and all sub-resources of this Dataset will be secured by this key. Structure is documented below.

Labels Dictionary<string, string>

A set of key/value label pairs to assign to this Workflow.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Region string

The region of the dataset. eg us-central1

DisplayName string

The user-defined name of the Dataset. The name can be up to 128 characters long and can be consist of any UTF-8 characters.

MetadataSchemaUri string

Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.

EncryptionSpec AiDatasetEncryptionSpecArgs

Customer-managed encryption key spec for a Dataset. If set, this Dataset and all sub-resources of this Dataset will be secured by this key. Structure is documented below.

Labels map[string]string

A set of key/value label pairs to assign to this Workflow.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Region string

The region of the dataset. eg us-central1

displayName String

The user-defined name of the Dataset. The name can be up to 128 characters long and can be consist of any UTF-8 characters.

metadataSchemaUri String

Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.

encryptionSpec AiDatasetEncryptionSpecArgs

Customer-managed encryption key spec for a Dataset. If set, this Dataset and all sub-resources of this Dataset will be secured by this key. Structure is documented below.

labels Map

A set of key/value label pairs to assign to this Workflow.

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

region String

The region of the dataset. eg us-central1

displayName string

The user-defined name of the Dataset. The name can be up to 128 characters long and can be consist of any UTF-8 characters.

metadataSchemaUri string

Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.

encryptionSpec AiDatasetEncryptionSpecArgs

Customer-managed encryption key spec for a Dataset. If set, this Dataset and all sub-resources of this Dataset will be secured by this key. Structure is documented below.

labels {[key: string]: string}

A set of key/value label pairs to assign to this Workflow.

project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

region string

The region of the dataset. eg us-central1

display_name str

The user-defined name of the Dataset. The name can be up to 128 characters long and can be consist of any UTF-8 characters.

metadata_schema_uri str

Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.

encryption_spec AiDatasetEncryptionSpecArgs

Customer-managed encryption key spec for a Dataset. If set, this Dataset and all sub-resources of this Dataset will be secured by this key. Structure is documented below.

labels Mapping[str, str]

A set of key/value label pairs to assign to this Workflow.

project str

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

region str

The region of the dataset. eg us-central1

displayName String

The user-defined name of the Dataset. The name can be up to 128 characters long and can be consist of any UTF-8 characters.

metadataSchemaUri String

Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.

encryptionSpec Property Map

Customer-managed encryption key spec for a Dataset. If set, this Dataset and all sub-resources of this Dataset will be secured by this key. Structure is documented below.

labels Map

A set of key/value label pairs to assign to this Workflow.

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

region String

The region of the dataset. eg us-central1

Outputs

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

CreateTime string

The timestamp of when the dataset was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.

Id string

The provider-assigned unique ID for this managed resource.

Name string

The resource name of the Dataset. This value is set by Google.

UpdateTime string

The timestamp of when the dataset was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.

CreateTime string

The timestamp of when the dataset was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.

Id string

The provider-assigned unique ID for this managed resource.

Name string

The resource name of the Dataset. This value is set by Google.

UpdateTime string

The timestamp of when the dataset was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.

createTime String

The timestamp of when the dataset was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.

id String

The provider-assigned unique ID for this managed resource.

name String

The resource name of the Dataset. This value is set by Google.

updateTime String

The timestamp of when the dataset was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.

createTime string

The timestamp of when the dataset was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.

id string

The provider-assigned unique ID for this managed resource.

name string

The resource name of the Dataset. This value is set by Google.

updateTime string

The timestamp of when the dataset was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.

create_time str

The timestamp of when the dataset was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.

id str

The provider-assigned unique ID for this managed resource.

name str

The resource name of the Dataset. This value is set by Google.

update_time str

The timestamp of when the dataset was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.

createTime String

The timestamp of when the dataset was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.

id String

The provider-assigned unique ID for this managed resource.

name String

The resource name of the Dataset. This value is set by Google.

updateTime String

The timestamp of when the dataset was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.

Look up an Existing AiDataset Resource

Get an existing AiDataset 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?: AiDatasetState, opts?: CustomResourceOptions): AiDataset
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        create_time: Optional[str] = None,
        display_name: Optional[str] = None,
        encryption_spec: Optional[AiDatasetEncryptionSpecArgs] = None,
        labels: Optional[Mapping[str, str]] = None,
        metadata_schema_uri: Optional[str] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        region: Optional[str] = None,
        update_time: Optional[str] = None) -> AiDataset
func GetAiDataset(ctx *Context, name string, id IDInput, state *AiDatasetState, opts ...ResourceOption) (*AiDataset, error)
public static AiDataset Get(string name, Input<string> id, AiDatasetState? state, CustomResourceOptions? opts = null)
public static AiDataset get(String name, Output<String> id, AiDatasetState 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:
CreateTime string

The timestamp of when the dataset was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.

DisplayName string

The user-defined name of the Dataset. The name can be up to 128 characters long and can be consist of any UTF-8 characters.

EncryptionSpec AiDatasetEncryptionSpecArgs

Customer-managed encryption key spec for a Dataset. If set, this Dataset and all sub-resources of this Dataset will be secured by this key. Structure is documented below.

Labels Dictionary<string, string>

A set of key/value label pairs to assign to this Workflow.

MetadataSchemaUri string

Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.

Name string

The resource name of the Dataset. This value is set by Google.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Region string

The region of the dataset. eg us-central1

UpdateTime string

The timestamp of when the dataset was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.

CreateTime string

The timestamp of when the dataset was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.

DisplayName string

The user-defined name of the Dataset. The name can be up to 128 characters long and can be consist of any UTF-8 characters.

EncryptionSpec AiDatasetEncryptionSpecArgs

Customer-managed encryption key spec for a Dataset. If set, this Dataset and all sub-resources of this Dataset will be secured by this key. Structure is documented below.

Labels map[string]string

A set of key/value label pairs to assign to this Workflow.

MetadataSchemaUri string

Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.

Name string

The resource name of the Dataset. This value is set by Google.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Region string

The region of the dataset. eg us-central1

UpdateTime string

The timestamp of when the dataset was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.

createTime String

The timestamp of when the dataset was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.

displayName String

The user-defined name of the Dataset. The name can be up to 128 characters long and can be consist of any UTF-8 characters.

encryptionSpec AiDatasetEncryptionSpecArgs

Customer-managed encryption key spec for a Dataset. If set, this Dataset and all sub-resources of this Dataset will be secured by this key. Structure is documented below.

labels Map

A set of key/value label pairs to assign to this Workflow.

metadataSchemaUri String

Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.

name String

The resource name of the Dataset. This value is set by Google.

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

region String

The region of the dataset. eg us-central1

updateTime String

The timestamp of when the dataset was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.

createTime string

The timestamp of when the dataset was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.

displayName string

The user-defined name of the Dataset. The name can be up to 128 characters long and can be consist of any UTF-8 characters.

encryptionSpec AiDatasetEncryptionSpecArgs

Customer-managed encryption key spec for a Dataset. If set, this Dataset and all sub-resources of this Dataset will be secured by this key. Structure is documented below.

labels {[key: string]: string}

A set of key/value label pairs to assign to this Workflow.

metadataSchemaUri string

Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.

name string

The resource name of the Dataset. This value is set by Google.

project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

region string

The region of the dataset. eg us-central1

updateTime string

The timestamp of when the dataset was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.

create_time str

The timestamp of when the dataset was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.

display_name str

The user-defined name of the Dataset. The name can be up to 128 characters long and can be consist of any UTF-8 characters.

encryption_spec AiDatasetEncryptionSpecArgs

Customer-managed encryption key spec for a Dataset. If set, this Dataset and all sub-resources of this Dataset will be secured by this key. Structure is documented below.

labels Mapping[str, str]

A set of key/value label pairs to assign to this Workflow.

metadata_schema_uri str

Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.

name str

The resource name of the Dataset. This value is set by Google.

project str

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

region str

The region of the dataset. eg us-central1

update_time str

The timestamp of when the dataset was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.

createTime String

The timestamp of when the dataset was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.

displayName String

The user-defined name of the Dataset. The name can be up to 128 characters long and can be consist of any UTF-8 characters.

encryptionSpec Property Map

Customer-managed encryption key spec for a Dataset. If set, this Dataset and all sub-resources of this Dataset will be secured by this key. Structure is documented below.

labels Map

A set of key/value label pairs to assign to this Workflow.

metadataSchemaUri String

Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.

name String

The resource name of the Dataset. This value is set by Google.

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

region String

The region of the dataset. eg us-central1

updateTime String

The timestamp of when the dataset was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.

Supporting Types

AiDatasetEncryptionSpec

KmsKeyName string

Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the resource is created.

KmsKeyName string

Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the resource is created.

kmsKeyName String

Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the resource is created.

kmsKeyName string

Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the resource is created.

kms_key_name str

Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the resource is created.

kmsKeyName String

Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the resource is created.

Import

This resource does not support import.

Package Details

Repository
https://github.com/pulumi/pulumi-gcp
License
Apache-2.0
Notes

This Pulumi package is based on the google-beta Terraform Provider.