resource_policies
Creates, updates, deletes, gets or lists a resource_policies resource.
Overview
| Name | resource_policies |
| Type | Resource |
| Id | aws.network_firewall.resource_policies |
Fields
The following fields are returned by SELECT queries:
- describe_resource_policy
| Name | Datatype | Description |
|---|---|---|
policy | string | The IAM policy for the resource. (pattern: <code>.\S.</code>) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_resource_policy | select | region | Retrieves a resource policy that you created in a PutResourcePolicy request. | |
put_resource_policy | replace | region, ResourceArn | Creates or updates an IAM policy for your rule group, firewall policy, or firewall. Use this to share these resources between accounts. This operation works in conjunction with the Amazon Web Services Resource Access Manager (RAM) service to manage resource sharing for Network Firewall. For information about using sharing with Network Firewall resources, see Sharing Network Firewall resources in the Network Firewall Developer Guide. Use this operation to create or update a resource policy for your Network Firewall rule group, firewall policy, or firewall. In the resource policy, you specify the accounts that you want to share the Network Firewall resource with and the operations that you want the accounts to be able to perform. When you add an account in the resource policy, you then run the following Resource Access Manager (RAM) operations to access and accept the shared resource. GetResourceShareInvitations - Returns the Amazon Resource Names (ARNs) of the resource share invitations. AcceptResourceShareInvitation - Accepts the share invitation for a specified resource share. For additional information about resource sharing using RAM, see Resource Access Manager User Guide. | |
delete_resource_policy | delete | region | Deletes a resource policy that you created in a PutResourcePolicy request. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- describe_resource_policy
Retrieves a resource policy that you created in a PutResourcePolicy request.
SELECT
policy
FROM aws.network_firewall.resource_policies
WHERE region = '{{ region }}' -- required
;
REPLACE examples
- put_resource_policy
Creates or updates an IAM policy for your rule group, firewall policy, or firewall. Use this to share these resources between accounts. This operation works in conjunction with the Amazon Web Services Resource Access Manager (RAM) service to manage resource sharing for Network Firewall. For information about using sharing with Network Firewall resources, see Sharing Network Firewall resources in the Network Firewall Developer Guide. Use this operation to create or update a resource policy for your Network Firewall rule group, firewall policy, or firewall. In the resource policy, you specify the accounts that you want to share the Network Firewall resource with and the operations that you want the accounts to be able to perform. When you add an account in the resource policy, you then run the following Resource Access Manager (RAM) operations to access and accept the shared resource. GetResourceShareInvitations - Returns the Amazon Resource Names (ARNs) of the resource share invitations. AcceptResourceShareInvitation - Accepts the share invitation for a specified resource share. For additional information about resource sharing using RAM, see Resource Access Manager User Guide.
REPLACE aws.network_firewall.resource_policies
SET
ResourceArn = '{{ ResourceArn }}',
Policy = '{{ Policy }}'
WHERE
region = '{{ region }}' --required
AND ResourceArn = '{{ ResourceArn }}' --required;
DELETE examples
- delete_resource_policy
Deletes a resource policy that you created in a PutResourcePolicy request.
DELETE FROM aws.network_firewall.resource_policies
WHERE region = '{{ region }}' --required
;