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

awx.JobTemplateLaunch

Explore with Pulumi AI

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

    Create JobTemplateLaunch Resource

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

    Constructor syntax

    new JobTemplateLaunch(name: string, args: JobTemplateLaunchArgs, opts?: CustomResourceOptions);
    @overload
    def JobTemplateLaunch(resource_name: str,
                          args: JobTemplateLaunchArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def JobTemplateLaunch(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          job_template_id: Optional[float] = None,
                          extra_vars: Optional[str] = None,
                          inventory_id: Optional[float] = None,
                          job_template_launch_id: Optional[str] = None,
                          limit: Optional[str] = None,
                          timeouts: Optional[JobTemplateLaunchTimeoutsArgs] = None,
                          wait_for_completion: Optional[bool] = None)
    func NewJobTemplateLaunch(ctx *Context, name string, args JobTemplateLaunchArgs, opts ...ResourceOption) (*JobTemplateLaunch, error)
    public JobTemplateLaunch(string name, JobTemplateLaunchArgs args, CustomResourceOptions? opts = null)
    public JobTemplateLaunch(String name, JobTemplateLaunchArgs args)
    public JobTemplateLaunch(String name, JobTemplateLaunchArgs args, CustomResourceOptions options)
    
    type: awx:JobTemplateLaunch
    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 JobTemplateLaunchArgs
    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 JobTemplateLaunchArgs
    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 JobTemplateLaunchArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args JobTemplateLaunchArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args JobTemplateLaunchArgs
    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 jobTemplateLaunchResource = new Awx.JobTemplateLaunch("jobTemplateLaunchResource", new()
    {
        JobTemplateId = 0,
        ExtraVars = "string",
        InventoryId = 0,
        JobTemplateLaunchId = "string",
        Limit = "string",
        Timeouts = new Awx.Inputs.JobTemplateLaunchTimeoutsArgs
        {
            Create = "string",
        },
        WaitForCompletion = false,
    });
    
    example, err := awx.NewJobTemplateLaunch(ctx, "jobTemplateLaunchResource", &awx.JobTemplateLaunchArgs{
    	JobTemplateId:       pulumi.Float64(0),
    	ExtraVars:           pulumi.String("string"),
    	InventoryId:         pulumi.Float64(0),
    	JobTemplateLaunchId: pulumi.String("string"),
    	Limit:               pulumi.String("string"),
    	Timeouts: &awx.JobTemplateLaunchTimeoutsArgs{
    		Create: pulumi.String("string"),
    	},
    	WaitForCompletion: pulumi.Bool(false),
    })
    
    var jobTemplateLaunchResource = new JobTemplateLaunch("jobTemplateLaunchResource", JobTemplateLaunchArgs.builder()
        .jobTemplateId(0)
        .extraVars("string")
        .inventoryId(0)
        .jobTemplateLaunchId("string")
        .limit("string")
        .timeouts(JobTemplateLaunchTimeoutsArgs.builder()
            .create("string")
            .build())
        .waitForCompletion(false)
        .build());
    
    job_template_launch_resource = awx.JobTemplateLaunch("jobTemplateLaunchResource",
        job_template_id=0,
        extra_vars="string",
        inventory_id=0,
        job_template_launch_id="string",
        limit="string",
        timeouts={
            "create": "string",
        },
        wait_for_completion=False)
    
    const jobTemplateLaunchResource = new awx.JobTemplateLaunch("jobTemplateLaunchResource", {
        jobTemplateId: 0,
        extraVars: "string",
        inventoryId: 0,
        jobTemplateLaunchId: "string",
        limit: "string",
        timeouts: {
            create: "string",
        },
        waitForCompletion: false,
    });
    
    type: awx:JobTemplateLaunch
    properties:
        extraVars: string
        inventoryId: 0
        jobTemplateId: 0
        jobTemplateLaunchId: string
        limit: string
        timeouts:
            create: string
        waitForCompletion: false
    

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

    JobTemplateId double
    Job template ID
    ExtraVars string
    Override job template variables. YAML or JSON values are supported.
    InventoryId double
    Override Inventory ID. Required ask_inventory_on_launch set on job_template.
    JobTemplateLaunchId string
    Limit string
    List of comma delimited hosts to limit job execution. Required ask_limit_on_launch set on job_template.
    Timeouts JobTemplateLaunchTimeouts
    WaitForCompletion bool
    Resource creation will wait for job completion.
    JobTemplateId float64
    Job template ID
    ExtraVars string
    Override job template variables. YAML or JSON values are supported.
    InventoryId float64
    Override Inventory ID. Required ask_inventory_on_launch set on job_template.
    JobTemplateLaunchId string
    Limit string
    List of comma delimited hosts to limit job execution. Required ask_limit_on_launch set on job_template.
    Timeouts JobTemplateLaunchTimeoutsArgs
    WaitForCompletion bool
    Resource creation will wait for job completion.
    jobTemplateId Double
    Job template ID
    extraVars String
    Override job template variables. YAML or JSON values are supported.
    inventoryId Double
    Override Inventory ID. Required ask_inventory_on_launch set on job_template.
    jobTemplateLaunchId String
    limit String
    List of comma delimited hosts to limit job execution. Required ask_limit_on_launch set on job_template.
    timeouts JobTemplateLaunchTimeouts
    waitForCompletion Boolean
    Resource creation will wait for job completion.
    jobTemplateId number
    Job template ID
    extraVars string
    Override job template variables. YAML or JSON values are supported.
    inventoryId number
    Override Inventory ID. Required ask_inventory_on_launch set on job_template.
    jobTemplateLaunchId string
    limit string
    List of comma delimited hosts to limit job execution. Required ask_limit_on_launch set on job_template.
    timeouts JobTemplateLaunchTimeouts
    waitForCompletion boolean
    Resource creation will wait for job completion.
    job_template_id float
    Job template ID
    extra_vars str
    Override job template variables. YAML or JSON values are supported.
    inventory_id float
    Override Inventory ID. Required ask_inventory_on_launch set on job_template.
    job_template_launch_id str
    limit str
    List of comma delimited hosts to limit job execution. Required ask_limit_on_launch set on job_template.
    timeouts JobTemplateLaunchTimeoutsArgs
    wait_for_completion bool
    Resource creation will wait for job completion.
    jobTemplateId Number
    Job template ID
    extraVars String
    Override job template variables. YAML or JSON values are supported.
    inventoryId Number
    Override Inventory ID. Required ask_inventory_on_launch set on job_template.
    jobTemplateLaunchId String
    limit String
    List of comma delimited hosts to limit job execution. Required ask_limit_on_launch set on job_template.
    timeouts Property Map
    waitForCompletion Boolean
    Resource creation will wait for job completion.

    Outputs

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

    Get an existing JobTemplateLaunch 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?: JobTemplateLaunchState, opts?: CustomResourceOptions): JobTemplateLaunch
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            extra_vars: Optional[str] = None,
            inventory_id: Optional[float] = None,
            job_template_id: Optional[float] = None,
            job_template_launch_id: Optional[str] = None,
            limit: Optional[str] = None,
            timeouts: Optional[JobTemplateLaunchTimeoutsArgs] = None,
            wait_for_completion: Optional[bool] = None) -> JobTemplateLaunch
    func GetJobTemplateLaunch(ctx *Context, name string, id IDInput, state *JobTemplateLaunchState, opts ...ResourceOption) (*JobTemplateLaunch, error)
    public static JobTemplateLaunch Get(string name, Input<string> id, JobTemplateLaunchState? state, CustomResourceOptions? opts = null)
    public static JobTemplateLaunch get(String name, Output<String> id, JobTemplateLaunchState state, CustomResourceOptions options)
    resources:  _:    type: awx:JobTemplateLaunch    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:
    ExtraVars string
    Override job template variables. YAML or JSON values are supported.
    InventoryId double
    Override Inventory ID. Required ask_inventory_on_launch set on job_template.
    JobTemplateId double
    Job template ID
    JobTemplateLaunchId string
    Limit string
    List of comma delimited hosts to limit job execution. Required ask_limit_on_launch set on job_template.
    Timeouts JobTemplateLaunchTimeouts
    WaitForCompletion bool
    Resource creation will wait for job completion.
    ExtraVars string
    Override job template variables. YAML or JSON values are supported.
    InventoryId float64
    Override Inventory ID. Required ask_inventory_on_launch set on job_template.
    JobTemplateId float64
    Job template ID
    JobTemplateLaunchId string
    Limit string
    List of comma delimited hosts to limit job execution. Required ask_limit_on_launch set on job_template.
    Timeouts JobTemplateLaunchTimeoutsArgs
    WaitForCompletion bool
    Resource creation will wait for job completion.
    extraVars String
    Override job template variables. YAML or JSON values are supported.
    inventoryId Double
    Override Inventory ID. Required ask_inventory_on_launch set on job_template.
    jobTemplateId Double
    Job template ID
    jobTemplateLaunchId String
    limit String
    List of comma delimited hosts to limit job execution. Required ask_limit_on_launch set on job_template.
    timeouts JobTemplateLaunchTimeouts
    waitForCompletion Boolean
    Resource creation will wait for job completion.
    extraVars string
    Override job template variables. YAML or JSON values are supported.
    inventoryId number
    Override Inventory ID. Required ask_inventory_on_launch set on job_template.
    jobTemplateId number
    Job template ID
    jobTemplateLaunchId string
    limit string
    List of comma delimited hosts to limit job execution. Required ask_limit_on_launch set on job_template.
    timeouts JobTemplateLaunchTimeouts
    waitForCompletion boolean
    Resource creation will wait for job completion.
    extra_vars str
    Override job template variables. YAML or JSON values are supported.
    inventory_id float
    Override Inventory ID. Required ask_inventory_on_launch set on job_template.
    job_template_id float
    Job template ID
    job_template_launch_id str
    limit str
    List of comma delimited hosts to limit job execution. Required ask_limit_on_launch set on job_template.
    timeouts JobTemplateLaunchTimeoutsArgs
    wait_for_completion bool
    Resource creation will wait for job completion.
    extraVars String
    Override job template variables. YAML or JSON values are supported.
    inventoryId Number
    Override Inventory ID. Required ask_inventory_on_launch set on job_template.
    jobTemplateId Number
    Job template ID
    jobTemplateLaunchId String
    limit String
    List of comma delimited hosts to limit job execution. Required ask_limit_on_launch set on job_template.
    timeouts Property Map
    waitForCompletion Boolean
    Resource creation will wait for job completion.

    Supporting Types

    JobTemplateLaunchTimeouts, JobTemplateLaunchTimeoutsArgs

    Create string
    Create string
    create String
    create string
    create str
    create 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