NetworkFirewall / Client / create_proxy_configuration

create_proxy_configuration¶

NetworkFirewall.Client.create_proxy_configuration(**kwargs)¶

Creates an Network Firewall ProxyConfiguration

A Proxy Configuration defines the monitoring and protection behavior for a Proxy. The details of the behavior are defined in the rule groups that you add to your configuration.

To manage a proxy configuration’s tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource.

To retrieve information about proxies, use ListProxyConfigurations and DescribeProxyConfiguration.

Request Syntax

response = client.create_proxy_configuration(
    ProxyConfigurationName='string',
    Description='string',
    RuleGroupNames=[
        'string',
    ],
    RuleGroupArns=[
        'string',
    ],
    DefaultRulePhaseActions={
        'PreDNS': 'ALLOW'|'DENY'|'ALERT',
        'PreREQUEST': 'ALLOW'|'DENY'|'ALERT',
        'PostRESPONSE': 'ALLOW'|'DENY'|'ALERT'
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

ProxyConfigurationName (string) –
[REQUIRED]

The descriptive name of the proxy configuration. You can’t change the name of a proxy configuration after you create it.
Description (string) – A description of the proxy configuration.
RuleGroupNames (list) –
The proxy rule group name(s) to attach to the proxy configuration.

You must specify the ARNs or the names, and you can specify both.
- (string) –
RuleGroupArns (list) –
The proxy rule group arn(s) to attach to the proxy configuration.

You must specify the ARNs or the names, and you can specify both.
- (string) –
DefaultRulePhaseActions (dict) –
[REQUIRED]

Evaluation points in the traffic flow where rules are applied. There are three phases in a traffic where the rule match is applied.
- PreDNS (string) –
  
  Before domain resolution.
- PreREQUEST (string) –
  
  After DNS, before request.
- PostRESPONSE (string) –
  
  After receiving response.
Tags (list) –
The key:value pairs to associate with the resource.
- (dict) –
  
  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.
  - Key (string) – [REQUIRED]
    
    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 (string) – [REQUIRED]
    
    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.

Return type:

dict

Returns:

Response Syntax

{
    'ProxyConfiguration': {
        'ProxyConfigurationName': 'string',
        'ProxyConfigurationArn': 'string',
        'Description': 'string',
        'CreateTime': datetime(2015, 1, 1),
        'DeleteTime': datetime(2015, 1, 1),
        'RuleGroups': [
            {
                'ProxyRuleGroupName': 'string',
                'ProxyRuleGroupArn': 'string',
                'Type': 'string',
                'Priority': 123
            },
        ],
        'DefaultRulePhaseActions': {
            'PreDNS': 'ALLOW'|'DENY'|'ALERT',
            'PreREQUEST': 'ALLOW'|'DENY'|'ALERT',
            'PostRESPONSE': 'ALLOW'|'DENY'|'ALERT'
        },
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    },
    'UpdateToken': 'string'
}

Response Structure

(dict) –
- ProxyConfiguration (dict) –
  
  The properties that define the proxy configuration.
  - ProxyConfigurationName (string) –
    
    The descriptive name of the proxy configuration. You can’t change the name of a proxy configuration after you create it.
  - ProxyConfigurationArn (string) –
    
    The Amazon Resource Name (ARN) of a proxy configuration.
  - Description (string) –
    
    A description of the proxy configuration.
  - CreateTime (datetime) –
    
    Time the Proxy Configuration was created.
  - DeleteTime (datetime) –
    
    Time the Proxy Configuration was deleted.
  - RuleGroups (list) –
    
    Proxy rule groups within the proxy configuration.
    - (dict) –
      
      Proxy rule group contained within a proxy configuration.
      - ProxyRuleGroupName (string) –
        
        The descriptive name of the proxy rule group. You can’t change the name of a proxy rule group after you create it.
      - ProxyRuleGroupArn (string) –
        
        The Amazon Resource Name (ARN) of a proxy rule group.
      - Type (string) –
        
        Proxy rule group type.
      - Priority (integer) –
        
        Priority of the proxy rule group in the proxy configuration.
  - DefaultRulePhaseActions (dict) –
    
    Evaluation points in the traffic flow where rules are applied. There are three phases in a traffic where the rule match is applied.
    
    Pre-DNS - before domain resolution.
    
    Pre-Request - after DNS, before request.
    
    Post-Response - after receiving response.
    - PreDNS (string) –
      
      Before domain resolution.
    - PreREQUEST (string) –
      
      After DNS, before request.
    - PostRESPONSE (string) –
      
      After receiving response.
  - Tags (list) –
    
    The key:value pairs to associate with the resource.
    - (dict) –
      
      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.
      - Key (string) –
        
        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 (string) –
        
        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.
- UpdateToken (string) –
  
  A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy configuration. The token marks the state of the proxy configuration resource at the time of the request.
  
  To make changes to the proxy configuration, you provide the token in your request. Network Firewall uses the token to ensure that the proxy configuration hasn’t changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy configuration again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

create_proxy_configuration¶

Request Syntax

Response Syntax

Response Structure

Exceptions