@pulumi/juniper-mist
Version:
A Pulumi package for creating and managing Juniper Mist resources.
366 lines • 13 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* This resource manages WAN Assurance Services (Applications).
*
* A Service is used to define a Custom Application that can be used in the `servicePolicies`. These Services can be referenced by their name in
* * the Service Policies (`mist_org_servicepolicy.services`)
* * the Gateway configuration (`mist_device_gateway.service_policies.services`)
* * the Gateway Templates (`mist_org_gatewaytemplate.service_policies.services`)
* * the HUB Profiles (`mist_org_deviceprofile_gateway.service_policies.services`)
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as junipermist from "@pulumi/juniper-mist";
*
* const serviceOne = new junipermist.org.Service("service_one", {
* orgId: terraformTest.id,
* name: "service_one",
* addresses: [
* "10.3.0.0/24",
* "10.4.0.0/24",
* ],
* type: "custom",
* specs: [{
* protocol: "tcp",
* portRange: "443",
* }],
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import `junipermist.org.Service` with:
* Org Service can be imported by specifying the orgId and the serviceId
*
* ```sh
* $ pulumi import junipermist:org/service:Service service_one 17b46405-3a6d-4715-8bb4-6bb6d06f316a.d3c42998-9012-4859-9743-6b9bee475309
* ```
*/
export declare class Service extends pulumi.CustomResource {
/**
* Get an existing Service 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?: ServiceState, opts?: pulumi.CustomResourceOptions): Service;
/**
* Returns true if the given object is an instance of Service. 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 Service;
/**
* Custom IPv4 or IPv6 subnets matched by this service when `type`==`custom`
*/
readonly addresses: pulumi.Output<string[]>;
/**
* Categories of applications matched by this service when `type`==`appCategories`
*/
readonly appCategories: pulumi.Output<string[]>;
/**
* Application subcategories matched by this service when `type`==`appCategories`
*/
readonly appSubcategories: pulumi.Output<string[]>;
/**
* Application identifiers matched by this service when `type`==`apps`
*/
readonly apps: pulumi.Output<string[]>;
/**
* 0 means unlimited, value from 0 to 107374182
*/
readonly clientLimitDown: pulumi.Output<number | undefined>;
/**
* 0 means unlimited, value from 0 to 107374182
*/
readonly clientLimitUp: pulumi.Output<number | undefined>;
/**
* Free-form description of the service definition
*/
readonly description: pulumi.Output<string | undefined>;
/**
* QoS DSCP value used for custom SSR traffic classification
*/
readonly dscp: pulumi.Output<string | undefined>;
/**
* Failover behavior for traffic matched by this service
*/
readonly failoverPolicy: pulumi.Output<string | undefined>;
/**
* Domain hostnames matched by this custom service for web filtering
*/
readonly hostnames: pulumi.Output<string[]>;
/**
* Maximum jitter threshold used for SSR uplink selection when `trafficType`==`custom`
*/
readonly maxJitter: pulumi.Output<string | undefined>;
/**
* Maximum latency threshold used for SSR uplink selection when `trafficType`==`custom`
*/
readonly maxLatency: pulumi.Output<string | undefined>;
/**
* Maximum packet loss threshold used for SSR uplink selection when `trafficType`==`custom`
*/
readonly maxLoss: pulumi.Output<string | undefined>;
/**
* Display name of the service definition
*/
readonly name: pulumi.Output<string>;
/**
* Organization identifier associated with the service definition
*/
readonly orgId: pulumi.Output<string>;
/**
* 0 means unlimited, value from 0 to 107374182
*/
readonly serviceLimitDown: pulumi.Output<number | undefined>;
/**
* 0 means unlimited, value from 0 to 107374182
*/
readonly serviceLimitUp: pulumi.Output<number | undefined>;
/**
* Whether to enable measure SLE
*/
readonly sleEnabled: pulumi.Output<boolean | undefined>;
/**
* Protocol and port match rules used when `type`==`custom`
*/
readonly specs: pulumi.Output<outputs.org.ServiceSpec[] | undefined>;
/**
* Whether SSR relaxes TCP state enforcement for this service
*/
readonly ssrRelaxedTcpStateEnforcement: pulumi.Output<boolean | undefined>;
/**
* Traffic class applied when `trafficType`==`custom`
*/
readonly trafficClass: pulumi.Output<string | undefined>;
/**
* values from List Traffic Types
*/
readonly trafficType: pulumi.Output<string>;
/**
* Matching mode that determines which app, URL, or custom fields are used
*/
readonly type: pulumi.Output<string>;
/**
* URL patterns matched by this service when `type`==`urls`
*/
readonly urls: pulumi.Output<string[]>;
/**
* Create a Service 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: ServiceArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Service resources.
*/
export interface ServiceState {
/**
* Custom IPv4 or IPv6 subnets matched by this service when `type`==`custom`
*/
addresses?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* Categories of applications matched by this service when `type`==`appCategories`
*/
appCategories?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* Application subcategories matched by this service when `type`==`appCategories`
*/
appSubcategories?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* Application identifiers matched by this service when `type`==`apps`
*/
apps?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* 0 means unlimited, value from 0 to 107374182
*/
clientLimitDown?: pulumi.Input<number | undefined>;
/**
* 0 means unlimited, value from 0 to 107374182
*/
clientLimitUp?: pulumi.Input<number | undefined>;
/**
* Free-form description of the service definition
*/
description?: pulumi.Input<string | undefined>;
/**
* QoS DSCP value used for custom SSR traffic classification
*/
dscp?: pulumi.Input<string | undefined>;
/**
* Failover behavior for traffic matched by this service
*/
failoverPolicy?: pulumi.Input<string | undefined>;
/**
* Domain hostnames matched by this custom service for web filtering
*/
hostnames?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* Maximum jitter threshold used for SSR uplink selection when `trafficType`==`custom`
*/
maxJitter?: pulumi.Input<string | undefined>;
/**
* Maximum latency threshold used for SSR uplink selection when `trafficType`==`custom`
*/
maxLatency?: pulumi.Input<string | undefined>;
/**
* Maximum packet loss threshold used for SSR uplink selection when `trafficType`==`custom`
*/
maxLoss?: pulumi.Input<string | undefined>;
/**
* Display name of the service definition
*/
name?: pulumi.Input<string | undefined>;
/**
* Organization identifier associated with the service definition
*/
orgId?: pulumi.Input<string | undefined>;
/**
* 0 means unlimited, value from 0 to 107374182
*/
serviceLimitDown?: pulumi.Input<number | undefined>;
/**
* 0 means unlimited, value from 0 to 107374182
*/
serviceLimitUp?: pulumi.Input<number | undefined>;
/**
* Whether to enable measure SLE
*/
sleEnabled?: pulumi.Input<boolean | undefined>;
/**
* Protocol and port match rules used when `type`==`custom`
*/
specs?: pulumi.Input<pulumi.Input<inputs.org.ServiceSpec>[] | undefined>;
/**
* Whether SSR relaxes TCP state enforcement for this service
*/
ssrRelaxedTcpStateEnforcement?: pulumi.Input<boolean | undefined>;
/**
* Traffic class applied when `trafficType`==`custom`
*/
trafficClass?: pulumi.Input<string | undefined>;
/**
* values from List Traffic Types
*/
trafficType?: pulumi.Input<string | undefined>;
/**
* Matching mode that determines which app, URL, or custom fields are used
*/
type?: pulumi.Input<string | undefined>;
/**
* URL patterns matched by this service when `type`==`urls`
*/
urls?: pulumi.Input<pulumi.Input<string>[] | undefined>;
}
/**
* The set of arguments for constructing a Service resource.
*/
export interface ServiceArgs {
/**
* Custom IPv4 or IPv6 subnets matched by this service when `type`==`custom`
*/
addresses?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* Categories of applications matched by this service when `type`==`appCategories`
*/
appCategories?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* Application subcategories matched by this service when `type`==`appCategories`
*/
appSubcategories?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* Application identifiers matched by this service when `type`==`apps`
*/
apps?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* 0 means unlimited, value from 0 to 107374182
*/
clientLimitDown?: pulumi.Input<number | undefined>;
/**
* 0 means unlimited, value from 0 to 107374182
*/
clientLimitUp?: pulumi.Input<number | undefined>;
/**
* Free-form description of the service definition
*/
description?: pulumi.Input<string | undefined>;
/**
* QoS DSCP value used for custom SSR traffic classification
*/
dscp?: pulumi.Input<string | undefined>;
/**
* Failover behavior for traffic matched by this service
*/
failoverPolicy?: pulumi.Input<string | undefined>;
/**
* Domain hostnames matched by this custom service for web filtering
*/
hostnames?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* Maximum jitter threshold used for SSR uplink selection when `trafficType`==`custom`
*/
maxJitter?: pulumi.Input<string | undefined>;
/**
* Maximum latency threshold used for SSR uplink selection when `trafficType`==`custom`
*/
maxLatency?: pulumi.Input<string | undefined>;
/**
* Maximum packet loss threshold used for SSR uplink selection when `trafficType`==`custom`
*/
maxLoss?: pulumi.Input<string | undefined>;
/**
* Display name of the service definition
*/
name?: pulumi.Input<string | undefined>;
/**
* Organization identifier associated with the service definition
*/
orgId: pulumi.Input<string>;
/**
* 0 means unlimited, value from 0 to 107374182
*/
serviceLimitDown?: pulumi.Input<number | undefined>;
/**
* 0 means unlimited, value from 0 to 107374182
*/
serviceLimitUp?: pulumi.Input<number | undefined>;
/**
* Whether to enable measure SLE
*/
sleEnabled?: pulumi.Input<boolean | undefined>;
/**
* Protocol and port match rules used when `type`==`custom`
*/
specs?: pulumi.Input<pulumi.Input<inputs.org.ServiceSpec>[] | undefined>;
/**
* Whether SSR relaxes TCP state enforcement for this service
*/
ssrRelaxedTcpStateEnforcement?: pulumi.Input<boolean | undefined>;
/**
* Traffic class applied when `trafficType`==`custom`
*/
trafficClass?: pulumi.Input<string | undefined>;
/**
* values from List Traffic Types
*/
trafficType?: pulumi.Input<string | undefined>;
/**
* Matching mode that determines which app, URL, or custom fields are used
*/
type?: pulumi.Input<string | undefined>;
/**
* URL patterns matched by this service when `type`==`urls`
*/
urls?: pulumi.Input<pulumi.Input<string>[] | undefined>;
}
//# sourceMappingURL=service.d.ts.map