1. Packages
  2. Impart Security
  3. API Docs
  4. TagMetadata
Impart Security v0.9.0 published on Friday, Mar 21, 2025 by Impart Security

impart.TagMetadata

Explore with Pulumi AI

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as impart from "@impart-security/pulumi-impart";

// Create a new tag metadata
const example = new impart.TagMetadata("example", {
    name: "tag",
    description: "tag description",
    externalUrl: "http://example.com",
    labels: [resource.impart_label.example.slug],
    riskStatement: "risk statement",
});
Copy
import pulumi
import pulumi_impart as impart

# Create a new tag metadata
example = impart.TagMetadata("example",
    name="tag",
    description="tag description",
    external_url="http://example.com",
    labels=[resource["impart_label"]["example"]["slug"]],
    risk_statement="risk statement")
Copy
package main

import (
	"github.com/impart-security/pulumi-impart/sdk/go/impart"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Create a new tag metadata
		_, err := impart.NewTagMetadata(ctx, "example", &impart.TagMetadataArgs{
			Name:        pulumi.String("tag"),
			Description: pulumi.String("tag description"),
			ExternalUrl: pulumi.String("http://example.com"),
			Labels: pulumi.StringArray{
				resource.Impart_label.Example.Slug,
			},
			RiskStatement: pulumi.String("risk statement"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Impart = Pulumi.Impart;

return await Deployment.RunAsync(() => 
{
    // Create a new tag metadata
    var example = new Impart.TagMetadata("example", new()
    {
        Name = "tag",
        Description = "tag description",
        ExternalUrl = "http://example.com",
        Labels = new[]
        {
            resource.Impart_label.Example.Slug,
        },
        RiskStatement = "risk statement",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.impart.TagMetadata;
import com.pulumi.impart.TagMetadataArgs;
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) {
        // Create a new tag metadata
        var example = new TagMetadata("example", TagMetadataArgs.builder()
            .name("tag")
            .description("tag description")
            .externalUrl("http://example.com")
            .labels(resource.impart_label().example().slug())
            .riskStatement("risk statement")
            .build());

    }
}
Copy
resources:
  # Create a new tag metadata
  example:
    type: impart:TagMetadata
    properties:
      name: tag
      description: tag description
      externalUrl: http://example.com
      labels:
        - ${resource.impart_label.example.slug}
      riskStatement: risk statement
Copy

Create TagMetadata Resource

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

Constructor syntax

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

@overload
def TagMetadata(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                name: Optional[str] = None,
                description: Optional[str] = None,
                external_url: Optional[str] = None,
                labels: Optional[Sequence[str]] = None,
                risk_statement: Optional[str] = None)
func NewTagMetadata(ctx *Context, name string, args TagMetadataArgs, opts ...ResourceOption) (*TagMetadata, error)
public TagMetadata(string name, TagMetadataArgs args, CustomResourceOptions? opts = null)
public TagMetadata(String name, TagMetadataArgs args)
public TagMetadata(String name, TagMetadataArgs args, CustomResourceOptions options)
type: impart:TagMetadata
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. TagMetadataArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. TagMetadataArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. TagMetadataArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. TagMetadataArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. TagMetadataArgs
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 tagMetadataResource = new Impart.TagMetadata("tagMetadataResource", new()
{
    Name = "string",
    Description = "string",
    ExternalUrl = "string",
    Labels = new[]
    {
        "string",
    },
    RiskStatement = "string",
});
Copy
example, err := impart.NewTagMetadata(ctx, "tagMetadataResource", &impart.TagMetadataArgs{
	Name:        pulumi.String("string"),
	Description: pulumi.String("string"),
	ExternalUrl: pulumi.String("string"),
	Labels: pulumi.StringArray{
		pulumi.String("string"),
	},
	RiskStatement: pulumi.String("string"),
})
Copy
var tagMetadataResource = new TagMetadata("tagMetadataResource", TagMetadataArgs.builder()
    .name("string")
    .description("string")
    .externalUrl("string")
    .labels("string")
    .riskStatement("string")
    .build());
Copy
tag_metadata_resource = impart.TagMetadata("tagMetadataResource",
    name="string",
    description="string",
    external_url="string",
    labels=["string"],
    risk_statement="string")
Copy
const tagMetadataResource = new impart.TagMetadata("tagMetadataResource", {
    name: "string",
    description: "string",
    externalUrl: "string",
    labels: ["string"],
    riskStatement: "string",
});
Copy
type: impart:TagMetadata
properties:
    description: string
    externalUrl: string
    labels:
        - string
    name: string
    riskStatement: string
Copy

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

Name This property is required. string
The tag name.
Description string
The description for the tag.
ExternalUrl string
The external URL for the tag.
Labels List<string>
The applied labels.
RiskStatement string
The risk statement for the tag.
Name This property is required. string
The tag name.
Description string
The description for the tag.
ExternalUrl string
The external URL for the tag.
Labels []string
The applied labels.
RiskStatement string
The risk statement for the tag.
name This property is required. String
The tag name.
description String
The description for the tag.
externalUrl String
The external URL for the tag.
labels List<String>
The applied labels.
riskStatement String
The risk statement for the tag.
name This property is required. string
The tag name.
description string
The description for the tag.
externalUrl string
The external URL for the tag.
labels string[]
The applied labels.
riskStatement string
The risk statement for the tag.
name This property is required. str
The tag name.
description str
The description for the tag.
external_url str
The external URL for the tag.
labels Sequence[str]
The applied labels.
risk_statement str
The risk statement for the tag.
name This property is required. String
The tag name.
description String
The description for the tag.
externalUrl String
The external URL for the tag.
labels List<String>
The applied labels.
riskStatement String
The risk statement for the tag.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing TagMetadata Resource

Get an existing TagMetadata 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?: TagMetadataState, opts?: CustomResourceOptions): TagMetadata
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        external_url: Optional[str] = None,
        labels: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        risk_statement: Optional[str] = None) -> TagMetadata
func GetTagMetadata(ctx *Context, name string, id IDInput, state *TagMetadataState, opts ...ResourceOption) (*TagMetadata, error)
public static TagMetadata Get(string name, Input<string> id, TagMetadataState? state, CustomResourceOptions? opts = null)
public static TagMetadata get(String name, Output<String> id, TagMetadataState state, CustomResourceOptions options)
resources:  _:    type: impart:TagMetadata    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Description string
The description for the tag.
ExternalUrl string
The external URL for the tag.
Labels List<string>
The applied labels.
Name string
The tag name.
RiskStatement string
The risk statement for the tag.
Description string
The description for the tag.
ExternalUrl string
The external URL for the tag.
Labels []string
The applied labels.
Name string
The tag name.
RiskStatement string
The risk statement for the tag.
description String
The description for the tag.
externalUrl String
The external URL for the tag.
labels List<String>
The applied labels.
name String
The tag name.
riskStatement String
The risk statement for the tag.
description string
The description for the tag.
externalUrl string
The external URL for the tag.
labels string[]
The applied labels.
name string
The tag name.
riskStatement string
The risk statement for the tag.
description str
The description for the tag.
external_url str
The external URL for the tag.
labels Sequence[str]
The applied labels.
name str
The tag name.
risk_statement str
The risk statement for the tag.
description String
The description for the tag.
externalUrl String
The external URL for the tag.
labels List<String>
The applied labels.
name String
The tag name.
riskStatement String
The risk statement for the tag.

Package Details

Repository
impart impart-security/pulumi-impart
License
Apache-2.0
Notes
This Pulumi package is based on the impart Terraform Provider.