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

scm.Region

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.Region("example", {});

    import pulumi
import pulumi_scm as scm

example = scm.Region("example")

    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.NewRegion(ctx, "example", nil)
		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.Region("example");

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scm.Region;
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 Region("example");

    }
}

    resources:
  example:
    type: scm:Region

    Create Region Resource

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

    Constructor syntax

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

@overload
def Region(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           addresses: Optional[Sequence[str]] = None,
           device: Optional[str] = None,
           folder: Optional[str] = None,
           geo_location: Optional[RegionGeoLocationArgs] = None,
           name: Optional[str] = None,
           snippet: Optional[str] = None)
    func NewRegion(ctx *Context, name string, args *RegionArgs, opts ...ResourceOption) (*Region, error)
    public Region(string name, RegionArgs? args = null, CustomResourceOptions? opts = null)
    public Region(String name, RegionArgs args)
public Region(String name, RegionArgs args, CustomResourceOptions options)

    type: scm:Region
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 RegionArgs
    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 RegionArgs
    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 RegionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RegionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RegionArgs
    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 regionResource = new Scm.Region("regionResource", new()
{
    Addresses = new[]
    {
        "string",
    },
    Device = "string",
    Folder = "string",
    GeoLocation = new Scm.Inputs.RegionGeoLocationArgs
    {
        Latitude = 0,
        Longitude = 0,
    },
    Name = "string",
    Snippet = "string",
});

    example, err := scm.NewRegion(ctx, "regionResource", &scm.RegionArgs{
	Addresses: pulumi.StringArray{
		pulumi.String("string"),
	},
	Device: pulumi.String("string"),
	Folder: pulumi.String("string"),
	GeoLocation: &scm.RegionGeoLocationArgs{
		Latitude:  pulumi.Float64(0),
		Longitude: pulumi.Float64(0),
	},
	Name:    pulumi.String("string"),
	Snippet: pulumi.String("string"),
})

    var regionResource = new Region("regionResource", RegionArgs.builder()
    .addresses("string")
    .device("string")
    .folder("string")
    .geoLocation(RegionGeoLocationArgs.builder()
        .latitude(0)
        .longitude(0)
        .build())
    .name("string")
    .snippet("string")
    .build());

    region_resource = scm.Region("regionResource",
    addresses=["string"],
    device="string",
    folder="string",
    geo_location={
        "latitude": 0,
        "longitude": 0,
    },
    name="string",
    snippet="string")

    const regionResource = new scm.Region("regionResource", {
    addresses: ["string"],
    device: "string",
    folder: "string",
    geoLocation: {
        latitude: 0,
        longitude: 0,
    },
    name: "string",
    snippet: "string",
});

    type: scm:Region
properties:
    addresses:
        - string
    device: string
    folder: string
    geoLocation:
        latitude: 0
        longitude: 0
    name: string
    snippet: string

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

    Addresses List<string>
    The Addresses param.
    Device string
    The Device param.
    Folder string
    The Folder param.
    GeoLocation RegionGeoLocation
    The GeoLocation param.
    Name string
    Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 31 characters.
    Snippet string
    The Snippet param.
    Addresses []string
    The Addresses param.
    Device string
    The Device param.
    Folder string
    The Folder param.
    GeoLocation RegionGeoLocationArgs
    The GeoLocation param.
    Name string
    Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 31 characters.
    Snippet string
    The Snippet param.
    addresses List<String>
    The Addresses param.
    device String
    The Device param.
    folder String
    The Folder param.
    geoLocation RegionGeoLocation
    The GeoLocation param.
    name String
    Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 31 characters.
    snippet String
    The Snippet param.
    addresses string[]
    The Addresses param.
    device string
    The Device param.
    folder string
    The Folder param.
    geoLocation RegionGeoLocation
    The GeoLocation param.
    name string
    Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 31 characters.
    snippet string
    The Snippet param.
    addresses Sequence[str]
    The Addresses param.
    device str
    The Device param.
    folder str
    The Folder param.
    geo_location RegionGeoLocationArgs
    The GeoLocation param.
    name str
    Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 31 characters.
    snippet str
    The Snippet param.
    addresses List<String>
    The Addresses param.
    device String
    The Device param.
    folder String
    The Folder param.
    geoLocation Property Map
    The GeoLocation param.
    name String
    Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 31 characters.
    snippet String
    The Snippet param.

    Outputs

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

    Get an existing Region 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?: RegionState, opts?: CustomResourceOptions): Region
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        addresses: Optional[Sequence[str]] = None,
        device: Optional[str] = None,
        folder: Optional[str] = None,
        geo_location: Optional[RegionGeoLocationArgs] = None,
        name: Optional[str] = None,
        snippet: Optional[str] = None,
        tfid: Optional[str] = None) -> Region
    func GetRegion(ctx *Context, name string, id IDInput, state *RegionState, opts ...ResourceOption) (*Region, error)
    public static Region Get(string name, Input<string> id, RegionState? state, CustomResourceOptions? opts = null)
    public static Region get(String name, Output<String> id, RegionState 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:
    Addresses List<string>
    The Addresses param.
    Device string
    The Device param.
    Folder string
    The Folder param.
    GeoLocation RegionGeoLocation
    The GeoLocation param.
    Name string
    Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 31 characters.
    Snippet string
    The Snippet param.
    Tfid string
    Addresses []string
    The Addresses param.
    Device string
    The Device param.
    Folder string
    The Folder param.
    GeoLocation RegionGeoLocationArgs
    The GeoLocation param.
    Name string
    Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 31 characters.
    Snippet string
    The Snippet param.
    Tfid string
    addresses List<String>
    The Addresses param.
    device String
    The Device param.
    folder String
    The Folder param.
    geoLocation RegionGeoLocation
    The GeoLocation param.
    name String
    Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 31 characters.
    snippet String
    The Snippet param.
    tfid String
    addresses string[]
    The Addresses param.
    device string
    The Device param.
    folder string
    The Folder param.
    geoLocation RegionGeoLocation
    The GeoLocation param.
    name string
    Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 31 characters.
    snippet string
    The Snippet param.
    tfid string
    addresses Sequence[str]
    The Addresses param.
    device str
    The Device param.
    folder str
    The Folder param.
    geo_location RegionGeoLocationArgs
    The GeoLocation param.
    name str
    Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 31 characters.
    snippet str
    The Snippet param.
    tfid str
    addresses List<String>
    The Addresses param.
    device String
    The Device param.
    folder String
    The Folder param.
    geoLocation Property Map
    The GeoLocation param.
    name String
    Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 31 characters.
    snippet String
    The Snippet param.
    tfid String

    Supporting Types

    RegionGeoLocation, RegionGeoLocationArgs

    Latitude double
    latitude coordinate. Value must be between -90 and 90.
    Longitude double
    longitude coordinate. Value must be between -180 and 180.
    Latitude float64
    latitude coordinate. Value must be between -90 and 90.
    Longitude float64
    longitude coordinate. Value must be between -180 and 180.
    latitude Double
    latitude coordinate. Value must be between -90 and 90.
    longitude Double
    longitude coordinate. Value must be between -180 and 180.
    latitude number
    latitude coordinate. Value must be between -90 and 90.
    longitude number
    longitude coordinate. Value must be between -180 and 180.
    latitude float
    latitude coordinate. Value must be between -90 and 90.
    longitude float
    longitude coordinate. Value must be between -180 and 180.
    latitude Number
    latitude coordinate. Value must be between -90 and 90.
    longitude Number
    longitude coordinate. Value must be between -180 and 180.

    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