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

awx.Schedule

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.Schedule("default", {
        rrule: "DTSTART;TZID=Europe/Paris:20211214T120000 RRULE:INTERVAL=1;FREQ=DAILY",
        unifiedJobTemplateId: awx_job_template.baseconfig.id,
    });
    
    import pulumi
    import pulumi_awx as awx
    
    default = awx.Schedule("default",
        rrule="DTSTART;TZID=Europe/Paris:20211214T120000 RRULE:INTERVAL=1;FREQ=DAILY",
        unified_job_template_id=awx_job_template["baseconfig"]["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.NewSchedule(ctx, "default", &awx.ScheduleArgs{
    			Rrule:                pulumi.String("DTSTART;TZID=Europe/Paris:20211214T120000 RRULE:INTERVAL=1;FREQ=DAILY"),
    			UnifiedJobTemplateId: pulumi.Any(awx_job_template.Baseconfig.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.Schedule("default", new()
        {
            Rrule = "DTSTART;TZID=Europe/Paris:20211214T120000 RRULE:INTERVAL=1;FREQ=DAILY",
            UnifiedJobTemplateId = awx_job_template.Baseconfig.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.awx.Schedule;
    import com.pulumi.awx.ScheduleArgs;
    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 Schedule("default", ScheduleArgs.builder()
                .rrule("DTSTART;TZID=Europe/Paris:20211214T120000 RRULE:INTERVAL=1;FREQ=DAILY")
                .unifiedJobTemplateId(awx_job_template.baseconfig().id())
                .build());
    
        }
    }
    
    resources:
      default:
        type: awx:Schedule
        properties:
          rrule: DTSTART;TZID=Europe/Paris:20211214T120000 RRULE:INTERVAL=1;FREQ=DAILY
          unifiedJobTemplateId: ${awx_job_template.baseconfig.id}
    

    Create Schedule Resource

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

    Constructor syntax

    new Schedule(name: string, args: ScheduleArgs, opts?: CustomResourceOptions);
    @overload
    def Schedule(resource_name: str,
                 args: ScheduleArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def Schedule(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 rrule: Optional[str] = None,
                 unified_job_template_id: Optional[float] = None,
                 description: Optional[str] = None,
                 enabled: Optional[bool] = None,
                 extra_data: Optional[str] = None,
                 inventory: Optional[float] = None,
                 name: Optional[str] = None,
                 schedule_id: Optional[str] = None)
    func NewSchedule(ctx *Context, name string, args ScheduleArgs, opts ...ResourceOption) (*Schedule, error)
    public Schedule(string name, ScheduleArgs args, CustomResourceOptions? opts = null)
    public Schedule(String name, ScheduleArgs args)
    public Schedule(String name, ScheduleArgs args, CustomResourceOptions options)
    
    type: awx:Schedule
    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 ScheduleArgs
    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 ScheduleArgs
    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 ScheduleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ScheduleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ScheduleArgs
    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 scheduleResource = new Awx.Schedule("scheduleResource", new()
    {
        Rrule = "string",
        UnifiedJobTemplateId = 0,
        Description = "string",
        Enabled = false,
        ExtraData = "string",
        Inventory = 0,
        Name = "string",
        ScheduleId = "string",
    });
    
    example, err := awx.NewSchedule(ctx, "scheduleResource", &awx.ScheduleArgs{
    	Rrule:                pulumi.String("string"),
    	UnifiedJobTemplateId: pulumi.Float64(0),
    	Description:          pulumi.String("string"),
    	Enabled:              pulumi.Bool(false),
    	ExtraData:            pulumi.String("string"),
    	Inventory:            pulumi.Float64(0),
    	Name:                 pulumi.String("string"),
    	ScheduleId:           pulumi.String("string"),
    })
    
    var scheduleResource = new Schedule("scheduleResource", ScheduleArgs.builder()
        .rrule("string")
        .unifiedJobTemplateId(0)
        .description("string")
        .enabled(false)
        .extraData("string")
        .inventory(0)
        .name("string")
        .scheduleId("string")
        .build());
    
    schedule_resource = awx.Schedule("scheduleResource",
        rrule="string",
        unified_job_template_id=0,
        description="string",
        enabled=False,
        extra_data="string",
        inventory=0,
        name="string",
        schedule_id="string")
    
    const scheduleResource = new awx.Schedule("scheduleResource", {
        rrule: "string",
        unifiedJobTemplateId: 0,
        description: "string",
        enabled: false,
        extraData: "string",
        inventory: 0,
        name: "string",
        scheduleId: "string",
    });
    
    type: awx:Schedule
    properties:
        description: string
        enabled: false
        extraData: string
        inventory: 0
        name: string
        rrule: string
        scheduleId: string
        unifiedJobTemplateId: 0
    

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

    Rrule string
    UnifiedJobTemplateId double
    Description string
    Enabled bool
    ExtraData string
    Extra data to be pass for the schedule (YAML format)
    Inventory double
    Name string
    ScheduleId string
    Rrule string
    UnifiedJobTemplateId float64
    Description string
    Enabled bool
    ExtraData string
    Extra data to be pass for the schedule (YAML format)
    Inventory float64
    Name string
    ScheduleId string
    rrule String
    unifiedJobTemplateId Double
    description String
    enabled Boolean
    extraData String
    Extra data to be pass for the schedule (YAML format)
    inventory Double
    name String
    scheduleId String
    rrule string
    unifiedJobTemplateId number
    description string
    enabled boolean
    extraData string
    Extra data to be pass for the schedule (YAML format)
    inventory number
    name string
    scheduleId string
    rrule str
    unified_job_template_id float
    description str
    enabled bool
    extra_data str
    Extra data to be pass for the schedule (YAML format)
    inventory float
    name str
    schedule_id str
    rrule String
    unifiedJobTemplateId Number
    description String
    enabled Boolean
    extraData String
    Extra data to be pass for the schedule (YAML format)
    inventory Number
    name String
    scheduleId String

    Outputs

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

    Get an existing Schedule 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?: ScheduleState, opts?: CustomResourceOptions): Schedule
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            enabled: Optional[bool] = None,
            extra_data: Optional[str] = None,
            inventory: Optional[float] = None,
            name: Optional[str] = None,
            rrule: Optional[str] = None,
            schedule_id: Optional[str] = None,
            unified_job_template_id: Optional[float] = None) -> Schedule
    func GetSchedule(ctx *Context, name string, id IDInput, state *ScheduleState, opts ...ResourceOption) (*Schedule, error)
    public static Schedule Get(string name, Input<string> id, ScheduleState? state, CustomResourceOptions? opts = null)
    public static Schedule get(String name, Output<String> id, ScheduleState state, CustomResourceOptions options)
    resources:  _:    type: awx:Schedule    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:
    Description string
    Enabled bool
    ExtraData string
    Extra data to be pass for the schedule (YAML format)
    Inventory double
    Name string
    Rrule string
    ScheduleId string
    UnifiedJobTemplateId double
    Description string
    Enabled bool
    ExtraData string
    Extra data to be pass for the schedule (YAML format)
    Inventory float64
    Name string
    Rrule string
    ScheduleId string
    UnifiedJobTemplateId float64
    description String
    enabled Boolean
    extraData String
    Extra data to be pass for the schedule (YAML format)
    inventory Double
    name String
    rrule String
    scheduleId String
    unifiedJobTemplateId Double
    description string
    enabled boolean
    extraData string
    Extra data to be pass for the schedule (YAML format)
    inventory number
    name string
    rrule string
    scheduleId string
    unifiedJobTemplateId number
    description str
    enabled bool
    extra_data str
    Extra data to be pass for the schedule (YAML format)
    inventory float
    name str
    rrule str
    schedule_id str
    unified_job_template_id float
    description String
    enabled Boolean
    extraData String
    Extra data to be pass for the schedule (YAML format)
    inventory Number
    name String
    rrule String
    scheduleId String
    unifiedJobTemplateId Number

    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