com.pulumi.awsnative.wafv2.kotlin.outputs.GetRuleGroupResult.kt Maven / Gradle / Ivy

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

package com.pulumi.awsnative.wafv2.kotlin.outputs

import com.pulumi.awsnative.kotlin.outputs.Tag
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.collections.List
import kotlin.collections.Map

/**
 *
 * @property arn The Amazon Resource Name (ARN) of the rule group.
 * @property availableLabels Collection of Available Labels.
 * @property capacity The web ACL capacity units (WCUs) required for this rule group.
 * When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, AWS WAF enforces this limit.
 * AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.
 * @property consumedLabels Collection of Consumed Labels.
 * @property customResponseBodies A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.
 * For information about customizing web requests and responses, see [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) in the *AWS WAF Developer Guide* .
 * For information about the limits on count and size for custom request and response settings, see [AWS WAF quotas](https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the *AWS WAF Developer Guide* .
 * @property description A description of the rule group that helps with identification.
 * @property id The ID of the rule group.
 * @property labelNamespace The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.
 * The syntax for the label namespace prefix for a rule group is the following: `awswaf::rule group::`
 * When a rule with a label matches a web request, AWS WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon.
 * @property rules Collection of Rules.
 * @property tags Key:value pairs associated with an AWS resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each AWS resource.
 * > To modify tags on existing resources, use the AWS WAF APIs or command line interface. With AWS CloudFormation , you can only add tags to AWS WAF resources during resource creation.
 * @property visibilityConfig Defines and enables Amazon CloudWatch metrics and web request sample collection.
 */
public data class GetRuleGroupResult(
    public val arn: String? = null,
    public val availableLabels: List? = null,
    public val capacity: Int? = null,
    public val consumedLabels: List? = null,
    public val customResponseBodies: Map? = null,
    public val description: String? = null,
    public val id: String? = null,
    public val labelNamespace: String? = null,
    public val rules: List? = null,
    public val tags: List? = null,
    public val visibilityConfig: RuleGroupVisibilityConfig? = null,
) {
    public companion object {
        public fun toKotlin(javaType: com.pulumi.awsnative.wafv2.outputs.GetRuleGroupResult): GetRuleGroupResult = GetRuleGroupResult(
            arn = javaType.arn().map({ args0 -> args0 }).orElse(null),
            availableLabels = javaType.availableLabels().map({ args0 ->
                args0.let({ args0 ->
                    com.pulumi.awsnative.wafv2.kotlin.outputs.RuleGroupLabelSummary.Companion.toKotlin(args0)
                })
            }),
            capacity = javaType.capacity().map({ args0 -> args0 }).orElse(null),
            consumedLabels = javaType.consumedLabels().map({ args0 ->
                args0.let({ args0 ->
                    com.pulumi.awsnative.wafv2.kotlin.outputs.RuleGroupLabelSummary.Companion.toKotlin(args0)
                })
            }),
            customResponseBodies = javaType.customResponseBodies().map({ args0 ->
                args0.key.to(
                    args0.value.let({ args0 ->
                        com.pulumi.awsnative.wafv2.kotlin.outputs.RuleGroupCustomResponseBody.Companion.toKotlin(args0)
                    }),
                )
            }).toMap(),
            description = javaType.description().map({ args0 -> args0 }).orElse(null),
            id = javaType.id().map({ args0 -> args0 }).orElse(null),
            labelNamespace = javaType.labelNamespace().map({ args0 -> args0 }).orElse(null),
            rules = javaType.rules().map({ args0 ->
                args0.let({ args0 ->
                    com.pulumi.awsnative.wafv2.kotlin.outputs.RuleGroupRule.Companion.toKotlin(args0)
                })
            }),
            tags = javaType.tags().map({ args0 ->
                args0.let({ args0 ->
                    com.pulumi.awsnative.kotlin.outputs.Tag.Companion.toKotlin(args0)
                })
            }),
            visibilityConfig = javaType.visibilityConfig().map({ args0 ->
                args0.let({ args0 ->
                    com.pulumi.awsnative.wafv2.kotlin.outputs.RuleGroupVisibilityConfig.Companion.toKotlin(args0)
                })
            }).orElse(null),
        )
    }
}