1. Packages
  2. Packages
  3. Harness Provider
  4. API Docs
  5. platform
  6. IacmAnsiblePlaybook
Viewing docs for Harness v0.13.1
published on Thursday, May 28, 2026 by Pulumi
harness logo
Viewing docs for Harness v0.13.1
published on Thursday, May 28, 2026 by Pulumi

    Resource for managing Harness IaCM Ansible Playbooks.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as harness from "@pulumi/harness";
    
    const example = new harness.platform.IacmAnsiblePlaybook("example", {
        identifier: "my_playbook",
        name: "my-playbook",
        orgId: exampleHarnessPlatformOrganization.id,
        projectId: exampleHarnessPlatformProject.id,
        repository: "https://github.com/org/repo",
        repositoryBranch: "main",
        repositoryPath: "ansible/site.yml",
        repositoryConnector: "account.my_github_connector",
        ansibleGalaxy: true,
        tags: ["env:prod"],
        vars: [{
            key: "environment",
            value: "production",
            valueType: "string",
        }],
        envVars: [{
            key: "ANSIBLE_CONFIG",
            value: "ansible.cfg",
            valueType: "string",
        }],
    });
    
    import pulumi
    import pulumi_harness as harness
    
    example = harness.platform.IacmAnsiblePlaybook("example",
        identifier="my_playbook",
        name="my-playbook",
        org_id=example_harness_platform_organization["id"],
        project_id=example_harness_platform_project["id"],
        repository="https://github.com/org/repo",
        repository_branch="main",
        repository_path="ansible/site.yml",
        repository_connector="account.my_github_connector",
        ansible_galaxy=True,
        tags=["env:prod"],
        vars=[{
            "key": "environment",
            "value": "production",
            "value_type": "string",
        }],
        env_vars=[{
            "key": "ANSIBLE_CONFIG",
            "value": "ansible.cfg",
            "value_type": "string",
        }])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-harness/sdk/go/harness/platform"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := platform.NewIacmAnsiblePlaybook(ctx, "example", &platform.IacmAnsiblePlaybookArgs{
    			Identifier:          pulumi.String("my_playbook"),
    			Name:                pulumi.String("my-playbook"),
    			OrgId:               pulumi.Any(exampleHarnessPlatformOrganization.Id),
    			ProjectId:           pulumi.Any(exampleHarnessPlatformProject.Id),
    			Repository:          pulumi.String("https://github.com/org/repo"),
    			RepositoryBranch:    pulumi.String("main"),
    			RepositoryPath:      pulumi.String("ansible/site.yml"),
    			RepositoryConnector: pulumi.String("account.my_github_connector"),
    			AnsibleGalaxy:       pulumi.Bool(true),
    			Tags: pulumi.StringArray{
    				pulumi.String("env:prod"),
    			},
    			Vars: platform.IacmAnsiblePlaybookVarArray{
    				&platform.IacmAnsiblePlaybookVarArgs{
    					Key:       pulumi.String("environment"),
    					Value:     pulumi.String("production"),
    					ValueType: pulumi.String("string"),
    				},
    			},
    			EnvVars: platform.IacmAnsiblePlaybookEnvVarArray{
    				&platform.IacmAnsiblePlaybookEnvVarArgs{
    					Key:       pulumi.String("ANSIBLE_CONFIG"),
    					Value:     pulumi.String("ansible.cfg"),
    					ValueType: pulumi.String("string"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Harness = Pulumi.Harness;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Harness.Platform.IacmAnsiblePlaybook("example", new()
        {
            Identifier = "my_playbook",
            Name = "my-playbook",
            OrgId = exampleHarnessPlatformOrganization.Id,
            ProjectId = exampleHarnessPlatformProject.Id,
            Repository = "https://github.com/org/repo",
            RepositoryBranch = "main",
            RepositoryPath = "ansible/site.yml",
            RepositoryConnector = "account.my_github_connector",
            AnsibleGalaxy = true,
            Tags = new[]
            {
                "env:prod",
            },
            Vars = new[]
            {
                new Harness.Platform.Inputs.IacmAnsiblePlaybookVarArgs
                {
                    Key = "environment",
                    Value = "production",
                    ValueType = "string",
                },
            },
            EnvVars = new[]
            {
                new Harness.Platform.Inputs.IacmAnsiblePlaybookEnvVarArgs
                {
                    Key = "ANSIBLE_CONFIG",
                    Value = "ansible.cfg",
                    ValueType = "string",
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.harness.platform.IacmAnsiblePlaybook;
    import com.pulumi.harness.platform.IacmAnsiblePlaybookArgs;
    import com.pulumi.harness.platform.inputs.IacmAnsiblePlaybookVarArgs;
    import com.pulumi.harness.platform.inputs.IacmAnsiblePlaybookEnvVarArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    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 example = new IacmAnsiblePlaybook("example", IacmAnsiblePlaybookArgs.builder()
                .identifier("my_playbook")
                .name("my-playbook")
                .orgId(exampleHarnessPlatformOrganization.id())
                .projectId(exampleHarnessPlatformProject.id())
                .repository("https://github.com/org/repo")
                .repositoryBranch("main")
                .repositoryPath("ansible/site.yml")
                .repositoryConnector("account.my_github_connector")
                .ansibleGalaxy(true)
                .tags("env:prod")
                .vars(IacmAnsiblePlaybookVarArgs.builder()
                    .key("environment")
                    .value("production")
                    .valueType("string")
                    .build())
                .envVars(IacmAnsiblePlaybookEnvVarArgs.builder()
                    .key("ANSIBLE_CONFIG")
                    .value("ansible.cfg")
                    .valueType("string")
                    .build())
                .build());
    
        }
    }
    
    resources:
      example:
        type: harness:platform:IacmAnsiblePlaybook
        properties:
          identifier: my_playbook
          name: my-playbook
          orgId: ${exampleHarnessPlatformOrganization.id}
          projectId: ${exampleHarnessPlatformProject.id}
          repository: https://github.com/org/repo
          repositoryBranch: main
          repositoryPath: ansible/site.yml
          repositoryConnector: account.my_github_connector
          ansibleGalaxy: true
          tags:
            - env:prod
          vars:
            - key: environment
              value: production
              valueType: string
          envVars:
            - key: ANSIBLE_CONFIG
              value: ansible.cfg
              valueType: string
    
    pulumi {
      required_providers {
        harness = {
          source = "pulumi/harness"
        }
      }
    }
    
    resource "harness_platform_iacmansibleplaybook" "example" {
      identifier           = "my_playbook"
      name                 = "my-playbook"
      org_id               = exampleHarnessPlatformOrganization.id
      project_id           = exampleHarnessPlatformProject.id
      repository           = "https://github.com/org/repo"
      repository_branch    = "main"
      repository_path      = "ansible/site.yml"
      repository_connector = "account.my_github_connector"
      ansible_galaxy       = true
      tags                 = ["env:prod"]
      vars {
        key        = "environment"
        value      = "production"
        value_type = "string"
      }
      env_vars {
        key        = "ANSIBLE_CONFIG"
        value      = "ansible.cfg"
        value_type = "string"
      }
    }
    

    Create IacmAnsiblePlaybook Resource

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

    Constructor syntax

    new IacmAnsiblePlaybook(name: string, args: IacmAnsiblePlaybookArgs, opts?: CustomResourceOptions);
    @overload
    def IacmAnsiblePlaybook(resource_name: str,
                            args: IacmAnsiblePlaybookArgs,
                            opts: Optional[ResourceOptions] = None)
    
    @overload
    def IacmAnsiblePlaybook(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            identifier: Optional[str] = None,
                            repository_path: Optional[str] = None,
                            project_id: Optional[str] = None,
                            org_id: Optional[str] = None,
                            env_vars: Optional[Sequence[IacmAnsiblePlaybookEnvVarArgs]] = None,
                            name: Optional[str] = None,
                            ansible_galaxy: Optional[bool] = None,
                            description: Optional[str] = None,
                            repository: Optional[str] = None,
                            repository_branch: Optional[str] = None,
                            repository_commit: Optional[str] = None,
                            repository_connector: Optional[str] = None,
                            ansible_galaxy_requirements_file: Optional[str] = None,
                            tags: Optional[Sequence[str]] = None,
                            vars: Optional[Sequence[IacmAnsiblePlaybookVarArgs]] = None)
    func NewIacmAnsiblePlaybook(ctx *Context, name string, args IacmAnsiblePlaybookArgs, opts ...ResourceOption) (*IacmAnsiblePlaybook, error)
    public IacmAnsiblePlaybook(string name, IacmAnsiblePlaybookArgs args, CustomResourceOptions? opts = null)
    public IacmAnsiblePlaybook(String name, IacmAnsiblePlaybookArgs args)
    public IacmAnsiblePlaybook(String name, IacmAnsiblePlaybookArgs args, CustomResourceOptions options)
    
    type: harness:platform:IacmAnsiblePlaybook
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "harness_platform_iacmansibleplaybook" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args IacmAnsiblePlaybookArgs
    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 IacmAnsiblePlaybookArgs
    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 IacmAnsiblePlaybookArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IacmAnsiblePlaybookArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IacmAnsiblePlaybookArgs
    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 iacmAnsiblePlaybookResource = new Harness.Platform.IacmAnsiblePlaybook("iacmAnsiblePlaybookResource", new()
    {
        Identifier = "string",
        RepositoryPath = "string",
        ProjectId = "string",
        OrgId = "string",
        EnvVars = new[]
        {
            new Harness.Platform.Inputs.IacmAnsiblePlaybookEnvVarArgs
            {
                Key = "string",
                Value = "string",
                ValueType = "string",
                FileName = "string",
            },
        },
        Name = "string",
        AnsibleGalaxy = false,
        Description = "string",
        Repository = "string",
        RepositoryBranch = "string",
        RepositoryCommit = "string",
        RepositoryConnector = "string",
        AnsibleGalaxyRequirementsFile = "string",
        Tags = new[]
        {
            "string",
        },
        Vars = new[]
        {
            new Harness.Platform.Inputs.IacmAnsiblePlaybookVarArgs
            {
                Key = "string",
                Value = "string",
                ValueType = "string",
                FileName = "string",
            },
        },
    });
    
    example, err := platform.NewIacmAnsiblePlaybook(ctx, "iacmAnsiblePlaybookResource", &platform.IacmAnsiblePlaybookArgs{
    	Identifier:     pulumi.String("string"),
    	RepositoryPath: pulumi.String("string"),
    	ProjectId:      pulumi.String("string"),
    	OrgId:          pulumi.String("string"),
    	EnvVars: platform.IacmAnsiblePlaybookEnvVarArray{
    		&platform.IacmAnsiblePlaybookEnvVarArgs{
    			Key:       pulumi.String("string"),
    			Value:     pulumi.String("string"),
    			ValueType: pulumi.String("string"),
    			FileName:  pulumi.String("string"),
    		},
    	},
    	Name:                          pulumi.String("string"),
    	AnsibleGalaxy:                 pulumi.Bool(false),
    	Description:                   pulumi.String("string"),
    	Repository:                    pulumi.String("string"),
    	RepositoryBranch:              pulumi.String("string"),
    	RepositoryCommit:              pulumi.String("string"),
    	RepositoryConnector:           pulumi.String("string"),
    	AnsibleGalaxyRequirementsFile: pulumi.String("string"),
    	Tags: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Vars: platform.IacmAnsiblePlaybookVarArray{
    		&platform.IacmAnsiblePlaybookVarArgs{
    			Key:       pulumi.String("string"),
    			Value:     pulumi.String("string"),
    			ValueType: pulumi.String("string"),
    			FileName:  pulumi.String("string"),
    		},
    	},
    })
    
    resource "harness_platform_iacmansibleplaybook" "iacmAnsiblePlaybookResource" {
      identifier      = "string"
      repository_path = "string"
      project_id      = "string"
      org_id          = "string"
      env_vars {
        key        = "string"
        value      = "string"
        value_type = "string"
        file_name  = "string"
      }
      name                             = "string"
      ansible_galaxy                   = false
      description                      = "string"
      repository                       = "string"
      repository_branch                = "string"
      repository_commit                = "string"
      repository_connector             = "string"
      ansible_galaxy_requirements_file = "string"
      tags                             = ["string"]
      vars {
        key        = "string"
        value      = "string"
        value_type = "string"
        file_name  = "string"
      }
    }
    
    var iacmAnsiblePlaybookResource = new IacmAnsiblePlaybook("iacmAnsiblePlaybookResource", IacmAnsiblePlaybookArgs.builder()
        .identifier("string")
        .repositoryPath("string")
        .projectId("string")
        .orgId("string")
        .envVars(IacmAnsiblePlaybookEnvVarArgs.builder()
            .key("string")
            .value("string")
            .valueType("string")
            .fileName("string")
            .build())
        .name("string")
        .ansibleGalaxy(false)
        .description("string")
        .repository("string")
        .repositoryBranch("string")
        .repositoryCommit("string")
        .repositoryConnector("string")
        .ansibleGalaxyRequirementsFile("string")
        .tags("string")
        .vars(IacmAnsiblePlaybookVarArgs.builder()
            .key("string")
            .value("string")
            .valueType("string")
            .fileName("string")
            .build())
        .build());
    
    iacm_ansible_playbook_resource = harness.platform.IacmAnsiblePlaybook("iacmAnsiblePlaybookResource",
        identifier="string",
        repository_path="string",
        project_id="string",
        org_id="string",
        env_vars=[{
            "key": "string",
            "value": "string",
            "value_type": "string",
            "file_name": "string",
        }],
        name="string",
        ansible_galaxy=False,
        description="string",
        repository="string",
        repository_branch="string",
        repository_commit="string",
        repository_connector="string",
        ansible_galaxy_requirements_file="string",
        tags=["string"],
        vars=[{
            "key": "string",
            "value": "string",
            "value_type": "string",
            "file_name": "string",
        }])
    
    const iacmAnsiblePlaybookResource = new harness.platform.IacmAnsiblePlaybook("iacmAnsiblePlaybookResource", {
        identifier: "string",
        repositoryPath: "string",
        projectId: "string",
        orgId: "string",
        envVars: [{
            key: "string",
            value: "string",
            valueType: "string",
            fileName: "string",
        }],
        name: "string",
        ansibleGalaxy: false,
        description: "string",
        repository: "string",
        repositoryBranch: "string",
        repositoryCommit: "string",
        repositoryConnector: "string",
        ansibleGalaxyRequirementsFile: "string",
        tags: ["string"],
        vars: [{
            key: "string",
            value: "string",
            valueType: "string",
            fileName: "string",
        }],
    });
    
    type: harness:platform:IacmAnsiblePlaybook
    properties:
        ansibleGalaxy: false
        ansibleGalaxyRequirementsFile: string
        description: string
        envVars:
            - fileName: string
              key: string
              value: string
              valueType: string
        identifier: string
        name: string
        orgId: string
        projectId: string
        repository: string
        repositoryBranch: string
        repositoryCommit: string
        repositoryConnector: string
        repositoryPath: string
        tags:
            - string
        vars:
            - fileName: string
              key: string
              value: string
              valueType: string
    

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

    Identifier string
    Unique identifier of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    RepositoryPath string
    Path within the repository where the playbook resides.
    AnsibleGalaxy bool
    Install Ansible Galaxy dependencies.
    AnsibleGalaxyRequirementsFile string
    Path to the Ansible Galaxy requirements file.
    Description string
    Description of the resource.
    EnvVars List<IacmAnsiblePlaybookEnvVar>
    Environment variables configured on the playbook.
    Name string
    Name of the resource.
    Repository string
    Repository name for the playbook.
    RepositoryBranch string
    Repository branch for the playbook.
    RepositoryCommit string
    Repository commit or tag for the playbook.
    RepositoryConnector string
    Repository connector reference for the playbook.
    Tags List<string>
    Tags to associate with the resource.
    Vars List<IacmAnsiblePlaybookVar>
    Variables configured on the playbook.
    Identifier string
    Unique identifier of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    RepositoryPath string
    Path within the repository where the playbook resides.
    AnsibleGalaxy bool
    Install Ansible Galaxy dependencies.
    AnsibleGalaxyRequirementsFile string
    Path to the Ansible Galaxy requirements file.
    Description string
    Description of the resource.
    EnvVars []IacmAnsiblePlaybookEnvVarArgs
    Environment variables configured on the playbook.
    Name string
    Name of the resource.
    Repository string
    Repository name for the playbook.
    RepositoryBranch string
    Repository branch for the playbook.
    RepositoryCommit string
    Repository commit or tag for the playbook.
    RepositoryConnector string
    Repository connector reference for the playbook.
    Tags []string
    Tags to associate with the resource.
    Vars []IacmAnsiblePlaybookVarArgs
    Variables configured on the playbook.
    identifier string
    Unique identifier of the resource.
    org_id string
    Unique identifier of the organization.
    project_id string
    Unique identifier of the project.
    repository_path string
    Path within the repository where the playbook resides.
    ansible_galaxy bool
    Install Ansible Galaxy dependencies.
    ansible_galaxy_requirements_file string
    Path to the Ansible Galaxy requirements file.
    description string
    Description of the resource.
    env_vars list(object)
    Environment variables configured on the playbook.
    name string
    Name of the resource.
    repository string
    Repository name for the playbook.
    repository_branch string
    Repository branch for the playbook.
    repository_commit string
    Repository commit or tag for the playbook.
    repository_connector string
    Repository connector reference for the playbook.
    tags list(string)
    Tags to associate with the resource.
    vars list(object)
    Variables configured on the playbook.
    identifier String
    Unique identifier of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    repositoryPath String
    Path within the repository where the playbook resides.
    ansibleGalaxy Boolean
    Install Ansible Galaxy dependencies.
    ansibleGalaxyRequirementsFile String
    Path to the Ansible Galaxy requirements file.
    description String
    Description of the resource.
    envVars List<IacmAnsiblePlaybookEnvVar>
    Environment variables configured on the playbook.
    name String
    Name of the resource.
    repository String
    Repository name for the playbook.
    repositoryBranch String
    Repository branch for the playbook.
    repositoryCommit String
    Repository commit or tag for the playbook.
    repositoryConnector String
    Repository connector reference for the playbook.
    tags List<String>
    Tags to associate with the resource.
    vars List<IacmAnsiblePlaybookVar>
    Variables configured on the playbook.
    identifier string
    Unique identifier of the resource.
    orgId string
    Unique identifier of the organization.
    projectId string
    Unique identifier of the project.
    repositoryPath string
    Path within the repository where the playbook resides.
    ansibleGalaxy boolean
    Install Ansible Galaxy dependencies.
    ansibleGalaxyRequirementsFile string
    Path to the Ansible Galaxy requirements file.
    description string
    Description of the resource.
    envVars IacmAnsiblePlaybookEnvVar[]
    Environment variables configured on the playbook.
    name string
    Name of the resource.
    repository string
    Repository name for the playbook.
    repositoryBranch string
    Repository branch for the playbook.
    repositoryCommit string
    Repository commit or tag for the playbook.
    repositoryConnector string
    Repository connector reference for the playbook.
    tags string[]
    Tags to associate with the resource.
    vars IacmAnsiblePlaybookVar[]
    Variables configured on the playbook.
    identifier str
    Unique identifier of the resource.
    org_id str
    Unique identifier of the organization.
    project_id str
    Unique identifier of the project.
    repository_path str
    Path within the repository where the playbook resides.
    ansible_galaxy bool
    Install Ansible Galaxy dependencies.
    ansible_galaxy_requirements_file str
    Path to the Ansible Galaxy requirements file.
    description str
    Description of the resource.
    env_vars Sequence[IacmAnsiblePlaybookEnvVarArgs]
    Environment variables configured on the playbook.
    name str
    Name of the resource.
    repository str
    Repository name for the playbook.
    repository_branch str
    Repository branch for the playbook.
    repository_commit str
    Repository commit or tag for the playbook.
    repository_connector str
    Repository connector reference for the playbook.
    tags Sequence[str]
    Tags to associate with the resource.
    vars Sequence[IacmAnsiblePlaybookVarArgs]
    Variables configured on the playbook.
    identifier String
    Unique identifier of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    repositoryPath String
    Path within the repository where the playbook resides.
    ansibleGalaxy Boolean
    Install Ansible Galaxy dependencies.
    ansibleGalaxyRequirementsFile String
    Path to the Ansible Galaxy requirements file.
    description String
    Description of the resource.
    envVars List<Property Map>
    Environment variables configured on the playbook.
    name String
    Name of the resource.
    repository String
    Repository name for the playbook.
    repositoryBranch String
    Repository branch for the playbook.
    repositoryCommit String
    Repository commit or tag for the playbook.
    repositoryConnector String
    Repository connector reference for the playbook.
    tags List<String>
    Tags to associate with the resource.
    vars List<Property Map>
    Variables configured on the playbook.

    Outputs

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

    Get an existing IacmAnsiblePlaybook 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?: IacmAnsiblePlaybookState, opts?: CustomResourceOptions): IacmAnsiblePlaybook
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            ansible_galaxy: Optional[bool] = None,
            ansible_galaxy_requirements_file: Optional[str] = None,
            description: Optional[str] = None,
            env_vars: Optional[Sequence[IacmAnsiblePlaybookEnvVarArgs]] = None,
            identifier: Optional[str] = None,
            name: Optional[str] = None,
            org_id: Optional[str] = None,
            project_id: Optional[str] = None,
            repository: Optional[str] = None,
            repository_branch: Optional[str] = None,
            repository_commit: Optional[str] = None,
            repository_connector: Optional[str] = None,
            repository_path: Optional[str] = None,
            tags: Optional[Sequence[str]] = None,
            vars: Optional[Sequence[IacmAnsiblePlaybookVarArgs]] = None) -> IacmAnsiblePlaybook
    func GetIacmAnsiblePlaybook(ctx *Context, name string, id IDInput, state *IacmAnsiblePlaybookState, opts ...ResourceOption) (*IacmAnsiblePlaybook, error)
    public static IacmAnsiblePlaybook Get(string name, Input<string> id, IacmAnsiblePlaybookState? state, CustomResourceOptions? opts = null)
    public static IacmAnsiblePlaybook get(String name, Output<String> id, IacmAnsiblePlaybookState state, CustomResourceOptions options)
    resources:  _:    type: harness:platform:IacmAnsiblePlaybook    get:      id: ${id}
    import {
      to = harness_platform_iacmansibleplaybook.example
      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:
    AnsibleGalaxy bool
    Install Ansible Galaxy dependencies.
    AnsibleGalaxyRequirementsFile string
    Path to the Ansible Galaxy requirements file.
    Description string
    Description of the resource.
    EnvVars List<IacmAnsiblePlaybookEnvVar>
    Environment variables configured on the playbook.
    Identifier string
    Unique identifier of the resource.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Repository string
    Repository name for the playbook.
    RepositoryBranch string
    Repository branch for the playbook.
    RepositoryCommit string
    Repository commit or tag for the playbook.
    RepositoryConnector string
    Repository connector reference for the playbook.
    RepositoryPath string
    Path within the repository where the playbook resides.
    Tags List<string>
    Tags to associate with the resource.
    Vars List<IacmAnsiblePlaybookVar>
    Variables configured on the playbook.
    AnsibleGalaxy bool
    Install Ansible Galaxy dependencies.
    AnsibleGalaxyRequirementsFile string
    Path to the Ansible Galaxy requirements file.
    Description string
    Description of the resource.
    EnvVars []IacmAnsiblePlaybookEnvVarArgs
    Environment variables configured on the playbook.
    Identifier string
    Unique identifier of the resource.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Repository string
    Repository name for the playbook.
    RepositoryBranch string
    Repository branch for the playbook.
    RepositoryCommit string
    Repository commit or tag for the playbook.
    RepositoryConnector string
    Repository connector reference for the playbook.
    RepositoryPath string
    Path within the repository where the playbook resides.
    Tags []string
    Tags to associate with the resource.
    Vars []IacmAnsiblePlaybookVarArgs
    Variables configured on the playbook.
    ansible_galaxy bool
    Install Ansible Galaxy dependencies.
    ansible_galaxy_requirements_file string
    Path to the Ansible Galaxy requirements file.
    description string
    Description of the resource.
    env_vars list(object)
    Environment variables configured on the playbook.
    identifier string
    Unique identifier of the resource.
    name string
    Name of the resource.
    org_id string
    Unique identifier of the organization.
    project_id string
    Unique identifier of the project.
    repository string
    Repository name for the playbook.
    repository_branch string
    Repository branch for the playbook.
    repository_commit string
    Repository commit or tag for the playbook.
    repository_connector string
    Repository connector reference for the playbook.
    repository_path string
    Path within the repository where the playbook resides.
    tags list(string)
    Tags to associate with the resource.
    vars list(object)
    Variables configured on the playbook.
    ansibleGalaxy Boolean
    Install Ansible Galaxy dependencies.
    ansibleGalaxyRequirementsFile String
    Path to the Ansible Galaxy requirements file.
    description String
    Description of the resource.
    envVars List<IacmAnsiblePlaybookEnvVar>
    Environment variables configured on the playbook.
    identifier String
    Unique identifier of the resource.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    repository String
    Repository name for the playbook.
    repositoryBranch String
    Repository branch for the playbook.
    repositoryCommit String
    Repository commit or tag for the playbook.
    repositoryConnector String
    Repository connector reference for the playbook.
    repositoryPath String
    Path within the repository where the playbook resides.
    tags List<String>
    Tags to associate with the resource.
    vars List<IacmAnsiblePlaybookVar>
    Variables configured on the playbook.
    ansibleGalaxy boolean
    Install Ansible Galaxy dependencies.
    ansibleGalaxyRequirementsFile string
    Path to the Ansible Galaxy requirements file.
    description string
    Description of the resource.
    envVars IacmAnsiblePlaybookEnvVar[]
    Environment variables configured on the playbook.
    identifier string
    Unique identifier of the resource.
    name string
    Name of the resource.
    orgId string
    Unique identifier of the organization.
    projectId string
    Unique identifier of the project.
    repository string
    Repository name for the playbook.
    repositoryBranch string
    Repository branch for the playbook.
    repositoryCommit string
    Repository commit or tag for the playbook.
    repositoryConnector string
    Repository connector reference for the playbook.
    repositoryPath string
    Path within the repository where the playbook resides.
    tags string[]
    Tags to associate with the resource.
    vars IacmAnsiblePlaybookVar[]
    Variables configured on the playbook.
    ansible_galaxy bool
    Install Ansible Galaxy dependencies.
    ansible_galaxy_requirements_file str
    Path to the Ansible Galaxy requirements file.
    description str
    Description of the resource.
    env_vars Sequence[IacmAnsiblePlaybookEnvVarArgs]
    Environment variables configured on the playbook.
    identifier str
    Unique identifier of the resource.
    name str
    Name of the resource.
    org_id str
    Unique identifier of the organization.
    project_id str
    Unique identifier of the project.
    repository str
    Repository name for the playbook.
    repository_branch str
    Repository branch for the playbook.
    repository_commit str
    Repository commit or tag for the playbook.
    repository_connector str
    Repository connector reference for the playbook.
    repository_path str
    Path within the repository where the playbook resides.
    tags Sequence[str]
    Tags to associate with the resource.
    vars Sequence[IacmAnsiblePlaybookVarArgs]
    Variables configured on the playbook.
    ansibleGalaxy Boolean
    Install Ansible Galaxy dependencies.
    ansibleGalaxyRequirementsFile String
    Path to the Ansible Galaxy requirements file.
    description String
    Description of the resource.
    envVars List<Property Map>
    Environment variables configured on the playbook.
    identifier String
    Unique identifier of the resource.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    repository String
    Repository name for the playbook.
    repositoryBranch String
    Repository branch for the playbook.
    repositoryCommit String
    Repository commit or tag for the playbook.
    repositoryConnector String
    Repository connector reference for the playbook.
    repositoryPath String
    Path within the repository where the playbook resides.
    tags List<String>
    Tags to associate with the resource.
    vars List<Property Map>
    Variables configured on the playbook.

    Supporting Types

    IacmAnsiblePlaybookEnvVar, IacmAnsiblePlaybookEnvVarArgs

    Key string
    Key is the identifier for the variable.
    Value string
    Value of the variable. For secret value types this must be a Harness secret reference.
    ValueType string
    Value type. One of: string, secret.
    FileName string
    Filename to store the value in (used for file-backed variables).
    Key string
    Key is the identifier for the variable.
    Value string
    Value of the variable. For secret value types this must be a Harness secret reference.
    ValueType string
    Value type. One of: string, secret.
    FileName string
    Filename to store the value in (used for file-backed variables).
    key string
    Key is the identifier for the variable.
    value string
    Value of the variable. For secret value types this must be a Harness secret reference.
    value_type string
    Value type. One of: string, secret.
    file_name string
    Filename to store the value in (used for file-backed variables).
    key String
    Key is the identifier for the variable.
    value String
    Value of the variable. For secret value types this must be a Harness secret reference.
    valueType String
    Value type. One of: string, secret.
    fileName String
    Filename to store the value in (used for file-backed variables).
    key string
    Key is the identifier for the variable.
    value string
    Value of the variable. For secret value types this must be a Harness secret reference.
    valueType string
    Value type. One of: string, secret.
    fileName string
    Filename to store the value in (used for file-backed variables).
    key str
    Key is the identifier for the variable.
    value str
    Value of the variable. For secret value types this must be a Harness secret reference.
    value_type str
    Value type. One of: string, secret.
    file_name str
    Filename to store the value in (used for file-backed variables).
    key String
    Key is the identifier for the variable.
    value String
    Value of the variable. For secret value types this must be a Harness secret reference.
    valueType String
    Value type. One of: string, secret.
    fileName String
    Filename to store the value in (used for file-backed variables).

    IacmAnsiblePlaybookVar, IacmAnsiblePlaybookVarArgs

    Key string
    Key is the identifier for the variable.
    Value string
    Value of the variable. For secret value types this must be a Harness secret reference.
    ValueType string
    Value type. One of: string, secret.
    FileName string
    Filename to store the value in (used for file-backed variables).
    Key string
    Key is the identifier for the variable.
    Value string
    Value of the variable. For secret value types this must be a Harness secret reference.
    ValueType string
    Value type. One of: string, secret.
    FileName string
    Filename to store the value in (used for file-backed variables).
    key string
    Key is the identifier for the variable.
    value string
    Value of the variable. For secret value types this must be a Harness secret reference.
    value_type string
    Value type. One of: string, secret.
    file_name string
    Filename to store the value in (used for file-backed variables).
    key String
    Key is the identifier for the variable.
    value String
    Value of the variable. For secret value types this must be a Harness secret reference.
    valueType String
    Value type. One of: string, secret.
    fileName String
    Filename to store the value in (used for file-backed variables).
    key string
    Key is the identifier for the variable.
    value string
    Value of the variable. For secret value types this must be a Harness secret reference.
    valueType string
    Value type. One of: string, secret.
    fileName string
    Filename to store the value in (used for file-backed variables).
    key str
    Key is the identifier for the variable.
    value str
    Value of the variable. For secret value types this must be a Harness secret reference.
    value_type str
    Value type. One of: string, secret.
    file_name str
    Filename to store the value in (used for file-backed variables).
    key String
    Key is the identifier for the variable.
    value String
    Value of the variable. For secret value types this must be a Harness secret reference.
    valueType String
    Value type. One of: string, secret.
    fileName String
    Filename to store the value in (used for file-backed variables).

    Package Details

    Repository
    harness pulumi/pulumi-harness
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the harness Terraform Provider.
    harness logo
    Viewing docs for Harness v0.13.1
    published on Thursday, May 28, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial