@pulumi/scm
Version:
A Pulumi package for managing resources on Strata Cloud Manager.. Based on terraform-provider-scm: version v0.2.1
181 lines (180 loc) • 5.59 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* BgpRouteMap resource
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scm from "@pulumi/scm";
*
* //
* // Creates various resources used for subsequent examples
* //
* const scmRoutePrefixList = new scm.RoutePrefixList("scm_route_prefix_list", {
* folder: "ngfw-shared",
* name: "scm_bgp_prefix_list",
* description: "Managed by Pulumi",
* type: {
* ipv4: {
* ipv4Entries: [{
* name: 10,
* action: "permit",
* prefix: {
* greaterThanOrEqual: 24,
* network: "198.18.1.0/24",
* },
* }],
* },
* },
* });
* //
* // Creates a bgp route map that sets no-export community for traffic matching prefix-list
* // Requires: scm_bgp_prefix_list
* //
* const scmBgpRouteMap = new scm.BgpRouteMap("scm_bgp_route_map", {
* folder: "ngfw-shared",
* name: "scm_bgp_route_map",
* description: "Managed by Pulumi",
* routeMaps: [{
* name: 10,
* description: "No Export",
* match: {
* ipv4: {
* address: {
* prefixList: "scm_bgp_prefix_list",
* },
* },
* },
* set: {
* regularCommunity: ["no-export"],
* },
* }],
* }, {
* dependsOn: [scmRoutePrefixList],
* });
* ```
*/
export declare class BgpRouteMap extends pulumi.CustomResource {
/**
* Get an existing BgpRouteMap 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?: BgpRouteMapState, opts?: pulumi.CustomResourceOptions): BgpRouteMap;
/**
* Returns true if the given object is an instance of BgpRouteMap. 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 BgpRouteMap;
/**
* Description
*/
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>;
/**
* Name
*/
readonly name: pulumi.Output<string>;
/**
* Route map
*/
readonly routeMaps: pulumi.Output<outputs.BgpRouteMapRouteMap[] | undefined>;
/**
* 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 BgpRouteMap 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?: BgpRouteMapArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering BgpRouteMap resources.
*/
export interface BgpRouteMapState {
/**
* Description
*/
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>;
/**
* Name
*/
name?: pulumi.Input<string>;
/**
* Route map
*/
routeMaps?: pulumi.Input<pulumi.Input<inputs.BgpRouteMapRouteMap>[]>;
/**
* 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 BgpRouteMap resource.
*/
export interface BgpRouteMapArgs {
/**
* Description
*/
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>;
/**
* Name
*/
name?: pulumi.Input<string>;
/**
* Route map
*/
routeMaps?: pulumi.Input<pulumi.Input<inputs.BgpRouteMapRouteMap>[]>;
/**
* The snippet in which the resource is defined
*
* > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
*/
snippet?: pulumi.Input<string>;
}