@pulumi/scm
Version:
A Pulumi package for managing resources on Strata Cloud Manager.. Based on terraform-provider-scm: version v0.2.1
147 lines (146 loc) • 4.42 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Variable data source
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scm from "@pulumi/scm";
*
* // Look up the "$example" variable by its name.
* const scmVariableDs = scm.getVariable({
* id: "66cbe56c-0300-4905-8455-d384978a0081",
* });
* export const variableOutputs = {
* exampleId: scmVariableDs.then(scmVariableDs => scmVariableDs.id),
* exampleName: scmVariableDs.then(scmVariableDs => scmVariableDs.name),
* exampleType: scmVariableDs.then(scmVariableDs => scmVariableDs.type),
* exampleValue: scmVariableDs.then(scmVariableDs => scmVariableDs.value),
* };
* ```
*/
export declare function getVariable(args: GetVariableArgs, opts?: pulumi.InvokeOptions): Promise<GetVariableResult>;
/**
* A collection of arguments for invoking getVariable.
*/
export interface GetVariableArgs {
/**
* 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;
/**
* UUID of the variable
*/
id: string;
/**
* The name of the variable
*/
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 getVariable.
*/
export interface GetVariableResult {
/**
* The description of the variable
*/
readonly description: 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;
/**
* UUID of the variable
*/
readonly id: string;
/**
* The name of the variable
*/
readonly name: string;
/**
* Is the variable overridden?
*/
readonly overridden: boolean;
/**
* 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;
/**
* The variable type
*/
readonly type: string;
/**
* The value of the variable
*/
readonly value: string;
}
/**
* Variable data source
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scm from "@pulumi/scm";
*
* // Look up the "$example" variable by its name.
* const scmVariableDs = scm.getVariable({
* id: "66cbe56c-0300-4905-8455-d384978a0081",
* });
* export const variableOutputs = {
* exampleId: scmVariableDs.then(scmVariableDs => scmVariableDs.id),
* exampleName: scmVariableDs.then(scmVariableDs => scmVariableDs.name),
* exampleType: scmVariableDs.then(scmVariableDs => scmVariableDs.type),
* exampleValue: scmVariableDs.then(scmVariableDs => scmVariableDs.value),
* };
* ```
*/
export declare function getVariableOutput(args: GetVariableOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetVariableResult>;
/**
* A collection of arguments for invoking getVariable.
*/
export interface GetVariableOutputArgs {
/**
* 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>;
/**
* UUID of the variable
*/
id: pulumi.Input<string>;
/**
* The name of the variable
*/
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>;
}