com.pulumi.awsnative.configuration.kotlin.outputs.ConfigRuleSourceDetail.kt Maven / Gradle / Ivy

Go to download
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.awsnative.configuration.kotlin.outputs

import kotlin.String
import kotlin.Suppress

/**
 * Provides the source and the message types that trigger CC to evaluate your AWS resources against a rule. It also provides the frequency with which you want CC to run evaluations for the rule if the trigger type is periodic. You can specify the parameter values for ``SourceDetail`` only for custom rules.
 * @property eventSource The source of the event, such as an AWS service, that triggers CC to evaluate your AWS resources.
 * @property maximumExecutionFrequency The frequency at which you want CC to run evaluations for a custom rule with a periodic trigger. If you specify a value for ``MaximumExecutionFrequency``, then ``MessageType`` must use the ``ScheduledNotification`` value.
 *   By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the ``MaximumExecutionFrequency`` parameter.
 *  Based on the valid value you choose, CC runs evaluations once for each valid value. For example, if you choose ``Three_Hours``, CC runs evaluations once every three hours. In this case, ``Three_Hours`` is the frequency of this rule.
 * @property messageType The type of notification that triggers CC to run an evaluation for a rule. You can specify the following notification types:
 *   +   ``ConfigurationItemChangeNotification`` - Triggers an evaluation when CC delivers a configuration item as a result of a resource change.
 *   +   ``OversizedConfigurationItemChangeNotification`` - Triggers an evaluation when CC delivers an oversized configuration item. CC may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS.
 *   +   ``ScheduledNotification`` - Triggers a periodic evaluation at the frequency specified for ``MaximumExecutionFrequency``.
 *   +   ``ConfigurationSnapshotDeliveryCompleted`` - Triggers a periodic evaluation when CC delivers a configuration snapshot.
 *  If you want your custom rule to be triggered by configuration changes, specify two SourceDetail objects, one for ``ConfigurationItemChangeNotification`` and one for ``OversizedConfigurationItemChangeNotification``.
 */
public data class ConfigRuleSourceDetail(
    public val eventSource: String,
    public val maximumExecutionFrequency: String? = null,
    public val messageType: String,
) {
    public companion object {
        public fun toKotlin(javaType: com.pulumi.awsnative.configuration.outputs.ConfigRuleSourceDetail): ConfigRuleSourceDetail = ConfigRuleSourceDetail(
            eventSource = javaType.eventSource(),
            maximumExecutionFrequency = javaType.maximumExecutionFrequency().map({ args0 ->
                args0
            }).orElse(null),
            messageType = javaType.messageType(),
        )
    }
}