Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Splight
  3. API Docs
  4. Asset
splight v1.1.9 published on Friday, Oct 18, 2024 by splightplatform
splightplatform/pulumi-splight

splight.Asset

Explore with Pulumi AI

splight logo
splight v1.1.9 published on Friday, Oct 18, 2024 by splightplatform
splightplatform/pulumi-splight

    Example Usage

    Create Asset Resource

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

    Constructor syntax

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

@overload
def Asset(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          geometry: Optional[str] = None,
          description: Optional[str] = None,
          kind: Optional[AssetKindArgs] = None,
          name: Optional[str] = None,
          tags: Optional[Sequence[AssetTagArgs]] = None)
    func NewAsset(ctx *Context, name string, args AssetArgs, opts ...ResourceOption) (*Asset, error)
    public Asset(string name, AssetArgs args, CustomResourceOptions? opts = null)
    public Asset(String name, AssetArgs args)
public Asset(String name, AssetArgs args, CustomResourceOptions options)

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

    example, err := splight.NewAsset(ctx, "assetResource", &splight.AssetArgs{
	Geometry:    pulumi.String("string"),
	Description: pulumi.String("string"),
	Kind: &splight.AssetKindArgs{
		Id:   pulumi.String("string"),
		Name: pulumi.String("string"),
	},
	Name: pulumi.String("string"),
	Tags: splight.AssetTagArray{
		&splight.AssetTagArgs{
			Id:   pulumi.String("string"),
			Name: pulumi.String("string"),
		},
	},
})

    var assetResource = new Asset("assetResource", AssetArgs.builder()
    .geometry("string")
    .description("string")
    .kind(AssetKindArgs.builder()
        .id("string")
        .name("string")
        .build())
    .name("string")
    .tags(AssetTagArgs.builder()
        .id("string")
        .name("string")
        .build())
    .build());

    asset_resource = splight.Asset("assetResource",
    geometry="string",
    description="string",
    kind=splight.AssetKindArgs(
        id="string",
        name="string",
    ),
    name="string",
    tags=[splight.AssetTagArgs(
        id="string",
        name="string",
    )])

    const assetResource = new splight.Asset("assetResource", {
    geometry: "string",
    description: "string",
    kind: {
        id: "string",
        name: "string",
    },
    name: "string",
    tags: [{
        id: "string",
        name: "string",
    }],
});

    type: splight:Asset
properties:
    description: string
    geometry: string
    kind:
        id: string
        name: string
    name: string
    tags:
        - id: string
          name: string

    Asset Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Asset resource accepts the following input properties:

    Geometry string
    GeoJSON GeomtryCollection
    Description string
    description of the resource
    Kind Splight.Splight.Inputs.AssetKind
    kind of the resource
    Name string
    name of the resource
    Tags List<Splight.Splight.Inputs.AssetTag>
    tags of the resource
    Geometry string
    GeoJSON GeomtryCollection
    Description string
    description of the resource
    Kind AssetKindArgs
    kind of the resource
    Name string
    name of the resource
    Tags []AssetTagArgs
    tags of the resource
    geometry String
    GeoJSON GeomtryCollection
    description String
    description of the resource
    kind AssetKind
    kind of the resource
    name String
    name of the resource
    tags List<AssetTag>
    tags of the resource
    geometry string
    GeoJSON GeomtryCollection
    description string
    description of the resource
    kind AssetKind
    kind of the resource
    name string
    name of the resource
    tags AssetTag[]
    tags of the resource
    geometry str
    GeoJSON GeomtryCollection
    description str
    description of the resource
    kind AssetKindArgs
    kind of the resource
    name str
    name of the resource
    tags Sequence[AssetTagArgs]
    tags of the resource
    geometry String
    GeoJSON GeomtryCollection
    description String
    description of the resource
    kind Property Map
    kind of the resource
    name String
    name of the resource
    tags List<Property Map>
    tags of the resource

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Asset Resource

    Get an existing Asset 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?: AssetState, opts?: CustomResourceOptions): Asset
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        geometry: Optional[str] = None,
        kind: Optional[AssetKindArgs] = None,
        name: Optional[str] = None,
        tags: Optional[Sequence[AssetTagArgs]] = None) -> Asset
    func GetAsset(ctx *Context, name string, id IDInput, state *AssetState, opts ...ResourceOption) (*Asset, error)
    public static Asset Get(string name, Input<string> id, AssetState? state, CustomResourceOptions? opts = null)
    public static Asset get(String name, Output<String> id, AssetState 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
    GeoJSON GeomtryCollection
    Kind Splight.Splight.Inputs.AssetKind
    kind of the resource
    Name string
    name of the resource
    Tags List<Splight.Splight.Inputs.AssetTag>
    tags of the resource
    Description string
    description of the resource
    Geometry string
    GeoJSON GeomtryCollection
    Kind AssetKindArgs
    kind of the resource
    Name string
    name of the resource
    Tags []AssetTagArgs
    tags of the resource
    description String
    description of the resource
    geometry String
    GeoJSON GeomtryCollection
    kind AssetKind
    kind of the resource
    name String
    name of the resource
    tags List<AssetTag>
    tags of the resource
    description string
    description of the resource
    geometry string
    GeoJSON GeomtryCollection
    kind AssetKind
    kind of the resource
    name string
    name of the resource
    tags AssetTag[]
    tags of the resource
    description str
    description of the resource
    geometry str
    GeoJSON GeomtryCollection
    kind AssetKindArgs
    kind of the resource
    name str
    name of the resource
    tags Sequence[AssetTagArgs]
    tags of the resource
    description String
    description of the resource
    geometry String
    GeoJSON GeomtryCollection
    kind Property Map
    kind of the resource
    name String
    name of the resource
    tags List<Property Map>
    tags of the resource

    Supporting Types

    AssetKind, AssetKindArgs

    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

    AssetTag, AssetTagArgs

    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/asset:Asset [options] splight_asset.<name> <asset_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.1.9 published on Friday, Oct 18, 2024 by splightplatform
    splightplatform/pulumi-splight