@pulumi/scm
Version:
A Pulumi package for managing resources on Strata Cloud Manager.. Based on terraform-provider-scm: version v0.2.1
141 lines (140 loc) • 4.19 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Tag data source
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scm from "@pulumi/scm";
*
* // Look up the "production" tag by its name.
* const scmTagDs = scm.getTag({
* id: "66cbe56c-0300-4905-8455-d384978a0082",
* });
* export const tagOutputs = {
* productionId: scmTagDs.then(scmTagDs => scmTagDs.id),
* productionColor: scmTagDs.then(scmTagDs => scmTagDs.color),
* productionFolder: scmTagDs.then(scmTagDs => scmTagDs.folder),
* productionSnippet: scmTagDs.then(scmTagDs => scmTagDs.snippet),
* productionDevice: scmTagDs.then(scmTagDs => scmTagDs.device),
* };
* ```
*/
export declare function getTag(args: GetTagArgs, opts?: pulumi.InvokeOptions): Promise<GetTagResult>;
/**
* A collection of arguments for invoking getTag.
*/
export interface GetTagArgs {
/**
* The device in which the resource is defined
* > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
*/
device?: string;
/**
* The folder in which the resource is defined
* > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
*/
folder?: string;
/**
* The UUID of the tag
*/
id: string;
/**
* The name of the tag
*/
name?: string;
/**
* The snippet in which the resource is defined
* > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
*/
snippet?: string;
}
/**
* A collection of values returned by getTag.
*/
export interface GetTagResult {
/**
* The color of the tag
*/
readonly color: string;
/**
* The description of the tag
*/
readonly comments: string;
/**
* The device in which the resource is defined
* > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
*/
readonly device: string;
/**
* The folder in which the resource is defined
* > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
*/
readonly folder: string;
/**
* The UUID of the tag
*/
readonly id: string;
/**
* The name of the tag
*/
readonly name: string;
/**
* The snippet in which the resource is defined
* > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
*/
readonly snippet: string;
readonly tfid: string;
}
/**
* Tag data source
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scm from "@pulumi/scm";
*
* // Look up the "production" tag by its name.
* const scmTagDs = scm.getTag({
* id: "66cbe56c-0300-4905-8455-d384978a0082",
* });
* export const tagOutputs = {
* productionId: scmTagDs.then(scmTagDs => scmTagDs.id),
* productionColor: scmTagDs.then(scmTagDs => scmTagDs.color),
* productionFolder: scmTagDs.then(scmTagDs => scmTagDs.folder),
* productionSnippet: scmTagDs.then(scmTagDs => scmTagDs.snippet),
* productionDevice: scmTagDs.then(scmTagDs => scmTagDs.device),
* };
* ```
*/
export declare function getTagOutput(args: GetTagOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetTagResult>;
/**
* A collection of arguments for invoking getTag.
*/
export interface GetTagOutputArgs {
/**
* The device in which the resource is defined
* > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
*/
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 UUID of the tag
*/
id: 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>;
}