@pulumi/scm
Version:
A Pulumi package for managing resources on Strata Cloud Manager.. Based on terraform-provider-scm: version v0.2.1
237 lines (236 loc) • 7.82 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* SyslogServerProfile resource
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scm from "@pulumi/scm";
*
* const scmSyslogServerProf1 = new scm.SyslogServerProfile("scm_syslog_server_prof_1", {
* folder: "All",
* name: "syslog-server-prof-base",
* servers: [{
* name: "Server-Primary",
* server: "192.168.1.10",
* }],
* });
* const scmSyslogServerProf2 = new scm.SyslogServerProfile("scm_syslog_server_prof_2", {
* folder: "All",
* name: "syslog-server-prof-mixed",
* servers: [{
* name: "Server-Mixed",
* server: "10.0.0.50",
* transport: "TCP",
* port: 601,
* format: "IETF",
* facility: "LOG_LOCAL4",
* }],
* format: {
* traffic: "$bytes",
* threat: "$app",
* globalprotect: "$cloud",
* },
* });
* const scmSyslogServerProf3 = new scm.SyslogServerProfile("scm_syslog_server_prof_3", {
* folder: "All",
* name: "syslog-server-prof-complete",
* servers: [
* {
* name: "Server-A",
* server: "172.16.10.1",
* transport: "UDP",
* port: 514,
* format: "BSD",
* facility: "LOG_LOCAL7",
* },
* {
* name: "Server-B",
* server: "172.16.10.2",
* transport: "TCP",
* port: 6514,
* format: "IETF",
* facility: "LOG_LOCAL3",
* },
* {
* name: "Server-C",
* server: "192.168.1.10",
* transport: "UDP",
* port: 514,
* format: "BSD",
* facility: "LOG_USER",
* },
* ],
* format: {
* escaping: {
* escapeCharacter: "*",
* escapedCharacters: "&\\#",
* },
* traffic: "$actionflags",
* threat: "$error + $errorcode",
* wildfire: "$client_os",
* url: "$type",
* data: "$srcregion",
* gtp: "$time_generated",
* sctp: "$device_name and $contenttype",
* tunnel: "$tunnel_type",
* auth: "$hostid + $portal",
* userid: "$hostid and $location",
* iptag: "dg_hier_level_1",
* decryption: "dg_hier_level_2",
* config: "dg_hier_level_3",
* system: "$vsys_name + $status",
* globalprotect: "default",
* hipMatch: "custom",
* correlation: "custom",
* },
* });
* ```
*
* ## Import
*
* The following command can be used to import a resource not managed by Terraform:
*
* bash
*
* ```sh
* $ pulumi import scm:index/syslogServerProfile:SyslogServerProfile example folder:::id
* ```
*
* or
*
* bash
*
* ```sh
* $ pulumi import scm:index/syslogServerProfile:SyslogServerProfile example :snippet::id
* ```
*
* or
*
* bash
*
* ```sh
* $ pulumi import scm:index/syslogServerProfile:SyslogServerProfile example ::device:id
* ```
*/
export declare class SyslogServerProfile extends pulumi.CustomResource {
/**
* Get an existing SyslogServerProfile 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?: SyslogServerProfileState, opts?: pulumi.CustomResourceOptions): SyslogServerProfile;
/**
* Returns true if the given object is an instance of SyslogServerProfile. 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 SyslogServerProfile;
/**
* The device in which the resource is defined
* > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
*/
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>;
/**
* Format
*/
readonly format: pulumi.Output<outputs.SyslogServerProfileFormat | undefined>;
/**
* The name of the syslog server profile
*/
readonly name: pulumi.Output<string>;
/**
* A list of syslog server configurations. At least one server is required.
*/
readonly servers: pulumi.Output<outputs.SyslogServerProfileServer[]>;
/**
* 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>;
/**
* Create a SyslogServerProfile 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: SyslogServerProfileArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering SyslogServerProfile resources.
*/
export interface SyslogServerProfileState {
/**
* 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>;
/**
* Format
*/
format?: pulumi.Input<inputs.SyslogServerProfileFormat>;
/**
* The name of the syslog server profile
*/
name?: pulumi.Input<string>;
/**
* A list of syslog server configurations. At least one server is required.
*/
servers?: pulumi.Input<pulumi.Input<inputs.SyslogServerProfileServer>[]>;
/**
* 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 set of arguments for constructing a SyslogServerProfile resource.
*/
export interface SyslogServerProfileArgs {
/**
* 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>;
/**
* Format
*/
format?: pulumi.Input<inputs.SyslogServerProfileFormat>;
/**
* The name of the syslog server profile
*/
name?: pulumi.Input<string>;
/**
* A list of syslog server configurations. At least one server is required.
*/
servers: pulumi.Input<pulumi.Input<inputs.SyslogServerProfileServer>[]>;
/**
* The snippet in which the resource is defined
* > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
*/
snippet?: pulumi.Input<string>;
}