UNPKG

@pulumi/scm

Version:

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

152 lines (151 loc) 4.96 kB
import * as pulumi from "@pulumi/pulumi"; import * as outputs from "./types/output"; /** * AddressGroup data source * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as scm from "@pulumi/scm"; * * // Look up the address group by its ID. * const scmAddressGroupDs = scm.getAddressGroup({ * id: "99802bce-76c6-42c9-801e-e2e4529bb335", * }); * export const addressGroupOutputs = { * groupId: scmAddressGroupDs.then(scmAddressGroupDs => scmAddressGroupDs.id), * folder: scmAddressGroupDs.then(scmAddressGroupDs => scmAddressGroupDs.folder), * name: scmAddressGroupDs.then(scmAddressGroupDs => scmAddressGroupDs.name), * description: scmAddressGroupDs.then(scmAddressGroupDs => scmAddressGroupDs.description), * static: scmAddressGroupDs.then(scmAddressGroupDs => scmAddressGroupDs.statics), * }; * ``` */ export declare function getAddressGroup(args: GetAddressGroupArgs, opts?: pulumi.InvokeOptions): Promise<GetAddressGroupResult>; /** * A collection of arguments for invoking getAddressGroup. */ export interface GetAddressGroupArgs { /** * 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 address group */ id: string; /** * The name of the address group */ 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 getAddressGroup. */ export interface GetAddressGroupResult { /** * Description */ 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; /** * Dynamic * > ℹ️ **Note:** You must specify exactly one of `dynamic` and `static`. */ readonly dynamic: outputs.GetAddressGroupDynamic; /** * 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 address group */ readonly id: string; /** * The name of the address group */ 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; /** * Static * > ℹ️ **Note:** You must specify exactly one of `dynamic` and `static`. */ readonly statics: string[]; /** * Tags for address group object */ readonly tags: string[]; readonly tfid: string; } /** * AddressGroup data source * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as scm from "@pulumi/scm"; * * // Look up the address group by its ID. * const scmAddressGroupDs = scm.getAddressGroup({ * id: "99802bce-76c6-42c9-801e-e2e4529bb335", * }); * export const addressGroupOutputs = { * groupId: scmAddressGroupDs.then(scmAddressGroupDs => scmAddressGroupDs.id), * folder: scmAddressGroupDs.then(scmAddressGroupDs => scmAddressGroupDs.folder), * name: scmAddressGroupDs.then(scmAddressGroupDs => scmAddressGroupDs.name), * description: scmAddressGroupDs.then(scmAddressGroupDs => scmAddressGroupDs.description), * static: scmAddressGroupDs.then(scmAddressGroupDs => scmAddressGroupDs.statics), * }; * ``` */ export declare function getAddressGroupOutput(args: GetAddressGroupOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetAddressGroupResult>; /** * A collection of arguments for invoking getAddressGroup. */ export interface GetAddressGroupOutputArgs { /** * 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 address group */ id: pulumi.Input<string>; /** * The name of the address group */ 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>; }