com.pulumi.awsnative.wafv2.kotlin.outputs.GetWebAclResult.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
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.
@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 web ACL.
* @property associationConfig Specifies custom configurations for the associations between the web ACL and protected resources.
* Use this to customize the maximum size of the request body that your protected resources forward to AWS WAF for inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).
* > You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see [AWS WAF Pricing](https://docs.aws.amazon.com/waf/pricing/) .
* For Application Load Balancer and AWS AppSync , the limit is fixed at 8 KB (8,192 bytes).
* @property capacity The web ACL capacity units (WCUs) currently being used by this web ACL.
* 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 captchaConfig Specifies how AWS WAF should handle `CAPTCHA` evaluations for rules that don't have their own `CaptchaConfig` settings. If you don't specify this, AWS WAF uses its default settings for `CaptchaConfig` .
* @property challengeConfig Specifies how AWS WAF should handle challenge evaluations for rules that don't have their own `ChallengeConfig` settings. If you don't specify this, AWS WAF uses its default settings for `ChallengeConfig` .
* @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 web ACL, and then use them in the rules and default actions that you define in the web ACL.
* 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 defaultAction The action to perform if none of the `Rules` contained in the `WebACL` match.
* @property description A description of the web ACL that helps with identification.
* @property id The ID of the web ACL.
* @property labelNamespace The label namespace prefix for this web ACL. All labels added by rules in this web ACL have this prefix.
* The syntax for the label namespace prefix for a web ACL is the following: `awswaf::webacl::`
* 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 tokenDomains Specifies the domains that AWS WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When AWS WAF provides a token, it uses the domain of the AWS resource that the web ACL is protecting. If you don't specify a list of token domains, AWS WAF accepts tokens only for the domain of the protected resource. With a token domain list, AWS WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.
* @property visibilityConfig Defines and enables Amazon CloudWatch metrics and web request sample collection.
*/
public data class GetWebAclResult(
public val arn: String? = null,
public val associationConfig: WebAclAssociationConfig? = null,
public val capacity: Int? = null,
public val captchaConfig: WebAclCaptchaConfig? = null,
public val challengeConfig: WebAclChallengeConfig? = null,
public val customResponseBodies: Map? = null,
public val defaultAction: WebAclDefaultAction? = 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 tokenDomains: List? = null,
public val visibilityConfig: WebAclVisibilityConfig? = null,
) {
public companion object {
public fun toKotlin(javaType: com.pulumi.awsnative.wafv2.outputs.GetWebAclResult): GetWebAclResult = GetWebAclResult(
arn = javaType.arn().map({ args0 -> args0 }).orElse(null),
associationConfig = javaType.associationConfig().map({ args0 ->
args0.let({ args0 ->
com.pulumi.awsnative.wafv2.kotlin.outputs.WebAclAssociationConfig.Companion.toKotlin(args0)
})
}).orElse(null),
capacity = javaType.capacity().map({ args0 -> args0 }).orElse(null),
captchaConfig = javaType.captchaConfig().map({ args0 ->
args0.let({ args0 ->
com.pulumi.awsnative.wafv2.kotlin.outputs.WebAclCaptchaConfig.Companion.toKotlin(args0)
})
}).orElse(null),
challengeConfig = javaType.challengeConfig().map({ args0 ->
args0.let({ args0 ->
com.pulumi.awsnative.wafv2.kotlin.outputs.WebAclChallengeConfig.Companion.toKotlin(args0)
})
}).orElse(null),
customResponseBodies = javaType.customResponseBodies().map({ args0 ->
args0.key.to(
args0.value.let({ args0 ->
com.pulumi.awsnative.wafv2.kotlin.outputs.WebAclCustomResponseBody.Companion.toKotlin(args0)
}),
)
}).toMap(),
defaultAction = javaType.defaultAction().map({ args0 ->
args0.let({ args0 ->
com.pulumi.awsnative.wafv2.kotlin.outputs.WebAclDefaultAction.Companion.toKotlin(args0)
})
}).orElse(null),
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.WebAclRule.Companion.toKotlin(args0)
})
}),
tags = javaType.tags().map({ args0 ->
args0.let({ args0 ->
com.pulumi.awsnative.kotlin.outputs.Tag.Companion.toKotlin(args0)
})
}),
tokenDomains = javaType.tokenDomains().map({ args0 -> args0 }),
visibilityConfig = javaType.visibilityConfig().map({ args0 ->
args0.let({ args0 ->
com.pulumi.awsnative.wafv2.kotlin.outputs.WebAclVisibilityConfig.Companion.toKotlin(args0)
})
}).orElse(null),
)
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy