Skip to content

CreateFirewallPolicyRequest

Source code in docs_src/capo_network_firewall/types/create_firewall_policy_request.py
class CreateFirewallPolicyRequest(TypedDict, closed=True):
    firewall_policy_name: "capo_network_firewall.types.resource_name.ResourceName"
    """<p>The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.</p>"""
    firewall_policy: "capo_network_firewall.types.firewall_policy.FirewallPolicy"
    """<p>The rule groups and policy actions to use in the firewall policy.</p>"""
    description: NotRequired["capo_network_firewall.types.description.Description"]
    """<p>A description of the firewall policy.</p>"""
    tags: NotRequired["capo_network_firewall.types.tag_list.TagList"]
    """<p>The key:value pairs to associate with the resource.</p>"""
    dry_run: "capo_network_firewall.types.boolean.Boolean"
    """<p>Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request. </p> <p>If set to <code>TRUE</code>, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to <code>FALSE</code>, but doesn't make additions or changes to your resources. This option allows you to make sure that you have the required permissions to run the request and that your request parameters are valid. </p> <p>If set to <code>FALSE</code>, Network Firewall makes the requested changes to your resources. </p>"""
    encryption_configuration: NotRequired[
        "capo_network_firewall.types.encryption_configuration.EncryptionConfiguration"
    ]
    """<p>A complex type that contains settings for encryption of your firewall policy resources.</p>"""

description instance-attribute

description: NotRequired[Description]

A description of the firewall policy.

dry_run instance-attribute

dry_run: Boolean

Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.

If set to TRUE, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows you to make sure that you have the required permissions to run the request and that your request parameters are valid.

If set to FALSE, Network Firewall makes the requested changes to your resources.

encryption_configuration instance-attribute

encryption_configuration: NotRequired[EncryptionConfiguration]

A complex type that contains settings for encryption of your firewall policy resources.

firewall_policy instance-attribute

firewall_policy: FirewallPolicy

The rule groups and policy actions to use in the firewall policy.

firewall_policy_name instance-attribute

firewall_policy_name: ResourceName

The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.

tags instance-attribute

tags: NotRequired[TagList]

The key:value pairs to associate with the resource.