SdwanRule resource
Create SdwanRule Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new SdwanRule(name: string, args: SdwanRuleArgs, opts?: CustomResourceOptions);@overload
def SdwanRule(resource_name: str,
args: SdwanRuleArgs,
opts: Optional[ResourceOptions] = None)
@overload
def SdwanRule(resource_name: str,
opts: Optional[ResourceOptions] = None,
path_quality_profile: Optional[str] = None,
applications: Optional[Sequence[str]] = None,
tos: Optional[Sequence[str]] = None,
destinations: Optional[Sequence[str]] = None,
sources: Optional[Sequence[str]] = None,
action: Optional[SdwanRuleActionArgs] = None,
source_users: Optional[Sequence[str]] = None,
services: Optional[Sequence[str]] = None,
froms: Optional[Sequence[str]] = None,
position: Optional[str] = None,
disabled: Optional[bool] = None,
negate_source: Optional[bool] = None,
negate_destination: Optional[bool] = None,
name: Optional[str] = None,
saas_quality_profile: Optional[str] = None,
folder: Optional[str] = None,
snippet: Optional[str] = None,
error_correction_profile: Optional[str] = None,
device: Optional[str] = None,
tags: Optional[Sequence[str]] = None,
description: Optional[str] = None)func NewSdwanRule(ctx *Context, name string, args SdwanRuleArgs, opts ...ResourceOption) (*SdwanRule, error)public SdwanRule(string name, SdwanRuleArgs args, CustomResourceOptions? opts = null)
public SdwanRule(String name, SdwanRuleArgs args)
public SdwanRule(String name, SdwanRuleArgs args, CustomResourceOptions options)
type: scm:SdwanRule
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 SdwanRuleArgs
- 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 SdwanRuleArgs
- 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 SdwanRuleArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SdwanRuleArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SdwanRuleArgs
- 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 sdwanRuleResource = new Scm.SdwanRule("sdwanRuleResource", new()
{
PathQualityProfile = "string",
Applications = new[]
{
"string",
},
Tos = new[]
{
"string",
},
Destinations = new[]
{
"string",
},
Sources = new[]
{
"string",
},
Action = new Scm.Inputs.SdwanRuleActionArgs
{
TrafficDistributionProfile = "string",
},
SourceUsers = new[]
{
"string",
},
Services = new[]
{
"string",
},
Froms = new[]
{
"string",
},
Position = "string",
Disabled = false,
NegateSource = false,
NegateDestination = false,
Name = "string",
SaasQualityProfile = "string",
Folder = "string",
Snippet = "string",
ErrorCorrectionProfile = "string",
Device = "string",
Tags = new[]
{
"string",
},
Description = "string",
});
example, err := scm.NewSdwanRule(ctx, "sdwanRuleResource", &scm.SdwanRuleArgs{
PathQualityProfile: pulumi.String("string"),
Applications: pulumi.StringArray{
pulumi.String("string"),
},
Tos: pulumi.StringArray{
pulumi.String("string"),
},
Destinations: pulumi.StringArray{
pulumi.String("string"),
},
Sources: pulumi.StringArray{
pulumi.String("string"),
},
Action: &scm.SdwanRuleActionArgs{
TrafficDistributionProfile: pulumi.String("string"),
},
SourceUsers: pulumi.StringArray{
pulumi.String("string"),
},
Services: pulumi.StringArray{
pulumi.String("string"),
},
Froms: pulumi.StringArray{
pulumi.String("string"),
},
Position: pulumi.String("string"),
Disabled: pulumi.Bool(false),
NegateSource: pulumi.Bool(false),
NegateDestination: pulumi.Bool(false),
Name: pulumi.String("string"),
SaasQualityProfile: pulumi.String("string"),
Folder: pulumi.String("string"),
Snippet: pulumi.String("string"),
ErrorCorrectionProfile: pulumi.String("string"),
Device: pulumi.String("string"),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
Description: pulumi.String("string"),
})
var sdwanRuleResource = new SdwanRule("sdwanRuleResource", SdwanRuleArgs.builder()
.pathQualityProfile("string")
.applications("string")
.tos("string")
.destinations("string")
.sources("string")
.action(SdwanRuleActionArgs.builder()
.trafficDistributionProfile("string")
.build())
.sourceUsers("string")
.services("string")
.froms("string")
.position("string")
.disabled(false)
.negateSource(false)
.negateDestination(false)
.name("string")
.saasQualityProfile("string")
.folder("string")
.snippet("string")
.errorCorrectionProfile("string")
.device("string")
.tags("string")
.description("string")
.build());
sdwan_rule_resource = scm.SdwanRule("sdwanRuleResource",
path_quality_profile="string",
applications=["string"],
tos=["string"],
destinations=["string"],
sources=["string"],
action={
"traffic_distribution_profile": "string",
},
source_users=["string"],
services=["string"],
froms=["string"],
position="string",
disabled=False,
negate_source=False,
negate_destination=False,
name="string",
saas_quality_profile="string",
folder="string",
snippet="string",
error_correction_profile="string",
device="string",
tags=["string"],
description="string")
const sdwanRuleResource = new scm.SdwanRule("sdwanRuleResource", {
pathQualityProfile: "string",
applications: ["string"],
tos: ["string"],
destinations: ["string"],
sources: ["string"],
action: {
trafficDistributionProfile: "string",
},
sourceUsers: ["string"],
services: ["string"],
froms: ["string"],
position: "string",
disabled: false,
negateSource: false,
negateDestination: false,
name: "string",
saasQualityProfile: "string",
folder: "string",
snippet: "string",
errorCorrectionProfile: "string",
device: "string",
tags: ["string"],
description: "string",
});
type: scm:SdwanRule
properties:
action:
trafficDistributionProfile: string
applications:
- string
description: string
destinations:
- string
device: string
disabled: false
errorCorrectionProfile: string
folder: string
froms:
- string
name: string
negateDestination: false
negateSource: false
pathQualityProfile: string
position: string
saasQualityProfile: string
services:
- string
snippet: string
sourceUsers:
- string
sources:
- string
tags:
- string
tos:
- string
SdwanRule 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 SdwanRule resource accepts the following input properties:
- Action
Sdwan
Rule Action - Action
- Applications List<string>
- List of applications
- Destinations List<string>
- List of destination addresses
- Froms List<string>
- List of source zones
- Path
Quality stringProfile - Path quality profile
- Position string
- Rule postion relative to device rules
- Services List<string>
- List of services
- Source
Users List<string> - List of source users
- Sources List<string>
- List of source addresses
- Tos List<string>
- List of destination zones
- Description string
- Rule description
- Device string
- The device in which the resource is defined
- Disabled bool
- Disable rule?
- Error
Correction stringProfile - Error correction profile
- Folder string
- The folder in which the resource is defined
- Name string
- Rule name
- Negate
Destination bool - Negate destination address(es)?
- Negate
Source bool - Negate source address(es)?
- Saas
Quality stringProfile - SaaS quality profile
- Snippet string
- The snippet in which the resource is defined
- List<string>
- List of tags
- Action
Sdwan
Rule Action Args - Action
- Applications []string
- List of applications
- Destinations []string
- List of destination addresses
- Froms []string
- List of source zones
- Path
Quality stringProfile - Path quality profile
- Position string
- Rule postion relative to device rules
- Services []string
- List of services
- Source
Users []string - List of source users
- Sources []string
- List of source addresses
- Tos []string
- List of destination zones
- Description string
- Rule description
- Device string
- The device in which the resource is defined
- Disabled bool
- Disable rule?
- Error
Correction stringProfile - Error correction profile
- Folder string
- The folder in which the resource is defined
- Name string
- Rule name
- Negate
Destination bool - Negate destination address(es)?
- Negate
Source bool - Negate source address(es)?
- Saas
Quality stringProfile - SaaS quality profile
- Snippet string
- The snippet in which the resource is defined
- []string
- List of tags
- action
Sdwan
Rule Action - Action
- applications List<String>
- List of applications
- destinations List<String>
- List of destination addresses
- froms List<String>
- List of source zones
- path
Quality StringProfile - Path quality profile
- position String
- Rule postion relative to device rules
- services List<String>
- List of services
- source
Users List<String> - List of source users
- sources List<String>
- List of source addresses
- tos List<String>
- List of destination zones
- description String
- Rule description
- device String
- The device in which the resource is defined
- disabled Boolean
- Disable rule?
- error
Correction StringProfile - Error correction profile
- folder String
- The folder in which the resource is defined
- name String
- Rule name
- negate
Destination Boolean - Negate destination address(es)?
- negate
Source Boolean - Negate source address(es)?
- saas
Quality StringProfile - SaaS quality profile
- snippet String
- The snippet in which the resource is defined
- List<String>
- List of tags
- action
Sdwan
Rule Action - Action
- applications string[]
- List of applications
- destinations string[]
- List of destination addresses
- froms string[]
- List of source zones
- path
Quality stringProfile - Path quality profile
- position string
- Rule postion relative to device rules
- services string[]
- List of services
- source
Users string[] - List of source users
- sources string[]
- List of source addresses
- tos string[]
- List of destination zones
- description string
- Rule description
- device string
- The device in which the resource is defined
- disabled boolean
- Disable rule?
- error
Correction stringProfile - Error correction profile
- folder string
- The folder in which the resource is defined
- name string
- Rule name
- negate
Destination boolean - Negate destination address(es)?
- negate
Source boolean - Negate source address(es)?
- saas
Quality stringProfile - SaaS quality profile
- snippet string
- The snippet in which the resource is defined
- string[]
- List of tags
- action
Sdwan
Rule Action Args - Action
- applications Sequence[str]
- List of applications
- destinations Sequence[str]
- List of destination addresses
- froms Sequence[str]
- List of source zones
- path_
quality_ strprofile - Path quality profile
- position str
- Rule postion relative to device rules
- services Sequence[str]
- List of services
- source_
users Sequence[str] - List of source users
- sources Sequence[str]
- List of source addresses
- tos Sequence[str]
- List of destination zones
- description str
- Rule description
- device str
- The device in which the resource is defined
- disabled bool
- Disable rule?
- error_
correction_ strprofile - Error correction profile
- folder str
- The folder in which the resource is defined
- name str
- Rule name
- negate_
destination bool - Negate destination address(es)?
- negate_
source bool - Negate source address(es)?
- saas_
quality_ strprofile - SaaS quality profile
- snippet str
- The snippet in which the resource is defined
- Sequence[str]
- List of tags
- action Property Map
- Action
- applications List<String>
- List of applications
- destinations List<String>
- List of destination addresses
- froms List<String>
- List of source zones
- path
Quality StringProfile - Path quality profile
- position String
- Rule postion relative to device rules
- services List<String>
- List of services
- source
Users List<String> - List of source users
- sources List<String>
- List of source addresses
- tos List<String>
- List of destination zones
- description String
- Rule description
- device String
- The device in which the resource is defined
- disabled Boolean
- Disable rule?
- error
Correction StringProfile - Error correction profile
- folder String
- The folder in which the resource is defined
- name String
- Rule name
- negate
Destination Boolean - Negate destination address(es)?
- negate
Source Boolean - Negate source address(es)?
- saas
Quality StringProfile - SaaS quality profile
- snippet String
- The snippet in which the resource is defined
- List<String>
- List of tags
Outputs
All input properties are implicitly available as output properties. Additionally, the SdwanRule resource produces the following output properties:
Look up Existing SdwanRule Resource
Get an existing SdwanRule 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?: SdwanRuleState, opts?: CustomResourceOptions): SdwanRule@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
action: Optional[SdwanRuleActionArgs] = None,
applications: Optional[Sequence[str]] = None,
description: Optional[str] = None,
destinations: Optional[Sequence[str]] = None,
device: Optional[str] = None,
disabled: Optional[bool] = None,
error_correction_profile: Optional[str] = None,
folder: Optional[str] = None,
froms: Optional[Sequence[str]] = None,
name: Optional[str] = None,
negate_destination: Optional[bool] = None,
negate_source: Optional[bool] = None,
path_quality_profile: Optional[str] = None,
position: Optional[str] = None,
saas_quality_profile: Optional[str] = None,
services: Optional[Sequence[str]] = None,
snippet: Optional[str] = None,
source_users: Optional[Sequence[str]] = None,
sources: Optional[Sequence[str]] = None,
tags: Optional[Sequence[str]] = None,
tfid: Optional[str] = None,
tos: Optional[Sequence[str]] = None) -> SdwanRulefunc GetSdwanRule(ctx *Context, name string, id IDInput, state *SdwanRuleState, opts ...ResourceOption) (*SdwanRule, error)public static SdwanRule Get(string name, Input<string> id, SdwanRuleState? state, CustomResourceOptions? opts = null)public static SdwanRule get(String name, Output<String> id, SdwanRuleState state, CustomResourceOptions options)resources: _: type: scm:SdwanRule 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.
- Action
Sdwan
Rule Action - Action
- Applications List<string>
- List of applications
- Description string
- Rule description
- Destinations List<string>
- List of destination addresses
- Device string
- The device in which the resource is defined
- Disabled bool
- Disable rule?
- Error
Correction stringProfile - Error correction profile
- Folder string
- The folder in which the resource is defined
- Froms List<string>
- List of source zones
- Name string
- Rule name
- Negate
Destination bool - Negate destination address(es)?
- Negate
Source bool - Negate source address(es)?
- Path
Quality stringProfile - Path quality profile
- Position string
- Rule postion relative to device rules
- Saas
Quality stringProfile - SaaS quality profile
- Services List<string>
- List of services
- Snippet string
- The snippet in which the resource is defined
- Source
Users List<string> - List of source users
- Sources List<string>
- List of source addresses
- List<string>
- List of tags
- Tfid string
- Tos List<string>
- List of destination zones
- Action
Sdwan
Rule Action Args - Action
- Applications []string
- List of applications
- Description string
- Rule description
- Destinations []string
- List of destination addresses
- Device string
- The device in which the resource is defined
- Disabled bool
- Disable rule?
- Error
Correction stringProfile - Error correction profile
- Folder string
- The folder in which the resource is defined
- Froms []string
- List of source zones
- Name string
- Rule name
- Negate
Destination bool - Negate destination address(es)?
- Negate
Source bool - Negate source address(es)?
- Path
Quality stringProfile - Path quality profile
- Position string
- Rule postion relative to device rules
- Saas
Quality stringProfile - SaaS quality profile
- Services []string
- List of services
- Snippet string
- The snippet in which the resource is defined
- Source
Users []string - List of source users
- Sources []string
- List of source addresses
- []string
- List of tags
- Tfid string
- Tos []string
- List of destination zones
- action
Sdwan
Rule Action - Action
- applications List<String>
- List of applications
- description String
- Rule description
- destinations List<String>
- List of destination addresses
- device String
- The device in which the resource is defined
- disabled Boolean
- Disable rule?
- error
Correction StringProfile - Error correction profile
- folder String
- The folder in which the resource is defined
- froms List<String>
- List of source zones
- name String
- Rule name
- negate
Destination Boolean - Negate destination address(es)?
- negate
Source Boolean - Negate source address(es)?
- path
Quality StringProfile - Path quality profile
- position String
- Rule postion relative to device rules
- saas
Quality StringProfile - SaaS quality profile
- services List<String>
- List of services
- snippet String
- The snippet in which the resource is defined
- source
Users List<String> - List of source users
- sources List<String>
- List of source addresses
- List<String>
- List of tags
- tfid String
- tos List<String>
- List of destination zones
- action
Sdwan
Rule Action - Action
- applications string[]
- List of applications
- description string
- Rule description
- destinations string[]
- List of destination addresses
- device string
- The device in which the resource is defined
- disabled boolean
- Disable rule?
- error
Correction stringProfile - Error correction profile
- folder string
- The folder in which the resource is defined
- froms string[]
- List of source zones
- name string
- Rule name
- negate
Destination boolean - Negate destination address(es)?
- negate
Source boolean - Negate source address(es)?
- path
Quality stringProfile - Path quality profile
- position string
- Rule postion relative to device rules
- saas
Quality stringProfile - SaaS quality profile
- services string[]
- List of services
- snippet string
- The snippet in which the resource is defined
- source
Users string[] - List of source users
- sources string[]
- List of source addresses
- string[]
- List of tags
- tfid string
- tos string[]
- List of destination zones
- action
Sdwan
Rule Action Args - Action
- applications Sequence[str]
- List of applications
- description str
- Rule description
- destinations Sequence[str]
- List of destination addresses
- device str
- The device in which the resource is defined
- disabled bool
- Disable rule?
- error_
correction_ strprofile - Error correction profile
- folder str
- The folder in which the resource is defined
- froms Sequence[str]
- List of source zones
- name str
- Rule name
- negate_
destination bool - Negate destination address(es)?
- negate_
source bool - Negate source address(es)?
- path_
quality_ strprofile - Path quality profile
- position str
- Rule postion relative to device rules
- saas_
quality_ strprofile - SaaS quality profile
- services Sequence[str]
- List of services
- snippet str
- The snippet in which the resource is defined
- source_
users Sequence[str] - List of source users
- sources Sequence[str]
- List of source addresses
- Sequence[str]
- List of tags
- tfid str
- tos Sequence[str]
- List of destination zones
- action Property Map
- Action
- applications List<String>
- List of applications
- description String
- Rule description
- destinations List<String>
- List of destination addresses
- device String
- The device in which the resource is defined
- disabled Boolean
- Disable rule?
- error
Correction StringProfile - Error correction profile
- folder String
- The folder in which the resource is defined
- froms List<String>
- List of source zones
- name String
- Rule name
- negate
Destination Boolean - Negate destination address(es)?
- negate
Source Boolean - Negate source address(es)?
- path
Quality StringProfile - Path quality profile
- position String
- Rule postion relative to device rules
- saas
Quality StringProfile - SaaS quality profile
- services List<String>
- List of services
- snippet String
- The snippet in which the resource is defined
- source
Users List<String> - List of source users
- sources List<String>
- List of source addresses
- List<String>
- List of tags
- tfid String
- tos List<String>
- List of destination zones
Supporting Types
SdwanRuleAction, SdwanRuleActionArgs
- Traffic
Distribution stringProfile - Traffic dstribution profile
- Traffic
Distribution stringProfile - Traffic dstribution profile
- traffic
Distribution StringProfile - Traffic dstribution profile
- traffic
Distribution stringProfile - Traffic dstribution profile
- traffic_
distribution_ strprofile - Traffic dstribution profile
- traffic
Distribution StringProfile - Traffic dstribution profile
Package Details
- Repository
- scm pulumi/pulumi-scm
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
scmTerraform Provider.
