Route53Resolver / Client / create_firewall_rule_group

create_firewall_rule_group#

Route53Resolver.Client.create_firewall_rule_group(**kwargs)#

Creates an empty DNS Firewall rule group for filtering DNS network traffic in a VPC. You can add rules to the new rule group by calling CreateFirewallRule.

See also: AWS API Documentation

Request Syntax

response = client.create_firewall_rule_group(
    CreatorRequestId='string',
    Name='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • CreatorRequestId (string) –

    [REQUIRED]

    A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of running the operation twice. This can be any unique string, for example, a timestamp.

    This field is autopopulated if not provided.

  • Name (string) –

    [REQUIRED]

    A name that lets you identify the rule group, to manage and use it.

  • Tags (list) –

    A list of the tag keys and values that you want to associate with the rule group.

    • (dict) –

      One tag that you want to add to the specified resource. A tag consists of a Key (a name for the tag) and a Value.

      • Key (string) – [REQUIRED]

        The name for the tag. For example, if you want to associate Resolver resources with the account IDs of your customers for billing purposes, the value of Key might be account-id.

      • Value (string) – [REQUIRED]

        The value for the tag. For example, if Key is account-id, then Value might be the ID of the customer account that you’re creating the resource for.

Return type:

dict

Returns:

Response Syntax

{
    'FirewallRuleGroup': {
        'Id': 'string',
        'Arn': 'string',
        'Name': 'string',
        'RuleCount': 123,
        'Status': 'COMPLETE'|'DELETING'|'UPDATING',
        'StatusMessage': 'string',
        'OwnerId': 'string',
        'CreatorRequestId': 'string',
        'ShareStatus': 'NOT_SHARED'|'SHARED_WITH_ME'|'SHARED_BY_ME',
        'CreationTime': 'string',
        'ModificationTime': 'string'
    }
}

Response Structure

  • (dict) –

    • FirewallRuleGroup (dict) –

      A collection of rules used to filter DNS network traffic.

      • Id (string) –

        The ID of the rule group.

      • Arn (string) –

        The ARN (Amazon Resource Name) of the rule group.

      • Name (string) –

        The name of the rule group.

      • RuleCount (integer) –

        The number of rules in the rule group.

      • Status (string) –

        The status of the domain list.

      • StatusMessage (string) –

        Additional information about the status of the rule group, if available.

      • OwnerId (string) –

        The Amazon Web Services account ID for the account that created the rule group. When a rule group is shared with your account, this is the account that has shared the rule group with you.

      • CreatorRequestId (string) –

        A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of running the operation twice. This can be any unique string, for example, a timestamp.

      • ShareStatus (string) –

        Whether the rule group is shared with other Amazon Web Services accounts, or was shared with the current account by another Amazon Web Services account. Sharing is configured through Resource Access Manager (RAM).

      • CreationTime (string) –

        The date and time that the rule group was created, in Unix time format and Coordinated Universal Time (UTC).

      • ModificationTime (string) –

        The date and time that the rule group was last modified, in Unix time format and Coordinated Universal Time (UTC).

Exceptions