Schedule resource
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,
schedule_type: Optional[ScheduleScheduleTypeArgs] = None,
device: Optional[str] = None,
folder: Optional[str] = None,
name: Optional[str] = None,
snippet: 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: scm: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 Scm.Schedule("scheduleResource", new()
{
ScheduleType = new Scm.Inputs.ScheduleScheduleTypeArgs
{
NonRecurrings = new[]
{
"string",
},
Recurring = new Scm.Inputs.ScheduleScheduleTypeRecurringArgs
{
Dailies = new[]
{
"string",
},
Weekly = new Scm.Inputs.ScheduleScheduleTypeRecurringWeeklyArgs
{
Fridays = new[]
{
"string",
},
Mondays = new[]
{
"string",
},
Saturdays = new[]
{
"string",
},
Sundays = new[]
{
"string",
},
Thursdays = new[]
{
"string",
},
Tuesdays = new[]
{
"string",
},
Wednesdays = new[]
{
"string",
},
},
},
},
Device = "string",
Folder = "string",
Name = "string",
Snippet = "string",
});
example, err := scm.NewSchedule(ctx, "scheduleResource", &scm.ScheduleArgs{
ScheduleType: &scm.ScheduleScheduleTypeArgs{
NonRecurrings: pulumi.StringArray{
pulumi.String("string"),
},
Recurring: &scm.ScheduleScheduleTypeRecurringArgs{
Dailies: pulumi.StringArray{
pulumi.String("string"),
},
Weekly: &scm.ScheduleScheduleTypeRecurringWeeklyArgs{
Fridays: pulumi.StringArray{
pulumi.String("string"),
},
Mondays: pulumi.StringArray{
pulumi.String("string"),
},
Saturdays: pulumi.StringArray{
pulumi.String("string"),
},
Sundays: pulumi.StringArray{
pulumi.String("string"),
},
Thursdays: pulumi.StringArray{
pulumi.String("string"),
},
Tuesdays: pulumi.StringArray{
pulumi.String("string"),
},
Wednesdays: pulumi.StringArray{
pulumi.String("string"),
},
},
},
},
Device: pulumi.String("string"),
Folder: pulumi.String("string"),
Name: pulumi.String("string"),
Snippet: pulumi.String("string"),
})
var scheduleResource = new Schedule("scheduleResource", ScheduleArgs.builder()
.scheduleType(ScheduleScheduleTypeArgs.builder()
.nonRecurrings("string")
.recurring(ScheduleScheduleTypeRecurringArgs.builder()
.dailies("string")
.weekly(ScheduleScheduleTypeRecurringWeeklyArgs.builder()
.fridays("string")
.mondays("string")
.saturdays("string")
.sundays("string")
.thursdays("string")
.tuesdays("string")
.wednesdays("string")
.build())
.build())
.build())
.device("string")
.folder("string")
.name("string")
.snippet("string")
.build());
schedule_resource = scm.Schedule("scheduleResource",
schedule_type={
"non_recurrings": ["string"],
"recurring": {
"dailies": ["string"],
"weekly": {
"fridays": ["string"],
"mondays": ["string"],
"saturdays": ["string"],
"sundays": ["string"],
"thursdays": ["string"],
"tuesdays": ["string"],
"wednesdays": ["string"],
},
},
},
device="string",
folder="string",
name="string",
snippet="string")
const scheduleResource = new scm.Schedule("scheduleResource", {
scheduleType: {
nonRecurrings: ["string"],
recurring: {
dailies: ["string"],
weekly: {
fridays: ["string"],
mondays: ["string"],
saturdays: ["string"],
sundays: ["string"],
thursdays: ["string"],
tuesdays: ["string"],
wednesdays: ["string"],
},
},
},
device: "string",
folder: "string",
name: "string",
snippet: "string",
});
type: scm:Schedule
properties:
device: string
folder: string
name: string
scheduleType:
nonRecurrings:
- string
recurring:
dailies:
- string
weekly:
fridays:
- string
mondays:
- string
saturdays:
- string
sundays:
- string
thursdays:
- string
tuesdays:
- string
wednesdays:
- string
snippet: string
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:
- Schedule
Type ScheduleSchedule Type - Schedule type
- Device string
- The device in which the resource is defined
- Folder string
- The folder in which the resource is defined
- Name string
- The name of the schedule
- Snippet string
- The snippet in which the resource is defined
- Schedule
Type ScheduleSchedule Type Args - Schedule type
- Device string
- The device in which the resource is defined
- Folder string
- The folder in which the resource is defined
- Name string
- The name of the schedule
- Snippet string
- The snippet in which the resource is defined
- schedule
Type ScheduleSchedule Type - Schedule type
- device String
- The device in which the resource is defined
- folder String
- The folder in which the resource is defined
- name String
- The name of the schedule
- snippet String
- The snippet in which the resource is defined
- schedule
Type ScheduleSchedule Type - Schedule type
- device string
- The device in which the resource is defined
- folder string
- The folder in which the resource is defined
- name string
- The name of the schedule
- snippet string
- The snippet in which the resource is defined
- schedule_
type ScheduleSchedule Type Args - Schedule type
- device str
- The device in which the resource is defined
- folder str
- The folder in which the resource is defined
- name str
- The name of the schedule
- snippet str
- The snippet in which the resource is defined
- schedule
Type Property Map - Schedule type
- device String
- The device in which the resource is defined
- folder String
- The folder in which the resource is defined
- name String
- The name of the schedule
- snippet String
- The snippet in which the resource is defined
Outputs
All input properties are implicitly available as output properties. Additionally, the Schedule resource produces the following output properties:
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,
device: Optional[str] = None,
folder: Optional[str] = None,
name: Optional[str] = None,
schedule_type: Optional[ScheduleScheduleTypeArgs] = None,
snippet: Optional[str] = None,
tfid: Optional[str] = None) -> Schedulefunc 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: scm: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.
- Device string
- The device in which the resource is defined
- Folder string
- The folder in which the resource is defined
- Name string
- The name of the schedule
- Schedule
Type ScheduleSchedule Type - Schedule type
- Snippet string
- The snippet in which the resource is defined
- Tfid string
- Device string
- The device in which the resource is defined
- Folder string
- The folder in which the resource is defined
- Name string
- The name of the schedule
- Schedule
Type ScheduleSchedule Type Args - Schedule type
- Snippet string
- The snippet in which the resource is defined
- Tfid string
- device String
- The device in which the resource is defined
- folder String
- The folder in which the resource is defined
- name String
- The name of the schedule
- schedule
Type ScheduleSchedule Type - Schedule type
- snippet String
- The snippet in which the resource is defined
- tfid String
- device string
- The device in which the resource is defined
- folder string
- The folder in which the resource is defined
- name string
- The name of the schedule
- schedule
Type ScheduleSchedule Type - Schedule type
- snippet string
- The snippet in which the resource is defined
- tfid string
- device str
- The device in which the resource is defined
- folder str
- The folder in which the resource is defined
- name str
- The name of the schedule
- schedule_
type ScheduleSchedule Type Args - Schedule type
- snippet str
- The snippet in which the resource is defined
- tfid str
- device String
- The device in which the resource is defined
- folder String
- The folder in which the resource is defined
- name String
- The name of the schedule
- schedule
Type Property Map - Schedule type
- snippet String
- The snippet in which the resource is defined
- tfid String
Supporting Types
ScheduleScheduleType, ScheduleScheduleTypeArgs
- Non
Recurrings List<string> - Non recurring
- Recurring
Schedule
Schedule Type Recurring - Recurring
- Non
Recurrings []string - Non recurring
- Recurring
Schedule
Schedule Type Recurring - Recurring
- non
Recurrings List<String> - Non recurring
- recurring
Schedule
Schedule Type Recurring - Recurring
- non
Recurrings string[] - Non recurring
- recurring
Schedule
Schedule Type Recurring - Recurring
- non_
recurrings Sequence[str] - Non recurring
- recurring
Schedule
Schedule Type Recurring - Recurring
- non
Recurrings List<String> - Non recurring
- recurring Property Map
- Recurring
ScheduleScheduleTypeRecurring, ScheduleScheduleTypeRecurringArgs
- Dailies List<string>
- Daily
- Weekly
Schedule
Schedule Type Recurring Weekly - Weekly
- Dailies []string
- Daily
- Weekly
Schedule
Schedule Type Recurring Weekly - Weekly
- dailies List<String>
- Daily
- weekly
Schedule
Schedule Type Recurring Weekly - Weekly
- dailies string[]
- Daily
- weekly
Schedule
Schedule Type Recurring Weekly - Weekly
- dailies Sequence[str]
- Daily
- weekly
Schedule
Schedule Type Recurring Weekly - Weekly
- dailies List<String>
- Daily
- weekly Property Map
- Weekly
ScheduleScheduleTypeRecurringWeekly, ScheduleScheduleTypeRecurringWeeklyArgs
Package Details
- Repository
- scm pulumi/pulumi-scm
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
scmTerraform Provider.
