1. Packages
  2. Strata Cloud Manager Provider
  3. API Docs
  4. AddressObject
Strata Cloud Manager v0.3.1 published on Thursday, Mar 13, 2025 by Pulumi

scm.AddressObject

Explore with Pulumi AI

Retrieves a config item.

Example Usage

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

const example = new scm.AddressObject("example", {
    folder: "Shared",
    name: "example",
    description: "Made by Pulumi",
    ipNetmask: "10.2.3.4",
});
Copy
import pulumi
import pulumi_scm as scm

example = scm.AddressObject("example",
    folder="Shared",
    name="example",
    description="Made by Pulumi",
    ip_netmask="10.2.3.4")
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 {
		_, err := scm.NewAddressObject(ctx, "example", &scm.AddressObjectArgs{
			Folder:      pulumi.String("Shared"),
			Name:        pulumi.String("example"),
			Description: pulumi.String("Made by Pulumi"),
			IpNetmask:   pulumi.String("10.2.3.4"),
		})
		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 example = new Scm.AddressObject("example", new()
    {
        Folder = "Shared",
        Name = "example",
        Description = "Made by Pulumi",
        IpNetmask = "10.2.3.4",
    });

});
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 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 AddressObject("example", AddressObjectArgs.builder()
            .folder("Shared")
            .name("example")
            .description("Made by Pulumi")
            .ipNetmask("10.2.3.4")
            .build());

    }
}
Copy
resources:
  example:
    type: scm:AddressObject
    properties:
      folder: Shared
      name: example
      description: Made by Pulumi
      ipNetmask: 10.2.3.4
Copy

Create AddressObject Resource

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

Constructor syntax

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

@overload
def AddressObject(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  description: Optional[str] = None,
                  device: Optional[str] = None,
                  folder: Optional[str] = None,
                  fqdn: Optional[str] = None,
                  ip_netmask: Optional[str] = None,
                  ip_range: Optional[str] = None,
                  ip_wildcard: Optional[str] = None,
                  name: Optional[str] = None,
                  snippet: Optional[str] = None,
                  tags: Optional[Sequence[str]] = None)
func NewAddressObject(ctx *Context, name string, args *AddressObjectArgs, opts ...ResourceOption) (*AddressObject, error)
public AddressObject(string name, AddressObjectArgs? args = null, CustomResourceOptions? opts = null)
public AddressObject(String name, AddressObjectArgs args)
public AddressObject(String name, AddressObjectArgs args, CustomResourceOptions options)
type: scm:AddressObject
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 AddressObjectArgs
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 AddressObjectArgs
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 AddressObjectArgs
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 AddressObjectArgs
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. AddressObjectArgs
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 addressObjectResource = new Scm.AddressObject("addressObjectResource", new()
{
    Description = "string",
    Device = "string",
    Folder = "string",
    Fqdn = "string",
    IpNetmask = "string",
    IpRange = "string",
    IpWildcard = "string",
    Name = "string",
    Snippet = "string",
    Tags = new[]
    {
        "string",
    },
});
Copy
example, err := scm.NewAddressObject(ctx, "addressObjectResource", &scm.AddressObjectArgs{
	Description: pulumi.String("string"),
	Device:      pulumi.String("string"),
	Folder:      pulumi.String("string"),
	Fqdn:        pulumi.String("string"),
	IpNetmask:   pulumi.String("string"),
	IpRange:     pulumi.String("string"),
	IpWildcard:  pulumi.String("string"),
	Name:        pulumi.String("string"),
	Snippet:     pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
})
Copy
var addressObjectResource = new AddressObject("addressObjectResource", AddressObjectArgs.builder()
    .description("string")
    .device("string")
    .folder("string")
    .fqdn("string")
    .ipNetmask("string")
    .ipRange("string")
    .ipWildcard("string")
    .name("string")
    .snippet("string")
    .tags("string")
    .build());
Copy
address_object_resource = scm.AddressObject("addressObjectResource",
    description="string",
    device="string",
    folder="string",
    fqdn="string",
    ip_netmask="string",
    ip_range="string",
    ip_wildcard="string",
    name="string",
    snippet="string",
    tags=["string"])
Copy
const addressObjectResource = new scm.AddressObject("addressObjectResource", {
    description: "string",
    device: "string",
    folder: "string",
    fqdn: "string",
    ipNetmask: "string",
    ipRange: "string",
    ipWildcard: "string",
    name: "string",
    snippet: "string",
    tags: ["string"],
});
Copy
type: scm:AddressObject
properties:
    description: string
    device: string
    folder: string
    fqdn: string
    ipNetmask: string
    ipRange: string
    ipWildcard: string
    name: string
    snippet: string
    tags:
        - string
Copy

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

Description string
The Description param. String length must not exceed 1023 characters.
Device string
The Device param.
Folder string
The Folder param.
Fqdn string
The Fqdn param. String length must be between 1 and 255 characters. String validation regex: ^a-zA-Z0-9_+[a-zA-Z0-9]$. Ensure that only one of the following is specified: fqdn, ip_netmask, ip_range, ip_wildcard
IpNetmask string
The IpNetmask param. Ensure that only one of the following is specified: fqdn, ip_netmask, ip_range, ip_wildcard
IpRange string
The IpRange param. Ensure that only one of the following is specified: fqdn, ip_netmask, ip_range, ip_wildcard
IpWildcard string
The IpWildcard param. Ensure that only one of the following is specified: fqdn, ip_netmask, ip_range, ip_wildcard
Name string
Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
Snippet string
The Snippet param.
Tags List<string>
Tags for address 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.
Folder string
The Folder param.
Fqdn string
The Fqdn param. String length must be between 1 and 255 characters. String validation regex: ^a-zA-Z0-9_+[a-zA-Z0-9]$. Ensure that only one of the following is specified: fqdn, ip_netmask, ip_range, ip_wildcard
IpNetmask string
The IpNetmask param. Ensure that only one of the following is specified: fqdn, ip_netmask, ip_range, ip_wildcard
IpRange string
The IpRange param. Ensure that only one of the following is specified: fqdn, ip_netmask, ip_range, ip_wildcard
IpWildcard string
The IpWildcard param. Ensure that only one of the following is specified: fqdn, ip_netmask, ip_range, ip_wildcard
Name string
Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
Snippet string
The Snippet param.
Tags []string
Tags for address 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.
folder String
The Folder param.
fqdn String
The Fqdn param. String length must be between 1 and 255 characters. String validation regex: ^a-zA-Z0-9_+[a-zA-Z0-9]$. Ensure that only one of the following is specified: fqdn, ip_netmask, ip_range, ip_wildcard
ipNetmask String
The IpNetmask param. Ensure that only one of the following is specified: fqdn, ip_netmask, ip_range, ip_wildcard
ipRange String
The IpRange param. Ensure that only one of the following is specified: fqdn, ip_netmask, ip_range, ip_wildcard
ipWildcard String
The IpWildcard param. Ensure that only one of the following is specified: fqdn, ip_netmask, ip_range, ip_wildcard
name String
Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
snippet String
The Snippet param.
tags List<String>
Tags for address 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.
folder string
The Folder param.
fqdn string
The Fqdn param. String length must be between 1 and 255 characters. String validation regex: ^a-zA-Z0-9_+[a-zA-Z0-9]$. Ensure that only one of the following is specified: fqdn, ip_netmask, ip_range, ip_wildcard
ipNetmask string
The IpNetmask param. Ensure that only one of the following is specified: fqdn, ip_netmask, ip_range, ip_wildcard
ipRange string
The IpRange param. Ensure that only one of the following is specified: fqdn, ip_netmask, ip_range, ip_wildcard
ipWildcard string
The IpWildcard param. Ensure that only one of the following is specified: fqdn, ip_netmask, ip_range, ip_wildcard
name string
Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
snippet string
The Snippet param.
tags string[]
Tags for address 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.
folder str
The Folder param.
fqdn str
The Fqdn param. String length must be between 1 and 255 characters. String validation regex: ^a-zA-Z0-9_+[a-zA-Z0-9]$. Ensure that only one of the following is specified: fqdn, ip_netmask, ip_range, ip_wildcard
ip_netmask str
The IpNetmask param. Ensure that only one of the following is specified: fqdn, ip_netmask, ip_range, ip_wildcard
ip_range str
The IpRange param. Ensure that only one of the following is specified: fqdn, ip_netmask, ip_range, ip_wildcard
ip_wildcard str
The IpWildcard param. Ensure that only one of the following is specified: fqdn, ip_netmask, ip_range, ip_wildcard
name str
Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
snippet str
The Snippet param.
tags Sequence[str]
Tags for address 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.
folder String
The Folder param.
fqdn String
The Fqdn param. String length must be between 1 and 255 characters. String validation regex: ^a-zA-Z0-9_+[a-zA-Z0-9]$. Ensure that only one of the following is specified: fqdn, ip_netmask, ip_range, ip_wildcard
ipNetmask String
The IpNetmask param. Ensure that only one of the following is specified: fqdn, ip_netmask, ip_range, ip_wildcard
ipRange String
The IpRange param. Ensure that only one of the following is specified: fqdn, ip_netmask, ip_range, ip_wildcard
ipWildcard String
The IpWildcard param. Ensure that only one of the following is specified: fqdn, ip_netmask, ip_range, ip_wildcard
name String
Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
snippet String
The Snippet param.
tags List<String>
Tags for address 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 AddressObject resource produces the following output properties:

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

Look up Existing AddressObject Resource

Get an existing AddressObject 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?: AddressObjectState, opts?: CustomResourceOptions): AddressObject
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        device: Optional[str] = None,
        folder: Optional[str] = None,
        fqdn: Optional[str] = None,
        ip_netmask: Optional[str] = None,
        ip_range: Optional[str] = None,
        ip_wildcard: Optional[str] = None,
        name: Optional[str] = None,
        snippet: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        tfid: Optional[str] = None,
        type: Optional[str] = None) -> AddressObject
func GetAddressObject(ctx *Context, name string, id IDInput, state *AddressObjectState, opts ...ResourceOption) (*AddressObject, error)
public static AddressObject Get(string name, Input<string> id, AddressObjectState? state, CustomResourceOptions? opts = null)
public static AddressObject get(String name, Output<String> id, AddressObjectState state, CustomResourceOptions options)
resources:  _:    type: scm:AddressObject    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.
Folder string
The Folder param.
Fqdn string
The Fqdn param. String length must be between 1 and 255 characters. String validation regex: ^a-zA-Z0-9_+[a-zA-Z0-9]$. Ensure that only one of the following is specified: fqdn, ip_netmask, ip_range, ip_wildcard
IpNetmask string
The IpNetmask param. Ensure that only one of the following is specified: fqdn, ip_netmask, ip_range, ip_wildcard
IpRange string
The IpRange param. Ensure that only one of the following is specified: fqdn, ip_netmask, ip_range, ip_wildcard
IpWildcard string
The IpWildcard param. Ensure that only one of the following is specified: fqdn, ip_netmask, ip_range, ip_wildcard
Name string
Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
Snippet string
The Snippet param.
Tags List<string>
Tags for address 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
Type string
The Type param.
Description string
The Description param. String length must not exceed 1023 characters.
Device string
The Device param.
Folder string
The Folder param.
Fqdn string
The Fqdn param. String length must be between 1 and 255 characters. String validation regex: ^a-zA-Z0-9_+[a-zA-Z0-9]$. Ensure that only one of the following is specified: fqdn, ip_netmask, ip_range, ip_wildcard
IpNetmask string
The IpNetmask param. Ensure that only one of the following is specified: fqdn, ip_netmask, ip_range, ip_wildcard
IpRange string
The IpRange param. Ensure that only one of the following is specified: fqdn, ip_netmask, ip_range, ip_wildcard
IpWildcard string
The IpWildcard param. Ensure that only one of the following is specified: fqdn, ip_netmask, ip_range, ip_wildcard
Name string
Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
Snippet string
The Snippet param.
Tags []string
Tags for address 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
Type string
The Type param.
description String
The Description param. String length must not exceed 1023 characters.
device String
The Device param.
folder String
The Folder param.
fqdn String
The Fqdn param. String length must be between 1 and 255 characters. String validation regex: ^a-zA-Z0-9_+[a-zA-Z0-9]$. Ensure that only one of the following is specified: fqdn, ip_netmask, ip_range, ip_wildcard
ipNetmask String
The IpNetmask param. Ensure that only one of the following is specified: fqdn, ip_netmask, ip_range, ip_wildcard
ipRange String
The IpRange param. Ensure that only one of the following is specified: fqdn, ip_netmask, ip_range, ip_wildcard
ipWildcard String
The IpWildcard param. Ensure that only one of the following is specified: fqdn, ip_netmask, ip_range, ip_wildcard
name String
Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
snippet String
The Snippet param.
tags List<String>
Tags for address 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
type String
The Type param.
description string
The Description param. String length must not exceed 1023 characters.
device string
The Device param.
folder string
The Folder param.
fqdn string
The Fqdn param. String length must be between 1 and 255 characters. String validation regex: ^a-zA-Z0-9_+[a-zA-Z0-9]$. Ensure that only one of the following is specified: fqdn, ip_netmask, ip_range, ip_wildcard
ipNetmask string
The IpNetmask param. Ensure that only one of the following is specified: fqdn, ip_netmask, ip_range, ip_wildcard
ipRange string
The IpRange param. Ensure that only one of the following is specified: fqdn, ip_netmask, ip_range, ip_wildcard
ipWildcard string
The IpWildcard param. Ensure that only one of the following is specified: fqdn, ip_netmask, ip_range, ip_wildcard
name string
Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
snippet string
The Snippet param.
tags string[]
Tags for address 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
type string
The Type param.
description str
The Description param. String length must not exceed 1023 characters.
device str
The Device param.
folder str
The Folder param.
fqdn str
The Fqdn param. String length must be between 1 and 255 characters. String validation regex: ^a-zA-Z0-9_+[a-zA-Z0-9]$. Ensure that only one of the following is specified: fqdn, ip_netmask, ip_range, ip_wildcard
ip_netmask str
The IpNetmask param. Ensure that only one of the following is specified: fqdn, ip_netmask, ip_range, ip_wildcard
ip_range str
The IpRange param. Ensure that only one of the following is specified: fqdn, ip_netmask, ip_range, ip_wildcard
ip_wildcard str
The IpWildcard param. Ensure that only one of the following is specified: fqdn, ip_netmask, ip_range, ip_wildcard
name str
Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
snippet str
The Snippet param.
tags Sequence[str]
Tags for address 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
type str
The Type param.
description String
The Description param. String length must not exceed 1023 characters.
device String
The Device param.
folder String
The Folder param.
fqdn String
The Fqdn param. String length must be between 1 and 255 characters. String validation regex: ^a-zA-Z0-9_+[a-zA-Z0-9]$. Ensure that only one of the following is specified: fqdn, ip_netmask, ip_range, ip_wildcard
ipNetmask String
The IpNetmask param. Ensure that only one of the following is specified: fqdn, ip_netmask, ip_range, ip_wildcard
ipRange String
The IpRange param. Ensure that only one of the following is specified: fqdn, ip_netmask, ip_range, ip_wildcard
ipWildcard String
The IpWildcard param. Ensure that only one of the following is specified: fqdn, ip_netmask, ip_range, ip_wildcard
name String
Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
snippet String
The Snippet param.
tags List<String>
Tags for address 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
type String
The Type param.

Package Details

Repository
scm pulumi/pulumi-scm
License
Apache-2.0
Notes
This Pulumi package is based on the scm Terraform Provider.