Rancher2
ClusterAlterGroup
Deprecated:
rancher2.ClusterAlterGroup has been deprecated in favor of rancher2.ClusterAlertGroup
Provides a Rancher v2 Cluster Alert Group resource. This can be used to create Cluster Alert Group for Rancher v2 environments and retrieve their information.
Example Usage
using Pulumi;
using Rancher2 = Pulumi.Rancher2;
class MyStack : Stack
{
public MyStack()
{
// Create a new Rancher2 Cluster Alert Group
var foo = new Rancher2.ClusterAlertGroup("foo", new Rancher2.ClusterAlertGroupArgs
{
ClusterId = "<cluster_id>",
Description = "Terraform cluster alert group",
GroupIntervalSeconds = 300,
RepeatIntervalSeconds = 3600,
});
}
}
package main
import (
"github.com/pulumi/pulumi-rancher2/sdk/v3/go/rancher2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := rancher2.NewClusterAlertGroup(ctx, "foo", &rancher2.ClusterAlertGroupArgs{
ClusterId: pulumi.String("<cluster_id>"),
Description: pulumi.String("Terraform cluster alert group"),
GroupIntervalSeconds: pulumi.Int(300),
RepeatIntervalSeconds: pulumi.Int(3600),
})
if err != nil {
return err
}
return nil
})
}
Coming soon!
import pulumi
import pulumi_rancher2 as rancher2
# Create a new Rancher2 Cluster Alert Group
foo = rancher2.ClusterAlertGroup("foo",
cluster_id="<cluster_id>",
description="Terraform cluster alert group",
group_interval_seconds=300,
repeat_interval_seconds=3600)
import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";
// Create a new Rancher2 Cluster Alert Group
const foo = new rancher2.ClusterAlertGroup("foo", {
clusterId: "<cluster_id>",
description: "Terraform cluster alert group",
groupIntervalSeconds: 300,
repeatIntervalSeconds: 3600,
});
Coming soon!
Create a ClusterAlterGroup Resource
new ClusterAlterGroup(name: string, args: ClusterAlterGroupArgs, opts?: CustomResourceOptions);
@overload
def ClusterAlterGroup(resource_name: str,
opts: Optional[ResourceOptions] = None,
annotations: Optional[Mapping[str, Any]] = None,
cluster_id: Optional[str] = None,
description: Optional[str] = None,
group_interval_seconds: Optional[int] = None,
group_wait_seconds: Optional[int] = None,
labels: Optional[Mapping[str, Any]] = None,
name: Optional[str] = None,
recipients: Optional[Sequence[ClusterAlterGroupRecipientArgs]] = None,
repeat_interval_seconds: Optional[int] = None)
@overload
def ClusterAlterGroup(resource_name: str,
args: ClusterAlterGroupArgs,
opts: Optional[ResourceOptions] = None)
func NewClusterAlterGroup(ctx *Context, name string, args ClusterAlterGroupArgs, opts ...ResourceOption) (*ClusterAlterGroup, error)
public ClusterAlterGroup(string name, ClusterAlterGroupArgs args, CustomResourceOptions? opts = null)
public ClusterAlterGroup(String name, ClusterAlterGroupArgs args)
public ClusterAlterGroup(String name, ClusterAlterGroupArgs args, CustomResourceOptions options)
type: rancher2:ClusterAlterGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ClusterAlterGroupArgs
- 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 ClusterAlterGroupArgs
- 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 ClusterAlterGroupArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ClusterAlterGroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ClusterAlterGroupArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
ClusterAlterGroup 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 ClusterAlterGroup resource accepts the following input properties:
- Cluster
Id string The cluster id where create cluster alert group (string)
- Annotations Dictionary<string, object>
The cluster alert group annotations (map)
- Description string
The cluster alert group description (string)
- Group
Interval intSeconds The cluster alert group interval seconds. Default:
180
(int)- Group
Wait intSeconds The cluster alert group wait seconds. Default:
180
(int)- Labels Dictionary<string, object>
The cluster alert group labels (map)
- Name string
The cluster alert group name (string)
- Recipients
List<Cluster
Alter Group Recipient Args> The cluster alert group recipients (list)
- Repeat
Interval intSeconds The cluster alert group wait seconds. Default:
3600
(int)
- Cluster
Id string The cluster id where create cluster alert group (string)
- Annotations map[string]interface{}
The cluster alert group annotations (map)
- Description string
The cluster alert group description (string)
- Group
Interval intSeconds The cluster alert group interval seconds. Default:
180
(int)- Group
Wait intSeconds The cluster alert group wait seconds. Default:
180
(int)- Labels map[string]interface{}
The cluster alert group labels (map)
- Name string
The cluster alert group name (string)
- Recipients
[]Cluster
Alter Group Recipient Args The cluster alert group recipients (list)
- Repeat
Interval intSeconds The cluster alert group wait seconds. Default:
3600
(int)
- cluster
Id String The cluster id where create cluster alert group (string)
- annotations
Map
The cluster alert group annotations (map)
- description String
The cluster alert group description (string)
- group
Interval IntegerSeconds The cluster alert group interval seconds. Default:
180
(int)- group
Wait IntegerSeconds The cluster alert group wait seconds. Default:
180
(int)- labels
Map
The cluster alert group labels (map)
- name String
The cluster alert group name (string)
- recipients
List
Alter Group Recipient Args> The cluster alert group recipients (list)
- repeat
Interval IntegerSeconds The cluster alert group wait seconds. Default:
3600
(int)
- cluster
Id string The cluster id where create cluster alert group (string)
- annotations {[key: string]: any}
The cluster alert group annotations (map)
- description string
The cluster alert group description (string)
- group
Interval numberSeconds The cluster alert group interval seconds. Default:
180
(int)- group
Wait numberSeconds The cluster alert group wait seconds. Default:
180
(int)- labels {[key: string]: any}
The cluster alert group labels (map)
- name string
The cluster alert group name (string)
- recipients
Cluster
Alter Group Recipient Args[] The cluster alert group recipients (list)
- repeat
Interval numberSeconds The cluster alert group wait seconds. Default:
3600
(int)
- cluster_
id str The cluster id where create cluster alert group (string)
- annotations Mapping[str, Any]
The cluster alert group annotations (map)
- description str
The cluster alert group description (string)
- group_
interval_ intseconds The cluster alert group interval seconds. Default:
180
(int)- group_
wait_ intseconds The cluster alert group wait seconds. Default:
180
(int)- labels Mapping[str, Any]
The cluster alert group labels (map)
- name str
The cluster alert group name (string)
- recipients
Sequence[Cluster
Alter Group Recipient Args] The cluster alert group recipients (list)
- repeat_
interval_ intseconds The cluster alert group wait seconds. Default:
3600
(int)
- cluster
Id String The cluster id where create cluster alert group (string)
- annotations
Map
The cluster alert group annotations (map)
- description String
The cluster alert group description (string)
- group
Interval NumberSeconds The cluster alert group interval seconds. Default:
180
(int)- group
Wait NumberSeconds The cluster alert group wait seconds. Default:
180
(int)- labels
Map
The cluster alert group labels (map)
- name String
The cluster alert group name (string)
- recipients
List
The cluster alert group recipients (list)
- repeat
Interval NumberSeconds The cluster alert group wait seconds. Default:
3600
(int)
Outputs
All input properties are implicitly available as output properties. Additionally, the ClusterAlterGroup 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 an Existing ClusterAlterGroup Resource
Get an existing ClusterAlterGroup 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?: ClusterAlterGroupState, opts?: CustomResourceOptions): ClusterAlterGroup
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
annotations: Optional[Mapping[str, Any]] = None,
cluster_id: Optional[str] = None,
description: Optional[str] = None,
group_interval_seconds: Optional[int] = None,
group_wait_seconds: Optional[int] = None,
labels: Optional[Mapping[str, Any]] = None,
name: Optional[str] = None,
recipients: Optional[Sequence[ClusterAlterGroupRecipientArgs]] = None,
repeat_interval_seconds: Optional[int] = None) -> ClusterAlterGroup
func GetClusterAlterGroup(ctx *Context, name string, id IDInput, state *ClusterAlterGroupState, opts ...ResourceOption) (*ClusterAlterGroup, error)
public static ClusterAlterGroup Get(string name, Input<string> id, ClusterAlterGroupState? state, CustomResourceOptions? opts = null)
public static ClusterAlterGroup get(String name, Output<String> id, ClusterAlterGroupState 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.
- Annotations Dictionary<string, object>
The cluster alert group annotations (map)
- Cluster
Id string The cluster id where create cluster alert group (string)
- Description string
The cluster alert group description (string)
- Group
Interval intSeconds The cluster alert group interval seconds. Default:
180
(int)- Group
Wait intSeconds The cluster alert group wait seconds. Default:
180
(int)- Labels Dictionary<string, object>
The cluster alert group labels (map)
- Name string
The cluster alert group name (string)
- Recipients
List<Cluster
Alter Group Recipient Args> The cluster alert group recipients (list)
- Repeat
Interval intSeconds The cluster alert group wait seconds. Default:
3600
(int)
- Annotations map[string]interface{}
The cluster alert group annotations (map)
- Cluster
Id string The cluster id where create cluster alert group (string)
- Description string
The cluster alert group description (string)
- Group
Interval intSeconds The cluster alert group interval seconds. Default:
180
(int)- Group
Wait intSeconds The cluster alert group wait seconds. Default:
180
(int)- Labels map[string]interface{}
The cluster alert group labels (map)
- Name string
The cluster alert group name (string)
- Recipients
[]Cluster
Alter Group Recipient Args The cluster alert group recipients (list)
- Repeat
Interval intSeconds The cluster alert group wait seconds. Default:
3600
(int)
- annotations
Map
The cluster alert group annotations (map)
- cluster
Id String The cluster id where create cluster alert group (string)
- description String
The cluster alert group description (string)
- group
Interval IntegerSeconds The cluster alert group interval seconds. Default:
180
(int)- group
Wait IntegerSeconds The cluster alert group wait seconds. Default:
180
(int)- labels
Map
The cluster alert group labels (map)
- name String
The cluster alert group name (string)
- recipients
List
Alter Group Recipient Args> The cluster alert group recipients (list)
- repeat
Interval IntegerSeconds The cluster alert group wait seconds. Default:
3600
(int)
- annotations {[key: string]: any}
The cluster alert group annotations (map)
- cluster
Id string The cluster id where create cluster alert group (string)
- description string
The cluster alert group description (string)
- group
Interval numberSeconds The cluster alert group interval seconds. Default:
180
(int)- group
Wait numberSeconds The cluster alert group wait seconds. Default:
180
(int)- labels {[key: string]: any}
The cluster alert group labels (map)
- name string
The cluster alert group name (string)
- recipients
Cluster
Alter Group Recipient Args[] The cluster alert group recipients (list)
- repeat
Interval numberSeconds The cluster alert group wait seconds. Default:
3600
(int)
- annotations Mapping[str, Any]
The cluster alert group annotations (map)
- cluster_
id str The cluster id where create cluster alert group (string)
- description str
The cluster alert group description (string)
- group_
interval_ intseconds The cluster alert group interval seconds. Default:
180
(int)- group_
wait_ intseconds The cluster alert group wait seconds. Default:
180
(int)- labels Mapping[str, Any]
The cluster alert group labels (map)
- name str
The cluster alert group name (string)
- recipients
Sequence[Cluster
Alter Group Recipient Args] The cluster alert group recipients (list)
- repeat_
interval_ intseconds The cluster alert group wait seconds. Default:
3600
(int)
- annotations
Map
The cluster alert group annotations (map)
- cluster
Id String The cluster id where create cluster alert group (string)
- description String
The cluster alert group description (string)
- group
Interval NumberSeconds The cluster alert group interval seconds. Default:
180
(int)- group
Wait NumberSeconds The cluster alert group wait seconds. Default:
180
(int)- labels
Map
The cluster alert group labels (map)
- name String
The cluster alert group name (string)
- recipients
List
The cluster alert group recipients (list)
- repeat
Interval NumberSeconds The cluster alert group wait seconds. Default:
3600
(int)
Supporting Types
ClusterAlterGroupRecipient
- Notifier
Id string Recipient notifier ID (string)
- Default
Recipient bool Use notifier default recipient, overriding
recipient
argument if set. Default:false
(bool)- Notifier
Type string Recipient notifier ID. Supported values :
"dingtalk" | "msteams" | "pagerduty" | "slack" | "email" | "webhook" | "wechat"
(string)- Recipient string
Recipient (string)
- Notifier
Id string Recipient notifier ID (string)
- Default
Recipient bool Use notifier default recipient, overriding
recipient
argument if set. Default:false
(bool)- Notifier
Type string Recipient notifier ID. Supported values :
"dingtalk" | "msteams" | "pagerduty" | "slack" | "email" | "webhook" | "wechat"
(string)- Recipient string
Recipient (string)
- notifier
Id String Recipient notifier ID (string)
- default
Recipient Boolean Use notifier default recipient, overriding
recipient
argument if set. Default:false
(bool)- notifier
Type String Recipient notifier ID. Supported values :
"dingtalk" | "msteams" | "pagerduty" | "slack" | "email" | "webhook" | "wechat"
(string)- recipient String
Recipient (string)
- notifier
Id string Recipient notifier ID (string)
- default
Recipient boolean Use notifier default recipient, overriding
recipient
argument if set. Default:false
(bool)- notifier
Type string Recipient notifier ID. Supported values :
"dingtalk" | "msteams" | "pagerduty" | "slack" | "email" | "webhook" | "wechat"
(string)- recipient string
Recipient (string)
- notifier_
id str Recipient notifier ID (string)
- default_
recipient bool Use notifier default recipient, overriding
recipient
argument if set. Default:false
(bool)- notifier_
type str Recipient notifier ID. Supported values :
"dingtalk" | "msteams" | "pagerduty" | "slack" | "email" | "webhook" | "wechat"
(string)- recipient str
Recipient (string)
- notifier
Id String Recipient notifier ID (string)
- default
Recipient Boolean Use notifier default recipient, overriding
recipient
argument if set. Default:false
(bool)- notifier
Type String Recipient notifier ID. Supported values :
"dingtalk" | "msteams" | "pagerduty" | "slack" | "email" | "webhook" | "wechat"
(string)- recipient String
Recipient (string)
Import
Cluster Alert Group can be imported using the Rancher cluster alert group ID
$ pulumi import rancher2:index/clusterAlterGroup:ClusterAlterGroup foo <CLUSTER_ALERT_GROUP_ID>
Package Details
- Repository
- https://github.com/pulumi/pulumi-rancher2
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
rancher2
Terraform Provider.