@pulumi/scm

import * as pulumi from "@pulumi/pulumi"; /** * Variable resource * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as scm from "@pulumi/scm"; * * // * // Creates a variable in as-number format * // * const scmVariableAsn = new scm.Variable("scm_variable_asn", { * folder: "All", * name: "$scm_variable_asn", * description: "Managed by Pulumi", * type: "as-number", * value: "65535", * }); * // * // Creates a variable in count format * // * const scmVariableCount = new scm.Variable("scm_variable_count", { * folder: "All", * name: "$scm_variable_count", * description: "Managed by Pulumi", * type: "count", * value: "15", * }); * // * // Creates a variable in fqdn format * // * const scmVariableFqdn = new scm.Variable("scm_variable_fqdn", { * folder: "All", * name: "$scm_variable_fqdn", * description: "Managed by Pulumi", * type: "fqdn", * value: "scm.example.com", * }); * // * // Creates a variable in group-id format * // * const scmVariableGroupId = new scm.Variable("scm_variable_group_id", { * folder: "All", * name: "$scm_variable_group_id", * description: "Managed by Pulumi", * type: "group-id", * value: "10", * }); * // * // Creates a variable in ip-range format * // * const scmVariableIprange = new scm.Variable("scm_variable_iprange", { * folder: "All", * name: "$scm_variable_iprange", * description: "Managed by Pulumi", * type: "ip-range", * value: "198.18.1.1-198.18.1.100", * }); * // * // Creates a variable in ip-netmask format * // * const scmVariableIpaddr = new scm.Variable("scm_variable_ipaddr", { * folder: "All", * name: "$scm_variable_ipaddr", * description: "Managed by Pulumi", * type: "ip-netmask", * value: "198.18.2.0/24", * }); * // * // Creates a variable in ip-wildcard format * // * const scmVariableIpwildcard = new scm.Variable("scm_variable_ipwildcard", { * folder: "All", * name: "$scm_variable_ipwildcard", * description: "Managed by Pulumi", * type: "ip-wildcard", * value: "198.18.1.0/0.255.255.255", * }); * // * // Creates a variable in percent format * // * const scmVariablePercent = new scm.Variable("scm_variable_percent", { * folder: "All", * name: "$scm_variable_percent", * description: "Managed by Pulumi", * type: "percent", * value: "10", * }); * // * // Creates a variable in router-id format * // * const scmVariableRouterId = new scm.Variable("scm_variable_router_id", { * folder: "All", * name: "$scm_variable_router_id", * description: "Managed by Pulumi", * type: "router-id", * value: "198.18.1.1", * }); * // * // Creates a variable in timer format * // * const scmVariableTimer = new scm.Variable("scm_variable_timer", { * folder: "All", * name: "$scm_variable_timer", * description: "Managed by Pulumi", * type: "timer", * value: "1440", * }); * // * // Creates a variable in zone format * // * const scmVariableZone = new scm.Variable("scm_variable_zone", { * folder: "All", * name: "$scm_variable_zone", * description: "Managed by Pulumi", * type: "zone", * value: "internet", * }); * ``` */ export declare class Variable extends pulumi.CustomResource { /** * Get an existing Variable 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?: VariableState, opts?: pulumi.CustomResourceOptions): Variable; /** * Returns true if the given object is an instance of Variable. 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 Variable; /** * The description of the variable */ readonly description: 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 variable */ readonly name: pulumi.Output<string>; /** * Is the variable overridden? */ readonly overridden: pulumi.Output<boolean>; /** * 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>; /** * The variable type */ readonly type: pulumi.Output<string>; /** * The value of the variable */ readonly value: pulumi.Output<string>; /** * Create a Variable 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: VariableArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Variable resources. */ export interface VariableState { /** * The description of the variable */ description?: 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 variable */ name?: pulumi.Input<string>; /** * Is the variable overridden? */ overridden?: pulumi.Input<boolean>; /** * 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 variable type */ type?: pulumi.Input<string>; /** * The value of the variable */ value?: pulumi.Input<string>; } /** * The set of arguments for constructing a Variable resource. */ export interface VariableArgs { /** * The description of the variable */ description?: 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 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>; /** * The variable type */ type: pulumi.Input<string>; /** * The value of the variable */ value: pulumi.Input<string>; }