Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Splight
  3. API Docs
  4. AssetRelation
splight v1.1.1 published on Thursday, Sep 26, 2024 by splightplatform
splightplatform/pulumi-splight

splight.AssetRelation

Explore with Pulumi AI

splight logo
splight v1.1.1 published on Thursday, Sep 26, 2024 by splightplatform
splightplatform/pulumi-splight

    Example Usage

    Create AssetRelation Resource

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

    Constructor syntax

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

@overload
def AssetRelation(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  asset: Optional[AssetRelationAssetArgs] = None,
                  related_asset: Optional[AssetRelationRelatedAssetArgs] = None,
                  related_asset_kind: Optional[AssetRelationRelatedAssetKindArgs] = None,
                  description: Optional[str] = None,
                  name: Optional[str] = None)
    func NewAssetRelation(ctx *Context, name string, args AssetRelationArgs, opts ...ResourceOption) (*AssetRelation, error)
    public AssetRelation(string name, AssetRelationArgs args, CustomResourceOptions? opts = null)
    public AssetRelation(String name, AssetRelationArgs args)
public AssetRelation(String name, AssetRelationArgs args, CustomResourceOptions options)

    type: splight:AssetRelation
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 AssetRelationArgs
    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 AssetRelationArgs
    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 AssetRelationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AssetRelationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AssetRelationArgs
    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 assetRelationResource = new Splight.AssetRelation("assetRelationResource", new()
{
    Asset = new Splight.Inputs.AssetRelationAssetArgs
    {
        Id = "string",
        Name = "string",
    },
    RelatedAsset = new Splight.Inputs.AssetRelationRelatedAssetArgs
    {
        Id = "string",
        Name = "string",
    },
    RelatedAssetKind = new Splight.Inputs.AssetRelationRelatedAssetKindArgs
    {
        Id = "string",
        Name = "string",
    },
    Description = "string",
    Name = "string",
});

    example, err := splight.NewAssetRelation(ctx, "assetRelationResource", &splight.AssetRelationArgs{
	Asset: &splight.AssetRelationAssetArgs{
		Id:   pulumi.String("string"),
		Name: pulumi.String("string"),
	},
	RelatedAsset: &splight.AssetRelationRelatedAssetArgs{
		Id:   pulumi.String("string"),
		Name: pulumi.String("string"),
	},
	RelatedAssetKind: &splight.AssetRelationRelatedAssetKindArgs{
		Id:   pulumi.String("string"),
		Name: pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
})

    var assetRelationResource = new AssetRelation("assetRelationResource", AssetRelationArgs.builder()
    .asset(AssetRelationAssetArgs.builder()
        .id("string")
        .name("string")
        .build())
    .relatedAsset(AssetRelationRelatedAssetArgs.builder()
        .id("string")
        .name("string")
        .build())
    .relatedAssetKind(AssetRelationRelatedAssetKindArgs.builder()
        .id("string")
        .name("string")
        .build())
    .description("string")
    .name("string")
    .build());

    asset_relation_resource = splight.AssetRelation("assetRelationResource",
    asset=splight.AssetRelationAssetArgs(
        id="string",
        name="string",
    ),
    related_asset=splight.AssetRelationRelatedAssetArgs(
        id="string",
        name="string",
    ),
    related_asset_kind=splight.AssetRelationRelatedAssetKindArgs(
        id="string",
        name="string",
    ),
    description="string",
    name="string")

    const assetRelationResource = new splight.AssetRelation("assetRelationResource", {
    asset: {
        id: "string",
        name: "string",
    },
    relatedAsset: {
        id: "string",
        name: "string",
    },
    relatedAssetKind: {
        id: "string",
        name: "string",
    },
    description: "string",
    name: "string",
});

    type: splight:AssetRelation
properties:
    asset:
        id: string
        name: string
    description: string
    name: string
    relatedAsset:
        id: string
        name: string
    relatedAssetKind:
        id: string
        name: string

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

    Asset Splight.Splight.Inputs.AssetRelationAsset
    asset where the relation origins
    RelatedAsset Splight.Splight.Inputs.AssetRelationRelatedAsset
    target asset of the relation
    RelatedAssetKind Splight.Splight.Inputs.AssetRelationRelatedAssetKind
    kind of the target relation asset
    Description string
    relation description
    Name string
    relation name
    Asset AssetRelationAssetArgs
    asset where the relation origins
    RelatedAsset AssetRelationRelatedAssetArgs
    target asset of the relation
    RelatedAssetKind AssetRelationRelatedAssetKindArgs
    kind of the target relation asset
    Description string
    relation description
    Name string
    relation name
    asset AssetRelationAsset
    asset where the relation origins
    relatedAsset AssetRelationRelatedAsset
    target asset of the relation
    relatedAssetKind AssetRelationRelatedAssetKind
    kind of the target relation asset
    description String
    relation description
    name String
    relation name
    asset AssetRelationAsset
    asset where the relation origins
    relatedAsset AssetRelationRelatedAsset
    target asset of the relation
    relatedAssetKind AssetRelationRelatedAssetKind
    kind of the target relation asset
    description string
    relation description
    name string
    relation name
    asset AssetRelationAssetArgs
    asset where the relation origins
    related_asset AssetRelationRelatedAssetArgs
    target asset of the relation
    related_asset_kind AssetRelationRelatedAssetKindArgs
    kind of the target relation asset
    description str
    relation description
    name str
    relation name
    asset Property Map
    asset where the relation origins
    relatedAsset Property Map
    target asset of the relation
    relatedAssetKind Property Map
    kind of the target relation asset
    description String
    relation description
    name String
    relation name

    Outputs

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

    Get an existing AssetRelation 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?: AssetRelationState, opts?: CustomResourceOptions): AssetRelation
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        asset: Optional[AssetRelationAssetArgs] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        related_asset: Optional[AssetRelationRelatedAssetArgs] = None,
        related_asset_kind: Optional[AssetRelationRelatedAssetKindArgs] = None) -> AssetRelation
    func GetAssetRelation(ctx *Context, name string, id IDInput, state *AssetRelationState, opts ...ResourceOption) (*AssetRelation, error)
    public static AssetRelation Get(string name, Input<string> id, AssetRelationState? state, CustomResourceOptions? opts = null)
    public static AssetRelation get(String name, Output<String> id, AssetRelationState 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:
    Asset Splight.Splight.Inputs.AssetRelationAsset
    asset where the relation origins
    Description string
    relation description
    Name string
    relation name
    RelatedAsset Splight.Splight.Inputs.AssetRelationRelatedAsset
    target asset of the relation
    RelatedAssetKind Splight.Splight.Inputs.AssetRelationRelatedAssetKind
    kind of the target relation asset
    Asset AssetRelationAssetArgs
    asset where the relation origins
    Description string
    relation description
    Name string
    relation name
    RelatedAsset AssetRelationRelatedAssetArgs
    target asset of the relation
    RelatedAssetKind AssetRelationRelatedAssetKindArgs
    kind of the target relation asset
    asset AssetRelationAsset
    asset where the relation origins
    description String
    relation description
    name String
    relation name
    relatedAsset AssetRelationRelatedAsset
    target asset of the relation
    relatedAssetKind AssetRelationRelatedAssetKind
    kind of the target relation asset
    asset AssetRelationAsset
    asset where the relation origins
    description string
    relation description
    name string
    relation name
    relatedAsset AssetRelationRelatedAsset
    target asset of the relation
    relatedAssetKind AssetRelationRelatedAssetKind
    kind of the target relation asset
    asset AssetRelationAssetArgs
    asset where the relation origins
    description str
    relation description
    name str
    relation name
    related_asset AssetRelationRelatedAssetArgs
    target asset of the relation
    related_asset_kind AssetRelationRelatedAssetKindArgs
    kind of the target relation asset
    asset Property Map
    asset where the relation origins
    description String
    relation description
    name String
    relation name
    relatedAsset Property Map
    target asset of the relation
    relatedAssetKind Property Map
    kind of the target relation asset

    Supporting Types

    AssetRelationAsset, AssetRelationAssetArgs

    Id string
    asset id
    Name string
    asset name
    Id string
    asset id
    Name string
    asset name
    id String
    asset id
    name String
    asset name
    id string
    asset id
    name string
    asset name
    id str
    asset id
    name str
    asset name
    id String
    asset id
    name String
    asset name

    AssetRelationRelatedAsset, AssetRelationRelatedAssetArgs

    Id string
    asset id
    Name string
    asset name
    Id string
    asset id
    Name string
    asset name
    id String
    asset id
    name String
    asset name
    id string
    asset id
    name string
    asset name
    id str
    asset id
    name str
    asset name
    id String
    asset id
    name String
    asset name

    AssetRelationRelatedAssetKind, AssetRelationRelatedAssetKindArgs

    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

    Import

    $ pulumi import splight:index/assetRelation:AssetRelation [options] splight_relation.<name> <relation_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.1 published on Thursday, Sep 26, 2024 by splightplatform
    splightplatform/pulumi-splight