Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Strata Cloud Manager Provider
  3. API Docs
  4. AddressGroup
Strata Cloud Manager v0.3.1 published on Thursday, Mar 13, 2025 by Pulumi
pulumi/pulumi-scm

scm.AddressGroup

Explore with Pulumi AI

Strata Cloud Manager v0.3.1 published on Thursday, Mar 13, 2025 by Pulumi
pulumi/pulumi-scm

Retrieves a config item.

Example Usage

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

const x = new scm.AddressObject("x", {
    folder: "Shared",
    name: "foo",
    description: "Made by Pulumi",
    fqdn: "www.example.com",
});
const example = new scm.AddressGroup("example", {
    folder: "Shared",
    name: "example",
    staticLists: [x.name],
});
Copy
import pulumi
import pulumi_scm as scm

x = scm.AddressObject("x",
    folder="Shared",
    name="foo",
    description="Made by Pulumi",
    fqdn="www.example.com")
example = scm.AddressGroup("example",
    folder="Shared",
    name="example",
    static_lists=[x.name])
Copy
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 {
		x, err := scm.NewAddressObject(ctx, "x", &scm.AddressObjectArgs{
			Folder:      pulumi.String("Shared"),
			Name:        pulumi.String("foo"),
			Description: pulumi.String("Made by Pulumi"),
			Fqdn:        pulumi.String("www.example.com"),
		})
		if err != nil {
			return err
		}
		_, err = scm.NewAddressGroup(ctx, "example", &scm.AddressGroupArgs{
			Folder: pulumi.String("Shared"),
			Name:   pulumi.String("example"),
			StaticLists: pulumi.StringArray{
				x.Name,
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scm = Pulumi.Scm;

return await Deployment.RunAsync(() => 
{
    var x = new Scm.AddressObject("x", new()
    {
        Folder = "Shared",
        Name = "foo",
        Description = "Made by Pulumi",
        Fqdn = "www.example.com",
    });

    var example = new Scm.AddressGroup("example", new()
    {
        Folder = "Shared",
        Name = "example",
        StaticLists = new[]
        {
            x.Name,
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scm.AddressObject;
import com.pulumi.scm.AddressObjectArgs;
import com.pulumi.scm.AddressGroup;
import com.pulumi.scm.AddressGroupArgs;
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 x = new AddressObject("x", AddressObjectArgs.builder()
            .folder("Shared")
            .name("foo")
            .description("Made by Pulumi")
            .fqdn("www.example.com")
            .build());

        var example = new AddressGroup("example", AddressGroupArgs.builder()
            .folder("Shared")
            .name("example")
            .staticLists(x.name())
            .build());

    }
}
Copy
resources:
  example:
    type: scm:AddressGroup
    properties:
      folder: Shared
      name: example
      staticLists:
        - ${x.name}
  x:
    type: scm:AddressObject
    properties:
      folder: Shared
      name: foo
      description: Made by Pulumi
      fqdn: www.example.com
Copy

Create AddressGroup Resource

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

Constructor syntax

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

@overload
def AddressGroup(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 description: Optional[str] = None,
                 device: Optional[str] = None,
                 dynamic_value: Optional[AddressGroupDynamicValueArgs] = None,
                 folder: Optional[str] = None,
                 name: Optional[str] = None,
                 snippet: Optional[str] = None,
                 static_lists: Optional[Sequence[str]] = None,
                 tags: Optional[Sequence[str]] = None)
func NewAddressGroup(ctx *Context, name string, args *AddressGroupArgs, opts ...ResourceOption) (*AddressGroup, error)
public AddressGroup(string name, AddressGroupArgs? args = null, CustomResourceOptions? opts = null)
public AddressGroup(String name, AddressGroupArgs args)
public AddressGroup(String name, AddressGroupArgs args, CustomResourceOptions options)

type: scm:AddressGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args AddressGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args AddressGroupArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args AddressGroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args AddressGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. AddressGroupArgs
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 addressGroupResource = new Scm.AddressGroup("addressGroupResource", new()
{
    Description = "string",
    Device = "string",
    DynamicValue = new Scm.Inputs.AddressGroupDynamicValueArgs
    {
        Filter = "string",
    },
    Folder = "string",
    Name = "string",
    Snippet = "string",
    StaticLists = new[]
    {
        "string",
    },
    Tags = new[]
    {
        "string",
    },
});
Copy
example, err := scm.NewAddressGroup(ctx, "addressGroupResource", &scm.AddressGroupArgs{
	Description: pulumi.String("string"),
	Device:      pulumi.String("string"),
	DynamicValue: &scm.AddressGroupDynamicValueArgs{
		Filter: pulumi.String("string"),
	},
	Folder:  pulumi.String("string"),
	Name:    pulumi.String("string"),
	Snippet: pulumi.String("string"),
	StaticLists: pulumi.StringArray{
		pulumi.String("string"),
	},
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
})
Copy
var addressGroupResource = new AddressGroup("addressGroupResource", AddressGroupArgs.builder()
    .description("string")
    .device("string")
    .dynamicValue(AddressGroupDynamicValueArgs.builder()
        .filter("string")
        .build())
    .folder("string")
    .name("string")
    .snippet("string")
    .staticLists("string")
    .tags("string")
    .build());
Copy
address_group_resource = scm.AddressGroup("addressGroupResource",
    description="string",
    device="string",
    dynamic_value={
        "filter": "string",
    },
    folder="string",
    name="string",
    snippet="string",
    static_lists=["string"],
    tags=["string"])
Copy
const addressGroupResource = new scm.AddressGroup("addressGroupResource", {
    description: "string",
    device: "string",
    dynamicValue: {
        filter: "string",
    },
    folder: "string",
    name: "string",
    snippet: "string",
    staticLists: ["string"],
    tags: ["string"],
});
Copy
type: scm:AddressGroup
properties:
    description: string
    device: string
    dynamicValue:
        filter: string
    folder: string
    name: string
    snippet: string
    staticLists:
        - string
    tags:
        - string
Copy

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

Description string
The Description param. String length must not exceed 1023 characters.
Device string
The Device param.
DynamicValue AddressGroupDynamicValue
The DynamicValue param. Ensure that only one of the following is specified: dynamic, static
Folder string
The Folder param.
Name string
Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
Snippet string
The Snippet param.
StaticLists List<string>
The StaticList param. Individual elements in this list are subject to additional validation. String length must not exceed 63 characters. Ensure that only one of the following is specified: dynamic, static
Tags List<string>
Tags for address group object. List must contain at most 64 elements. Individual elements in this list are subject to additional validation. String length must not exceed 127 characters.
Description string
The Description param. String length must not exceed 1023 characters.
Device string
The Device param.
DynamicValue AddressGroupDynamicValueArgs
The DynamicValue param. Ensure that only one of the following is specified: dynamic, static
Folder string
The Folder param.
Name string
Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
Snippet string
The Snippet param.
StaticLists []string
The StaticList param. Individual elements in this list are subject to additional validation. String length must not exceed 63 characters. Ensure that only one of the following is specified: dynamic, static
Tags []string
Tags for address group object. List must contain at most 64 elements. Individual elements in this list are subject to additional validation. String length must not exceed 127 characters.
description String
The Description param. String length must not exceed 1023 characters.
device String
The Device param.
dynamicValue AddressGroupDynamicValue
The DynamicValue param. Ensure that only one of the following is specified: dynamic, static
folder String
The Folder param.
name String
Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
snippet String
The Snippet param.
staticLists List<String>
The StaticList param. Individual elements in this list are subject to additional validation. String length must not exceed 63 characters. Ensure that only one of the following is specified: dynamic, static
tags List<String>
Tags for address group object. List must contain at most 64 elements. Individual elements in this list are subject to additional validation. String length must not exceed 127 characters.
description string
The Description param. String length must not exceed 1023 characters.
device string
The Device param.
dynamicValue AddressGroupDynamicValue
The DynamicValue param. Ensure that only one of the following is specified: dynamic, static
folder string
The Folder param.
name string
Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
snippet string
The Snippet param.
staticLists string[]
The StaticList param. Individual elements in this list are subject to additional validation. String length must not exceed 63 characters. Ensure that only one of the following is specified: dynamic, static
tags string[]
Tags for address group object. List must contain at most 64 elements. Individual elements in this list are subject to additional validation. String length must not exceed 127 characters.
description str
The Description param. String length must not exceed 1023 characters.
device str
The Device param.
dynamic_value AddressGroupDynamicValueArgs
The DynamicValue param. Ensure that only one of the following is specified: dynamic, static
folder str
The Folder param.
name str
Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
snippet str
The Snippet param.
static_lists Sequence[str]
The StaticList param. Individual elements in this list are subject to additional validation. String length must not exceed 63 characters. Ensure that only one of the following is specified: dynamic, static
tags Sequence[str]
Tags for address group object. List must contain at most 64 elements. Individual elements in this list are subject to additional validation. String length must not exceed 127 characters.
description String
The Description param. String length must not exceed 1023 characters.
device String
The Device param.
dynamicValue Property Map
The DynamicValue param. Ensure that only one of the following is specified: dynamic, static
folder String
The Folder param.
name String
Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
snippet String
The Snippet param.
staticLists List<String>
The StaticList param. Individual elements in this list are subject to additional validation. String length must not exceed 63 characters. Ensure that only one of the following is specified: dynamic, static
tags List<String>
Tags for address group object. List must contain at most 64 elements. Individual elements in this list are subject to additional validation. String length must not exceed 127 characters.

Outputs

All input properties are implicitly available as output properties. Additionally, the AddressGroup 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 AddressGroup Resource

Get an existing AddressGroup 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?: AddressGroupState, opts?: CustomResourceOptions): AddressGroup
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        device: Optional[str] = None,
        dynamic_value: Optional[AddressGroupDynamicValueArgs] = None,
        folder: Optional[str] = None,
        name: Optional[str] = None,
        snippet: Optional[str] = None,
        static_lists: Optional[Sequence[str]] = None,
        tags: Optional[Sequence[str]] = None,
        tfid: Optional[str] = None) -> AddressGroup
func GetAddressGroup(ctx *Context, name string, id IDInput, state *AddressGroupState, opts ...ResourceOption) (*AddressGroup, error)
public static AddressGroup Get(string name, Input<string> id, AddressGroupState? state, CustomResourceOptions? opts = null)
public static AddressGroup get(String name, Output<String> id, AddressGroupState state, CustomResourceOptions options)
resources:  _:    type: scm:AddressGroup    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Description string
The Description param. String length must not exceed 1023 characters.
Device string
The Device param.
DynamicValue AddressGroupDynamicValue
The DynamicValue param. Ensure that only one of the following is specified: dynamic, static
Folder string
The Folder param.
Name string
Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
Snippet string
The Snippet param.
StaticLists List<string>
The StaticList param. Individual elements in this list are subject to additional validation. String length must not exceed 63 characters. Ensure that only one of the following is specified: dynamic, static
Tags List<string>
Tags for address group object. List must contain at most 64 elements. Individual elements in this list are subject to additional validation. String length must not exceed 127 characters.
Tfid string
Description string
The Description param. String length must not exceed 1023 characters.
Device string
The Device param.
DynamicValue AddressGroupDynamicValueArgs
The DynamicValue param. Ensure that only one of the following is specified: dynamic, static
Folder string
The Folder param.
Name string
Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
Snippet string
The Snippet param.
StaticLists []string
The StaticList param. Individual elements in this list are subject to additional validation. String length must not exceed 63 characters. Ensure that only one of the following is specified: dynamic, static
Tags []string
Tags for address group object. List must contain at most 64 elements. Individual elements in this list are subject to additional validation. String length must not exceed 127 characters.
Tfid string
description String
The Description param. String length must not exceed 1023 characters.
device String
The Device param.
dynamicValue AddressGroupDynamicValue
The DynamicValue param. Ensure that only one of the following is specified: dynamic, static
folder String
The Folder param.
name String
Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
snippet String
The Snippet param.
staticLists List<String>
The StaticList param. Individual elements in this list are subject to additional validation. String length must not exceed 63 characters. Ensure that only one of the following is specified: dynamic, static
tags List<String>
Tags for address group object. List must contain at most 64 elements. Individual elements in this list are subject to additional validation. String length must not exceed 127 characters.
tfid String
description string
The Description param. String length must not exceed 1023 characters.
device string
The Device param.
dynamicValue AddressGroupDynamicValue
The DynamicValue param. Ensure that only one of the following is specified: dynamic, static
folder string
The Folder param.
name string
Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
snippet string
The Snippet param.
staticLists string[]
The StaticList param. Individual elements in this list are subject to additional validation. String length must not exceed 63 characters. Ensure that only one of the following is specified: dynamic, static
tags string[]
Tags for address group object. List must contain at most 64 elements. Individual elements in this list are subject to additional validation. String length must not exceed 127 characters.
tfid string
description str
The Description param. String length must not exceed 1023 characters.
device str
The Device param.
dynamic_value AddressGroupDynamicValueArgs
The DynamicValue param. Ensure that only one of the following is specified: dynamic, static
folder str
The Folder param.
name str
Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
snippet str
The Snippet param.
static_lists Sequence[str]
The StaticList param. Individual elements in this list are subject to additional validation. String length must not exceed 63 characters. Ensure that only one of the following is specified: dynamic, static
tags Sequence[str]
Tags for address group object. List must contain at most 64 elements. Individual elements in this list are subject to additional validation. String length must not exceed 127 characters.
tfid str
description String
The Description param. String length must not exceed 1023 characters.
device String
The Device param.
dynamicValue Property Map
The DynamicValue param. Ensure that only one of the following is specified: dynamic, static
folder String
The Folder param.
name String
Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
snippet String
The Snippet param.
staticLists List<String>
The StaticList param. Individual elements in this list are subject to additional validation. String length must not exceed 63 characters. Ensure that only one of the following is specified: dynamic, static
tags List<String>
Tags for address group object. List must contain at most 64 elements. Individual elements in this list are subject to additional validation. String length must not exceed 127 characters.
tfid String

Supporting Types

AddressGroupDynamicValue
, AddressGroupDynamicValueArgs

Filter This property is required. string
Tag based filter defining group membership e.g. tag1 AND tag2 OR tag3. String length must not exceed 2047 characters.
Filter This property is required. string
Tag based filter defining group membership e.g. tag1 AND tag2 OR tag3. String length must not exceed 2047 characters.
filter This property is required. String
Tag based filter defining group membership e.g. tag1 AND tag2 OR tag3. String length must not exceed 2047 characters.
filter This property is required. string
Tag based filter defining group membership e.g. tag1 AND tag2 OR tag3. String length must not exceed 2047 characters.
filter This property is required. str
Tag based filter defining group membership e.g. tag1 AND tag2 OR tag3. String length must not exceed 2047 characters.
filter This property is required. String
Tag based filter defining group membership e.g. tag1 AND tag2 OR tag3. String length must not exceed 2047 characters.

Package Details

Repository
scm pulumi/pulumi-scm
License
Apache-2.0
Notes
This Pulumi package is based on the scm Terraform Provider.
Strata Cloud Manager v0.3.1 published on Thursday, Mar 13, 2025 by Pulumi
pulumi/pulumi-scm