Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Splight
  3. API Docs
  4. ExternalGrid
splight v1.2.13 published on Friday, Feb 14, 2025 by splightplatform
splightplatform/pulumi-splight

splight.ExternalGrid

Explore with Pulumi AI

splight v1.2.13 published on Friday, Feb 14, 2025 by splightplatform
splightplatform/pulumi-splight

Example Usage

Create ExternalGrid Resource

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

Constructor syntax

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

@overload
def ExternalGrid(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 description: Optional[str] = None,
                 geometry: Optional[str] = None,
                 name: Optional[str] = None,
                 tags: Optional[Sequence[ExternalGridTagArgs]] = None,
                 timezone: Optional[str] = None)
func NewExternalGrid(ctx *Context, name string, args *ExternalGridArgs, opts ...ResourceOption) (*ExternalGrid, error)
public ExternalGrid(string name, ExternalGridArgs? args = null, CustomResourceOptions? opts = null)
public ExternalGrid(String name, ExternalGridArgs args)
public ExternalGrid(String name, ExternalGridArgs args, CustomResourceOptions options)

type: splight:ExternalGrid
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 ExternalGridArgs
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 ExternalGridArgs
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 ExternalGridArgs
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 ExternalGridArgs
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. ExternalGridArgs
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 externalGridResource = new Splight.ExternalGrid("externalGridResource", new()
{
    Description = "string",
    Geometry = "string",
    Name = "string",
    Tags = new[]
    {
        new Splight.Inputs.ExternalGridTagArgs
        {
            Id = "string",
            Name = "string",
        },
    },
    Timezone = "string",
});
Copy
example, err := splight.NewExternalGrid(ctx, "externalGridResource", &splight.ExternalGridArgs{
	Description: pulumi.String("string"),
	Geometry:    pulumi.String("string"),
	Name:        pulumi.String("string"),
	Tags: splight.ExternalGridTagArray{
		&splight.ExternalGridTagArgs{
			Id:   pulumi.String("string"),
			Name: pulumi.String("string"),
		},
	},
	Timezone: pulumi.String("string"),
})
Copy
var externalGridResource = new ExternalGrid("externalGridResource", ExternalGridArgs.builder()
    .description("string")
    .geometry("string")
    .name("string")
    .tags(ExternalGridTagArgs.builder()
        .id("string")
        .name("string")
        .build())
    .timezone("string")
    .build());
Copy
external_grid_resource = splight.ExternalGrid("externalGridResource",
    description="string",
    geometry="string",
    name="string",
    tags=[{
        "id": "string",
        "name": "string",
    }],
    timezone="string")
Copy
const externalGridResource = new splight.ExternalGrid("externalGridResource", {
    description: "string",
    geometry: "string",
    name: "string",
    tags: [{
        id: "string",
        name: "string",
    }],
    timezone: "string",
});
Copy
type: splight:ExternalGrid
properties:
    description: string
    geometry: string
    name: string
    tags:
        - id: string
          name: string
    timezone: string
Copy

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

Description string
description of the resource
Geometry string
geo position and shape of the resource
Name string
name of the resource
Tags List<Splight.Splight.Inputs.ExternalGridTag>
tags of the resource
Timezone string
timezone that overrides location-based timezone of the resource
Description string
description of the resource
Geometry string
geo position and shape of the resource
Name string
name of the resource
Tags []ExternalGridTagArgs
tags of the resource
Timezone string
timezone that overrides location-based timezone of the resource
description String
description of the resource
geometry String
geo position and shape of the resource
name String
name of the resource
tags List<ExternalGridTag>
tags of the resource
timezone String
timezone that overrides location-based timezone of the resource
description string
description of the resource
geometry string
geo position and shape of the resource
name string
name of the resource
tags ExternalGridTag[]
tags of the resource
timezone string
timezone that overrides location-based timezone of the resource
description str
description of the resource
geometry str
geo position and shape of the resource
name str
name of the resource
tags Sequence[ExternalGridTagArgs]
tags of the resource
timezone str
timezone that overrides location-based timezone of the resource
description String
description of the resource
geometry String
geo position and shape of the resource
name String
name of the resource
tags List<Property Map>
tags of the resource
timezone String
timezone that overrides location-based timezone of the resource

Outputs

All input properties are implicitly available as output properties. Additionally, the ExternalGrid resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Kinds List<Splight.Splight.Outputs.ExternalGridKind>
kind of the resource
Id string
The provider-assigned unique ID for this managed resource.
Kinds []ExternalGridKind
kind of the resource
id String
The provider-assigned unique ID for this managed resource.
kinds List<ExternalGridKind>
kind of the resource
id string
The provider-assigned unique ID for this managed resource.
kinds ExternalGridKind[]
kind of the resource
id str
The provider-assigned unique ID for this managed resource.
kinds Sequence[ExternalGridKind]
kind of the resource
id String
The provider-assigned unique ID for this managed resource.
kinds List<Property Map>
kind of the resource

Look up Existing ExternalGrid Resource

Get an existing ExternalGrid 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?: ExternalGridState, opts?: CustomResourceOptions): ExternalGrid
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        geometry: Optional[str] = None,
        kinds: Optional[Sequence[ExternalGridKindArgs]] = None,
        name: Optional[str] = None,
        tags: Optional[Sequence[ExternalGridTagArgs]] = None,
        timezone: Optional[str] = None) -> ExternalGrid
func GetExternalGrid(ctx *Context, name string, id IDInput, state *ExternalGridState, opts ...ResourceOption) (*ExternalGrid, error)
public static ExternalGrid Get(string name, Input<string> id, ExternalGridState? state, CustomResourceOptions? opts = null)
public static ExternalGrid get(String name, Output<String> id, ExternalGridState state, CustomResourceOptions options)
resources:  _:    type: splight:ExternalGrid    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
description of the resource
Geometry string
geo position and shape of the resource
Kinds List<Splight.Splight.Inputs.ExternalGridKind>
kind of the resource
Name string
name of the resource
Tags List<Splight.Splight.Inputs.ExternalGridTag>
tags of the resource
Timezone string
timezone that overrides location-based timezone of the resource
Description string
description of the resource
Geometry string
geo position and shape of the resource
Kinds []ExternalGridKindArgs
kind of the resource
Name string
name of the resource
Tags []ExternalGridTagArgs
tags of the resource
Timezone string
timezone that overrides location-based timezone of the resource
description String
description of the resource
geometry String
geo position and shape of the resource
kinds List<ExternalGridKind>
kind of the resource
name String
name of the resource
tags List<ExternalGridTag>
tags of the resource
timezone String
timezone that overrides location-based timezone of the resource
description string
description of the resource
geometry string
geo position and shape of the resource
kinds ExternalGridKind[]
kind of the resource
name string
name of the resource
tags ExternalGridTag[]
tags of the resource
timezone string
timezone that overrides location-based timezone of the resource
description str
description of the resource
geometry str
geo position and shape of the resource
kinds Sequence[ExternalGridKindArgs]
kind of the resource
name str
name of the resource
tags Sequence[ExternalGridTagArgs]
tags of the resource
timezone str
timezone that overrides location-based timezone of the resource
description String
description of the resource
geometry String
geo position and shape of the resource
kinds List<Property Map>
kind of the resource
name String
name of the resource
tags List<Property Map>
tags of the resource
timezone String
timezone that overrides location-based timezone of the resource

Supporting Types

ExternalGridKind
, ExternalGridKindArgs

Id
This property is required.
Changes to this property will trigger replacement.
string
kind id
Name
This property is required.
Changes to this property will trigger replacement.
string
kind name
Id
This property is required.
Changes to this property will trigger replacement.
string
kind id
Name
This property is required.
Changes to this property will trigger replacement.
string
kind name
id
This property is required.
Changes to this property will trigger replacement.
String
kind id
name
This property is required.
Changes to this property will trigger replacement.
String
kind name
id
This property is required.
Changes to this property will trigger replacement.
string
kind id
name
This property is required.
Changes to this property will trigger replacement.
string
kind name
id
This property is required.
Changes to this property will trigger replacement.
str
kind id
name
This property is required.
Changes to this property will trigger replacement.
str
kind name
id
This property is required.
Changes to this property will trigger replacement.
String
kind id
name
This property is required.
Changes to this property will trigger replacement.
String
kind name

ExternalGridTag
, ExternalGridTagArgs

Id This property is required. string
tag id
Name This property is required. string
tag name
Id This property is required. string
tag id
Name This property is required. string
tag name
id This property is required. String
tag id
name This property is required. String
tag name
id This property is required. string
tag id
name This property is required. string
tag name
id This property is required. str
tag id
name This property is required. str
tag name
id This property is required. String
tag id
name This property is required. String
tag name

Import

$ pulumi import splight:index/externalGrid:ExternalGrid [options] splight_external_grid.<name> <external_grid_id>
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
splight splightplatform/pulumi-splight
License
Apache-2.0
Notes
This Pulumi package is based on the splight Terraform Provider.
splight v1.2.13 published on Friday, Feb 14, 2025 by splightplatform
splightplatform/pulumi-splight