Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Statuscake
  3. API Docs
  4. SslCheck
Statuscake v1.0.2 published on Sunday, Oct 8, 2023 by Pulumiverse
pulumiverse/pulumi-statuscake

statuscake.SslCheck

Explore with Pulumi AI

statuscake logo
Statuscake v1.0.2 published on Sunday, Oct 8, 2023 by Pulumiverse
pulumiverse/pulumi-statuscake

    Create SslCheck Resource

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

    Constructor syntax

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

@overload
def SslCheck(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             alert_config: Optional[SslCheckAlertConfigArgs] = None,
             check_interval: Optional[int] = None,
             monitored_resource: Optional[SslCheckMonitoredResourceArgs] = None,
             contact_groups: Optional[Sequence[str]] = None,
             follow_redirects: Optional[bool] = None,
             paused: Optional[bool] = None,
             user_agent: Optional[str] = None)
    func NewSslCheck(ctx *Context, name string, args SslCheckArgs, opts ...ResourceOption) (*SslCheck, error)
    public SslCheck(string name, SslCheckArgs args, CustomResourceOptions? opts = null)
    public SslCheck(String name, SslCheckArgs args)
public SslCheck(String name, SslCheckArgs args, CustomResourceOptions options)

    type: statuscake:SslCheck
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 SslCheckArgs
    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 SslCheckArgs
    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 SslCheckArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SslCheckArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SslCheckArgs
    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 sslCheckResource = new Statuscake.SslCheck("sslCheckResource", new()
{
    AlertConfig = new Statuscake.Inputs.SslCheckAlertConfigArgs
    {
        AlertAts = new[]
        {
            0,
        },
        OnBroken = false,
        OnExpiry = false,
        OnMixed = false,
        OnReminder = false,
    },
    CheckInterval = 0,
    MonitoredResource = new Statuscake.Inputs.SslCheckMonitoredResourceArgs
    {
        Address = "string",
        Hostname = "string",
    },
    ContactGroups = new[]
    {
        "string",
    },
    FollowRedirects = false,
    Paused = false,
    UserAgent = "string",
});

    example, err := statuscake.NewSslCheck(ctx, "sslCheckResource", &statuscake.SslCheckArgs{
	AlertConfig: &statuscake.SslCheckAlertConfigArgs{
		AlertAts: pulumi.IntArray{
			pulumi.Int(0),
		},
		OnBroken:   pulumi.Bool(false),
		OnExpiry:   pulumi.Bool(false),
		OnMixed:    pulumi.Bool(false),
		OnReminder: pulumi.Bool(false),
	},
	CheckInterval: pulumi.Int(0),
	MonitoredResource: &statuscake.SslCheckMonitoredResourceArgs{
		Address:  pulumi.String("string"),
		Hostname: pulumi.String("string"),
	},
	ContactGroups: pulumi.StringArray{
		pulumi.String("string"),
	},
	FollowRedirects: pulumi.Bool(false),
	Paused:          pulumi.Bool(false),
	UserAgent:       pulumi.String("string"),
})

    var sslCheckResource = new SslCheck("sslCheckResource", SslCheckArgs.builder()
    .alertConfig(SslCheckAlertConfigArgs.builder()
        .alertAts(0)
        .onBroken(false)
        .onExpiry(false)
        .onMixed(false)
        .onReminder(false)
        .build())
    .checkInterval(0)
    .monitoredResource(SslCheckMonitoredResourceArgs.builder()
        .address("string")
        .hostname("string")
        .build())
    .contactGroups("string")
    .followRedirects(false)
    .paused(false)
    .userAgent("string")
    .build());

    ssl_check_resource = statuscake.SslCheck("sslCheckResource",
    alert_config={
        "alert_ats": [0],
        "on_broken": False,
        "on_expiry": False,
        "on_mixed": False,
        "on_reminder": False,
    },
    check_interval=0,
    monitored_resource={
        "address": "string",
        "hostname": "string",
    },
    contact_groups=["string"],
    follow_redirects=False,
    paused=False,
    user_agent="string")

    const sslCheckResource = new statuscake.SslCheck("sslCheckResource", {
    alertConfig: {
        alertAts: [0],
        onBroken: false,
        onExpiry: false,
        onMixed: false,
        onReminder: false,
    },
    checkInterval: 0,
    monitoredResource: {
        address: "string",
        hostname: "string",
    },
    contactGroups: ["string"],
    followRedirects: false,
    paused: false,
    userAgent: "string",
});

    type: statuscake:SslCheck
properties:
    alertConfig:
        alertAts:
            - 0
        onBroken: false
        onExpiry: false
        onMixed: false
        onReminder: false
    checkInterval: 0
    contactGroups:
        - string
    followRedirects: false
    monitoredResource:
        address: string
        hostname: string
    paused: false
    userAgent: string

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

    AlertConfig Pulumiverse.Statuscake.Inputs.SslCheckAlertConfig
    Alert configuration block
    CheckInterval int
    Number of seconds between checks
    MonitoredResource Pulumiverse.Statuscake.Inputs.SslCheckMonitoredResource
    Monitored resource configuration block. The describes server under test
    ContactGroups List<string>
    List of contact group IDs
    FollowRedirects bool
    Whether to follow redirects when testing. Disabled by default
    Paused bool
    Whether the check should be run
    UserAgent string
    Custom user agent string set when testing
    AlertConfig SslCheckAlertConfigArgs
    Alert configuration block
    CheckInterval int
    Number of seconds between checks
    MonitoredResource SslCheckMonitoredResourceArgs
    Monitored resource configuration block. The describes server under test
    ContactGroups []string
    List of contact group IDs
    FollowRedirects bool
    Whether to follow redirects when testing. Disabled by default
    Paused bool
    Whether the check should be run
    UserAgent string
    Custom user agent string set when testing
    alertConfig SslCheckAlertConfig
    Alert configuration block
    checkInterval Integer
    Number of seconds between checks
    monitoredResource SslCheckMonitoredResource
    Monitored resource configuration block. The describes server under test
    contactGroups List<String>
    List of contact group IDs
    followRedirects Boolean
    Whether to follow redirects when testing. Disabled by default
    paused Boolean
    Whether the check should be run
    userAgent String
    Custom user agent string set when testing
    alertConfig SslCheckAlertConfig
    Alert configuration block
    checkInterval number
    Number of seconds between checks
    monitoredResource SslCheckMonitoredResource
    Monitored resource configuration block. The describes server under test
    contactGroups string[]
    List of contact group IDs
    followRedirects boolean
    Whether to follow redirects when testing. Disabled by default
    paused boolean
    Whether the check should be run
    userAgent string
    Custom user agent string set when testing
    alert_config SslCheckAlertConfigArgs
    Alert configuration block
    check_interval int
    Number of seconds between checks
    monitored_resource SslCheckMonitoredResourceArgs
    Monitored resource configuration block. The describes server under test
    contact_groups Sequence[str]
    List of contact group IDs
    follow_redirects bool
    Whether to follow redirects when testing. Disabled by default
    paused bool
    Whether the check should be run
    user_agent str
    Custom user agent string set when testing
    alertConfig Property Map
    Alert configuration block
    checkInterval Number
    Number of seconds between checks
    monitoredResource Property Map
    Monitored resource configuration block. The describes server under test
    contactGroups List<String>
    List of contact group IDs
    followRedirects Boolean
    Whether to follow redirects when testing. Disabled by default
    paused Boolean
    Whether the check should be run
    userAgent String
    Custom user agent string set when testing

    Outputs

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

    Get an existing SslCheck 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?: SslCheckState, opts?: CustomResourceOptions): SslCheck
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        alert_config: Optional[SslCheckAlertConfigArgs] = None,
        check_interval: Optional[int] = None,
        contact_groups: Optional[Sequence[str]] = None,
        follow_redirects: Optional[bool] = None,
        monitored_resource: Optional[SslCheckMonitoredResourceArgs] = None,
        paused: Optional[bool] = None,
        user_agent: Optional[str] = None) -> SslCheck
    func GetSslCheck(ctx *Context, name string, id IDInput, state *SslCheckState, opts ...ResourceOption) (*SslCheck, error)
    public static SslCheck Get(string name, Input<string> id, SslCheckState? state, CustomResourceOptions? opts = null)
    public static SslCheck get(String name, Output<String> id, SslCheckState 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.SslCheckAlertConfig
    Alert configuration block
    CheckInterval int
    Number of seconds between checks
    ContactGroups List<string>
    List of contact group IDs
    FollowRedirects bool
    Whether to follow redirects when testing. Disabled by default
    MonitoredResource Pulumiverse.Statuscake.Inputs.SslCheckMonitoredResource
    Monitored resource configuration block. The describes server under test
    Paused bool
    Whether the check should be run
    UserAgent string
    Custom user agent string set when testing
    AlertConfig SslCheckAlertConfigArgs
    Alert configuration block
    CheckInterval int
    Number of seconds between checks
    ContactGroups []string
    List of contact group IDs
    FollowRedirects bool
    Whether to follow redirects when testing. Disabled by default
    MonitoredResource SslCheckMonitoredResourceArgs
    Monitored resource configuration block. The describes server under test
    Paused bool
    Whether the check should be run
    UserAgent string
    Custom user agent string set when testing
    alertConfig SslCheckAlertConfig
    Alert configuration block
    checkInterval Integer
    Number of seconds between checks
    contactGroups List<String>
    List of contact group IDs
    followRedirects Boolean
    Whether to follow redirects when testing. Disabled by default
    monitoredResource SslCheckMonitoredResource
    Monitored resource configuration block. The describes server under test
    paused Boolean
    Whether the check should be run
    userAgent String
    Custom user agent string set when testing
    alertConfig SslCheckAlertConfig
    Alert configuration block
    checkInterval number
    Number of seconds between checks
    contactGroups string[]
    List of contact group IDs
    followRedirects boolean
    Whether to follow redirects when testing. Disabled by default
    monitoredResource SslCheckMonitoredResource
    Monitored resource configuration block. The describes server under test
    paused boolean
    Whether the check should be run
    userAgent string
    Custom user agent string set when testing
    alert_config SslCheckAlertConfigArgs
    Alert configuration block
    check_interval int
    Number of seconds between checks
    contact_groups Sequence[str]
    List of contact group IDs
    follow_redirects bool
    Whether to follow redirects when testing. Disabled by default
    monitored_resource SslCheckMonitoredResourceArgs
    Monitored resource configuration block. The describes server under test
    paused bool
    Whether the check should be run
    user_agent str
    Custom user agent string set when testing
    alertConfig Property Map
    Alert configuration block
    checkInterval Number
    Number of seconds between checks
    contactGroups List<String>
    List of contact group IDs
    followRedirects Boolean
    Whether to follow redirects when testing. Disabled by default
    monitoredResource Property Map
    Monitored resource configuration block. The describes server under test
    paused Boolean
    Whether the check should be run
    userAgent String
    Custom user agent string set when testing

    Supporting Types

    SslCheckAlertConfig, SslCheckAlertConfigArgs

    AlertAts List<int>
    OnBroken bool
    OnExpiry bool
    OnMixed bool
    OnReminder bool
    alertAts List<Integer>
    onBroken Boolean
    onExpiry Boolean
    onMixed Boolean
    onReminder Boolean
    alertAts number[]
    onBroken boolean
    onExpiry boolean
    onMixed boolean
    onReminder boolean
    alert_ats Sequence[int]
    on_broken bool
    on_expiry bool
    on_mixed bool
    on_reminder bool
    alertAts List<Number>
    onBroken Boolean
    onExpiry Boolean
    onMixed Boolean
    onReminder Boolean

    SslCheckMonitoredResource, SslCheckMonitoredResourceArgs

    Address string
    Hostname string
    Address string
    Hostname string
    address String
    hostname String
    address string
    hostname string
    address String
    hostname 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
    pulumiverse/pulumi-statuscake