Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Scm Provider
  3. API Docs
  4. TrafficSteeringRule
Strata Cloud Manager v0.1.6 published on Wednesday, Oct 16, 2024 by Pulumi
pulumi/pulumi-scm

scm.TrafficSteeringRule

Explore with Pulumi AI

scm logo
Strata Cloud Manager v0.1.6 published on Wednesday, Oct 16, 2024 by Pulumi
pulumi/pulumi-scm

    Retrieves a config item.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as scm from "@pulumi/scm";

const example = new scm.TrafficSteeringRule("example", {folder: "Shared"});

    import pulumi
import pulumi_scm as scm

example = scm.TrafficSteeringRule("example", folder="Shared")

    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.NewTrafficSteeringRule(ctx, "example", &scm.TrafficSteeringRuleArgs{
			Folder: pulumi.String("Shared"),
		})
		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.TrafficSteeringRule("example", new()
    {
        Folder = "Shared",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scm.TrafficSteeringRule;
import com.pulumi.scm.TrafficSteeringRuleArgs;
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 TrafficSteeringRule("example", TrafficSteeringRuleArgs.builder()
            .folder("Shared")
            .build());

    }
}

    resources:
  example:
    type: scm:TrafficSteeringRule
    properties:
      folder: Shared

    Create TrafficSteeringRule Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new TrafficSteeringRule(name: string, args: TrafficSteeringRuleArgs, opts?: CustomResourceOptions);
    @overload
def TrafficSteeringRule(resource_name: str,
                        args: TrafficSteeringRuleArgs,
                        opts: Optional[ResourceOptions] = None)

@overload
def TrafficSteeringRule(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        services: Optional[Sequence[str]] = None,
                        sources: Optional[Sequence[str]] = None,
                        action: Optional[TrafficSteeringRuleActionArgs] = None,
                        categories: Optional[Sequence[str]] = None,
                        destinations: Optional[Sequence[str]] = None,
                        folder: Optional[str] = None,
                        name: Optional[str] = None,
                        source_users: Optional[Sequence[str]] = None)
    func NewTrafficSteeringRule(ctx *Context, name string, args TrafficSteeringRuleArgs, opts ...ResourceOption) (*TrafficSteeringRule, error)
    public TrafficSteeringRule(string name, TrafficSteeringRuleArgs args, CustomResourceOptions? opts = null)
    public TrafficSteeringRule(String name, TrafficSteeringRuleArgs args)
public TrafficSteeringRule(String name, TrafficSteeringRuleArgs args, CustomResourceOptions options)

    type: scm:TrafficSteeringRule
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 TrafficSteeringRuleArgs
    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 TrafficSteeringRuleArgs
    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 TrafficSteeringRuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TrafficSteeringRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TrafficSteeringRuleArgs
    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 trafficSteeringRuleResource = new Scm.TrafficSteeringRule("trafficSteeringRuleResource", new()
{
    Services = new[]
    {
        "string",
    },
    Sources = new[]
    {
        "string",
    },
    Action = new Scm.Inputs.TrafficSteeringRuleActionArgs
    {
        Forward = new Scm.Inputs.TrafficSteeringRuleActionForwardArgs
        {
            Target = "string",
        },
        NoPbf = false,
    },
    Categories = new[]
    {
        "string",
    },
    Destinations = new[]
    {
        "string",
    },
    Folder = "string",
    Name = "string",
    SourceUsers = new[]
    {
        "string",
    },
});

    example, err := scm.NewTrafficSteeringRule(ctx, "trafficSteeringRuleResource", &scm.TrafficSteeringRuleArgs{
	Services: pulumi.StringArray{
		pulumi.String("string"),
	},
	Sources: pulumi.StringArray{
		pulumi.String("string"),
	},
	Action: &scm.TrafficSteeringRuleActionArgs{
		Forward: &scm.TrafficSteeringRuleActionForwardArgs{
			Target: pulumi.String("string"),
		},
		NoPbf: pulumi.Bool(false),
	},
	Categories: pulumi.StringArray{
		pulumi.String("string"),
	},
	Destinations: pulumi.StringArray{
		pulumi.String("string"),
	},
	Folder: pulumi.String("string"),
	Name:   pulumi.String("string"),
	SourceUsers: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var trafficSteeringRuleResource = new TrafficSteeringRule("trafficSteeringRuleResource", TrafficSteeringRuleArgs.builder()
    .services("string")
    .sources("string")
    .action(TrafficSteeringRuleActionArgs.builder()
        .forward(TrafficSteeringRuleActionForwardArgs.builder()
            .target("string")
            .build())
        .noPbf(false)
        .build())
    .categories("string")
    .destinations("string")
    .folder("string")
    .name("string")
    .sourceUsers("string")
    .build());

    traffic_steering_rule_resource = scm.TrafficSteeringRule("trafficSteeringRuleResource",
    services=["string"],
    sources=["string"],
    action={
        "forward": {
            "target": "string",
        },
        "no_pbf": False,
    },
    categories=["string"],
    destinations=["string"],
    folder="string",
    name="string",
    source_users=["string"])

    const trafficSteeringRuleResource = new scm.TrafficSteeringRule("trafficSteeringRuleResource", {
    services: ["string"],
    sources: ["string"],
    action: {
        forward: {
            target: "string",
        },
        noPbf: false,
    },
    categories: ["string"],
    destinations: ["string"],
    folder: "string",
    name: "string",
    sourceUsers: ["string"],
});

    type: scm:TrafficSteeringRule
properties:
    action:
        forward:
            target: string
        noPbf: false
    categories:
        - string
    destinations:
        - string
    folder: string
    name: string
    services:
        - string
    sourceUsers:
        - string
    sources:
        - string

    TrafficSteeringRule 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 TrafficSteeringRule resource accepts the following input properties:

    Services List<string>
    The Service param.
    Sources List<string>
    The Source param.
    Action TrafficSteeringRuleAction
    The Action param.
    Categories List<string>
    The Category param.
    Destinations List<string>
    The Destination param.
    Folder string
    The Folder param. String can either be a specific string("Service Connections") or match this regex: ^[0-9a-zA-Z._\s-]{1,}$. Default: "Service Connections".
    Name string
    The Name param.
    SourceUsers List<string>
    The SourceUser param.
    Services []string
    The Service param.
    Sources []string
    The Source param.
    Action TrafficSteeringRuleActionArgs
    The Action param.
    Categories []string
    The Category param.
    Destinations []string
    The Destination param.
    Folder string
    The Folder param. String can either be a specific string("Service Connections") or match this regex: ^[0-9a-zA-Z._\s-]{1,}$. Default: "Service Connections".
    Name string
    The Name param.
    SourceUsers []string
    The SourceUser param.
    services List<String>
    The Service param.
    sources List<String>
    The Source param.
    action TrafficSteeringRuleAction
    The Action param.
    categories List<String>
    The Category param.
    destinations List<String>
    The Destination param.
    folder String
    The Folder param. String can either be a specific string("Service Connections") or match this regex: ^[0-9a-zA-Z._\s-]{1,}$. Default: "Service Connections".
    name String
    The Name param.
    sourceUsers List<String>
    The SourceUser param.
    services string[]
    The Service param.
    sources string[]
    The Source param.
    action TrafficSteeringRuleAction
    The Action param.
    categories string[]
    The Category param.
    destinations string[]
    The Destination param.
    folder string
    The Folder param. String can either be a specific string("Service Connections") or match this regex: ^[0-9a-zA-Z._\s-]{1,}$. Default: "Service Connections".
    name string
    The Name param.
    sourceUsers string[]
    The SourceUser param.
    services Sequence[str]
    The Service param.
    sources Sequence[str]
    The Source param.
    action TrafficSteeringRuleActionArgs
    The Action param.
    categories Sequence[str]
    The Category param.
    destinations Sequence[str]
    The Destination param.
    folder str
    The Folder param. String can either be a specific string("Service Connections") or match this regex: ^[0-9a-zA-Z._\s-]{1,}$. Default: "Service Connections".
    name str
    The Name param.
    source_users Sequence[str]
    The SourceUser param.
    services List<String>
    The Service param.
    sources List<String>
    The Source param.
    action Property Map
    The Action param.
    categories List<String>
    The Category param.
    destinations List<String>
    The Destination param.
    folder String
    The Folder param. String can either be a specific string("Service Connections") or match this regex: ^[0-9a-zA-Z._\s-]{1,}$. Default: "Service Connections".
    name String
    The Name param.
    sourceUsers List<String>
    The SourceUser param.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the TrafficSteeringRule resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Tfid string
    Id string
    The provider-assigned unique ID for this managed resource.
    Tfid string
    id String
    The provider-assigned unique ID for this managed resource.
    tfid String
    id string
    The provider-assigned unique ID for this managed resource.
    tfid string
    id str
    The provider-assigned unique ID for this managed resource.
    tfid str
    id String
    The provider-assigned unique ID for this managed resource.
    tfid String

    Look up Existing TrafficSteeringRule Resource

    Get an existing TrafficSteeringRule 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?: TrafficSteeringRuleState, opts?: CustomResourceOptions): TrafficSteeringRule
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        action: Optional[TrafficSteeringRuleActionArgs] = None,
        categories: Optional[Sequence[str]] = None,
        destinations: Optional[Sequence[str]] = None,
        folder: Optional[str] = None,
        name: Optional[str] = None,
        services: Optional[Sequence[str]] = None,
        source_users: Optional[Sequence[str]] = None,
        sources: Optional[Sequence[str]] = None,
        tfid: Optional[str] = None) -> TrafficSteeringRule
    func GetTrafficSteeringRule(ctx *Context, name string, id IDInput, state *TrafficSteeringRuleState, opts ...ResourceOption) (*TrafficSteeringRule, error)
    public static TrafficSteeringRule Get(string name, Input<string> id, TrafficSteeringRuleState? state, CustomResourceOptions? opts = null)
    public static TrafficSteeringRule get(String name, Output<String> id, TrafficSteeringRuleState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    The following state arguments are supported:
    Action TrafficSteeringRuleAction
    The Action param.
    Categories List<string>
    The Category param.
    Destinations List<string>
    The Destination param.
    Folder string
    The Folder param. String can either be a specific string("Service Connections") or match this regex: ^[0-9a-zA-Z._\s-]{1,}$. Default: "Service Connections".
    Name string
    The Name param.
    Services List<string>
    The Service param.
    SourceUsers List<string>
    The SourceUser param.
    Sources List<string>
    The Source param.
    Tfid string
    Action TrafficSteeringRuleActionArgs
    The Action param.
    Categories []string
    The Category param.
    Destinations []string
    The Destination param.
    Folder string
    The Folder param. String can either be a specific string("Service Connections") or match this regex: ^[0-9a-zA-Z._\s-]{1,}$. Default: "Service Connections".
    Name string
    The Name param.
    Services []string
    The Service param.
    SourceUsers []string
    The SourceUser param.
    Sources []string
    The Source param.
    Tfid string
    action TrafficSteeringRuleAction
    The Action param.
    categories List<String>
    The Category param.
    destinations List<String>
    The Destination param.
    folder String
    The Folder param. String can either be a specific string("Service Connections") or match this regex: ^[0-9a-zA-Z._\s-]{1,}$. Default: "Service Connections".
    name String
    The Name param.
    services List<String>
    The Service param.
    sourceUsers List<String>
    The SourceUser param.
    sources List<String>
    The Source param.
    tfid String
    action TrafficSteeringRuleAction
    The Action param.
    categories string[]
    The Category param.
    destinations string[]
    The Destination param.
    folder string
    The Folder param. String can either be a specific string("Service Connections") or match this regex: ^[0-9a-zA-Z._\s-]{1,}$. Default: "Service Connections".
    name string
    The Name param.
    services string[]
    The Service param.
    sourceUsers string[]
    The SourceUser param.
    sources string[]
    The Source param.
    tfid string
    action TrafficSteeringRuleActionArgs
    The Action param.
    categories Sequence[str]
    The Category param.
    destinations Sequence[str]
    The Destination param.
    folder str
    The Folder param. String can either be a specific string("Service Connections") or match this regex: ^[0-9a-zA-Z._\s-]{1,}$. Default: "Service Connections".
    name str
    The Name param.
    services Sequence[str]
    The Service param.
    source_users Sequence[str]
    The SourceUser param.
    sources Sequence[str]
    The Source param.
    tfid str
    action Property Map
    The Action param.
    categories List<String>
    The Category param.
    destinations List<String>
    The Destination param.
    folder String
    The Folder param. String can either be a specific string("Service Connections") or match this regex: ^[0-9a-zA-Z._\s-]{1,}$. Default: "Service Connections".
    name String
    The Name param.
    services List<String>
    The Service param.
    sourceUsers List<String>
    The SourceUser param.
    sources List<String>
    The Source param.
    tfid String

    Supporting Types

    TrafficSteeringRuleAction, TrafficSteeringRuleActionArgs

    Forward TrafficSteeringRuleActionForward
    The Forward param. Ensure that only one of the following is specified: forward, no-pbf
    NoPbf bool
    The NoPbf param. Ensure that only one of the following is specified: forward, no-pbf
    Forward TrafficSteeringRuleActionForward
    The Forward param. Ensure that only one of the following is specified: forward, no-pbf
    NoPbf bool
    The NoPbf param. Ensure that only one of the following is specified: forward, no-pbf
    forward TrafficSteeringRuleActionForward
    The Forward param. Ensure that only one of the following is specified: forward, no-pbf
    noPbf Boolean
    The NoPbf param. Ensure that only one of the following is specified: forward, no-pbf
    forward TrafficSteeringRuleActionForward
    The Forward param. Ensure that only one of the following is specified: forward, no-pbf
    noPbf boolean
    The NoPbf param. Ensure that only one of the following is specified: forward, no-pbf
    forward TrafficSteeringRuleActionForward
    The Forward param. Ensure that only one of the following is specified: forward, no-pbf
    no_pbf bool
    The NoPbf param. Ensure that only one of the following is specified: forward, no-pbf
    forward Property Map
    The Forward param. Ensure that only one of the following is specified: forward, no-pbf
    noPbf Boolean
    The NoPbf param. Ensure that only one of the following is specified: forward, no-pbf

    TrafficSteeringRuleActionForward, TrafficSteeringRuleActionForwardArgs

    Target string
    The Target param.
    Target string
    The Target param.
    target String
    The Target param.
    target string
    The Target param.
    target str
    The Target param.
    target String
    The Target param.

    Package Details

    Repository
    scm pulumi/pulumi-scm
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the scm Terraform Provider.
    scm logo
    Strata Cloud Manager v0.1.6 published on Wednesday, Oct 16, 2024 by Pulumi
    pulumi/pulumi-scm