Civo

Pulumi Official
Package maintained by Pulumi
v2.2.4 published on Friday, Jul 29, 2022 by Pulumi

FirewallRule

Provides a Civo firewall rule resource. This can be used to create, modify, and delete firewalls rules. This resource don’t have an update option because Civo backend doesn’t support it at this moment. In that case, we use ForceNew for all object in the resource.

Create a FirewallRule Resource

new FirewallRule(name: string, args: FirewallRuleArgs, opts?: CustomResourceOptions);
@overload
def FirewallRule(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 action: Optional[str] = None,
                 cidrs: Optional[Sequence[str]] = None,
                 direction: Optional[str] = None,
                 end_port: Optional[str] = None,
                 firewall_id: Optional[str] = None,
                 label: Optional[str] = None,
                 protocol: Optional[str] = None,
                 region: Optional[str] = None,
                 start_port: Optional[str] = None)
@overload
def FirewallRule(resource_name: str,
                 args: FirewallRuleArgs,
                 opts: Optional[ResourceOptions] = None)
func NewFirewallRule(ctx *Context, name string, args FirewallRuleArgs, opts ...ResourceOption) (*FirewallRule, error)
public FirewallRule(string name, FirewallRuleArgs args, CustomResourceOptions? opts = null)
public FirewallRule(String name, FirewallRuleArgs args)
public FirewallRule(String name, FirewallRuleArgs args, CustomResourceOptions options)
type: civo:FirewallRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args FirewallRuleArgs
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 FirewallRuleArgs
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 FirewallRuleArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args FirewallRuleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args FirewallRuleArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

FirewallRule Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The FirewallRule resource accepts the following input properties:

Action string

The action of the rule can be allow or deny. When we set the action = 'allow', this is going to add a rule to allow traffic. Similarly, setting action = 'deny' will deny the traffic.

Cidrs List<string>

The CIDR notation of the other end to affect, or a valid network CIDR (e.g. 0.0.0.0/0 to open for everyone or 1.2.3.4/32 to open just for a specific IP address)

Direction string

The direction of the rule can be ingress or egress

FirewallId string

The Firewall ID

EndPort string

The end of the port range (this is optional, by default it will only apply to the single port listed in start_port)

Label string

A string that will be the displayed name/reference for this rule

Protocol string

The protocol choice from tcp, udp or icmp (the default if unspecified is tcp)

Region string

The region for this rule

StartPort string

The start of the port range to configure for this rule (or the single port if required)

Action string

The action of the rule can be allow or deny. When we set the action = 'allow', this is going to add a rule to allow traffic. Similarly, setting action = 'deny' will deny the traffic.

Cidrs []string

The CIDR notation of the other end to affect, or a valid network CIDR (e.g. 0.0.0.0/0 to open for everyone or 1.2.3.4/32 to open just for a specific IP address)

Direction string

The direction of the rule can be ingress or egress

FirewallId string

The Firewall ID

EndPort string

The end of the port range (this is optional, by default it will only apply to the single port listed in start_port)

Label string

A string that will be the displayed name/reference for this rule

Protocol string

The protocol choice from tcp, udp or icmp (the default if unspecified is tcp)

Region string

The region for this rule

StartPort string

The start of the port range to configure for this rule (or the single port if required)

action String

The action of the rule can be allow or deny. When we set the action = 'allow', this is going to add a rule to allow traffic. Similarly, setting action = 'deny' will deny the traffic.

cidrs List<String>

The CIDR notation of the other end to affect, or a valid network CIDR (e.g. 0.0.0.0/0 to open for everyone or 1.2.3.4/32 to open just for a specific IP address)

direction String

The direction of the rule can be ingress or egress

firewallId String

The Firewall ID

endPort String

The end of the port range (this is optional, by default it will only apply to the single port listed in start_port)

label String

A string that will be the displayed name/reference for this rule

protocol String

The protocol choice from tcp, udp or icmp (the default if unspecified is tcp)

region String

The region for this rule

startPort String

The start of the port range to configure for this rule (or the single port if required)

action string

The action of the rule can be allow or deny. When we set the action = 'allow', this is going to add a rule to allow traffic. Similarly, setting action = 'deny' will deny the traffic.

cidrs string[]

The CIDR notation of the other end to affect, or a valid network CIDR (e.g. 0.0.0.0/0 to open for everyone or 1.2.3.4/32 to open just for a specific IP address)

direction string

The direction of the rule can be ingress or egress

firewallId string

The Firewall ID

endPort string

The end of the port range (this is optional, by default it will only apply to the single port listed in start_port)

label string

A string that will be the displayed name/reference for this rule

protocol string

The protocol choice from tcp, udp or icmp (the default if unspecified is tcp)

region string

The region for this rule

startPort string

The start of the port range to configure for this rule (or the single port if required)

action str

The action of the rule can be allow or deny. When we set the action = 'allow', this is going to add a rule to allow traffic. Similarly, setting action = 'deny' will deny the traffic.

cidrs Sequence[str]

The CIDR notation of the other end to affect, or a valid network CIDR (e.g. 0.0.0.0/0 to open for everyone or 1.2.3.4/32 to open just for a specific IP address)

direction str

The direction of the rule can be ingress or egress

firewall_id str

The Firewall ID

end_port str

The end of the port range (this is optional, by default it will only apply to the single port listed in start_port)

label str

A string that will be the displayed name/reference for this rule

protocol str

The protocol choice from tcp, udp or icmp (the default if unspecified is tcp)

region str

The region for this rule

start_port str

The start of the port range to configure for this rule (or the single port if required)

action String

The action of the rule can be allow or deny. When we set the action = 'allow', this is going to add a rule to allow traffic. Similarly, setting action = 'deny' will deny the traffic.

cidrs List<String>

The CIDR notation of the other end to affect, or a valid network CIDR (e.g. 0.0.0.0/0 to open for everyone or 1.2.3.4/32 to open just for a specific IP address)

direction String

The direction of the rule can be ingress or egress

firewallId String

The Firewall ID

endPort String

The end of the port range (this is optional, by default it will only apply to the single port listed in start_port)

label String

A string that will be the displayed name/reference for this rule

protocol String

The protocol choice from tcp, udp or icmp (the default if unspecified is tcp)

region String

The region for this rule

startPort String

The start of the port range to configure for this rule (or the single port if required)

Outputs

All input properties are implicitly available as output properties. Additionally, the FirewallRule 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 an Existing FirewallRule Resource

Get an existing FirewallRule 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?: FirewallRuleState, opts?: CustomResourceOptions): FirewallRule
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        action: Optional[str] = None,
        cidrs: Optional[Sequence[str]] = None,
        direction: Optional[str] = None,
        end_port: Optional[str] = None,
        firewall_id: Optional[str] = None,
        label: Optional[str] = None,
        protocol: Optional[str] = None,
        region: Optional[str] = None,
        start_port: Optional[str] = None) -> FirewallRule
func GetFirewallRule(ctx *Context, name string, id IDInput, state *FirewallRuleState, opts ...ResourceOption) (*FirewallRule, error)
public static FirewallRule Get(string name, Input<string> id, FirewallRuleState? state, CustomResourceOptions? opts = null)
public static FirewallRule get(String name, Output<String> id, FirewallRuleState 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.
The following state arguments are supported:
Action string

The action of the rule can be allow or deny. When we set the action = 'allow', this is going to add a rule to allow traffic. Similarly, setting action = 'deny' will deny the traffic.

Cidrs List<string>

The CIDR notation of the other end to affect, or a valid network CIDR (e.g. 0.0.0.0/0 to open for everyone or 1.2.3.4/32 to open just for a specific IP address)

Direction string

The direction of the rule can be ingress or egress

EndPort string

The end of the port range (this is optional, by default it will only apply to the single port listed in start_port)

FirewallId string

The Firewall ID

Label string

A string that will be the displayed name/reference for this rule

Protocol string

The protocol choice from tcp, udp or icmp (the default if unspecified is tcp)

Region string

The region for this rule

StartPort string

The start of the port range to configure for this rule (or the single port if required)

Action string

The action of the rule can be allow or deny. When we set the action = 'allow', this is going to add a rule to allow traffic. Similarly, setting action = 'deny' will deny the traffic.

Cidrs []string

The CIDR notation of the other end to affect, or a valid network CIDR (e.g. 0.0.0.0/0 to open for everyone or 1.2.3.4/32 to open just for a specific IP address)

Direction string

The direction of the rule can be ingress or egress

EndPort string

The end of the port range (this is optional, by default it will only apply to the single port listed in start_port)

FirewallId string

The Firewall ID

Label string

A string that will be the displayed name/reference for this rule

Protocol string

The protocol choice from tcp, udp or icmp (the default if unspecified is tcp)

Region string

The region for this rule

StartPort string

The start of the port range to configure for this rule (or the single port if required)

action String

The action of the rule can be allow or deny. When we set the action = 'allow', this is going to add a rule to allow traffic. Similarly, setting action = 'deny' will deny the traffic.

cidrs List<String>

The CIDR notation of the other end to affect, or a valid network CIDR (e.g. 0.0.0.0/0 to open for everyone or 1.2.3.4/32 to open just for a specific IP address)

direction String

The direction of the rule can be ingress or egress

endPort String

The end of the port range (this is optional, by default it will only apply to the single port listed in start_port)

firewallId String

The Firewall ID

label String

A string that will be the displayed name/reference for this rule

protocol String

The protocol choice from tcp, udp or icmp (the default if unspecified is tcp)

region String

The region for this rule

startPort String

The start of the port range to configure for this rule (or the single port if required)

action string

The action of the rule can be allow or deny. When we set the action = 'allow', this is going to add a rule to allow traffic. Similarly, setting action = 'deny' will deny the traffic.

cidrs string[]

The CIDR notation of the other end to affect, or a valid network CIDR (e.g. 0.0.0.0/0 to open for everyone or 1.2.3.4/32 to open just for a specific IP address)

direction string

The direction of the rule can be ingress or egress

endPort string

The end of the port range (this is optional, by default it will only apply to the single port listed in start_port)

firewallId string

The Firewall ID

label string

A string that will be the displayed name/reference for this rule

protocol string

The protocol choice from tcp, udp or icmp (the default if unspecified is tcp)

region string

The region for this rule

startPort string

The start of the port range to configure for this rule (or the single port if required)

action str

The action of the rule can be allow or deny. When we set the action = 'allow', this is going to add a rule to allow traffic. Similarly, setting action = 'deny' will deny the traffic.

cidrs Sequence[str]

The CIDR notation of the other end to affect, or a valid network CIDR (e.g. 0.0.0.0/0 to open for everyone or 1.2.3.4/32 to open just for a specific IP address)

direction str

The direction of the rule can be ingress or egress

end_port str

The end of the port range (this is optional, by default it will only apply to the single port listed in start_port)

firewall_id str

The Firewall ID

label str

A string that will be the displayed name/reference for this rule

protocol str

The protocol choice from tcp, udp or icmp (the default if unspecified is tcp)

region str

The region for this rule

start_port str

The start of the port range to configure for this rule (or the single port if required)

action String

The action of the rule can be allow or deny. When we set the action = 'allow', this is going to add a rule to allow traffic. Similarly, setting action = 'deny' will deny the traffic.

cidrs List<String>

The CIDR notation of the other end to affect, or a valid network CIDR (e.g. 0.0.0.0/0 to open for everyone or 1.2.3.4/32 to open just for a specific IP address)

direction String

The direction of the rule can be ingress or egress

endPort String

The end of the port range (this is optional, by default it will only apply to the single port listed in start_port)

firewallId String

The Firewall ID

label String

A string that will be the displayed name/reference for this rule

protocol String

The protocol choice from tcp, udp or icmp (the default if unspecified is tcp)

region String

The region for this rule

startPort String

The start of the port range to configure for this rule (or the single port if required)

Import

using firewall_id:firewall_rule_id

 $ pulumi import civo:index/firewallRule:FirewallRule http b8ecd2ab-2267-4a5e-8692-cbf1d32583e3:4b0022ee-00b2-4f81-a40d-b4f8728923a7

Package Details

Repository
https://github.com/pulumi/pulumi-civo
License
Apache-2.0
Notes

This Pulumi package is based on the civo Terraform Provider.