oci.ResourceScheduler.Schedule
Explore with Pulumi AI
This resource provides the Schedule resource in Oracle Cloud Infrastructure Resource Scheduler service.
Creates a Schedule
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,
recurrence_details: Optional[str] = None,
compartment_id: Optional[str] = None,
recurrence_type: Optional[str] = None,
action: Optional[str] = None,
description: Optional[str] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
display_name: Optional[str] = None,
defined_tags: Optional[Mapping[str, str]] = None,
resource_filters: Optional[Sequence[_resourcescheduler.ScheduleResourceFilterArgs]] = None,
resources: Optional[Sequence[_resourcescheduler.ScheduleResourceArgs]] = None,
state: Optional[str] = None,
time_ends: Optional[str] = None,
time_starts: 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: oci:ResourceScheduler: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 ociScheduleResource = new Oci.ResourceScheduler.Schedule("ociScheduleResource", new()
{
RecurrenceDetails = "string",
CompartmentId = "string",
RecurrenceType = "string",
Action = "string",
Description = "string",
FreeformTags =
{
{ "string", "string" },
},
DisplayName = "string",
DefinedTags =
{
{ "string", "string" },
},
ResourceFilters = new[]
{
new Oci.ResourceScheduler.Inputs.ScheduleResourceFilterArgs
{
Attribute = "string",
Condition = "string",
ShouldIncludeChildCompartments = false,
Values = new[]
{
new Oci.ResourceScheduler.Inputs.ScheduleResourceFilterValueArgs
{
Namespace = "string",
TagKey = "string",
Value = "string",
},
},
},
},
Resources = new[]
{
new Oci.ResourceScheduler.Inputs.ScheduleResourceArgs
{
Id = "string",
Metadata =
{
{ "string", "string" },
},
},
},
State = "string",
TimeEnds = "string",
TimeStarts = "string",
});
example, err := ResourceScheduler.NewSchedule(ctx, "ociScheduleResource", &ResourceScheduler.ScheduleArgs{
RecurrenceDetails: pulumi.String("string"),
CompartmentId: pulumi.String("string"),
RecurrenceType: pulumi.String("string"),
Action: pulumi.String("string"),
Description: pulumi.String("string"),
FreeformTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
DisplayName: pulumi.String("string"),
DefinedTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
ResourceFilters: resourcescheduler.ScheduleResourceFilterArray{
&resourcescheduler.ScheduleResourceFilterArgs{
Attribute: pulumi.String("string"),
Condition: pulumi.String("string"),
ShouldIncludeChildCompartments: pulumi.Bool(false),
Values: resourcescheduler.ScheduleResourceFilterValueArray{
&resourcescheduler.ScheduleResourceFilterValueArgs{
Namespace: pulumi.String("string"),
TagKey: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
},
},
Resources: resourcescheduler.ScheduleResourceArray{
&resourcescheduler.ScheduleResourceArgs{
Id: pulumi.String("string"),
Metadata: pulumi.StringMap{
"string": pulumi.String("string"),
},
},
},
State: pulumi.String("string"),
TimeEnds: pulumi.String("string"),
TimeStarts: pulumi.String("string"),
})
var ociScheduleResource = new Schedule("ociScheduleResource", ScheduleArgs.builder()
.recurrenceDetails("string")
.compartmentId("string")
.recurrenceType("string")
.action("string")
.description("string")
.freeformTags(Map.of("string", "string"))
.displayName("string")
.definedTags(Map.of("string", "string"))
.resourceFilters(ScheduleResourceFilterArgs.builder()
.attribute("string")
.condition("string")
.shouldIncludeChildCompartments(false)
.values(ScheduleResourceFilterValueArgs.builder()
.namespace("string")
.tagKey("string")
.value("string")
.build())
.build())
.resources(ScheduleResourceArgs.builder()
.id("string")
.metadata(Map.of("string", "string"))
.build())
.state("string")
.timeEnds("string")
.timeStarts("string")
.build());
oci_schedule_resource = oci.resource_scheduler.Schedule("ociScheduleResource",
recurrence_details="string",
compartment_id="string",
recurrence_type="string",
action="string",
description="string",
freeform_tags={
"string": "string",
},
display_name="string",
defined_tags={
"string": "string",
},
resource_filters=[{
"attribute": "string",
"condition": "string",
"should_include_child_compartments": False,
"values": [{
"namespace": "string",
"tag_key": "string",
"value": "string",
}],
}],
resources=[{
"id": "string",
"metadata": {
"string": "string",
},
}],
state="string",
time_ends="string",
time_starts="string")
const ociScheduleResource = new oci.resourcescheduler.Schedule("ociScheduleResource", {
recurrenceDetails: "string",
compartmentId: "string",
recurrenceType: "string",
action: "string",
description: "string",
freeformTags: {
string: "string",
},
displayName: "string",
definedTags: {
string: "string",
},
resourceFilters: [{
attribute: "string",
condition: "string",
shouldIncludeChildCompartments: false,
values: [{
namespace: "string",
tagKey: "string",
value: "string",
}],
}],
resources: [{
id: "string",
metadata: {
string: "string",
},
}],
state: "string",
timeEnds: "string",
timeStarts: "string",
});
type: oci:ResourceScheduler:Schedule
properties:
action: string
compartmentId: string
definedTags:
string: string
description: string
displayName: string
freeformTags:
string: string
recurrenceDetails: string
recurrenceType: string
resourceFilters:
- attribute: string
condition: string
shouldIncludeChildCompartments: false
values:
- namespace: string
tagKey: string
value: string
resources:
- id: string
metadata:
string: string
state: string
timeEnds: string
timeStarts: 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:
- Action string
- (Updatable) This is the action that will be executed by the schedule.
- Compartment
Id string - The OCID of the compartment in which the schedule is created
- Recurrence
Details string - (Updatable) This is the frequency of recurrence of a schedule. The frequency field can either conform to RFC-5545 formatting or UNIX cron formatting for recurrences, based on the value specified by the recurrenceType field. Example:
FREQ=WEEKLY;BYDAY=MO,TU,WE,TH;BYHOUR=10;INTERVAL=1
- Recurrence
Type string - (Updatable) Type of recurrence of a schedule. Could be set to
ICAL
,CRON
- Dictionary<string, string>
- (Updatable) These are defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- Description string
- (Updatable) This is the description of the schedule.
- Display
Name string - (Updatable) This is a user-friendly name for the schedule. It does not have to be unique, and it's changeable.
- Dictionary<string, string>
- (Updatable) These are free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- Resource
Filters List<ScheduleResource Filter> - (Updatable) This is a list of resources filters. The schedule will be applied to resources matching all of them.
- Resources
List<Schedule
Resource> - (Updatable) This is the list of resources to which the scheduled operation is applied.
- State string
(Updatable) The target state for the Schedule. Could be set to
ACTIVE
orINACTIVE
.** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Time
Ends string - (Updatable) This is the date and time the schedule ends, in the format defined by RFC 3339 Example:
2016-08-25T21:10:29.600Z
- Time
Starts string - (Updatable) This is the date and time the schedule starts, in the format defined by RFC 3339 Example:
2016-08-25T21:10:29.600Z
- Action string
- (Updatable) This is the action that will be executed by the schedule.
- Compartment
Id string - The OCID of the compartment in which the schedule is created
- Recurrence
Details string - (Updatable) This is the frequency of recurrence of a schedule. The frequency field can either conform to RFC-5545 formatting or UNIX cron formatting for recurrences, based on the value specified by the recurrenceType field. Example:
FREQ=WEEKLY;BYDAY=MO,TU,WE,TH;BYHOUR=10;INTERVAL=1
- Recurrence
Type string - (Updatable) Type of recurrence of a schedule. Could be set to
ICAL
,CRON
- map[string]string
- (Updatable) These are defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- Description string
- (Updatable) This is the description of the schedule.
- Display
Name string - (Updatable) This is a user-friendly name for the schedule. It does not have to be unique, and it's changeable.
- map[string]string
- (Updatable) These are free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- Resource
Filters []ScheduleResource Filter Args - (Updatable) This is a list of resources filters. The schedule will be applied to resources matching all of them.
- Resources
[]Schedule
Resource Args - (Updatable) This is the list of resources to which the scheduled operation is applied.
- State string
(Updatable) The target state for the Schedule. Could be set to
ACTIVE
orINACTIVE
.** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Time
Ends string - (Updatable) This is the date and time the schedule ends, in the format defined by RFC 3339 Example:
2016-08-25T21:10:29.600Z
- Time
Starts string - (Updatable) This is the date and time the schedule starts, in the format defined by RFC 3339 Example:
2016-08-25T21:10:29.600Z
- action String
- (Updatable) This is the action that will be executed by the schedule.
- compartment
Id String - The OCID of the compartment in which the schedule is created
- recurrence
Details String - (Updatable) This is the frequency of recurrence of a schedule. The frequency field can either conform to RFC-5545 formatting or UNIX cron formatting for recurrences, based on the value specified by the recurrenceType field. Example:
FREQ=WEEKLY;BYDAY=MO,TU,WE,TH;BYHOUR=10;INTERVAL=1
- recurrence
Type String - (Updatable) Type of recurrence of a schedule. Could be set to
ICAL
,CRON
- Map<String,String>
- (Updatable) These are defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- description String
- (Updatable) This is the description of the schedule.
- display
Name String - (Updatable) This is a user-friendly name for the schedule. It does not have to be unique, and it's changeable.
- Map<String,String>
- (Updatable) These are free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- resource
Filters List<ScheduleResource Filter> - (Updatable) This is a list of resources filters. The schedule will be applied to resources matching all of them.
- resources
List<Schedule
Resource> - (Updatable) This is the list of resources to which the scheduled operation is applied.
- state String
(Updatable) The target state for the Schedule. Could be set to
ACTIVE
orINACTIVE
.** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- time
Ends String - (Updatable) This is the date and time the schedule ends, in the format defined by RFC 3339 Example:
2016-08-25T21:10:29.600Z
- time
Starts String - (Updatable) This is the date and time the schedule starts, in the format defined by RFC 3339 Example:
2016-08-25T21:10:29.600Z
- action string
- (Updatable) This is the action that will be executed by the schedule.
- compartment
Id string - The OCID of the compartment in which the schedule is created
- recurrence
Details string - (Updatable) This is the frequency of recurrence of a schedule. The frequency field can either conform to RFC-5545 formatting or UNIX cron formatting for recurrences, based on the value specified by the recurrenceType field. Example:
FREQ=WEEKLY;BYDAY=MO,TU,WE,TH;BYHOUR=10;INTERVAL=1
- recurrence
Type string - (Updatable) Type of recurrence of a schedule. Could be set to
ICAL
,CRON
- {[key: string]: string}
- (Updatable) These are defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- description string
- (Updatable) This is the description of the schedule.
- display
Name string - (Updatable) This is a user-friendly name for the schedule. It does not have to be unique, and it's changeable.
- {[key: string]: string}
- (Updatable) These are free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- resource
Filters ScheduleResource Filter[] - (Updatable) This is a list of resources filters. The schedule will be applied to resources matching all of them.
- resources
Schedule
Resource[] - (Updatable) This is the list of resources to which the scheduled operation is applied.
- state string
(Updatable) The target state for the Schedule. Could be set to
ACTIVE
orINACTIVE
.** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- time
Ends string - (Updatable) This is the date and time the schedule ends, in the format defined by RFC 3339 Example:
2016-08-25T21:10:29.600Z
- time
Starts string - (Updatable) This is the date and time the schedule starts, in the format defined by RFC 3339 Example:
2016-08-25T21:10:29.600Z
- action str
- (Updatable) This is the action that will be executed by the schedule.
- compartment_
id str - The OCID of the compartment in which the schedule is created
- recurrence_
details str - (Updatable) This is the frequency of recurrence of a schedule. The frequency field can either conform to RFC-5545 formatting or UNIX cron formatting for recurrences, based on the value specified by the recurrenceType field. Example:
FREQ=WEEKLY;BYDAY=MO,TU,WE,TH;BYHOUR=10;INTERVAL=1
- recurrence_
type str - (Updatable) Type of recurrence of a schedule. Could be set to
ICAL
,CRON
- Mapping[str, str]
- (Updatable) These are defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- description str
- (Updatable) This is the description of the schedule.
- display_
name str - (Updatable) This is a user-friendly name for the schedule. It does not have to be unique, and it's changeable.
- Mapping[str, str]
- (Updatable) These are free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- resource_
filters Sequence[resourcescheduler.Schedule Resource Filter Args] - (Updatable) This is a list of resources filters. The schedule will be applied to resources matching all of them.
- resources
Sequence[resourcescheduler.
Schedule Resource Args] - (Updatable) This is the list of resources to which the scheduled operation is applied.
- state str
(Updatable) The target state for the Schedule. Could be set to
ACTIVE
orINACTIVE
.** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- time_
ends str - (Updatable) This is the date and time the schedule ends, in the format defined by RFC 3339 Example:
2016-08-25T21:10:29.600Z
- time_
starts str - (Updatable) This is the date and time the schedule starts, in the format defined by RFC 3339 Example:
2016-08-25T21:10:29.600Z
- action String
- (Updatable) This is the action that will be executed by the schedule.
- compartment
Id String - The OCID of the compartment in which the schedule is created
- recurrence
Details String - (Updatable) This is the frequency of recurrence of a schedule. The frequency field can either conform to RFC-5545 formatting or UNIX cron formatting for recurrences, based on the value specified by the recurrenceType field. Example:
FREQ=WEEKLY;BYDAY=MO,TU,WE,TH;BYHOUR=10;INTERVAL=1
- recurrence
Type String - (Updatable) Type of recurrence of a schedule. Could be set to
ICAL
,CRON
- Map<String>
- (Updatable) These are defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- description String
- (Updatable) This is the description of the schedule.
- display
Name String - (Updatable) This is a user-friendly name for the schedule. It does not have to be unique, and it's changeable.
- Map<String>
- (Updatable) These are free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- resource
Filters List<Property Map> - (Updatable) This is a list of resources filters. The schedule will be applied to resources matching all of them.
- resources List<Property Map>
- (Updatable) This is the list of resources to which the scheduled operation is applied.
- state String
(Updatable) The target state for the Schedule. Could be set to
ACTIVE
orINACTIVE
.** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- time
Ends String - (Updatable) This is the date and time the schedule ends, in the format defined by RFC 3339 Example:
2016-08-25T21:10:29.600Z
- time
Starts String - (Updatable) This is the date and time the schedule starts, in the format defined by RFC 3339 Example:
2016-08-25T21:10:29.600Z
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.
- Dictionary<string, string>
- These are system tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"}
- Time
Created string - This is the date and time the schedule was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- Time
Last stringRun - This is the date and time the schedule runs last time, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- Time
Next stringRun - This is the date and time the schedule run the next time, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- Time
Updated string - This is the date and time the schedule was updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- Id string
- The provider-assigned unique ID for this managed resource.
- map[string]string
- These are system tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"}
- Time
Created string - This is the date and time the schedule was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- Time
Last stringRun - This is the date and time the schedule runs last time, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- Time
Next stringRun - This is the date and time the schedule run the next time, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- Time
Updated string - This is the date and time the schedule was updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- id String
- The provider-assigned unique ID for this managed resource.
- Map<String,String>
- These are system tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time
Created String - This is the date and time the schedule was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- time
Last StringRun - This is the date and time the schedule runs last time, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- time
Next StringRun - This is the date and time the schedule run the next time, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- time
Updated String - This is the date and time the schedule was updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- id string
- The provider-assigned unique ID for this managed resource.
- {[key: string]: string}
- These are system tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time
Created string - This is the date and time the schedule was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- time
Last stringRun - This is the date and time the schedule runs last time, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- time
Next stringRun - This is the date and time the schedule run the next time, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- time
Updated string - This is the date and time the schedule was updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- id str
- The provider-assigned unique ID for this managed resource.
- Mapping[str, str]
- These are system tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time_
created str - This is the date and time the schedule was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- time_
last_ strrun - This is the date and time the schedule runs last time, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- time_
next_ strrun - This is the date and time the schedule run the next time, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- time_
updated str - This is the date and time the schedule was updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- id String
- The provider-assigned unique ID for this managed resource.
- Map<String>
- These are system tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time
Created String - This is the date and time the schedule was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- time
Last StringRun - This is the date and time the schedule runs last time, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- time
Next StringRun - This is the date and time the schedule run the next time, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- time
Updated String - This is the date and time the schedule was updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
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,
action: Optional[str] = None,
compartment_id: Optional[str] = None,
defined_tags: Optional[Mapping[str, str]] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
recurrence_details: Optional[str] = None,
recurrence_type: Optional[str] = None,
resource_filters: Optional[Sequence[_resourcescheduler.ScheduleResourceFilterArgs]] = None,
resources: Optional[Sequence[_resourcescheduler.ScheduleResourceArgs]] = None,
state: Optional[str] = None,
system_tags: Optional[Mapping[str, str]] = None,
time_created: Optional[str] = None,
time_ends: Optional[str] = None,
time_last_run: Optional[str] = None,
time_next_run: Optional[str] = None,
time_starts: Optional[str] = None,
time_updated: Optional[str] = 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)
Resource lookup is not supported in YAML
- 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.
- Action string
- (Updatable) This is the action that will be executed by the schedule.
- Compartment
Id string - The OCID of the compartment in which the schedule is created
- Dictionary<string, string>
- (Updatable) These are defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- Description string
- (Updatable) This is the description of the schedule.
- Display
Name string - (Updatable) This is a user-friendly name for the schedule. It does not have to be unique, and it's changeable.
- Dictionary<string, string>
- (Updatable) These are free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- Recurrence
Details string - (Updatable) This is the frequency of recurrence of a schedule. The frequency field can either conform to RFC-5545 formatting or UNIX cron formatting for recurrences, based on the value specified by the recurrenceType field. Example:
FREQ=WEEKLY;BYDAY=MO,TU,WE,TH;BYHOUR=10;INTERVAL=1
- Recurrence
Type string - (Updatable) Type of recurrence of a schedule. Could be set to
ICAL
,CRON
- Resource
Filters List<ScheduleResource Filter> - (Updatable) This is a list of resources filters. The schedule will be applied to resources matching all of them.
- Resources
List<Schedule
Resource> - (Updatable) This is the list of resources to which the scheduled operation is applied.
- State string
(Updatable) The target state for the Schedule. Could be set to
ACTIVE
orINACTIVE
.** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Dictionary<string, string>
- These are system tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"}
- Time
Created string - This is the date and time the schedule was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- Time
Ends string - (Updatable) This is the date and time the schedule ends, in the format defined by RFC 3339 Example:
2016-08-25T21:10:29.600Z
- Time
Last stringRun - This is the date and time the schedule runs last time, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- Time
Next stringRun - This is the date and time the schedule run the next time, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- Time
Starts string - (Updatable) This is the date and time the schedule starts, in the format defined by RFC 3339 Example:
2016-08-25T21:10:29.600Z
- Time
Updated string - This is the date and time the schedule was updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- Action string
- (Updatable) This is the action that will be executed by the schedule.
- Compartment
Id string - The OCID of the compartment in which the schedule is created
- map[string]string
- (Updatable) These are defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- Description string
- (Updatable) This is the description of the schedule.
- Display
Name string - (Updatable) This is a user-friendly name for the schedule. It does not have to be unique, and it's changeable.
- map[string]string
- (Updatable) These are free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- Recurrence
Details string - (Updatable) This is the frequency of recurrence of a schedule. The frequency field can either conform to RFC-5545 formatting or UNIX cron formatting for recurrences, based on the value specified by the recurrenceType field. Example:
FREQ=WEEKLY;BYDAY=MO,TU,WE,TH;BYHOUR=10;INTERVAL=1
- Recurrence
Type string - (Updatable) Type of recurrence of a schedule. Could be set to
ICAL
,CRON
- Resource
Filters []ScheduleResource Filter Args - (Updatable) This is a list of resources filters. The schedule will be applied to resources matching all of them.
- Resources
[]Schedule
Resource Args - (Updatable) This is the list of resources to which the scheduled operation is applied.
- State string
(Updatable) The target state for the Schedule. Could be set to
ACTIVE
orINACTIVE
.** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- map[string]string
- These are system tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"}
- Time
Created string - This is the date and time the schedule was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- Time
Ends string - (Updatable) This is the date and time the schedule ends, in the format defined by RFC 3339 Example:
2016-08-25T21:10:29.600Z
- Time
Last stringRun - This is the date and time the schedule runs last time, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- Time
Next stringRun - This is the date and time the schedule run the next time, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- Time
Starts string - (Updatable) This is the date and time the schedule starts, in the format defined by RFC 3339 Example:
2016-08-25T21:10:29.600Z
- Time
Updated string - This is the date and time the schedule was updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- action String
- (Updatable) This is the action that will be executed by the schedule.
- compartment
Id String - The OCID of the compartment in which the schedule is created
- Map<String,String>
- (Updatable) These are defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- description String
- (Updatable) This is the description of the schedule.
- display
Name String - (Updatable) This is a user-friendly name for the schedule. It does not have to be unique, and it's changeable.
- Map<String,String>
- (Updatable) These are free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- recurrence
Details String - (Updatable) This is the frequency of recurrence of a schedule. The frequency field can either conform to RFC-5545 formatting or UNIX cron formatting for recurrences, based on the value specified by the recurrenceType field. Example:
FREQ=WEEKLY;BYDAY=MO,TU,WE,TH;BYHOUR=10;INTERVAL=1
- recurrence
Type String - (Updatable) Type of recurrence of a schedule. Could be set to
ICAL
,CRON
- resource
Filters List<ScheduleResource Filter> - (Updatable) This is a list of resources filters. The schedule will be applied to resources matching all of them.
- resources
List<Schedule
Resource> - (Updatable) This is the list of resources to which the scheduled operation is applied.
- state String
(Updatable) The target state for the Schedule. Could be set to
ACTIVE
orINACTIVE
.** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Map<String,String>
- These are system tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time
Created String - This is the date and time the schedule was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- time
Ends String - (Updatable) This is the date and time the schedule ends, in the format defined by RFC 3339 Example:
2016-08-25T21:10:29.600Z
- time
Last StringRun - This is the date and time the schedule runs last time, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- time
Next StringRun - This is the date and time the schedule run the next time, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- time
Starts String - (Updatable) This is the date and time the schedule starts, in the format defined by RFC 3339 Example:
2016-08-25T21:10:29.600Z
- time
Updated String - This is the date and time the schedule was updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- action string
- (Updatable) This is the action that will be executed by the schedule.
- compartment
Id string - The OCID of the compartment in which the schedule is created
- {[key: string]: string}
- (Updatable) These are defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- description string
- (Updatable) This is the description of the schedule.
- display
Name string - (Updatable) This is a user-friendly name for the schedule. It does not have to be unique, and it's changeable.
- {[key: string]: string}
- (Updatable) These are free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- recurrence
Details string - (Updatable) This is the frequency of recurrence of a schedule. The frequency field can either conform to RFC-5545 formatting or UNIX cron formatting for recurrences, based on the value specified by the recurrenceType field. Example:
FREQ=WEEKLY;BYDAY=MO,TU,WE,TH;BYHOUR=10;INTERVAL=1
- recurrence
Type string - (Updatable) Type of recurrence of a schedule. Could be set to
ICAL
,CRON
- resource
Filters ScheduleResource Filter[] - (Updatable) This is a list of resources filters. The schedule will be applied to resources matching all of them.
- resources
Schedule
Resource[] - (Updatable) This is the list of resources to which the scheduled operation is applied.
- state string
(Updatable) The target state for the Schedule. Could be set to
ACTIVE
orINACTIVE
.** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- {[key: string]: string}
- These are system tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time
Created string - This is the date and time the schedule was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- time
Ends string - (Updatable) This is the date and time the schedule ends, in the format defined by RFC 3339 Example:
2016-08-25T21:10:29.600Z
- time
Last stringRun - This is the date and time the schedule runs last time, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- time
Next stringRun - This is the date and time the schedule run the next time, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- time
Starts string - (Updatable) This is the date and time the schedule starts, in the format defined by RFC 3339 Example:
2016-08-25T21:10:29.600Z
- time
Updated string - This is the date and time the schedule was updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- action str
- (Updatable) This is the action that will be executed by the schedule.
- compartment_
id str - The OCID of the compartment in which the schedule is created
- Mapping[str, str]
- (Updatable) These are defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- description str
- (Updatable) This is the description of the schedule.
- display_
name str - (Updatable) This is a user-friendly name for the schedule. It does not have to be unique, and it's changeable.
- Mapping[str, str]
- (Updatable) These are free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- recurrence_
details str - (Updatable) This is the frequency of recurrence of a schedule. The frequency field can either conform to RFC-5545 formatting or UNIX cron formatting for recurrences, based on the value specified by the recurrenceType field. Example:
FREQ=WEEKLY;BYDAY=MO,TU,WE,TH;BYHOUR=10;INTERVAL=1
- recurrence_
type str - (Updatable) Type of recurrence of a schedule. Could be set to
ICAL
,CRON
- resource_
filters Sequence[resourcescheduler.Schedule Resource Filter Args] - (Updatable) This is a list of resources filters. The schedule will be applied to resources matching all of them.
- resources
Sequence[resourcescheduler.
Schedule Resource Args] - (Updatable) This is the list of resources to which the scheduled operation is applied.
- state str
(Updatable) The target state for the Schedule. Could be set to
ACTIVE
orINACTIVE
.** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Mapping[str, str]
- These are system tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time_
created str - This is the date and time the schedule was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- time_
ends str - (Updatable) This is the date and time the schedule ends, in the format defined by RFC 3339 Example:
2016-08-25T21:10:29.600Z
- time_
last_ strrun - This is the date and time the schedule runs last time, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- time_
next_ strrun - This is the date and time the schedule run the next time, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- time_
starts str - (Updatable) This is the date and time the schedule starts, in the format defined by RFC 3339 Example:
2016-08-25T21:10:29.600Z
- time_
updated str - This is the date and time the schedule was updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- action String
- (Updatable) This is the action that will be executed by the schedule.
- compartment
Id String - The OCID of the compartment in which the schedule is created
- Map<String>
- (Updatable) These are defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- description String
- (Updatable) This is the description of the schedule.
- display
Name String - (Updatable) This is a user-friendly name for the schedule. It does not have to be unique, and it's changeable.
- Map<String>
- (Updatable) These are free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- recurrence
Details String - (Updatable) This is the frequency of recurrence of a schedule. The frequency field can either conform to RFC-5545 formatting or UNIX cron formatting for recurrences, based on the value specified by the recurrenceType field. Example:
FREQ=WEEKLY;BYDAY=MO,TU,WE,TH;BYHOUR=10;INTERVAL=1
- recurrence
Type String - (Updatable) Type of recurrence of a schedule. Could be set to
ICAL
,CRON
- resource
Filters List<Property Map> - (Updatable) This is a list of resources filters. The schedule will be applied to resources matching all of them.
- resources List<Property Map>
- (Updatable) This is the list of resources to which the scheduled operation is applied.
- state String
(Updatable) The target state for the Schedule. Could be set to
ACTIVE
orINACTIVE
.** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Map<String>
- These are system tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time
Created String - This is the date and time the schedule was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- time
Ends String - (Updatable) This is the date and time the schedule ends, in the format defined by RFC 3339 Example:
2016-08-25T21:10:29.600Z
- time
Last StringRun - This is the date and time the schedule runs last time, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- time
Next StringRun - This is the date and time the schedule run the next time, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- time
Starts String - (Updatable) This is the date and time the schedule starts, in the format defined by RFC 3339 Example:
2016-08-25T21:10:29.600Z
- time
Updated String - This is the date and time the schedule was updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
Supporting Types
ScheduleResource, ScheduleResourceArgs
ScheduleResourceFilter, ScheduleResourceFilterArgs
- Attribute string
- (Updatable) This is the resource attribute on which the threshold is defined. We support 5 different types of attributes:
DEFINED_TAGS
,COMPARTMENT_ID
,TIME_CREATED
,LIFECYCLE_STATE
andRESOURCE_TYPE
. - Condition string
- This is the condition for the filter in comparison to its creation time.
- Should
Include boolChild Compartments - This sets whether to include child compartments.
- Values
List<Schedule
Resource Filter Value> - (Updatable) This is a collection of resource filter values, different types of filter has different value format, see below:
- When
attribute="DEFINED_TAGS"
:
- When
- Attribute string
- (Updatable) This is the resource attribute on which the threshold is defined. We support 5 different types of attributes:
DEFINED_TAGS
,COMPARTMENT_ID
,TIME_CREATED
,LIFECYCLE_STATE
andRESOURCE_TYPE
. - Condition string
- This is the condition for the filter in comparison to its creation time.
- Should
Include boolChild Compartments - This sets whether to include child compartments.
- Values
[]Schedule
Resource Filter Value - (Updatable) This is a collection of resource filter values, different types of filter has different value format, see below:
- When
attribute="DEFINED_TAGS"
:
- When
- attribute String
- (Updatable) This is the resource attribute on which the threshold is defined. We support 5 different types of attributes:
DEFINED_TAGS
,COMPARTMENT_ID
,TIME_CREATED
,LIFECYCLE_STATE
andRESOURCE_TYPE
. - condition String
- This is the condition for the filter in comparison to its creation time.
- should
Include BooleanChild Compartments - This sets whether to include child compartments.
- values
List<Schedule
Resource Filter Value> - (Updatable) This is a collection of resource filter values, different types of filter has different value format, see below:
- When
attribute="DEFINED_TAGS"
:
- When
- attribute string
- (Updatable) This is the resource attribute on which the threshold is defined. We support 5 different types of attributes:
DEFINED_TAGS
,COMPARTMENT_ID
,TIME_CREATED
,LIFECYCLE_STATE
andRESOURCE_TYPE
. - condition string
- This is the condition for the filter in comparison to its creation time.
- should
Include booleanChild Compartments - This sets whether to include child compartments.
- values
Schedule
Resource Filter Value[] - (Updatable) This is a collection of resource filter values, different types of filter has different value format, see below:
- When
attribute="DEFINED_TAGS"
:
- When
- attribute str
- (Updatable) This is the resource attribute on which the threshold is defined. We support 5 different types of attributes:
DEFINED_TAGS
,COMPARTMENT_ID
,TIME_CREATED
,LIFECYCLE_STATE
andRESOURCE_TYPE
. - condition str
- This is the condition for the filter in comparison to its creation time.
- should_
include_ boolchild_ compartments - This sets whether to include child compartments.
- values
Sequence[resourcescheduler.
Schedule Resource Filter Value] - (Updatable) This is a collection of resource filter values, different types of filter has different value format, see below:
- When
attribute="DEFINED_TAGS"
:
- When
- attribute String
- (Updatable) This is the resource attribute on which the threshold is defined. We support 5 different types of attributes:
DEFINED_TAGS
,COMPARTMENT_ID
,TIME_CREATED
,LIFECYCLE_STATE
andRESOURCE_TYPE
. - condition String
- This is the condition for the filter in comparison to its creation time.
- should
Include BooleanChild Compartments - This sets whether to include child compartments.
- values List<Property Map>
- (Updatable) This is a collection of resource filter values, different types of filter has different value format, see below:
- When
attribute="DEFINED_TAGS"
:
- When
ScheduleResourceFilterValue, ScheduleResourceFilterValueArgs
Import
Schedules can be imported using the id
, e.g.
$ pulumi import oci:ResourceScheduler/schedule:Schedule test_schedule "id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.