1. Packages
  2. Vra Provider
  3. API Docs
  4. CatalogSourceBlueprint
vra 0.12.0 published on Monday, Apr 14, 2025 by vmware

vra.CatalogSourceBlueprint

Explore with Pulumi AI

vra logo
vra 0.12.0 published on Monday, Apr 14, 2025 by vmware

    Creates a VMware vRealize Automation catalog source resource of type cloud template, formerly known as a blueprint.

    Example Usage

    S

    The following example shows how to create a catalog source resource.

    import * as pulumi from "@pulumi/pulumi";
    import * as vra from "@pulumi/vra";
    
    const _this = new vra.CatalogSourceBlueprint("this", {projectId: _var.vra_project_id});
    
    import pulumi
    import pulumi_vra as vra
    
    this = vra.CatalogSourceBlueprint("this", project_id=var["vra_project_id"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/vra/vra"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := vra.NewCatalogSourceBlueprint(ctx, "this", &vra.CatalogSourceBlueprintArgs{
    			ProjectId: pulumi.Any(_var.Vra_project_id),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Vra = Pulumi.Vra;
    
    return await Deployment.RunAsync(() => 
    {
        var @this = new Vra.CatalogSourceBlueprint("this", new()
        {
            ProjectId = @var.Vra_project_id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.vra.CatalogSourceBlueprint;
    import com.pulumi.vra.CatalogSourceBlueprintArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var this_ = new CatalogSourceBlueprint("this", CatalogSourceBlueprintArgs.builder()
                .projectId(var_.vra_project_id())
                .build());
    
        }
    }
    
    resources:
      this:
        type: vra:CatalogSourceBlueprint
        properties:
          projectId: ${var.vra_project_id}
    

    Attribute Reference

    • created_at - Date when entity was created. Date and time format is ISO 8601 and UTC.

    • created_by - User who created the entity.

    • global - Flag indicating that all items can be requested across all projects.

    • id - ID of catalog source.

    • items_found - Number of items found in the catalog source.

    • items_imported - Number of items imported from the catalog source.

    • last_import_completed_at - Time at which the last import completed.

    • last_import_errors - List of errors seen when the catalog source was last imported.

    • last_import_started_at - Time at which the last import started.

    • last_updated_by - User who last updated the catalog source.

    • type_id - Type of catalog source. Example: blueprint, CFT, etc.

    Create CatalogSourceBlueprint Resource

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

    Constructor syntax

    new CatalogSourceBlueprint(name: string, args: CatalogSourceBlueprintArgs, opts?: CustomResourceOptions);
    @overload
    def CatalogSourceBlueprint(resource_name: str,
                               args: CatalogSourceBlueprintArgs,
                               opts: Optional[ResourceOptions] = None)
    
    @overload
    def CatalogSourceBlueprint(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               project_id: Optional[str] = None,
                               catalog_source_blueprint_id: Optional[str] = None,
                               config: Optional[Mapping[str, str]] = None,
                               description: Optional[str] = None,
                               name: Optional[str] = None)
    func NewCatalogSourceBlueprint(ctx *Context, name string, args CatalogSourceBlueprintArgs, opts ...ResourceOption) (*CatalogSourceBlueprint, error)
    public CatalogSourceBlueprint(string name, CatalogSourceBlueprintArgs args, CustomResourceOptions? opts = null)
    public CatalogSourceBlueprint(String name, CatalogSourceBlueprintArgs args)
    public CatalogSourceBlueprint(String name, CatalogSourceBlueprintArgs args, CustomResourceOptions options)
    
    type: vra:CatalogSourceBlueprint
    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 CatalogSourceBlueprintArgs
    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 CatalogSourceBlueprintArgs
    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 CatalogSourceBlueprintArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CatalogSourceBlueprintArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CatalogSourceBlueprintArgs
    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 catalogSourceBlueprintResource = new Vra.CatalogSourceBlueprint("catalogSourceBlueprintResource", new()
    {
        ProjectId = "string",
        CatalogSourceBlueprintId = "string",
        Config = 
        {
            { "string", "string" },
        },
        Description = "string",
        Name = "string",
    });
    
    example, err := vra.NewCatalogSourceBlueprint(ctx, "catalogSourceBlueprintResource", &vra.CatalogSourceBlueprintArgs{
    	ProjectId:                pulumi.String("string"),
    	CatalogSourceBlueprintId: pulumi.String("string"),
    	Config: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Description: pulumi.String("string"),
    	Name:        pulumi.String("string"),
    })
    
    var catalogSourceBlueprintResource = new CatalogSourceBlueprint("catalogSourceBlueprintResource", CatalogSourceBlueprintArgs.builder()
        .projectId("string")
        .catalogSourceBlueprintId("string")
        .config(Map.of("string", "string"))
        .description("string")
        .name("string")
        .build());
    
    catalog_source_blueprint_resource = vra.CatalogSourceBlueprint("catalogSourceBlueprintResource",
        project_id="string",
        catalog_source_blueprint_id="string",
        config={
            "string": "string",
        },
        description="string",
        name="string")
    
    const catalogSourceBlueprintResource = new vra.CatalogSourceBlueprint("catalogSourceBlueprintResource", {
        projectId: "string",
        catalogSourceBlueprintId: "string",
        config: {
            string: "string",
        },
        description: "string",
        name: "string",
    });
    
    type: vra:CatalogSourceBlueprint
    properties:
        catalogSourceBlueprintId: string
        config:
            string: string
        description: string
        name: string
        projectId: string
    

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

    ProjectId string
    ID of the project this entity belongs to.
    CatalogSourceBlueprintId string
    Config Dictionary<string, string>
    Custom configuration of the catalog source as a map of key values.
    Description string
    Human-friendly description.
    Name string
    Human-friendly name used as an identifier in APIs that support this option.
    ProjectId string
    ID of the project this entity belongs to.
    CatalogSourceBlueprintId string
    Config map[string]string
    Custom configuration of the catalog source as a map of key values.
    Description string
    Human-friendly description.
    Name string
    Human-friendly name used as an identifier in APIs that support this option.
    projectId String
    ID of the project this entity belongs to.
    catalogSourceBlueprintId String
    config Map<String,String>
    Custom configuration of the catalog source as a map of key values.
    description String
    Human-friendly description.
    name String
    Human-friendly name used as an identifier in APIs that support this option.
    projectId string
    ID of the project this entity belongs to.
    catalogSourceBlueprintId string
    config {[key: string]: string}
    Custom configuration of the catalog source as a map of key values.
    description string
    Human-friendly description.
    name string
    Human-friendly name used as an identifier in APIs that support this option.
    project_id str
    ID of the project this entity belongs to.
    catalog_source_blueprint_id str
    config Mapping[str, str]
    Custom configuration of the catalog source as a map of key values.
    description str
    Human-friendly description.
    name str
    Human-friendly name used as an identifier in APIs that support this option.
    projectId String
    ID of the project this entity belongs to.
    catalogSourceBlueprintId String
    config Map<String>
    Custom configuration of the catalog source as a map of key values.
    description String
    Human-friendly description.
    name String
    Human-friendly name used as an identifier in APIs that support this option.

    Outputs

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

    CreatedAt string
    CreatedBy string
    Global bool
    Id string
    The provider-assigned unique ID for this managed resource.
    ItemsFound string
    ItemsImported string
    LastImportCompletedAt string
    LastImportErrors List<string>
    LastImportStartedAt string
    LastUpdatedBy string
    TypeId string
    CreatedAt string
    CreatedBy string
    Global bool
    Id string
    The provider-assigned unique ID for this managed resource.
    ItemsFound string
    ItemsImported string
    LastImportCompletedAt string
    LastImportErrors []string
    LastImportStartedAt string
    LastUpdatedBy string
    TypeId string
    createdAt String
    createdBy String
    global Boolean
    id String
    The provider-assigned unique ID for this managed resource.
    itemsFound String
    itemsImported String
    lastImportCompletedAt String
    lastImportErrors List<String>
    lastImportStartedAt String
    lastUpdatedBy String
    typeId String
    createdAt string
    createdBy string
    global boolean
    id string
    The provider-assigned unique ID for this managed resource.
    itemsFound string
    itemsImported string
    lastImportCompletedAt string
    lastImportErrors string[]
    lastImportStartedAt string
    lastUpdatedBy string
    typeId string
    created_at str
    created_by str
    global_ bool
    id str
    The provider-assigned unique ID for this managed resource.
    items_found str
    items_imported str
    last_import_completed_at str
    last_import_errors Sequence[str]
    last_import_started_at str
    last_updated_by str
    type_id str
    createdAt String
    createdBy String
    global Boolean
    id String
    The provider-assigned unique ID for this managed resource.
    itemsFound String
    itemsImported String
    lastImportCompletedAt String
    lastImportErrors List<String>
    lastImportStartedAt String
    lastUpdatedBy String
    typeId String

    Look up Existing CatalogSourceBlueprint Resource

    Get an existing CatalogSourceBlueprint 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?: CatalogSourceBlueprintState, opts?: CustomResourceOptions): CatalogSourceBlueprint
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            catalog_source_blueprint_id: Optional[str] = None,
            config: Optional[Mapping[str, str]] = None,
            created_at: Optional[str] = None,
            created_by: Optional[str] = None,
            description: Optional[str] = None,
            global_: Optional[bool] = None,
            items_found: Optional[str] = None,
            items_imported: Optional[str] = None,
            last_import_completed_at: Optional[str] = None,
            last_import_errors: Optional[Sequence[str]] = None,
            last_import_started_at: Optional[str] = None,
            last_updated_by: Optional[str] = None,
            name: Optional[str] = None,
            project_id: Optional[str] = None,
            type_id: Optional[str] = None) -> CatalogSourceBlueprint
    func GetCatalogSourceBlueprint(ctx *Context, name string, id IDInput, state *CatalogSourceBlueprintState, opts ...ResourceOption) (*CatalogSourceBlueprint, error)
    public static CatalogSourceBlueprint Get(string name, Input<string> id, CatalogSourceBlueprintState? state, CustomResourceOptions? opts = null)
    public static CatalogSourceBlueprint get(String name, Output<String> id, CatalogSourceBlueprintState state, CustomResourceOptions options)
    resources:  _:    type: vra:CatalogSourceBlueprint    get:      id: ${id}
    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:
    CatalogSourceBlueprintId string
    Config Dictionary<string, string>
    Custom configuration of the catalog source as a map of key values.
    CreatedAt string
    CreatedBy string
    Description string
    Human-friendly description.
    Global bool
    ItemsFound string
    ItemsImported string
    LastImportCompletedAt string
    LastImportErrors List<string>
    LastImportStartedAt string
    LastUpdatedBy string
    Name string
    Human-friendly name used as an identifier in APIs that support this option.
    ProjectId string
    ID of the project this entity belongs to.
    TypeId string
    CatalogSourceBlueprintId string
    Config map[string]string
    Custom configuration of the catalog source as a map of key values.
    CreatedAt string
    CreatedBy string
    Description string
    Human-friendly description.
    Global bool
    ItemsFound string
    ItemsImported string
    LastImportCompletedAt string
    LastImportErrors []string
    LastImportStartedAt string
    LastUpdatedBy string
    Name string
    Human-friendly name used as an identifier in APIs that support this option.
    ProjectId string
    ID of the project this entity belongs to.
    TypeId string
    catalogSourceBlueprintId String
    config Map<String,String>
    Custom configuration of the catalog source as a map of key values.
    createdAt String
    createdBy String
    description String
    Human-friendly description.
    global Boolean
    itemsFound String
    itemsImported String
    lastImportCompletedAt String
    lastImportErrors List<String>
    lastImportStartedAt String
    lastUpdatedBy String
    name String
    Human-friendly name used as an identifier in APIs that support this option.
    projectId String
    ID of the project this entity belongs to.
    typeId String
    catalogSourceBlueprintId string
    config {[key: string]: string}
    Custom configuration of the catalog source as a map of key values.
    createdAt string
    createdBy string
    description string
    Human-friendly description.
    global boolean
    itemsFound string
    itemsImported string
    lastImportCompletedAt string
    lastImportErrors string[]
    lastImportStartedAt string
    lastUpdatedBy string
    name string
    Human-friendly name used as an identifier in APIs that support this option.
    projectId string
    ID of the project this entity belongs to.
    typeId string
    catalog_source_blueprint_id str
    config Mapping[str, str]
    Custom configuration of the catalog source as a map of key values.
    created_at str
    created_by str
    description str
    Human-friendly description.
    global_ bool
    items_found str
    items_imported str
    last_import_completed_at str
    last_import_errors Sequence[str]
    last_import_started_at str
    last_updated_by str
    name str
    Human-friendly name used as an identifier in APIs that support this option.
    project_id str
    ID of the project this entity belongs to.
    type_id str
    catalogSourceBlueprintId String
    config Map<String>
    Custom configuration of the catalog source as a map of key values.
    createdAt String
    createdBy String
    description String
    Human-friendly description.
    global Boolean
    itemsFound String
    itemsImported String
    lastImportCompletedAt String
    lastImportErrors List<String>
    lastImportStartedAt String
    lastUpdatedBy String
    name String
    Human-friendly name used as an identifier in APIs that support this option.
    projectId String
    ID of the project this entity belongs to.
    typeId String

    Import

    To import the cloud template catalog source, use the ID as in the following example:

    $ pulumi import vra:index/catalogSourceBlueprint:CatalogSourceBlueprint this 05956583-6488-4e7d-84c9-92a7b7219a15`
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    vra vmware/terraform-provider-vra
    License
    Notes
    This Pulumi package is based on the vra Terraform Provider.
    vra logo
    vra 0.12.0 published on Monday, Apr 14, 2025 by vmware