1. Packages
  2. Awx Provider
  3. API Docs
  4. WorkflowJobTemplate
awx 0.29.1 published on Monday, Apr 14, 2025 by denouche

awx.WorkflowJobTemplate

Explore with Pulumi AI

awx logo
awx 0.29.1 published on Monday, Apr 14, 2025 by denouche

    TBD

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as awx from "@pulumi/awx";
    
    const _default = new awx.WorkflowJobTemplate("default", {
        organizationId: _var.organization_id,
        inventoryId: awx_inventory["default"].id,
    });
    
    import pulumi
    import pulumi_awx as awx
    
    default = awx.WorkflowJobTemplate("default",
        organization_id=var["organization_id"],
        inventory_id=awx_inventory["default"]["id"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/awx/awx"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := awx.NewWorkflowJobTemplate(ctx, "default", &awx.WorkflowJobTemplateArgs{
    			OrganizationId: pulumi.Any(_var.Organization_id),
    			InventoryId:    pulumi.Any(awx_inventory.Default.Id),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Awx = Pulumi.Awx;
    
    return await Deployment.RunAsync(() => 
    {
        var @default = new Awx.WorkflowJobTemplate("default", new()
        {
            OrganizationId = @var.Organization_id,
            InventoryId = awx_inventory.Default.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.awx.WorkflowJobTemplate;
    import com.pulumi.awx.WorkflowJobTemplateArgs;
    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 default_ = new WorkflowJobTemplate("default", WorkflowJobTemplateArgs.builder()
                .organizationId(var_.organization_id())
                .inventoryId(awx_inventory.default().id())
                .build());
    
        }
    }
    
    resources:
      default:
        type: awx:WorkflowJobTemplate
        properties:
          organizationId: ${var.organization_id}
          inventoryId: ${awx_inventory.default.id}
    

    Create WorkflowJobTemplate Resource

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

    Constructor syntax

    new WorkflowJobTemplate(name: string, args?: WorkflowJobTemplateArgs, opts?: CustomResourceOptions);
    @overload
    def WorkflowJobTemplate(resource_name: str,
                            args: Optional[WorkflowJobTemplateArgs] = None,
                            opts: Optional[ResourceOptions] = None)
    
    @overload
    def WorkflowJobTemplate(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            allow_simultaneous: Optional[bool] = None,
                            ask_inventory_on_launch: Optional[bool] = None,
                            ask_limit_on_launch: Optional[bool] = None,
                            ask_scm_branch_on_launch: Optional[bool] = None,
                            ask_variables_on_launch: Optional[bool] = None,
                            description: Optional[str] = None,
                            inventory_id: Optional[str] = None,
                            limit: Optional[str] = None,
                            name: Optional[str] = None,
                            organization_id: Optional[float] = None,
                            scm_branch: Optional[str] = None,
                            survey_enabled: Optional[bool] = None,
                            variables: Optional[str] = None,
                            webhook_credential: Optional[str] = None,
                            webhook_service: Optional[str] = None,
                            workflow_job_template_id: Optional[str] = None)
    func NewWorkflowJobTemplate(ctx *Context, name string, args *WorkflowJobTemplateArgs, opts ...ResourceOption) (*WorkflowJobTemplate, error)
    public WorkflowJobTemplate(string name, WorkflowJobTemplateArgs? args = null, CustomResourceOptions? opts = null)
    public WorkflowJobTemplate(String name, WorkflowJobTemplateArgs args)
    public WorkflowJobTemplate(String name, WorkflowJobTemplateArgs args, CustomResourceOptions options)
    
    type: awx:WorkflowJobTemplate
    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 WorkflowJobTemplateArgs
    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 WorkflowJobTemplateArgs
    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 WorkflowJobTemplateArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkflowJobTemplateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkflowJobTemplateArgs
    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 workflowJobTemplateResource = new Awx.WorkflowJobTemplate("workflowJobTemplateResource", new()
    {
        AllowSimultaneous = false,
        AskInventoryOnLaunch = false,
        AskLimitOnLaunch = false,
        AskScmBranchOnLaunch = false,
        AskVariablesOnLaunch = false,
        Description = "string",
        InventoryId = "string",
        Limit = "string",
        Name = "string",
        OrganizationId = 0,
        ScmBranch = "string",
        SurveyEnabled = false,
        Variables = "string",
        WebhookCredential = "string",
        WebhookService = "string",
        WorkflowJobTemplateId = "string",
    });
    
    example, err := awx.NewWorkflowJobTemplate(ctx, "workflowJobTemplateResource", &awx.WorkflowJobTemplateArgs{
    	AllowSimultaneous:     pulumi.Bool(false),
    	AskInventoryOnLaunch:  pulumi.Bool(false),
    	AskLimitOnLaunch:      pulumi.Bool(false),
    	AskScmBranchOnLaunch:  pulumi.Bool(false),
    	AskVariablesOnLaunch:  pulumi.Bool(false),
    	Description:           pulumi.String("string"),
    	InventoryId:           pulumi.String("string"),
    	Limit:                 pulumi.String("string"),
    	Name:                  pulumi.String("string"),
    	OrganizationId:        pulumi.Float64(0),
    	ScmBranch:             pulumi.String("string"),
    	SurveyEnabled:         pulumi.Bool(false),
    	Variables:             pulumi.String("string"),
    	WebhookCredential:     pulumi.String("string"),
    	WebhookService:        pulumi.String("string"),
    	WorkflowJobTemplateId: pulumi.String("string"),
    })
    
    var workflowJobTemplateResource = new WorkflowJobTemplate("workflowJobTemplateResource", WorkflowJobTemplateArgs.builder()
        .allowSimultaneous(false)
        .askInventoryOnLaunch(false)
        .askLimitOnLaunch(false)
        .askScmBranchOnLaunch(false)
        .askVariablesOnLaunch(false)
        .description("string")
        .inventoryId("string")
        .limit("string")
        .name("string")
        .organizationId(0)
        .scmBranch("string")
        .surveyEnabled(false)
        .variables("string")
        .webhookCredential("string")
        .webhookService("string")
        .workflowJobTemplateId("string")
        .build());
    
    workflow_job_template_resource = awx.WorkflowJobTemplate("workflowJobTemplateResource",
        allow_simultaneous=False,
        ask_inventory_on_launch=False,
        ask_limit_on_launch=False,
        ask_scm_branch_on_launch=False,
        ask_variables_on_launch=False,
        description="string",
        inventory_id="string",
        limit="string",
        name="string",
        organization_id=0,
        scm_branch="string",
        survey_enabled=False,
        variables="string",
        webhook_credential="string",
        webhook_service="string",
        workflow_job_template_id="string")
    
    const workflowJobTemplateResource = new awx.WorkflowJobTemplate("workflowJobTemplateResource", {
        allowSimultaneous: false,
        askInventoryOnLaunch: false,
        askLimitOnLaunch: false,
        askScmBranchOnLaunch: false,
        askVariablesOnLaunch: false,
        description: "string",
        inventoryId: "string",
        limit: "string",
        name: "string",
        organizationId: 0,
        scmBranch: "string",
        surveyEnabled: false,
        variables: "string",
        webhookCredential: "string",
        webhookService: "string",
        workflowJobTemplateId: "string",
    });
    
    type: awx:WorkflowJobTemplate
    properties:
        allowSimultaneous: false
        askInventoryOnLaunch: false
        askLimitOnLaunch: false
        askScmBranchOnLaunch: false
        askVariablesOnLaunch: false
        description: string
        inventoryId: string
        limit: string
        name: string
        organizationId: 0
        scmBranch: string
        surveyEnabled: false
        variables: string
        webhookCredential: string
        webhookService: string
        workflowJobTemplateId: string
    

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

    AllowSimultaneous bool
    AskInventoryOnLaunch bool
    AskLimitOnLaunch bool
    AskScmBranchOnLaunch bool
    AskVariablesOnLaunch bool
    Description string
    Optional description of this workflow job template.
    InventoryId string
    Inventory applied as a prompt, assuming job template prompts for inventory.
    Limit string
    Name string
    Name of this workflow job template. (string, required)
    OrganizationId double
    The organization used to determine access to this template. (id, default=``)
    ScmBranch string
    SurveyEnabled bool
    Variables string
    WebhookCredential string
    WebhookService string
    WorkflowJobTemplateId string
    AllowSimultaneous bool
    AskInventoryOnLaunch bool
    AskLimitOnLaunch bool
    AskScmBranchOnLaunch bool
    AskVariablesOnLaunch bool
    Description string
    Optional description of this workflow job template.
    InventoryId string
    Inventory applied as a prompt, assuming job template prompts for inventory.
    Limit string
    Name string
    Name of this workflow job template. (string, required)
    OrganizationId float64
    The organization used to determine access to this template. (id, default=``)
    ScmBranch string
    SurveyEnabled bool
    Variables string
    WebhookCredential string
    WebhookService string
    WorkflowJobTemplateId string
    allowSimultaneous Boolean
    askInventoryOnLaunch Boolean
    askLimitOnLaunch Boolean
    askScmBranchOnLaunch Boolean
    askVariablesOnLaunch Boolean
    description String
    Optional description of this workflow job template.
    inventoryId String
    Inventory applied as a prompt, assuming job template prompts for inventory.
    limit String
    name String
    Name of this workflow job template. (string, required)
    organizationId Double
    The organization used to determine access to this template. (id, default=``)
    scmBranch String
    surveyEnabled Boolean
    variables String
    webhookCredential String
    webhookService String
    workflowJobTemplateId String
    allowSimultaneous boolean
    askInventoryOnLaunch boolean
    askLimitOnLaunch boolean
    askScmBranchOnLaunch boolean
    askVariablesOnLaunch boolean
    description string
    Optional description of this workflow job template.
    inventoryId string
    Inventory applied as a prompt, assuming job template prompts for inventory.
    limit string
    name string
    Name of this workflow job template. (string, required)
    organizationId number
    The organization used to determine access to this template. (id, default=``)
    scmBranch string
    surveyEnabled boolean
    variables string
    webhookCredential string
    webhookService string
    workflowJobTemplateId string
    allow_simultaneous bool
    ask_inventory_on_launch bool
    ask_limit_on_launch bool
    ask_scm_branch_on_launch bool
    ask_variables_on_launch bool
    description str
    Optional description of this workflow job template.
    inventory_id str
    Inventory applied as a prompt, assuming job template prompts for inventory.
    limit str
    name str
    Name of this workflow job template. (string, required)
    organization_id float
    The organization used to determine access to this template. (id, default=``)
    scm_branch str
    survey_enabled bool
    variables str
    webhook_credential str
    webhook_service str
    workflow_job_template_id str
    allowSimultaneous Boolean
    askInventoryOnLaunch Boolean
    askLimitOnLaunch Boolean
    askScmBranchOnLaunch Boolean
    askVariablesOnLaunch Boolean
    description String
    Optional description of this workflow job template.
    inventoryId String
    Inventory applied as a prompt, assuming job template prompts for inventory.
    limit String
    name String
    Name of this workflow job template. (string, required)
    organizationId Number
    The organization used to determine access to this template. (id, default=``)
    scmBranch String
    surveyEnabled Boolean
    variables String
    webhookCredential String
    webhookService String
    workflowJobTemplateId String

    Outputs

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

    Get an existing WorkflowJobTemplate 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?: WorkflowJobTemplateState, opts?: CustomResourceOptions): WorkflowJobTemplate
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            allow_simultaneous: Optional[bool] = None,
            ask_inventory_on_launch: Optional[bool] = None,
            ask_limit_on_launch: Optional[bool] = None,
            ask_scm_branch_on_launch: Optional[bool] = None,
            ask_variables_on_launch: Optional[bool] = None,
            description: Optional[str] = None,
            inventory_id: Optional[str] = None,
            limit: Optional[str] = None,
            name: Optional[str] = None,
            organization_id: Optional[float] = None,
            scm_branch: Optional[str] = None,
            survey_enabled: Optional[bool] = None,
            variables: Optional[str] = None,
            webhook_credential: Optional[str] = None,
            webhook_service: Optional[str] = None,
            workflow_job_template_id: Optional[str] = None) -> WorkflowJobTemplate
    func GetWorkflowJobTemplate(ctx *Context, name string, id IDInput, state *WorkflowJobTemplateState, opts ...ResourceOption) (*WorkflowJobTemplate, error)
    public static WorkflowJobTemplate Get(string name, Input<string> id, WorkflowJobTemplateState? state, CustomResourceOptions? opts = null)
    public static WorkflowJobTemplate get(String name, Output<String> id, WorkflowJobTemplateState state, CustomResourceOptions options)
    resources:  _:    type: awx:WorkflowJobTemplate    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:
    AllowSimultaneous bool
    AskInventoryOnLaunch bool
    AskLimitOnLaunch bool
    AskScmBranchOnLaunch bool
    AskVariablesOnLaunch bool
    Description string
    Optional description of this workflow job template.
    InventoryId string
    Inventory applied as a prompt, assuming job template prompts for inventory.
    Limit string
    Name string
    Name of this workflow job template. (string, required)
    OrganizationId double
    The organization used to determine access to this template. (id, default=``)
    ScmBranch string
    SurveyEnabled bool
    Variables string
    WebhookCredential string
    WebhookService string
    WorkflowJobTemplateId string
    AllowSimultaneous bool
    AskInventoryOnLaunch bool
    AskLimitOnLaunch bool
    AskScmBranchOnLaunch bool
    AskVariablesOnLaunch bool
    Description string
    Optional description of this workflow job template.
    InventoryId string
    Inventory applied as a prompt, assuming job template prompts for inventory.
    Limit string
    Name string
    Name of this workflow job template. (string, required)
    OrganizationId float64
    The organization used to determine access to this template. (id, default=``)
    ScmBranch string
    SurveyEnabled bool
    Variables string
    WebhookCredential string
    WebhookService string
    WorkflowJobTemplateId string
    allowSimultaneous Boolean
    askInventoryOnLaunch Boolean
    askLimitOnLaunch Boolean
    askScmBranchOnLaunch Boolean
    askVariablesOnLaunch Boolean
    description String
    Optional description of this workflow job template.
    inventoryId String
    Inventory applied as a prompt, assuming job template prompts for inventory.
    limit String
    name String
    Name of this workflow job template. (string, required)
    organizationId Double
    The organization used to determine access to this template. (id, default=``)
    scmBranch String
    surveyEnabled Boolean
    variables String
    webhookCredential String
    webhookService String
    workflowJobTemplateId String
    allowSimultaneous boolean
    askInventoryOnLaunch boolean
    askLimitOnLaunch boolean
    askScmBranchOnLaunch boolean
    askVariablesOnLaunch boolean
    description string
    Optional description of this workflow job template.
    inventoryId string
    Inventory applied as a prompt, assuming job template prompts for inventory.
    limit string
    name string
    Name of this workflow job template. (string, required)
    organizationId number
    The organization used to determine access to this template. (id, default=``)
    scmBranch string
    surveyEnabled boolean
    variables string
    webhookCredential string
    webhookService string
    workflowJobTemplateId string
    allow_simultaneous bool
    ask_inventory_on_launch bool
    ask_limit_on_launch bool
    ask_scm_branch_on_launch bool
    ask_variables_on_launch bool
    description str
    Optional description of this workflow job template.
    inventory_id str
    Inventory applied as a prompt, assuming job template prompts for inventory.
    limit str
    name str
    Name of this workflow job template. (string, required)
    organization_id float
    The organization used to determine access to this template. (id, default=``)
    scm_branch str
    survey_enabled bool
    variables str
    webhook_credential str
    webhook_service str
    workflow_job_template_id str
    allowSimultaneous Boolean
    askInventoryOnLaunch Boolean
    askLimitOnLaunch Boolean
    askScmBranchOnLaunch Boolean
    askVariablesOnLaunch Boolean
    description String
    Optional description of this workflow job template.
    inventoryId String
    Inventory applied as a prompt, assuming job template prompts for inventory.
    limit String
    name String
    Name of this workflow job template. (string, required)
    organizationId Number
    The organization used to determine access to this template. (id, default=``)
    scmBranch String
    surveyEnabled Boolean
    variables String
    webhookCredential String
    webhookService String
    workflowJobTemplateId String

    Package Details

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