Skip to content

GenerateRuleConfigurationRequest

Source code in docs_src/capo_network_security_manager/types/generate_rule_configuration_request.py
class GenerateRuleConfigurationRequest(TypedDict, closed=True):
    prompt: "capo_network_security_manager.types.sensitive_string.SensitiveString"
    """<p>A natural-language description of the configuration that you want to generate.</p>"""
    rule_firewall_type: (
        "capo_network_security_manager.types.rule_firewall_type.RuleFirewallType"
    )
    """<p>The firewall type of the rule.</p>"""
    rule_type: "capo_network_security_manager.types.rule_type.RuleType"
    """<p>The type of the rule. <code>CONFIGURATION</code> rules contain firewall settings, and <code>INSPECTION</code> rules contain rule groups.</p>"""
    waf_config_data_type: NotRequired[
        "capo_network_security_manager.types.waf_config_data_type.WAFConfigDataType"
    ]
    """<p>For AWS WAF configuration rules, the specific AWS WAF configuration variant to generate. This is optional; if you omit it, the service selects the variant.</p>"""
    current_configuration: NotRequired["str"]
    """<p>An existing configuration to edit, as a JSON string. When you provide this value, the operation edits the configuration. When you omit it, the operation generates a new configuration.</p>"""
    client_token: NotRequired[
        "capo_network_security_manager.types.idempotency_token.IdempotencyToken"
    ]
    """<p>A unique, case-sensitive token that you provide to ensure that the operation completes no more than one time. If you retry a request with the same client token and the same parameters, the service returns the result of the original successful request.</p>"""

client_token instance-attribute

client_token: NotRequired[IdempotencyToken]

A unique, case-sensitive token that you provide to ensure that the operation completes no more than one time. If you retry a request with the same client token and the same parameters, the service returns the result of the original successful request.

current_configuration instance-attribute

current_configuration: NotRequired[str]

An existing configuration to edit, as a JSON string. When you provide this value, the operation edits the configuration. When you omit it, the operation generates a new configuration.

prompt instance-attribute

A natural-language description of the configuration that you want to generate.

rule_firewall_type instance-attribute

rule_firewall_type: RuleFirewallType

The firewall type of the rule.

rule_type instance-attribute

rule_type: RuleType

The type of the rule. CONFIGURATION rules contain firewall settings, and INSPECTION rules contain rule groups.

waf_config_data_type instance-attribute

waf_config_data_type: NotRequired[WAFConfigDataType]

For AWS WAF configuration rules, the specific AWS WAF configuration variant to generate. This is optional; if you omit it, the service selects the variant.