1. Docs
2. Reference
3. API
4. @pulumi/alicloud
5. cms

Module cms

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-alicloud repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-alicloud repo.

Resources

• Alarm
• SiteMonitor

Others

• AlarmArgs
• AlarmState
• SiteMonitorArgs
• SiteMonitorState

Resources

Resource Alarm

class Alarm extends CustomResource

constructor

new Alarm(name: string, args: AlarmArgs, opts?: pulumi.CustomResourceOptions)

Create a Alarm resource with the given unique name, arguments, and options.

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AlarmState, opts?: pulumi.CustomResourceOptions): Alarm

Get an existing Alarm resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Alarm

Returns true if the given object is an instance of Alarm. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property contactGroups

public contactGroups: pulumi.Output<string[]>;

List contact groups of the alarm rule, which must have been created on the console.

property dimensions

public dimensions: pulumi.Output<{[key: string]: any}>;

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.

property effectiveInterval

public effectiveInterval: pulumi.Output<string | undefined>;

The interval of effecting alarm rule. It foramt as “hh:mm-hh:mm”, like “0:00-4:00”. Default to “00:00-23:59”.

property enabled

public enabled: pulumi.Output<boolean | undefined>;

Whether to enable alarm rule. Default to true.

property endTime

public endTime: pulumi.Output<number | undefined>;

It has been deprecated from provider version 1.50.0 and ‘effective_interval’ instead.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property metric

public metric: pulumi.Output<string>;

Name of the monitoring metrics corresponding to a project, such as “CPUUtilization” and “networkinRate”. For more information, see Metrics Reference.

property name

public name: pulumi.Output<string>;

The alarm rule name.

property operator

public operator: pulumi.Output<string | undefined>;

Alarm comparison operator. Valid values: [”<=“, “<“, “>”, “>=”, “==”, “!=”]. Default to “==”.

property period

public period: pulumi.Output<number | undefined>;

Index query cycle, which must be consistent with that defined for metrics. Default to 300, in seconds.

property project

public project: pulumi.Output<string>;

Monitor project name, such as “acsEcsDashboard” and “acsRdsDashboard”. For more information, see Metrics Reference.

property silenceTime

public silenceTime: pulumi.Output<number | undefined>;

Notification silence period in the alarm state, in seconds. Valid value range: [300, 86400]. Default to 86400

property startTime

public startTime: pulumi.Output<number | undefined>;

It has been deprecated from provider version 1.50.0 and ‘effective_interval’ instead.

property statistics

public statistics: pulumi.Output<string | undefined>;

Statistical method. It must be consistent with that defined for metrics. Valid values: [“Average”, “Minimum”, “Maximum”]. Default to “Average”.

property status

public status: pulumi.Output<string>;

The current alarm rule status.

property threshold

public threshold: pulumi.Output<string>;

Alarm threshold value, which must be a numeric value currently.

property triggeredCount

public triggeredCount: pulumi.Output<number | undefined>;

Number of consecutive times it has been detected that the values exceed the threshold. Default to 3.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property webhook

public webhook: pulumi.Output<string | undefined>;

The webhook that should be called when the alarm is triggered. Currently, only http protocol is supported. Default is empty string.

Resource SiteMonitor

class SiteMonitor extends CustomResource

constructor

new SiteMonitor(name: string, args: SiteMonitorArgs, opts?: pulumi.CustomResourceOptions)

Create a SiteMonitor resource with the given unique name, arguments, and options.

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SiteMonitorState, opts?: pulumi.CustomResourceOptions): SiteMonitor

Get an existing SiteMonitor resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is SiteMonitor

Returns true if the given object is an instance of SiteMonitor. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property address

public address: pulumi.Output<string>;

property alertIds

public alertIds: pulumi.Output<string[] | undefined>;

property createTime

public createTime: pulumi.Output<string>;

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property interval

public interval: pulumi.Output<number | undefined>;

property ispCities

public ispCities: pulumi.Output<SiteMonitorIspCity[] | undefined>;

property optionsJson

public optionsJson: pulumi.Output<string | undefined>;

property taskName

public taskName: pulumi.Output<string>;

property taskState

public taskState: pulumi.Output<string>;

property taskType

public taskType: pulumi.Output<string>;

property updateTime

public updateTime: pulumi.Output<string>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Others

interface AlarmArgs

interface AlarmArgs

The set of arguments for constructing a Alarm resource.

property contactGroups

contactGroups: pulumi.Input<pulumi.Input<string>[]>;

List contact groups of the alarm rule, which must have been created on the console.

property dimensions

dimensions: pulumi.Input<{[key: string]: any}>;

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.

property effectiveInterval

effectiveInterval?: pulumi.Input<string>;

The interval of effecting alarm rule. It foramt as “hh:mm-hh:mm”, like “0:00-4:00”. Default to “00:00-23:59”.

property enabled

enabled?: pulumi.Input<boolean>;

Whether to enable alarm rule. Default to true.

property endTime

endTime?: pulumi.Input<number>;

It has been deprecated from provider version 1.50.0 and ‘effective_interval’ instead.

property metric

metric: pulumi.Input<string>;

Name of the monitoring metrics corresponding to a project, such as “CPUUtilization” and “networkinRate”. For more information, see Metrics Reference.

property name

name?: pulumi.Input<string>;

The alarm rule name.

property operator

operator?: pulumi.Input<string>;

Alarm comparison operator. Valid values: [”<=“, “<“, “>”, “>=”, “==”, “!=”]. Default to “==”.

property period

period?: pulumi.Input<number>;

Index query cycle, which must be consistent with that defined for metrics. Default to 300, in seconds.

property project

project: pulumi.Input<string>;

Monitor project name, such as “acsEcsDashboard” and “acsRdsDashboard”. For more information, see Metrics Reference.

property silenceTime

silenceTime?: pulumi.Input<number>;

Notification silence period in the alarm state, in seconds. Valid value range: [300, 86400]. Default to 86400

property startTime

startTime?: pulumi.Input<number>;

It has been deprecated from provider version 1.50.0 and ‘effective_interval’ instead.

property statistics

statistics?: pulumi.Input<string>;

Statistical method. It must be consistent with that defined for metrics. Valid values: [“Average”, “Minimum”, “Maximum”]. Default to “Average”.

property threshold

threshold: pulumi.Input<string>;

Alarm threshold value, which must be a numeric value currently.

property triggeredCount

triggeredCount?: pulumi.Input<number>;

Number of consecutive times it has been detected that the values exceed the threshold. Default to 3.

property webhook

webhook?: pulumi.Input<string>;

The webhook that should be called when the alarm is triggered. Currently, only http protocol is supported. Default is empty string.

interface AlarmState

interface AlarmState

Input properties used for looking up and filtering Alarm resources.

property contactGroups

contactGroups?: pulumi.Input<pulumi.Input<string>[]>;

List contact groups of the alarm rule, which must have been created on the console.

property dimensions

dimensions?: pulumi.Input<{[key: string]: any}>;

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.

property effectiveInterval

effectiveInterval?: pulumi.Input<string>;

The interval of effecting alarm rule. It foramt as “hh:mm-hh:mm”, like “0:00-4:00”. Default to “00:00-23:59”.

property enabled

enabled?: pulumi.Input<boolean>;

Whether to enable alarm rule. Default to true.

property endTime

endTime?: pulumi.Input<number>;

It has been deprecated from provider version 1.50.0 and ‘effective_interval’ instead.

property metric

metric?: pulumi.Input<string>;

Name of the monitoring metrics corresponding to a project, such as “CPUUtilization” and “networkinRate”. For more information, see Metrics Reference.

property name

name?: pulumi.Input<string>;

The alarm rule name.

property operator

operator?: pulumi.Input<string>;

Alarm comparison operator. Valid values: [”<=“, “<“, “>”, “>=”, “==”, “!=”]. Default to “==”.

property period

period?: pulumi.Input<number>;

Index query cycle, which must be consistent with that defined for metrics. Default to 300, in seconds.

property project

project?: pulumi.Input<string>;

Monitor project name, such as “acsEcsDashboard” and “acsRdsDashboard”. For more information, see Metrics Reference.

property silenceTime

silenceTime?: pulumi.Input<number>;

Notification silence period in the alarm state, in seconds. Valid value range: [300, 86400]. Default to 86400

property startTime

startTime?: pulumi.Input<number>;

It has been deprecated from provider version 1.50.0 and ‘effective_interval’ instead.

property statistics

statistics?: pulumi.Input<string>;

Statistical method. It must be consistent with that defined for metrics. Valid values: [“Average”, “Minimum”, “Maximum”]. Default to “Average”.

property status

status?: pulumi.Input<string>;

The current alarm rule status.

property threshold

threshold?: pulumi.Input<string>;

Alarm threshold value, which must be a numeric value currently.

property triggeredCount

triggeredCount?: pulumi.Input<number>;

Number of consecutive times it has been detected that the values exceed the threshold. Default to 3.

property webhook

webhook?: pulumi.Input<string>;

The webhook that should be called when the alarm is triggered. Currently, only http protocol is supported. Default is empty string.

interface SiteMonitorArgs

interface SiteMonitorArgs

The set of arguments for constructing a SiteMonitor resource.

property address

address: pulumi.Input<string>;

property alertIds

alertIds?: pulumi.Input<pulumi.Input<string>[]>;

property interval

interval?: pulumi.Input<number>;

property ispCities

ispCities?: pulumi.Input<pulumi.Input<SiteMonitorIspCity>[]>;

property optionsJson

optionsJson?: pulumi.Input<string>;

property taskName

taskName: pulumi.Input<string>;

property taskType

taskType: pulumi.Input<string>;

interface SiteMonitorState

interface SiteMonitorState

Input properties used for looking up and filtering SiteMonitor resources.

property address

address?: pulumi.Input<string>;

property alertIds

alertIds?: pulumi.Input<pulumi.Input<string>[]>;

property createTime

createTime?: pulumi.Input<string>;

property interval

interval?: pulumi.Input<number>;

property ispCities

ispCities?: pulumi.Input<pulumi.Input<SiteMonitorIspCity>[]>;

property optionsJson

optionsJson?: pulumi.Input<string>;

property taskName

taskName?: pulumi.Input<string>;

property taskState

taskState?: pulumi.Input<string>;

property taskType

taskType?: pulumi.Input<string>;

property updateTime

updateTime?: pulumi.Input<string>;