Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. aiplatform
  5. aiplatform/v1
  6. Tensorboard

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
pulumi/pulumi-google-native

google-native.aiplatform/v1.Tensorboard

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
pulumi/pulumi-google-native

    Creates a Tensorboard. Auto-naming is currently not supported for this resource.

    Create Tensorboard Resource

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

    Constructor syntax

    new Tensorboard(name: string, args: TensorboardArgs, opts?: CustomResourceOptions);
    @overload
def Tensorboard(resource_name: str,
                args: TensorboardArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def Tensorboard(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                display_name: Optional[str] = None,
                description: Optional[str] = None,
                encryption_spec: Optional[GoogleCloudAiplatformV1EncryptionSpecArgs] = None,
                etag: Optional[str] = None,
                is_default: Optional[bool] = None,
                labels: Optional[Mapping[str, str]] = None,
                location: Optional[str] = None,
                project: Optional[str] = None)
    func NewTensorboard(ctx *Context, name string, args TensorboardArgs, opts ...ResourceOption) (*Tensorboard, error)
    public Tensorboard(string name, TensorboardArgs args, CustomResourceOptions? opts = null)
    public Tensorboard(String name, TensorboardArgs args)
public Tensorboard(String name, TensorboardArgs args, CustomResourceOptions options)

    type: google-native:aiplatform/v1:Tensorboard
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 TensorboardArgs
    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 TensorboardArgs
    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 TensorboardArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TensorboardArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TensorboardArgs
    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 tensorboardResource = new GoogleNative.Aiplatform.V1.Tensorboard("tensorboardResource", new()
{
    DisplayName = "string",
    Description = "string",
    EncryptionSpec = new GoogleNative.Aiplatform.V1.Inputs.GoogleCloudAiplatformV1EncryptionSpecArgs
    {
        KmsKeyName = "string",
    },
    Etag = "string",
    IsDefault = false,
    Labels = 
    {
        { "string", "string" },
    },
    Location = "string",
    Project = "string",
});

    example, err := aiplatform.NewTensorboard(ctx, "tensorboardResource", &aiplatform.TensorboardArgs{
	DisplayName: pulumi.String("string"),
	Description: pulumi.String("string"),
	EncryptionSpec: &aiplatform.GoogleCloudAiplatformV1EncryptionSpecArgs{
		KmsKeyName: pulumi.String("string"),
	},
	Etag:      pulumi.String("string"),
	IsDefault: pulumi.Bool(false),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Location: pulumi.String("string"),
	Project:  pulumi.String("string"),
})

    var tensorboardResource = new Tensorboard("tensorboardResource", TensorboardArgs.builder()
    .displayName("string")
    .description("string")
    .encryptionSpec(GoogleCloudAiplatformV1EncryptionSpecArgs.builder()
        .kmsKeyName("string")
        .build())
    .etag("string")
    .isDefault(false)
    .labels(Map.of("string", "string"))
    .location("string")
    .project("string")
    .build());

    tensorboard_resource = google_native.aiplatform.v1.Tensorboard("tensorboardResource",
    display_name="string",
    description="string",
    encryption_spec={
        "kms_key_name": "string",
    },
    etag="string",
    is_default=False,
    labels={
        "string": "string",
    },
    location="string",
    project="string")

    const tensorboardResource = new google_native.aiplatform.v1.Tensorboard("tensorboardResource", {
    displayName: "string",
    description: "string",
    encryptionSpec: {
        kmsKeyName: "string",
    },
    etag: "string",
    isDefault: false,
    labels: {
        string: "string",
    },
    location: "string",
    project: "string",
});

    type: google-native:aiplatform/v1:Tensorboard
properties:
    description: string
    displayName: string
    encryptionSpec:
        kmsKeyName: string
    etag: string
    isDefault: false
    labels:
        string: string
    location: string
    project: string

    Tensorboard Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Tensorboard resource accepts the following input properties:

    DisplayName string
    User provided name of this Tensorboard.
    Description string
    Description of this Tensorboard.
    EncryptionSpec Pulumi.GoogleNative.Aiplatform.V1.Inputs.GoogleCloudAiplatformV1EncryptionSpec
    Customer-managed encryption key spec for a Tensorboard. If set, this Tensorboard and all sub-resources of this Tensorboard will be secured by this key.
    Etag string
    Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
    IsDefault bool
    Used to indicate if the TensorBoard instance is the default one. Each project & region can have at most one default TensorBoard instance. Creation of a default TensorBoard instance and updating an existing TensorBoard instance to be default will mark all other TensorBoard instances (if any) as non default.
    Labels Dictionary<string, string>
    The labels with user-defined metadata to organize your Tensorboards. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Tensorboard (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
    Location string
    Project string
    DisplayName string
    User provided name of this Tensorboard.
    Description string
    Description of this Tensorboard.
    EncryptionSpec GoogleCloudAiplatformV1EncryptionSpecArgs
    Customer-managed encryption key spec for a Tensorboard. If set, this Tensorboard and all sub-resources of this Tensorboard will be secured by this key.
    Etag string
    Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
    IsDefault bool
    Used to indicate if the TensorBoard instance is the default one. Each project & region can have at most one default TensorBoard instance. Creation of a default TensorBoard instance and updating an existing TensorBoard instance to be default will mark all other TensorBoard instances (if any) as non default.
    Labels map[string]string
    The labels with user-defined metadata to organize your Tensorboards. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Tensorboard (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
    Location string
    Project string
    displayName String
    User provided name of this Tensorboard.
    description String
    Description of this Tensorboard.
    encryptionSpec GoogleCloudAiplatformV1EncryptionSpec
    Customer-managed encryption key spec for a Tensorboard. If set, this Tensorboard and all sub-resources of this Tensorboard will be secured by this key.
    etag String
    Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
    isDefault Boolean
    Used to indicate if the TensorBoard instance is the default one. Each project & region can have at most one default TensorBoard instance. Creation of a default TensorBoard instance and updating an existing TensorBoard instance to be default will mark all other TensorBoard instances (if any) as non default.
    labels Map<String,String>
    The labels with user-defined metadata to organize your Tensorboards. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Tensorboard (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
    location String
    project String
    displayName string
    User provided name of this Tensorboard.
    description string
    Description of this Tensorboard.
    encryptionSpec GoogleCloudAiplatformV1EncryptionSpec
    Customer-managed encryption key spec for a Tensorboard. If set, this Tensorboard and all sub-resources of this Tensorboard will be secured by this key.
    etag string
    Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
    isDefault boolean
    Used to indicate if the TensorBoard instance is the default one. Each project & region can have at most one default TensorBoard instance. Creation of a default TensorBoard instance and updating an existing TensorBoard instance to be default will mark all other TensorBoard instances (if any) as non default.
    labels {[key: string]: string}
    The labels with user-defined metadata to organize your Tensorboards. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Tensorboard (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
    location string
    project string
    display_name str
    User provided name of this Tensorboard.
    description str
    Description of this Tensorboard.
    encryption_spec GoogleCloudAiplatformV1EncryptionSpecArgs
    Customer-managed encryption key spec for a Tensorboard. If set, this Tensorboard and all sub-resources of this Tensorboard will be secured by this key.
    etag str
    Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
    is_default bool
    Used to indicate if the TensorBoard instance is the default one. Each project & region can have at most one default TensorBoard instance. Creation of a default TensorBoard instance and updating an existing TensorBoard instance to be default will mark all other TensorBoard instances (if any) as non default.
    labels Mapping[str, str]
    The labels with user-defined metadata to organize your Tensorboards. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Tensorboard (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
    location str
    project str
    displayName String
    User provided name of this Tensorboard.
    description String
    Description of this Tensorboard.
    encryptionSpec Property Map
    Customer-managed encryption key spec for a Tensorboard. If set, this Tensorboard and all sub-resources of this Tensorboard will be secured by this key.
    etag String
    Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
    isDefault Boolean
    Used to indicate if the TensorBoard instance is the default one. Each project & region can have at most one default TensorBoard instance. Creation of a default TensorBoard instance and updating an existing TensorBoard instance to be default will mark all other TensorBoard instances (if any) as non default.
    labels Map<String>
    The labels with user-defined metadata to organize your Tensorboards. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Tensorboard (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
    location String
    project String

    Outputs

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

    BlobStoragePathPrefix string
    Consumer project Cloud Storage path prefix used to store blob data, which can either be a bucket or directory. Does not end with a '/'.
    CreateTime string
    Timestamp when this Tensorboard was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Name of the Tensorboard. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}
    RunCount int
    The number of Runs stored in this Tensorboard.
    UpdateTime string
    Timestamp when this Tensorboard was last updated.
    BlobStoragePathPrefix string
    Consumer project Cloud Storage path prefix used to store blob data, which can either be a bucket or directory. Does not end with a '/'.
    CreateTime string
    Timestamp when this Tensorboard was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Name of the Tensorboard. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}
    RunCount int
    The number of Runs stored in this Tensorboard.
    UpdateTime string
    Timestamp when this Tensorboard was last updated.
    blobStoragePathPrefix String
    Consumer project Cloud Storage path prefix used to store blob data, which can either be a bucket or directory. Does not end with a '/'.
    createTime String
    Timestamp when this Tensorboard was created.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Name of the Tensorboard. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}
    runCount Integer
    The number of Runs stored in this Tensorboard.
    updateTime String
    Timestamp when this Tensorboard was last updated.
    blobStoragePathPrefix string
    Consumer project Cloud Storage path prefix used to store blob data, which can either be a bucket or directory. Does not end with a '/'.
    createTime string
    Timestamp when this Tensorboard was created.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Name of the Tensorboard. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}
    runCount number
    The number of Runs stored in this Tensorboard.
    updateTime string
    Timestamp when this Tensorboard was last updated.
    blob_storage_path_prefix str
    Consumer project Cloud Storage path prefix used to store blob data, which can either be a bucket or directory. Does not end with a '/'.
    create_time str
    Timestamp when this Tensorboard was created.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Name of the Tensorboard. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}
    run_count int
    The number of Runs stored in this Tensorboard.
    update_time str
    Timestamp when this Tensorboard was last updated.
    blobStoragePathPrefix String
    Consumer project Cloud Storage path prefix used to store blob data, which can either be a bucket or directory. Does not end with a '/'.
    createTime String
    Timestamp when this Tensorboard was created.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Name of the Tensorboard. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}
    runCount Number
    The number of Runs stored in this Tensorboard.
    updateTime String
    Timestamp when this Tensorboard 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.

    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
    pulumi/pulumi-google-native