Docs Home
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
aws.networkfirewall.ResourcePolicy
Explore with Pulumi AI
Provides an AWS Network Firewall Resource Policy Resource for a rule group or firewall policy.
Example Usage
For a Firewall Policy resource
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.networkfirewall.ResourcePolicy("example", {
resourceArn: exampleAwsNetworkfirewallFirewallPolicy.arn,
policy: JSON.stringify({
Statement: [{
Action: [
"network-firewall:ListFirewallPolicies",
"network-firewall:CreateFirewall",
"network-firewall:UpdateFirewall",
"network-firewall:AssociateFirewallPolicy",
],
Effect: "Allow",
Resource: exampleAwsNetworkfirewallFirewallPolicy.arn,
Principal: {
AWS: "arn:aws:iam::123456789012:root",
},
}],
Version: "2012-10-17",
}),
});
import pulumi
import json
import pulumi_aws as aws
example = aws.networkfirewall.ResourcePolicy("example",
resource_arn=example_aws_networkfirewall_firewall_policy["arn"],
policy=json.dumps({
"Statement": [{
"Action": [
"network-firewall:ListFirewallPolicies",
"network-firewall:CreateFirewall",
"network-firewall:UpdateFirewall",
"network-firewall:AssociateFirewallPolicy",
],
"Effect": "Allow",
"Resource": example_aws_networkfirewall_firewall_policy["arn"],
"Principal": {
"AWS": "arn:aws:iam::123456789012:root",
},
}],
"Version": "2012-10-17",
}))
package main
import (
"encoding/json"
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/networkfirewall"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
tmpJSON0, err := json.Marshal(map[string]interface{}{
"Statement": []map[string]interface{}{
map[string]interface{}{
"Action": []string{
"network-firewall:ListFirewallPolicies",
"network-firewall:CreateFirewall",
"network-firewall:UpdateFirewall",
"network-firewall:AssociateFirewallPolicy",
},
"Effect": "Allow",
"Resource": exampleAwsNetworkfirewallFirewallPolicy.Arn,
"Principal": map[string]interface{}{
"AWS": "arn:aws:iam::123456789012:root",
},
},
},
"Version": "2012-10-17",
})
if err != nil {
return err
}
json0 := string(tmpJSON0)
_, err = networkfirewall.NewResourcePolicy(ctx, "example", &networkfirewall.ResourcePolicyArgs{
ResourceArn: pulumi.Any(exampleAwsNetworkfirewallFirewallPolicy.Arn),
Policy: pulumi.String(json0),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.NetworkFirewall.ResourcePolicy("example", new()
{
ResourceArn = exampleAwsNetworkfirewallFirewallPolicy.Arn,
Policy = JsonSerializer.Serialize(new Dictionary<string, object?>
{
["Statement"] = new[]
{
new Dictionary<string, object?>
{
["Action"] = new[]
{
"network-firewall:ListFirewallPolicies",
"network-firewall:CreateFirewall",
"network-firewall:UpdateFirewall",
"network-firewall:AssociateFirewallPolicy",
},
["Effect"] = "Allow",
["Resource"] = exampleAwsNetworkfirewallFirewallPolicy.Arn,
["Principal"] = new Dictionary<string, object?>
{
["AWS"] = "arn:aws:iam::123456789012:root",
},
},
},
["Version"] = "2012-10-17",
}),
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.networkfirewall.ResourcePolicy;
import com.pulumi.aws.networkfirewall.ResourcePolicyArgs;
import static com.pulumi.codegen.internal.Serialization.*;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new ResourcePolicy("example", ResourcePolicyArgs.builder()
.resourceArn(exampleAwsNetworkfirewallFirewallPolicy.arn())
.policy(serializeJson(
jsonObject(
jsonProperty("Statement", jsonArray(jsonObject(
jsonProperty("Action", jsonArray(
"network-firewall:ListFirewallPolicies",
"network-firewall:CreateFirewall",
"network-firewall:UpdateFirewall",
"network-firewall:AssociateFirewallPolicy"
)),
jsonProperty("Effect", "Allow"),
jsonProperty("Resource", exampleAwsNetworkfirewallFirewallPolicy.arn()),
jsonProperty("Principal", jsonObject(
jsonProperty("AWS", "arn:aws:iam::123456789012:root")
))
))),
jsonProperty("Version", "2012-10-17")
)))
.build());
}
}
resources:
example:
type: aws:networkfirewall:ResourcePolicy
properties:
resourceArn: ${exampleAwsNetworkfirewallFirewallPolicy.arn}
policy:
fn::toJSON:
Statement:
- Action:
- network-firewall:ListFirewallPolicies
- network-firewall:CreateFirewall
- network-firewall:UpdateFirewall
- network-firewall:AssociateFirewallPolicy
Effect: Allow
Resource: ${exampleAwsNetworkfirewallFirewallPolicy.arn}
Principal:
AWS: arn:aws:iam::123456789012:root
Version: 2012-10-17
For a Rule Group resource
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.networkfirewall.ResourcePolicy("example", {
resourceArn: exampleAwsNetworkfirewallRuleGroup.arn,
policy: JSON.stringify({
Statement: [{
Action: [
"network-firewall:ListRuleGroups",
"network-firewall:CreateFirewallPolicy",
"network-firewall:UpdateFirewallPolicy",
],
Effect: "Allow",
Resource: exampleAwsNetworkfirewallRuleGroup.arn,
Principal: {
AWS: "arn:aws:iam::123456789012:root",
},
}],
Version: "2012-10-17",
}),
});
import pulumi
import json
import pulumi_aws as aws
example = aws.networkfirewall.ResourcePolicy("example",
resource_arn=example_aws_networkfirewall_rule_group["arn"],
policy=json.dumps({
"Statement": [{
"Action": [
"network-firewall:ListRuleGroups",
"network-firewall:CreateFirewallPolicy",
"network-firewall:UpdateFirewallPolicy",
],
"Effect": "Allow",
"Resource": example_aws_networkfirewall_rule_group["arn"],
"Principal": {
"AWS": "arn:aws:iam::123456789012:root",
},
}],
"Version": "2012-10-17",
}))
package main
import (
"encoding/json"
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/networkfirewall"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
tmpJSON0, err := json.Marshal(map[string]interface{}{
"Statement": []map[string]interface{}{
map[string]interface{}{
"Action": []string{
"network-firewall:ListRuleGroups",
"network-firewall:CreateFirewallPolicy",
"network-firewall:UpdateFirewallPolicy",
},
"Effect": "Allow",
"Resource": exampleAwsNetworkfirewallRuleGroup.Arn,
"Principal": map[string]interface{}{
"AWS": "arn:aws:iam::123456789012:root",
},
},
},
"Version": "2012-10-17",
})
if err != nil {
return err
}
json0 := string(tmpJSON0)
_, err = networkfirewall.NewResourcePolicy(ctx, "example", &networkfirewall.ResourcePolicyArgs{
ResourceArn: pulumi.Any(exampleAwsNetworkfirewallRuleGroup.Arn),
Policy: pulumi.String(json0),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.NetworkFirewall.ResourcePolicy("example", new()
{
ResourceArn = exampleAwsNetworkfirewallRuleGroup.Arn,
Policy = JsonSerializer.Serialize(new Dictionary<string, object?>
{
["Statement"] = new[]
{
new Dictionary<string, object?>
{
["Action"] = new[]
{
"network-firewall:ListRuleGroups",
"network-firewall:CreateFirewallPolicy",
"network-firewall:UpdateFirewallPolicy",
},
["Effect"] = "Allow",
["Resource"] = exampleAwsNetworkfirewallRuleGroup.Arn,
["Principal"] = new Dictionary<string, object?>
{
["AWS"] = "arn:aws:iam::123456789012:root",
},
},
},
["Version"] = "2012-10-17",
}),
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.networkfirewall.ResourcePolicy;
import com.pulumi.aws.networkfirewall.ResourcePolicyArgs;
import static com.pulumi.codegen.internal.Serialization.*;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new ResourcePolicy("example", ResourcePolicyArgs.builder()
.resourceArn(exampleAwsNetworkfirewallRuleGroup.arn())
.policy(serializeJson(
jsonObject(
jsonProperty("Statement", jsonArray(jsonObject(
jsonProperty("Action", jsonArray(
"network-firewall:ListRuleGroups",
"network-firewall:CreateFirewallPolicy",
"network-firewall:UpdateFirewallPolicy"
)),
jsonProperty("Effect", "Allow"),
jsonProperty("Resource", exampleAwsNetworkfirewallRuleGroup.arn()),
jsonProperty("Principal", jsonObject(
jsonProperty("AWS", "arn:aws:iam::123456789012:root")
))
))),
jsonProperty("Version", "2012-10-17")
)))
.build());
}
}
resources:
example:
type: aws:networkfirewall:ResourcePolicy
properties:
resourceArn: ${exampleAwsNetworkfirewallRuleGroup.arn}
policy:
fn::toJSON:
Statement:
- Action:
- network-firewall:ListRuleGroups
- network-firewall:CreateFirewallPolicy
- network-firewall:UpdateFirewallPolicy
Effect: Allow
Resource: ${exampleAwsNetworkfirewallRuleGroup.arn}
Principal:
AWS: arn:aws:iam::123456789012:root
Version: 2012-10-17
Create ResourcePolicy Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ResourcePolicy(name: string, args: ResourcePolicyArgs, opts?: CustomResourceOptions);@overload
def ResourcePolicy(resource_name: str,
args: ResourcePolicyArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ResourcePolicy(resource_name: str,
opts: Optional[ResourceOptions] = None,
policy: Optional[str] = None,
resource_arn: Optional[str] = None)func NewResourcePolicy(ctx *Context, name string, args ResourcePolicyArgs, opts ...ResourceOption) (*ResourcePolicy, error)public ResourcePolicy(string name, ResourcePolicyArgs args, CustomResourceOptions? opts = null)
public ResourcePolicy(String name, ResourcePolicyArgs args)
public ResourcePolicy(String name, ResourcePolicyArgs args, CustomResourceOptions options)
type: aws:networkfirewall:ResourcePolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ResourcePolicyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ResourcePolicyArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ResourcePolicyArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ResourcePolicyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ResourcePolicyArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var exampleresourcePolicyResourceResourceFromNetworkfirewallresourcePolicy = new Aws.NetworkFirewall.ResourcePolicy("exampleresourcePolicyResourceResourceFromNetworkfirewallresourcePolicy", new()
{
Policy = "string",
ResourceArn = "string",
});
example, err := networkfirewall.NewResourcePolicy(ctx, "exampleresourcePolicyResourceResourceFromNetworkfirewallresourcePolicy", &networkfirewall.ResourcePolicyArgs{
Policy: pulumi.String("string"),
ResourceArn: pulumi.String("string"),
})
var exampleresourcePolicyResourceResourceFromNetworkfirewallresourcePolicy = new ResourcePolicy("exampleresourcePolicyResourceResourceFromNetworkfirewallresourcePolicy", ResourcePolicyArgs.builder()
.policy("string")
.resourceArn("string")
.build());
exampleresource_policy_resource_resource_from_networkfirewallresource_policy = aws.networkfirewall.ResourcePolicy("exampleresourcePolicyResourceResourceFromNetworkfirewallresourcePolicy",
policy="string",
resource_arn="string")
const exampleresourcePolicyResourceResourceFromNetworkfirewallresourcePolicy = new aws.networkfirewall.ResourcePolicy("exampleresourcePolicyResourceResourceFromNetworkfirewallresourcePolicy", {
policy: "string",
resourceArn: "string",
});
type: aws:networkfirewall:ResourcePolicy
properties:
policy: string
resourceArn: string
ResourcePolicy Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ResourcePolicy resource accepts the following input properties:
- Policy string
- JSON formatted policy document that controls access to the Network Firewall resource. The policy must be provided without whitespaces. We recommend using jsonencode for formatting as seen in the examples above. For more details, including available policy statement Actions, see the Policy parameter in the AWS API documentation.
- Resource
Arn string - The Amazon Resource Name (ARN) of the rule group or firewall policy.
- Policy string
- JSON formatted policy document that controls access to the Network Firewall resource. The policy must be provided without whitespaces. We recommend using jsonencode for formatting as seen in the examples above. For more details, including available policy statement Actions, see the Policy parameter in the AWS API documentation.
- Resource
Arn string - The Amazon Resource Name (ARN) of the rule group or firewall policy.
- policy String
- JSON formatted policy document that controls access to the Network Firewall resource. The policy must be provided without whitespaces. We recommend using jsonencode for formatting as seen in the examples above. For more details, including available policy statement Actions, see the Policy parameter in the AWS API documentation.
- resource
Arn String - The Amazon Resource Name (ARN) of the rule group or firewall policy.
- policy string
- JSON formatted policy document that controls access to the Network Firewall resource. The policy must be provided without whitespaces. We recommend using jsonencode for formatting as seen in the examples above. For more details, including available policy statement Actions, see the Policy parameter in the AWS API documentation.
- resource
Arn string - The Amazon Resource Name (ARN) of the rule group or firewall policy.
- policy str
- JSON formatted policy document that controls access to the Network Firewall resource. The policy must be provided without whitespaces. We recommend using jsonencode for formatting as seen in the examples above. For more details, including available policy statement Actions, see the Policy parameter in the AWS API documentation.
- resource_
arn str - The Amazon Resource Name (ARN) of the rule group or firewall policy.
- policy String
- JSON formatted policy document that controls access to the Network Firewall resource. The policy must be provided without whitespaces. We recommend using jsonencode for formatting as seen in the examples above. For more details, including available policy statement Actions, see the Policy parameter in the AWS API documentation.
- resource
Arn String - The Amazon Resource Name (ARN) of the rule group or firewall policy.
Outputs
All input properties are implicitly available as output properties. Additionally, the ResourcePolicy resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing ResourcePolicy Resource
Get an existing ResourcePolicy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ResourcePolicyState, opts?: CustomResourceOptions): ResourcePolicy@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
policy: Optional[str] = None,
resource_arn: Optional[str] = None) -> ResourcePolicyfunc GetResourcePolicy(ctx *Context, name string, id IDInput, state *ResourcePolicyState, opts ...ResourceOption) (*ResourcePolicy, error)public static ResourcePolicy Get(string name, Input<string> id, ResourcePolicyState? state, CustomResourceOptions? opts = null)public static ResourcePolicy get(String name, Output<String> id, ResourcePolicyState state, CustomResourceOptions options)Resource lookup is not supported in YAML- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Policy string
- JSON formatted policy document that controls access to the Network Firewall resource. The policy must be provided without whitespaces. We recommend using jsonencode for formatting as seen in the examples above. For more details, including available policy statement Actions, see the Policy parameter in the AWS API documentation.
- Resource
Arn string - The Amazon Resource Name (ARN) of the rule group or firewall policy.
- Policy string
- JSON formatted policy document that controls access to the Network Firewall resource. The policy must be provided without whitespaces. We recommend using jsonencode for formatting as seen in the examples above. For more details, including available policy statement Actions, see the Policy parameter in the AWS API documentation.
- Resource
Arn string - The Amazon Resource Name (ARN) of the rule group or firewall policy.
- policy String
- JSON formatted policy document that controls access to the Network Firewall resource. The policy must be provided without whitespaces. We recommend using jsonencode for formatting as seen in the examples above. For more details, including available policy statement Actions, see the Policy parameter in the AWS API documentation.
- resource
Arn String - The Amazon Resource Name (ARN) of the rule group or firewall policy.
- policy string
- JSON formatted policy document that controls access to the Network Firewall resource. The policy must be provided without whitespaces. We recommend using jsonencode for formatting as seen in the examples above. For more details, including available policy statement Actions, see the Policy parameter in the AWS API documentation.
- resource
Arn string - The Amazon Resource Name (ARN) of the rule group or firewall policy.
- policy str
- JSON formatted policy document that controls access to the Network Firewall resource. The policy must be provided without whitespaces. We recommend using jsonencode for formatting as seen in the examples above. For more details, including available policy statement Actions, see the Policy parameter in the AWS API documentation.
- resource_
arn str - The Amazon Resource Name (ARN) of the rule group or firewall policy.
- policy String
- JSON formatted policy document that controls access to the Network Firewall resource. The policy must be provided without whitespaces. We recommend using jsonencode for formatting as seen in the examples above. For more details, including available policy statement Actions, see the Policy parameter in the AWS API documentation.
- resource
Arn String - The Amazon Resource Name (ARN) of the rule group or firewall policy.
Import
Using pulumi import, import Network Firewall Resource Policies using the resource arn. For example:
$ pulumi import aws:networkfirewall/resourcePolicy:ResourcePolicy example arn:aws:network-firewall:us-west-1:123456789012:stateful-rulegroup/example
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
awsTerraform Provider.