com.pulumi.awsnative.rum.kotlin.inputs.AppMonitorMetricDefinitionArgs.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-aws-native-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
There is a newer version: 1.24.0.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.awsnative.rum.kotlin.inputs

import com.pulumi.awsnative.rum.inputs.AppMonitorMetricDefinitionArgs.builder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiNullFieldException
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.Pair
import kotlin.String
import kotlin.Suppress
import kotlin.collections.Map
import kotlin.jvm.JvmName

/**
 * A single metric definition
 * @property dimensionKeys Use this field only if you are sending the metric to CloudWatch.
 * This field is a map of field paths to dimension names. It defines the dimensions to associate with this metric in CloudWatch. For extended metrics, valid values for the entries in this field are the following:
 * "metadata.pageId": "PageId"
 * "metadata.browserName": "BrowserName"
 * "metadata.deviceType": "DeviceType"
 * "metadata.osName": "OSName"
 * "metadata.countryCode": "CountryCode"
 * "event_details.fileType": "FileType"
 * All dimensions listed in this field must also be included in EventPattern.
 * @property eventPattern The pattern that defines the metric, specified as a JSON object. RUM checks events that happen in a user's session against the pattern, and events that match the pattern are sent to the metric destination.
 * When you define extended metrics, the metric definition is not valid if EventPattern is omitted.
 * Example event patterns:
 * '{ "event_type": ["com.amazon.rum.js_error_event"], "metadata": { "browserName": [ "Chrome", "Safari" ], } }'
 * '{ "event_type": ["com.amazon.rum.performance_navigation_event"], "metadata": { "browserName": [ "Chrome", "Firefox" ] }, "event_details": { "duration": [{ "numeric": [ "<", 2000 ] }] } }'
 * '{ "event_type": ["com.amazon.rum.performance_navigation_event"], "metadata": { "browserName": [ "Chrome", "Safari" ], "countryCode": [ "US" ] }, "event_details": { "duration": [{ "numeric": [ ">=", 2000, "<", 8000 ] }] } }'
 * If the metrics destination' is CloudWatch and the event also matches a value in DimensionKeys, then the metric is published with the specified dimensions.
 * @property name The name for the metric that is defined in this structure. For extended metrics, valid values are the following:
 * PerformanceNavigationDuration
 * PerformanceResourceDuration
 * NavigationSatisfiedTransaction
 * NavigationToleratedTransaction
 * NavigationFrustratedTransaction
 * WebVitalsCumulativeLayoutShift
 * WebVitalsFirstInputDelay
 * WebVitalsLargestContentfulPaint
 * JsErrorCount
 * HttpErrorCount
 * SessionCount
 * @property namespace The namespace used by CloudWatch Metrics for the metric that is defined in this structure
 * @property unitLabel The CloudWatch metric unit to use for this metric. If you omit this field, the metric is recorded with no unit.
 * @property valueKey The field within the event object that the metric value is sourced from.
 * If you omit this field, a hardcoded value of 1 is pushed as the metric value. This is useful if you just want to count the number of events that the filter catches.
 * If this metric is sent to Evidently, this field will be passed to Evidently raw and Evidently will handle data extraction from the event.
 */
public data class AppMonitorMetricDefinitionArgs(
    public val dimensionKeys: Output>? = null,
    public val eventPattern: Output? = null,
    public val name: Output,
    public val namespace: Output? = null,
    public val unitLabel: Output? = null,
    public val valueKey: Output? = null,
) : ConvertibleToJava {
    override fun toJava(): com.pulumi.awsnative.rum.inputs.AppMonitorMetricDefinitionArgs =
        com.pulumi.awsnative.rum.inputs.AppMonitorMetricDefinitionArgs.builder()
            .dimensionKeys(
                dimensionKeys?.applyValue({ args0 ->
                    args0.map({ args0 ->
                        args0.key.to(args0.value)
                    }).toMap()
                }),
            )
            .eventPattern(eventPattern?.applyValue({ args0 -> args0 }))
            .name(name.applyValue({ args0 -> args0 }))
            .namespace(namespace?.applyValue({ args0 -> args0 }))
            .unitLabel(unitLabel?.applyValue({ args0 -> args0 }))
            .valueKey(valueKey?.applyValue({ args0 -> args0 })).build()
}

/**
 * Builder for [AppMonitorMetricDefinitionArgs].
 */
@PulumiTagMarker
public class AppMonitorMetricDefinitionArgsBuilder internal constructor() {
    private var dimensionKeys: Output>? = null

    private var eventPattern: Output? = null

    private var name: Output? = null

    private var namespace: Output? = null

    private var unitLabel: Output? = null

    private var valueKey: Output? = null

    /**
     * @param value Use this field only if you are sending the metric to CloudWatch.
     * This field is a map of field paths to dimension names. It defines the dimensions to associate with this metric in CloudWatch. For extended metrics, valid values for the entries in this field are the following:
     * "metadata.pageId": "PageId"
     * "metadata.browserName": "BrowserName"
     * "metadata.deviceType": "DeviceType"
     * "metadata.osName": "OSName"
     * "metadata.countryCode": "CountryCode"
     * "event_details.fileType": "FileType"
     * All dimensions listed in this field must also be included in EventPattern.
     */
    @JvmName("kimlwxugktbfkqte")
    public suspend fun dimensionKeys(`value`: Output>) {
        this.dimensionKeys = value
    }

    /**
     * @param value The pattern that defines the metric, specified as a JSON object. RUM checks events that happen in a user's session against the pattern, and events that match the pattern are sent to the metric destination.
     * When you define extended metrics, the metric definition is not valid if EventPattern is omitted.
     * Example event patterns:
     * '{ "event_type": ["com.amazon.rum.js_error_event"], "metadata": { "browserName": [ "Chrome", "Safari" ], } }'
     * '{ "event_type": ["com.amazon.rum.performance_navigation_event"], "metadata": { "browserName": [ "Chrome", "Firefox" ] }, "event_details": { "duration": [{ "numeric": [ "<", 2000 ] }] } }'
     * '{ "event_type": ["com.amazon.rum.performance_navigation_event"], "metadata": { "browserName": [ "Chrome", "Safari" ], "countryCode": [ "US" ] }, "event_details": { "duration": [{ "numeric": [ ">=", 2000, "<", 8000 ] }] } }'
     * If the metrics destination' is CloudWatch and the event also matches a value in DimensionKeys, then the metric is published with the specified dimensions.
     */
    @JvmName("keenrpbwbajuepuo")
    public suspend fun eventPattern(`value`: Output) {
        this.eventPattern = value
    }

    /**
     * @param value The name for the metric that is defined in this structure. For extended metrics, valid values are the following:
     * PerformanceNavigationDuration
     * PerformanceResourceDuration
     * NavigationSatisfiedTransaction
     * NavigationToleratedTransaction
     * NavigationFrustratedTransaction
     * WebVitalsCumulativeLayoutShift
     * WebVitalsFirstInputDelay
     * WebVitalsLargestContentfulPaint
     * JsErrorCount
     * HttpErrorCount
     * SessionCount
     */
    @JvmName("qkcjxqstxlxefvor")
    public suspend fun name(`value`: Output) {
        this.name = value
    }

    /**
     * @param value The namespace used by CloudWatch Metrics for the metric that is defined in this structure
     */
    @JvmName("rsduvcfeuyxhbihd")
    public suspend fun namespace(`value`: Output) {
        this.namespace = value
    }

    /**
     * @param value The CloudWatch metric unit to use for this metric. If you omit this field, the metric is recorded with no unit.
     */
    @JvmName("xrmppflpfyatnrse")
    public suspend fun unitLabel(`value`: Output) {
        this.unitLabel = value
    }

    /**
     * @param value The field within the event object that the metric value is sourced from.
     * If you omit this field, a hardcoded value of 1 is pushed as the metric value. This is useful if you just want to count the number of events that the filter catches.
     * If this metric is sent to Evidently, this field will be passed to Evidently raw and Evidently will handle data extraction from the event.
     */
    @JvmName("uxrllwdyrbosfptt")
    public suspend fun valueKey(`value`: Output) {
        this.valueKey = value
    }

    /**
     * @param value Use this field only if you are sending the metric to CloudWatch.
     * This field is a map of field paths to dimension names. It defines the dimensions to associate with this metric in CloudWatch. For extended metrics, valid values for the entries in this field are the following:
     * "metadata.pageId": "PageId"
     * "metadata.browserName": "BrowserName"
     * "metadata.deviceType": "DeviceType"
     * "metadata.osName": "OSName"
     * "metadata.countryCode": "CountryCode"
     * "event_details.fileType": "FileType"
     * All dimensions listed in this field must also be included in EventPattern.
     */
    @JvmName("nnsjagilaixwtlwo")
    public suspend fun dimensionKeys(`value`: Map?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.dimensionKeys = mapped
    }

    /**
     * @param values Use this field only if you are sending the metric to CloudWatch.
     * This field is a map of field paths to dimension names. It defines the dimensions to associate with this metric in CloudWatch. For extended metrics, valid values for the entries in this field are the following:
     * "metadata.pageId": "PageId"
     * "metadata.browserName": "BrowserName"
     * "metadata.deviceType": "DeviceType"
     * "metadata.osName": "OSName"
     * "metadata.countryCode": "CountryCode"
     * "event_details.fileType": "FileType"
     * All dimensions listed in this field must also be included in EventPattern.
     */
    @JvmName("pchjcpywermswvay")
    public fun dimensionKeys(vararg values: Pair) {
        val toBeMapped = values.toMap()
        val mapped = toBeMapped.let({ args0 -> of(args0) })
        this.dimensionKeys = mapped
    }

    /**
     * @param value The pattern that defines the metric, specified as a JSON object. RUM checks events that happen in a user's session against the pattern, and events that match the pattern are sent to the metric destination.
     * When you define extended metrics, the metric definition is not valid if EventPattern is omitted.
     * Example event patterns:
     * '{ "event_type": ["com.amazon.rum.js_error_event"], "metadata": { "browserName": [ "Chrome", "Safari" ], } }'
     * '{ "event_type": ["com.amazon.rum.performance_navigation_event"], "metadata": { "browserName": [ "Chrome", "Firefox" ] }, "event_details": { "duration": [{ "numeric": [ "<", 2000 ] }] } }'
     * '{ "event_type": ["com.amazon.rum.performance_navigation_event"], "metadata": { "browserName": [ "Chrome", "Safari" ], "countryCode": [ "US" ] }, "event_details": { "duration": [{ "numeric": [ ">=", 2000, "<", 8000 ] }] } }'
     * If the metrics destination' is CloudWatch and the event also matches a value in DimensionKeys, then the metric is published with the specified dimensions.
     */
    @JvmName("nijlnvqcxdefkhhs")
    public suspend fun eventPattern(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.eventPattern = mapped
    }

    /**
     * @param value The name for the metric that is defined in this structure. For extended metrics, valid values are the following:
     * PerformanceNavigationDuration
     * PerformanceResourceDuration
     * NavigationSatisfiedTransaction
     * NavigationToleratedTransaction
     * NavigationFrustratedTransaction
     * WebVitalsCumulativeLayoutShift
     * WebVitalsFirstInputDelay
     * WebVitalsLargestContentfulPaint
     * JsErrorCount
     * HttpErrorCount
     * SessionCount
     */
    @JvmName("ykbictnyelyakdgc")
    public suspend fun name(`value`: String) {
        val toBeMapped = value
        val mapped = toBeMapped.let({ args0 -> of(args0) })
        this.name = mapped
    }

    /**
     * @param value The namespace used by CloudWatch Metrics for the metric that is defined in this structure
     */
    @JvmName("viqeflmmvmqejedx")
    public suspend fun namespace(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.namespace = mapped
    }

    /**
     * @param value The CloudWatch metric unit to use for this metric. If you omit this field, the metric is recorded with no unit.
     */
    @JvmName("ujkggyjyaglbcdyt")
    public suspend fun unitLabel(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.unitLabel = mapped
    }

    /**
     * @param value The field within the event object that the metric value is sourced from.
     * If you omit this field, a hardcoded value of 1 is pushed as the metric value. This is useful if you just want to count the number of events that the filter catches.
     * If this metric is sent to Evidently, this field will be passed to Evidently raw and Evidently will handle data extraction from the event.
     */
    @JvmName("xgarmcwxgtevhnix")
    public suspend fun valueKey(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.valueKey = mapped
    }

    internal fun build(): AppMonitorMetricDefinitionArgs = AppMonitorMetricDefinitionArgs(
        dimensionKeys = dimensionKeys,
        eventPattern = eventPattern,
        name = name ?: throw PulumiNullFieldException("name"),
        namespace = namespace,
        unitLabel = unitLabel,
        valueKey = valueKey,
    )
}