Route53Resolver / Client / associate_firewall_rule_group

associate_firewall_rule_group#

Route53Resolver.Client.associate_firewall_rule_group(**kwargs)#

Associates a FirewallRuleGroup with a VPC, to provide DNS filtering for the VPC.

See also: AWS API Documentation

Request Syntax

response = client.associate_firewall_rule_group(
    CreatorRequestId='string',
    FirewallRuleGroupId='string',
    VpcId='string',
    Priority=123,
    Name='string',
    MutationProtection='ENABLED'|'DISABLED',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • CreatorRequestId (string) –

    [REQUIRED]

    A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

    This field is autopopulated if not provided.

  • FirewallRuleGroupId (string) –

    [REQUIRED]

    The unique identifier of the firewall rule group.

  • VpcId (string) –

    [REQUIRED]

    The unique identifier of the VPC that you want to associate with the rule group.

  • Priority (integer) –

    [REQUIRED]

    The setting that determines the processing order of the rule group among the rule groups that you associate with the specified VPC. DNS Firewall filters VPC traffic starting from the rule group with the lowest numeric priority setting.

    You must specify a unique priority for each rule group that you associate with a single VPC. To make it easier to insert rule groups later, leave space between the numbers, for example, use 101, 200, and so on. You can change the priority setting for a rule group association after you create it.

    The allowed values for Priority are between 100 and 9900.

  • Name (string) –

    [REQUIRED]

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

  • MutationProtection (string) – If enabled, this setting disallows modification or removal of the association, to help prevent against accidentally altering DNS firewall protections. When you create the association, the default setting is DISABLED.

  • Tags (list) –

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

    • (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

{
    'FirewallRuleGroupAssociation': {
        'Id': 'string',
        'Arn': 'string',
        'FirewallRuleGroupId': 'string',
        'VpcId': 'string',
        'Name': 'string',
        'Priority': 123,
        'MutationProtection': 'ENABLED'|'DISABLED',
        'ManagedOwnerName': 'string',
        'Status': 'COMPLETE'|'DELETING'|'UPDATING',
        'StatusMessage': 'string',
        'CreatorRequestId': 'string',
        'CreationTime': 'string',
        'ModificationTime': 'string'
    }
}

Response Structure

  • (dict) –

    • FirewallRuleGroupAssociation (dict) –

      The association that you just created. The association has an ID that you can use to identify it in other requests, like update and delete.

      • Id (string) –

        The identifier for the association.

      • Arn (string) –

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

      • FirewallRuleGroupId (string) –

        The unique identifier of the firewall rule group.

      • VpcId (string) –

        The unique identifier of the VPC that is associated with the rule group.

      • Name (string) –

        The name of the association.

      • Priority (integer) –

        The setting that determines the processing order of the rule group among the rule groups that are associated with a single VPC. DNS Firewall filters VPC traffic starting from rule group with the lowest numeric priority setting.

      • MutationProtection (string) –

        If enabled, this setting disallows modification or removal of the association, to help prevent against accidentally altering DNS firewall protections.

      • ManagedOwnerName (string) –

        The owner of the association, used only for associations that are not managed by you. If you use Firewall Manager to manage your DNS Firewalls, then this reports Firewall Manager as the managed owner.

      • Status (string) –

        The current status of the association.

      • StatusMessage (string) –

        Additional information about the status of the response, if available.

      • 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.

      • CreationTime (string) –

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

      • ModificationTime (string) –

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

Exceptions