Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Splight
  3. API Docs
  4. Grid
splight v1.2.2 published on Friday, Nov 8, 2024 by splightplatform
splightplatform/pulumi-splight

splight.Grid

Explore with Pulumi AI

splight logo
splight v1.2.2 published on Friday, Nov 8, 2024 by splightplatform
splightplatform/pulumi-splight

    Example Usage

    Create Grid Resource

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

    Constructor syntax

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

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

    type: splight:Grid
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 GridArgs
    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 GridArgs
    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 GridArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GridArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GridArgs
    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 gridResource = new Splight.Grid("gridResource", new()
{
    Description = "string",
    Geometry = "string",
    Name = "string",
    Tags = new[]
    {
        new Splight.Inputs.GridTagArgs
        {
            Id = "string",
            Name = "string",
        },
    },
    Timezone = "string",
});

    example, err := splight.NewGrid(ctx, "gridResource", &splight.GridArgs{
	Description: pulumi.String("string"),
	Geometry:    pulumi.String("string"),
	Name:        pulumi.String("string"),
	Tags: splight.GridTagArray{
		&splight.GridTagArgs{
			Id:   pulumi.String("string"),
			Name: pulumi.String("string"),
		},
	},
	Timezone: pulumi.String("string"),
})

    var gridResource = new Grid("gridResource", GridArgs.builder()
    .description("string")
    .geometry("string")
    .name("string")
    .tags(GridTagArgs.builder()
        .id("string")
        .name("string")
        .build())
    .timezone("string")
    .build());

    grid_resource = splight.Grid("gridResource",
    description="string",
    geometry="string",
    name="string",
    tags=[{
        "id": "string",
        "name": "string",
    }],
    timezone="string")

    const gridResource = new splight.Grid("gridResource", {
    description: "string",
    geometry: "string",
    name: "string",
    tags: [{
        id: "string",
        name: "string",
    }],
    timezone: "string",
});

    type: splight:Grid
properties:
    description: string
    geometry: string
    name: string
    tags:
        - id: string
          name: string
    timezone: string

    Grid 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 Grid 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.GridTag>
    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 []GridTagArgs
    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<GridTag>
    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 GridTag[]
    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[GridTagArgs]
    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 Grid resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Kinds List<Splight.Splight.Outputs.GridKind>
    kind of the resource
    Id string
    The provider-assigned unique ID for this managed resource.
    Kinds []GridKind
    kind of the resource
    id String
    The provider-assigned unique ID for this managed resource.
    kinds List<GridKind>
    kind of the resource
    id string
    The provider-assigned unique ID for this managed resource.
    kinds GridKind[]
    kind of the resource
    id str
    The provider-assigned unique ID for this managed resource.
    kinds Sequence[GridKind]
    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 Grid Resource

    Get an existing Grid 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?: GridState, opts?: CustomResourceOptions): Grid
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        geometry: Optional[str] = None,
        kinds: Optional[Sequence[GridKindArgs]] = None,
        name: Optional[str] = None,
        tags: Optional[Sequence[GridTagArgs]] = None,
        timezone: Optional[str] = None) -> Grid
    func GetGrid(ctx *Context, name string, id IDInput, state *GridState, opts ...ResourceOption) (*Grid, error)
    public static Grid Get(string name, Input<string> id, GridState? state, CustomResourceOptions? opts = null)
    public static Grid get(String name, Output<String> id, GridState 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:
    Description string
    description of the resource
    Geometry string
    geo position and shape of the resource
    Kinds List<Splight.Splight.Inputs.GridKind>
    kind of the resource
    Name string
    name of the resource
    Tags List<Splight.Splight.Inputs.GridTag>
    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 []GridKindArgs
    kind of the resource
    Name string
    name of the resource
    Tags []GridTagArgs
    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<GridKind>
    kind of the resource
    name String
    name of the resource
    tags List<GridTag>
    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 GridKind[]
    kind of the resource
    name string
    name of the resource
    tags GridTag[]
    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[GridKindArgs]
    kind of the resource
    name str
    name of the resource
    tags Sequence[GridTagArgs]
    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

    GridKind, GridKindArgs

    Id string
    kind id
    Name string
    kind name
    Id string
    kind id
    Name string
    kind name
    id String
    kind id
    name String
    kind name
    id string
    kind id
    name string
    kind name
    id str
    kind id
    name str
    kind name
    id String
    kind id
    name String
    kind name

    GridTag, GridTagArgs

    Id string
    tag id
    Name string
    tag name
    Id string
    tag id
    Name string
    tag name
    id String
    tag id
    name String
    tag name
    id string
    tag id
    name string
    tag name
    id str
    tag id
    name str
    tag name
    id String
    tag id
    name String
    tag name

    Import

    $ pulumi import splight:index/grid:Grid [options] splight_grid.<name> <grid_id>

    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 logo
    splight v1.2.2 published on Friday, Nov 8, 2024 by splightplatform
    splightplatform/pulumi-splight