Amazon Network Firewall #X Amz Target=NetworkFirewall 20201112.CreateFirewallPolicy API

openapi: 3.2.0
info:
  version: 2020-11-12
  x-release: v4
  title: 'AWS Network Firewall #X Amz Target=NetworkFirewall…'
  description: This is the API Reference for Network Firewall.
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: network-firewall
  x-aws-signingName: network-firewall
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/network-firewall-2020-11-12.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://network-firewall.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Network Firewall multi-region endpoint
- url: https://network-firewall.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Network Firewall multi-region endpoint
- url: http://network-firewall.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Network Firewall endpoint for China (Beijing) and China (Ningxia)
- url: https://network-firewall.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Network Firewall endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=NetworkFirewall 20201112.CreateFirewallPolicy'
paths:
  /#X-Amz-Target=NetworkFirewall_20201112.CreateFirewallPolicy:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: CreateFirewallPolicy
      description: 'Creates the firewall policy for the firewall according to the specifications.


        An Network Firewall firewall policy defines the behavior of a firewall, in a collection of stateless and stateful rule groups and other settings. You can use one firewall policy for multiple firewalls.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateFirewallPolicyResponse'
              examples:
                CreateFirewallPolicy200Example:
                  summary: Default CreateFirewallPolicy 200 response
                  x-microcks-default: true
                  value:
                    UpdateToken: example-string
                    FirewallPolicyResponse: example-string
        '480':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '481':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '482':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '483':
          description: InternalServerError
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '484':
          description: InsufficientCapacityException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InsufficientCapacityException'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateFirewallPolicyRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - NetworkFirewall_20201112.CreateFirewallPolicy
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Amazon Network Firewall Create Firewall Policy
      tags:
      - '#X Amz Target=NetworkFirewall 20201112.CreateFirewallPolicy'
components:
  schemas:
    DimensionValue:
      type: string
      pattern: ^[a-zA-Z0-9-_ ]+$
      minLength: 1
      maxLength: 128
    TagValue:
      type: string
      pattern: ^.*$
      minLength: 0
      maxLength: 256
    InsufficientCapacityException: {}
    StreamExceptionPolicy:
      type: string
      enum:
      - DROP
      - CONTINUE
    FirewallPolicy:
      type: object
      required:
      - StatelessDefaultActions
      - StatelessFragmentDefaultActions
      properties:
        StatelessRuleGroupReferences:
          allOf:
          - $ref: '#/components/schemas/StatelessRuleGroupReferences'
          - description: 'References to the stateless rule groups that are used in the policy. These define the matching criteria in stateless rules. '
        StatelessDefaultActions:
          allOf:
          - $ref: '#/components/schemas/StatelessActions'
          - description: '<p>The actions to take on a packet if it doesn''t match any of the stateless rules in the policy. If you want non-matching packets to be forwarded for stateful inspection, specify <code>aws:forward_to_sfe</code>. </p> <p>You must specify one of the standard actions: <code>aws:pass</code>, <code>aws:drop</code>, or <code>aws:forward_to_sfe</code>. In addition, you can specify custom actions that are compatible with your standard section choice.</p> <p>For example, you could specify <code>["aws:pass"]</code> or you could specify <code>["aws:pass", “customActionName”]</code>. For information about compatibility, see the custom action descriptions under <a>CustomAction</a>.</p>'
        StatelessFragmentDefaultActions:
          allOf:
          - $ref: '#/components/schemas/StatelessActions'
          - description: '<p>The actions to take on a fragmented UDP packet if it doesn''t match any of the stateless rules in the policy. Network Firewall only manages UDP packet fragments and silently drops packet fragments for other protocols. If you want non-matching fragmented UDP packets to be forwarded for stateful inspection, specify <code>aws:forward_to_sfe</code>. </p> <p>You must specify one of the standard actions: <code>aws:pass</code>, <code>aws:drop</code>, or <code>aws:forward_to_sfe</code>. In addition, you can specify custom actions that are compatible with your standard section choice.</p> <p>For example, you could specify <code>["aws:pass"]</code> or you could specify <code>["aws:pass", “customActionName”]</code>. For information about compatibility, see the custom action descriptions under <a>CustomAction</a>.</p>'
        StatelessCustomActions:
          allOf:
          - $ref: '#/components/schemas/CustomActions'
          - description: The custom action definitions that are available for use in the firewall policy's <code>StatelessDefaultActions</code> setting. You name each custom action that you define, and then you can use it by name in your default actions specifications.
        StatefulRuleGroupReferences:
          allOf:
          - $ref: '#/components/schemas/StatefulRuleGroupReferences'
          - description: 'References to the stateful rule groups that are used in the policy. These define the inspection criteria in stateful rules. '
        StatefulDefaultActions:
          allOf:
          - $ref: '#/components/schemas/StatefulActions'
          - description: <p>The default actions to take on a packet that doesn't match any stateful rules. The stateful default action is optional, and is only valid when using the strict rule order.</p> <p>Valid values of the stateful default action:</p> <ul> <li> <p>aws:drop_strict</p> </li> <li> <p>aws:drop_established</p> </li> <li> <p>aws:alert_strict</p> </li> <li> <p>aws:alert_established</p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html#suricata-strict-rule-evaluation-order.html">Strict evaluation order</a> in the <i>Network Firewall Developer Guide</i>. </p>
        StatefulEngineOptions:
          allOf:
          - $ref: '#/components/schemas/StatefulEngineOptions'
          - description: Additional options governing how Network Firewall handles stateful rules. The stateful rule groups that you use in your policy must have stateful rule options settings that are compatible with these settings.
        TLSInspectionConfigurationArn:
          allOf:
          - $ref: '#/components/schemas/ResourceArn'
          - description: The Amazon Resource Name (ARN) of the TLS inspection configuration.
      description: <p>The firewall policy defines the behavior of a firewall using a collection of stateless and stateful rule groups and other settings. You can use one firewall policy for multiple firewalls. </p> <p>This, along with <a>FirewallPolicyResponse</a>, define the policy. You can retrieve all objects for a firewall policy by calling <a>DescribeFirewallPolicy</a>.</p>
    StatefulActions:
      type: array
      items:
        $ref: '#/components/schemas/CollectionMember_String'
    StatefulEngineOptions:
      type: object
      properties:
        RuleOrder:
          allOf:
          - $ref: '#/components/schemas/RuleOrder'
          - description: 'Indicates how to manage the order of stateful rule evaluation for the policy. <code>DEFAULT_ACTION_ORDER</code> is the default behavior. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them based on certain settings. For more information, see <a href="https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html">Evaluation order for stateful rules</a> in the <i>Network Firewall Developer Guide</i>. '
        StreamExceptionPolicy:
          allOf:
          - $ref: '#/components/schemas/StreamExceptionPolicy'
          - description: <p>Configures how Network Firewall processes traffic when a network connection breaks midstream. Network connections can break due to disruptions in external networks or within the firewall itself.</p> <ul> <li> <p> <code>DROP</code> - Network Firewall fails closed and drops all subsequent traffic going to the firewall. This is the default behavior.</p> </li> <li> <p> <code>CONTINUE</code> - Network Firewall continues to apply rules to the subsequent traffic without context from traffic before the break. This impacts the behavior of rules that depend on this context. For example, if you have a stateful rule to <code>drop http</code> traffic, Network Firewall won't match the traffic for this rule because the service won't have the context from session initialization defining the application layer protocol as HTTP. However, this behavior is rule dependent—a TCP-layer rule using a <code>flow:stateless</code> rule would still match, as would the <code>aws:drop_strict</code> default action.</p> </li> </ul>
      description: 'Configuration settings for the handling of the stateful rule groups in a firewall policy. '
    ThrottlingException: {}
    EncryptionConfiguration:
      type: object
      required:
      - Type
      properties:
        KeyId:
          allOf:
          - $ref: '#/components/schemas/KeyId'
          - description: The ID of the Amazon Web Services Key Management Service (KMS) customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id">Key ID</a> in the <i>Amazon Web Services KMS Developer Guide</i>.
        Type:
          allOf:
          - $ref: '#/components/schemas/EncryptionType'
          - description: The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.
      description: A complex type that contains optional Amazon Web Services Key Management Service (KMS) encryption settings for your Network Firewall resources. Your data is encrypted by default with an Amazon Web Services owned key that Amazon Web Services owns and manages for you. You can use either the Amazon Web Services owned key, or provide your own customer managed key. To learn more about KMS encryption of your Network Firewall resources, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-encryption-at-rest.html">Encryption at rest with Amazon Web Services Key Managment Service</a> in the <i>Network Firewall Developer Guide</i>.
    StatelessActions:
      type: array
      items:
        $ref: '#/components/schemas/CollectionMember_String'
    TagList:
      type: array
      items:
        $ref: '#/components/schemas/Tag'
      minItems: 1
      maxItems: 200
    TagKey:
      type: string
      pattern: ^.*$
      minLength: 1
      maxLength: 128
    CollectionMember_String:
      type: string
    CreateFirewallPolicyResponse:
      type: object
      required:
      - UpdateToken
      - FirewallPolicyResponse
      properties:
        UpdateToken:
          allOf:
          - $ref: '#/components/schemas/UpdateToken'
          - description: <p>A token used for optimistic locking. Network Firewall returns a token to your requests that access the firewall policy. The token marks the state of the policy resource at the time of the request. </p> <p>To make changes to the policy, you provide the token in your request. Network Firewall uses the token to ensure that the policy hasn't changed since you last retrieved it. If it has changed, the operation fails with an <code>InvalidTokenException</code>. If this happens, retrieve the firewall policy again to get a current copy of it with current token. Reapply your changes as needed, then try the operation again using the new token. </p>
        FirewallPolicyResponse:
          allOf:
          - $ref: '#/components/schemas/FirewallPolicyResponse'
          - description: 'The high-level properties of a firewall policy. This, along with the <a>FirewallPolicy</a>, define the policy. You can retrieve all objects for a firewall policy by calling <a>DescribeFirewallPolicy</a>. '
    ActionDefinition:
      type: object
      properties:
        PublishMetricAction:
          allOf:
          - $ref: '#/components/schemas/PublishMetricAction'
          - description: <p>Stateless inspection criteria that publishes the specified metrics to Amazon CloudWatch for the matching packet. This setting defines a CloudWatch dimension value to be published.</p> <p>You can pair this custom action with any of the standard stateless rule actions. For example, you could pair this in a rule action with the standard action that forwards the packet for stateful inspection. Then, when a packet matches the rule, Network Firewall publishes metrics for the packet and forwards it. </p>
      description: A custom action to use in stateless rule actions settings. This is used in <a>CustomAction</a>.
    StatefulRuleGroupOverride:
      type: object
      properties:
        Action:
          allOf:
          - $ref: '#/components/schemas/OverrideAction'
          - description: The action that changes the rule group from <code>DROP</code> to <code>ALERT</code>. This only applies to managed rule groups.
      description: 'The setting that allows the policy owner to change the behavior of the rule group within a policy. '
    InternalServerError: {}
    UpdateToken:
      type: string
      pattern: ^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$
      minLength: 1
      maxLength: 1024
    ResourceId:
      type: string
      pattern: ^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$
      minLength: 36
      maxLength: 36
    StatelessRuleGroupReference:
      type: object
      required:
      - ResourceArn
      - Priority
      properties:
        ResourceArn:
          allOf:
          - $ref: '#/components/schemas/ResourceArn'
          - description: The Amazon Resource Name (ARN) of the stateless rule group.
        Priority:
          allOf:
          - $ref: '#/components/schemas/Priority'
          - description: An integer setting that indicates the order in which to run the stateless rule groups in a single <a>FirewallPolicy</a>. Network Firewall applies each stateless rule group to a packet starting with the group that has the lowest priority setting. You must ensure that the priority settings are unique within each policy.
      description: 'Identifier for a single stateless rule group, used in a firewall policy to refer to the rule group. '
    ResourceArn:
      type: string
      pattern: ^arn:aws.*
      minLength: 1
      maxLength: 256
    OverrideAction:
      type: string
      enum:
      - DROP_TO_ALERT
    Boolean:
      type: boolean
    Description:
      type: string
      pattern: ^.*$
      maxLength: 512
    ActionName:
      type: string
      pattern: ^[a-zA-Z0-9]+$
      minLength: 1
      maxLength: 128
    ResourceStatus:
      type: string
      enum:
      - ACTIVE
      - DELETING
    ResourceName:
      type: string
      pattern: ^[a-zA-Z0-9-]+$
      minLength: 1
      maxLength: 128
    StatefulRuleGroupReference:
      type: object
      required:
      - ResourceArn
      properties:
        ResourceArn:
          allOf:
          - $ref: '#/components/schemas/ResourceArn'
          - description: The Amazon Resource Name (ARN) of the stateful rule group.
        Priority:
          allOf:
          - $ref: '#/components/schemas/Priority'
          - description: <p>An integer setting that indicates the order in which to run the stateful rule groups in a single <a>FirewallPolicy</a>. This setting only applies to firewall policies that specify the <code>STRICT_ORDER</code> rule order in the stateful engine options settings.</p> <p>Network Firewall evalutes each stateful rule group against a packet starting with the group that has the lowest priority setting. You must ensure that the priority settings are unique within each policy.</p> <p>You can change the priority settings of your rule groups at any time. To make it easier to insert rule groups later, number them so there's a wide range in between, for example use 100, 200, and so on. </p>
        Override:
          allOf:
          - $ref: '#/components/schemas/StatefulRuleGroupOverride'
          - description: The action that allows the policy owner to override the behavior of the rule group within a policy.
      description: 'Identifier for a single stateful rule group, used in a firewall policy to refer to a rule group. '
    StatelessRuleGroupReferences:
      type: array
      items:
        $ref: '#/components/schemas/StatelessRuleGroupReference'
    StatefulRuleGroupReferences:
      type: array
      items:
        $ref: '#/components/schemas/StatefulRuleGroupReference'
    InvalidRequestException: {}
    Priority:
      type: integer
      minimum: 1
      maximum: 65535
    PublishMetricAction:
      type: object
      required:
      - Dimensions
      properties:
        Dimensions:
          allOf:
          - $ref: '#/components/schemas/Dimensions'
          - description: <p/>
      description: Stateless inspection criteria that publishes the specified metrics to Amazon CloudWatch for the matching packet. This setting defines a CloudWatch dimension value to be published.
    KeyId:
      type: string
      pattern: .*\S.*
      minLength: 1
      maxLength: 2048
    CustomAction:
      type: object
      required:
      - ActionName
      - ActionDefinition
      properties:
        ActionName:
          allOf:
          - $ref: '#/components/schemas/ActionName'
          - description: The descriptive name of the custom action. You can't change the name of a custom action after you create it.
        ActionDefinition:
          allOf:
          - $ref: '#/components/schemas/ActionDefinition'
          - description: The custom action associated with the action name.
      description: '<p>An optional, non-standard action to use for stateless packet handling. You can define this in addition to the standard action that you must specify. </p> <p>You define and name the custom actions that you want to be able to use, and then you reference them by name in your actions settings. </p> <p>You can use custom actions in the following places: </p> <ul> <li> <p>In a rule group''s <a>StatelessRulesAndCustomActions</a> specification. The custom actions are available for use by name inside the <code>StatelessRulesAndCustomActions</code> where you define them. You can use them for your stateless rule actions to specify what to do with a packet that matches the rule''s match attributes. </p> </li> <li> <p>In a <a>FirewallPolicy</a> specification, in <code>StatelessCustomActions</code>. The custom actions are available for use inside the policy where you define them. You can use them for the policy''s default stateless actions settings to specify what to do with packets that don''t match any of the policy''s stateless rules. </p> </li> </ul>'
    RuleCapacity:
      type: integer
    Tag:
      type: object
      required:
      - Key
      - Value
      properties:
        Key:
          allOf:
          - $ref: '#/components/schemas/TagKey'
          - description: The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
        Value:
          allOf:
          - $ref: '#/components/schemas/TagValue'
          - description: The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
      description: 'A key:value pair associated with an Amazon Web Services 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 Amazon Web Services resource. '
    CustomActions:
      type: array
      items:
        $ref: '#/components/schemas/CustomAction'
    FirewallPolicyResponse:
      type: object
      required:
      - FirewallPolicyName
      - FirewallPolicyArn
      - FirewallPolicyId
      properties:
        FirewallPolicyName:
          allOf:
          - $ref: '#/components/schemas/ResourceName'
          - description: The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.
        FirewallPolicyArn:
          allOf:
          - $ref: '#/components/schemas/ResourceArn'
          - description: <p>The Amazon Resource Name (ARN) of the firewall policy.</p> <note> <p>If this response is for a create request that had <code>DryRun</code> set to <code>TRUE</code>, then this ARN is a placeholder that isn't attached to a valid resource.</p> </note>
        FirewallPolicyId:
          allOf:
          - $ref: '#/components/schemas/ResourceId'
          - description: 'The unique identifier for the firewall policy. '
        Description:
          allOf:
          - $ref: '#/components/schemas/Description'
          - description: A description of the firewall policy.
        FirewallPolicyStatus:
          allOf:
          - $ref: '#/components/schemas/ResourceStatus'
          - description: The current status of the firewall policy. You can retrieve this for a firewall policy by calling <a>DescribeFirewallPolicy</a> and providing the firewall policy's name or ARN.
        Tags:
          allOf:
          - $ref: '#/components/schemas/TagList'
          - description: The key:value pairs to associate with the resource.
        ConsumedStatelessRuleCapacity:
          allOf:
          - $ref: '#/components/schemas/RuleCapacity'
          - description: The number of capacity units currently consumed by the policy's stateless rules.
        ConsumedStatefulRuleCapacity:
          allOf:
          - $ref: '#/components/schemas/RuleCapacity'
          - description: The number of capacity units currently consumed by the policy's stateful rules.
        NumberOfAssociations:
          allOf:
          - $ref: '#/components/schemas/NumberOfAssociations'
          - description: The number of firewalls that are associated with this firewall policy.
        EncryptionConfiguration:
          allOf:
          - $ref: '#/components/schemas/EncryptionConfiguration'
          - description: A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall policy.
        LastModifiedTime:
          allOf:
          - $ref: '#/components/schemas/LastUpdateTime'
          - description: The last time that the firewall policy was changed.
      description: 'The high-level properties of a firewall policy. This, along with the <a>FirewallPolicy</a>, define the policy. You can retrieve all objects for a firewall policy by calling <a>DescribeFirewallPolicy</a>. '
    RuleOrder:
      type: string
      enum:
      - DEFAULT_ACTION_ORDER
      - STRICT_ORDER
    LastUpdateTime:
      type: string
      format: date-time
    EncryptionType:
      type: string
      enum:
      - CUSTOMER_KMS
      - AWS_OWNED_KMS_KEY
    CreateFirewallPolicyRequest:
      type: object
      required:
      - FirewallPolicyName
      - FirewallPolicy
      title: CreateFirewallPolicyRequest
      properties:
        FirewallPolicyName:
          allOf:
          - $ref: '#/components/schemas/ResourceName'
          - description: The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.
        FirewallPolicy:
          allOf:
          - $ref: '#/components/schemas/FirewallPolicy'
          - description: The rule groups and policy actions to use in the firewall policy.
        Description:
          allOf:
          - $ref: '#/components/schemas/Description'
          - description: A description of the firewall policy.
        Tags:
          allOf:
          - $ref: '#/components/schemas/TagList'
          - description: The key:value pairs to associate with the resource.
        DryRun:
          allOf:
          - $ref: '#/components/schemas/Boolean'
          - description: <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>
        EncryptionConfiguration:
          allOf:
          - $ref: '#/components/schemas/EncryptionConfiguration'
          - description: A complex type that contains settings for encryption of your firewall policy resources.
    Dimensions:
      type: array
      items:
        $ref: '#/components/schemas/Dimension'
      minItems: 1
      maxItems: 1
    Dimension:
      type: object
      required:
      - Value
      properties:
        Value:
          allOf:
          - $ref: '#/components/schemas/DimensionValue'
          - description: The value to use in the custom metric dimension.
      description: <p>The value to use in an Amazon CloudWatch custom metric dimension. This is used in the <code>PublishMetrics</code> <a>CustomAction</a>. A CloudWatch custom metric dimension is a name/value pair that's part of the identity of a metric. </p> <p>Network Firewall sets the dimension name to <code>CustomAction</code> and you provide the dimension value. </p> <p>For more information about CloudWatch custom metric dimensions, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html#usingDimensions">Publishing Custom Metrics</a> in the <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html">Amazon CloudWatch User Guide</a>.</p>
    LimitExceededException: {}
    NumberOfAssociations:
      type: integer
  parameters:
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/network-firewall/
x-hasEquivalentPaths: true