1. Packages
  2. Google Cloud Native
  3. API Docs
  4. aiplatform
  5. aiplatform/v1
  6. MetadataStore

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

google-native.aiplatform/v1.MetadataStore

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

    Initializes a MetadataStore, including allocation of resources. Auto-naming is currently not supported for this resource.

    Create MetadataStore Resource

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

    Constructor syntax

    new MetadataStore(name: string, args?: MetadataStoreArgs, opts?: CustomResourceOptions);
    @overload
    def MetadataStore(resource_name: str,
                      args: Optional[MetadataStoreArgs] = None,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def MetadataStore(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      description: Optional[str] = None,
                      encryption_spec: Optional[GoogleCloudAiplatformV1EncryptionSpecArgs] = None,
                      location: Optional[str] = None,
                      metadata_store_id: Optional[str] = None,
                      project: Optional[str] = None)
    func NewMetadataStore(ctx *Context, name string, args *MetadataStoreArgs, opts ...ResourceOption) (*MetadataStore, error)
    public MetadataStore(string name, MetadataStoreArgs? args = null, CustomResourceOptions? opts = null)
    public MetadataStore(String name, MetadataStoreArgs args)
    public MetadataStore(String name, MetadataStoreArgs args, CustomResourceOptions options)
    
    type: google-native:aiplatform/v1:MetadataStore
    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 MetadataStoreArgs
    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 MetadataStoreArgs
    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 MetadataStoreArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MetadataStoreArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MetadataStoreArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var metadataStoreResource = new GoogleNative.Aiplatform.V1.MetadataStore("metadataStoreResource", new()
    {
        Description = "string",
        EncryptionSpec = new GoogleNative.Aiplatform.V1.Inputs.GoogleCloudAiplatformV1EncryptionSpecArgs
        {
            KmsKeyName = "string",
        },
        Location = "string",
        MetadataStoreId = "string",
        Project = "string",
    });
    
    example, err := aiplatform.NewMetadataStore(ctx, "metadataStoreResource", &aiplatform.MetadataStoreArgs{
    Description: pulumi.String("string"),
    EncryptionSpec: &aiplatform.GoogleCloudAiplatformV1EncryptionSpecArgs{
    KmsKeyName: pulumi.String("string"),
    },
    Location: pulumi.String("string"),
    MetadataStoreId: pulumi.String("string"),
    Project: pulumi.String("string"),
    })
    
    var metadataStoreResource = new MetadataStore("metadataStoreResource", MetadataStoreArgs.builder()
        .description("string")
        .encryptionSpec(GoogleCloudAiplatformV1EncryptionSpecArgs.builder()
            .kmsKeyName("string")
            .build())
        .location("string")
        .metadataStoreId("string")
        .project("string")
        .build());
    
    metadata_store_resource = google_native.aiplatform.v1.MetadataStore("metadataStoreResource",
        description="string",
        encryption_spec=google_native.aiplatform.v1.GoogleCloudAiplatformV1EncryptionSpecArgs(
            kms_key_name="string",
        ),
        location="string",
        metadata_store_id="string",
        project="string")
    
    const metadataStoreResource = new google_native.aiplatform.v1.MetadataStore("metadataStoreResource", {
        description: "string",
        encryptionSpec: {
            kmsKeyName: "string",
        },
        location: "string",
        metadataStoreId: "string",
        project: "string",
    });
    
    type: google-native:aiplatform/v1:MetadataStore
    properties:
        description: string
        encryptionSpec:
            kmsKeyName: string
        location: string
        metadataStoreId: string
        project: string
    

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

    Description string
    Description of the MetadataStore.
    EncryptionSpec Pulumi.GoogleNative.Aiplatform.V1.Inputs.GoogleCloudAiplatformV1EncryptionSpec
    Customer-managed encryption key spec for a Metadata Store. If set, this Metadata Store and all sub-resources of this Metadata Store are secured using this key.
    Location string
    MetadataStoreId string
    The {metadatastore} portion of the resource name with the format: projects/{project}/locations/{location}/metadataStores/{metadatastore} If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are /a-z-/. Must be unique across all MetadataStores in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataStore.)
    Project string
    Description string
    Description of the MetadataStore.
    EncryptionSpec GoogleCloudAiplatformV1EncryptionSpecArgs
    Customer-managed encryption key spec for a Metadata Store. If set, this Metadata Store and all sub-resources of this Metadata Store are secured using this key.
    Location string
    MetadataStoreId string
    The {metadatastore} portion of the resource name with the format: projects/{project}/locations/{location}/metadataStores/{metadatastore} If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are /a-z-/. Must be unique across all MetadataStores in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataStore.)
    Project string
    description String
    Description of the MetadataStore.
    encryptionSpec GoogleCloudAiplatformV1EncryptionSpec
    Customer-managed encryption key spec for a Metadata Store. If set, this Metadata Store and all sub-resources of this Metadata Store are secured using this key.
    location String
    metadataStoreId String
    The {metadatastore} portion of the resource name with the format: projects/{project}/locations/{location}/metadataStores/{metadatastore} If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are /a-z-/. Must be unique across all MetadataStores in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataStore.)
    project String
    description string
    Description of the MetadataStore.
    encryptionSpec GoogleCloudAiplatformV1EncryptionSpec
    Customer-managed encryption key spec for a Metadata Store. If set, this Metadata Store and all sub-resources of this Metadata Store are secured using this key.
    location string
    metadataStoreId string
    The {metadatastore} portion of the resource name with the format: projects/{project}/locations/{location}/metadataStores/{metadatastore} If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are /a-z-/. Must be unique across all MetadataStores in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataStore.)
    project string
    description str
    Description of the MetadataStore.
    encryption_spec GoogleCloudAiplatformV1EncryptionSpecArgs
    Customer-managed encryption key spec for a Metadata Store. If set, this Metadata Store and all sub-resources of this Metadata Store are secured using this key.
    location str
    metadata_store_id str
    The {metadatastore} portion of the resource name with the format: projects/{project}/locations/{location}/metadataStores/{metadatastore} If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are /a-z-/. Must be unique across all MetadataStores in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataStore.)
    project str
    description String
    Description of the MetadataStore.
    encryptionSpec Property Map
    Customer-managed encryption key spec for a Metadata Store. If set, this Metadata Store and all sub-resources of this Metadata Store are secured using this key.
    location String
    metadataStoreId String
    The {metadatastore} portion of the resource name with the format: projects/{project}/locations/{location}/metadataStores/{metadatastore} If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are /a-z-/. Must be unique across all MetadataStores in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataStore.)
    project String

    Outputs

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

    CreateTime string
    Timestamp when this MetadataStore was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The resource name of the MetadataStore instance.
    State Pulumi.GoogleNative.Aiplatform.V1.Outputs.GoogleCloudAiplatformV1MetadataStoreMetadataStoreStateResponse
    State information of the MetadataStore.
    UpdateTime string
    Timestamp when this MetadataStore was last updated.
    CreateTime string
    Timestamp when this MetadataStore was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The resource name of the MetadataStore instance.
    State GoogleCloudAiplatformV1MetadataStoreMetadataStoreStateResponse
    State information of the MetadataStore.
    UpdateTime string
    Timestamp when this MetadataStore was last updated.
    createTime String
    Timestamp when this MetadataStore was created.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The resource name of the MetadataStore instance.
    state GoogleCloudAiplatformV1MetadataStoreMetadataStoreStateResponse
    State information of the MetadataStore.
    updateTime String
    Timestamp when this MetadataStore was last updated.
    createTime string
    Timestamp when this MetadataStore was created.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The resource name of the MetadataStore instance.
    state GoogleCloudAiplatformV1MetadataStoreMetadataStoreStateResponse
    State information of the MetadataStore.
    updateTime string
    Timestamp when this MetadataStore was last updated.
    create_time str
    Timestamp when this MetadataStore was created.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The resource name of the MetadataStore instance.
    state GoogleCloudAiplatformV1MetadataStoreMetadataStoreStateResponse
    State information of the MetadataStore.
    update_time str
    Timestamp when this MetadataStore was last updated.
    createTime String
    Timestamp when this MetadataStore was created.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The resource name of the MetadataStore instance.
    state Property Map
    State information of the MetadataStore.
    updateTime String
    Timestamp when this MetadataStore was last updated.

    Supporting Types

    GoogleCloudAiplatformV1EncryptionSpec, GoogleCloudAiplatformV1EncryptionSpecArgs

    KmsKeyName string
    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 compute resource is created.
    KmsKeyName string
    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 compute resource is created.
    kmsKeyName String
    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 compute resource is created.
    kmsKeyName string
    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 compute resource is created.
    kms_key_name str
    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 compute resource is created.
    kmsKeyName String
    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 compute resource is created.

    GoogleCloudAiplatformV1EncryptionSpecResponse, GoogleCloudAiplatformV1EncryptionSpecResponseArgs

    KmsKeyName string
    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 compute resource is created.
    KmsKeyName string
    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 compute resource is created.
    kmsKeyName String
    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 compute resource is created.
    kmsKeyName string
    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 compute resource is created.
    kms_key_name str
    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 compute resource is created.
    kmsKeyName String
    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 compute resource is created.

    GoogleCloudAiplatformV1MetadataStoreMetadataStoreStateResponse, GoogleCloudAiplatformV1MetadataStoreMetadataStoreStateResponseArgs

    DiskUtilizationBytes string
    The disk utilization of the MetadataStore in bytes.
    DiskUtilizationBytes string
    The disk utilization of the MetadataStore in bytes.
    diskUtilizationBytes String
    The disk utilization of the MetadataStore in bytes.
    diskUtilizationBytes string
    The disk utilization of the MetadataStore in bytes.
    disk_utilization_bytes str
    The disk utilization of the MetadataStore in bytes.
    diskUtilizationBytes String
    The disk utilization of the MetadataStore in bytes.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi