@pulumi/scm
Version:
A Pulumi package for managing resources on Strata Cloud Manager.. Based on terraform-provider-scm: version v0.2.1
268 lines (267 loc) • 8.53 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Address resource
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scm from "@pulumi/scm";
*
* // This file is embedded using go:embed
* const scmAddrTag1 = new scm.Tag("scm_addr_tag_1", {
* folder: "All",
* name: "scm_addr_tag_1",
* color: "Red",
* });
* const scmAddrTag2 = new scm.Tag("scm_addr_tag_2", {
* folder: "All",
* name: "scm_addr_tag_2",
* color: "Blue",
* });
* const scmAddrTag3 = new scm.Tag("scm_addr_tag_3", {
* folder: "All",
* name: "scm_addr_tag_3",
* color: "Orange",
* });
* // IP Netmask
* const scmAddress1 = new scm.Address("scm_address_1", {
* folder: "Shared",
* name: "scm_address_1",
* description: "Made by Pulumi",
* ipNetmask: "10.2.3.4",
* });
* // IP Range
* const scmAddress2 = new scm.Address("scm_address_2", {
* folder: "Shared",
* name: "scm_address_2",
* description: "Small IP range test",
* ipRange: "192.168.1.10-192.168.1.20",
* });
* // FQDN
* const scmAddress3 = new scm.Address("scm_address_3", {
* folder: "Shared",
* name: "scm_address_3",
* description: "Simple FQDN test",
* fqdn: "example.com",
* });
* // Class C wildcard
* const scmAddress4 = new scm.Address("scm_address_4", {
* folder: "Shared",
* name: "scm_address_4",
* description: "Class C wildcard test",
* ipWildcard: "192.168.1.0/0.0.0.255",
* });
* // Multiple tags
* const scmAddress5 = new scm.Address("scm_address_5", {
* folder: "Shared",
* name: "scm_address_5",
* description: "Multiple tags test",
* ipNetmask: "10.10.10.2/32",
* tags: [
* scmAddrTag1.name,
* scmAddrTag2.name,
* scmAddrTag3.name,
* ],
* }, {
* dependsOn: [
* scmAddrTag1,
* scmAddrTag2,
* scmAddrTag3,
* ],
* });
* ```
*/
export declare class Address extends pulumi.CustomResource {
/**
* Get an existing Address 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?: AddressState, opts?: pulumi.CustomResourceOptions): Address;
/**
* Returns true if the given object is an instance of Address. 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 Address;
/**
* The description of the address object
*/
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>;
/**
* Fully qualified domain name
*
* > ℹ️ **Note:** You must specify exactly one of `fqdn`, `ipNetmask`, `ipRange`, and `ipWildcard`.
*/
readonly fqdn: pulumi.Output<string | undefined>;
/**
* IP address with or without CIDR notation
*
* > ℹ️ **Note:** You must specify exactly one of `fqdn`, `ipNetmask`, `ipRange`, and `ipWildcard`.
*/
readonly ipNetmask: pulumi.Output<string | undefined>;
/**
* Ip range
*
* > ℹ️ **Note:** You must specify exactly one of `fqdn`, `ipNetmask`, `ipRange`, and `ipWildcard`.
*/
readonly ipRange: pulumi.Output<string | undefined>;
/**
* IP wildcard mask
*
* > ℹ️ **Note:** You must specify exactly one of `fqdn`, `ipNetmask`, `ipRange`, and `ipWildcard`.
*/
readonly ipWildcard: pulumi.Output<string | undefined>;
/**
* The name of the address object
*/
readonly name: pulumi.Output<string>;
/**
* 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>;
/**
* Tags assocaited with the address object
*/
readonly tags: pulumi.Output<string[] | undefined>;
readonly tfid: pulumi.Output<string>;
/**
* Create a Address 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?: AddressArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Address resources.
*/
export interface AddressState {
/**
* The description of the address object
*/
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>;
/**
* Fully qualified domain name
*
* > ℹ️ **Note:** You must specify exactly one of `fqdn`, `ipNetmask`, `ipRange`, and `ipWildcard`.
*/
fqdn?: pulumi.Input<string>;
/**
* IP address with or without CIDR notation
*
* > ℹ️ **Note:** You must specify exactly one of `fqdn`, `ipNetmask`, `ipRange`, and `ipWildcard`.
*/
ipNetmask?: pulumi.Input<string>;
/**
* Ip range
*
* > ℹ️ **Note:** You must specify exactly one of `fqdn`, `ipNetmask`, `ipRange`, and `ipWildcard`.
*/
ipRange?: pulumi.Input<string>;
/**
* IP wildcard mask
*
* > ℹ️ **Note:** You must specify exactly one of `fqdn`, `ipNetmask`, `ipRange`, and `ipWildcard`.
*/
ipWildcard?: pulumi.Input<string>;
/**
* The name of the address object
*/
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>;
/**
* Tags assocaited with the address object
*/
tags?: pulumi.Input<pulumi.Input<string>[]>;
tfid?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Address resource.
*/
export interface AddressArgs {
/**
* The description of the address object
*/
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>;
/**
* Fully qualified domain name
*
* > ℹ️ **Note:** You must specify exactly one of `fqdn`, `ipNetmask`, `ipRange`, and `ipWildcard`.
*/
fqdn?: pulumi.Input<string>;
/**
* IP address with or without CIDR notation
*
* > ℹ️ **Note:** You must specify exactly one of `fqdn`, `ipNetmask`, `ipRange`, and `ipWildcard`.
*/
ipNetmask?: pulumi.Input<string>;
/**
* Ip range
*
* > ℹ️ **Note:** You must specify exactly one of `fqdn`, `ipNetmask`, `ipRange`, and `ipWildcard`.
*/
ipRange?: pulumi.Input<string>;
/**
* IP wildcard mask
*
* > ℹ️ **Note:** You must specify exactly one of `fqdn`, `ipNetmask`, `ipRange`, and `ipWildcard`.
*/
ipWildcard?: pulumi.Input<string>;
/**
* The name of the address object
*/
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>;
/**
* Tags assocaited with the address object
*/
tags?: pulumi.Input<pulumi.Input<string>[]>;
}