cms

package
v2.11.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 6, 2020 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Alarm

type Alarm struct {
	pulumi.CustomResourceState

	// List contact groups of the alarm rule, which must have been created on the console.
	ContactGroups pulumi.StringArrayOutput `pulumi:"contactGroups"`
	// Map of the resources associated with the alarm rule, such as "instanceId", "device" and "port". Each key's value is a string and it uses comma to split multiple items. For more information, see [Metrics Reference](https://www.alibabacloud.com/help/doc-detail/28619.htm).
	Dimensions pulumi.MapOutput `pulumi:"dimensions"`
	// The interval of effecting alarm rule. It foramt as "hh:mm-hh:mm", like "0:00-4:00". Default to "00:00-23:59".
	EffectiveInterval pulumi.StringPtrOutput `pulumi:"effectiveInterval"`
	// Whether to enable alarm rule. Default to true.
	Enabled pulumi.BoolPtrOutput `pulumi:"enabled"`
	// It has been deprecated from provider version 1.50.0 and 'effective_interval' instead.
	//
	// Deprecated: Field 'end_time' has been deprecated from provider version 1.50.0. New field 'effective_interval' instead.
	EndTime pulumi.IntPtrOutput `pulumi:"endTime"`
	// Name of the monitoring metrics corresponding to a project, such as "CPUUtilization" and "networkinRate". For more information, see [Metrics Reference](https://www.alibabacloud.com/help/doc-detail/28619.htm).
	Metric pulumi.StringOutput `pulumi:"metric"`
	// The alarm rule name.
	Name pulumi.StringOutput `pulumi:"name"`
	// Alarm comparison operator. Valid values: ["<=", "<", ">", ">=", "==", "!="]. Default to "==".
	Operator pulumi.StringPtrOutput `pulumi:"operator"`
	// Index query cycle, which must be consistent with that defined for metrics. Default to 300, in seconds.
	Period pulumi.IntPtrOutput `pulumi:"period"`
	// Monitor project name, such as "acsEcsDashboard" and "acsRdsDashboard". For more information, see [Metrics Reference](https://www.alibabacloud.com/help/doc-detail/28619.htm).
	Project pulumi.StringOutput `pulumi:"project"`
	// Notification silence period in the alarm state, in seconds. Valid value range: [300, 86400]. Default to 86400
	SilenceTime pulumi.IntPtrOutput `pulumi:"silenceTime"`
	// It has been deprecated from provider version 1.50.0 and 'effective_interval' instead.
	//
	// Deprecated: Field 'start_time' has been deprecated from provider version 1.50.0. New field 'effective_interval' instead.
	StartTime pulumi.IntPtrOutput `pulumi:"startTime"`
	// Statistical method. It must be consistent with that defined for metrics. Valid values: ["Average", "Minimum", "Maximum"]. Default to "Average".
	Statistics pulumi.StringPtrOutput `pulumi:"statistics"`
	// The current alarm rule status.
	Status pulumi.StringOutput `pulumi:"status"`
	// Alarm threshold value, which must be a numeric value currently.
	Threshold pulumi.StringOutput `pulumi:"threshold"`
	// Number of consecutive times it has been detected that the values exceed the threshold. Default to 3.
	TriggeredCount pulumi.IntPtrOutput `pulumi:"triggeredCount"`
	// The webhook that should be called when the alarm is triggered. Currently, only http protocol is supported. Default is empty string.
	Webhook pulumi.StringPtrOutput `pulumi:"webhook"`
}

This resource provides a alarm rule resource and it can be used to monitor several cloud services according different metrics. Details for [alarm rule](https://www.alibabacloud.com/help/doc-detail/28608.htm).

func GetAlarm

func GetAlarm(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *AlarmState, opts ...pulumi.ResourceOption) (*Alarm, error)

GetAlarm gets an existing Alarm resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewAlarm

func NewAlarm(ctx *pulumi.Context,
	name string, args *AlarmArgs, opts ...pulumi.ResourceOption) (*Alarm, error)

NewAlarm registers a new resource with the given unique name, arguments, and options.

type AlarmArgs

type AlarmArgs struct {
	// List contact groups of the alarm rule, which must have been created on the console.
	ContactGroups pulumi.StringArrayInput
	// Map of the resources associated with the alarm rule, such as "instanceId", "device" and "port". Each key's value is a string and it uses comma to split multiple items. For more information, see [Metrics Reference](https://www.alibabacloud.com/help/doc-detail/28619.htm).
	Dimensions pulumi.MapInput
	// The interval of effecting alarm rule. It foramt as "hh:mm-hh:mm", like "0:00-4:00". Default to "00:00-23:59".
	EffectiveInterval pulumi.StringPtrInput
	// Whether to enable alarm rule. Default to true.
	Enabled pulumi.BoolPtrInput
	// It has been deprecated from provider version 1.50.0 and 'effective_interval' instead.
	//
	// Deprecated: Field 'end_time' has been deprecated from provider version 1.50.0. New field 'effective_interval' instead.
	EndTime pulumi.IntPtrInput
	// Name of the monitoring metrics corresponding to a project, such as "CPUUtilization" and "networkinRate". For more information, see [Metrics Reference](https://www.alibabacloud.com/help/doc-detail/28619.htm).
	Metric pulumi.StringInput
	// The alarm rule name.
	Name pulumi.StringPtrInput
	// Alarm comparison operator. Valid values: ["<=", "<", ">", ">=", "==", "!="]. Default to "==".
	Operator pulumi.StringPtrInput
	// Index query cycle, which must be consistent with that defined for metrics. Default to 300, in seconds.
	Period pulumi.IntPtrInput
	// Monitor project name, such as "acsEcsDashboard" and "acsRdsDashboard". For more information, see [Metrics Reference](https://www.alibabacloud.com/help/doc-detail/28619.htm).
	Project pulumi.StringInput
	// Notification silence period in the alarm state, in seconds. Valid value range: [300, 86400]. Default to 86400
	SilenceTime pulumi.IntPtrInput
	// It has been deprecated from provider version 1.50.0 and 'effective_interval' instead.
	//
	// Deprecated: Field 'start_time' has been deprecated from provider version 1.50.0. New field 'effective_interval' instead.
	StartTime pulumi.IntPtrInput
	// Statistical method. It must be consistent with that defined for metrics. Valid values: ["Average", "Minimum", "Maximum"]. Default to "Average".
	Statistics pulumi.StringPtrInput
	// Alarm threshold value, which must be a numeric value currently.
	Threshold pulumi.StringInput
	// Number of consecutive times it has been detected that the values exceed the threshold. Default to 3.
	TriggeredCount pulumi.IntPtrInput
	// The webhook that should be called when the alarm is triggered. Currently, only http protocol is supported. Default is empty string.
	Webhook pulumi.StringPtrInput
}

The set of arguments for constructing a Alarm resource.

func (AlarmArgs) ElementType

func (AlarmArgs) ElementType() reflect.Type

type AlarmState

type AlarmState struct {
	// List contact groups of the alarm rule, which must have been created on the console.
	ContactGroups pulumi.StringArrayInput
	// Map of the resources associated with the alarm rule, such as "instanceId", "device" and "port". Each key's value is a string and it uses comma to split multiple items. For more information, see [Metrics Reference](https://www.alibabacloud.com/help/doc-detail/28619.htm).
	Dimensions pulumi.MapInput
	// The interval of effecting alarm rule. It foramt as "hh:mm-hh:mm", like "0:00-4:00". Default to "00:00-23:59".
	EffectiveInterval pulumi.StringPtrInput
	// Whether to enable alarm rule. Default to true.
	Enabled pulumi.BoolPtrInput
	// It has been deprecated from provider version 1.50.0 and 'effective_interval' instead.
	//
	// Deprecated: Field 'end_time' has been deprecated from provider version 1.50.0. New field 'effective_interval' instead.
	EndTime pulumi.IntPtrInput
	// Name of the monitoring metrics corresponding to a project, such as "CPUUtilization" and "networkinRate". For more information, see [Metrics Reference](https://www.alibabacloud.com/help/doc-detail/28619.htm).
	Metric pulumi.StringPtrInput
	// The alarm rule name.
	Name pulumi.StringPtrInput
	// Alarm comparison operator. Valid values: ["<=", "<", ">", ">=", "==", "!="]. Default to "==".
	Operator pulumi.StringPtrInput
	// Index query cycle, which must be consistent with that defined for metrics. Default to 300, in seconds.
	Period pulumi.IntPtrInput
	// Monitor project name, such as "acsEcsDashboard" and "acsRdsDashboard". For more information, see [Metrics Reference](https://www.alibabacloud.com/help/doc-detail/28619.htm).
	Project pulumi.StringPtrInput
	// Notification silence period in the alarm state, in seconds. Valid value range: [300, 86400]. Default to 86400
	SilenceTime pulumi.IntPtrInput
	// It has been deprecated from provider version 1.50.0 and 'effective_interval' instead.
	//
	// Deprecated: Field 'start_time' has been deprecated from provider version 1.50.0. New field 'effective_interval' instead.
	StartTime pulumi.IntPtrInput
	// Statistical method. It must be consistent with that defined for metrics. Valid values: ["Average", "Minimum", "Maximum"]. Default to "Average".
	Statistics pulumi.StringPtrInput
	// The current alarm rule status.
	Status pulumi.StringPtrInput
	// Alarm threshold value, which must be a numeric value currently.
	Threshold pulumi.StringPtrInput
	// Number of consecutive times it has been detected that the values exceed the threshold. Default to 3.
	TriggeredCount pulumi.IntPtrInput
	// The webhook that should be called when the alarm is triggered. Currently, only http protocol is supported. Default is empty string.
	Webhook pulumi.StringPtrInput
}

func (AlarmState) ElementType

func (AlarmState) ElementType() reflect.Type

type SiteMonitor

type SiteMonitor struct {
	pulumi.CustomResourceState

	// The URL or IP address monitored by the site monitoring task.
	Address pulumi.StringOutput `pulumi:"address"`
	// The IDs of existing alert rules to be associated with the site monitoring task.
	AlertIds   pulumi.StringArrayOutput `pulumi:"alertIds"`
	CreateTime pulumi.StringOutput      `pulumi:"createTime"`
	// The monitoring interval of the site monitoring task. Unit: minutes. Valid values: 1, 5, and 15. Default value: 1.
	Interval pulumi.IntPtrOutput `pulumi:"interval"`
	// The detection points in a JSON array. For example, `[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]` indicates the detection points in Beijing, Hangzhou, and Qingdao respectively. You can call the [DescribeSiteMonitorISPCityList](https://www.alibabacloud.com/help/en/doc-detail/115045.htm?spm=a2c63.p38356.b99.238.5fec36962UlFG6) operation to query detection point information. If this parameter is not specified, three detection points will be chosen randomly for monitoring.
	IspCities SiteMonitorIspCityArrayOutput `pulumi:"ispCities"`
	// The extended options of the protocol of the site monitoring task. The options vary according to the protocol.
	OptionsJson pulumi.StringPtrOutput `pulumi:"optionsJson"`
	// The name of the site monitoring task. The name must be 4 to 100 characters in length. The name can contain the following types of characters: letters, digits, and underscores.
	TaskName  pulumi.StringOutput `pulumi:"taskName"`
	TaskState pulumi.StringOutput `pulumi:"taskState"`
	// The protocol of the site monitoring task. Currently, site monitoring supports the following protocols: HTTP, Ping, TCP, UDP, DNS, SMTP, POP3, and FTP.
	TaskType   pulumi.StringOutput `pulumi:"taskType"`
	UpdateTime pulumi.StringOutput `pulumi:"updateTime"`
}

This resource provides a site monitor resource and it can be used to monitor public endpoints and websites. Details at https://www.alibabacloud.com/help/doc-detail/67907.htm

Available in 1.72.0+

func GetSiteMonitor

func GetSiteMonitor(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *SiteMonitorState, opts ...pulumi.ResourceOption) (*SiteMonitor, error)

GetSiteMonitor gets an existing SiteMonitor resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewSiteMonitor

func NewSiteMonitor(ctx *pulumi.Context,
	name string, args *SiteMonitorArgs, opts ...pulumi.ResourceOption) (*SiteMonitor, error)

NewSiteMonitor registers a new resource with the given unique name, arguments, and options.

type SiteMonitorArgs

type SiteMonitorArgs struct {
	// The URL or IP address monitored by the site monitoring task.
	Address pulumi.StringInput
	// The IDs of existing alert rules to be associated with the site monitoring task.
	AlertIds pulumi.StringArrayInput
	// The monitoring interval of the site monitoring task. Unit: minutes. Valid values: 1, 5, and 15. Default value: 1.
	Interval pulumi.IntPtrInput
	// The detection points in a JSON array. For example, `[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]` indicates the detection points in Beijing, Hangzhou, and Qingdao respectively. You can call the [DescribeSiteMonitorISPCityList](https://www.alibabacloud.com/help/en/doc-detail/115045.htm?spm=a2c63.p38356.b99.238.5fec36962UlFG6) operation to query detection point information. If this parameter is not specified, three detection points will be chosen randomly for monitoring.
	IspCities SiteMonitorIspCityArrayInput
	// The extended options of the protocol of the site monitoring task. The options vary according to the protocol.
	OptionsJson pulumi.StringPtrInput
	// The name of the site monitoring task. The name must be 4 to 100 characters in length. The name can contain the following types of characters: letters, digits, and underscores.
	TaskName pulumi.StringInput
	// The protocol of the site monitoring task. Currently, site monitoring supports the following protocols: HTTP, Ping, TCP, UDP, DNS, SMTP, POP3, and FTP.
	TaskType pulumi.StringInput
}

The set of arguments for constructing a SiteMonitor resource.

func (SiteMonitorArgs) ElementType

func (SiteMonitorArgs) ElementType() reflect.Type

type SiteMonitorIspCity

type SiteMonitorIspCity struct {
	City string `pulumi:"city"`
	Isp  string `pulumi:"isp"`
}

type SiteMonitorIspCityArgs

type SiteMonitorIspCityArgs struct {
	City pulumi.StringInput `pulumi:"city"`
	Isp  pulumi.StringInput `pulumi:"isp"`
}

func (SiteMonitorIspCityArgs) ElementType

func (SiteMonitorIspCityArgs) ElementType() reflect.Type

func (SiteMonitorIspCityArgs) ToSiteMonitorIspCityOutput

func (i SiteMonitorIspCityArgs) ToSiteMonitorIspCityOutput() SiteMonitorIspCityOutput

func (SiteMonitorIspCityArgs) ToSiteMonitorIspCityOutputWithContext

func (i SiteMonitorIspCityArgs) ToSiteMonitorIspCityOutputWithContext(ctx context.Context) SiteMonitorIspCityOutput

type SiteMonitorIspCityArray

type SiteMonitorIspCityArray []SiteMonitorIspCityInput

func (SiteMonitorIspCityArray) ElementType

func (SiteMonitorIspCityArray) ElementType() reflect.Type

func (SiteMonitorIspCityArray) ToSiteMonitorIspCityArrayOutput

func (i SiteMonitorIspCityArray) ToSiteMonitorIspCityArrayOutput() SiteMonitorIspCityArrayOutput

func (SiteMonitorIspCityArray) ToSiteMonitorIspCityArrayOutputWithContext

func (i SiteMonitorIspCityArray) ToSiteMonitorIspCityArrayOutputWithContext(ctx context.Context) SiteMonitorIspCityArrayOutput

type SiteMonitorIspCityArrayInput

type SiteMonitorIspCityArrayInput interface {
	pulumi.Input

	ToSiteMonitorIspCityArrayOutput() SiteMonitorIspCityArrayOutput
	ToSiteMonitorIspCityArrayOutputWithContext(context.Context) SiteMonitorIspCityArrayOutput
}

SiteMonitorIspCityArrayInput is an input type that accepts SiteMonitorIspCityArray and SiteMonitorIspCityArrayOutput values. You can construct a concrete instance of `SiteMonitorIspCityArrayInput` via:

SiteMonitorIspCityArray{ SiteMonitorIspCityArgs{...} }

type SiteMonitorIspCityArrayOutput

type SiteMonitorIspCityArrayOutput struct{ *pulumi.OutputState }

func (SiteMonitorIspCityArrayOutput) ElementType

func (SiteMonitorIspCityArrayOutput) Index

func (SiteMonitorIspCityArrayOutput) ToSiteMonitorIspCityArrayOutput

func (o SiteMonitorIspCityArrayOutput) ToSiteMonitorIspCityArrayOutput() SiteMonitorIspCityArrayOutput

func (SiteMonitorIspCityArrayOutput) ToSiteMonitorIspCityArrayOutputWithContext

func (o SiteMonitorIspCityArrayOutput) ToSiteMonitorIspCityArrayOutputWithContext(ctx context.Context) SiteMonitorIspCityArrayOutput

type SiteMonitorIspCityInput

type SiteMonitorIspCityInput interface {
	pulumi.Input

	ToSiteMonitorIspCityOutput() SiteMonitorIspCityOutput
	ToSiteMonitorIspCityOutputWithContext(context.Context) SiteMonitorIspCityOutput
}

SiteMonitorIspCityInput is an input type that accepts SiteMonitorIspCityArgs and SiteMonitorIspCityOutput values. You can construct a concrete instance of `SiteMonitorIspCityInput` via:

SiteMonitorIspCityArgs{...}

type SiteMonitorIspCityOutput

type SiteMonitorIspCityOutput struct{ *pulumi.OutputState }

func (SiteMonitorIspCityOutput) City

func (SiteMonitorIspCityOutput) ElementType

func (SiteMonitorIspCityOutput) ElementType() reflect.Type

func (SiteMonitorIspCityOutput) Isp

func (SiteMonitorIspCityOutput) ToSiteMonitorIspCityOutput

func (o SiteMonitorIspCityOutput) ToSiteMonitorIspCityOutput() SiteMonitorIspCityOutput

func (SiteMonitorIspCityOutput) ToSiteMonitorIspCityOutputWithContext

func (o SiteMonitorIspCityOutput) ToSiteMonitorIspCityOutputWithContext(ctx context.Context) SiteMonitorIspCityOutput

type SiteMonitorState

type SiteMonitorState struct {
	// The URL or IP address monitored by the site monitoring task.
	Address pulumi.StringPtrInput
	// The IDs of existing alert rules to be associated with the site monitoring task.
	AlertIds   pulumi.StringArrayInput
	CreateTime pulumi.StringPtrInput
	// The monitoring interval of the site monitoring task. Unit: minutes. Valid values: 1, 5, and 15. Default value: 1.
	Interval pulumi.IntPtrInput
	// The detection points in a JSON array. For example, `[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]` indicates the detection points in Beijing, Hangzhou, and Qingdao respectively. You can call the [DescribeSiteMonitorISPCityList](https://www.alibabacloud.com/help/en/doc-detail/115045.htm?spm=a2c63.p38356.b99.238.5fec36962UlFG6) operation to query detection point information. If this parameter is not specified, three detection points will be chosen randomly for monitoring.
	IspCities SiteMonitorIspCityArrayInput
	// The extended options of the protocol of the site monitoring task. The options vary according to the protocol.
	OptionsJson pulumi.StringPtrInput
	// The name of the site monitoring task. The name must be 4 to 100 characters in length. The name can contain the following types of characters: letters, digits, and underscores.
	TaskName  pulumi.StringPtrInput
	TaskState pulumi.StringPtrInput
	// The protocol of the site monitoring task. Currently, site monitoring supports the following protocols: HTTP, Ping, TCP, UDP, DNS, SMTP, POP3, and FTP.
	TaskType   pulumi.StringPtrInput
	UpdateTime pulumi.StringPtrInput
}

func (SiteMonitorState) ElementType

func (SiteMonitorState) ElementType() reflect.Type

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL