@pulumi/scm
Version:
A Pulumi package for managing resources on Strata Cloud Manager.. Based on terraform-provider-scm: version v0.2.1
151 lines (150 loc) • 4.56 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Tag resource
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scm from "@pulumi/scm";
*
* // This file is embedded using go:embed
* // Tags for organizing and categorizing resources
* const scmTag1 = new scm.Tag("scm_tag_1", {
* folder: "All",
* name: "scm_tag_1",
* color: "Red",
* });
* const scmTag2 = new scm.Tag("scm_tag_2", {
* folder: "All",
* name: "scm_tag_2",
* color: "Blue",
* });
* const scmTag3 = new scm.Tag("scm_tag_3", {
* folder: "All",
* name: "scm_tag_3",
* color: "Orange",
* });
* ```
*/
export declare class Tag extends pulumi.CustomResource {
/**
* Get an existing Tag resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TagState, opts?: pulumi.CustomResourceOptions): Tag;
/**
* Returns true if the given object is an instance of Tag. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Tag;
/**
* The color of the tag
*/
readonly color: pulumi.Output<string | undefined>;
/**
* The description of the tag
*/
readonly comments: pulumi.Output<string | undefined>;
/**
* The device in which the resource is defined
*/
readonly device: pulumi.Output<string | undefined>;
/**
* The folder in which the resource is defined
*
* > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
*/
readonly folder: pulumi.Output<string | undefined>;
/**
* The name of the tag
*/
readonly name: pulumi.Output<string>;
/**
* The snippet in which the resource is defined
*
* > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
*/
readonly snippet: pulumi.Output<string | undefined>;
readonly tfid: pulumi.Output<string>;
/**
* Create a Tag resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: TagArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Tag resources.
*/
export interface TagState {
/**
* The color of the tag
*/
color?: pulumi.Input<string>;
/**
* The description of the tag
*/
comments?: pulumi.Input<string>;
/**
* The device in which the resource is defined
*/
device?: pulumi.Input<string>;
/**
* The folder in which the resource is defined
*
* > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
*/
folder?: pulumi.Input<string>;
/**
* The name of the tag
*/
name?: pulumi.Input<string>;
/**
* The snippet in which the resource is defined
*
* > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
*/
snippet?: pulumi.Input<string>;
tfid?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Tag resource.
*/
export interface TagArgs {
/**
* The color of the tag
*/
color?: pulumi.Input<string>;
/**
* The description of the tag
*/
comments?: pulumi.Input<string>;
/**
* The device in which the resource is defined
*/
device?: pulumi.Input<string>;
/**
* The folder in which the resource is defined
*
* > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
*/
folder?: pulumi.Input<string>;
/**
* The name of the tag
*/
name?: pulumi.Input<string>;
/**
* The snippet in which the resource is defined
*
* > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
*/
snippet?: pulumi.Input<string>;
}