- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
PutFirewallRuleGroupPolicyCommand
Attaches an Identity and Access Management (Amazon Web Services IAM) policy for sharing the rule group. You can use the policy to share the rule group using Resource Access Manager (RAM).
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { Route53ResolverClient, PutFirewallRuleGroupPolicyCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import
// const { Route53ResolverClient, PutFirewallRuleGroupPolicyCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import
const client = new Route53ResolverClient(config);
const input = { // PutFirewallRuleGroupPolicyRequest
Arn: "STRING_VALUE", // required
FirewallRuleGroupPolicy: "STRING_VALUE", // required
};
const command = new PutFirewallRuleGroupPolicyCommand(input);
const response = await client.send(command);
// { // PutFirewallRuleGroupPolicyResponse
// ReturnValue: true || false,
// };
PutFirewallRuleGroupPolicyCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
ArnRequired | string | undefined | The ARN (Amazon Resource Name) for the rule group that you want to share. |
FirewallRuleGroupPolicyRequired | string | undefined | The Identity and Access Management (Amazon Web Services IAM) policy to attach to the rule group. |
PutFirewallRuleGroupPolicyCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
ReturnValue | boolean | undefined |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| AccessDeniedException | client | The current account doesn't have the IAM permissions required to perform the specified Resolver operation. This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs. |
| InternalServiceErrorException | client | We encountered an unknown error. Try again in a few minutes. |
| ResourceNotFoundException | client | The specified resource doesn't exist. |
| ThrottlingException | client | The request was throttled. Try again in a few minutes. |
| ValidationException | client | You have provided an invalid command. If you ran the |
| Route53ResolverServiceException | Base exception class for all service exceptions from Route53Resolver service. |