1. Packages
  2. Google Cloud Native
  3. API Docs
  4. monitoring
  5. monitoring/v3
  6. Snooze

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

google-native.monitoring/v3.Snooze

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

    Creates a Snooze that will prevent alerts, which match the provided criteria, from being opened. The Snooze applies for a specific time interval. Note - this resource’s API doesn’t support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.

    Create Snooze Resource

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

    Constructor syntax

    new Snooze(name: string, args: SnoozeArgs, opts?: CustomResourceOptions);
    @overload
    def Snooze(resource_name: str,
               args: SnoozeArgs,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def Snooze(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               criteria: Optional[CriteriaArgs] = None,
               display_name: Optional[str] = None,
               interval: Optional[TimeIntervalArgs] = None,
               name: Optional[str] = None,
               project: Optional[str] = None)
    func NewSnooze(ctx *Context, name string, args SnoozeArgs, opts ...ResourceOption) (*Snooze, error)
    public Snooze(string name, SnoozeArgs args, CustomResourceOptions? opts = null)
    public Snooze(String name, SnoozeArgs args)
    public Snooze(String name, SnoozeArgs args, CustomResourceOptions options)
    
    type: google-native:monitoring/v3:Snooze
    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 SnoozeArgs
    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 SnoozeArgs
    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 SnoozeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SnoozeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SnoozeArgs
    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 snoozeResource = new GoogleNative.Monitoring.V3.Snooze("snoozeResource", new()
    {
        Criteria = new GoogleNative.Monitoring.V3.Inputs.CriteriaArgs
        {
            Policies = new[]
            {
                "string",
            },
        },
        DisplayName = "string",
        Interval = new GoogleNative.Monitoring.V3.Inputs.TimeIntervalArgs
        {
            EndTime = "string",
            StartTime = "string",
        },
        Name = "string",
        Project = "string",
    });
    
    example, err := monitoringv3.NewSnooze(ctx, "snoozeResource", &monitoringv3.SnoozeArgs{
    	Criteria: &monitoring.CriteriaArgs{
    		Policies: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    	},
    	DisplayName: pulumi.String("string"),
    	Interval: &monitoring.TimeIntervalArgs{
    		EndTime:   pulumi.String("string"),
    		StartTime: pulumi.String("string"),
    	},
    	Name:    pulumi.String("string"),
    	Project: pulumi.String("string"),
    })
    
    var snoozeResource = new Snooze("snoozeResource", SnoozeArgs.builder()
        .criteria(CriteriaArgs.builder()
            .policies("string")
            .build())
        .displayName("string")
        .interval(TimeIntervalArgs.builder()
            .endTime("string")
            .startTime("string")
            .build())
        .name("string")
        .project("string")
        .build());
    
    snooze_resource = google_native.monitoring.v3.Snooze("snoozeResource",
        criteria={
            "policies": ["string"],
        },
        display_name="string",
        interval={
            "end_time": "string",
            "start_time": "string",
        },
        name="string",
        project="string")
    
    const snoozeResource = new google_native.monitoring.v3.Snooze("snoozeResource", {
        criteria: {
            policies: ["string"],
        },
        displayName: "string",
        interval: {
            endTime: "string",
            startTime: "string",
        },
        name: "string",
        project: "string",
    });
    
    type: google-native:monitoring/v3:Snooze
    properties:
        criteria:
            policies:
                - string
        displayName: string
        interval:
            endTime: string
            startTime: string
        name: string
        project: string
    

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

    Criteria Pulumi.GoogleNative.Monitoring.V3.Inputs.Criteria
    This defines the criteria for applying the Snooze. See Criteria for more information.
    DisplayName string
    A display name for the Snooze. This can be, at most, 512 unicode characters.
    Interval Pulumi.GoogleNative.Monitoring.V3.Inputs.TimeInterval
    The Snooze will be active from interval.start_time through interval.end_time. interval.start_time cannot be in the past. There is a 15 second clock skew to account for the time it takes for a request to reach the API from the UI.
    Name string
    The name of the Snooze. The format is: projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID] The ID of the Snooze will be generated by the system.
    Project string
    Criteria CriteriaArgs
    This defines the criteria for applying the Snooze. See Criteria for more information.
    DisplayName string
    A display name for the Snooze. This can be, at most, 512 unicode characters.
    Interval TimeIntervalArgs
    The Snooze will be active from interval.start_time through interval.end_time. interval.start_time cannot be in the past. There is a 15 second clock skew to account for the time it takes for a request to reach the API from the UI.
    Name string
    The name of the Snooze. The format is: projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID] The ID of the Snooze will be generated by the system.
    Project string
    criteria Criteria
    This defines the criteria for applying the Snooze. See Criteria for more information.
    displayName String
    A display name for the Snooze. This can be, at most, 512 unicode characters.
    interval TimeInterval
    The Snooze will be active from interval.start_time through interval.end_time. interval.start_time cannot be in the past. There is a 15 second clock skew to account for the time it takes for a request to reach the API from the UI.
    name String
    The name of the Snooze. The format is: projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID] The ID of the Snooze will be generated by the system.
    project String
    criteria Criteria
    This defines the criteria for applying the Snooze. See Criteria for more information.
    displayName string
    A display name for the Snooze. This can be, at most, 512 unicode characters.
    interval TimeInterval
    The Snooze will be active from interval.start_time through interval.end_time. interval.start_time cannot be in the past. There is a 15 second clock skew to account for the time it takes for a request to reach the API from the UI.
    name string
    The name of the Snooze. The format is: projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID] The ID of the Snooze will be generated by the system.
    project string
    criteria CriteriaArgs
    This defines the criteria for applying the Snooze. See Criteria for more information.
    display_name str
    A display name for the Snooze. This can be, at most, 512 unicode characters.
    interval TimeIntervalArgs
    The Snooze will be active from interval.start_time through interval.end_time. interval.start_time cannot be in the past. There is a 15 second clock skew to account for the time it takes for a request to reach the API from the UI.
    name str
    The name of the Snooze. The format is: projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID] The ID of the Snooze will be generated by the system.
    project str
    criteria Property Map
    This defines the criteria for applying the Snooze. See Criteria for more information.
    displayName String
    A display name for the Snooze. This can be, at most, 512 unicode characters.
    interval Property Map
    The Snooze will be active from interval.start_time through interval.end_time. interval.start_time cannot be in the past. There is a 15 second clock skew to account for the time it takes for a request to reach the API from the UI.
    name String
    The name of the Snooze. The format is: projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID] The ID of the Snooze will be generated by the system.
    project String

    Outputs

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

    Supporting Types

    Criteria, CriteriaArgs

    Policies List<string>
    The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation.
    Policies []string
    The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation.
    policies List<String>
    The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation.
    policies string[]
    The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation.
    policies Sequence[str]
    The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation.
    policies List<String>
    The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation.

    CriteriaResponse, CriteriaResponseArgs

    Policies List<string>
    The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation.
    Policies []string
    The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation.
    policies List<String>
    The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation.
    policies string[]
    The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation.
    policies Sequence[str]
    The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation.
    policies List<String>
    The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation.

    TimeInterval, TimeIntervalArgs

    EndTime string
    The end of the time interval.
    StartTime string
    Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.
    EndTime string
    The end of the time interval.
    StartTime string
    Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.
    endTime String
    The end of the time interval.
    startTime String
    Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.
    endTime string
    The end of the time interval.
    startTime string
    Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.
    end_time str
    The end of the time interval.
    start_time str
    Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.
    endTime String
    The end of the time interval.
    startTime String
    Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.

    TimeIntervalResponse, TimeIntervalResponseArgs

    EndTime string
    The end of the time interval.
    StartTime string
    Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.
    EndTime string
    The end of the time interval.
    StartTime string
    Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.
    endTime String
    The end of the time interval.
    startTime String
    Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.
    endTime string
    The end of the time interval.
    startTime string
    Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.
    end_time str
    The end of the time interval.
    start_time str
    Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.
    endTime String
    The end of the time interval.
    startTime String
    Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi