Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . route53resolver ]

associate-firewall-rule-group

Description

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  associate-firewall-rule-group
[--creator-request-id <value>]
--firewall-rule-group-id <value>
--vpc-id <value>
--priority <value>
--name <value>
[--mutation-protection <value>]
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--creator-request-id (string)

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.

--firewall-rule-group-id (string)

The unique identifier of the firewall rule group.

--vpc-id (string)

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

--priority (integer)

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)

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

--mutation-protection (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 .

Possible values:

  • ENABLED
  • DISABLED

--tags (list)

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

(structure)

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)

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)

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.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To associate a firewall rule group with a VPC

The following associate-firewall-rule-group example associates a DNS Firewall rule group with an Amazon VPC.

aws route53resolver associate-firewall-rule-group \
    --name test-association \
    --firewall-rule-group-id rslvr-frg-47f93271fexample \
    --vpc-id vpc-31e92222 \
    --priority 101

Output:

{
    "FirewallRuleGroupAssociation": {
        "Id": "rslvr-frgassoc-57e8873d7example",
        "Arn": "arn:aws:route53resolver:us-west-2:123456789012:firewall-rule-group-association/rslvr-frgassoc-57e8873d7example",
        "FirewallRuleGroupId": "rslvr-frg-47f93271fexample",
        "VpcId": "vpc-31e92222",
        "Name": "test-association",
        "Priority": 101,
        "MutationProtection": "DISABLED",
        "Status": "UPDATING",
        "StatusMessage": "Creating Firewall Rule Group Association",
        "CreatorRequestId": "2ca1a304-32b3-4f5f-bc4c-EXAMPLE11111",
        "CreationTime": "2021-05-25T21:47:48.755768Z",
        "ModificationTime": "2021-05-25T21:47:48.755768Z"
    }
}

For more information, see Managing associations between your VPC and Route 53 Resolver DNS Firewall rule groups in the Amazon Route 53 Developer Guide.

Output

FirewallRuleGroupAssociation -> (structure)

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