UNPKG

@pulumi/scm

Version:

A Pulumi package for managing resources on Strata Cloud Manager.. Based on terraform-provider-scm: version v0.2.1

146 lines (145 loc) 5.5 kB
import * as pulumi from "@pulumi/pulumi"; import * as outputs from "./types/output"; /** * ExternalDynamicList data source * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as scm from "@pulumi/scm"; * * // Data source to look up a single external dynamic list by its ID. * const scmExternalDynamicListDs = scm.getExternalDynamicList({ * id: "ce39b7b5-f5bc-4276-9fe5-be56613e37ad", * }); * export const externalDynamicListDetails = { * id: scmExternalDynamicListDs.then(scmExternalDynamicListDs => scmExternalDynamicListDs.id), * name: scmExternalDynamicListDs.then(scmExternalDynamicListDs => scmExternalDynamicListDs.name), * folder: scmExternalDynamicListDs.then(scmExternalDynamicListDs => scmExternalDynamicListDs.folder), * description: scmExternalDynamicListDs.then(scmExternalDynamicListDs => scmExternalDynamicListDs.type?.domain?.description), * url: scmExternalDynamicListDs.then(scmExternalDynamicListDs => scmExternalDynamicListDs.type?.domain?.url), * recurring: scmExternalDynamicListDs.then(scmExternalDynamicListDs => scmExternalDynamicListDs.type?.domain?.recurring), * }; * ``` */ export declare function getExternalDynamicList(args: GetExternalDynamicListArgs, opts?: pulumi.InvokeOptions): Promise<GetExternalDynamicListResult>; /** * A collection of arguments for invoking getExternalDynamicList. */ export interface GetExternalDynamicListArgs { /** * 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 external dynamic list */ id: string; /** * The name of the external dynamic list */ 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 getExternalDynamicList. */ export interface GetExternalDynamicListResult { /** * The device in which the resource is defined * > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`. */ readonly device: string; /** * Map of sensitive values returned from the API. */ readonly encryptedValues: { [key: string]: 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 external dynamic list */ readonly id: string; /** * The name of the external dynamic list */ 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; /** * Type configuration for External Dynamic List */ readonly type: outputs.GetExternalDynamicListType; } /** * ExternalDynamicList data source * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as scm from "@pulumi/scm"; * * // Data source to look up a single external dynamic list by its ID. * const scmExternalDynamicListDs = scm.getExternalDynamicList({ * id: "ce39b7b5-f5bc-4276-9fe5-be56613e37ad", * }); * export const externalDynamicListDetails = { * id: scmExternalDynamicListDs.then(scmExternalDynamicListDs => scmExternalDynamicListDs.id), * name: scmExternalDynamicListDs.then(scmExternalDynamicListDs => scmExternalDynamicListDs.name), * folder: scmExternalDynamicListDs.then(scmExternalDynamicListDs => scmExternalDynamicListDs.folder), * description: scmExternalDynamicListDs.then(scmExternalDynamicListDs => scmExternalDynamicListDs.type?.domain?.description), * url: scmExternalDynamicListDs.then(scmExternalDynamicListDs => scmExternalDynamicListDs.type?.domain?.url), * recurring: scmExternalDynamicListDs.then(scmExternalDynamicListDs => scmExternalDynamicListDs.type?.domain?.recurring), * }; * ``` */ export declare function getExternalDynamicListOutput(args: GetExternalDynamicListOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetExternalDynamicListResult>; /** * A collection of arguments for invoking getExternalDynamicList. */ export interface GetExternalDynamicListOutputArgs { /** * 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 external dynamic list */ id: pulumi.Input<string>; /** * The name of the external dynamic list */ 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>; }