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

splight.Component

Explore with Pulumi AI

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

    Example Usage

    Create Component Resource

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

    Constructor syntax

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

@overload
def Component(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              version: Optional[str] = None,
              description: Optional[str] = None,
              inputs: Optional[Sequence[ComponentInputArgs]] = None,
              name: Optional[str] = None,
              tags: Optional[Sequence[ComponentTagArgs]] = None)
    func NewComponent(ctx *Context, name string, args ComponentArgs, opts ...ResourceOption) (*Component, error)
    public Component(string name, ComponentArgs args, CustomResourceOptions? opts = null)
    public Component(String name, ComponentArgs args)
public Component(String name, ComponentArgs args, CustomResourceOptions options)

    type: splight:Component
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 ComponentArgs
    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 ComponentArgs
    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 ComponentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ComponentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ComponentArgs
    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 componentResource = new Splight.Component("componentResource", new()
{
    Version = "string",
    Description = "string",
    Inputs = new[]
    {
        new Splight.Inputs.ComponentInputArgs
        {
            Name = "string",
            Type = "string",
            Description = "string",
            Multiple = false,
            Required = false,
            Sensitive = false,
            Value = "string",
        },
    },
    Name = "string",
    Tags = new[]
    {
        new Splight.Inputs.ComponentTagArgs
        {
            Id = "string",
            Name = "string",
        },
    },
});

    example, err := splight.NewComponent(ctx, "componentResource", &splight.ComponentArgs{
	Version:     pulumi.String("string"),
	Description: pulumi.String("string"),
	Inputs: splight.ComponentInputTypeArray{
		&splight.ComponentInputTypeArgs{
			Name:        pulumi.String("string"),
			Type:        pulumi.String("string"),
			Description: pulumi.String("string"),
			Multiple:    pulumi.Bool(false),
			Required:    pulumi.Bool(false),
			Sensitive:   pulumi.Bool(false),
			Value:       pulumi.String("string"),
		},
	},
	Name: pulumi.String("string"),
	Tags: splight.ComponentTagArray{
		&splight.ComponentTagArgs{
			Id:   pulumi.String("string"),
			Name: pulumi.String("string"),
		},
	},
})

    var componentResource = new Component("componentResource", ComponentArgs.builder()
    .version("string")
    .description("string")
    .inputs(ComponentInputArgs.builder()
        .name("string")
        .type("string")
        .description("string")
        .multiple(false)
        .required(false)
        .sensitive(false)
        .value("string")
        .build())
    .name("string")
    .tags(ComponentTagArgs.builder()
        .id("string")
        .name("string")
        .build())
    .build());

    component_resource = splight.Component("componentResource",
    version="string",
    description="string",
    inputs=[splight.ComponentInputArgs(
        name="string",
        type="string",
        description="string",
        multiple=False,
        required=False,
        sensitive=False,
        value="string",
    )],
    name="string",
    tags=[splight.ComponentTagArgs(
        id="string",
        name="string",
    )])

    const componentResource = new splight.Component("componentResource", {
    version: "string",
    description: "string",
    inputs: [{
        name: "string",
        type: "string",
        description: "string",
        multiple: false,
        required: false,
        sensitive: false,
        value: "string",
    }],
    name: "string",
    tags: [{
        id: "string",
        name: "string",
    }],
});

    type: splight:Component
properties:
    description: string
    inputs:
        - description: string
          multiple: false
          name: string
          required: false
          sensitive: false
          type: string
          value: string
    name: string
    tags:
        - id: string
          name: string
    version: string

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

    Version string
    [NAME-VERSION] the version of the hub component
    Description string
    optional description to add details of the resource
    Inputs List<Splight.Splight.Inputs.ComponentInput>
    static config parameters of the routine
    Name string
    the name of the component to be created
    Tags List<Splight.Splight.Inputs.ComponentTag>
    tags of the resource
    Version string
    [NAME-VERSION] the version of the hub component
    Description string
    optional description to add details of the resource
    Inputs []ComponentInputTypeArgs
    static config parameters of the routine
    Name string
    the name of the component to be created
    Tags []ComponentTagArgs
    tags of the resource
    version String
    [NAME-VERSION] the version of the hub component
    description String
    optional description to add details of the resource
    inputs List<ComponentInput>
    static config parameters of the routine
    name String
    the name of the component to be created
    tags List<ComponentTag>
    tags of the resource
    version string
    [NAME-VERSION] the version of the hub component
    description string
    optional description to add details of the resource
    inputs ComponentInput[]
    static config parameters of the routine
    name string
    the name of the component to be created
    tags ComponentTag[]
    tags of the resource
    version str
    [NAME-VERSION] the version of the hub component
    description str
    optional description to add details of the resource
    inputs Sequence[ComponentInputArgs]
    static config parameters of the routine
    name str
    the name of the component to be created
    tags Sequence[ComponentTagArgs]
    tags of the resource
    version String
    [NAME-VERSION] the version of the hub component
    description String
    optional description to add details of the resource
    inputs List<Property Map>
    static config parameters of the routine
    name String
    the name of the component to be created
    tags List<Property Map>
    tags of the resource

    Outputs

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

    Get an existing Component 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?: ComponentState, opts?: CustomResourceOptions): Component
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        inputs: Optional[Sequence[ComponentInputArgs]] = None,
        name: Optional[str] = None,
        tags: Optional[Sequence[ComponentTagArgs]] = None,
        version: Optional[str] = None) -> Component
    func GetComponent(ctx *Context, name string, id IDInput, state *ComponentState, opts ...ResourceOption) (*Component, error)
    public static Component Get(string name, Input<string> id, ComponentState? state, CustomResourceOptions? opts = null)
    public static Component get(String name, Output<String> id, ComponentState 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
    optional description to add details of the resource
    Inputs List<Splight.Splight.Inputs.ComponentInput>
    static config parameters of the routine
    Name string
    the name of the component to be created
    Tags List<Splight.Splight.Inputs.ComponentTag>
    tags of the resource
    Version string
    [NAME-VERSION] the version of the hub component
    Description string
    optional description to add details of the resource
    Inputs []ComponentInputTypeArgs
    static config parameters of the routine
    Name string
    the name of the component to be created
    Tags []ComponentTagArgs
    tags of the resource
    Version string
    [NAME-VERSION] the version of the hub component
    description String
    optional description to add details of the resource
    inputs List<ComponentInput>
    static config parameters of the routine
    name String
    the name of the component to be created
    tags List<ComponentTag>
    tags of the resource
    version String
    [NAME-VERSION] the version of the hub component
    description string
    optional description to add details of the resource
    inputs ComponentInput[]
    static config parameters of the routine
    name string
    the name of the component to be created
    tags ComponentTag[]
    tags of the resource
    version string
    [NAME-VERSION] the version of the hub component
    description str
    optional description to add details of the resource
    inputs Sequence[ComponentInputArgs]
    static config parameters of the routine
    name str
    the name of the component to be created
    tags Sequence[ComponentTagArgs]
    tags of the resource
    version str
    [NAME-VERSION] the version of the hub component
    description String
    optional description to add details of the resource
    inputs List<Property Map>
    static config parameters of the routine
    name String
    the name of the component to be created
    tags List<Property Map>
    tags of the resource
    version String
    [NAME-VERSION] the version of the hub component

    Supporting Types

    ComponentInput, ComponentInputArgs

    Name string
    Type string
    Description string
    Multiple bool
    Required bool
    Sensitive bool
    Value string
    Name string
    Type string
    Description string
    Multiple bool
    Required bool
    Sensitive bool
    Value string
    name String
    type String
    description String
    multiple Boolean
    required Boolean
    sensitive Boolean
    value String
    name string
    type string
    description string
    multiple boolean
    required boolean
    sensitive boolean
    value string
    name String
    type String
    description String
    multiple Boolean
    required Boolean
    sensitive Boolean
    value String

    ComponentTag, ComponentTagArgs

    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/component:Component [options] splight_component.<name> <component_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