1. Packages
  2. Statuscake
  3. API Docs
  4. PagespeedCheck
Statuscake v1.0.2 published on Sunday, Oct 8, 2023 by Pulumiverse

statuscake.PagespeedCheck

Explore with Pulumi AI

statuscake logo
Statuscake v1.0.2 published on Sunday, Oct 8, 2023 by Pulumiverse

    Create PagespeedCheck Resource

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

    Constructor syntax

    new PagespeedCheck(name: string, args: PagespeedCheckArgs, opts?: CustomResourceOptions);
    @overload
    def PagespeedCheck(resource_name: str,
                       args: PagespeedCheckArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def PagespeedCheck(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       alert_config: Optional[PagespeedCheckAlertConfigArgs] = None,
                       check_interval: Optional[int] = None,
                       monitored_resource: Optional[PagespeedCheckMonitoredResourceArgs] = None,
                       region: Optional[str] = None,
                       contact_groups: Optional[Sequence[str]] = None,
                       name: Optional[str] = None,
                       paused: Optional[bool] = None)
    func NewPagespeedCheck(ctx *Context, name string, args PagespeedCheckArgs, opts ...ResourceOption) (*PagespeedCheck, error)
    public PagespeedCheck(string name, PagespeedCheckArgs args, CustomResourceOptions? opts = null)
    public PagespeedCheck(String name, PagespeedCheckArgs args)
    public PagespeedCheck(String name, PagespeedCheckArgs args, CustomResourceOptions options)
    
    type: statuscake:PagespeedCheck
    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 PagespeedCheckArgs
    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 PagespeedCheckArgs
    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 PagespeedCheckArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PagespeedCheckArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PagespeedCheckArgs
    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 pagespeedCheckResource = new Statuscake.PagespeedCheck("pagespeedCheckResource", new()
    {
        AlertConfig = new Statuscake.Inputs.PagespeedCheckAlertConfigArgs
        {
            AlertBigger = 0,
            AlertSlower = 0,
            AlertSmaller = 0,
        },
        CheckInterval = 0,
        MonitoredResource = new Statuscake.Inputs.PagespeedCheckMonitoredResourceArgs
        {
            Address = "string",
        },
        Region = "string",
        ContactGroups = new[]
        {
            "string",
        },
        Name = "string",
        Paused = false,
    });
    
    example, err := statuscake.NewPagespeedCheck(ctx, "pagespeedCheckResource", &statuscake.PagespeedCheckArgs{
    	AlertConfig: &statuscake.PagespeedCheckAlertConfigArgs{
    		AlertBigger:  pulumi.Int(0),
    		AlertSlower:  pulumi.Int(0),
    		AlertSmaller: pulumi.Int(0),
    	},
    	CheckInterval: pulumi.Int(0),
    	MonitoredResource: &statuscake.PagespeedCheckMonitoredResourceArgs{
    		Address: pulumi.String("string"),
    	},
    	Region: pulumi.String("string"),
    	ContactGroups: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Name:   pulumi.String("string"),
    	Paused: pulumi.Bool(false),
    })
    
    var pagespeedCheckResource = new PagespeedCheck("pagespeedCheckResource", PagespeedCheckArgs.builder()
        .alertConfig(PagespeedCheckAlertConfigArgs.builder()
            .alertBigger(0)
            .alertSlower(0)
            .alertSmaller(0)
            .build())
        .checkInterval(0)
        .monitoredResource(PagespeedCheckMonitoredResourceArgs.builder()
            .address("string")
            .build())
        .region("string")
        .contactGroups("string")
        .name("string")
        .paused(false)
        .build());
    
    pagespeed_check_resource = statuscake.PagespeedCheck("pagespeedCheckResource",
        alert_config={
            "alert_bigger": 0,
            "alert_slower": 0,
            "alert_smaller": 0,
        },
        check_interval=0,
        monitored_resource={
            "address": "string",
        },
        region="string",
        contact_groups=["string"],
        name="string",
        paused=False)
    
    const pagespeedCheckResource = new statuscake.PagespeedCheck("pagespeedCheckResource", {
        alertConfig: {
            alertBigger: 0,
            alertSlower: 0,
            alertSmaller: 0,
        },
        checkInterval: 0,
        monitoredResource: {
            address: "string",
        },
        region: "string",
        contactGroups: ["string"],
        name: "string",
        paused: false,
    });
    
    type: statuscake:PagespeedCheck
    properties:
        alertConfig:
            alertBigger: 0
            alertSlower: 0
            alertSmaller: 0
        checkInterval: 0
        contactGroups:
            - string
        monitoredResource:
            address: string
        name: string
        paused: false
        region: string
    

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

    AlertConfig Pulumiverse.Statuscake.Inputs.PagespeedCheckAlertConfig
    Alert configuration block. Omitting this block disabled all alerts
    CheckInterval int
    Number of seconds between checks
    MonitoredResource Pulumiverse.Statuscake.Inputs.PagespeedCheckMonitoredResource
    Monitored resource configuration block. The describes server under test
    Region string
    Region on which to run checks
    ContactGroups List<string>
    List of contact group IDs
    Name string
    Name of the check
    Paused bool
    Whether the check should be run
    AlertConfig PagespeedCheckAlertConfigArgs
    Alert configuration block. Omitting this block disabled all alerts
    CheckInterval int
    Number of seconds between checks
    MonitoredResource PagespeedCheckMonitoredResourceArgs
    Monitored resource configuration block. The describes server under test
    Region string
    Region on which to run checks
    ContactGroups []string
    List of contact group IDs
    Name string
    Name of the check
    Paused bool
    Whether the check should be run
    alertConfig PagespeedCheckAlertConfig
    Alert configuration block. Omitting this block disabled all alerts
    checkInterval Integer
    Number of seconds between checks
    monitoredResource PagespeedCheckMonitoredResource
    Monitored resource configuration block. The describes server under test
    region String
    Region on which to run checks
    contactGroups List<String>
    List of contact group IDs
    name String
    Name of the check
    paused Boolean
    Whether the check should be run
    alertConfig PagespeedCheckAlertConfig
    Alert configuration block. Omitting this block disabled all alerts
    checkInterval number
    Number of seconds between checks
    monitoredResource PagespeedCheckMonitoredResource
    Monitored resource configuration block. The describes server under test
    region string
    Region on which to run checks
    contactGroups string[]
    List of contact group IDs
    name string
    Name of the check
    paused boolean
    Whether the check should be run
    alert_config PagespeedCheckAlertConfigArgs
    Alert configuration block. Omitting this block disabled all alerts
    check_interval int
    Number of seconds between checks
    monitored_resource PagespeedCheckMonitoredResourceArgs
    Monitored resource configuration block. The describes server under test
    region str
    Region on which to run checks
    contact_groups Sequence[str]
    List of contact group IDs
    name str
    Name of the check
    paused bool
    Whether the check should be run
    alertConfig Property Map
    Alert configuration block. Omitting this block disabled all alerts
    checkInterval Number
    Number of seconds between checks
    monitoredResource Property Map
    Monitored resource configuration block. The describes server under test
    region String
    Region on which to run checks
    contactGroups List<String>
    List of contact group IDs
    name String
    Name of the check
    paused Boolean
    Whether the check should be run

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Location string
    Assigned monitoring location on which checks will be run
    Id string
    The provider-assigned unique ID for this managed resource.
    Location string
    Assigned monitoring location on which checks will be run
    id String
    The provider-assigned unique ID for this managed resource.
    location String
    Assigned monitoring location on which checks will be run
    id string
    The provider-assigned unique ID for this managed resource.
    location string
    Assigned monitoring location on which checks will be run
    id str
    The provider-assigned unique ID for this managed resource.
    location str
    Assigned monitoring location on which checks will be run
    id String
    The provider-assigned unique ID for this managed resource.
    location String
    Assigned monitoring location on which checks will be run

    Look up Existing PagespeedCheck Resource

    Get an existing PagespeedCheck 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?: PagespeedCheckState, opts?: CustomResourceOptions): PagespeedCheck
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            alert_config: Optional[PagespeedCheckAlertConfigArgs] = None,
            check_interval: Optional[int] = None,
            contact_groups: Optional[Sequence[str]] = None,
            location: Optional[str] = None,
            monitored_resource: Optional[PagespeedCheckMonitoredResourceArgs] = None,
            name: Optional[str] = None,
            paused: Optional[bool] = None,
            region: Optional[str] = None) -> PagespeedCheck
    func GetPagespeedCheck(ctx *Context, name string, id IDInput, state *PagespeedCheckState, opts ...ResourceOption) (*PagespeedCheck, error)
    public static PagespeedCheck Get(string name, Input<string> id, PagespeedCheckState? state, CustomResourceOptions? opts = null)
    public static PagespeedCheck get(String name, Output<String> id, PagespeedCheckState 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:
    AlertConfig Pulumiverse.Statuscake.Inputs.PagespeedCheckAlertConfig
    Alert configuration block. Omitting this block disabled all alerts
    CheckInterval int
    Number of seconds between checks
    ContactGroups List<string>
    List of contact group IDs
    Location string
    Assigned monitoring location on which checks will be run
    MonitoredResource Pulumiverse.Statuscake.Inputs.PagespeedCheckMonitoredResource
    Monitored resource configuration block. The describes server under test
    Name string
    Name of the check
    Paused bool
    Whether the check should be run
    Region string
    Region on which to run checks
    AlertConfig PagespeedCheckAlertConfigArgs
    Alert configuration block. Omitting this block disabled all alerts
    CheckInterval int
    Number of seconds between checks
    ContactGroups []string
    List of contact group IDs
    Location string
    Assigned monitoring location on which checks will be run
    MonitoredResource PagespeedCheckMonitoredResourceArgs
    Monitored resource configuration block. The describes server under test
    Name string
    Name of the check
    Paused bool
    Whether the check should be run
    Region string
    Region on which to run checks
    alertConfig PagespeedCheckAlertConfig
    Alert configuration block. Omitting this block disabled all alerts
    checkInterval Integer
    Number of seconds between checks
    contactGroups List<String>
    List of contact group IDs
    location String
    Assigned monitoring location on which checks will be run
    monitoredResource PagespeedCheckMonitoredResource
    Monitored resource configuration block. The describes server under test
    name String
    Name of the check
    paused Boolean
    Whether the check should be run
    region String
    Region on which to run checks
    alertConfig PagespeedCheckAlertConfig
    Alert configuration block. Omitting this block disabled all alerts
    checkInterval number
    Number of seconds between checks
    contactGroups string[]
    List of contact group IDs
    location string
    Assigned monitoring location on which checks will be run
    monitoredResource PagespeedCheckMonitoredResource
    Monitored resource configuration block. The describes server under test
    name string
    Name of the check
    paused boolean
    Whether the check should be run
    region string
    Region on which to run checks
    alert_config PagespeedCheckAlertConfigArgs
    Alert configuration block. Omitting this block disabled all alerts
    check_interval int
    Number of seconds between checks
    contact_groups Sequence[str]
    List of contact group IDs
    location str
    Assigned monitoring location on which checks will be run
    monitored_resource PagespeedCheckMonitoredResourceArgs
    Monitored resource configuration block. The describes server under test
    name str
    Name of the check
    paused bool
    Whether the check should be run
    region str
    Region on which to run checks
    alertConfig Property Map
    Alert configuration block. Omitting this block disabled all alerts
    checkInterval Number
    Number of seconds between checks
    contactGroups List<String>
    List of contact group IDs
    location String
    Assigned monitoring location on which checks will be run
    monitoredResource Property Map
    Monitored resource configuration block. The describes server under test
    name String
    Name of the check
    paused Boolean
    Whether the check should be run
    region String
    Region on which to run checks

    Supporting Types

    PagespeedCheckAlertConfig, PagespeedCheckAlertConfigArgs

    alertBigger Integer
    alertSlower Integer
    alertSmaller Integer

    PagespeedCheckMonitoredResource, PagespeedCheckMonitoredResourceArgs

    Address string
    Address string
    address String
    address string
    address String

    Package Details

    Repository
    statuscake pulumiverse/pulumi-statuscake
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the statuscake Terraform Provider.
    statuscake logo
    Statuscake v1.0.2 published on Sunday, Oct 8, 2023 by Pulumiverse