Skip to content

alerting.v1alpha1.contactPoint

"ContactPoint is the Schema for the ContactPoints API. Manages Grafana Alerting contact points. Official documentation https://grafana.com/docs/grafana/next/alerting/fundamentals/notifications/contact-points/HTTP API https://grafana.com/docs/grafana/latest/developers/http_api/alerting_provisioning/#contact-points This resource requires Grafana 9.1.0 or later."

Index

Fields

fn new

new(name)

new returns an instance of ContactPoint

obj metadata

"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."

fn metadata.withAnnotations

withAnnotations(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

fn metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

Note: This function appends passed data to existing values

fn metadata.withClusterName

withClusterName(clusterName)

"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."

fn metadata.withCreationTimestamp

withCreationTimestamp(creationTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withDeletionGracePeriodSeconds

withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)

"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."

fn metadata.withDeletionTimestamp

withDeletionTimestamp(deletionTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withFinalizers

withFinalizers(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

fn metadata.withFinalizersMixin

withFinalizersMixin(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

Note: This function appends passed data to existing values

fn metadata.withGenerateName

withGenerateName(generateName)

"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"

fn metadata.withGeneration

withGeneration(generation)

"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."

fn metadata.withLabels

withLabels(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

fn metadata.withLabelsMixin

withLabelsMixin(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

Note: This function appends passed data to existing values

fn metadata.withName

withName(name)

"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"

fn metadata.withNamespace

withNamespace(namespace)

"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"

fn metadata.withOwnerReferences

withOwnerReferences(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

fn metadata.withOwnerReferencesMixin

withOwnerReferencesMixin(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

Note: This function appends passed data to existing values

fn metadata.withResourceVersion

withResourceVersion(resourceVersion)

"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

withSelfLink(selfLink)

"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."

fn metadata.withUid

withUid(uid)

"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj spec

"ContactPointSpec defines the desired state of ContactPoint"

fn spec.withDeletionPolicy

withDeletionPolicy(deletionPolicy)

"DeletionPolicy specifies what will happen to the underlying external\nwhen this managed resource is deleted - either \"Delete\" or \"Orphan\" the\nexternal resource.\nThis field is planned to be deprecated in favor of the ManagementPolicies\nfield in a future release. Currently, both could be set independently and\nnon-default values would be honored if the feature flag is enabled.\nSee the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223"

fn spec.withManagementPolicies

withManagementPolicies(managementPolicies)

"THIS IS A BETA FIELD. It is on by default but can be opted out\nthrough a Crossplane feature flag.\nManagementPolicies specify the array of actions Crossplane is allowed to\ntake on the managed and external resources.\nThis field is planned to replace the DeletionPolicy field in a future\nrelease. Currently, both could be set independently and non-default\nvalues would be honored if the feature flag is enabled. If both are\ncustom, the DeletionPolicy field will be ignored.\nSee the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223\nand this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md"

fn spec.withManagementPoliciesMixin

withManagementPoliciesMixin(managementPolicies)

"THIS IS A BETA FIELD. It is on by default but can be opted out\nthrough a Crossplane feature flag.\nManagementPolicies specify the array of actions Crossplane is allowed to\ntake on the managed and external resources.\nThis field is planned to replace the DeletionPolicy field in a future\nrelease. Currently, both could be set independently and non-default\nvalues would be honored if the feature flag is enabled. If both are\ncustom, the DeletionPolicy field will be ignored.\nSee the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223\nand this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md"

Note: This function appends passed data to existing values

obj spec.forProvider

fn spec.forProvider.withAlertmanager

withAlertmanager(alertmanager)

"(Block Set) A contact point that sends notifications to other Alertmanager instances. (see below for nested schema)\nA contact point that sends notifications to other Alertmanager instances."

fn spec.forProvider.withAlertmanagerMixin

withAlertmanagerMixin(alertmanager)

"(Block Set) A contact point that sends notifications to other Alertmanager instances. (see below for nested schema)\nA contact point that sends notifications to other Alertmanager instances."

Note: This function appends passed data to existing values

fn spec.forProvider.withDingding

withDingding(dingding)

"(Block Set) A contact point that sends notifications to DingDing. (see below for nested schema)\nA contact point that sends notifications to DingDing."

fn spec.forProvider.withDingdingMixin

withDingdingMixin(dingding)

"(Block Set) A contact point that sends notifications to DingDing. (see below for nested schema)\nA contact point that sends notifications to DingDing."

Note: This function appends passed data to existing values

fn spec.forProvider.withDisableProvenance

withDisableProvenance(disableProvenance)

"Defaults to false. Defaults to false."

fn spec.forProvider.withDiscord

withDiscord(discord)

"(Block Set) A contact point that sends notifications as Discord messages (see below for nested schema)\nA contact point that sends notifications as Discord messages"

fn spec.forProvider.withDiscordMixin

withDiscordMixin(discord)

"(Block Set) A contact point that sends notifications as Discord messages (see below for nested schema)\nA contact point that sends notifications as Discord messages"

Note: This function appends passed data to existing values

fn spec.forProvider.withEmail

withEmail(email)

"(Block Set) A contact point that sends notifications to an email address. (see below for nested schema)\nA contact point that sends notifications to an email address."

fn spec.forProvider.withEmailMixin

withEmailMixin(email)

"(Block Set) A contact point that sends notifications to an email address. (see below for nested schema)\nA contact point that sends notifications to an email address."

Note: This function appends passed data to existing values

fn spec.forProvider.withGooglechat

withGooglechat(googlechat)

"(Block Set) A contact point that sends notifications to Google Chat. (see below for nested schema)\nA contact point that sends notifications to Google Chat."

fn spec.forProvider.withGooglechatMixin

withGooglechatMixin(googlechat)

"(Block Set) A contact point that sends notifications to Google Chat. (see below for nested schema)\nA contact point that sends notifications to Google Chat."

Note: This function appends passed data to existing values

fn spec.forProvider.withKafka

withKafka(kafka)

"(Block Set) A contact point that publishes notifications to Apache Kafka topics. (see below for nested schema)\nA contact point that publishes notifications to Apache Kafka topics."

fn spec.forProvider.withKafkaMixin

withKafkaMixin(kafka)

"(Block Set) A contact point that publishes notifications to Apache Kafka topics. (see below for nested schema)\nA contact point that publishes notifications to Apache Kafka topics."

Note: This function appends passed data to existing values

fn spec.forProvider.withLine

withLine(line)

"(Block Set) A contact point that sends notifications to LINE.me. (see below for nested schema)\nA contact point that sends notifications to LINE.me."

fn spec.forProvider.withLineMixin

withLineMixin(line)

"(Block Set) A contact point that sends notifications to LINE.me. (see below for nested schema)\nA contact point that sends notifications to LINE.me."

Note: This function appends passed data to existing values

fn spec.forProvider.withName

withName(name)

"(String) The name of the contact point.\nThe name of the contact point."

fn spec.forProvider.withOncall

withOncall(oncall)

"Call. (see below for nested schema)\nA contact point that sends notifications to Grafana On-Call."

fn spec.forProvider.withOncallMixin

withOncallMixin(oncall)

"Call. (see below for nested schema)\nA contact point that sends notifications to Grafana On-Call."

Note: This function appends passed data to existing values

fn spec.forProvider.withOpsgenie

withOpsgenie(opsgenie)

"(Block Set) A contact point that sends notifications to OpsGenie. (see below for nested schema)\nA contact point that sends notifications to OpsGenie."

fn spec.forProvider.withOpsgenieMixin

withOpsgenieMixin(opsgenie)

"(Block Set) A contact point that sends notifications to OpsGenie. (see below for nested schema)\nA contact point that sends notifications to OpsGenie."

Note: This function appends passed data to existing values

fn spec.forProvider.withOrgId

withOrgId(orgId)

"(String) The Organization ID. If not set, the Org ID defined in the provider block will be used.\nThe Organization ID. If not set, the Org ID defined in the provider block will be used."

fn spec.forProvider.withPagerduty

withPagerduty(pagerduty)

"(Block Set) A contact point that sends notifications to PagerDuty. (see below for nested schema)\nA contact point that sends notifications to PagerDuty."

fn spec.forProvider.withPagerdutyMixin

withPagerdutyMixin(pagerduty)

"(Block Set) A contact point that sends notifications to PagerDuty. (see below for nested schema)\nA contact point that sends notifications to PagerDuty."

Note: This function appends passed data to existing values

fn spec.forProvider.withPushover

withPushover(pushover)

"(Block Set) A contact point that sends notifications to Pushover. (see below for nested schema)\nA contact point that sends notifications to Pushover."

fn spec.forProvider.withPushoverMixin

withPushoverMixin(pushover)

"(Block Set) A contact point that sends notifications to Pushover. (see below for nested schema)\nA contact point that sends notifications to Pushover."

Note: This function appends passed data to existing values

fn spec.forProvider.withSensugo

withSensugo(sensugo)

"(Block Set) A contact point that sends notifications to SensuGo. (see below for nested schema)\nA contact point that sends notifications to SensuGo."

fn spec.forProvider.withSensugoMixin

withSensugoMixin(sensugo)

"(Block Set) A contact point that sends notifications to SensuGo. (see below for nested schema)\nA contact point that sends notifications to SensuGo."

Note: This function appends passed data to existing values

fn spec.forProvider.withSlack

withSlack(slack)

"(Block Set) A contact point that sends notifications to Slack. (see below for nested schema)\nA contact point that sends notifications to Slack."

fn spec.forProvider.withSlackMixin

withSlackMixin(slack)

"(Block Set) A contact point that sends notifications to Slack. (see below for nested schema)\nA contact point that sends notifications to Slack."

Note: This function appends passed data to existing values

fn spec.forProvider.withSns

withSns(sns)

"(Block Set) A contact point that sends notifications to Amazon SNS. Requires Amazon Managed Grafana. (see below for nested schema)\nA contact point that sends notifications to Amazon SNS. Requires Amazon Managed Grafana."

fn spec.forProvider.withSnsMixin

withSnsMixin(sns)

"(Block Set) A contact point that sends notifications to Amazon SNS. Requires Amazon Managed Grafana. (see below for nested schema)\nA contact point that sends notifications to Amazon SNS. Requires Amazon Managed Grafana."

Note: This function appends passed data to existing values

fn spec.forProvider.withTeams

withTeams(teams)

"(Block Set) A contact point that sends notifications to Microsoft Teams. (see below for nested schema)\nA contact point that sends notifications to Microsoft Teams."

fn spec.forProvider.withTeamsMixin

withTeamsMixin(teams)

"(Block Set) A contact point that sends notifications to Microsoft Teams. (see below for nested schema)\nA contact point that sends notifications to Microsoft Teams."

Note: This function appends passed data to existing values

fn spec.forProvider.withTelegram

withTelegram(telegram)

"(Block Set) A contact point that sends notifications to Telegram. (see below for nested schema)\nA contact point that sends notifications to Telegram."

fn spec.forProvider.withTelegramMixin

withTelegramMixin(telegram)

"(Block Set) A contact point that sends notifications to Telegram. (see below for nested schema)\nA contact point that sends notifications to Telegram."

Note: This function appends passed data to existing values

fn spec.forProvider.withThreema

withThreema(threema)

"(Block Set) A contact point that sends notifications to Threema. (see below for nested schema)\nA contact point that sends notifications to Threema."

fn spec.forProvider.withThreemaMixin

withThreemaMixin(threema)

"(Block Set) A contact point that sends notifications to Threema. (see below for nested schema)\nA contact point that sends notifications to Threema."

Note: This function appends passed data to existing values

fn spec.forProvider.withVictorops

withVictorops(victorops)

"(Block Set) A contact point that sends notifications to VictorOps (now known as Splunk OnCall). (see below for nested schema)\nA contact point that sends notifications to VictorOps (now known as Splunk OnCall)."

fn spec.forProvider.withVictoropsMixin

withVictoropsMixin(victorops)

"(Block Set) A contact point that sends notifications to VictorOps (now known as Splunk OnCall). (see below for nested schema)\nA contact point that sends notifications to VictorOps (now known as Splunk OnCall)."

Note: This function appends passed data to existing values

fn spec.forProvider.withWebex

withWebex(webex)

"(Block Set) A contact point that sends notifications to Cisco Webex. (see below for nested schema)\nA contact point that sends notifications to Cisco Webex."

fn spec.forProvider.withWebexMixin

withWebexMixin(webex)

"(Block Set) A contact point that sends notifications to Cisco Webex. (see below for nested schema)\nA contact point that sends notifications to Cisco Webex."

Note: This function appends passed data to existing values

fn spec.forProvider.withWebhook

withWebhook(webhook)

"(Block Set) A contact point that sends notifications to an arbitrary webhook, using the Prometheus webhook format defined here: https://prometheus.io/docs/alerting/latest/configuration/#webhook_config (see below for nested schema)\nA contact point that sends notifications to an arbitrary webhook, using the Prometheus webhook format defined here: https://prometheus.io/docs/alerting/latest/configuration/#webhook_config"

fn spec.forProvider.withWebhookMixin

withWebhookMixin(webhook)

"(Block Set) A contact point that sends notifications to an arbitrary webhook, using the Prometheus webhook format defined here: https://prometheus.io/docs/alerting/latest/configuration/#webhook_config (see below for nested schema)\nA contact point that sends notifications to an arbitrary webhook, using the Prometheus webhook format defined here: https://prometheus.io/docs/alerting/latest/configuration/#webhook_config"

Note: This function appends passed data to existing values

fn spec.forProvider.withWecom

withWecom(wecom)

"(Block Set) A contact point that sends notifications to WeCom. (see below for nested schema)\nA contact point that sends notifications to WeCom."

fn spec.forProvider.withWecomMixin

withWecomMixin(wecom)

"(Block Set) A contact point that sends notifications to WeCom. (see below for nested schema)\nA contact point that sends notifications to WeCom."

Note: This function appends passed data to existing values

obj spec.forProvider.alertmanager

"(Block Set) A contact point that sends notifications to other Alertmanager instances. (see below for nested schema)\nA contact point that sends notifications to other Alertmanager instances."

fn spec.forProvider.alertmanager.withBasicAuthUser

withBasicAuthUser(basicAuthUser)

"(String) The username component of the basic auth credentials to use.\nThe username component of the basic auth credentials to use."

fn spec.forProvider.alertmanager.withDisableResolveMessage

withDisableResolveMessage(disableResolveMessage)

"(Boolean) Whether to disable sending resolve messages. Defaults to false.\nWhether to disable sending resolve messages. Defaults to false."

fn spec.forProvider.alertmanager.withUrl

withUrl(url)

"(String) The URL of the Alertmanager instance.\nThe URL of the Alertmanager instance."

obj spec.forProvider.alertmanager.basicAuthPasswordSecretRef

"(String, Sensitive) The password component of the basic auth credentials to use.\nThe password component of the basic auth credentials to use."

fn spec.forProvider.alertmanager.basicAuthPasswordSecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.alertmanager.basicAuthPasswordSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.alertmanager.basicAuthPasswordSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.alertmanager.settingsSecretRef

"(Map of String, Sensitive) Additional custom properties to attach to the notifier. Defaults to map[].\nAdditional custom properties to attach to the notifier. Defaults to map[]."

fn spec.forProvider.alertmanager.settingsSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.alertmanager.settingsSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.dingding

"(Block Set) A contact point that sends notifications to DingDing. (see below for nested schema)\nA contact point that sends notifications to DingDing."

fn spec.forProvider.dingding.withDisableResolveMessage

withDisableResolveMessage(disableResolveMessage)

"(Boolean) Whether to disable sending resolve messages. Defaults to false.\nWhether to disable sending resolve messages. Defaults to false."

fn spec.forProvider.dingding.withMessage

withMessage(message)

"(String) The templated content of the message.\nThe templated content of the message."

fn spec.forProvider.dingding.withMessageType

withMessageType(messageType)

"either 'link' or 'actionCard'\nThe format of message to send - either 'link' or 'actionCard'"

fn spec.forProvider.dingding.withTitle

withTitle(title)

"(String) The templated title of the message.\nThe templated title of the message."

fn spec.forProvider.dingding.withUrl

withUrl(url)

"(String) The URL of the Alertmanager instance.\nThe DingDing webhook URL."

obj spec.forProvider.dingding.settingsSecretRef

"(Map of String, Sensitive) Additional custom properties to attach to the notifier. Defaults to map[].\nAdditional custom properties to attach to the notifier. Defaults to map[]."

fn spec.forProvider.dingding.settingsSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.dingding.settingsSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.discord

"(Block Set) A contact point that sends notifications as Discord messages (see below for nested schema)\nA contact point that sends notifications as Discord messages"

fn spec.forProvider.discord.withAvatarUrl

withAvatarUrl(avatarUrl)

"(String) The URL of a custom avatar image to use. Defaults to “.\nThe URL of a custom avatar image to use. Defaults to “."

fn spec.forProvider.discord.withDisableResolveMessage

withDisableResolveMessage(disableResolveMessage)

"(Boolean) Whether to disable sending resolve messages. Defaults to false.\nWhether to disable sending resolve messages. Defaults to false."

fn spec.forProvider.discord.withMessage

withMessage(message)

"(String) The templated content of the message.\nThe templated content of the message. Defaults to “."

fn spec.forProvider.discord.withTitle

withTitle(title)

"(String) The templated title of the message.\nThe templated content of the title."

fn spec.forProvider.discord.withUseDiscordUsername

withUseDiscordUsername(useDiscordUsername)

"(Boolean) Whether to use the bot account's plain username instead of \"Grafana.\" Defaults to false.\nWhether to use the bot account's plain username instead of \"Grafana.\" Defaults to false."

obj spec.forProvider.discord.settingsSecretRef

"(Map of String, Sensitive) Additional custom properties to attach to the notifier. Defaults to map[].\nAdditional custom properties to attach to the notifier. Defaults to map[]."

fn spec.forProvider.discord.settingsSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.discord.settingsSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.discord.urlSecretRef

"(String) The URL of the Alertmanager instance.\nThe discord webhook URL."

fn spec.forProvider.discord.urlSecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.discord.urlSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.discord.urlSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.email

"(Block Set) A contact point that sends notifications to an email address. (see below for nested schema)\nA contact point that sends notifications to an email address."

fn spec.forProvider.email.withAddresses

withAddresses(addresses)

"(List of String) The addresses to send emails to.\nThe addresses to send emails to."

fn spec.forProvider.email.withAddressesMixin

withAddressesMixin(addresses)

"(List of String) The addresses to send emails to.\nThe addresses to send emails to."

Note: This function appends passed data to existing values

fn spec.forProvider.email.withDisableResolveMessage

withDisableResolveMessage(disableResolveMessage)

"(Boolean) Whether to disable sending resolve messages. Defaults to false.\nWhether to disable sending resolve messages. Defaults to false."

fn spec.forProvider.email.withMessage

withMessage(message)

"(String) The templated content of the message.\nThe templated content of the email. Defaults to “."

fn spec.forProvider.email.withSingleEmail

withSingleEmail(singleEmail)

"(Boolean) Whether to send a single email CC'ing all addresses, rather than a separate email to each address. Defaults to false.\nWhether to send a single email CC'ing all addresses, rather than a separate email to each address. Defaults to false."

fn spec.forProvider.email.withSubject

withSubject(subject)

"(String) The templated subject line of the email. Defaults to “.\nThe templated subject line of the email. Defaults to “."

obj spec.forProvider.email.settingsSecretRef

"(Map of String, Sensitive) Additional custom properties to attach to the notifier. Defaults to map[].\nAdditional custom properties to attach to the notifier. Defaults to map[]."

fn spec.forProvider.email.settingsSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.email.settingsSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.googlechat

"(Block Set) A contact point that sends notifications to Google Chat. (see below for nested schema)\nA contact point that sends notifications to Google Chat."

fn spec.forProvider.googlechat.withDisableResolveMessage

withDisableResolveMessage(disableResolveMessage)

"(Boolean) Whether to disable sending resolve messages. Defaults to false.\nWhether to disable sending resolve messages. Defaults to false."

fn spec.forProvider.googlechat.withMessage

withMessage(message)

"(String) The templated content of the message.\nThe templated content of the message."

fn spec.forProvider.googlechat.withTitle

withTitle(title)

"(String) The templated title of the message.\nThe templated content of the title."

obj spec.forProvider.googlechat.settingsSecretRef

"(Map of String, Sensitive) Additional custom properties to attach to the notifier. Defaults to map[].\nAdditional custom properties to attach to the notifier. Defaults to map[]."

fn spec.forProvider.googlechat.settingsSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.googlechat.settingsSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.googlechat.urlSecretRef

"(String) The URL of the Alertmanager instance.\nThe Google Chat webhook URL."

fn spec.forProvider.googlechat.urlSecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.googlechat.urlSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.googlechat.urlSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.kafka

"(Block Set) A contact point that publishes notifications to Apache Kafka topics. (see below for nested schema)\nA contact point that publishes notifications to Apache Kafka topics."

fn spec.forProvider.kafka.withApiVersion

withApiVersion(apiVersion)

"(String) The API version to use when contacting the Kafka REST Server. Supported: v2 (default) and v3. Defaults to v2.\nThe API version to use when contacting the Kafka REST Server. Supported: v2 (default) and v3. Defaults to v2."

fn spec.forProvider.kafka.withClusterId

withClusterId(clusterId)

"(String) The Id of cluster to use when contacting the Kafka REST Server. Required api_version to be 'v3'\nThe Id of cluster to use when contacting the Kafka REST Server. Required api_version to be 'v3'"

fn spec.forProvider.kafka.withDescription

withDescription(description)

"(String) The templated description of the Kafka message.\nThe templated description of the Kafka message."

fn spec.forProvider.kafka.withDetails

withDetails(details)

"(String) The templated details to include with the message.\nThe templated details to include with the message."

fn spec.forProvider.kafka.withDisableResolveMessage

withDisableResolveMessage(disableResolveMessage)

"(Boolean) Whether to disable sending resolve messages. Defaults to false.\nWhether to disable sending resolve messages. Defaults to false."

fn spec.forProvider.kafka.withTopic

withTopic(topic)

"(String) The name of the Kafka topic to publish to.\nThe name of the Kafka topic to publish to."

fn spec.forProvider.kafka.withUsername

withUsername(username)

"(String) The user name to use when making a call to the Kafka REST Proxy\nThe user name to use when making a call to the Kafka REST Proxy"

obj spec.forProvider.kafka.passwordSecretRef

"(String, Sensitive) The password to use when making a call to the Kafka REST Proxy\nThe password to use when making a call to the Kafka REST Proxy"

fn spec.forProvider.kafka.passwordSecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.kafka.passwordSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.kafka.passwordSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.kafka.restProxyUrlSecretRef

"(String, Sensitive) The URL of the Kafka REST proxy to send requests to.\nThe URL of the Kafka REST proxy to send requests to."

fn spec.forProvider.kafka.restProxyUrlSecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.kafka.restProxyUrlSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.kafka.restProxyUrlSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.kafka.settingsSecretRef

"(Map of String, Sensitive) Additional custom properties to attach to the notifier. Defaults to map[].\nAdditional custom properties to attach to the notifier. Defaults to map[]."

fn spec.forProvider.kafka.settingsSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.kafka.settingsSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.line

"(Block Set) A contact point that sends notifications to LINE.me. (see below for nested schema)\nA contact point that sends notifications to LINE.me."

fn spec.forProvider.line.withDescription

withDescription(description)

"(String) The templated description of the Kafka message.\nThe templated description of the message."

fn spec.forProvider.line.withDisableResolveMessage

withDisableResolveMessage(disableResolveMessage)

"(Boolean) Whether to disable sending resolve messages. Defaults to false.\nWhether to disable sending resolve messages. Defaults to false."

fn spec.forProvider.line.withTitle

withTitle(title)

"(String) The templated title of the message.\nThe templated title of the message."

obj spec.forProvider.line.settingsSecretRef

"(Map of String, Sensitive) Additional custom properties to attach to the notifier. Defaults to map[].\nAdditional custom properties to attach to the notifier. Defaults to map[]."

fn spec.forProvider.line.settingsSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.line.settingsSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.line.tokenSecretRef

"(String, Sensitive) The bearer token used to authorize the client.\nThe bearer token used to authorize the client."

fn spec.forProvider.line.tokenSecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.line.tokenSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.line.tokenSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.oncall

"Call. (see below for nested schema)\nA contact point that sends notifications to Grafana On-Call."

fn spec.forProvider.oncall.withAuthorizationScheme

withAuthorizationScheme(authorizationScheme)

"attaches an auth header with this name. Do not use in conjunction with basic auth parameters.\nAllows a custom authorization scheme - attaches an auth header with this name. Do not use in conjunction with basic auth parameters."

fn spec.forProvider.oncall.withBasicAuthUser

withBasicAuthUser(basicAuthUser)

"(String) The username component of the basic auth credentials to use.\nThe username to use in basic auth headers attached to the request. If omitted, basic auth will not be used."

fn spec.forProvider.oncall.withDisableResolveMessage

withDisableResolveMessage(disableResolveMessage)

"(Boolean) Whether to disable sending resolve messages. Defaults to false.\nWhether to disable sending resolve messages. Defaults to false."

fn spec.forProvider.oncall.withHttpMethod

withHttpMethod(httpMethod)

"(String) The HTTP method to use in the request. Defaults to POST.\nThe HTTP method to use in the request. Defaults to POST."

fn spec.forProvider.oncall.withMaxAlerts

withMaxAlerts(maxAlerts)

"(Number) The maximum number of alerts to send in a single request. This can be helpful in limiting the size of the request body. The default is 0, which indicates no limit.\nThe maximum number of alerts to send in a single request. This can be helpful in limiting the size of the request body. The default is 0, which indicates no limit."

fn spec.forProvider.oncall.withMessage

withMessage(message)

"(String) The templated content of the message.\nCustom message. You can use template variables."

fn spec.forProvider.oncall.withTitle

withTitle(title)

"(String) The templated title of the message.\nTemplated title of the message."

fn spec.forProvider.oncall.withUrl

withUrl(url)

"(String) The URL of the Alertmanager instance.\nThe URL to send webhook requests to."

obj spec.forProvider.oncall.authorizationCredentialsSecretRef

"attaches an auth header with this value. Do not use in conjunction with basic auth parameters.\nAllows a custom authorization scheme - attaches an auth header with this value. Do not use in conjunction with basic auth parameters."

fn spec.forProvider.oncall.authorizationCredentialsSecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.oncall.authorizationCredentialsSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.oncall.authorizationCredentialsSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.oncall.basicAuthPasswordSecretRef

"(String, Sensitive) The password component of the basic auth credentials to use.\nThe username to use in basic auth headers attached to the request. If omitted, basic auth will not be used."

fn spec.forProvider.oncall.basicAuthPasswordSecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.oncall.basicAuthPasswordSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.oncall.basicAuthPasswordSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.oncall.settingsSecretRef

"(Map of String, Sensitive) Additional custom properties to attach to the notifier. Defaults to map[].\nAdditional custom properties to attach to the notifier. Defaults to map[]."

fn spec.forProvider.oncall.settingsSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.oncall.settingsSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.opsgenie

"(Block Set) A contact point that sends notifications to OpsGenie. (see below for nested schema)\nA contact point that sends notifications to OpsGenie."

fn spec.forProvider.opsgenie.withAutoClose

withAutoClose(autoClose)

"close alerts in OpsGenie when they resolve in the Alertmanager.\nWhether to auto-close alerts in OpsGenie when they resolve in the Alertmanager."

fn spec.forProvider.opsgenie.withDescription

withDescription(description)

"(String) The templated description of the Kafka message.\nA templated high-level description to use for the alert."

fn spec.forProvider.opsgenie.withDisableResolveMessage

withDisableResolveMessage(disableResolveMessage)

"(Boolean) Whether to disable sending resolve messages. Defaults to false.\nWhether to disable sending resolve messages. Defaults to false."

fn spec.forProvider.opsgenie.withMessage

withMessage(message)

"(String) The templated content of the message.\nThe templated content of the message."

fn spec.forProvider.opsgenie.withOverridePriority

withOverridePriority(overridePriority)

"(Boolean) Whether to allow the alert priority to be configured via the value of the og_priority annotation on the alert.\nWhether to allow the alert priority to be configured via the value of the og_priority annotation on the alert."

fn spec.forProvider.opsgenie.withResponders

withResponders(responders)

"(Block List) Teams, users, escalations and schedules that the alert will be routed to send notifications. If the API Key belongs to a team integration, this field will be overwritten with the owner team. This feature is available from Grafana 10.3+. (see below for nested schema)\nTeams, users, escalations and schedules that the alert will be routed to send notifications. If the API Key belongs to a team integration, this field will be overwritten with the owner team. This feature is available from Grafana 10.3+."

fn spec.forProvider.opsgenie.withRespondersMixin

withRespondersMixin(responders)

"(Block List) Teams, users, escalations and schedules that the alert will be routed to send notifications. If the API Key belongs to a team integration, this field will be overwritten with the owner team. This feature is available from Grafana 10.3+. (see below for nested schema)\nTeams, users, escalations and schedules that the alert will be routed to send notifications. If the API Key belongs to a team integration, this field will be overwritten with the owner team. This feature is available from Grafana 10.3+."

Note: This function appends passed data to existing values

fn spec.forProvider.opsgenie.withSendTagsAs

withSendTagsAs(sendTagsAs)

"(String) Whether to send annotations to OpsGenie as Tags, Details, or both. Supported values are tags, details, both, or empty to use the default behavior of Tags.\nWhether to send annotations to OpsGenie as Tags, Details, or both. Supported values are tags, details, both, or empty to use the default behavior of Tags."

fn spec.forProvider.opsgenie.withUrl

withUrl(url)

"(String) The URL of the Alertmanager instance.\nAllows customization of the OpsGenie API URL."

obj spec.forProvider.opsgenie.apiKeySecretRef

"(String, Sensitive) The OpsGenie API key to use.\nThe OpsGenie API key to use."

fn spec.forProvider.opsgenie.apiKeySecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.opsgenie.apiKeySecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.opsgenie.apiKeySecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.opsgenie.responders

"(Block List) Teams, users, escalations and schedules that the alert will be routed to send notifications. If the API Key belongs to a team integration, this field will be overwritten with the owner team. This feature is available from Grafana 10.3+. (see below for nested schema)\nTeams, users, escalations and schedules that the alert will be routed to send notifications. If the API Key belongs to a team integration, this field will be overwritten with the owner team. This feature is available from Grafana 10.3+."

fn spec.forProvider.opsgenie.responders.withId

withId(id)

"(String) The ID of this resource.\nID of the responder. Must be specified if name and username are empty."

fn spec.forProvider.opsgenie.responders.withName

withName(name)

"(String) The name of the contact point.\nName of the responder. Must be specified if username and id are empty."

fn spec.forProvider.opsgenie.responders.withType

withType(type)

"(String) Type of the responder. Supported: team, teams, user, escalation, schedule or a template that is expanded to one of these values.\nType of the responder. Supported: team, teams, user, escalation, schedule or a template that is expanded to one of these values."

fn spec.forProvider.opsgenie.responders.withUsername

withUsername(username)

"(String) The user name to use when making a call to the Kafka REST Proxy\nUser name of the responder. Must be specified if name and id are empty."

obj spec.forProvider.opsgenie.settingsSecretRef

"(Map of String, Sensitive) Additional custom properties to attach to the notifier. Defaults to map[].\nAdditional custom properties to attach to the notifier. Defaults to map[]."

fn spec.forProvider.opsgenie.settingsSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.opsgenie.settingsSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.organizationRef

"Reference to a Organization in oss to populate orgId."

fn spec.forProvider.organizationRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.organizationRef.policy

"Policies for referencing."

fn spec.forProvider.organizationRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required.\nThe default is 'Required', which means the reconcile will fail if the\nreference cannot be resolved. 'Optional' means this reference will be\na no-op if it cannot be resolved."

fn spec.forProvider.organizationRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default\nis 'IfNotPresent', which will attempt to resolve the reference only when\nthe corresponding field is not present. Use 'Always' to resolve the\nreference on every reconcile."

obj spec.forProvider.organizationSelector

"Selector for a Organization in oss to populate orgId."

fn spec.forProvider.organizationSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

"MatchControllerRef ensures an object with the same controller reference\nas the selecting object is selected."

fn spec.forProvider.organizationSelector.withMatchLabels

withMatchLabels(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

fn spec.forProvider.organizationSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

Note: This function appends passed data to existing values

obj spec.forProvider.organizationSelector.policy

"Policies for selection."

fn spec.forProvider.organizationSelector.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required.\nThe default is 'Required', which means the reconcile will fail if the\nreference cannot be resolved. 'Optional' means this reference will be\na no-op if it cannot be resolved."

fn spec.forProvider.organizationSelector.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default\nis 'IfNotPresent', which will attempt to resolve the reference only when\nthe corresponding field is not present. Use 'Always' to resolve the\nreference on every reconcile."

obj spec.forProvider.pagerduty

"(Block Set) A contact point that sends notifications to PagerDuty. (see below for nested schema)\nA contact point that sends notifications to PagerDuty."

fn spec.forProvider.pagerduty.withClass

withClass(class)

"(String) The class or type of event, for example ping failure.\nThe class or type of event, for example ping failure."

fn spec.forProvider.pagerduty.withClient

withClient(client)

"(String) The name of the monitoring client that is triggering this event.\nThe name of the monitoring client that is triggering this event."

fn spec.forProvider.pagerduty.withClientUrl

withClientUrl(clientUrl)

"(String) The URL of the monitoring client that is triggering this event.\nThe URL of the monitoring client that is triggering this event."

fn spec.forProvider.pagerduty.withComponent

withComponent(component)

"(String) The component being affected by the event.\nThe component being affected by the event."

fn spec.forProvider.pagerduty.withDetails

withDetails(details)

"(String) The templated details to include with the message.\nA set of arbitrary key/value pairs that provide further detail about the incident."

fn spec.forProvider.pagerduty.withDetailsMixin

withDetailsMixin(details)

"(String) The templated details to include with the message.\nA set of arbitrary key/value pairs that provide further detail about the incident."

Note: This function appends passed data to existing values

fn spec.forProvider.pagerduty.withDisableResolveMessage

withDisableResolveMessage(disableResolveMessage)

"(Boolean) Whether to disable sending resolve messages. Defaults to false.\nWhether to disable sending resolve messages. Defaults to false."

fn spec.forProvider.pagerduty.withGroup

withGroup(group)

"(String) The group to which the provided component belongs to.\nThe group to which the provided component belongs to."

fn spec.forProvider.pagerduty.withSeverity

withSeverity(severity)

"(String) The PagerDuty event severity level. Default is critical.\nThe PagerDuty event severity level. Default is critical."

fn spec.forProvider.pagerduty.withSource

withSource(source)

"(String) The unique location of the affected system.\nThe unique location of the affected system."

fn spec.forProvider.pagerduty.withSummary

withSummary(summary)

"(String) The templated summary message of the event.\nThe templated summary message of the event."

obj spec.forProvider.pagerduty.integrationKeySecretRef

"(String, Sensitive) The PagerDuty API key.\nThe PagerDuty API key."

fn spec.forProvider.pagerduty.integrationKeySecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.pagerduty.integrationKeySecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.pagerduty.integrationKeySecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.pagerduty.settingsSecretRef

"(Map of String, Sensitive) Additional custom properties to attach to the notifier. Defaults to map[].\nAdditional custom properties to attach to the notifier. Defaults to map[]."

fn spec.forProvider.pagerduty.settingsSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.pagerduty.settingsSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.pushover

"(Block Set) A contact point that sends notifications to Pushover. (see below for nested schema)\nA contact point that sends notifications to Pushover."

fn spec.forProvider.pushover.withDevice

withDevice(device)

"separated list of devices to which the event is associated.\nComma-separated list of devices to which the event is associated."

fn spec.forProvider.pushover.withDisableResolveMessage

withDisableResolveMessage(disableResolveMessage)

"(Boolean) Whether to disable sending resolve messages. Defaults to false.\nWhether to disable sending resolve messages. Defaults to false."

fn spec.forProvider.pushover.withExpire

withExpire(expire)

"(Number) How many seconds for which the notification will continue to be retried by Pushover.\nHow many seconds for which the notification will continue to be retried by Pushover."

fn spec.forProvider.pushover.withMessage

withMessage(message)

"(String) The templated content of the message.\nThe templated notification message content."

fn spec.forProvider.pushover.withOkPriority

withOkPriority(okPriority)

"(Number) The priority level of the resolved event.\nThe priority level of the resolved event."

fn spec.forProvider.pushover.withOkSound

withOkSound(okSound)

"(String) The sound associated with the resolved notification.\nThe sound associated with the resolved notification."

fn spec.forProvider.pushover.withPriority

withPriority(priority)

"(Number) The priority level of the event.\nThe priority level of the event."

fn spec.forProvider.pushover.withRetry

withRetry(retry)

"(Number) How often, in seconds, the Pushover servers will send the same notification to the user.\nHow often, in seconds, the Pushover servers will send the same notification to the user."

fn spec.forProvider.pushover.withSound

withSound(sound)

"(String) The sound associated with the notification.\nThe sound associated with the notification."

fn spec.forProvider.pushover.withTitle

withTitle(title)

"(String) The templated title of the message.\nThe templated title of the message."

fn spec.forProvider.pushover.withUploadImage

withUploadImage(uploadImage)

"(Boolean) Whether to send images in the notification or not. Default is true. Requires Grafana to be configured to send images in notifications.\nWhether to send images in the notification or not. Default is true. Requires Grafana to be configured to send images in notifications."

obj spec.forProvider.pushover.apiTokenSecretRef

"(String, Sensitive) The Pushover API token.\nThe Pushover API token."

fn spec.forProvider.pushover.apiTokenSecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.pushover.apiTokenSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.pushover.apiTokenSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.pushover.settingsSecretRef

"(Map of String, Sensitive) Additional custom properties to attach to the notifier. Defaults to map[].\nAdditional custom properties to attach to the notifier. Defaults to map[]."

fn spec.forProvider.pushover.settingsSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.pushover.settingsSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.pushover.userKeySecretRef

"(String, Sensitive) The Pushover user key.\nThe Pushover user key."

fn spec.forProvider.pushover.userKeySecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.pushover.userKeySecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.pushover.userKeySecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.sensugo

"(Block Set) A contact point that sends notifications to SensuGo. (see below for nested schema)\nA contact point that sends notifications to SensuGo."

fn spec.forProvider.sensugo.withCheck

withCheck(check)

"(String) The SensuGo check to which the event should be routed.\nThe SensuGo check to which the event should be routed."

fn spec.forProvider.sensugo.withDisableResolveMessage

withDisableResolveMessage(disableResolveMessage)

"(Boolean) Whether to disable sending resolve messages. Defaults to false.\nWhether to disable sending resolve messages. Defaults to false."

fn spec.forProvider.sensugo.withEntity

withEntity(entity)

"(String) The entity being monitored.\nThe entity being monitored."

fn spec.forProvider.sensugo.withHandler

withHandler(handler)

"(String) A custom handler to execute in addition to the check.\nA custom handler to execute in addition to the check."

fn spec.forProvider.sensugo.withMessage

withMessage(message)

"(String) The templated content of the message.\nTemplated message content describing the alert."

fn spec.forProvider.sensugo.withNamespace

withNamespace(namespace)

"(String) The namespace in which the check resides.\nThe namespace in which the check resides."

fn spec.forProvider.sensugo.withUrl

withUrl(url)

"(String) The URL of the Alertmanager instance.\nThe SensuGo URL to send requests to."

obj spec.forProvider.sensugo.apiKeySecretRef

"(String, Sensitive) The OpsGenie API key to use.\nThe SensuGo API key."

fn spec.forProvider.sensugo.apiKeySecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.sensugo.apiKeySecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.sensugo.apiKeySecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.sensugo.settingsSecretRef

"(Map of String, Sensitive) Additional custom properties to attach to the notifier. Defaults to map[].\nAdditional custom properties to attach to the notifier. Defaults to map[]."

fn spec.forProvider.sensugo.settingsSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.sensugo.settingsSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.slack

"(Block Set) A contact point that sends notifications to Slack. (see below for nested schema)\nA contact point that sends notifications to Slack."

fn spec.forProvider.slack.withDisableResolveMessage

withDisableResolveMessage(disableResolveMessage)

"(Boolean) Whether to disable sending resolve messages. Defaults to false.\nWhether to disable sending resolve messages. Defaults to false."

fn spec.forProvider.slack.withEndpointUrl

withEndpointUrl(endpointUrl)

"(String) Use this to override the Slack API endpoint URL to send requests to.\nUse this to override the Slack API endpoint URL to send requests to."

fn spec.forProvider.slack.withIconEmoji

withIconEmoji(iconEmoji)

"(String) The name of a Slack workspace emoji to use as the bot icon.\nThe name of a Slack workspace emoji to use as the bot icon."

fn spec.forProvider.slack.withIconUrl

withIconUrl(iconUrl)

"(String) A URL of an image to use as the bot icon.\nA URL of an image to use as the bot icon."

fn spec.forProvider.slack.withMentionChannel

withMentionChannel(mentionChannel)

"(String) Describes how to ping the slack channel that messages are being sent to. Options are here for an @here ping, channel for @channel, or empty for no ping.\nDescribes how to ping the slack channel that messages are being sent to. Options are here for an @here ping, channel for @channel, or empty for no ping."

fn spec.forProvider.slack.withMentionGroups

withMentionGroups(mentionGroups)

"separated list of groups to mention in the message.\nComma-separated list of groups to mention in the message."

fn spec.forProvider.slack.withMentionUsers

withMentionUsers(mentionUsers)

"separated list of users to mention in the message.\nComma-separated list of users to mention in the message."

fn spec.forProvider.slack.withRecipient

withRecipient(recipient)

"(String) Channel, private group, or IM channel (can be an encoded ID or a name) to send messages to.\nChannel, private group, or IM channel (can be an encoded ID or a name) to send messages to."

fn spec.forProvider.slack.withText

withText(text)

"(String) Templated content of the message.\nTemplated content of the message."

fn spec.forProvider.slack.withTitle

withTitle(title)

"(String) The templated title of the message.\nTemplated title of the message."

fn spec.forProvider.slack.withUsername

withUsername(username)

"(String) The user name to use when making a call to the Kafka REST Proxy\nUsername for the bot to use."

obj spec.forProvider.slack.settingsSecretRef

"(Map of String, Sensitive) Additional custom properties to attach to the notifier. Defaults to map[].\nAdditional custom properties to attach to the notifier. Defaults to map[]."

fn spec.forProvider.slack.settingsSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.slack.settingsSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.slack.tokenSecretRef

"(String, Sensitive) The bearer token used to authorize the client.\nA Slack API token,for sending messages directly without the webhook method."

fn spec.forProvider.slack.tokenSecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.slack.tokenSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.slack.tokenSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.slack.urlSecretRef

"(String) The URL of the Alertmanager instance.\nA Slack webhook URL,for sending messages via the webhook method."

fn spec.forProvider.slack.urlSecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.slack.urlSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.slack.urlSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.sns

"(Block Set) A contact point that sends notifications to Amazon SNS. Requires Amazon Managed Grafana. (see below for nested schema)\nA contact point that sends notifications to Amazon SNS. Requires Amazon Managed Grafana."

fn spec.forProvider.sns.withAssumeRoleArn

withAssumeRoleArn(assumeRoleArn)

"(String) The Amazon Resource Name (ARN) of the role to assume to send notifications to Amazon SNS.\nThe Amazon Resource Name (ARN) of the role to assume to send notifications to Amazon SNS."

fn spec.forProvider.sns.withAuthProvider

withAuthProvider(authProvider)

"(String) The authentication provider to use. Valid values are default, arn and keys. Default is default. Defaults to default.\nThe authentication provider to use. Valid values are default, arn and keys. Default is default. Defaults to default."

fn spec.forProvider.sns.withBody

withBody(body)

"(String)"

fn spec.forProvider.sns.withDisableResolveMessage

withDisableResolveMessage(disableResolveMessage)

"(Boolean) Whether to disable sending resolve messages. Defaults to false.\nWhether to disable sending resolve messages. Defaults to false."

fn spec.forProvider.sns.withExternalId

withExternalId(externalId)

"(String) The external ID to use when assuming the role.\nThe external ID to use when assuming the role."

fn spec.forProvider.sns.withMessageFormat

withMessageFormat(messageFormat)

"(String) The format of the message to send. Valid values are text, body and json. Default is text. Defaults to text.\nThe format of the message to send. Valid values are text, body and json. Default is text. Defaults to text."

fn spec.forProvider.sns.withSubject

withSubject(subject)

"(String) The templated subject line of the email. Defaults to “."

fn spec.forProvider.sns.withTopic

withTopic(topic)

"(String) The name of the Kafka topic to publish to.\nThe Amazon SNS topic to send notifications to."

obj spec.forProvider.sns.accessKeySecretRef

"(String, Sensitive) AWS access key ID used to authenticate with Amazon SNS.\nAWS access key ID used to authenticate with Amazon SNS."

fn spec.forProvider.sns.accessKeySecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.sns.accessKeySecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.sns.accessKeySecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.sns.secretKeySecretRef

"(String, Sensitive) AWS secret access key used to authenticate with Amazon SNS.\nAWS secret access key used to authenticate with Amazon SNS."

fn spec.forProvider.sns.secretKeySecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.sns.secretKeySecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.sns.secretKeySecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.sns.settingsSecretRef

"(Map of String, Sensitive) Additional custom properties to attach to the notifier. Defaults to map[].\nAdditional custom properties to attach to the notifier. Defaults to map[]."

fn spec.forProvider.sns.settingsSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.sns.settingsSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.teams

"(Block Set) A contact point that sends notifications to Microsoft Teams. (see below for nested schema)\nA contact point that sends notifications to Microsoft Teams."

fn spec.forProvider.teams.withDisableResolveMessage

withDisableResolveMessage(disableResolveMessage)

"(Boolean) Whether to disable sending resolve messages. Defaults to false.\nWhether to disable sending resolve messages. Defaults to false."

fn spec.forProvider.teams.withMessage

withMessage(message)

"(String) The templated content of the message.\nThe templated message content to send."

fn spec.forProvider.teams.withSectionTitle

withSectionTitle(sectionTitle)

"(String) The templated subtitle for each message section.\nThe templated subtitle for each message section."

fn spec.forProvider.teams.withTitle

withTitle(title)

"(String) The templated title of the message.\nThe templated title of the message."

obj spec.forProvider.teams.settingsSecretRef

"(Map of String, Sensitive) Additional custom properties to attach to the notifier. Defaults to map[].\nAdditional custom properties to attach to the notifier. Defaults to map[]."

fn spec.forProvider.teams.settingsSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.teams.settingsSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.teams.urlSecretRef

"(String) The URL of the Alertmanager instance.\nA Teams webhook URL."

fn spec.forProvider.teams.urlSecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.teams.urlSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.teams.urlSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.telegram

"(Block Set) A contact point that sends notifications to Telegram. (see below for nested schema)\nA contact point that sends notifications to Telegram."

fn spec.forProvider.telegram.withChatId

withChatId(chatId)

"(String) The chat ID to send messages to.\nThe chat ID to send messages to."

fn spec.forProvider.telegram.withDisableNotifications

withDisableNotifications(disableNotifications)

"(Boolean) When set users will receive a notification with no sound.\nWhen set users will receive a notification with no sound."

fn spec.forProvider.telegram.withDisableResolveMessage

withDisableResolveMessage(disableResolveMessage)

"(Boolean) Whether to disable sending resolve messages. Defaults to false.\nWhether to disable sending resolve messages. Defaults to false."

fn spec.forProvider.telegram.withDisableWebPagePreview

withDisableWebPagePreview(disableWebPagePreview)

"(Boolean) When set it disables link previews for links in the message.\nWhen set it disables link previews for links in the message."

fn spec.forProvider.telegram.withMessage

withMessage(message)

"(String) The templated content of the message.\nThe templated content of the message."

fn spec.forProvider.telegram.withParseMode

withParseMode(parseMode)

"(String) Mode for parsing entities in the message text. Supported: None, Markdown, MarkdownV2, and HTML. HTML is the default.\nMode for parsing entities in the message text. Supported: None, Markdown, MarkdownV2, and HTML. HTML is the default."

fn spec.forProvider.telegram.withProtectContent

withProtectContent(protectContent)

"(Boolean) When set it protects the contents of the message from forwarding and saving.\nWhen set it protects the contents of the message from forwarding and saving."

obj spec.forProvider.telegram.settingsSecretRef

"(Map of String, Sensitive) Additional custom properties to attach to the notifier. Defaults to map[].\nAdditional custom properties to attach to the notifier. Defaults to map[]."

fn spec.forProvider.telegram.settingsSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.telegram.settingsSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.telegram.tokenSecretRef

"(String, Sensitive) The bearer token used to authorize the client.\nThe Telegram bot token."

fn spec.forProvider.telegram.tokenSecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.telegram.tokenSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.telegram.tokenSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.threema

"(Block Set) A contact point that sends notifications to Threema. (see below for nested schema)\nA contact point that sends notifications to Threema."

fn spec.forProvider.threema.withDescription

withDescription(description)

"(String) The templated description of the Kafka message.\nThe templated description of the message."

fn spec.forProvider.threema.withDisableResolveMessage

withDisableResolveMessage(disableResolveMessage)

"(Boolean) Whether to disable sending resolve messages. Defaults to false.\nWhether to disable sending resolve messages. Defaults to false."

fn spec.forProvider.threema.withGatewayId

withGatewayId(gatewayId)

"(String) The Threema gateway ID.\nThe Threema gateway ID."

fn spec.forProvider.threema.withRecipientId

withRecipientId(recipientId)

"(String) The ID of the recipient of the message.\nThe ID of the recipient of the message."

fn spec.forProvider.threema.withTitle

withTitle(title)

"(String) The templated title of the message.\nThe templated title of the message."

obj spec.forProvider.threema.apiSecretSecretRef

"(String, Sensitive) The Threema API key.\nThe Threema API key."

fn spec.forProvider.threema.apiSecretSecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.threema.apiSecretSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.threema.apiSecretSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.threema.settingsSecretRef

"(Map of String, Sensitive) Additional custom properties to attach to the notifier. Defaults to map[].\nAdditional custom properties to attach to the notifier. Defaults to map[]."

fn spec.forProvider.threema.settingsSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.threema.settingsSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.victorops

"(Block Set) A contact point that sends notifications to VictorOps (now known as Splunk OnCall). (see below for nested schema)\nA contact point that sends notifications to VictorOps (now known as Splunk OnCall)."

fn spec.forProvider.victorops.withDescription

withDescription(description)

"(String) The templated description of the Kafka message.\nTemplated description of the message."

fn spec.forProvider.victorops.withDisableResolveMessage

withDisableResolveMessage(disableResolveMessage)

"(Boolean) Whether to disable sending resolve messages. Defaults to false.\nWhether to disable sending resolve messages. Defaults to false."

fn spec.forProvider.victorops.withMessageType

withMessageType(messageType)

"either 'link' or 'actionCard'\nThe VictorOps alert state - typically either CRITICAL or RECOVERY."

fn spec.forProvider.victorops.withTitle

withTitle(title)

"(String) The templated title of the message.\nTemplated title to display."

fn spec.forProvider.victorops.withUrl

withUrl(url)

"(String) The URL of the Alertmanager instance.\nThe VictorOps webhook URL."

obj spec.forProvider.victorops.settingsSecretRef

"(Map of String, Sensitive) Additional custom properties to attach to the notifier. Defaults to map[].\nAdditional custom properties to attach to the notifier. Defaults to map[]."

fn spec.forProvider.victorops.settingsSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.victorops.settingsSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.webex

"(Block Set) A contact point that sends notifications to Cisco Webex. (see below for nested schema)\nA contact point that sends notifications to Cisco Webex."

fn spec.forProvider.webex.withApiUrl

withApiUrl(apiUrl)

"(String) The URL to send webhook requests to.\nThe URL to send webhook requests to."

fn spec.forProvider.webex.withDisableResolveMessage

withDisableResolveMessage(disableResolveMessage)

"(Boolean) Whether to disable sending resolve messages. Defaults to false.\nWhether to disable sending resolve messages. Defaults to false."

fn spec.forProvider.webex.withMessage

withMessage(message)

"(String) The templated content of the message.\nThe templated title of the message to send."

fn spec.forProvider.webex.withRoomId

withRoomId(roomId)

"(String) ID of the Webex Teams room where to send the messages.\nID of the Webex Teams room where to send the messages."

obj spec.forProvider.webex.settingsSecretRef

"(Map of String, Sensitive) Additional custom properties to attach to the notifier. Defaults to map[].\nAdditional custom properties to attach to the notifier. Defaults to map[]."

fn spec.forProvider.webex.settingsSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.webex.settingsSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.webex.tokenSecretRef

"(String, Sensitive) The bearer token used to authorize the client.\nThe bearer token used to authorize the client."

fn spec.forProvider.webex.tokenSecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.webex.tokenSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.webex.tokenSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.webhook

"(Block Set) A contact point that sends notifications to an arbitrary webhook, using the Prometheus webhook format defined here: https://prometheus.io/docs/alerting/latest/configuration/#webhook_config (see below for nested schema)\nA contact point that sends notifications to an arbitrary webhook, using the Prometheus webhook format defined here: https://prometheus.io/docs/alerting/latest/configuration/#webhook_config"

fn spec.forProvider.webhook.withAuthorizationScheme

withAuthorizationScheme(authorizationScheme)

"attaches an auth header with this name. Do not use in conjunction with basic auth parameters.\nAllows a custom authorization scheme - attaches an auth header with this name. Do not use in conjunction with basic auth parameters."

fn spec.forProvider.webhook.withBasicAuthUser

withBasicAuthUser(basicAuthUser)

"(String) The username component of the basic auth credentials to use.\nThe username to use in basic auth headers attached to the request. If omitted, basic auth will not be used."

fn spec.forProvider.webhook.withDisableResolveMessage

withDisableResolveMessage(disableResolveMessage)

"(Boolean) Whether to disable sending resolve messages. Defaults to false.\nWhether to disable sending resolve messages. Defaults to false."

fn spec.forProvider.webhook.withHttpMethod

withHttpMethod(httpMethod)

"(String) The HTTP method to use in the request. Defaults to POST.\nThe HTTP method to use in the request. Defaults to POST."

fn spec.forProvider.webhook.withMaxAlerts

withMaxAlerts(maxAlerts)

"(Number) The maximum number of alerts to send in a single request. This can be helpful in limiting the size of the request body. The default is 0, which indicates no limit.\nThe maximum number of alerts to send in a single request. This can be helpful in limiting the size of the request body. The default is 0, which indicates no limit."

fn spec.forProvider.webhook.withMessage

withMessage(message)

"(String) The templated content of the message.\nCustom message. You can use template variables."

fn spec.forProvider.webhook.withTitle

withTitle(title)

"(String) The templated title of the message.\nTemplated title of the message."

fn spec.forProvider.webhook.withUrl

withUrl(url)

"(String) The URL of the Alertmanager instance.\nThe URL to send webhook requests to."

obj spec.forProvider.webhook.authorizationCredentialsSecretRef

"attaches an auth header with this value. Do not use in conjunction with basic auth parameters.\nAllows a custom authorization scheme - attaches an auth header with this value. Do not use in conjunction with basic auth parameters."

fn spec.forProvider.webhook.authorizationCredentialsSecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.webhook.authorizationCredentialsSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.webhook.authorizationCredentialsSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.webhook.basicAuthPasswordSecretRef

"(String, Sensitive) The password component of the basic auth credentials to use.\nThe username to use in basic auth headers attached to the request. If omitted, basic auth will not be used."

fn spec.forProvider.webhook.basicAuthPasswordSecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.webhook.basicAuthPasswordSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.webhook.basicAuthPasswordSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.webhook.settingsSecretRef

"(Map of String, Sensitive) Additional custom properties to attach to the notifier. Defaults to map[].\nAdditional custom properties to attach to the notifier. Defaults to map[]."

fn spec.forProvider.webhook.settingsSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.webhook.settingsSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.wecom

"(Block Set) A contact point that sends notifications to WeCom. (see below for nested schema)\nA contact point that sends notifications to WeCom."

fn spec.forProvider.wecom.withAgentId

withAgentId(agentId)

"(String) Agent ID added to the request payload when using APIAPP.\nAgent ID added to the request payload when using APIAPP."

fn spec.forProvider.wecom.withCorpId

withCorpId(corpId)

"(String) Corp ID used to get token when using APIAPP.\nCorp ID used to get token when using APIAPP."

fn spec.forProvider.wecom.withDisableResolveMessage

withDisableResolveMessage(disableResolveMessage)

"(Boolean) Whether to disable sending resolve messages. Defaults to false.\nWhether to disable sending resolve messages. Defaults to false."

fn spec.forProvider.wecom.withMessage

withMessage(message)

"(String) The templated content of the message.\nThe templated content of the message to send."

fn spec.forProvider.wecom.withMsgType

withMsgType(msgType)

"(String) The type of them message. Supported: markdown, text. Default: text.\nThe type of them message. Supported: markdown, text. Default: text."

fn spec.forProvider.wecom.withTitle

withTitle(title)

"(String) The templated title of the message.\nThe templated title of the message to send."

fn spec.forProvider.wecom.withToUser

withToUser(toUser)

"(String) The ID of user that should receive the message. Multiple entries should be separated by '|'. Default: @all.\nThe ID of user that should receive the message. Multiple entries should be separated by '|'. Default: @all."

obj spec.forProvider.wecom.secretSecretRef

"(String, Sensitive) The secret key required to obtain access token when using APIAPP. See https://work.weixin.qq.com/wework_admin/frame#apps to create APIAPP.\nThe secret key required to obtain access token when using APIAPP. See https://work.weixin.qq.com/wework_admin/frame#apps to create APIAPP."

fn spec.forProvider.wecom.secretSecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.wecom.secretSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.wecom.secretSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.wecom.settingsSecretRef

"(Map of String, Sensitive) Additional custom properties to attach to the notifier. Defaults to map[].\nAdditional custom properties to attach to the notifier. Defaults to map[]."

fn spec.forProvider.wecom.settingsSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.wecom.settingsSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.forProvider.wecom.urlSecretRef

"(String) The URL of the Alertmanager instance.\nThe WeCom webhook URL. Required if using GroupRobot."

fn spec.forProvider.wecom.urlSecretRef.withKey

withKey(key)

"The key to select."

fn spec.forProvider.wecom.urlSecretRef.withName

withName(name)

"Name of the secret."

fn spec.forProvider.wecom.urlSecretRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."

obj spec.initProvider

"THIS IS A BETA FIELD. It will be honored\nunless the Management Policies feature flag is disabled.\nInitProvider holds the same fields as ForProvider, with the exception\nof Identifier and other resource reference fields. The fields that are\nin InitProvider are merged into ForProvider when the resource is created.\nThe same fields are also added to the terraform ignore_changes hook, to\navoid updating them after creation. This is useful for fields that are\nrequired on creation, but we do not desire to update them after creation,\nfor example because of an external controller is managing them, like an\nautoscaler."

fn spec.initProvider.withAlertmanager

withAlertmanager(alertmanager)

"(Block Set) A contact point that sends notifications to other Alertmanager instances. (see below for nested schema)\nA contact point that sends notifications to other Alertmanager instances."

fn spec.initProvider.withAlertmanagerMixin

withAlertmanagerMixin(alertmanager)

"(Block Set) A contact point that sends notifications to other Alertmanager instances. (see below for nested schema)\nA contact point that sends notifications to other Alertmanager instances."

Note: This function appends passed data to existing values

fn spec.initProvider.withDingding

withDingding(dingding)

"(Block Set) A contact point that sends notifications to DingDing. (see below for nested schema)\nA contact point that sends notifications to DingDing."

fn spec.initProvider.withDingdingMixin

withDingdingMixin(dingding)

"(Block Set) A contact point that sends notifications to DingDing. (see below for nested schema)\nA contact point that sends notifications to DingDing."

Note: This function appends passed data to existing values

fn spec.initProvider.withDisableProvenance

withDisableProvenance(disableProvenance)

"Defaults to false. Defaults to false."

fn spec.initProvider.withDiscord

withDiscord(discord)

"(Block Set) A contact point that sends notifications as Discord messages (see below for nested schema)\nA contact point that sends notifications as Discord messages"

fn spec.initProvider.withDiscordMixin

withDiscordMixin(discord)

"(Block Set) A contact point that sends notifications as Discord messages (see below for nested schema)\nA contact point that sends notifications as Discord messages"

Note: This function appends passed data to existing values

fn spec.initProvider.withEmail

withEmail(email)

"(Block Set) A contact point that sends notifications to an email address. (see below for nested schema)\nA contact point that sends notifications to an email address."

fn spec.initProvider.withEmailMixin

withEmailMixin(email)

"(Block Set) A contact point that sends notifications to an email address. (see below for nested schema)\nA contact point that sends notifications to an email address."

Note: This function appends passed data to existing values

fn spec.initProvider.withGooglechat

withGooglechat(googlechat)

"(Block Set) A contact point that sends notifications to Google Chat. (see below for nested schema)\nA contact point that sends notifications to Google Chat."

fn spec.initProvider.withGooglechatMixin

withGooglechatMixin(googlechat)

"(Block Set) A contact point that sends notifications to Google Chat. (see below for nested schema)\nA contact point that sends notifications to Google Chat."

Note: This function appends passed data to existing values

fn spec.initProvider.withKafka

withKafka(kafka)

"(Block Set) A contact point that publishes notifications to Apache Kafka topics. (see below for nested schema)\nA contact point that publishes notifications to Apache Kafka topics."

fn spec.initProvider.withKafkaMixin

withKafkaMixin(kafka)

"(Block Set) A contact point that publishes notifications to Apache Kafka topics. (see below for nested schema)\nA contact point that publishes notifications to Apache Kafka topics."

Note: This function appends passed data to existing values

fn spec.initProvider.withLine

withLine(line)

"(Block Set) A contact point that sends notifications to LINE.me. (see below for nested schema)\nA contact point that sends notifications to LINE.me."

fn spec.initProvider.withLineMixin

withLineMixin(line)

"(Block Set) A contact point that sends notifications to LINE.me. (see below for nested schema)\nA contact point that sends notifications to LINE.me."

Note: This function appends passed data to existing values

fn spec.initProvider.withName

withName(name)

"(String) The name of the contact point.\nThe name of the contact point."

fn spec.initProvider.withOncall

withOncall(oncall)

"Call. (see below for nested schema)\nA contact point that sends notifications to Grafana On-Call."

fn spec.initProvider.withOncallMixin

withOncallMixin(oncall)

"Call. (see below for nested schema)\nA contact point that sends notifications to Grafana On-Call."

Note: This function appends passed data to existing values

fn spec.initProvider.withOpsgenie

withOpsgenie(opsgenie)

"(Block Set) A contact point that sends notifications to OpsGenie. (see below for nested schema)\nA contact point that sends notifications to OpsGenie."

fn spec.initProvider.withOpsgenieMixin

withOpsgenieMixin(opsgenie)

"(Block Set) A contact point that sends notifications to OpsGenie. (see below for nested schema)\nA contact point that sends notifications to OpsGenie."

Note: This function appends passed data to existing values

fn spec.initProvider.withOrgId

withOrgId(orgId)

"(String) The Organization ID. If not set, the Org ID defined in the provider block will be used.\nThe Organization ID. If not set, the Org ID defined in the provider block will be used."

fn spec.initProvider.withPagerduty

withPagerduty(pagerduty)

"(Block Set) A contact point that sends notifications to PagerDuty. (see below for nested schema)\nA contact point that sends notifications to PagerDuty."

fn spec.initProvider.withPagerdutyMixin

withPagerdutyMixin(pagerduty)

"(Block Set) A contact point that sends notifications to PagerDuty. (see below for nested schema)\nA contact point that sends notifications to PagerDuty."

Note: This function appends passed data to existing values

fn spec.initProvider.withPushover

withPushover(pushover)

"(Block Set) A contact point that sends notifications to Pushover. (see below for nested schema)\nA contact point that sends notifications to Pushover."

fn spec.initProvider.withPushoverMixin

withPushoverMixin(pushover)

"(Block Set) A contact point that sends notifications to Pushover. (see below for nested schema)\nA contact point that sends notifications to Pushover."

Note: This function appends passed data to existing values

fn spec.initProvider.withSensugo

withSensugo(sensugo)

"(Block Set) A contact point that sends notifications to SensuGo. (see below for nested schema)\nA contact point that sends notifications to SensuGo."

fn spec.initProvider.withSensugoMixin

withSensugoMixin(sensugo)

"(Block Set) A contact point that sends notifications to SensuGo. (see below for nested schema)\nA contact point that sends notifications to SensuGo."

Note: This function appends passed data to existing values

fn spec.initProvider.withSlack

withSlack(slack)

"(Block Set) A contact point that sends notifications to Slack. (see below for nested schema)\nA contact point that sends notifications to Slack."

fn spec.initProvider.withSlackMixin

withSlackMixin(slack)

"(Block Set) A contact point that sends notifications to Slack. (see below for nested schema)\nA contact point that sends notifications to Slack."

Note: This function appends passed data to existing values

fn spec.initProvider.withSns

withSns(sns)

"(Block Set) A contact point that sends notifications to Amazon SNS. Requires Amazon Managed Grafana. (see below for nested schema)\nA contact point that sends notifications to Amazon SNS. Requires Amazon Managed Grafana."

fn spec.initProvider.withSnsMixin

withSnsMixin(sns)

"(Block Set) A contact point that sends notifications to Amazon SNS. Requires Amazon Managed Grafana. (see below for nested schema)\nA contact point that sends notifications to Amazon SNS. Requires Amazon Managed Grafana."

Note: This function appends passed data to existing values

fn spec.initProvider.withTeams

withTeams(teams)

"(Block Set) A contact point that sends notifications to Microsoft Teams. (see below for nested schema)\nA contact point that sends notifications to Microsoft Teams."

fn spec.initProvider.withTeamsMixin

withTeamsMixin(teams)

"(Block Set) A contact point that sends notifications to Microsoft Teams. (see below for nested schema)\nA contact point that sends notifications to Microsoft Teams."

Note: This function appends passed data to existing values

fn spec.initProvider.withTelegram

withTelegram(telegram)

"(Block Set) A contact point that sends notifications to Telegram. (see below for nested schema)\nA contact point that sends notifications to Telegram."

fn spec.initProvider.withTelegramMixin

withTelegramMixin(telegram)

"(Block Set) A contact point that sends notifications to Telegram. (see below for nested schema)\nA contact point that sends notifications to Telegram."

Note: This function appends passed data to existing values

fn spec.initProvider.withThreema

withThreema(threema)

"(Block Set) A contact point that sends notifications to Threema. (see below for nested schema)\nA contact point that sends notifications to Threema."

fn spec.initProvider.withThreemaMixin

withThreemaMixin(threema)

"(Block Set) A contact point that sends notifications to Threema. (see below for nested schema)\nA contact point that sends notifications to Threema."

Note: This function appends passed data to existing values

fn spec.initProvider.withVictorops

withVictorops(victorops)

"(Block Set) A contact point that sends notifications to VictorOps (now known as Splunk OnCall). (see below for nested schema)\nA contact point that sends notifications to VictorOps (now known as Splunk OnCall)."

fn spec.initProvider.withVictoropsMixin

withVictoropsMixin(victorops)

"(Block Set) A contact point that sends notifications to VictorOps (now known as Splunk OnCall). (see below for nested schema)\nA contact point that sends notifications to VictorOps (now known as Splunk OnCall)."

Note: This function appends passed data to existing values

fn spec.initProvider.withWebex

withWebex(webex)

"(Block Set) A contact point that sends notifications to Cisco Webex. (see below for nested schema)\nA contact point that sends notifications to Cisco Webex."

fn spec.initProvider.withWebexMixin

withWebexMixin(webex)

"(Block Set) A contact point that sends notifications to Cisco Webex. (see below for nested schema)\nA contact point that sends notifications to Cisco Webex."

Note: This function appends passed data to existing values

fn spec.initProvider.withWebhook

withWebhook(webhook)

"(Block Set) A contact point that sends notifications to an arbitrary webhook, using the Prometheus webhook format defined here: https://prometheus.io/docs/alerting/latest/configuration/#webhook_config (see below for nested schema)\nA contact point that sends notifications to an arbitrary webhook, using the Prometheus webhook format defined here: https://prometheus.io/docs/alerting/latest/configuration/#webhook_config"

fn spec.initProvider.withWebhookMixin

withWebhookMixin(webhook)

"(Block Set) A contact point that sends notifications to an arbitrary webhook, using the Prometheus webhook format defined here: https://prometheus.io/docs/alerting/latest/configuration/#webhook_config (see below for nested schema)\nA contact point that sends notifications to an arbitrary webhook, using the Prometheus webhook format defined here: https://prometheus.io/docs/alerting/latest/configuration/#webhook_config"

Note: This function appends passed data to existing values

fn spec.initProvider.withWecom

withWecom(wecom)

"(Block Set) A contact point that sends notifications to WeCom. (see below for nested schema)\nA contact point that sends notifications to WeCom."

fn spec.initProvider.withWecomMixin

withWecomMixin(wecom)

"(Block Set) A contact point that sends notifications to WeCom. (see below for nested schema)\nA contact point that sends notifications to WeCom."

Note: This function appends passed data to existing values

obj spec.initProvider.alertmanager

"(Block Set) A contact point that sends notifications to other Alertmanager instances. (see below for nested schema)\nA contact point that sends notifications to other Alertmanager instances."

fn spec.initProvider.alertmanager.withBasicAuthUser

withBasicAuthUser(basicAuthUser)

"(String) The username component of the basic auth credentials to use.\nThe username component of the basic auth credentials to use."

fn spec.initProvider.alertmanager.withDisableResolveMessage

withDisableResolveMessage(disableResolveMessage)

"(Boolean) Whether to disable sending resolve messages. Defaults to false.\nWhether to disable sending resolve messages. Defaults to false."

fn spec.initProvider.alertmanager.withUrl

withUrl(url)

"(String) The URL of the Alertmanager instance.\nThe URL of the Alertmanager instance."

obj spec.initProvider.dingding

"(Block Set) A contact point that sends notifications to DingDing. (see below for nested schema)\nA contact point that sends notifications to DingDing."

fn spec.initProvider.dingding.withDisableResolveMessage

withDisableResolveMessage(disableResolveMessage)

"(Boolean) Whether to disable sending resolve messages. Defaults to false.\nWhether to disable sending resolve messages. Defaults to false."

fn spec.initProvider.dingding.withMessage

withMessage(message)

"(String) The templated content of the message.\nThe templated content of the message."

fn spec.initProvider.dingding.withMessageType

withMessageType(messageType)

"either 'link' or 'actionCard'\nThe format of message to send - either 'link' or 'actionCard'"

fn spec.initProvider.dingding.withTitle

withTitle(title)

"(String) The templated title of the message.\nThe templated title of the message."

fn spec.initProvider.dingding.withUrl

withUrl(url)

"(String) The URL of the Alertmanager instance.\nThe DingDing webhook URL."

obj spec.initProvider.discord

"(Block Set) A contact point that sends notifications as Discord messages (see below for nested schema)\nA contact point that sends notifications as Discord messages"

fn spec.initProvider.discord.withAvatarUrl

withAvatarUrl(avatarUrl)

"(String) The URL of a custom avatar image to use. Defaults to “.\nThe URL of a custom avatar image to use. Defaults to “."

fn spec.initProvider.discord.withDisableResolveMessage

withDisableResolveMessage(disableResolveMessage)

"(Boolean) Whether to disable sending resolve messages. Defaults to false.\nWhether to disable sending resolve messages. Defaults to false."

fn spec.initProvider.discord.withMessage

withMessage(message)

"(String) The templated content of the message.\nThe templated content of the message. Defaults to “."

fn spec.initProvider.discord.withTitle

withTitle(title)

"(String) The templated title of the message.\nThe templated content of the title."

fn spec.initProvider.discord.withUseDiscordUsername

withUseDiscordUsername(useDiscordUsername)

"(Boolean) Whether to use the bot account's plain username instead of \"Grafana.\" Defaults to false.\nWhether to use the bot account's plain username instead of \"Grafana.\" Defaults to false."

obj spec.initProvider.email

"(Block Set) A contact point that sends notifications to an email address. (see below for nested schema)\nA contact point that sends notifications to an email address."

fn spec.initProvider.email.withAddresses

withAddresses(addresses)

"(List of String) The addresses to send emails to.\nThe addresses to send emails to."

fn spec.initProvider.email.withAddressesMixin

withAddressesMixin(addresses)

"(List of String) The addresses to send emails to.\nThe addresses to send emails to."

Note: This function appends passed data to existing values

fn spec.initProvider.email.withDisableResolveMessage

withDisableResolveMessage(disableResolveMessage)

"(Boolean) Whether to disable sending resolve messages. Defaults to false.\nWhether to disable sending resolve messages. Defaults to false."

fn spec.initProvider.email.withMessage

withMessage(message)

"(String) The templated content of the message.\nThe templated content of the email. Defaults to “."

fn spec.initProvider.email.withSingleEmail

withSingleEmail(singleEmail)

"(Boolean) Whether to send a single email CC'ing all addresses, rather than a separate email to each address. Defaults to false.\nWhether to send a single email CC'ing all addresses, rather than a separate email to each address. Defaults to false."

fn spec.initProvider.email.withSubject

withSubject(subject)

"(String) The templated subject line of the email. Defaults to “.\nThe templated subject line of the email. Defaults to “."

obj spec.initProvider.googlechat

"(Block Set) A contact point that sends notifications to Google Chat. (see below for nested schema)\nA contact point that sends notifications to Google Chat."

fn spec.initProvider.googlechat.withDisableResolveMessage

withDisableResolveMessage(disableResolveMessage)

"(Boolean) Whether to disable sending resolve messages. Defaults to false.\nWhether to disable sending resolve messages. Defaults to false."

fn spec.initProvider.googlechat.withMessage

withMessage(message)

"(String) The templated content of the message.\nThe templated content of the message."

fn spec.initProvider.googlechat.withTitle

withTitle(title)

"(String) The templated title of the message.\nThe templated content of the title."

obj spec.initProvider.kafka

"(Block Set) A contact point that publishes notifications to Apache Kafka topics. (see below for nested schema)\nA contact point that publishes notifications to Apache Kafka topics."

fn spec.initProvider.kafka.withApiVersion

withApiVersion(apiVersion)

"(String) The API version to use when contacting the Kafka REST Server. Supported: v2 (default) and v3. Defaults to v2.\nThe API version to use when contacting the Kafka REST Server. Supported: v2 (default) and v3. Defaults to v2."

fn spec.initProvider.kafka.withClusterId

withClusterId(clusterId)

"(String) The Id of cluster to use when contacting the Kafka REST Server. Required api_version to be 'v3'\nThe Id of cluster to use when contacting the Kafka REST Server. Required api_version to be 'v3'"

fn spec.initProvider.kafka.withDescription

withDescription(description)

"(String) The templated description of the Kafka message.\nThe templated description of the Kafka message."

fn spec.initProvider.kafka.withDetails

withDetails(details)

"(String) The templated details to include with the message.\nThe templated details to include with the message."

fn spec.initProvider.kafka.withDisableResolveMessage

withDisableResolveMessage(disableResolveMessage)

"(Boolean) Whether to disable sending resolve messages. Defaults to false.\nWhether to disable sending resolve messages. Defaults to false."

fn spec.initProvider.kafka.withTopic

withTopic(topic)

"(String) The name of the Kafka topic to publish to.\nThe name of the Kafka topic to publish to."

fn spec.initProvider.kafka.withUsername

withUsername(username)

"(String) The user name to use when making a call to the Kafka REST Proxy\nThe user name to use when making a call to the Kafka REST Proxy"

obj spec.initProvider.line

"(Block Set) A contact point that sends notifications to LINE.me. (see below for nested schema)\nA contact point that sends notifications to LINE.me."

fn spec.initProvider.line.withDescription

withDescription(description)

"(String) The templated description of the Kafka message.\nThe templated description of the message."

fn spec.initProvider.line.withDisableResolveMessage

withDisableResolveMessage(disableResolveMessage)

"(Boolean) Whether to disable sending resolve messages. Defaults to false.\nWhether to disable sending resolve messages. Defaults to false."

fn spec.initProvider.line.withTitle

withTitle(title)

"(String) The templated title of the message.\nThe templated title of the message."

obj spec.initProvider.oncall

"Call. (see below for nested schema)\nA contact point that sends notifications to Grafana On-Call."

fn spec.initProvider.oncall.withAuthorizationScheme

withAuthorizationScheme(authorizationScheme)

"attaches an auth header with this name. Do not use in conjunction with basic auth parameters.\nAllows a custom authorization scheme - attaches an auth header with this name. Do not use in conjunction with basic auth parameters."

fn spec.initProvider.oncall.withBasicAuthUser

withBasicAuthUser(basicAuthUser)

"(String) The username component of the basic auth credentials to use.\nThe username to use in basic auth headers attached to the request. If omitted, basic auth will not be used."

fn spec.initProvider.oncall.withDisableResolveMessage

withDisableResolveMessage(disableResolveMessage)

"(Boolean) Whether to disable sending resolve messages. Defaults to false.\nWhether to disable sending resolve messages. Defaults to false."

fn spec.initProvider.oncall.withHttpMethod

withHttpMethod(httpMethod)

"(String) The HTTP method to use in the request. Defaults to POST.\nThe HTTP method to use in the request. Defaults to POST."

fn spec.initProvider.oncall.withMaxAlerts

withMaxAlerts(maxAlerts)

"(Number) The maximum number of alerts to send in a single request. This can be helpful in limiting the size of the request body. The default is 0, which indicates no limit.\nThe maximum number of alerts to send in a single request. This can be helpful in limiting the size of the request body. The default is 0, which indicates no limit."

fn spec.initProvider.oncall.withMessage

withMessage(message)

"(String) The templated content of the message.\nCustom message. You can use template variables."

fn spec.initProvider.oncall.withTitle

withTitle(title)

"(String) The templated title of the message.\nTemplated title of the message."

fn spec.initProvider.oncall.withUrl

withUrl(url)

"(String) The URL of the Alertmanager instance.\nThe URL to send webhook requests to."

obj spec.initProvider.opsgenie

"(Block Set) A contact point that sends notifications to OpsGenie. (see below for nested schema)\nA contact point that sends notifications to OpsGenie."

fn spec.initProvider.opsgenie.withAutoClose

withAutoClose(autoClose)

"close alerts in OpsGenie when they resolve in the Alertmanager.\nWhether to auto-close alerts in OpsGenie when they resolve in the Alertmanager."

fn spec.initProvider.opsgenie.withDescription

withDescription(description)

"(String) The templated description of the Kafka message.\nA templated high-level description to use for the alert."

fn spec.initProvider.opsgenie.withDisableResolveMessage

withDisableResolveMessage(disableResolveMessage)

"(Boolean) Whether to disable sending resolve messages. Defaults to false.\nWhether to disable sending resolve messages. Defaults to false."

fn spec.initProvider.opsgenie.withMessage

withMessage(message)

"(String) The templated content of the message.\nThe templated content of the message."

fn spec.initProvider.opsgenie.withOverridePriority

withOverridePriority(overridePriority)

"(Boolean) Whether to allow the alert priority to be configured via the value of the og_priority annotation on the alert.\nWhether to allow the alert priority to be configured via the value of the og_priority annotation on the alert."

fn spec.initProvider.opsgenie.withResponders

withResponders(responders)

"(Block List) Teams, users, escalations and schedules that the alert will be routed to send notifications. If the API Key belongs to a team integration, this field will be overwritten with the owner team. This feature is available from Grafana 10.3+. (see below for nested schema)\nTeams, users, escalations and schedules that the alert will be routed to send notifications. If the API Key belongs to a team integration, this field will be overwritten with the owner team. This feature is available from Grafana 10.3+."

fn spec.initProvider.opsgenie.withRespondersMixin

withRespondersMixin(responders)

"(Block List) Teams, users, escalations and schedules that the alert will be routed to send notifications. If the API Key belongs to a team integration, this field will be overwritten with the owner team. This feature is available from Grafana 10.3+. (see below for nested schema)\nTeams, users, escalations and schedules that the alert will be routed to send notifications. If the API Key belongs to a team integration, this field will be overwritten with the owner team. This feature is available from Grafana 10.3+."

Note: This function appends passed data to existing values

fn spec.initProvider.opsgenie.withSendTagsAs

withSendTagsAs(sendTagsAs)

"(String) Whether to send annotations to OpsGenie as Tags, Details, or both. Supported values are tags, details, both, or empty to use the default behavior of Tags.\nWhether to send annotations to OpsGenie as Tags, Details, or both. Supported values are tags, details, both, or empty to use the default behavior of Tags."

fn spec.initProvider.opsgenie.withUrl

withUrl(url)

"(String) The URL of the Alertmanager instance.\nAllows customization of the OpsGenie API URL."

obj spec.initProvider.opsgenie.responders

"(Block List) Teams, users, escalations and schedules that the alert will be routed to send notifications. If the API Key belongs to a team integration, this field will be overwritten with the owner team. This feature is available from Grafana 10.3+. (see below for nested schema)\nTeams, users, escalations and schedules that the alert will be routed to send notifications. If the API Key belongs to a team integration, this field will be overwritten with the owner team. This feature is available from Grafana 10.3+."

fn spec.initProvider.opsgenie.responders.withId

withId(id)

"(String) The ID of this resource.\nID of the responder. Must be specified if name and username are empty."

fn spec.initProvider.opsgenie.responders.withName

withName(name)

"(String) The name of the contact point.\nName of the responder. Must be specified if username and id are empty."

fn spec.initProvider.opsgenie.responders.withType

withType(type)

"(String) Type of the responder. Supported: team, teams, user, escalation, schedule or a template that is expanded to one of these values.\nType of the responder. Supported: team, teams, user, escalation, schedule or a template that is expanded to one of these values."

fn spec.initProvider.opsgenie.responders.withUsername

withUsername(username)

"(String) The user name to use when making a call to the Kafka REST Proxy\nUser name of the responder. Must be specified if name and id are empty."

obj spec.initProvider.organizationRef

"Reference to a Organization in oss to populate orgId."

fn spec.initProvider.organizationRef.withName

withName(name)

"Name of the referenced object."

obj spec.initProvider.organizationRef.policy

"Policies for referencing."

fn spec.initProvider.organizationRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required.\nThe default is 'Required', which means the reconcile will fail if the\nreference cannot be resolved. 'Optional' means this reference will be\na no-op if it cannot be resolved."

fn spec.initProvider.organizationRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default\nis 'IfNotPresent', which will attempt to resolve the reference only when\nthe corresponding field is not present. Use 'Always' to resolve the\nreference on every reconcile."

obj spec.initProvider.organizationSelector

"Selector for a Organization in oss to populate orgId."

fn spec.initProvider.organizationSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

"MatchControllerRef ensures an object with the same controller reference\nas the selecting object is selected."

fn spec.initProvider.organizationSelector.withMatchLabels

withMatchLabels(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

fn spec.initProvider.organizationSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

Note: This function appends passed data to existing values

obj spec.initProvider.organizationSelector.policy

"Policies for selection."

fn spec.initProvider.organizationSelector.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required.\nThe default is 'Required', which means the reconcile will fail if the\nreference cannot be resolved. 'Optional' means this reference will be\na no-op if it cannot be resolved."

fn spec.initProvider.organizationSelector.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default\nis 'IfNotPresent', which will attempt to resolve the reference only when\nthe corresponding field is not present. Use 'Always' to resolve the\nreference on every reconcile."

obj spec.initProvider.pagerduty

"(Block Set) A contact point that sends notifications to PagerDuty. (see below for nested schema)\nA contact point that sends notifications to PagerDuty."

fn spec.initProvider.pagerduty.withClass

withClass(class)

"(String) The class or type of event, for example ping failure.\nThe class or type of event, for example ping failure."

fn spec.initProvider.pagerduty.withClient

withClient(client)

"(String) The name of the monitoring client that is triggering this event.\nThe name of the monitoring client that is triggering this event."

fn spec.initProvider.pagerduty.withClientUrl

withClientUrl(clientUrl)

"(String) The URL of the monitoring client that is triggering this event.\nThe URL of the monitoring client that is triggering this event."

fn spec.initProvider.pagerduty.withComponent

withComponent(component)

"(String) The component being affected by the event.\nThe component being affected by the event."

fn spec.initProvider.pagerduty.withDetails

withDetails(details)

"(String) The templated details to include with the message.\nA set of arbitrary key/value pairs that provide further detail about the incident."

fn spec.initProvider.pagerduty.withDetailsMixin

withDetailsMixin(details)

"(String) The templated details to include with the message.\nA set of arbitrary key/value pairs that provide further detail about the incident."

Note: This function appends passed data to existing values

fn spec.initProvider.pagerduty.withDisableResolveMessage

withDisableResolveMessage(disableResolveMessage)

"(Boolean) Whether to disable sending resolve messages. Defaults to false.\nWhether to disable sending resolve messages. Defaults to false."

fn spec.initProvider.pagerduty.withGroup

withGroup(group)

"(String) The group to which the provided component belongs to.\nThe group to which the provided component belongs to."

fn spec.initProvider.pagerduty.withSeverity

withSeverity(severity)

"(String) The PagerDuty event severity level. Default is critical.\nThe PagerDuty event severity level. Default is critical."

fn spec.initProvider.pagerduty.withSource

withSource(source)

"(String) The unique location of the affected system.\nThe unique location of the affected system."

fn spec.initProvider.pagerduty.withSummary

withSummary(summary)

"(String) The templated summary message of the event.\nThe templated summary message of the event."

obj spec.initProvider.pushover

"(Block Set) A contact point that sends notifications to Pushover. (see below for nested schema)\nA contact point that sends notifications to Pushover."

fn spec.initProvider.pushover.withDevice

withDevice(device)

"separated list of devices to which the event is associated.\nComma-separated list of devices to which the event is associated."

fn spec.initProvider.pushover.withDisableResolveMessage

withDisableResolveMessage(disableResolveMessage)

"(Boolean) Whether to disable sending resolve messages. Defaults to false.\nWhether to disable sending resolve messages. Defaults to false."

fn spec.initProvider.pushover.withExpire

withExpire(expire)

"(Number) How many seconds for which the notification will continue to be retried by Pushover.\nHow many seconds for which the notification will continue to be retried by Pushover."

fn spec.initProvider.pushover.withMessage

withMessage(message)

"(String) The templated content of the message.\nThe templated notification message content."

fn spec.initProvider.pushover.withOkPriority

withOkPriority(okPriority)

"(Number) The priority level of the resolved event.\nThe priority level of the resolved event."

fn spec.initProvider.pushover.withOkSound

withOkSound(okSound)

"(String) The sound associated with the resolved notification.\nThe sound associated with the resolved notification."

fn spec.initProvider.pushover.withPriority

withPriority(priority)

"(Number) The priority level of the event.\nThe priority level of the event."

fn spec.initProvider.pushover.withRetry

withRetry(retry)

"(Number) How often, in seconds, the Pushover servers will send the same notification to the user.\nHow often, in seconds, the Pushover servers will send the same notification to the user."

fn spec.initProvider.pushover.withSound

withSound(sound)

"(String) The sound associated with the notification.\nThe sound associated with the notification."

fn spec.initProvider.pushover.withTitle

withTitle(title)

"(String) The templated title of the message.\nThe templated title of the message."

fn spec.initProvider.pushover.withUploadImage

withUploadImage(uploadImage)

"(Boolean) Whether to send images in the notification or not. Default is true. Requires Grafana to be configured to send images in notifications.\nWhether to send images in the notification or not. Default is true. Requires Grafana to be configured to send images in notifications."

obj spec.initProvider.sensugo

"(Block Set) A contact point that sends notifications to SensuGo. (see below for nested schema)\nA contact point that sends notifications to SensuGo."

fn spec.initProvider.sensugo.withCheck

withCheck(check)

"(String) The SensuGo check to which the event should be routed.\nThe SensuGo check to which the event should be routed."

fn spec.initProvider.sensugo.withDisableResolveMessage

withDisableResolveMessage(disableResolveMessage)

"(Boolean) Whether to disable sending resolve messages. Defaults to false.\nWhether to disable sending resolve messages. Defaults to false."

fn spec.initProvider.sensugo.withEntity

withEntity(entity)

"(String) The entity being monitored.\nThe entity being monitored."

fn spec.initProvider.sensugo.withHandler

withHandler(handler)

"(String) A custom handler to execute in addition to the check.\nA custom handler to execute in addition to the check."

fn spec.initProvider.sensugo.withMessage

withMessage(message)

"(String) The templated content of the message.\nTemplated message content describing the alert."

fn spec.initProvider.sensugo.withNamespace

withNamespace(namespace)

"(String) The namespace in which the check resides.\nThe namespace in which the check resides."

fn spec.initProvider.sensugo.withUrl

withUrl(url)

"(String) The URL of the Alertmanager instance.\nThe SensuGo URL to send requests to."

obj spec.initProvider.slack

"(Block Set) A contact point that sends notifications to Slack. (see below for nested schema)\nA contact point that sends notifications to Slack."

fn spec.initProvider.slack.withDisableResolveMessage

withDisableResolveMessage(disableResolveMessage)

"(Boolean) Whether to disable sending resolve messages. Defaults to false.\nWhether to disable sending resolve messages. Defaults to false."

fn spec.initProvider.slack.withEndpointUrl

withEndpointUrl(endpointUrl)

"(String) Use this to override the Slack API endpoint URL to send requests to.\nUse this to override the Slack API endpoint URL to send requests to."

fn spec.initProvider.slack.withIconEmoji

withIconEmoji(iconEmoji)

"(String) The name of a Slack workspace emoji to use as the bot icon.\nThe name of a Slack workspace emoji to use as the bot icon."

fn spec.initProvider.slack.withIconUrl

withIconUrl(iconUrl)

"(String) A URL of an image to use as the bot icon.\nA URL of an image to use as the bot icon."

fn spec.initProvider.slack.withMentionChannel

withMentionChannel(mentionChannel)

"(String) Describes how to ping the slack channel that messages are being sent to. Options are here for an @here ping, channel for @channel, or empty for no ping.\nDescribes how to ping the slack channel that messages are being sent to. Options are here for an @here ping, channel for @channel, or empty for no ping."

fn spec.initProvider.slack.withMentionGroups

withMentionGroups(mentionGroups)

"separated list of groups to mention in the message.\nComma-separated list of groups to mention in the message."

fn spec.initProvider.slack.withMentionUsers

withMentionUsers(mentionUsers)

"separated list of users to mention in the message.\nComma-separated list of users to mention in the message."

fn spec.initProvider.slack.withRecipient

withRecipient(recipient)

"(String) Channel, private group, or IM channel (can be an encoded ID or a name) to send messages to.\nChannel, private group, or IM channel (can be an encoded ID or a name) to send messages to."

fn spec.initProvider.slack.withText

withText(text)

"(String) Templated content of the message.\nTemplated content of the message."

fn spec.initProvider.slack.withTitle

withTitle(title)

"(String) The templated title of the message.\nTemplated title of the message."

fn spec.initProvider.slack.withUsername

withUsername(username)

"(String) The user name to use when making a call to the Kafka REST Proxy\nUsername for the bot to use."

obj spec.initProvider.sns

"(Block Set) A contact point that sends notifications to Amazon SNS. Requires Amazon Managed Grafana. (see below for nested schema)\nA contact point that sends notifications to Amazon SNS. Requires Amazon Managed Grafana."

fn spec.initProvider.sns.withAssumeRoleArn

withAssumeRoleArn(assumeRoleArn)

"(String) The Amazon Resource Name (ARN) of the role to assume to send notifications to Amazon SNS.\nThe Amazon Resource Name (ARN) of the role to assume to send notifications to Amazon SNS."

fn spec.initProvider.sns.withAuthProvider

withAuthProvider(authProvider)

"(String) The authentication provider to use. Valid values are default, arn and keys. Default is default. Defaults to default.\nThe authentication provider to use. Valid values are default, arn and keys. Default is default. Defaults to default."

fn spec.initProvider.sns.withBody

withBody(body)

"(String)"

fn spec.initProvider.sns.withDisableResolveMessage

withDisableResolveMessage(disableResolveMessage)

"(Boolean) Whether to disable sending resolve messages. Defaults to false.\nWhether to disable sending resolve messages. Defaults to false."

fn spec.initProvider.sns.withExternalId

withExternalId(externalId)

"(String) The external ID to use when assuming the role.\nThe external ID to use when assuming the role."

fn spec.initProvider.sns.withMessageFormat

withMessageFormat(messageFormat)

"(String) The format of the message to send. Valid values are text, body and json. Default is text. Defaults to text.\nThe format of the message to send. Valid values are text, body and json. Default is text. Defaults to text."

fn spec.initProvider.sns.withSubject

withSubject(subject)

"(String) The templated subject line of the email. Defaults to “."

fn spec.initProvider.sns.withTopic

withTopic(topic)

"(String) The name of the Kafka topic to publish to.\nThe Amazon SNS topic to send notifications to."

obj spec.initProvider.teams

"(Block Set) A contact point that sends notifications to Microsoft Teams. (see below for nested schema)\nA contact point that sends notifications to Microsoft Teams."

fn spec.initProvider.teams.withDisableResolveMessage

withDisableResolveMessage(disableResolveMessage)

"(Boolean) Whether to disable sending resolve messages. Defaults to false.\nWhether to disable sending resolve messages. Defaults to false."

fn spec.initProvider.teams.withMessage

withMessage(message)

"(String) The templated content of the message.\nThe templated message content to send."

fn spec.initProvider.teams.withSectionTitle

withSectionTitle(sectionTitle)

"(String) The templated subtitle for each message section.\nThe templated subtitle for each message section."

fn spec.initProvider.teams.withTitle

withTitle(title)

"(String) The templated title of the message.\nThe templated title of the message."

obj spec.initProvider.telegram

"(Block Set) A contact point that sends notifications to Telegram. (see below for nested schema)\nA contact point that sends notifications to Telegram."

fn spec.initProvider.telegram.withChatId

withChatId(chatId)

"(String) The chat ID to send messages to.\nThe chat ID to send messages to."

fn spec.initProvider.telegram.withDisableNotifications

withDisableNotifications(disableNotifications)

"(Boolean) When set users will receive a notification with no sound.\nWhen set users will receive a notification with no sound."

fn spec.initProvider.telegram.withDisableResolveMessage

withDisableResolveMessage(disableResolveMessage)

"(Boolean) Whether to disable sending resolve messages. Defaults to false.\nWhether to disable sending resolve messages. Defaults to false."

fn spec.initProvider.telegram.withDisableWebPagePreview

withDisableWebPagePreview(disableWebPagePreview)

"(Boolean) When set it disables link previews for links in the message.\nWhen set it disables link previews for links in the message."

fn spec.initProvider.telegram.withMessage

withMessage(message)

"(String) The templated content of the message.\nThe templated content of the message."

fn spec.initProvider.telegram.withParseMode

withParseMode(parseMode)

"(String) Mode for parsing entities in the message text. Supported: None, Markdown, MarkdownV2, and HTML. HTML is the default.\nMode for parsing entities in the message text. Supported: None, Markdown, MarkdownV2, and HTML. HTML is the default."

fn spec.initProvider.telegram.withProtectContent

withProtectContent(protectContent)

"(Boolean) When set it protects the contents of the message from forwarding and saving.\nWhen set it protects the contents of the message from forwarding and saving."

obj spec.initProvider.threema

"(Block Set) A contact point that sends notifications to Threema. (see below for nested schema)\nA contact point that sends notifications to Threema."

fn spec.initProvider.threema.withDescription

withDescription(description)

"(String) The templated description of the Kafka message.\nThe templated description of the message."

fn spec.initProvider.threema.withDisableResolveMessage

withDisableResolveMessage(disableResolveMessage)

"(Boolean) Whether to disable sending resolve messages. Defaults to false.\nWhether to disable sending resolve messages. Defaults to false."

fn spec.initProvider.threema.withGatewayId

withGatewayId(gatewayId)

"(String) The Threema gateway ID.\nThe Threema gateway ID."

fn spec.initProvider.threema.withRecipientId

withRecipientId(recipientId)

"(String) The ID of the recipient of the message.\nThe ID of the recipient of the message."

fn spec.initProvider.threema.withTitle

withTitle(title)

"(String) The templated title of the message.\nThe templated title of the message."

obj spec.initProvider.victorops

"(Block Set) A contact point that sends notifications to VictorOps (now known as Splunk OnCall). (see below for nested schema)\nA contact point that sends notifications to VictorOps (now known as Splunk OnCall)."

fn spec.initProvider.victorops.withDescription

withDescription(description)

"(String) The templated description of the Kafka message.\nTemplated description of the message."

fn spec.initProvider.victorops.withDisableResolveMessage

withDisableResolveMessage(disableResolveMessage)

"(Boolean) Whether to disable sending resolve messages. Defaults to false.\nWhether to disable sending resolve messages. Defaults to false."

fn spec.initProvider.victorops.withMessageType

withMessageType(messageType)

"either 'link' or 'actionCard'\nThe VictorOps alert state - typically either CRITICAL or RECOVERY."

fn spec.initProvider.victorops.withTitle

withTitle(title)

"(String) The templated title of the message.\nTemplated title to display."

fn spec.initProvider.victorops.withUrl

withUrl(url)

"(String) The URL of the Alertmanager instance.\nThe VictorOps webhook URL."

obj spec.initProvider.webex

"(Block Set) A contact point that sends notifications to Cisco Webex. (see below for nested schema)\nA contact point that sends notifications to Cisco Webex."

fn spec.initProvider.webex.withApiUrl

withApiUrl(apiUrl)

"(String) The URL to send webhook requests to.\nThe URL to send webhook requests to."

fn spec.initProvider.webex.withDisableResolveMessage

withDisableResolveMessage(disableResolveMessage)

"(Boolean) Whether to disable sending resolve messages. Defaults to false.\nWhether to disable sending resolve messages. Defaults to false."

fn spec.initProvider.webex.withMessage

withMessage(message)

"(String) The templated content of the message.\nThe templated title of the message to send."

fn spec.initProvider.webex.withRoomId

withRoomId(roomId)

"(String) ID of the Webex Teams room where to send the messages.\nID of the Webex Teams room where to send the messages."

obj spec.initProvider.webhook

"(Block Set) A contact point that sends notifications to an arbitrary webhook, using the Prometheus webhook format defined here: https://prometheus.io/docs/alerting/latest/configuration/#webhook_config (see below for nested schema)\nA contact point that sends notifications to an arbitrary webhook, using the Prometheus webhook format defined here: https://prometheus.io/docs/alerting/latest/configuration/#webhook_config"

fn spec.initProvider.webhook.withAuthorizationScheme

withAuthorizationScheme(authorizationScheme)

"attaches an auth header with this name. Do not use in conjunction with basic auth parameters.\nAllows a custom authorization scheme - attaches an auth header with this name. Do not use in conjunction with basic auth parameters."

fn spec.initProvider.webhook.withBasicAuthUser

withBasicAuthUser(basicAuthUser)

"(String) The username component of the basic auth credentials to use.\nThe username to use in basic auth headers attached to the request. If omitted, basic auth will not be used."

fn spec.initProvider.webhook.withDisableResolveMessage

withDisableResolveMessage(disableResolveMessage)

"(Boolean) Whether to disable sending resolve messages. Defaults to false.\nWhether to disable sending resolve messages. Defaults to false."

fn spec.initProvider.webhook.withHttpMethod

withHttpMethod(httpMethod)

"(String) The HTTP method to use in the request. Defaults to POST.\nThe HTTP method to use in the request. Defaults to POST."

fn spec.initProvider.webhook.withMaxAlerts

withMaxAlerts(maxAlerts)

"(Number) The maximum number of alerts to send in a single request. This can be helpful in limiting the size of the request body. The default is 0, which indicates no limit.\nThe maximum number of alerts to send in a single request. This can be helpful in limiting the size of the request body. The default is 0, which indicates no limit."

fn spec.initProvider.webhook.withMessage

withMessage(message)

"(String) The templated content of the message.\nCustom message. You can use template variables."

fn spec.initProvider.webhook.withTitle

withTitle(title)

"(String) The templated title of the message.\nTemplated title of the message."

fn spec.initProvider.webhook.withUrl

withUrl(url)

"(String) The URL of the Alertmanager instance.\nThe URL to send webhook requests to."

obj spec.initProvider.wecom

"(Block Set) A contact point that sends notifications to WeCom. (see below for nested schema)\nA contact point that sends notifications to WeCom."

fn spec.initProvider.wecom.withAgentId

withAgentId(agentId)

"(String) Agent ID added to the request payload when using APIAPP.\nAgent ID added to the request payload when using APIAPP."

fn spec.initProvider.wecom.withCorpId

withCorpId(corpId)

"(String) Corp ID used to get token when using APIAPP.\nCorp ID used to get token when using APIAPP."

fn spec.initProvider.wecom.withDisableResolveMessage

withDisableResolveMessage(disableResolveMessage)

"(Boolean) Whether to disable sending resolve messages. Defaults to false.\nWhether to disable sending resolve messages. Defaults to false."

fn spec.initProvider.wecom.withMessage

withMessage(message)

"(String) The templated content of the message.\nThe templated content of the message to send."

fn spec.initProvider.wecom.withMsgType

withMsgType(msgType)

"(String) The type of them message. Supported: markdown, text. Default: text.\nThe type of them message. Supported: markdown, text. Default: text."

fn spec.initProvider.wecom.withTitle

withTitle(title)

"(String) The templated title of the message.\nThe templated title of the message to send."

fn spec.initProvider.wecom.withToUser

withToUser(toUser)

"(String) The ID of user that should receive the message. Multiple entries should be separated by '|'. Default: @all.\nThe ID of user that should receive the message. Multiple entries should be separated by '|'. Default: @all."

obj spec.providerConfigRef

"ProviderConfigReference specifies how the provider that will be used to\ncreate, observe, update, and delete this managed resource should be\nconfigured."

fn spec.providerConfigRef.withName

withName(name)

"Name of the referenced object."

obj spec.providerConfigRef.policy

"Policies for referencing."

fn spec.providerConfigRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required.\nThe default is 'Required', which means the reconcile will fail if the\nreference cannot be resolved. 'Optional' means this reference will be\na no-op if it cannot be resolved."

fn spec.providerConfigRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default\nis 'IfNotPresent', which will attempt to resolve the reference only when\nthe corresponding field is not present. Use 'Always' to resolve the\nreference on every reconcile."

obj spec.publishConnectionDetailsTo

"PublishConnectionDetailsTo specifies the connection secret config which\ncontains a name, metadata and a reference to secret store config to\nwhich any connection details for this managed resource should be written.\nConnection details frequently include the endpoint, username,\nand password required to connect to the managed resource."

fn spec.publishConnectionDetailsTo.withName

withName(name)

"Name is the name of the connection secret."

obj spec.publishConnectionDetailsTo.configRef

"SecretStoreConfigRef specifies which secret store config should be used\nfor this ConnectionSecret."

fn spec.publishConnectionDetailsTo.configRef.withName

withName(name)

"Name of the referenced object."

obj spec.publishConnectionDetailsTo.configRef.policy

"Policies for referencing."

fn spec.publishConnectionDetailsTo.configRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required.\nThe default is 'Required', which means the reconcile will fail if the\nreference cannot be resolved. 'Optional' means this reference will be\na no-op if it cannot be resolved."

fn spec.publishConnectionDetailsTo.configRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default\nis 'IfNotPresent', which will attempt to resolve the reference only when\nthe corresponding field is not present. Use 'Always' to resolve the\nreference on every reconcile."

obj spec.publishConnectionDetailsTo.metadata

"Metadata is the metadata for connection secret."

fn spec.publishConnectionDetailsTo.metadata.withAnnotations

withAnnotations(annotations)

"Annotations are the annotations to be added to connection secret.\n- For Kubernetes secrets, this will be used as \"metadata.annotations\".\n- It is up to Secret Store implementation for others store types."

fn spec.publishConnectionDetailsTo.metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations are the annotations to be added to connection secret.\n- For Kubernetes secrets, this will be used as \"metadata.annotations\".\n- It is up to Secret Store implementation for others store types."

Note: This function appends passed data to existing values

fn spec.publishConnectionDetailsTo.metadata.withLabels

withLabels(labels)

"Labels are the labels/tags to be added to connection secret.\n- For Kubernetes secrets, this will be used as \"metadata.labels\".\n- It is up to Secret Store implementation for others store types."

fn spec.publishConnectionDetailsTo.metadata.withLabelsMixin

withLabelsMixin(labels)

"Labels are the labels/tags to be added to connection secret.\n- For Kubernetes secrets, this will be used as \"metadata.labels\".\n- It is up to Secret Store implementation for others store types."

Note: This function appends passed data to existing values

fn spec.publishConnectionDetailsTo.metadata.withType

withType(type)

"Type is the SecretType for the connection secret.\n- Only valid for Kubernetes Secret Stores."

obj spec.writeConnectionSecretToRef

"WriteConnectionSecretToReference specifies the namespace and name of a\nSecret to which any connection details for this managed resource should\nbe written. Connection details frequently include the endpoint, username,\nand password required to connect to the managed resource.\nThis field is planned to be replaced in a future release in favor of\nPublishConnectionDetailsTo. Currently, both could be set independently\nand connection details would be published to both without affecting\neach other."

fn spec.writeConnectionSecretToRef.withName

withName(name)

"Name of the secret."

fn spec.writeConnectionSecretToRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."