Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Harness Provider
  3. API Docs
  4. platform
  5. Template
Harness v0.4.4 published on Tuesday, Nov 12, 2024 by Pulumi
pulumi/pulumi-harness

harness.platform.Template

Explore with Pulumi AI

harness logo
Harness v0.4.4 published on Tuesday, Nov 12, 2024 by Pulumi
pulumi/pulumi-harness

    Resource for creating a Template. Description field is deprecated

    Create Template Resource

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

    Constructor syntax

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

@overload
def Template(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             identifier: Optional[str] = None,
             version: Optional[str] = None,
             import_from_git: Optional[bool] = None,
             git_details: Optional[TemplateGitDetailsArgs] = None,
             git_import_details: Optional[TemplateGitImportDetailsArgs] = None,
             force_delete: Optional[str] = None,
             comments: Optional[str] = None,
             is_stable: Optional[bool] = None,
             name: Optional[str] = None,
             org_id: Optional[str] = None,
             project_id: Optional[str] = None,
             tags: Optional[Sequence[str]] = None,
             template_import_request: Optional[TemplateTemplateImportRequestArgs] = None,
             template_yaml: Optional[str] = None,
             description: Optional[str] = None)
    func NewTemplate(ctx *Context, name string, args TemplateArgs, opts ...ResourceOption) (*Template, error)
    public Template(string name, TemplateArgs args, CustomResourceOptions? opts = null)
    public Template(String name, TemplateArgs args)
public Template(String name, TemplateArgs args, CustomResourceOptions options)

    type: harness:platform:Template
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 TemplateArgs
    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 TemplateArgs
    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 TemplateArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TemplateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TemplateArgs
    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 templateResource = new Harness.Platform.Template("templateResource", new()
{
    Identifier = "string",
    Version = "string",
    ImportFromGit = false,
    GitDetails = new Harness.Platform.Inputs.TemplateGitDetailsArgs
    {
        BaseBranch = "string",
        BranchName = "string",
        CommitMessage = "string",
        ConnectorRef = "string",
        FilePath = "string",
        LastCommitId = "string",
        LastObjectId = "string",
        RepoName = "string",
        StoreType = "string",
    },
    GitImportDetails = new Harness.Platform.Inputs.TemplateGitImportDetailsArgs
    {
        BranchName = "string",
        ConnectorRef = "string",
        FilePath = "string",
        IsForceImport = false,
        RepoName = "string",
    },
    ForceDelete = "string",
    Comments = "string",
    IsStable = false,
    Name = "string",
    OrgId = "string",
    ProjectId = "string",
    Tags = new[]
    {
        "string",
    },
    TemplateImportRequest = new Harness.Platform.Inputs.TemplateTemplateImportRequestArgs
    {
        TemplateDescription = "string",
        TemplateName = "string",
        TemplateVersion = "string",
    },
    TemplateYaml = "string",
});

    example, err := platform.NewTemplate(ctx, "templateResource", &platform.TemplateArgs{
	Identifier:    pulumi.String("string"),
	Version:       pulumi.String("string"),
	ImportFromGit: pulumi.Bool(false),
	GitDetails: &platform.TemplateGitDetailsArgs{
		BaseBranch:    pulumi.String("string"),
		BranchName:    pulumi.String("string"),
		CommitMessage: pulumi.String("string"),
		ConnectorRef:  pulumi.String("string"),
		FilePath:      pulumi.String("string"),
		LastCommitId:  pulumi.String("string"),
		LastObjectId:  pulumi.String("string"),
		RepoName:      pulumi.String("string"),
		StoreType:     pulumi.String("string"),
	},
	GitImportDetails: &platform.TemplateGitImportDetailsArgs{
		BranchName:    pulumi.String("string"),
		ConnectorRef:  pulumi.String("string"),
		FilePath:      pulumi.String("string"),
		IsForceImport: pulumi.Bool(false),
		RepoName:      pulumi.String("string"),
	},
	ForceDelete: pulumi.String("string"),
	Comments:    pulumi.String("string"),
	IsStable:    pulumi.Bool(false),
	Name:        pulumi.String("string"),
	OrgId:       pulumi.String("string"),
	ProjectId:   pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	TemplateImportRequest: &platform.TemplateTemplateImportRequestArgs{
		TemplateDescription: pulumi.String("string"),
		TemplateName:        pulumi.String("string"),
		TemplateVersion:     pulumi.String("string"),
	},
	TemplateYaml: pulumi.String("string"),
})

    var templateResource = new Template("templateResource", TemplateArgs.builder()
    .identifier("string")
    .version("string")
    .importFromGit(false)
    .gitDetails(TemplateGitDetailsArgs.builder()
        .baseBranch("string")
        .branchName("string")
        .commitMessage("string")
        .connectorRef("string")
        .filePath("string")
        .lastCommitId("string")
        .lastObjectId("string")
        .repoName("string")
        .storeType("string")
        .build())
    .gitImportDetails(TemplateGitImportDetailsArgs.builder()
        .branchName("string")
        .connectorRef("string")
        .filePath("string")
        .isForceImport(false)
        .repoName("string")
        .build())
    .forceDelete("string")
    .comments("string")
    .isStable(false)
    .name("string")
    .orgId("string")
    .projectId("string")
    .tags("string")
    .templateImportRequest(TemplateTemplateImportRequestArgs.builder()
        .templateDescription("string")
        .templateName("string")
        .templateVersion("string")
        .build())
    .templateYaml("string")
    .build());

    template_resource = harness.platform.Template("templateResource",
    identifier="string",
    version="string",
    import_from_git=False,
    git_details={
        "base_branch": "string",
        "branch_name": "string",
        "commit_message": "string",
        "connector_ref": "string",
        "file_path": "string",
        "last_commit_id": "string",
        "last_object_id": "string",
        "repo_name": "string",
        "store_type": "string",
    },
    git_import_details={
        "branch_name": "string",
        "connector_ref": "string",
        "file_path": "string",
        "is_force_import": False,
        "repo_name": "string",
    },
    force_delete="string",
    comments="string",
    is_stable=False,
    name="string",
    org_id="string",
    project_id="string",
    tags=["string"],
    template_import_request={
        "template_description": "string",
        "template_name": "string",
        "template_version": "string",
    },
    template_yaml="string")

    const templateResource = new harness.platform.Template("templateResource", {
    identifier: "string",
    version: "string",
    importFromGit: false,
    gitDetails: {
        baseBranch: "string",
        branchName: "string",
        commitMessage: "string",
        connectorRef: "string",
        filePath: "string",
        lastCommitId: "string",
        lastObjectId: "string",
        repoName: "string",
        storeType: "string",
    },
    gitImportDetails: {
        branchName: "string",
        connectorRef: "string",
        filePath: "string",
        isForceImport: false,
        repoName: "string",
    },
    forceDelete: "string",
    comments: "string",
    isStable: false,
    name: "string",
    orgId: "string",
    projectId: "string",
    tags: ["string"],
    templateImportRequest: {
        templateDescription: "string",
        templateName: "string",
        templateVersion: "string",
    },
    templateYaml: "string",
});

    type: harness:platform:Template
properties:
    comments: string
    forceDelete: string
    gitDetails:
        baseBranch: string
        branchName: string
        commitMessage: string
        connectorRef: string
        filePath: string
        lastCommitId: string
        lastObjectId: string
        repoName: string
        storeType: string
    gitImportDetails:
        branchName: string
        connectorRef: string
        filePath: string
        isForceImport: false
        repoName: string
    identifier: string
    importFromGit: false
    isStable: false
    name: string
    orgId: string
    projectId: string
    tags:
        - string
    templateImportRequest:
        templateDescription: string
        templateName: string
        templateVersion: string
    templateYaml: string
    version: string

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

    Identifier string
    Unique identifier of the resource
    Version string
    Version Label for Template.
    Comments string
    Specify comment with respect to changes.
    Description string
    Description of the entity. Description field is deprecated

    Deprecated: description field is deprecated

    ForceDelete string
    Enable this flag for force deletion of template. It will delete the Harness entity even if your pipelines or other entities reference it
    GitDetails TemplateGitDetails
    Contains parameters related to creating an Entity for Git Experience.
    GitImportDetails TemplateGitImportDetails
    Contains Git Information for importing entities from Git
    ImportFromGit bool
    Flag to set if importing from Git
    IsStable bool
    True if given version for template to be set as stable.
    Name string
    Name of the Variable
    OrgId string
    Organization Identifier for the Entity
    ProjectId string
    Project Identifier for the Entity
    Tags List<string>
    Tags to associate with the resource.
    TemplateImportRequest TemplateTemplateImportRequest
    Contains parameters for importing template.
    TemplateYaml string
    Yaml for creating new Template. In YAML, to reference an entity at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference an entity at the account scope, prefix 'account` to the expression: account.{identifier}. For eg, to reference a connector with identifier 'connectorId' at the organization scope in a stage mention it as connectorRef: org.connectorId.
    Identifier string
    Unique identifier of the resource
    Version string
    Version Label for Template.
    Comments string
    Specify comment with respect to changes.
    Description string
    Description of the entity. Description field is deprecated

    Deprecated: description field is deprecated

    ForceDelete string
    Enable this flag for force deletion of template. It will delete the Harness entity even if your pipelines or other entities reference it
    GitDetails TemplateGitDetailsArgs
    Contains parameters related to creating an Entity for Git Experience.
    GitImportDetails TemplateGitImportDetailsArgs
    Contains Git Information for importing entities from Git
    ImportFromGit bool
    Flag to set if importing from Git
    IsStable bool
    True if given version for template to be set as stable.
    Name string
    Name of the Variable
    OrgId string
    Organization Identifier for the Entity
    ProjectId string
    Project Identifier for the Entity
    Tags []string
    Tags to associate with the resource.
    TemplateImportRequest TemplateTemplateImportRequestArgs
    Contains parameters for importing template.
    TemplateYaml string
    Yaml for creating new Template. In YAML, to reference an entity at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference an entity at the account scope, prefix 'account` to the expression: account.{identifier}. For eg, to reference a connector with identifier 'connectorId' at the organization scope in a stage mention it as connectorRef: org.connectorId.
    identifier String
    Unique identifier of the resource
    version String
    Version Label for Template.
    comments String
    Specify comment with respect to changes.
    description String
    Description of the entity. Description field is deprecated

    Deprecated: description field is deprecated

    forceDelete String
    Enable this flag for force deletion of template. It will delete the Harness entity even if your pipelines or other entities reference it
    gitDetails TemplateGitDetails
    Contains parameters related to creating an Entity for Git Experience.
    gitImportDetails TemplateGitImportDetails
    Contains Git Information for importing entities from Git
    importFromGit Boolean
    Flag to set if importing from Git
    isStable Boolean
    True if given version for template to be set as stable.
    name String
    Name of the Variable
    orgId String
    Organization Identifier for the Entity
    projectId String
    Project Identifier for the Entity
    tags List<String>
    Tags to associate with the resource.
    templateImportRequest TemplateTemplateImportRequest
    Contains parameters for importing template.
    templateYaml String
    Yaml for creating new Template. In YAML, to reference an entity at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference an entity at the account scope, prefix 'account` to the expression: account.{identifier}. For eg, to reference a connector with identifier 'connectorId' at the organization scope in a stage mention it as connectorRef: org.connectorId.
    identifier string
    Unique identifier of the resource
    version string
    Version Label for Template.
    comments string
    Specify comment with respect to changes.
    description string
    Description of the entity. Description field is deprecated

    Deprecated: description field is deprecated

    forceDelete string
    Enable this flag for force deletion of template. It will delete the Harness entity even if your pipelines or other entities reference it
    gitDetails TemplateGitDetails
    Contains parameters related to creating an Entity for Git Experience.
    gitImportDetails TemplateGitImportDetails
    Contains Git Information for importing entities from Git
    importFromGit boolean
    Flag to set if importing from Git
    isStable boolean
    True if given version for template to be set as stable.
    name string
    Name of the Variable
    orgId string
    Organization Identifier for the Entity
    projectId string
    Project Identifier for the Entity
    tags string[]
    Tags to associate with the resource.
    templateImportRequest TemplateTemplateImportRequest
    Contains parameters for importing template.
    templateYaml string
    Yaml for creating new Template. In YAML, to reference an entity at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference an entity at the account scope, prefix 'account` to the expression: account.{identifier}. For eg, to reference a connector with identifier 'connectorId' at the organization scope in a stage mention it as connectorRef: org.connectorId.
    identifier str
    Unique identifier of the resource
    version str
    Version Label for Template.
    comments str
    Specify comment with respect to changes.
    description str
    Description of the entity. Description field is deprecated

    Deprecated: description field is deprecated

    force_delete str
    Enable this flag for force deletion of template. It will delete the Harness entity even if your pipelines or other entities reference it
    git_details TemplateGitDetailsArgs
    Contains parameters related to creating an Entity for Git Experience.
    git_import_details TemplateGitImportDetailsArgs
    Contains Git Information for importing entities from Git
    import_from_git bool
    Flag to set if importing from Git
    is_stable bool
    True if given version for template to be set as stable.
    name str
    Name of the Variable
    org_id str
    Organization Identifier for the Entity
    project_id str
    Project Identifier for the Entity
    tags Sequence[str]
    Tags to associate with the resource.
    template_import_request TemplateTemplateImportRequestArgs
    Contains parameters for importing template.
    template_yaml str
    Yaml for creating new Template. In YAML, to reference an entity at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference an entity at the account scope, prefix 'account` to the expression: account.{identifier}. For eg, to reference a connector with identifier 'connectorId' at the organization scope in a stage mention it as connectorRef: org.connectorId.
    identifier String
    Unique identifier of the resource
    version String
    Version Label for Template.
    comments String
    Specify comment with respect to changes.
    description String
    Description of the entity. Description field is deprecated

    Deprecated: description field is deprecated

    forceDelete String
    Enable this flag for force deletion of template. It will delete the Harness entity even if your pipelines or other entities reference it
    gitDetails Property Map
    Contains parameters related to creating an Entity for Git Experience.
    gitImportDetails Property Map
    Contains Git Information for importing entities from Git
    importFromGit Boolean
    Flag to set if importing from Git
    isStable Boolean
    True if given version for template to be set as stable.
    name String
    Name of the Variable
    orgId String
    Organization Identifier for the Entity
    projectId String
    Project Identifier for the Entity
    tags List<String>
    Tags to associate with the resource.
    templateImportRequest Property Map
    Contains parameters for importing template.
    templateYaml String
    Yaml for creating new Template. In YAML, to reference an entity at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference an entity at the account scope, prefix 'account` to the expression: account.{identifier}. For eg, to reference a connector with identifier 'connectorId' at the organization scope in a stage mention it as connectorRef: org.connectorId.

    Outputs

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

    Get an existing Template 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?: TemplateState, opts?: CustomResourceOptions): Template
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        comments: Optional[str] = None,
        description: Optional[str] = None,
        force_delete: Optional[str] = None,
        git_details: Optional[TemplateGitDetailsArgs] = None,
        git_import_details: Optional[TemplateGitImportDetailsArgs] = None,
        identifier: Optional[str] = None,
        import_from_git: Optional[bool] = None,
        is_stable: Optional[bool] = None,
        name: Optional[str] = None,
        org_id: Optional[str] = None,
        project_id: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        template_import_request: Optional[TemplateTemplateImportRequestArgs] = None,
        template_yaml: Optional[str] = None,
        version: Optional[str] = None) -> Template
    func GetTemplate(ctx *Context, name string, id IDInput, state *TemplateState, opts ...ResourceOption) (*Template, error)
    public static Template Get(string name, Input<string> id, TemplateState? state, CustomResourceOptions? opts = null)
    public static Template get(String name, Output<String> id, TemplateState 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:
    Comments string
    Specify comment with respect to changes.
    Description string
    Description of the entity. Description field is deprecated

    Deprecated: description field is deprecated

    ForceDelete string
    Enable this flag for force deletion of template. It will delete the Harness entity even if your pipelines or other entities reference it
    GitDetails TemplateGitDetails
    Contains parameters related to creating an Entity for Git Experience.
    GitImportDetails TemplateGitImportDetails
    Contains Git Information for importing entities from Git
    Identifier string
    Unique identifier of the resource
    ImportFromGit bool
    Flag to set if importing from Git
    IsStable bool
    True if given version for template to be set as stable.
    Name string
    Name of the Variable
    OrgId string
    Organization Identifier for the Entity
    ProjectId string
    Project Identifier for the Entity
    Tags List<string>
    Tags to associate with the resource.
    TemplateImportRequest TemplateTemplateImportRequest
    Contains parameters for importing template.
    TemplateYaml string
    Yaml for creating new Template. In YAML, to reference an entity at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference an entity at the account scope, prefix 'account` to the expression: account.{identifier}. For eg, to reference a connector with identifier 'connectorId' at the organization scope in a stage mention it as connectorRef: org.connectorId.
    Version string
    Version Label for Template.
    Comments string
    Specify comment with respect to changes.
    Description string
    Description of the entity. Description field is deprecated

    Deprecated: description field is deprecated

    ForceDelete string
    Enable this flag for force deletion of template. It will delete the Harness entity even if your pipelines or other entities reference it
    GitDetails TemplateGitDetailsArgs
    Contains parameters related to creating an Entity for Git Experience.
    GitImportDetails TemplateGitImportDetailsArgs
    Contains Git Information for importing entities from Git
    Identifier string
    Unique identifier of the resource
    ImportFromGit bool
    Flag to set if importing from Git
    IsStable bool
    True if given version for template to be set as stable.
    Name string
    Name of the Variable
    OrgId string
    Organization Identifier for the Entity
    ProjectId string
    Project Identifier for the Entity
    Tags []string
    Tags to associate with the resource.
    TemplateImportRequest TemplateTemplateImportRequestArgs
    Contains parameters for importing template.
    TemplateYaml string
    Yaml for creating new Template. In YAML, to reference an entity at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference an entity at the account scope, prefix 'account` to the expression: account.{identifier}. For eg, to reference a connector with identifier 'connectorId' at the organization scope in a stage mention it as connectorRef: org.connectorId.
    Version string
    Version Label for Template.
    comments String
    Specify comment with respect to changes.
    description String
    Description of the entity. Description field is deprecated

    Deprecated: description field is deprecated

    forceDelete String
    Enable this flag for force deletion of template. It will delete the Harness entity even if your pipelines or other entities reference it
    gitDetails TemplateGitDetails
    Contains parameters related to creating an Entity for Git Experience.
    gitImportDetails TemplateGitImportDetails
    Contains Git Information for importing entities from Git
    identifier String
    Unique identifier of the resource
    importFromGit Boolean
    Flag to set if importing from Git
    isStable Boolean
    True if given version for template to be set as stable.
    name String
    Name of the Variable
    orgId String
    Organization Identifier for the Entity
    projectId String
    Project Identifier for the Entity
    tags List<String>
    Tags to associate with the resource.
    templateImportRequest TemplateTemplateImportRequest
    Contains parameters for importing template.
    templateYaml String
    Yaml for creating new Template. In YAML, to reference an entity at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference an entity at the account scope, prefix 'account` to the expression: account.{identifier}. For eg, to reference a connector with identifier 'connectorId' at the organization scope in a stage mention it as connectorRef: org.connectorId.
    version String
    Version Label for Template.
    comments string
    Specify comment with respect to changes.
    description string
    Description of the entity. Description field is deprecated

    Deprecated: description field is deprecated

    forceDelete string
    Enable this flag for force deletion of template. It will delete the Harness entity even if your pipelines or other entities reference it
    gitDetails TemplateGitDetails
    Contains parameters related to creating an Entity for Git Experience.
    gitImportDetails TemplateGitImportDetails
    Contains Git Information for importing entities from Git
    identifier string
    Unique identifier of the resource
    importFromGit boolean
    Flag to set if importing from Git
    isStable boolean
    True if given version for template to be set as stable.
    name string
    Name of the Variable
    orgId string
    Organization Identifier for the Entity
    projectId string
    Project Identifier for the Entity
    tags string[]
    Tags to associate with the resource.
    templateImportRequest TemplateTemplateImportRequest
    Contains parameters for importing template.
    templateYaml string
    Yaml for creating new Template. In YAML, to reference an entity at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference an entity at the account scope, prefix 'account` to the expression: account.{identifier}. For eg, to reference a connector with identifier 'connectorId' at the organization scope in a stage mention it as connectorRef: org.connectorId.
    version string
    Version Label for Template.
    comments str
    Specify comment with respect to changes.
    description str
    Description of the entity. Description field is deprecated

    Deprecated: description field is deprecated

    force_delete str
    Enable this flag for force deletion of template. It will delete the Harness entity even if your pipelines or other entities reference it
    git_details TemplateGitDetailsArgs
    Contains parameters related to creating an Entity for Git Experience.
    git_import_details TemplateGitImportDetailsArgs
    Contains Git Information for importing entities from Git
    identifier str
    Unique identifier of the resource
    import_from_git bool
    Flag to set if importing from Git
    is_stable bool
    True if given version for template to be set as stable.
    name str
    Name of the Variable
    org_id str
    Organization Identifier for the Entity
    project_id str
    Project Identifier for the Entity
    tags Sequence[str]
    Tags to associate with the resource.
    template_import_request TemplateTemplateImportRequestArgs
    Contains parameters for importing template.
    template_yaml str
    Yaml for creating new Template. In YAML, to reference an entity at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference an entity at the account scope, prefix 'account` to the expression: account.{identifier}. For eg, to reference a connector with identifier 'connectorId' at the organization scope in a stage mention it as connectorRef: org.connectorId.
    version str
    Version Label for Template.
    comments String
    Specify comment with respect to changes.
    description String
    Description of the entity. Description field is deprecated

    Deprecated: description field is deprecated

    forceDelete String
    Enable this flag for force deletion of template. It will delete the Harness entity even if your pipelines or other entities reference it
    gitDetails Property Map
    Contains parameters related to creating an Entity for Git Experience.
    gitImportDetails Property Map
    Contains Git Information for importing entities from Git
    identifier String
    Unique identifier of the resource
    importFromGit Boolean
    Flag to set if importing from Git
    isStable Boolean
    True if given version for template to be set as stable.
    name String
    Name of the Variable
    orgId String
    Organization Identifier for the Entity
    projectId String
    Project Identifier for the Entity
    tags List<String>
    Tags to associate with the resource.
    templateImportRequest Property Map
    Contains parameters for importing template.
    templateYaml String
    Yaml for creating new Template. In YAML, to reference an entity at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference an entity at the account scope, prefix 'account` to the expression: account.{identifier}. For eg, to reference a connector with identifier 'connectorId' at the organization scope in a stage mention it as connectorRef: org.connectorId.
    version String
    Version Label for Template.

    Supporting Types

    TemplateGitDetails, TemplateGitDetailsArgs

    BaseBranch string
    Name of the default branch (this checks out a new branch titled by branch_name).
    BranchName string
    Name of the branch.
    CommitMessage string
    Commit message used for the merge commit.
    ConnectorRef string
    Identifier of the Harness Connector used for CRUD operations on the Entity. To reference a connector at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a connector at the account scope, prefix 'account` to the expression: account.{identifier}.
    FilePath string
    File path of the Entity in the repository.
    LastCommitId string
    Last commit identifier (for Git Repositories other than Github). To be provided only when updating Pipeline.
    LastObjectId string
    Last object identifier (for Github). To be provided only when updating Pipeline.
    RepoName string
    Name of the repository.
    StoreType string
    Specifies whether the Entity is to be stored in Git or not. Possible values: INLINE, REMOTE.
    BaseBranch string
    Name of the default branch (this checks out a new branch titled by branch_name).
    BranchName string
    Name of the branch.
    CommitMessage string
    Commit message used for the merge commit.
    ConnectorRef string
    Identifier of the Harness Connector used for CRUD operations on the Entity. To reference a connector at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a connector at the account scope, prefix 'account` to the expression: account.{identifier}.
    FilePath string
    File path of the Entity in the repository.
    LastCommitId string
    Last commit identifier (for Git Repositories other than Github). To be provided only when updating Pipeline.
    LastObjectId string
    Last object identifier (for Github). To be provided only when updating Pipeline.
    RepoName string
    Name of the repository.
    StoreType string
    Specifies whether the Entity is to be stored in Git or not. Possible values: INLINE, REMOTE.
    baseBranch String
    Name of the default branch (this checks out a new branch titled by branch_name).
    branchName String
    Name of the branch.
    commitMessage String
    Commit message used for the merge commit.
    connectorRef String
    Identifier of the Harness Connector used for CRUD operations on the Entity. To reference a connector at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a connector at the account scope, prefix 'account` to the expression: account.{identifier}.
    filePath String
    File path of the Entity in the repository.
    lastCommitId String
    Last commit identifier (for Git Repositories other than Github). To be provided only when updating Pipeline.
    lastObjectId String
    Last object identifier (for Github). To be provided only when updating Pipeline.
    repoName String
    Name of the repository.
    storeType String
    Specifies whether the Entity is to be stored in Git or not. Possible values: INLINE, REMOTE.
    baseBranch string
    Name of the default branch (this checks out a new branch titled by branch_name).
    branchName string
    Name of the branch.
    commitMessage string
    Commit message used for the merge commit.
    connectorRef string
    Identifier of the Harness Connector used for CRUD operations on the Entity. To reference a connector at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a connector at the account scope, prefix 'account` to the expression: account.{identifier}.
    filePath string
    File path of the Entity in the repository.
    lastCommitId string
    Last commit identifier (for Git Repositories other than Github). To be provided only when updating Pipeline.
    lastObjectId string
    Last object identifier (for Github). To be provided only when updating Pipeline.
    repoName string
    Name of the repository.
    storeType string
    Specifies whether the Entity is to be stored in Git or not. Possible values: INLINE, REMOTE.
    base_branch str
    Name of the default branch (this checks out a new branch titled by branch_name).
    branch_name str
    Name of the branch.
    commit_message str
    Commit message used for the merge commit.
    connector_ref str
    Identifier of the Harness Connector used for CRUD operations on the Entity. To reference a connector at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a connector at the account scope, prefix 'account` to the expression: account.{identifier}.
    file_path str
    File path of the Entity in the repository.
    last_commit_id str
    Last commit identifier (for Git Repositories other than Github). To be provided only when updating Pipeline.
    last_object_id str
    Last object identifier (for Github). To be provided only when updating Pipeline.
    repo_name str
    Name of the repository.
    store_type str
    Specifies whether the Entity is to be stored in Git or not. Possible values: INLINE, REMOTE.
    baseBranch String
    Name of the default branch (this checks out a new branch titled by branch_name).
    branchName String
    Name of the branch.
    commitMessage String
    Commit message used for the merge commit.
    connectorRef String
    Identifier of the Harness Connector used for CRUD operations on the Entity. To reference a connector at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a connector at the account scope, prefix 'account` to the expression: account.{identifier}.
    filePath String
    File path of the Entity in the repository.
    lastCommitId String
    Last commit identifier (for Git Repositories other than Github). To be provided only when updating Pipeline.
    lastObjectId String
    Last object identifier (for Github). To be provided only when updating Pipeline.
    repoName String
    Name of the repository.
    storeType String
    Specifies whether the Entity is to be stored in Git or not. Possible values: INLINE, REMOTE.

    TemplateGitImportDetails, TemplateGitImportDetailsArgs

    BranchName string
    Name of the branch.
    ConnectorRef string
    Identifier of the Harness Connector used for importing entity from Git To reference a connector at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a connector at the account scope, prefix 'account` to the expression: account.{identifier}.
    FilePath string
    File path of the Entity in the repository.
    IsForceImport bool
    RepoName string
    Name of the repository.
    BranchName string
    Name of the branch.
    ConnectorRef string
    Identifier of the Harness Connector used for importing entity from Git To reference a connector at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a connector at the account scope, prefix 'account` to the expression: account.{identifier}.
    FilePath string
    File path of the Entity in the repository.
    IsForceImport bool
    RepoName string
    Name of the repository.
    branchName String
    Name of the branch.
    connectorRef String
    Identifier of the Harness Connector used for importing entity from Git To reference a connector at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a connector at the account scope, prefix 'account` to the expression: account.{identifier}.
    filePath String
    File path of the Entity in the repository.
    isForceImport Boolean
    repoName String
    Name of the repository.
    branchName string
    Name of the branch.
    connectorRef string
    Identifier of the Harness Connector used for importing entity from Git To reference a connector at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a connector at the account scope, prefix 'account` to the expression: account.{identifier}.
    filePath string
    File path of the Entity in the repository.
    isForceImport boolean
    repoName string
    Name of the repository.
    branch_name str
    Name of the branch.
    connector_ref str
    Identifier of the Harness Connector used for importing entity from Git To reference a connector at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a connector at the account scope, prefix 'account` to the expression: account.{identifier}.
    file_path str
    File path of the Entity in the repository.
    is_force_import bool
    repo_name str
    Name of the repository.
    branchName String
    Name of the branch.
    connectorRef String
    Identifier of the Harness Connector used for importing entity from Git To reference a connector at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a connector at the account scope, prefix 'account` to the expression: account.{identifier}.
    filePath String
    File path of the Entity in the repository.
    isForceImport Boolean
    repoName String
    Name of the repository.

    TemplateTemplateImportRequest, TemplateTemplateImportRequestArgs

    TemplateDescription string
    Description of the template.
    TemplateName string
    Name of the template.
    TemplateVersion string
    Version of the template.
    TemplateDescription string
    Description of the template.
    TemplateName string
    Name of the template.
    TemplateVersion string
    Version of the template.
    templateDescription String
    Description of the template.
    templateName String
    Name of the template.
    templateVersion String
    Version of the template.
    templateDescription string
    Description of the template.
    templateName string
    Name of the template.
    templateVersion string
    Version of the template.
    template_description str
    Description of the template.
    template_name str
    Name of the template.
    template_version str
    Version of the template.
    templateDescription String
    Description of the template.
    templateName String
    Name of the template.
    templateVersion String
    Version of the template.

    Import

    Import account level template

    $ pulumi import harness:platform/template:Template example <template_id>

    Import org level template

    $ pulumi import harness:platform/template:Template example <ord_id>/<template_id>

    Import project level template

    $ pulumi import harness:platform/template:Template example <org_id>/<project_id>/<template_id>

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

    Package Details

    Repository
    harness pulumi/pulumi-harness
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the harness Terraform Provider.
    harness logo
    Harness v0.4.4 published on Tuesday, Nov 12, 2024 by Pulumi
    pulumi/pulumi-harness