Region resource
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.0)
.longitude(0.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>
- Address
- Device string
- The device in which the resource is defined
- Folder string
- The folder in which the resource is defined
- Geo
Location RegionGeo Location - Geo location
- Name string
- The name of the region
- Snippet string
- The snippet in which the resource is defined
- Addresses []string
- Address
- Device string
- The device in which the resource is defined
- Folder string
- The folder in which the resource is defined
- Geo
Location RegionGeo Location Args - Geo location
- Name string
- The name of the region
- Snippet string
- The snippet in which the resource is defined
- addresses List<String>
- Address
- device String
- The device in which the resource is defined
- folder String
- The folder in which the resource is defined
- geo
Location RegionGeo Location - Geo location
- name String
- The name of the region
- snippet String
- The snippet in which the resource is defined
- addresses string[]
- Address
- device string
- The device in which the resource is defined
- folder string
- The folder in which the resource is defined
- geo
Location RegionGeo Location - Geo location
- name string
- The name of the region
- snippet string
- The snippet in which the resource is defined
- addresses Sequence[str]
- Address
- device str
- The device in which the resource is defined
- folder str
- The folder in which the resource is defined
- geo_
location RegionGeo Location Args - Geo location
- name str
- The name of the region
- snippet str
- The snippet in which the resource is defined
- addresses List<String>
- Address
- device String
- The device in which the resource is defined
- folder String
- The folder in which the resource is defined
- geo
Location Property Map - Geo location
- name String
- The name of the region
- snippet String
- The snippet in which the resource is defined
Outputs
All input properties are implicitly available as output properties. Additionally, the Region resource produces the following output properties:
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) -> Regionfunc 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)resources: _: type: scm:Region 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.
- Addresses List<string>
- Address
- Device string
- The device in which the resource is defined
- Folder string
- The folder in which the resource is defined
- Geo
Location RegionGeo Location - Geo location
- Name string
- The name of the region
- Snippet string
- The snippet in which the resource is defined
- Tfid string
- Addresses []string
- Address
- Device string
- The device in which the resource is defined
- Folder string
- The folder in which the resource is defined
- Geo
Location RegionGeo Location Args - Geo location
- Name string
- The name of the region
- Snippet string
- The snippet in which the resource is defined
- Tfid string
- addresses List<String>
- Address
- device String
- The device in which the resource is defined
- folder String
- The folder in which the resource is defined
- geo
Location RegionGeo Location - Geo location
- name String
- The name of the region
- snippet String
- The snippet in which the resource is defined
- tfid String
- addresses string[]
- Address
- device string
- The device in which the resource is defined
- folder string
- The folder in which the resource is defined
- geo
Location RegionGeo Location - Geo location
- name string
- The name of the region
- snippet string
- The snippet in which the resource is defined
- tfid string
- addresses Sequence[str]
- Address
- device str
- The device in which the resource is defined
- folder str
- The folder in which the resource is defined
- geo_
location RegionGeo Location Args - Geo location
- name str
- The name of the region
- snippet str
- The snippet in which the resource is defined
- tfid str
- addresses List<String>
- Address
- device String
- The device in which the resource is defined
- folder String
- The folder in which the resource is defined
- geo
Location Property Map - Geo location
- name String
- The name of the region
- snippet String
- The snippet in which the resource is defined
- tfid String
Supporting Types
RegionGeoLocation, RegionGeoLocationArgs
Package Details
- Repository
- scm pulumi/pulumi-scm
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
scmTerraform Provider.
