1. Packages
  2. Volcengine
  3. API Docs
  4. tls
  5. AlarmNotifyGroup
Volcengine v0.0.23 published on Wednesday, Jan 3, 2024 by Volcengine

volcengine.tls.AlarmNotifyGroup

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.23 published on Wednesday, Jan 3, 2024 by Volcengine

    Provides a resource to manage tls alarm notify group

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Volcengine = Volcengine.Pulumi.Volcengine;
    
    return await Deployment.RunAsync(() => 
    {
        var foo = new Volcengine.Tls.AlarmNotifyGroup("foo", new()
        {
            AlarmNotifyGroupName = "tf-test",
            IamProjectName = "yyy",
            NotifyTypes = new[]
            {
                "Trigger",
            },
            Receivers = new[]
            {
                new Volcengine.Tls.Inputs.AlarmNotifyGroupReceiverArgs
                {
                    EndTime = "23:59:59",
                    ReceiverChannels = new[]
                    {
                        "Email",
                        "Sms",
                    },
                    ReceiverNames = new[]
                    {
                        "vke-qs",
                    },
                    ReceiverType = "User",
                    StartTime = "23:00:00",
                },
            },
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/tls"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := tls.NewAlarmNotifyGroup(ctx, "foo", &tls.AlarmNotifyGroupArgs{
    			AlarmNotifyGroupName: pulumi.String("tf-test"),
    			IamProjectName:       pulumi.String("yyy"),
    			NotifyTypes: pulumi.StringArray{
    				pulumi.String("Trigger"),
    			},
    			Receivers: tls.AlarmNotifyGroupReceiverArray{
    				&tls.AlarmNotifyGroupReceiverArgs{
    					EndTime: pulumi.String("23:59:59"),
    					ReceiverChannels: pulumi.StringArray{
    						pulumi.String("Email"),
    						pulumi.String("Sms"),
    					},
    					ReceiverNames: pulumi.StringArray{
    						pulumi.String("vke-qs"),
    					},
    					ReceiverType: pulumi.String("User"),
    					StartTime:    pulumi.String("23:00:00"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.volcengine.tls.AlarmNotifyGroup;
    import com.pulumi.volcengine.tls.AlarmNotifyGroupArgs;
    import com.pulumi.volcengine.tls.inputs.AlarmNotifyGroupReceiverArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var foo = new AlarmNotifyGroup("foo", AlarmNotifyGroupArgs.builder()        
                .alarmNotifyGroupName("tf-test")
                .iamProjectName("yyy")
                .notifyTypes("Trigger")
                .receivers(AlarmNotifyGroupReceiverArgs.builder()
                    .endTime("23:59:59")
                    .receiverChannels(                
                        "Email",
                        "Sms")
                    .receiverNames("vke-qs")
                    .receiverType("User")
                    .startTime("23:00:00")
                    .build())
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_volcengine as volcengine
    
    foo = volcengine.tls.AlarmNotifyGroup("foo",
        alarm_notify_group_name="tf-test",
        iam_project_name="yyy",
        notify_types=["Trigger"],
        receivers=[volcengine.tls.AlarmNotifyGroupReceiverArgs(
            end_time="23:59:59",
            receiver_channels=[
                "Email",
                "Sms",
            ],
            receiver_names=["vke-qs"],
            receiver_type="User",
            start_time="23:00:00",
        )])
    
    import * as pulumi from "@pulumi/pulumi";
    import * as volcengine from "@volcengine/pulumi";
    
    const foo = new volcengine.tls.AlarmNotifyGroup("foo", {
        alarmNotifyGroupName: "tf-test",
        iamProjectName: "yyy",
        notifyTypes: ["Trigger"],
        receivers: [{
            endTime: "23:59:59",
            receiverChannels: [
                "Email",
                "Sms",
            ],
            receiverNames: ["vke-qs"],
            receiverType: "User",
            startTime: "23:00:00",
        }],
    });
    
    resources:
      foo:
        type: volcengine:tls:AlarmNotifyGroup
        properties:
          alarmNotifyGroupName: tf-test
          iamProjectName: yyy
          notifyTypes:
            - Trigger
          receivers:
            - endTime: 23:59:59
              receiverChannels:
                - Email
                - Sms
              receiverNames:
                - vke-qs
              receiverType: User
              startTime: 23:00:00
    

    Create AlarmNotifyGroup Resource

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

    Constructor syntax

    new AlarmNotifyGroup(name: string, args: AlarmNotifyGroupArgs, opts?: CustomResourceOptions);
    @overload
    def AlarmNotifyGroup(resource_name: str,
                         args: AlarmNotifyGroupArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def AlarmNotifyGroup(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         alarm_notify_group_name: Optional[str] = None,
                         notify_types: Optional[Sequence[str]] = None,
                         receivers: Optional[Sequence[AlarmNotifyGroupReceiverArgs]] = None,
                         iam_project_name: Optional[str] = None)
    func NewAlarmNotifyGroup(ctx *Context, name string, args AlarmNotifyGroupArgs, opts ...ResourceOption) (*AlarmNotifyGroup, error)
    public AlarmNotifyGroup(string name, AlarmNotifyGroupArgs args, CustomResourceOptions? opts = null)
    public AlarmNotifyGroup(String name, AlarmNotifyGroupArgs args)
    public AlarmNotifyGroup(String name, AlarmNotifyGroupArgs args, CustomResourceOptions options)
    
    type: volcengine:tls:AlarmNotifyGroup
    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 AlarmNotifyGroupArgs
    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 AlarmNotifyGroupArgs
    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 AlarmNotifyGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AlarmNotifyGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AlarmNotifyGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var alarmNotifyGroupResource = new Volcengine.Tls.AlarmNotifyGroup("alarmNotifyGroupResource", new()
    {
        AlarmNotifyGroupName = "string",
        NotifyTypes = new[]
        {
            "string",
        },
        Receivers = new[]
        {
            new Volcengine.Tls.Inputs.AlarmNotifyGroupReceiverArgs
            {
                EndTime = "string",
                ReceiverChannels = new[]
                {
                    "string",
                },
                ReceiverNames = new[]
                {
                    "string",
                },
                ReceiverType = "string",
                StartTime = "string",
            },
        },
        IamProjectName = "string",
    });
    
    example, err := tls.NewAlarmNotifyGroup(ctx, "alarmNotifyGroupResource", &tls.AlarmNotifyGroupArgs{
    	AlarmNotifyGroupName: pulumi.String("string"),
    	NotifyTypes: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Receivers: tls.AlarmNotifyGroupReceiverArray{
    		&tls.AlarmNotifyGroupReceiverArgs{
    			EndTime: pulumi.String("string"),
    			ReceiverChannels: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    			ReceiverNames: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    			ReceiverType: pulumi.String("string"),
    			StartTime:    pulumi.String("string"),
    		},
    	},
    	IamProjectName: pulumi.String("string"),
    })
    
    var alarmNotifyGroupResource = new AlarmNotifyGroup("alarmNotifyGroupResource", AlarmNotifyGroupArgs.builder()        
        .alarmNotifyGroupName("string")
        .notifyTypes("string")
        .receivers(AlarmNotifyGroupReceiverArgs.builder()
            .endTime("string")
            .receiverChannels("string")
            .receiverNames("string")
            .receiverType("string")
            .startTime("string")
            .build())
        .iamProjectName("string")
        .build());
    
    alarm_notify_group_resource = volcengine.tls.AlarmNotifyGroup("alarmNotifyGroupResource",
        alarm_notify_group_name="string",
        notify_types=["string"],
        receivers=[volcengine.tls.AlarmNotifyGroupReceiverArgs(
            end_time="string",
            receiver_channels=["string"],
            receiver_names=["string"],
            receiver_type="string",
            start_time="string",
        )],
        iam_project_name="string")
    
    const alarmNotifyGroupResource = new volcengine.tls.AlarmNotifyGroup("alarmNotifyGroupResource", {
        alarmNotifyGroupName: "string",
        notifyTypes: ["string"],
        receivers: [{
            endTime: "string",
            receiverChannels: ["string"],
            receiverNames: ["string"],
            receiverType: "string",
            startTime: "string",
        }],
        iamProjectName: "string",
    });
    
    type: volcengine:tls:AlarmNotifyGroup
    properties:
        alarmNotifyGroupName: string
        iamProjectName: string
        notifyTypes:
            - string
        receivers:
            - endTime: string
              receiverChannels:
                - string
              receiverNames:
                - string
              receiverType: string
              startTime: string
    

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

    AlarmNotifyGroupName string
    The name of the notify group.
    NotifyTypes List<string>
    The notify type. Trigger: Alarm Trigger Recovery: Alarm Recovery.
    Receivers List<Volcengine.AlarmNotifyGroupReceiver>
    List of IAM users to receive alerts.
    IamProjectName string
    The name of the iam project.
    AlarmNotifyGroupName string
    The name of the notify group.
    NotifyTypes []string
    The notify type. Trigger: Alarm Trigger Recovery: Alarm Recovery.
    Receivers []AlarmNotifyGroupReceiverArgs
    List of IAM users to receive alerts.
    IamProjectName string
    The name of the iam project.
    alarmNotifyGroupName String
    The name of the notify group.
    notifyTypes List<String>
    The notify type. Trigger: Alarm Trigger Recovery: Alarm Recovery.
    receivers List<AlarmNotifyGroupReceiver>
    List of IAM users to receive alerts.
    iamProjectName String
    The name of the iam project.
    alarmNotifyGroupName string
    The name of the notify group.
    notifyTypes string[]
    The notify type. Trigger: Alarm Trigger Recovery: Alarm Recovery.
    receivers AlarmNotifyGroupReceiver[]
    List of IAM users to receive alerts.
    iamProjectName string
    The name of the iam project.
    alarm_notify_group_name str
    The name of the notify group.
    notify_types Sequence[str]
    The notify type. Trigger: Alarm Trigger Recovery: Alarm Recovery.
    receivers Sequence[AlarmNotifyGroupReceiverArgs]
    List of IAM users to receive alerts.
    iam_project_name str
    The name of the iam project.
    alarmNotifyGroupName String
    The name of the notify group.
    notifyTypes List<String>
    The notify type. Trigger: Alarm Trigger Recovery: Alarm Recovery.
    receivers List<Property Map>
    List of IAM users to receive alerts.
    iamProjectName String
    The name of the iam project.

    Outputs

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

    AlarmNotifyGroupId string
    The alarm notification group id.
    Id string
    The provider-assigned unique ID for this managed resource.
    AlarmNotifyGroupId string
    The alarm notification group id.
    Id string
    The provider-assigned unique ID for this managed resource.
    alarmNotifyGroupId String
    The alarm notification group id.
    id String
    The provider-assigned unique ID for this managed resource.
    alarmNotifyGroupId string
    The alarm notification group id.
    id string
    The provider-assigned unique ID for this managed resource.
    alarm_notify_group_id str
    The alarm notification group id.
    id str
    The provider-assigned unique ID for this managed resource.
    alarmNotifyGroupId String
    The alarm notification group id.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing AlarmNotifyGroup Resource

    Get an existing AlarmNotifyGroup 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?: AlarmNotifyGroupState, opts?: CustomResourceOptions): AlarmNotifyGroup
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            alarm_notify_group_id: Optional[str] = None,
            alarm_notify_group_name: Optional[str] = None,
            iam_project_name: Optional[str] = None,
            notify_types: Optional[Sequence[str]] = None,
            receivers: Optional[Sequence[AlarmNotifyGroupReceiverArgs]] = None) -> AlarmNotifyGroup
    func GetAlarmNotifyGroup(ctx *Context, name string, id IDInput, state *AlarmNotifyGroupState, opts ...ResourceOption) (*AlarmNotifyGroup, error)
    public static AlarmNotifyGroup Get(string name, Input<string> id, AlarmNotifyGroupState? state, CustomResourceOptions? opts = null)
    public static AlarmNotifyGroup get(String name, Output<String> id, AlarmNotifyGroupState 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:
    AlarmNotifyGroupId string
    The alarm notification group id.
    AlarmNotifyGroupName string
    The name of the notify group.
    IamProjectName string
    The name of the iam project.
    NotifyTypes List<string>
    The notify type. Trigger: Alarm Trigger Recovery: Alarm Recovery.
    Receivers List<Volcengine.AlarmNotifyGroupReceiver>
    List of IAM users to receive alerts.
    AlarmNotifyGroupId string
    The alarm notification group id.
    AlarmNotifyGroupName string
    The name of the notify group.
    IamProjectName string
    The name of the iam project.
    NotifyTypes []string
    The notify type. Trigger: Alarm Trigger Recovery: Alarm Recovery.
    Receivers []AlarmNotifyGroupReceiverArgs
    List of IAM users to receive alerts.
    alarmNotifyGroupId String
    The alarm notification group id.
    alarmNotifyGroupName String
    The name of the notify group.
    iamProjectName String
    The name of the iam project.
    notifyTypes List<String>
    The notify type. Trigger: Alarm Trigger Recovery: Alarm Recovery.
    receivers List<AlarmNotifyGroupReceiver>
    List of IAM users to receive alerts.
    alarmNotifyGroupId string
    The alarm notification group id.
    alarmNotifyGroupName string
    The name of the notify group.
    iamProjectName string
    The name of the iam project.
    notifyTypes string[]
    The notify type. Trigger: Alarm Trigger Recovery: Alarm Recovery.
    receivers AlarmNotifyGroupReceiver[]
    List of IAM users to receive alerts.
    alarm_notify_group_id str
    The alarm notification group id.
    alarm_notify_group_name str
    The name of the notify group.
    iam_project_name str
    The name of the iam project.
    notify_types Sequence[str]
    The notify type. Trigger: Alarm Trigger Recovery: Alarm Recovery.
    receivers Sequence[AlarmNotifyGroupReceiverArgs]
    List of IAM users to receive alerts.
    alarmNotifyGroupId String
    The alarm notification group id.
    alarmNotifyGroupName String
    The name of the notify group.
    iamProjectName String
    The name of the iam project.
    notifyTypes List<String>
    The notify type. Trigger: Alarm Trigger Recovery: Alarm Recovery.
    receivers List<Property Map>
    List of IAM users to receive alerts.

    Supporting Types

    AlarmNotifyGroupReceiver, AlarmNotifyGroupReceiverArgs

    EndTime string
    The end time.
    ReceiverChannels List<string>
    The list of the receiver channels. Currently supported channels: Email, Sms, Phone.
    ReceiverNames List<string>
    List of the receiver names.
    ReceiverType string
    The receiver type, Can be set as: User(The id of user).
    StartTime string
    The start time.
    EndTime string
    The end time.
    ReceiverChannels []string
    The list of the receiver channels. Currently supported channels: Email, Sms, Phone.
    ReceiverNames []string
    List of the receiver names.
    ReceiverType string
    The receiver type, Can be set as: User(The id of user).
    StartTime string
    The start time.
    endTime String
    The end time.
    receiverChannels List<String>
    The list of the receiver channels. Currently supported channels: Email, Sms, Phone.
    receiverNames List<String>
    List of the receiver names.
    receiverType String
    The receiver type, Can be set as: User(The id of user).
    startTime String
    The start time.
    endTime string
    The end time.
    receiverChannels string[]
    The list of the receiver channels. Currently supported channels: Email, Sms, Phone.
    receiverNames string[]
    List of the receiver names.
    receiverType string
    The receiver type, Can be set as: User(The id of user).
    startTime string
    The start time.
    end_time str
    The end time.
    receiver_channels Sequence[str]
    The list of the receiver channels. Currently supported channels: Email, Sms, Phone.
    receiver_names Sequence[str]
    List of the receiver names.
    receiver_type str
    The receiver type, Can be set as: User(The id of user).
    start_time str
    The start time.
    endTime String
    The end time.
    receiverChannels List<String>
    The list of the receiver channels. Currently supported channels: Email, Sms, Phone.
    receiverNames List<String>
    List of the receiver names.
    receiverType String
    The receiver type, Can be set as: User(The id of user).
    startTime String
    The start time.

    Import

    tls alarm notify group can be imported using the id, e.g.

     $ pulumi import volcengine:tls/alarmNotifyGroup:AlarmNotifyGroup default fa************
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.23 published on Wednesday, Jan 3, 2024 by Volcengine