Skip to content

CreatePolicyInput

Source code in docs_src/capo_network_security_manager/types/create_policy_input.py
class CreatePolicyInput(TypedDict, closed=True):
    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>"""
    policy_name: "capo_network_security_manager.types.policy_name.PolicyName"
    """<p>The name of the policy.</p>"""
    policy_description: NotRequired[
        "capo_network_security_manager.types.description.Description"
    ]
    """<p>A description of the policy.</p>"""
    priority: "capo_network_security_manager.types.priority.Priority"
    """<p>The priority of the resource. A lower number indicates a higher priority.</p>"""
    associated_template_and_rule_list: NotRequired[
        "capo_network_security_manager.types.template_and_rule_reference_list.TemplateAndRuleReferenceList"
    ]
    """<p>The templates and rules to associate with the policy. For AWS WAF policies, specify 1 to 100 templates or rules, of which at most 2 can be templates. For AWS Shield Advanced policies, this list must be empty.</p>"""
    firewall_type: (
        "capo_network_security_manager.types.policy_firewall_type.PolicyFirewallType"
    )
    """<p>The firewall type associated with the resource.</p>"""
    policy_configuration: (
        "capo_network_security_manager.types.policy_configuration.PolicyConfiguration"
    )
    """<p>The configuration settings that control the policy's behavior, including remediation and firewall-type-specific settings.</p>"""
    is_published: "capo_network_security_manager.types.is_published.IsPublished"
    """<p>Specifies whether to publish the resource. When <code>true</code>, the resource is saved in published (<code>ACTIVE</code>) state. When <code>false</code>, it is saved as a draft (<code>DRAFT</code>). Default: <code>true</code>.</p>"""
    tags: NotRequired["capo_network_security_manager.types.tag_map.TagMap"]
    """<p>The tags to add to the resource when it is created.</p>"""

associated_template_and_rule_list instance-attribute

associated_template_and_rule_list: NotRequired[TemplateAndRuleReferenceList]

The templates and rules to associate with the policy. For AWS WAF policies, specify 1 to 100 templates or rules, of which at most 2 can be templates. For AWS Shield Advanced policies, this list must be empty.

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.

firewall_type instance-attribute

firewall_type: PolicyFirewallType

The firewall type associated with the resource.

is_published instance-attribute

is_published: IsPublished

Specifies whether to publish the resource. When true, the resource is saved in published (ACTIVE) state. When false, it is saved as a draft (DRAFT). Default: true.

policy_configuration instance-attribute

policy_configuration: PolicyConfiguration

The configuration settings that control the policy's behavior, including remediation and firewall-type-specific settings.

policy_description instance-attribute

policy_description: NotRequired[Description]

A description of the policy.

policy_name instance-attribute

policy_name: PolicyName

The name of the policy.

priority instance-attribute

priority: Priority

The priority of the resource. A lower number indicates a higher priority.

tags instance-attribute

tags: NotRequired[TagMap]

The tags to add to the resource when it is created.