Documentation
¶
Index ¶
- type AlertPolicy
- func (r *AlertPolicy) Combiner() *pulumi.StringOutput
- func (r *AlertPolicy) Conditions() *pulumi.ArrayOutput
- func (r *AlertPolicy) CreationRecord() *pulumi.Output
- func (r *AlertPolicy) DisplayName() *pulumi.StringOutput
- func (r *AlertPolicy) Documentation() *pulumi.Output
- func (r *AlertPolicy) Enabled() *pulumi.BoolOutput
- func (r *AlertPolicy) ID() *pulumi.IDOutput
- func (r *AlertPolicy) Labels() *pulumi.ArrayOutput
- func (r *AlertPolicy) Name() *pulumi.StringOutput
- func (r *AlertPolicy) NotificationChannels() *pulumi.ArrayOutput
- func (r *AlertPolicy) Project() *pulumi.StringOutput
- func (r *AlertPolicy) URN() *pulumi.URNOutput
- func (r *AlertPolicy) UserLabels() *pulumi.MapOutput
- type AlertPolicyArgs
- type AlertPolicyState
- type Group
- func (r *Group) DisplayName() *pulumi.StringOutput
- func (r *Group) Filter() *pulumi.StringOutput
- func (r *Group) ID() *pulumi.IDOutput
- func (r *Group) IsCluster() *pulumi.BoolOutput
- func (r *Group) Name() *pulumi.StringOutput
- func (r *Group) ParentName() *pulumi.StringOutput
- func (r *Group) Project() *pulumi.StringOutput
- func (r *Group) URN() *pulumi.URNOutput
- type GroupArgs
- type GroupState
- type NotificationChannel
- func (r *NotificationChannel) Description() *pulumi.StringOutput
- func (r *NotificationChannel) DisplayName() *pulumi.StringOutput
- func (r *NotificationChannel) Enabled() *pulumi.BoolOutput
- func (r *NotificationChannel) ID() *pulumi.IDOutput
- func (r *NotificationChannel) Labels() *pulumi.MapOutput
- func (r *NotificationChannel) Name() *pulumi.StringOutput
- func (r *NotificationChannel) Project() *pulumi.StringOutput
- func (r *NotificationChannel) Type() *pulumi.StringOutput
- func (r *NotificationChannel) URN() *pulumi.URNOutput
- func (r *NotificationChannel) UserLabels() *pulumi.MapOutput
- func (r *NotificationChannel) VerificationStatus() *pulumi.StringOutput
- type NotificationChannelArgs
- type NotificationChannelState
- type UptimeCheckConfig
- func (r *UptimeCheckConfig) ContentMatchers() *pulumi.ArrayOutput
- func (r *UptimeCheckConfig) DisplayName() *pulumi.StringOutput
- func (r *UptimeCheckConfig) HttpCheck() *pulumi.Output
- func (r *UptimeCheckConfig) ID() *pulumi.IDOutput
- func (r *UptimeCheckConfig) InternalCheckers() *pulumi.ArrayOutput
- func (r *UptimeCheckConfig) IsInternal() *pulumi.BoolOutput
- func (r *UptimeCheckConfig) MonitoredResource() *pulumi.Output
- func (r *UptimeCheckConfig) Name() *pulumi.StringOutput
- func (r *UptimeCheckConfig) Period() *pulumi.StringOutput
- func (r *UptimeCheckConfig) Project() *pulumi.StringOutput
- func (r *UptimeCheckConfig) ResourceGroup() *pulumi.Output
- func (r *UptimeCheckConfig) SelectedRegions() *pulumi.ArrayOutput
- func (r *UptimeCheckConfig) TcpCheck() *pulumi.Output
- func (r *UptimeCheckConfig) Timeout() *pulumi.StringOutput
- func (r *UptimeCheckConfig) URN() *pulumi.URNOutput
- func (r *UptimeCheckConfig) UptimeCheckId() *pulumi.StringOutput
- type UptimeCheckConfigArgs
- type UptimeCheckConfigState
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AlertPolicy ¶
type AlertPolicy struct {
// contains filtered or unexported fields
}
A description of the conditions under which some aspect of your system is considered to be "unhealthy" and the ways to notify people or services about this state.
To get more information about AlertPolicy, see:
* [API documentation](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.alertPolicies) * How-to Guides
- [Official Documentation](https://cloud.google.com/monitoring/alerts/)
func GetAlertPolicy ¶
func GetAlertPolicy(ctx *pulumi.Context, name string, id pulumi.ID, state *AlertPolicyState, opts ...pulumi.ResourceOpt) (*AlertPolicy, error)
GetAlertPolicy gets an existing AlertPolicy 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 NewAlertPolicy ¶
func NewAlertPolicy(ctx *pulumi.Context, name string, args *AlertPolicyArgs, opts ...pulumi.ResourceOpt) (*AlertPolicy, error)
NewAlertPolicy registers a new resource with the given unique name, arguments, and options.
func (*AlertPolicy) Combiner ¶
func (r *AlertPolicy) Combiner() *pulumi.StringOutput
func (*AlertPolicy) Conditions ¶
func (r *AlertPolicy) Conditions() *pulumi.ArrayOutput
func (*AlertPolicy) CreationRecord ¶
func (r *AlertPolicy) CreationRecord() *pulumi.Output
func (*AlertPolicy) DisplayName ¶
func (r *AlertPolicy) DisplayName() *pulumi.StringOutput
func (*AlertPolicy) Documentation ¶ added in v0.18.0
func (r *AlertPolicy) Documentation() *pulumi.Output
func (*AlertPolicy) Enabled ¶
func (r *AlertPolicy) Enabled() *pulumi.BoolOutput
func (*AlertPolicy) ID ¶
func (r *AlertPolicy) ID() *pulumi.IDOutput
ID is this resource's unique identifier assigned by its provider.
func (*AlertPolicy) Labels ¶
func (r *AlertPolicy) Labels() *pulumi.ArrayOutput
func (*AlertPolicy) Name ¶
func (r *AlertPolicy) Name() *pulumi.StringOutput
func (*AlertPolicy) NotificationChannels ¶
func (r *AlertPolicy) NotificationChannels() *pulumi.ArrayOutput
func (*AlertPolicy) Project ¶
func (r *AlertPolicy) Project() *pulumi.StringOutput
func (*AlertPolicy) URN ¶
func (r *AlertPolicy) URN() *pulumi.URNOutput
URN is this resource's unique name assigned by Pulumi.
func (*AlertPolicy) UserLabels ¶ added in v0.18.6
func (r *AlertPolicy) UserLabels() *pulumi.MapOutput
type AlertPolicyArgs ¶
type AlertPolicyArgs struct { Combiner interface{} Conditions interface{} DisplayName interface{} Documentation interface{} Enabled interface{} Labels interface{} NotificationChannels interface{} Project interface{} UserLabels interface{} }
The set of arguments for constructing a AlertPolicy resource.
type AlertPolicyState ¶
type AlertPolicyState struct { Combiner interface{} Conditions interface{} CreationRecord interface{} DisplayName interface{} Documentation interface{} Enabled interface{} Labels interface{} Name interface{} NotificationChannels interface{} Project interface{} UserLabels interface{} }
Input properties used for looking up and filtering AlertPolicy resources.
type Group ¶ added in v0.16.4
type Group struct {
// contains filtered or unexported fields
}
The description of a dynamic collection of monitored resources. Each group has a filter that is matched against monitored resources and their associated metadata. If a group's filter matches an available monitored resource, then that resource is a member of that group.
To get more information about Group, see:
* [API documentation](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.groups) * How-to Guides
- [Official Documentation](https://cloud.google.com/monitoring/groups/)
func GetGroup ¶ added in v0.16.4
func GetGroup(ctx *pulumi.Context, name string, id pulumi.ID, state *GroupState, opts ...pulumi.ResourceOpt) (*Group, error)
GetGroup gets an existing Group 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 NewGroup ¶ added in v0.16.4
func NewGroup(ctx *pulumi.Context, name string, args *GroupArgs, opts ...pulumi.ResourceOpt) (*Group, error)
NewGroup registers a new resource with the given unique name, arguments, and options.
func (*Group) DisplayName ¶ added in v0.16.4
func (r *Group) DisplayName() *pulumi.StringOutput
func (*Group) Filter ¶ added in v0.16.4
func (r *Group) Filter() *pulumi.StringOutput
func (*Group) ID ¶ added in v0.16.4
ID is this resource's unique identifier assigned by its provider.
func (*Group) IsCluster ¶ added in v0.16.4
func (r *Group) IsCluster() *pulumi.BoolOutput
func (*Group) Name ¶ added in v0.16.4
func (r *Group) Name() *pulumi.StringOutput
func (*Group) ParentName ¶ added in v0.16.4
func (r *Group) ParentName() *pulumi.StringOutput
func (*Group) Project ¶ added in v0.16.4
func (r *Group) Project() *pulumi.StringOutput
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
type GroupArgs ¶ added in v0.16.4
type GroupArgs struct { DisplayName interface{} Filter interface{} IsCluster interface{} ParentName interface{} // The ID of the project in which the resource belongs. // If it is not provided, the provider project is used. Project interface{} }
The set of arguments for constructing a Group resource.
type GroupState ¶ added in v0.16.4
type GroupState struct { DisplayName interface{} Filter interface{} IsCluster interface{} Name interface{} ParentName interface{} // The ID of the project in which the resource belongs. // If it is not provided, the provider project is used. Project interface{} }
Input properties used for looking up and filtering Group resources.
type NotificationChannel ¶ added in v0.16.4
type NotificationChannel struct {
// contains filtered or unexported fields
}
A NotificationChannel is a medium through which an alert is delivered when a policy violation is detected. Examples of channels include email, SMS, and third-party messaging applications. Fields containing sensitive information like authentication tokens or contact info are only partially populated on retrieval.
Notification Channels are designed to be flexible and are made up of a supported `type` and labels to configure that channel. Each `type` has specific labels that need to be present for that channel to be correctly configured. The labels that are required to be present for one channel `type` are often different than those requried for another. Due to these loose constraints it's often best to set up a channel through the UI and import to Terraform when setting up a brand new channel type to determine which labels are required.
A list of supported channels per project the `list` endpoint can be accessed programatically or through the api explorer at https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.notificationChannelDescriptors/list . This provides the channel type and all of the required labels that must be passed.
To get more information about NotificationChannel, see:
* [API documentation](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.notificationChannels) * How-to Guides
- [Notification Options](https://cloud.google.com/monitoring/support/notification-options)
- [Monitoring API Documentation](https://cloud.google.com/monitoring/api/v3/)
func GetNotificationChannel ¶ added in v0.16.4
func GetNotificationChannel(ctx *pulumi.Context, name string, id pulumi.ID, state *NotificationChannelState, opts ...pulumi.ResourceOpt) (*NotificationChannel, error)
GetNotificationChannel gets an existing NotificationChannel 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 NewNotificationChannel ¶ added in v0.16.4
func NewNotificationChannel(ctx *pulumi.Context, name string, args *NotificationChannelArgs, opts ...pulumi.ResourceOpt) (*NotificationChannel, error)
NewNotificationChannel registers a new resource with the given unique name, arguments, and options.
func (*NotificationChannel) Description ¶ added in v0.16.4
func (r *NotificationChannel) Description() *pulumi.StringOutput
func (*NotificationChannel) DisplayName ¶ added in v0.16.4
func (r *NotificationChannel) DisplayName() *pulumi.StringOutput
func (*NotificationChannel) Enabled ¶ added in v0.16.4
func (r *NotificationChannel) Enabled() *pulumi.BoolOutput
func (*NotificationChannel) ID ¶ added in v0.16.4
func (r *NotificationChannel) ID() *pulumi.IDOutput
ID is this resource's unique identifier assigned by its provider.
func (*NotificationChannel) Labels ¶ added in v0.16.4
func (r *NotificationChannel) Labels() *pulumi.MapOutput
func (*NotificationChannel) Name ¶ added in v0.16.4
func (r *NotificationChannel) Name() *pulumi.StringOutput
func (*NotificationChannel) Project ¶ added in v0.16.4
func (r *NotificationChannel) Project() *pulumi.StringOutput
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
func (*NotificationChannel) Type ¶ added in v0.16.4
func (r *NotificationChannel) Type() *pulumi.StringOutput
func (*NotificationChannel) URN ¶ added in v0.16.4
func (r *NotificationChannel) URN() *pulumi.URNOutput
URN is this resource's unique name assigned by Pulumi.
func (*NotificationChannel) UserLabels ¶ added in v0.16.4
func (r *NotificationChannel) UserLabels() *pulumi.MapOutput
func (*NotificationChannel) VerificationStatus ¶ added in v0.16.4
func (r *NotificationChannel) VerificationStatus() *pulumi.StringOutput
type NotificationChannelArgs ¶ added in v0.16.4
type NotificationChannelArgs struct { Description interface{} DisplayName interface{} Enabled interface{} Labels interface{} // The ID of the project in which the resource belongs. // If it is not provided, the provider project is used. Project interface{} Type interface{} UserLabels interface{} }
The set of arguments for constructing a NotificationChannel resource.
type NotificationChannelState ¶ added in v0.16.4
type NotificationChannelState struct { Description interface{} DisplayName interface{} Enabled interface{} Labels interface{} Name interface{} // The ID of the project in which the resource belongs. // If it is not provided, the provider project is used. Project interface{} Type interface{} UserLabels interface{} VerificationStatus interface{} }
Input properties used for looking up and filtering NotificationChannel resources.
type UptimeCheckConfig ¶ added in v0.16.4
type UptimeCheckConfig struct {
// contains filtered or unexported fields
}
This message configures which resources and services to monitor for availability.
To get more information about UptimeCheckConfig, see:
* [API documentation](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.uptimeCheckConfigs) * How-to Guides
- [Official Documentation](https://cloud.google.com/monitoring/uptime-checks/)
func GetUptimeCheckConfig ¶ added in v0.16.4
func GetUptimeCheckConfig(ctx *pulumi.Context, name string, id pulumi.ID, state *UptimeCheckConfigState, opts ...pulumi.ResourceOpt) (*UptimeCheckConfig, error)
GetUptimeCheckConfig gets an existing UptimeCheckConfig 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 NewUptimeCheckConfig ¶ added in v0.16.4
func NewUptimeCheckConfig(ctx *pulumi.Context, name string, args *UptimeCheckConfigArgs, opts ...pulumi.ResourceOpt) (*UptimeCheckConfig, error)
NewUptimeCheckConfig registers a new resource with the given unique name, arguments, and options.
func (*UptimeCheckConfig) ContentMatchers ¶ added in v0.16.4
func (r *UptimeCheckConfig) ContentMatchers() *pulumi.ArrayOutput
func (*UptimeCheckConfig) DisplayName ¶ added in v0.16.4
func (r *UptimeCheckConfig) DisplayName() *pulumi.StringOutput
func (*UptimeCheckConfig) HttpCheck ¶ added in v0.16.4
func (r *UptimeCheckConfig) HttpCheck() *pulumi.Output
func (*UptimeCheckConfig) ID ¶ added in v0.16.4
func (r *UptimeCheckConfig) ID() *pulumi.IDOutput
ID is this resource's unique identifier assigned by its provider.
func (*UptimeCheckConfig) InternalCheckers ¶ added in v0.16.4
func (r *UptimeCheckConfig) InternalCheckers() *pulumi.ArrayOutput
func (*UptimeCheckConfig) IsInternal ¶ added in v0.16.4
func (r *UptimeCheckConfig) IsInternal() *pulumi.BoolOutput
func (*UptimeCheckConfig) MonitoredResource ¶ added in v0.16.4
func (r *UptimeCheckConfig) MonitoredResource() *pulumi.Output
func (*UptimeCheckConfig) Name ¶ added in v0.16.4
func (r *UptimeCheckConfig) Name() *pulumi.StringOutput
func (*UptimeCheckConfig) Period ¶ added in v0.16.4
func (r *UptimeCheckConfig) Period() *pulumi.StringOutput
func (*UptimeCheckConfig) Project ¶ added in v0.16.4
func (r *UptimeCheckConfig) Project() *pulumi.StringOutput
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
func (*UptimeCheckConfig) ResourceGroup ¶ added in v0.16.4
func (r *UptimeCheckConfig) ResourceGroup() *pulumi.Output
func (*UptimeCheckConfig) SelectedRegions ¶ added in v0.16.4
func (r *UptimeCheckConfig) SelectedRegions() *pulumi.ArrayOutput
func (*UptimeCheckConfig) TcpCheck ¶ added in v0.16.4
func (r *UptimeCheckConfig) TcpCheck() *pulumi.Output
func (*UptimeCheckConfig) Timeout ¶ added in v0.16.4
func (r *UptimeCheckConfig) Timeout() *pulumi.StringOutput
func (*UptimeCheckConfig) URN ¶ added in v0.16.4
func (r *UptimeCheckConfig) URN() *pulumi.URNOutput
URN is this resource's unique name assigned by Pulumi.
func (*UptimeCheckConfig) UptimeCheckId ¶ added in v0.18.0
func (r *UptimeCheckConfig) UptimeCheckId() *pulumi.StringOutput
type UptimeCheckConfigArgs ¶ added in v0.16.4
type UptimeCheckConfigArgs struct { ContentMatchers interface{} DisplayName interface{} HttpCheck interface{} InternalCheckers interface{} IsInternal interface{} MonitoredResource interface{} Period interface{} // The ID of the project in which the resource belongs. // If it is not provided, the provider project is used. Project interface{} ResourceGroup interface{} SelectedRegions interface{} TcpCheck interface{} Timeout interface{} }
The set of arguments for constructing a UptimeCheckConfig resource.
type UptimeCheckConfigState ¶ added in v0.16.4
type UptimeCheckConfigState struct { ContentMatchers interface{} DisplayName interface{} HttpCheck interface{} InternalCheckers interface{} IsInternal interface{} MonitoredResource interface{} Name interface{} Period interface{} // The ID of the project in which the resource belongs. // If it is not provided, the provider project is used. Project interface{} ResourceGroup interface{} SelectedRegions interface{} TcpCheck interface{} Timeout interface{} UptimeCheckId interface{} }
Input properties used for looking up and filtering UptimeCheckConfig resources.