RouteCommunityList resource
Create RouteCommunityList Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new RouteCommunityList(name: string, args?: RouteCommunityListArgs, opts?: CustomResourceOptions);@overload
def RouteCommunityList(resource_name: str,
args: Optional[RouteCommunityListArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def RouteCommunityList(resource_name: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
device: Optional[str] = None,
folder: Optional[str] = None,
name: Optional[str] = None,
snippet: Optional[str] = None,
type: Optional[RouteCommunityListTypeArgs] = None)func NewRouteCommunityList(ctx *Context, name string, args *RouteCommunityListArgs, opts ...ResourceOption) (*RouteCommunityList, error)public RouteCommunityList(string name, RouteCommunityListArgs? args = null, CustomResourceOptions? opts = null)
public RouteCommunityList(String name, RouteCommunityListArgs args)
public RouteCommunityList(String name, RouteCommunityListArgs args, CustomResourceOptions options)
type: scm:RouteCommunityList
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 RouteCommunityListArgs
- 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 RouteCommunityListArgs
- 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 RouteCommunityListArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args RouteCommunityListArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args RouteCommunityListArgs
- 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 routeCommunityListResource = new Scm.RouteCommunityList("routeCommunityListResource", new()
{
Description = "string",
Device = "string",
Folder = "string",
Name = "string",
Snippet = "string",
Type = new Scm.Inputs.RouteCommunityListTypeArgs
{
Extended = new Scm.Inputs.RouteCommunityListTypeExtendedArgs
{
ExtendedEntries = new[]
{
new Scm.Inputs.RouteCommunityListTypeExtendedExtendedEntryArgs
{
Action = "string",
LcRegexes = new[]
{
"string",
},
Name = 0,
},
},
},
Large = new Scm.Inputs.RouteCommunityListTypeLargeArgs
{
LargeEntries = new[]
{
new Scm.Inputs.RouteCommunityListTypeLargeLargeEntryArgs
{
Action = "string",
LcRegexes = new[]
{
"string",
},
Name = 0,
},
},
},
Regular = new Scm.Inputs.RouteCommunityListTypeRegularArgs
{
RegularEntries = new[]
{
new Scm.Inputs.RouteCommunityListTypeRegularRegularEntryArgs
{
Action = "string",
Communities = new[]
{
"string",
},
Name = 0,
},
},
},
},
});
example, err := scm.NewRouteCommunityList(ctx, "routeCommunityListResource", &scm.RouteCommunityListArgs{
Description: pulumi.String("string"),
Device: pulumi.String("string"),
Folder: pulumi.String("string"),
Name: pulumi.String("string"),
Snippet: pulumi.String("string"),
Type: &scm.RouteCommunityListTypeArgs{
Extended: &scm.RouteCommunityListTypeExtendedArgs{
ExtendedEntries: scm.RouteCommunityListTypeExtendedExtendedEntryArray{
&scm.RouteCommunityListTypeExtendedExtendedEntryArgs{
Action: pulumi.String("string"),
LcRegexes: pulumi.StringArray{
pulumi.String("string"),
},
Name: pulumi.Int(0),
},
},
},
Large: &scm.RouteCommunityListTypeLargeArgs{
LargeEntries: scm.RouteCommunityListTypeLargeLargeEntryArray{
&scm.RouteCommunityListTypeLargeLargeEntryArgs{
Action: pulumi.String("string"),
LcRegexes: pulumi.StringArray{
pulumi.String("string"),
},
Name: pulumi.Int(0),
},
},
},
Regular: &scm.RouteCommunityListTypeRegularArgs{
RegularEntries: scm.RouteCommunityListTypeRegularRegularEntryArray{
&scm.RouteCommunityListTypeRegularRegularEntryArgs{
Action: pulumi.String("string"),
Communities: pulumi.StringArray{
pulumi.String("string"),
},
Name: pulumi.Int(0),
},
},
},
},
})
var routeCommunityListResource = new RouteCommunityList("routeCommunityListResource", RouteCommunityListArgs.builder()
.description("string")
.device("string")
.folder("string")
.name("string")
.snippet("string")
.type(RouteCommunityListTypeArgs.builder()
.extended(RouteCommunityListTypeExtendedArgs.builder()
.extendedEntries(RouteCommunityListTypeExtendedExtendedEntryArgs.builder()
.action("string")
.lcRegexes("string")
.name(0)
.build())
.build())
.large(RouteCommunityListTypeLargeArgs.builder()
.largeEntries(RouteCommunityListTypeLargeLargeEntryArgs.builder()
.action("string")
.lcRegexes("string")
.name(0)
.build())
.build())
.regular(RouteCommunityListTypeRegularArgs.builder()
.regularEntries(RouteCommunityListTypeRegularRegularEntryArgs.builder()
.action("string")
.communities("string")
.name(0)
.build())
.build())
.build())
.build());
route_community_list_resource = scm.RouteCommunityList("routeCommunityListResource",
description="string",
device="string",
folder="string",
name="string",
snippet="string",
type={
"extended": {
"extended_entries": [{
"action": "string",
"lc_regexes": ["string"],
"name": 0,
}],
},
"large": {
"large_entries": [{
"action": "string",
"lc_regexes": ["string"],
"name": 0,
}],
},
"regular": {
"regular_entries": [{
"action": "string",
"communities": ["string"],
"name": 0,
}],
},
})
const routeCommunityListResource = new scm.RouteCommunityList("routeCommunityListResource", {
description: "string",
device: "string",
folder: "string",
name: "string",
snippet: "string",
type: {
extended: {
extendedEntries: [{
action: "string",
lcRegexes: ["string"],
name: 0,
}],
},
large: {
largeEntries: [{
action: "string",
lcRegexes: ["string"],
name: 0,
}],
},
regular: {
regularEntries: [{
action: "string",
communities: ["string"],
name: 0,
}],
},
},
});
type: scm:RouteCommunityList
properties:
description: string
device: string
folder: string
name: string
snippet: string
type:
extended:
extendedEntries:
- action: string
lcRegexes:
- string
name: 0
large:
largeEntries:
- action: string
lcRegexes:
- string
name: 0
regular:
regularEntries:
- action: string
communities:
- string
name: 0
RouteCommunityList 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 RouteCommunityList resource accepts the following input properties:
- Description string
- Description
- Device string
- The device in which the resource is defined
- Folder string
- The folder in which the resource is defined
- Name string
- Route community list name
- Snippet string
- The snippet in which the resource is defined
- Type
Route
Community List Type - Type
- Description string
- Description
- Device string
- The device in which the resource is defined
- Folder string
- The folder in which the resource is defined
- Name string
- Route community list name
- Snippet string
- The snippet in which the resource is defined
- Type
Route
Community List Type Args - Type
- description String
- Description
- device String
- The device in which the resource is defined
- folder String
- The folder in which the resource is defined
- name String
- Route community list name
- snippet String
- The snippet in which the resource is defined
- type
Route
Community List Type - Type
- description string
- Description
- device string
- The device in which the resource is defined
- folder string
- The folder in which the resource is defined
- name string
- Route community list name
- snippet string
- The snippet in which the resource is defined
- type
Route
Community List Type - Type
- description str
- Description
- device str
- The device in which the resource is defined
- folder str
- The folder in which the resource is defined
- name str
- Route community list name
- snippet str
- The snippet in which the resource is defined
- type
Route
Community List Type Args - Type
- description String
- Description
- device String
- The device in which the resource is defined
- folder String
- The folder in which the resource is defined
- name String
- Route community list name
- snippet String
- The snippet in which the resource is defined
- type Property Map
- Type
Outputs
All input properties are implicitly available as output properties. Additionally, the RouteCommunityList resource produces the following output properties:
Look up Existing RouteCommunityList Resource
Get an existing RouteCommunityList 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?: RouteCommunityListState, opts?: CustomResourceOptions): RouteCommunityList@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
device: Optional[str] = None,
folder: Optional[str] = None,
name: Optional[str] = None,
snippet: Optional[str] = None,
tfid: Optional[str] = None,
type: Optional[RouteCommunityListTypeArgs] = None) -> RouteCommunityListfunc GetRouteCommunityList(ctx *Context, name string, id IDInput, state *RouteCommunityListState, opts ...ResourceOption) (*RouteCommunityList, error)public static RouteCommunityList Get(string name, Input<string> id, RouteCommunityListState? state, CustomResourceOptions? opts = null)public static RouteCommunityList get(String name, Output<String> id, RouteCommunityListState state, CustomResourceOptions options)resources: _: type: scm:RouteCommunityList 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.
- Description string
- Description
- Device string
- The device in which the resource is defined
- Folder string
- The folder in which the resource is defined
- Name string
- Route community list name
- Snippet string
- The snippet in which the resource is defined
- Tfid string
- Type
Route
Community List Type - Type
- Description string
- Description
- Device string
- The device in which the resource is defined
- Folder string
- The folder in which the resource is defined
- Name string
- Route community list name
- Snippet string
- The snippet in which the resource is defined
- Tfid string
- Type
Route
Community List Type Args - Type
- description String
- Description
- device String
- The device in which the resource is defined
- folder String
- The folder in which the resource is defined
- name String
- Route community list name
- snippet String
- The snippet in which the resource is defined
- tfid String
- type
Route
Community List Type - Type
- description string
- Description
- device string
- The device in which the resource is defined
- folder string
- The folder in which the resource is defined
- name string
- Route community list name
- snippet string
- The snippet in which the resource is defined
- tfid string
- type
Route
Community List Type - Type
- description str
- Description
- device str
- The device in which the resource is defined
- folder str
- The folder in which the resource is defined
- name str
- Route community list name
- snippet str
- The snippet in which the resource is defined
- tfid str
- type
Route
Community List Type Args - Type
- description String
- Description
- device String
- The device in which the resource is defined
- folder String
- The folder in which the resource is defined
- name String
- Route community list name
- snippet String
- The snippet in which the resource is defined
- tfid String
- type Property Map
- Type
Supporting Types
RouteCommunityListType, RouteCommunityListTypeArgs
- extended Property Map
- Extended
- large Property Map
- Large
- regular Property Map
- Regular
RouteCommunityListTypeExtended, RouteCommunityListTypeExtendedArgs
- Extended
Entries List<RouteCommunity List Type Extended Extended Entry> - Extended community lists
- Extended
Entries []RouteCommunity List Type Extended Extended Entry - Extended community lists
- extended
Entries List<RouteCommunity List Type Extended Extended Entry> - Extended community lists
- extended
Entries RouteCommunity List Type Extended Extended Entry[] - Extended community lists
- extended_
entries Sequence[RouteCommunity List Type Extended Extended Entry] - Extended community lists
- extended
Entries List<Property Map> - Extended community lists
RouteCommunityListTypeExtendedExtendedEntry, RouteCommunityListTypeExtendedExtendedEntryArgs
- action str
- Action
- lc_
regexes Sequence[str] - Extended community regular expression
- name int
- Sequence number
RouteCommunityListTypeLarge, RouteCommunityListTypeLargeArgs
- Large
Entries List<RouteCommunity List Type Large Large Entry> - Large community lists
- Large
Entries []RouteCommunity List Type Large Large Entry - Large community lists
- large
Entries List<RouteCommunity List Type Large Large Entry> - Large community lists
- large
Entries RouteCommunity List Type Large Large Entry[] - Large community lists
- large_
entries Sequence[RouteCommunity List Type Large Large Entry] - Large community lists
- large
Entries List<Property Map> - Large community lists
RouteCommunityListTypeLargeLargeEntry, RouteCommunityListTypeLargeLargeEntryArgs
- action str
- Action
- lc_
regexes Sequence[str] - Large community regular expression
- name int
- Sequence number
RouteCommunityListTypeRegular, RouteCommunityListTypeRegularArgs
- Regular
Entries List<RouteCommunity List Type Regular Regular Entry> - Regular community lists
- Regular
Entries []RouteCommunity List Type Regular Regular Entry - Regular community lists
- regular
Entries List<RouteCommunity List Type Regular Regular Entry> - Regular community lists
- regular
Entries RouteCommunity List Type Regular Regular Entry[] - Regular community lists
- regular_
entries Sequence[RouteCommunity List Type Regular Regular Entry] - Regular community lists
- regular
Entries List<Property Map> - Regular community lists
RouteCommunityListTypeRegularRegularEntry, RouteCommunityListTypeRegularRegularEntryArgs
- Action string
- Action
- Communities List<string>
- Communities
- Name int
- Sequence number
- Action string
- Action
- Communities []string
- Communities
- Name int
- Sequence number
- action String
- Action
- communities List<String>
- Communities
- name Integer
- Sequence number
- action string
- Action
- communities string[]
- Communities
- name number
- Sequence number
- action str
- Action
- communities Sequence[str]
- Communities
- name int
- Sequence number
- action String
- Action
- communities List<String>
- Communities
- name Number
- Sequence number
Package Details
- Repository
- scm pulumi/pulumi-scm
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
scmTerraform Provider.
