Skip to content

Commit

Permalink
Minor docs tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
tremble committed Apr 22, 2022
1 parent 5a5e21b commit 04b217c
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 4 deletions.
28 changes: 28 additions & 0 deletions plugins/modules/networkfirewall_policy.py
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,34 @@
'''

EXAMPLES = '''
# Create an AWS Network Firewall Policy with default rule order
- community.aws.networkfirewall_policy:
stateful_rule_order: 'default'
state: present
name: 'ExamplePolicy'
# Create an AWS Network Firewall Policy with strict rule order
- community.aws.networkfirewall_policy:
stateful_rule_order: 'strict'
state: present
name: 'ExampleStrictPolicy'
# Create an AWS Network Firewall Policy that defaults to dropping all packets
- community.aws.networkfirewall_policy:
stateful_rule_order: 'strict'
state: present
name: 'ExampleDropPolicy'
stateful_default_actions:
- 'aws:drop_strict'
stateful_rule_groups:
- 'ExampleStrictRuleGroup'
- 'arn:aws:network-firewall:us-east-1:aws-managed:stateful-rulegroup/BotNetCommandAndControlDomainsStrictOrder'
# Delete an AWS Network Firewall Policy
- community.aws.networkfirewall_policy:
state: absent
name: 'ExampleDropPolicy'
'''

RETURN = '''
Expand Down
8 changes: 4 additions & 4 deletions plugins/modules/networkfirewall_policy_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,13 @@
arn:
description:
- The ARN of the Network Firewall policy.
- Mutually exclusive with I(name).
required: false
type: str
name:
description:
- The name of the Network Firewall policy.
- Mutually exclusive with I(arn).
required: false
type: str
Expand All @@ -36,14 +38,12 @@
- community.aws.networkfirewall_policy_info: {}
# Describe a Firewall policy by ARN
- community.aws.networkfirewall_rule_group_info:
- community.aws.networkfirewall_policy_info:
arn: arn:aws:network-firewall:us-east-1:123456789012:firewall-policy/ExamplePolicy
# Describe a Firewall policy by name
- community.aws.networkfirewall_rule_group_info:
- community.aws.networkfirewall_policy_info:
name: ExamplePolicy
type: stateful
'''

RETURN = '''
Expand Down

0 comments on commit 04b217c

Please sign in to comment.