1. Packages
  2. Talos Linux
  3. API Docs
  4. imageFactory
  5. Schematic
talos v0.4.1 published on Tuesday, Nov 5, 2024 by Pulumiverse

talos.imageFactory.Schematic

Explore with Pulumi AI

talos logo
talos v0.4.1 published on Tuesday, Nov 5, 2024 by Pulumiverse

    The image factory schematic resource allows you to create a schematic for a Talos image.

    Create Schematic Resource

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

    Constructor syntax

    new Schematic(name: string, args?: SchematicArgs, opts?: CustomResourceOptions);
    @overload
    def Schematic(resource_name: str,
                  args: Optional[SchematicArgs] = None,
                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def Schematic(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  schematic: Optional[str] = None)
    func NewSchematic(ctx *Context, name string, args *SchematicArgs, opts ...ResourceOption) (*Schematic, error)
    public Schematic(string name, SchematicArgs? args = null, CustomResourceOptions? opts = null)
    public Schematic(String name, SchematicArgs args)
    public Schematic(String name, SchematicArgs args, CustomResourceOptions options)
    
    type: talos:imageFactory:Schematic
    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 SchematicArgs
    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 SchematicArgs
    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 SchematicArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SchematicArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SchematicArgs
    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 schematicResource = new Talos.ImageFactory.Schematic("schematicResource", new()
    {
        SchematicData = "string",
    });
    
    example, err := imageFactory.NewSchematic(ctx, "schematicResource", &imageFactory.SchematicArgs{
    	Schematic: pulumi.String("string"),
    })
    
    var schematicResource = new Schematic("schematicResource", SchematicArgs.builder()
        .schematic("string")
        .build());
    
    schematic_resource = talos.image_factory.Schematic("schematicResource", schematic="string")
    
    const schematicResource = new talos.imagefactory.Schematic("schematicResource", {schematic: "string"});
    
    type: talos:imageFactory:Schematic
    properties:
        schematic: string
    

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

    SchematicData string
    The schematic yaml respresentation to generate the image.
    Schematic string
    The schematic yaml respresentation to generate the image.
    schematic String
    The schematic yaml respresentation to generate the image.
    schematic string
    The schematic yaml respresentation to generate the image.
    schematic str
    The schematic yaml respresentation to generate the image.
    schematic String
    The schematic yaml respresentation to generate the image.

    Outputs

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

    Get an existing Schematic 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?: SchematicState, opts?: CustomResourceOptions): Schematic
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            schematic: Optional[str] = None) -> Schematic
    func GetSchematic(ctx *Context, name string, id IDInput, state *SchematicState, opts ...ResourceOption) (*Schematic, error)
    public static Schematic Get(string name, Input<string> id, SchematicState? state, CustomResourceOptions? opts = null)
    public static Schematic get(String name, Output<String> id, SchematicState 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:
    SchematicData string
    The schematic yaml respresentation to generate the image.
    Schematic string
    The schematic yaml respresentation to generate the image.
    schematic String
    The schematic yaml respresentation to generate the image.
    schematic string
    The schematic yaml respresentation to generate the image.
    schematic str
    The schematic yaml respresentation to generate the image.
    schematic String
    The schematic yaml respresentation to generate the image.

    Package Details

    Repository
    talos pulumiverse/pulumi-talos
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the talos Terraform Provider.
    talos logo
    talos v0.4.1 published on Tuesday, Nov 5, 2024 by Pulumiverse