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

statuscake.ContactGroup

Explore with Pulumi AI

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

    Create ContactGroup Resource

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

    Constructor syntax

    new ContactGroup(name: string, args?: ContactGroupArgs, opts?: CustomResourceOptions);
    @overload
    def ContactGroup(resource_name: str,
                     args: Optional[ContactGroupArgs] = None,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def ContactGroup(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     email_addresses: Optional[Sequence[str]] = None,
                     integrations: Optional[Sequence[str]] = None,
                     mobile_numbers: Optional[Sequence[str]] = None,
                     name: Optional[str] = None,
                     ping_url: Optional[str] = None)
    func NewContactGroup(ctx *Context, name string, args *ContactGroupArgs, opts ...ResourceOption) (*ContactGroup, error)
    public ContactGroup(string name, ContactGroupArgs? args = null, CustomResourceOptions? opts = null)
    public ContactGroup(String name, ContactGroupArgs args)
    public ContactGroup(String name, ContactGroupArgs args, CustomResourceOptions options)
    
    type: statuscake:ContactGroup
    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 ContactGroupArgs
    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 ContactGroupArgs
    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 ContactGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ContactGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ContactGroupArgs
    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 contactGroupResource = new Statuscake.ContactGroup("contactGroupResource", new()
    {
        EmailAddresses = new[]
        {
            "string",
        },
        Integrations = new[]
        {
            "string",
        },
        MobileNumbers = new[]
        {
            "string",
        },
        Name = "string",
        PingUrl = "string",
    });
    
    example, err := statuscake.NewContactGroup(ctx, "contactGroupResource", &statuscake.ContactGroupArgs{
    	EmailAddresses: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Integrations: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	MobileNumbers: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Name:    pulumi.String("string"),
    	PingUrl: pulumi.String("string"),
    })
    
    var contactGroupResource = new ContactGroup("contactGroupResource", ContactGroupArgs.builder()
        .emailAddresses("string")
        .integrations("string")
        .mobileNumbers("string")
        .name("string")
        .pingUrl("string")
        .build());
    
    contact_group_resource = statuscake.ContactGroup("contactGroupResource",
        email_addresses=["string"],
        integrations=["string"],
        mobile_numbers=["string"],
        name="string",
        ping_url="string")
    
    const contactGroupResource = new statuscake.ContactGroup("contactGroupResource", {
        emailAddresses: ["string"],
        integrations: ["string"],
        mobileNumbers: ["string"],
        name: "string",
        pingUrl: "string",
    });
    
    type: statuscake:ContactGroup
    properties:
        emailAddresses:
            - string
        integrations:
            - string
        mobileNumbers:
            - string
        name: string
        pingUrl: string
    

    ContactGroup Resource Properties

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

    Inputs

    The ContactGroup resource accepts the following input properties:

    EmailAddresses List<string>
    List of email addresses
    Integrations List<string>
    List of integration IDs
    MobileNumbers List<string>
    List of international format mobile phone numbers
    Name string
    Name of the contact group
    PingUrl string
    URL or IP address of an endpoint to push uptime events. Currently this only supports HTTP GET endpoints
    EmailAddresses []string
    List of email addresses
    Integrations []string
    List of integration IDs
    MobileNumbers []string
    List of international format mobile phone numbers
    Name string
    Name of the contact group
    PingUrl string
    URL or IP address of an endpoint to push uptime events. Currently this only supports HTTP GET endpoints
    emailAddresses List<String>
    List of email addresses
    integrations List<String>
    List of integration IDs
    mobileNumbers List<String>
    List of international format mobile phone numbers
    name String
    Name of the contact group
    pingUrl String
    URL or IP address of an endpoint to push uptime events. Currently this only supports HTTP GET endpoints
    emailAddresses string[]
    List of email addresses
    integrations string[]
    List of integration IDs
    mobileNumbers string[]
    List of international format mobile phone numbers
    name string
    Name of the contact group
    pingUrl string
    URL or IP address of an endpoint to push uptime events. Currently this only supports HTTP GET endpoints
    email_addresses Sequence[str]
    List of email addresses
    integrations Sequence[str]
    List of integration IDs
    mobile_numbers Sequence[str]
    List of international format mobile phone numbers
    name str
    Name of the contact group
    ping_url str
    URL or IP address of an endpoint to push uptime events. Currently this only supports HTTP GET endpoints
    emailAddresses List<String>
    List of email addresses
    integrations List<String>
    List of integration IDs
    mobileNumbers List<String>
    List of international format mobile phone numbers
    name String
    Name of the contact group
    pingUrl String
    URL or IP address of an endpoint to push uptime events. Currently this only supports HTTP GET endpoints

    Outputs

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

    Get an existing ContactGroup 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?: ContactGroupState, opts?: CustomResourceOptions): ContactGroup
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            email_addresses: Optional[Sequence[str]] = None,
            integrations: Optional[Sequence[str]] = None,
            mobile_numbers: Optional[Sequence[str]] = None,
            name: Optional[str] = None,
            ping_url: Optional[str] = None) -> ContactGroup
    func GetContactGroup(ctx *Context, name string, id IDInput, state *ContactGroupState, opts ...ResourceOption) (*ContactGroup, error)
    public static ContactGroup Get(string name, Input<string> id, ContactGroupState? state, CustomResourceOptions? opts = null)
    public static ContactGroup get(String name, Output<String> id, ContactGroupState 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:
    EmailAddresses List<string>
    List of email addresses
    Integrations List<string>
    List of integration IDs
    MobileNumbers List<string>
    List of international format mobile phone numbers
    Name string
    Name of the contact group
    PingUrl string
    URL or IP address of an endpoint to push uptime events. Currently this only supports HTTP GET endpoints
    EmailAddresses []string
    List of email addresses
    Integrations []string
    List of integration IDs
    MobileNumbers []string
    List of international format mobile phone numbers
    Name string
    Name of the contact group
    PingUrl string
    URL or IP address of an endpoint to push uptime events. Currently this only supports HTTP GET endpoints
    emailAddresses List<String>
    List of email addresses
    integrations List<String>
    List of integration IDs
    mobileNumbers List<String>
    List of international format mobile phone numbers
    name String
    Name of the contact group
    pingUrl String
    URL or IP address of an endpoint to push uptime events. Currently this only supports HTTP GET endpoints
    emailAddresses string[]
    List of email addresses
    integrations string[]
    List of integration IDs
    mobileNumbers string[]
    List of international format mobile phone numbers
    name string
    Name of the contact group
    pingUrl string
    URL or IP address of an endpoint to push uptime events. Currently this only supports HTTP GET endpoints
    email_addresses Sequence[str]
    List of email addresses
    integrations Sequence[str]
    List of integration IDs
    mobile_numbers Sequence[str]
    List of international format mobile phone numbers
    name str
    Name of the contact group
    ping_url str
    URL or IP address of an endpoint to push uptime events. Currently this only supports HTTP GET endpoints
    emailAddresses List<String>
    List of email addresses
    integrations List<String>
    List of integration IDs
    mobileNumbers List<String>
    List of international format mobile phone numbers
    name String
    Name of the contact group
    pingUrl String
    URL or IP address of an endpoint to push uptime events. Currently this only supports HTTP GET endpoints

    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