Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Snowflake Provider
  3. API Docs
  4. ResourceMonitor
Snowflake v0.61.1 published on Thursday, Nov 14, 2024 by Pulumi
pulumi/pulumi-snowflake

snowflake.ResourceMonitor

Explore with Pulumi AI

snowflake logo
Snowflake v0.61.1 published on Thursday, Nov 14, 2024 by Pulumi
pulumi/pulumi-snowflake

    Import

    format is the resource monitor name

    $ pulumi import snowflake:index/resourceMonitor:ResourceMonitor example 'resourceMonitorName'

    Create ResourceMonitor Resource

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

    Constructor syntax

    new ResourceMonitor(name: string, args?: ResourceMonitorArgs, opts?: CustomResourceOptions);
    @overload
def ResourceMonitor(resource_name: str,
                    args: Optional[ResourceMonitorArgs] = None,
                    opts: Optional[ResourceOptions] = None)

@overload
def ResourceMonitor(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    credit_quota: Optional[int] = None,
                    end_timestamp: Optional[str] = None,
                    frequency: Optional[str] = None,
                    name: Optional[str] = None,
                    notify_triggers: Optional[Sequence[int]] = None,
                    notify_users: Optional[Sequence[str]] = None,
                    start_timestamp: Optional[str] = None,
                    suspend_immediate_trigger: Optional[int] = None,
                    suspend_trigger: Optional[int] = None)
    func NewResourceMonitor(ctx *Context, name string, args *ResourceMonitorArgs, opts ...ResourceOption) (*ResourceMonitor, error)
    public ResourceMonitor(string name, ResourceMonitorArgs? args = null, CustomResourceOptions? opts = null)
    public ResourceMonitor(String name, ResourceMonitorArgs args)
public ResourceMonitor(String name, ResourceMonitorArgs args, CustomResourceOptions options)

    type: snowflake:ResourceMonitor
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 ResourceMonitorArgs
    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 ResourceMonitorArgs
    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 ResourceMonitorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ResourceMonitorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ResourceMonitorArgs
    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 resourceMonitorResource = new Snowflake.ResourceMonitor("resourceMonitorResource", new()
{
    CreditQuota = 0,
    EndTimestamp = "string",
    Frequency = "string",
    Name = "string",
    NotifyTriggers = new[]
    {
        0,
    },
    NotifyUsers = new[]
    {
        "string",
    },
    StartTimestamp = "string",
    SuspendImmediateTrigger = 0,
    SuspendTrigger = 0,
});

    example, err := snowflake.NewResourceMonitor(ctx, "resourceMonitorResource", &snowflake.ResourceMonitorArgs{
	CreditQuota:  pulumi.Int(0),
	EndTimestamp: pulumi.String("string"),
	Frequency:    pulumi.String("string"),
	Name:         pulumi.String("string"),
	NotifyTriggers: pulumi.IntArray{
		pulumi.Int(0),
	},
	NotifyUsers: pulumi.StringArray{
		pulumi.String("string"),
	},
	StartTimestamp:          pulumi.String("string"),
	SuspendImmediateTrigger: pulumi.Int(0),
	SuspendTrigger:          pulumi.Int(0),
})

    var resourceMonitorResource = new ResourceMonitor("resourceMonitorResource", ResourceMonitorArgs.builder()
    .creditQuota(0)
    .endTimestamp("string")
    .frequency("string")
    .name("string")
    .notifyTriggers(0)
    .notifyUsers("string")
    .startTimestamp("string")
    .suspendImmediateTrigger(0)
    .suspendTrigger(0)
    .build());

    resource_monitor_resource = snowflake.ResourceMonitor("resourceMonitorResource",
    credit_quota=0,
    end_timestamp="string",
    frequency="string",
    name="string",
    notify_triggers=[0],
    notify_users=["string"],
    start_timestamp="string",
    suspend_immediate_trigger=0,
    suspend_trigger=0)

    const resourceMonitorResource = new snowflake.ResourceMonitor("resourceMonitorResource", {
    creditQuota: 0,
    endTimestamp: "string",
    frequency: "string",
    name: "string",
    notifyTriggers: [0],
    notifyUsers: ["string"],
    startTimestamp: "string",
    suspendImmediateTrigger: 0,
    suspendTrigger: 0,
});

    type: snowflake:ResourceMonitor
properties:
    creditQuota: 0
    endTimestamp: string
    frequency: string
    name: string
    notifyTriggers:
        - 0
    notifyUsers:
        - string
    startTimestamp: string
    suspendImmediateTrigger: 0
    suspendTrigger: 0

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

    CreditQuota int
    The number of credits allocated to the resource monitor per frequency interval. When total usage for all warehouses assigned to the monitor reaches this number for the current frequency interval, the resource monitor is considered to be at 100% of quota.
    EndTimestamp string
    The date and time when the resource monitor suspends the assigned warehouses.
    Frequency string
    The frequency interval at which the credit usage resets to 0. Valid values are (case-insensitive): MONTHLY | DAILY | WEEKLY | YEARLY | NEVER. If you set a frequency for a resource monitor, you must also set start_timestamp. If you specify NEVER for the frequency, the credit usage for the warehouse does not reset. After removing this field from the config, the previously set value will be preserved on the Snowflake side, not the default value. That's due to Snowflake limitation and the lack of unset functionality for this parameter.
    Name string
    Identifier for the resource monitor; must be unique for your account. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    NotifyTriggers List<int>
    Specifies a list of percentages of the credit quota. After reaching any of the values the users passed in the notify_users field will be notified (to receive the notification they should have notifications enabled). Values over 100 are supported.
    NotifyUsers List<string>
    Specifies the list of users (their identifiers) to receive email notifications on resource monitors.
    StartTimestamp string
    The date and time when the resource monitor starts monitoring credit usage for the assigned warehouses. If you set a start_timestamp for a resource monitor, you must also set frequency. After removing this field from the config, the previously set value will be preserved on the Snowflake side, not the default value. That's due to Snowflake limitation and the lack of unset functionality for this parameter.
    SuspendImmediateTrigger int
    Represents a numeric value specified as a percentage of the credit quota. Values over 100 are supported. After reaching this value, all assigned warehouses immediately cancel any currently running queries or statements. In addition, this action sends a notification to all users who have enabled notifications for themselves.
    SuspendTrigger int
    Represents a numeric value specified as a percentage of the credit quota. Values over 100 are supported. After reaching this value, all assigned warehouses while allowing currently running queries to complete will be suspended. No new queries can be executed by the warehouses until the credit quota for the resource monitor is increased. In addition, this action sends a notification to all users who have enabled notifications for themselves.
    CreditQuota int
    The number of credits allocated to the resource monitor per frequency interval. When total usage for all warehouses assigned to the monitor reaches this number for the current frequency interval, the resource monitor is considered to be at 100% of quota.
    EndTimestamp string
    The date and time when the resource monitor suspends the assigned warehouses.
    Frequency string
    The frequency interval at which the credit usage resets to 0. Valid values are (case-insensitive): MONTHLY | DAILY | WEEKLY | YEARLY | NEVER. If you set a frequency for a resource monitor, you must also set start_timestamp. If you specify NEVER for the frequency, the credit usage for the warehouse does not reset. After removing this field from the config, the previously set value will be preserved on the Snowflake side, not the default value. That's due to Snowflake limitation and the lack of unset functionality for this parameter.
    Name string
    Identifier for the resource monitor; must be unique for your account. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    NotifyTriggers []int
    Specifies a list of percentages of the credit quota. After reaching any of the values the users passed in the notify_users field will be notified (to receive the notification they should have notifications enabled). Values over 100 are supported.
    NotifyUsers []string
    Specifies the list of users (their identifiers) to receive email notifications on resource monitors.
    StartTimestamp string
    The date and time when the resource monitor starts monitoring credit usage for the assigned warehouses. If you set a start_timestamp for a resource monitor, you must also set frequency. After removing this field from the config, the previously set value will be preserved on the Snowflake side, not the default value. That's due to Snowflake limitation and the lack of unset functionality for this parameter.
    SuspendImmediateTrigger int
    Represents a numeric value specified as a percentage of the credit quota. Values over 100 are supported. After reaching this value, all assigned warehouses immediately cancel any currently running queries or statements. In addition, this action sends a notification to all users who have enabled notifications for themselves.
    SuspendTrigger int
    Represents a numeric value specified as a percentage of the credit quota. Values over 100 are supported. After reaching this value, all assigned warehouses while allowing currently running queries to complete will be suspended. No new queries can be executed by the warehouses until the credit quota for the resource monitor is increased. In addition, this action sends a notification to all users who have enabled notifications for themselves.
    creditQuota Integer
    The number of credits allocated to the resource monitor per frequency interval. When total usage for all warehouses assigned to the monitor reaches this number for the current frequency interval, the resource monitor is considered to be at 100% of quota.
    endTimestamp String
    The date and time when the resource monitor suspends the assigned warehouses.
    frequency String
    The frequency interval at which the credit usage resets to 0. Valid values are (case-insensitive): MONTHLY | DAILY | WEEKLY | YEARLY | NEVER. If you set a frequency for a resource monitor, you must also set start_timestamp. If you specify NEVER for the frequency, the credit usage for the warehouse does not reset. After removing this field from the config, the previously set value will be preserved on the Snowflake side, not the default value. That's due to Snowflake limitation and the lack of unset functionality for this parameter.
    name String
    Identifier for the resource monitor; must be unique for your account. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    notifyTriggers List<Integer>
    Specifies a list of percentages of the credit quota. After reaching any of the values the users passed in the notify_users field will be notified (to receive the notification they should have notifications enabled). Values over 100 are supported.
    notifyUsers List<String>
    Specifies the list of users (their identifiers) to receive email notifications on resource monitors.
    startTimestamp String
    The date and time when the resource monitor starts monitoring credit usage for the assigned warehouses. If you set a start_timestamp for a resource monitor, you must also set frequency. After removing this field from the config, the previously set value will be preserved on the Snowflake side, not the default value. That's due to Snowflake limitation and the lack of unset functionality for this parameter.
    suspendImmediateTrigger Integer
    Represents a numeric value specified as a percentage of the credit quota. Values over 100 are supported. After reaching this value, all assigned warehouses immediately cancel any currently running queries or statements. In addition, this action sends a notification to all users who have enabled notifications for themselves.
    suspendTrigger Integer
    Represents a numeric value specified as a percentage of the credit quota. Values over 100 are supported. After reaching this value, all assigned warehouses while allowing currently running queries to complete will be suspended. No new queries can be executed by the warehouses until the credit quota for the resource monitor is increased. In addition, this action sends a notification to all users who have enabled notifications for themselves.
    creditQuota number
    The number of credits allocated to the resource monitor per frequency interval. When total usage for all warehouses assigned to the monitor reaches this number for the current frequency interval, the resource monitor is considered to be at 100% of quota.
    endTimestamp string
    The date and time when the resource monitor suspends the assigned warehouses.
    frequency string
    The frequency interval at which the credit usage resets to 0. Valid values are (case-insensitive): MONTHLY | DAILY | WEEKLY | YEARLY | NEVER. If you set a frequency for a resource monitor, you must also set start_timestamp. If you specify NEVER for the frequency, the credit usage for the warehouse does not reset. After removing this field from the config, the previously set value will be preserved on the Snowflake side, not the default value. That's due to Snowflake limitation and the lack of unset functionality for this parameter.
    name string
    Identifier for the resource monitor; must be unique for your account. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    notifyTriggers number[]
    Specifies a list of percentages of the credit quota. After reaching any of the values the users passed in the notify_users field will be notified (to receive the notification they should have notifications enabled). Values over 100 are supported.
    notifyUsers string[]
    Specifies the list of users (their identifiers) to receive email notifications on resource monitors.
    startTimestamp string
    The date and time when the resource monitor starts monitoring credit usage for the assigned warehouses. If you set a start_timestamp for a resource monitor, you must also set frequency. After removing this field from the config, the previously set value will be preserved on the Snowflake side, not the default value. That's due to Snowflake limitation and the lack of unset functionality for this parameter.
    suspendImmediateTrigger number
    Represents a numeric value specified as a percentage of the credit quota. Values over 100 are supported. After reaching this value, all assigned warehouses immediately cancel any currently running queries or statements. In addition, this action sends a notification to all users who have enabled notifications for themselves.
    suspendTrigger number
    Represents a numeric value specified as a percentage of the credit quota. Values over 100 are supported. After reaching this value, all assigned warehouses while allowing currently running queries to complete will be suspended. No new queries can be executed by the warehouses until the credit quota for the resource monitor is increased. In addition, this action sends a notification to all users who have enabled notifications for themselves.
    credit_quota int
    The number of credits allocated to the resource monitor per frequency interval. When total usage for all warehouses assigned to the monitor reaches this number for the current frequency interval, the resource monitor is considered to be at 100% of quota.
    end_timestamp str
    The date and time when the resource monitor suspends the assigned warehouses.
    frequency str
    The frequency interval at which the credit usage resets to 0. Valid values are (case-insensitive): MONTHLY | DAILY | WEEKLY | YEARLY | NEVER. If you set a frequency for a resource monitor, you must also set start_timestamp. If you specify NEVER for the frequency, the credit usage for the warehouse does not reset. After removing this field from the config, the previously set value will be preserved on the Snowflake side, not the default value. That's due to Snowflake limitation and the lack of unset functionality for this parameter.
    name str
    Identifier for the resource monitor; must be unique for your account. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    notify_triggers Sequence[int]
    Specifies a list of percentages of the credit quota. After reaching any of the values the users passed in the notify_users field will be notified (to receive the notification they should have notifications enabled). Values over 100 are supported.
    notify_users Sequence[str]
    Specifies the list of users (their identifiers) to receive email notifications on resource monitors.
    start_timestamp str
    The date and time when the resource monitor starts monitoring credit usage for the assigned warehouses. If you set a start_timestamp for a resource monitor, you must also set frequency. After removing this field from the config, the previously set value will be preserved on the Snowflake side, not the default value. That's due to Snowflake limitation and the lack of unset functionality for this parameter.
    suspend_immediate_trigger int
    Represents a numeric value specified as a percentage of the credit quota. Values over 100 are supported. After reaching this value, all assigned warehouses immediately cancel any currently running queries or statements. In addition, this action sends a notification to all users who have enabled notifications for themselves.
    suspend_trigger int
    Represents a numeric value specified as a percentage of the credit quota. Values over 100 are supported. After reaching this value, all assigned warehouses while allowing currently running queries to complete will be suspended. No new queries can be executed by the warehouses until the credit quota for the resource monitor is increased. In addition, this action sends a notification to all users who have enabled notifications for themselves.
    creditQuota Number
    The number of credits allocated to the resource monitor per frequency interval. When total usage for all warehouses assigned to the monitor reaches this number for the current frequency interval, the resource monitor is considered to be at 100% of quota.
    endTimestamp String
    The date and time when the resource monitor suspends the assigned warehouses.
    frequency String
    The frequency interval at which the credit usage resets to 0. Valid values are (case-insensitive): MONTHLY | DAILY | WEEKLY | YEARLY | NEVER. If you set a frequency for a resource monitor, you must also set start_timestamp. If you specify NEVER for the frequency, the credit usage for the warehouse does not reset. After removing this field from the config, the previously set value will be preserved on the Snowflake side, not the default value. That's due to Snowflake limitation and the lack of unset functionality for this parameter.
    name String
    Identifier for the resource monitor; must be unique for your account. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    notifyTriggers List<Number>
    Specifies a list of percentages of the credit quota. After reaching any of the values the users passed in the notify_users field will be notified (to receive the notification they should have notifications enabled). Values over 100 are supported.
    notifyUsers List<String>
    Specifies the list of users (their identifiers) to receive email notifications on resource monitors.
    startTimestamp String
    The date and time when the resource monitor starts monitoring credit usage for the assigned warehouses. If you set a start_timestamp for a resource monitor, you must also set frequency. After removing this field from the config, the previously set value will be preserved on the Snowflake side, not the default value. That's due to Snowflake limitation and the lack of unset functionality for this parameter.
    suspendImmediateTrigger Number
    Represents a numeric value specified as a percentage of the credit quota. Values over 100 are supported. After reaching this value, all assigned warehouses immediately cancel any currently running queries or statements. In addition, this action sends a notification to all users who have enabled notifications for themselves.
    suspendTrigger Number
    Represents a numeric value specified as a percentage of the credit quota. Values over 100 are supported. After reaching this value, all assigned warehouses while allowing currently running queries to complete will be suspended. No new queries can be executed by the warehouses until the credit quota for the resource monitor is increased. In addition, this action sends a notification to all users who have enabled notifications for themselves.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ResourceMonitor resource produces the following output properties:

    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    Id string
    The provider-assigned unique ID for this managed resource.
    ShowOutputs List<ResourceMonitorShowOutput>
    Outputs the result of SHOW RESOURCE MONITORS for the given resource monitor.
    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    Id string
    The provider-assigned unique ID for this managed resource.
    ShowOutputs []ResourceMonitorShowOutput
    Outputs the result of SHOW RESOURCE MONITORS for the given resource monitor.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    id String
    The provider-assigned unique ID for this managed resource.
    showOutputs List<ResourceMonitorShowOutput>
    Outputs the result of SHOW RESOURCE MONITORS for the given resource monitor.
    fullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    id string
    The provider-assigned unique ID for this managed resource.
    showOutputs ResourceMonitorShowOutput[]
    Outputs the result of SHOW RESOURCE MONITORS for the given resource monitor.
    fully_qualified_name str
    Fully qualified name of the resource. For more information, see object name resolution.
    id str
    The provider-assigned unique ID for this managed resource.
    show_outputs Sequence[ResourceMonitorShowOutput]
    Outputs the result of SHOW RESOURCE MONITORS for the given resource monitor.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    id String
    The provider-assigned unique ID for this managed resource.
    showOutputs List<Property Map>
    Outputs the result of SHOW RESOURCE MONITORS for the given resource monitor.

    Look up Existing ResourceMonitor Resource

    Get an existing ResourceMonitor 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?: ResourceMonitorState, opts?: CustomResourceOptions): ResourceMonitor
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        credit_quota: Optional[int] = None,
        end_timestamp: Optional[str] = None,
        frequency: Optional[str] = None,
        fully_qualified_name: Optional[str] = None,
        name: Optional[str] = None,
        notify_triggers: Optional[Sequence[int]] = None,
        notify_users: Optional[Sequence[str]] = None,
        show_outputs: Optional[Sequence[ResourceMonitorShowOutputArgs]] = None,
        start_timestamp: Optional[str] = None,
        suspend_immediate_trigger: Optional[int] = None,
        suspend_trigger: Optional[int] = None) -> ResourceMonitor
    func GetResourceMonitor(ctx *Context, name string, id IDInput, state *ResourceMonitorState, opts ...ResourceOption) (*ResourceMonitor, error)
    public static ResourceMonitor Get(string name, Input<string> id, ResourceMonitorState? state, CustomResourceOptions? opts = null)
    public static ResourceMonitor get(String name, Output<String> id, ResourceMonitorState 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:
    CreditQuota int
    The number of credits allocated to the resource monitor per frequency interval. When total usage for all warehouses assigned to the monitor reaches this number for the current frequency interval, the resource monitor is considered to be at 100% of quota.
    EndTimestamp string
    The date and time when the resource monitor suspends the assigned warehouses.
    Frequency string
    The frequency interval at which the credit usage resets to 0. Valid values are (case-insensitive): MONTHLY | DAILY | WEEKLY | YEARLY | NEVER. If you set a frequency for a resource monitor, you must also set start_timestamp. If you specify NEVER for the frequency, the credit usage for the warehouse does not reset. After removing this field from the config, the previously set value will be preserved on the Snowflake side, not the default value. That's due to Snowflake limitation and the lack of unset functionality for this parameter.
    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    Name string
    Identifier for the resource monitor; must be unique for your account. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    NotifyTriggers List<int>
    Specifies a list of percentages of the credit quota. After reaching any of the values the users passed in the notify_users field will be notified (to receive the notification they should have notifications enabled). Values over 100 are supported.
    NotifyUsers List<string>
    Specifies the list of users (their identifiers) to receive email notifications on resource monitors.
    ShowOutputs List<ResourceMonitorShowOutput>
    Outputs the result of SHOW RESOURCE MONITORS for the given resource monitor.
    StartTimestamp string
    The date and time when the resource monitor starts monitoring credit usage for the assigned warehouses. If you set a start_timestamp for a resource monitor, you must also set frequency. After removing this field from the config, the previously set value will be preserved on the Snowflake side, not the default value. That's due to Snowflake limitation and the lack of unset functionality for this parameter.
    SuspendImmediateTrigger int
    Represents a numeric value specified as a percentage of the credit quota. Values over 100 are supported. After reaching this value, all assigned warehouses immediately cancel any currently running queries or statements. In addition, this action sends a notification to all users who have enabled notifications for themselves.
    SuspendTrigger int
    Represents a numeric value specified as a percentage of the credit quota. Values over 100 are supported. After reaching this value, all assigned warehouses while allowing currently running queries to complete will be suspended. No new queries can be executed by the warehouses until the credit quota for the resource monitor is increased. In addition, this action sends a notification to all users who have enabled notifications for themselves.
    CreditQuota int
    The number of credits allocated to the resource monitor per frequency interval. When total usage for all warehouses assigned to the monitor reaches this number for the current frequency interval, the resource monitor is considered to be at 100% of quota.
    EndTimestamp string
    The date and time when the resource monitor suspends the assigned warehouses.
    Frequency string
    The frequency interval at which the credit usage resets to 0. Valid values are (case-insensitive): MONTHLY | DAILY | WEEKLY | YEARLY | NEVER. If you set a frequency for a resource monitor, you must also set start_timestamp. If you specify NEVER for the frequency, the credit usage for the warehouse does not reset. After removing this field from the config, the previously set value will be preserved on the Snowflake side, not the default value. That's due to Snowflake limitation and the lack of unset functionality for this parameter.
    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    Name string
    Identifier for the resource monitor; must be unique for your account. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    NotifyTriggers []int
    Specifies a list of percentages of the credit quota. After reaching any of the values the users passed in the notify_users field will be notified (to receive the notification they should have notifications enabled). Values over 100 are supported.
    NotifyUsers []string
    Specifies the list of users (their identifiers) to receive email notifications on resource monitors.
    ShowOutputs []ResourceMonitorShowOutputArgs
    Outputs the result of SHOW RESOURCE MONITORS for the given resource monitor.
    StartTimestamp string
    The date and time when the resource monitor starts monitoring credit usage for the assigned warehouses. If you set a start_timestamp for a resource monitor, you must also set frequency. After removing this field from the config, the previously set value will be preserved on the Snowflake side, not the default value. That's due to Snowflake limitation and the lack of unset functionality for this parameter.
    SuspendImmediateTrigger int
    Represents a numeric value specified as a percentage of the credit quota. Values over 100 are supported. After reaching this value, all assigned warehouses immediately cancel any currently running queries or statements. In addition, this action sends a notification to all users who have enabled notifications for themselves.
    SuspendTrigger int
    Represents a numeric value specified as a percentage of the credit quota. Values over 100 are supported. After reaching this value, all assigned warehouses while allowing currently running queries to complete will be suspended. No new queries can be executed by the warehouses until the credit quota for the resource monitor is increased. In addition, this action sends a notification to all users who have enabled notifications for themselves.
    creditQuota Integer
    The number of credits allocated to the resource monitor per frequency interval. When total usage for all warehouses assigned to the monitor reaches this number for the current frequency interval, the resource monitor is considered to be at 100% of quota.
    endTimestamp String
    The date and time when the resource monitor suspends the assigned warehouses.
    frequency String
    The frequency interval at which the credit usage resets to 0. Valid values are (case-insensitive): MONTHLY | DAILY | WEEKLY | YEARLY | NEVER. If you set a frequency for a resource monitor, you must also set start_timestamp. If you specify NEVER for the frequency, the credit usage for the warehouse does not reset. After removing this field from the config, the previously set value will be preserved on the Snowflake side, not the default value. That's due to Snowflake limitation and the lack of unset functionality for this parameter.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    name String
    Identifier for the resource monitor; must be unique for your account. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    notifyTriggers List<Integer>
    Specifies a list of percentages of the credit quota. After reaching any of the values the users passed in the notify_users field will be notified (to receive the notification they should have notifications enabled). Values over 100 are supported.
    notifyUsers List<String>
    Specifies the list of users (their identifiers) to receive email notifications on resource monitors.
    showOutputs List<ResourceMonitorShowOutput>
    Outputs the result of SHOW RESOURCE MONITORS for the given resource monitor.
    startTimestamp String
    The date and time when the resource monitor starts monitoring credit usage for the assigned warehouses. If you set a start_timestamp for a resource monitor, you must also set frequency. After removing this field from the config, the previously set value will be preserved on the Snowflake side, not the default value. That's due to Snowflake limitation and the lack of unset functionality for this parameter.
    suspendImmediateTrigger Integer
    Represents a numeric value specified as a percentage of the credit quota. Values over 100 are supported. After reaching this value, all assigned warehouses immediately cancel any currently running queries or statements. In addition, this action sends a notification to all users who have enabled notifications for themselves.
    suspendTrigger Integer
    Represents a numeric value specified as a percentage of the credit quota. Values over 100 are supported. After reaching this value, all assigned warehouses while allowing currently running queries to complete will be suspended. No new queries can be executed by the warehouses until the credit quota for the resource monitor is increased. In addition, this action sends a notification to all users who have enabled notifications for themselves.
    creditQuota number
    The number of credits allocated to the resource monitor per frequency interval. When total usage for all warehouses assigned to the monitor reaches this number for the current frequency interval, the resource monitor is considered to be at 100% of quota.
    endTimestamp string
    The date and time when the resource monitor suspends the assigned warehouses.
    frequency string
    The frequency interval at which the credit usage resets to 0. Valid values are (case-insensitive): MONTHLY | DAILY | WEEKLY | YEARLY | NEVER. If you set a frequency for a resource monitor, you must also set start_timestamp. If you specify NEVER for the frequency, the credit usage for the warehouse does not reset. After removing this field from the config, the previously set value will be preserved on the Snowflake side, not the default value. That's due to Snowflake limitation and the lack of unset functionality for this parameter.
    fullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    name string
    Identifier for the resource monitor; must be unique for your account. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    notifyTriggers number[]
    Specifies a list of percentages of the credit quota. After reaching any of the values the users passed in the notify_users field will be notified (to receive the notification they should have notifications enabled). Values over 100 are supported.
    notifyUsers string[]
    Specifies the list of users (their identifiers) to receive email notifications on resource monitors.
    showOutputs ResourceMonitorShowOutput[]
    Outputs the result of SHOW RESOURCE MONITORS for the given resource monitor.
    startTimestamp string
    The date and time when the resource monitor starts monitoring credit usage for the assigned warehouses. If you set a start_timestamp for a resource monitor, you must also set frequency. After removing this field from the config, the previously set value will be preserved on the Snowflake side, not the default value. That's due to Snowflake limitation and the lack of unset functionality for this parameter.
    suspendImmediateTrigger number
    Represents a numeric value specified as a percentage of the credit quota. Values over 100 are supported. After reaching this value, all assigned warehouses immediately cancel any currently running queries or statements. In addition, this action sends a notification to all users who have enabled notifications for themselves.
    suspendTrigger number
    Represents a numeric value specified as a percentage of the credit quota. Values over 100 are supported. After reaching this value, all assigned warehouses while allowing currently running queries to complete will be suspended. No new queries can be executed by the warehouses until the credit quota for the resource monitor is increased. In addition, this action sends a notification to all users who have enabled notifications for themselves.
    credit_quota int
    The number of credits allocated to the resource monitor per frequency interval. When total usage for all warehouses assigned to the monitor reaches this number for the current frequency interval, the resource monitor is considered to be at 100% of quota.
    end_timestamp str
    The date and time when the resource monitor suspends the assigned warehouses.
    frequency str
    The frequency interval at which the credit usage resets to 0. Valid values are (case-insensitive): MONTHLY | DAILY | WEEKLY | YEARLY | NEVER. If you set a frequency for a resource monitor, you must also set start_timestamp. If you specify NEVER for the frequency, the credit usage for the warehouse does not reset. After removing this field from the config, the previously set value will be preserved on the Snowflake side, not the default value. That's due to Snowflake limitation and the lack of unset functionality for this parameter.
    fully_qualified_name str
    Fully qualified name of the resource. For more information, see object name resolution.
    name str
    Identifier for the resource monitor; must be unique for your account. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    notify_triggers Sequence[int]
    Specifies a list of percentages of the credit quota. After reaching any of the values the users passed in the notify_users field will be notified (to receive the notification they should have notifications enabled). Values over 100 are supported.
    notify_users Sequence[str]
    Specifies the list of users (their identifiers) to receive email notifications on resource monitors.
    show_outputs Sequence[ResourceMonitorShowOutputArgs]
    Outputs the result of SHOW RESOURCE MONITORS for the given resource monitor.
    start_timestamp str
    The date and time when the resource monitor starts monitoring credit usage for the assigned warehouses. If you set a start_timestamp for a resource monitor, you must also set frequency. After removing this field from the config, the previously set value will be preserved on the Snowflake side, not the default value. That's due to Snowflake limitation and the lack of unset functionality for this parameter.
    suspend_immediate_trigger int
    Represents a numeric value specified as a percentage of the credit quota. Values over 100 are supported. After reaching this value, all assigned warehouses immediately cancel any currently running queries or statements. In addition, this action sends a notification to all users who have enabled notifications for themselves.
    suspend_trigger int
    Represents a numeric value specified as a percentage of the credit quota. Values over 100 are supported. After reaching this value, all assigned warehouses while allowing currently running queries to complete will be suspended. No new queries can be executed by the warehouses until the credit quota for the resource monitor is increased. In addition, this action sends a notification to all users who have enabled notifications for themselves.
    creditQuota Number
    The number of credits allocated to the resource monitor per frequency interval. When total usage for all warehouses assigned to the monitor reaches this number for the current frequency interval, the resource monitor is considered to be at 100% of quota.
    endTimestamp String
    The date and time when the resource monitor suspends the assigned warehouses.
    frequency String
    The frequency interval at which the credit usage resets to 0. Valid values are (case-insensitive): MONTHLY | DAILY | WEEKLY | YEARLY | NEVER. If you set a frequency for a resource monitor, you must also set start_timestamp. If you specify NEVER for the frequency, the credit usage for the warehouse does not reset. After removing this field from the config, the previously set value will be preserved on the Snowflake side, not the default value. That's due to Snowflake limitation and the lack of unset functionality for this parameter.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    name String
    Identifier for the resource monitor; must be unique for your account. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    notifyTriggers List<Number>
    Specifies a list of percentages of the credit quota. After reaching any of the values the users passed in the notify_users field will be notified (to receive the notification they should have notifications enabled). Values over 100 are supported.
    notifyUsers List<String>
    Specifies the list of users (their identifiers) to receive email notifications on resource monitors.
    showOutputs List<Property Map>
    Outputs the result of SHOW RESOURCE MONITORS for the given resource monitor.
    startTimestamp String
    The date and time when the resource monitor starts monitoring credit usage for the assigned warehouses. If you set a start_timestamp for a resource monitor, you must also set frequency. After removing this field from the config, the previously set value will be preserved on the Snowflake side, not the default value. That's due to Snowflake limitation and the lack of unset functionality for this parameter.
    suspendImmediateTrigger Number
    Represents a numeric value specified as a percentage of the credit quota. Values over 100 are supported. After reaching this value, all assigned warehouses immediately cancel any currently running queries or statements. In addition, this action sends a notification to all users who have enabled notifications for themselves.
    suspendTrigger Number
    Represents a numeric value specified as a percentage of the credit quota. Values over 100 are supported. After reaching this value, all assigned warehouses while allowing currently running queries to complete will be suspended. No new queries can be executed by the warehouses until the credit quota for the resource monitor is increased. In addition, this action sends a notification to all users who have enabled notifications for themselves.

    Supporting Types

    ResourceMonitorShowOutput, ResourceMonitorShowOutputArgs

    Comment string
    CreatedOn string
    CreditQuota double
    EndTime string
    Frequency string
    Level string
    Name string
    Owner string
    RemainingCredits double
    StartTime string
    SuspendAt int
    SuspendImmediateAt int
    UsedCredits double
    Comment string
    CreatedOn string
    CreditQuota float64
    EndTime string
    Frequency string
    Level string
    Name string
    Owner string
    RemainingCredits float64
    StartTime string
    SuspendAt int
    SuspendImmediateAt int
    UsedCredits float64
    comment String
    createdOn String
    creditQuota Double
    endTime String
    frequency String
    level String
    name String
    owner String
    remainingCredits Double
    startTime String
    suspendAt Integer
    suspendImmediateAt Integer
    usedCredits Double
    comment string
    createdOn string
    creditQuota number
    endTime string
    frequency string
    level string
    name string
    owner string
    remainingCredits number
    startTime string
    suspendAt number
    suspendImmediateAt number
    usedCredits number
    comment String
    createdOn String
    creditQuota Number
    endTime String
    frequency String
    level String
    name String
    owner String
    remainingCredits Number
    startTime String
    suspendAt Number
    suspendImmediateAt Number
    usedCredits Number

    Package Details

    Repository
    Snowflake pulumi/pulumi-snowflake
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the snowflake Terraform Provider.
    snowflake logo
    Snowflake v0.61.1 published on Thursday, Nov 14, 2024 by Pulumi
    pulumi/pulumi-snowflake