Grafana v0.0.10, May 21 23

grafana.MachineLearningHoliday

Explore with Pulumi AI

A holiday describes time periods where a time series is expected to behave differently to normal.

To use a holiday in a job, use its id in the holidays attribute of a grafana.MachineLearningJob:

Create MachineLearningHoliday Resource

new MachineLearningHoliday(name: string, args?: MachineLearningHolidayArgs, opts?: CustomResourceOptions);

@overload
def MachineLearningHoliday(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           custom_periods: Optional[Sequence[MachineLearningHolidayCustomPeriodArgs]] = None,
                           description: Optional[str] = None,
                           ical_timezone: Optional[str] = None,
                           ical_url: Optional[str] = None,
                           name: Optional[str] = None)
@overload
def MachineLearningHoliday(resource_name: str,
                           args: Optional[MachineLearningHolidayArgs] = None,
                           opts: Optional[ResourceOptions] = None)

func NewMachineLearningHoliday(ctx *Context, name string, args *MachineLearningHolidayArgs, opts ...ResourceOption) (*MachineLearningHoliday, error)

public MachineLearningHoliday(string name, MachineLearningHolidayArgs? args = null, CustomResourceOptions? opts = null)

public MachineLearningHoliday(String name, MachineLearningHolidayArgs args)
public MachineLearningHoliday(String name, MachineLearningHolidayArgs args, CustomResourceOptions options)

type: grafana:MachineLearningHoliday
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args MachineLearningHolidayArgs: 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 MachineLearningHolidayArgs: 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 MachineLearningHolidayArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args MachineLearningHolidayArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args MachineLearningHolidayArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

MachineLearningHoliday Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The MachineLearningHoliday resource accepts the following input properties:

CustomPeriods List<Lbrlabs.PulumiPackage.Grafana.Inputs.MachineLearningHolidayCustomPeriodArgs>: A list of custom periods for the holiday.
Description string: A description of the holiday.
IcalTimezone string: The timezone to use for events in the iCal file pointed to by ical_url.
IcalUrl string: A URL to an iCal file containing all occurrences of the holiday.
Name string: The name of the holiday.

CustomPeriods []MachineLearningHolidayCustomPeriodArgs: A list of custom periods for the holiday.
Description string: A description of the holiday.
IcalTimezone string: The timezone to use for events in the iCal file pointed to by ical_url.
IcalUrl string: A URL to an iCal file containing all occurrences of the holiday.
Name string: The name of the holiday.

customPeriods List<MachineLearningHolidayCustomPeriodArgs>: A list of custom periods for the holiday.
description String: A description of the holiday.
icalTimezone String: The timezone to use for events in the iCal file pointed to by ical_url.
icalUrl String: A URL to an iCal file containing all occurrences of the holiday.
name String: The name of the holiday.

customPeriods MachineLearningHolidayCustomPeriodArgs[]: A list of custom periods for the holiday.
description string: A description of the holiday.
icalTimezone string: The timezone to use for events in the iCal file pointed to by ical_url.
icalUrl string: A URL to an iCal file containing all occurrences of the holiday.
name string: The name of the holiday.

custom_periods Sequence[MachineLearningHolidayCustomPeriodArgs]: A list of custom periods for the holiday.
description str: A description of the holiday.
ical_timezone str: The timezone to use for events in the iCal file pointed to by ical_url.
ical_url str: A URL to an iCal file containing all occurrences of the holiday.
name str: The name of the holiday.

customPeriods List<Property Map>: A list of custom periods for the holiday.
description String: A description of the holiday.
icalTimezone String: The timezone to use for events in the iCal file pointed to by ical_url.
icalUrl String: A URL to an iCal file containing all occurrences of the holiday.
name String: The name of the holiday.

Outputs

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

Get an existing MachineLearningHoliday 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?: MachineLearningHolidayState, opts?: CustomResourceOptions): MachineLearningHoliday

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        custom_periods: Optional[Sequence[MachineLearningHolidayCustomPeriodArgs]] = None,
        description: Optional[str] = None,
        ical_timezone: Optional[str] = None,
        ical_url: Optional[str] = None,
        name: Optional[str] = None) -> MachineLearningHoliday

func GetMachineLearningHoliday(ctx *Context, name string, id IDInput, state *MachineLearningHolidayState, opts ...ResourceOption) (*MachineLearningHoliday, error)

public static MachineLearningHoliday Get(string name, Input<string> id, MachineLearningHolidayState? state, CustomResourceOptions? opts = null)

public static MachineLearningHoliday get(String name, Output<String> id, MachineLearningHolidayState 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.

The following state arguments are supported:

CustomPeriods List<Lbrlabs.PulumiPackage.Grafana.Inputs.MachineLearningHolidayCustomPeriodArgs>: A list of custom periods for the holiday.
Description string: A description of the holiday.
IcalTimezone string: The timezone to use for events in the iCal file pointed to by ical_url.
IcalUrl string: A URL to an iCal file containing all occurrences of the holiday.
Name string: The name of the holiday.

CustomPeriods []MachineLearningHolidayCustomPeriodArgs: A list of custom periods for the holiday.
Description string: A description of the holiday.
IcalTimezone string: The timezone to use for events in the iCal file pointed to by ical_url.
IcalUrl string: A URL to an iCal file containing all occurrences of the holiday.
Name string: The name of the holiday.

customPeriods List<MachineLearningHolidayCustomPeriodArgs>: A list of custom periods for the holiday.
description String: A description of the holiday.
icalTimezone String: The timezone to use for events in the iCal file pointed to by ical_url.
icalUrl String: A URL to an iCal file containing all occurrences of the holiday.
name String: The name of the holiday.

customPeriods MachineLearningHolidayCustomPeriodArgs[]: A list of custom periods for the holiday.
description string: A description of the holiday.
icalTimezone string: The timezone to use for events in the iCal file pointed to by ical_url.
icalUrl string: A URL to an iCal file containing all occurrences of the holiday.
name string: The name of the holiday.

custom_periods Sequence[MachineLearningHolidayCustomPeriodArgs]: A list of custom periods for the holiday.
description str: A description of the holiday.
ical_timezone str: The timezone to use for events in the iCal file pointed to by ical_url.
ical_url str: A URL to an iCal file containing all occurrences of the holiday.
name str: The name of the holiday.

customPeriods List<Property Map>: A list of custom periods for the holiday.
description String: A description of the holiday.
icalTimezone String: The timezone to use for events in the iCal file pointed to by ical_url.
icalUrl String: A URL to an iCal file containing all occurrences of the holiday.
name String: The name of the holiday.

Supporting Types

MachineLearningHolidayCustomPeriod

EndTime string
StartTime string
Name string: The name of the custom period.

EndTime string
StartTime string
Name string: The name of the custom period.

endTime String
startTime String
name String: The name of the custom period.

endTime string
startTime string
name string: The name of the custom period.

end_time str
start_time str
name str: The name of the custom period.

endTime String
startTime String
name String: The name of the custom period.

Package Details

Repository: grafana lbrlabs/pulumi-grafana
License: Apache-2.0
Notes: This Pulumi package is based on the grafana Terraform Provider.