BgpRouting resource
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as scm from "@pulumi/scm";
const example = new scm.BgpRouting("example", {
backboneRouting: "no-asymmetric-routing",
acceptRouteOverSc: true,
addHostRouteToIkePeer: false,
withdrawStaticRoute: true,
outboundRoutesForServices: ["10.0.0.0/9"],
routingPreference: {
"default": {},
},
});
import pulumi
import pulumi_scm as scm
example = scm.BgpRouting("example",
backbone_routing="no-asymmetric-routing",
accept_route_over_sc=True,
add_host_route_to_ike_peer=False,
withdraw_static_route=True,
outbound_routes_for_services=["10.0.0.0/9"],
routing_preference={
"default": {},
})
package main
import (
"github.com/pulumi/pulumi-scm/sdk/go/scm"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := scm.NewBgpRouting(ctx, "example", &scm.BgpRoutingArgs{
BackboneRouting: pulumi.String("no-asymmetric-routing"),
AcceptRouteOverSc: pulumi.Bool(true),
AddHostRouteToIkePeer: pulumi.Bool(false),
WithdrawStaticRoute: pulumi.Bool(true),
OutboundRoutesForServices: pulumi.StringArray{
pulumi.String("10.0.0.0/9"),
},
RoutingPreference: &scm.BgpRoutingRoutingPreferenceArgs{
Default: &scm.BgpRoutingRoutingPreferenceDefaultArgs{},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scm = Pulumi.Scm;
return await Deployment.RunAsync(() =>
{
var example = new Scm.BgpRouting("example", new()
{
BackboneRouting = "no-asymmetric-routing",
AcceptRouteOverSc = true,
AddHostRouteToIkePeer = false,
WithdrawStaticRoute = true,
OutboundRoutesForServices = new[]
{
"10.0.0.0/9",
},
RoutingPreference = new Scm.Inputs.BgpRoutingRoutingPreferenceArgs
{
Default = null,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scm.BgpRouting;
import com.pulumi.scm.BgpRoutingArgs;
import com.pulumi.scm.inputs.BgpRoutingRoutingPreferenceArgs;
import com.pulumi.scm.inputs.BgpRoutingRoutingPreferenceDefaultArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new BgpRouting("example", BgpRoutingArgs.builder()
.backboneRouting("no-asymmetric-routing")
.acceptRouteOverSc(true)
.addHostRouteToIkePeer(false)
.withdrawStaticRoute(true)
.outboundRoutesForServices("10.0.0.0/9")
.routingPreference(BgpRoutingRoutingPreferenceArgs.builder()
.default_(BgpRoutingRoutingPreferenceDefaultArgs.builder()
.build())
.build())
.build());
}
}
resources:
example:
type: scm:BgpRouting
properties:
backboneRouting: no-asymmetric-routing
acceptRouteOverSc: true
addHostRouteToIkePeer: false
withdrawStaticRoute: true
outboundRoutesForServices:
- 10.0.0.0/9
routingPreference:
default: {}
Create BgpRouting Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new BgpRouting(name: string, args?: BgpRoutingArgs, opts?: CustomResourceOptions);@overload
def BgpRouting(resource_name: str,
args: Optional[BgpRoutingArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def BgpRouting(resource_name: str,
opts: Optional[ResourceOptions] = None,
accept_route_over_sc: Optional[bool] = None,
add_host_route_to_ike_peer: Optional[bool] = None,
backbone_routing: Optional[str] = None,
outbound_routes_for_services: Optional[Sequence[str]] = None,
routing_preference: Optional[BgpRoutingRoutingPreferenceArgs] = None,
withdraw_static_route: Optional[bool] = None)func NewBgpRouting(ctx *Context, name string, args *BgpRoutingArgs, opts ...ResourceOption) (*BgpRouting, error)public BgpRouting(string name, BgpRoutingArgs? args = null, CustomResourceOptions? opts = null)
public BgpRouting(String name, BgpRoutingArgs args)
public BgpRouting(String name, BgpRoutingArgs args, CustomResourceOptions options)
type: scm:BgpRouting
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args BgpRoutingArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args BgpRoutingArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args BgpRoutingArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args BgpRoutingArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args BgpRoutingArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var bgpRoutingResource = new Scm.BgpRouting("bgpRoutingResource", new()
{
AcceptRouteOverSc = false,
AddHostRouteToIkePeer = false,
BackboneRouting = "string",
OutboundRoutesForServices = new[]
{
"string",
},
RoutingPreference = new Scm.Inputs.BgpRoutingRoutingPreferenceArgs
{
Default = null,
HotPotatoRouting = null,
},
WithdrawStaticRoute = false,
});
example, err := scm.NewBgpRouting(ctx, "bgpRoutingResource", &scm.BgpRoutingArgs{
AcceptRouteOverSc: pulumi.Bool(false),
AddHostRouteToIkePeer: pulumi.Bool(false),
BackboneRouting: pulumi.String("string"),
OutboundRoutesForServices: pulumi.StringArray{
pulumi.String("string"),
},
RoutingPreference: &scm.BgpRoutingRoutingPreferenceArgs{
Default: &scm.BgpRoutingRoutingPreferenceDefaultArgs{},
HotPotatoRouting: &scm.BgpRoutingRoutingPreferenceHotPotatoRoutingArgs{},
},
WithdrawStaticRoute: pulumi.Bool(false),
})
var bgpRoutingResource = new BgpRouting("bgpRoutingResource", BgpRoutingArgs.builder()
.acceptRouteOverSc(false)
.addHostRouteToIkePeer(false)
.backboneRouting("string")
.outboundRoutesForServices("string")
.routingPreference(BgpRoutingRoutingPreferenceArgs.builder()
.default_(BgpRoutingRoutingPreferenceDefaultArgs.builder()
.build())
.hotPotatoRouting(BgpRoutingRoutingPreferenceHotPotatoRoutingArgs.builder()
.build())
.build())
.withdrawStaticRoute(false)
.build());
bgp_routing_resource = scm.BgpRouting("bgpRoutingResource",
accept_route_over_sc=False,
add_host_route_to_ike_peer=False,
backbone_routing="string",
outbound_routes_for_services=["string"],
routing_preference={
"default": {},
"hot_potato_routing": {},
},
withdraw_static_route=False)
const bgpRoutingResource = new scm.BgpRouting("bgpRoutingResource", {
acceptRouteOverSc: false,
addHostRouteToIkePeer: false,
backboneRouting: "string",
outboundRoutesForServices: ["string"],
routingPreference: {
"default": {},
hotPotatoRouting: {},
},
withdrawStaticRoute: false,
});
type: scm:BgpRouting
properties:
acceptRouteOverSc: false
addHostRouteToIkePeer: false
backboneRouting: string
outboundRoutesForServices:
- string
routingPreference:
default: {}
hotPotatoRouting: {}
withdrawStaticRoute: false
BgpRouting Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The BgpRouting resource accepts the following input properties:
- Accept
Route boolOver Sc - Accept route over s c
- Add
Host boolRoute To Ike Peer - Add host route to ike peer
- Backbone
Routing string - Backbone routing
- Outbound
Routes List<string>For Services - Outbound routes for services
- Routing
Preference BgpRouting Routing Preference - Routing preference
- Withdraw
Static boolRoute - Withdraw static route
- Accept
Route boolOver Sc - Accept route over s c
- Add
Host boolRoute To Ike Peer - Add host route to ike peer
- Backbone
Routing string - Backbone routing
- Outbound
Routes []stringFor Services - Outbound routes for services
- Routing
Preference BgpRouting Routing Preference Args - Routing preference
- Withdraw
Static boolRoute - Withdraw static route
- accept
Route BooleanOver Sc - Accept route over s c
- add
Host BooleanRoute To Ike Peer - Add host route to ike peer
- backbone
Routing String - Backbone routing
- outbound
Routes List<String>For Services - Outbound routes for services
- routing
Preference BgpRouting Routing Preference - Routing preference
- withdraw
Static BooleanRoute - Withdraw static route
- accept
Route booleanOver Sc - Accept route over s c
- add
Host booleanRoute To Ike Peer - Add host route to ike peer
- backbone
Routing string - Backbone routing
- outbound
Routes string[]For Services - Outbound routes for services
- routing
Preference BgpRouting Routing Preference - Routing preference
- withdraw
Static booleanRoute - Withdraw static route
- accept_
route_ boolover_ sc - Accept route over s c
- add_
host_ boolroute_ to_ ike_ peer - Add host route to ike peer
- backbone_
routing str - Backbone routing
- outbound_
routes_ Sequence[str]for_ services - Outbound routes for services
- routing_
preference BgpRouting Routing Preference Args - Routing preference
- withdraw_
static_ boolroute - Withdraw static route
- accept
Route BooleanOver Sc - Accept route over s c
- add
Host BooleanRoute To Ike Peer - Add host route to ike peer
- backbone
Routing String - Backbone routing
- outbound
Routes List<String>For Services - Outbound routes for services
- routing
Preference Property Map - Routing preference
- withdraw
Static BooleanRoute - Withdraw static route
Outputs
All input properties are implicitly available as output properties. Additionally, the BgpRouting resource produces the following output properties:
Look up Existing BgpRouting Resource
Get an existing BgpRouting resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: BgpRoutingState, opts?: CustomResourceOptions): BgpRouting@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
accept_route_over_sc: Optional[bool] = None,
add_host_route_to_ike_peer: Optional[bool] = None,
backbone_routing: Optional[str] = None,
outbound_routes_for_services: Optional[Sequence[str]] = None,
routing_preference: Optional[BgpRoutingRoutingPreferenceArgs] = None,
tfid: Optional[str] = None,
withdraw_static_route: Optional[bool] = None) -> BgpRoutingfunc GetBgpRouting(ctx *Context, name string, id IDInput, state *BgpRoutingState, opts ...ResourceOption) (*BgpRouting, error)public static BgpRouting Get(string name, Input<string> id, BgpRoutingState? state, CustomResourceOptions? opts = null)public static BgpRouting get(String name, Output<String> id, BgpRoutingState state, CustomResourceOptions options)resources: _: type: scm:BgpRouting get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Accept
Route boolOver Sc - Accept route over s c
- Add
Host boolRoute To Ike Peer - Add host route to ike peer
- Backbone
Routing string - Backbone routing
- Outbound
Routes List<string>For Services - Outbound routes for services
- Routing
Preference BgpRouting Routing Preference - Routing preference
- Tfid string
- Withdraw
Static boolRoute - Withdraw static route
- Accept
Route boolOver Sc - Accept route over s c
- Add
Host boolRoute To Ike Peer - Add host route to ike peer
- Backbone
Routing string - Backbone routing
- Outbound
Routes []stringFor Services - Outbound routes for services
- Routing
Preference BgpRouting Routing Preference Args - Routing preference
- Tfid string
- Withdraw
Static boolRoute - Withdraw static route
- accept
Route BooleanOver Sc - Accept route over s c
- add
Host BooleanRoute To Ike Peer - Add host route to ike peer
- backbone
Routing String - Backbone routing
- outbound
Routes List<String>For Services - Outbound routes for services
- routing
Preference BgpRouting Routing Preference - Routing preference
- tfid String
- withdraw
Static BooleanRoute - Withdraw static route
- accept
Route booleanOver Sc - Accept route over s c
- add
Host booleanRoute To Ike Peer - Add host route to ike peer
- backbone
Routing string - Backbone routing
- outbound
Routes string[]For Services - Outbound routes for services
- routing
Preference BgpRouting Routing Preference - Routing preference
- tfid string
- withdraw
Static booleanRoute - Withdraw static route
- accept_
route_ boolover_ sc - Accept route over s c
- add_
host_ boolroute_ to_ ike_ peer - Add host route to ike peer
- backbone_
routing str - Backbone routing
- outbound_
routes_ Sequence[str]for_ services - Outbound routes for services
- routing_
preference BgpRouting Routing Preference Args - Routing preference
- tfid str
- withdraw_
static_ boolroute - Withdraw static route
- accept
Route BooleanOver Sc - Accept route over s c
- add
Host BooleanRoute To Ike Peer - Add host route to ike peer
- backbone
Routing String - Backbone routing
- outbound
Routes List<String>For Services - Outbound routes for services
- routing
Preference Property Map - Routing preference
- tfid String
- withdraw
Static BooleanRoute - Withdraw static route
Supporting Types
BgpRoutingRoutingPreference, BgpRoutingRoutingPreferenceArgs
- Default
Bgp
Routing Routing Preference Default - Default
- Hot
Potato BgpRouting Routing Routing Preference Hot Potato Routing Hot potato routing
ℹ️ Note: You must specify exactly one of
defaultandhot_potato_routing.
- Default
Bgp
Routing Routing Preference Default - Default
- Hot
Potato BgpRouting Routing Routing Preference Hot Potato Routing Hot potato routing
ℹ️ Note: You must specify exactly one of
defaultandhot_potato_routing.
- default_
Bgp
Routing Routing Preference Default - Default
- hot
Potato BgpRouting Routing Routing Preference Hot Potato Routing Hot potato routing
ℹ️ Note: You must specify exactly one of
defaultandhot_potato_routing.
- default
Bgp
Routing Routing Preference Default - Default
- hot
Potato BgpRouting Routing Routing Preference Hot Potato Routing Hot potato routing
ℹ️ Note: You must specify exactly one of
defaultandhot_potato_routing.
- default
Bgp
Routing Routing Preference Default - Default
- hot_
potato_ Bgprouting Routing Routing Preference Hot Potato Routing Hot potato routing
ℹ️ Note: You must specify exactly one of
defaultandhot_potato_routing.
- default Property Map
- Default
- hot
Potato Property MapRouting Hot potato routing
ℹ️ Note: You must specify exactly one of
defaultandhot_potato_routing.
Package Details
- Repository
- scm pulumi/pulumi-scm
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
scmTerraform Provider.
