1. Packages
  2. Aquasec
  3. API Docs
  4. FirewallPolicy
Aquasec v0.8.29 published on Monday, Jul 22, 2024 by Pulumiverse

aquasec.FirewallPolicy

Explore with Pulumi AI

Create FirewallPolicy Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new FirewallPolicy(name: string, args?: FirewallPolicyArgs, opts?: CustomResourceOptions);
@overload
def FirewallPolicy(resource_name: str,
                   args: Optional[FirewallPolicyArgs] = None,
                   opts: Optional[ResourceOptions] = None)

@overload
def FirewallPolicy(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   block_icmp_ping: Optional[bool] = None,
                   block_metadata_service: Optional[bool] = None,
                   description: Optional[str] = None,
                   inbound_networks: Optional[Sequence[FirewallPolicyInboundNetworkArgs]] = None,
                   name: Optional[str] = None,
                   outbound_networks: Optional[Sequence[FirewallPolicyOutboundNetworkArgs]] = None,
                   type: Optional[str] = None,
                   version: Optional[str] = None)
func NewFirewallPolicy(ctx *Context, name string, args *FirewallPolicyArgs, opts ...ResourceOption) (*FirewallPolicy, error)
public FirewallPolicy(string name, FirewallPolicyArgs? args = null, CustomResourceOptions? opts = null)
public FirewallPolicy(String name, FirewallPolicyArgs args)
public FirewallPolicy(String name, FirewallPolicyArgs args, CustomResourceOptions options)
type: aquasec:FirewallPolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args FirewallPolicyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args FirewallPolicyArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args FirewallPolicyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args FirewallPolicyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. FirewallPolicyArgs
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 firewallPolicyResource = new Aquasec.FirewallPolicy("firewallPolicyResource", new()
{
    BlockIcmpPing = false,
    BlockMetadataService = false,
    Description = "string",
    InboundNetworks = new[]
    {
        new Aquasec.Inputs.FirewallPolicyInboundNetworkArgs
        {
            Allow = false,
            PortRange = "string",
            ResourceType = "string",
            Resource = "string",
        },
    },
    Name = "string",
    OutboundNetworks = new[]
    {
        new Aquasec.Inputs.FirewallPolicyOutboundNetworkArgs
        {
            Allow = false,
            PortRange = "string",
            ResourceType = "string",
            Resource = "string",
        },
    },
    Type = "string",
    Version = "string",
});
Copy
example, err := aquasec.NewFirewallPolicy(ctx, "firewallPolicyResource", &aquasec.FirewallPolicyArgs{
	BlockIcmpPing:        pulumi.Bool(false),
	BlockMetadataService: pulumi.Bool(false),
	Description:          pulumi.String("string"),
	InboundNetworks: aquasec.FirewallPolicyInboundNetworkArray{
		&aquasec.FirewallPolicyInboundNetworkArgs{
			Allow:        pulumi.Bool(false),
			PortRange:    pulumi.String("string"),
			ResourceType: pulumi.String("string"),
			Resource:     pulumi.String("string"),
		},
	},
	Name: pulumi.String("string"),
	OutboundNetworks: aquasec.FirewallPolicyOutboundNetworkArray{
		&aquasec.FirewallPolicyOutboundNetworkArgs{
			Allow:        pulumi.Bool(false),
			PortRange:    pulumi.String("string"),
			ResourceType: pulumi.String("string"),
			Resource:     pulumi.String("string"),
		},
	},
	Type:    pulumi.String("string"),
	Version: pulumi.String("string"),
})
Copy
var firewallPolicyResource = new FirewallPolicy("firewallPolicyResource", FirewallPolicyArgs.builder()
    .blockIcmpPing(false)
    .blockMetadataService(false)
    .description("string")
    .inboundNetworks(FirewallPolicyInboundNetworkArgs.builder()
        .allow(false)
        .portRange("string")
        .resourceType("string")
        .resource("string")
        .build())
    .name("string")
    .outboundNetworks(FirewallPolicyOutboundNetworkArgs.builder()
        .allow(false)
        .portRange("string")
        .resourceType("string")
        .resource("string")
        .build())
    .type("string")
    .version("string")
    .build());
Copy
firewall_policy_resource = aquasec.FirewallPolicy("firewallPolicyResource",
    block_icmp_ping=False,
    block_metadata_service=False,
    description="string",
    inbound_networks=[{
        "allow": False,
        "port_range": "string",
        "resource_type": "string",
        "resource": "string",
    }],
    name="string",
    outbound_networks=[{
        "allow": False,
        "port_range": "string",
        "resource_type": "string",
        "resource": "string",
    }],
    type="string",
    version="string")
Copy
const firewallPolicyResource = new aquasec.FirewallPolicy("firewallPolicyResource", {
    blockIcmpPing: false,
    blockMetadataService: false,
    description: "string",
    inboundNetworks: [{
        allow: false,
        portRange: "string",
        resourceType: "string",
        resource: "string",
    }],
    name: "string",
    outboundNetworks: [{
        allow: false,
        portRange: "string",
        resourceType: "string",
        resource: "string",
    }],
    type: "string",
    version: "string",
});
Copy
type: aquasec:FirewallPolicy
properties:
    blockIcmpPing: false
    blockMetadataService: false
    description: string
    inboundNetworks:
        - allow: false
          portRange: string
          resource: string
          resourceType: string
    name: string
    outboundNetworks:
        - allow: false
          portRange: string
          resource: string
          resourceType: string
    type: string
    version: string
Copy

FirewallPolicy 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 FirewallPolicy resource accepts the following input properties:

BlockIcmpPing bool
Indicates whether policy includes blocking incoming 'ping' requests.
BlockMetadataService bool
Indicates whether policy includes blocking metadata services of the cloud.
Description string
Description of the Firewall Policy.
InboundNetworks List<Pulumiverse.Aquasec.Inputs.FirewallPolicyInboundNetwork>
Information on network addresses that are allowed to pass in data or requests.
Name Changes to this property will trigger replacement. string
Name of the policy, no longer than 128 characters and no slash characters.
OutboundNetworks List<Pulumiverse.Aquasec.Inputs.FirewallPolicyOutboundNetwork>
Information on network addresses that are allowed to receive data or requests.
Type string
Indicates the class of protection defined by the firewall.
Version string
Aqua version functionality supported
BlockIcmpPing bool
Indicates whether policy includes blocking incoming 'ping' requests.
BlockMetadataService bool
Indicates whether policy includes blocking metadata services of the cloud.
Description string
Description of the Firewall Policy.
InboundNetworks []FirewallPolicyInboundNetworkArgs
Information on network addresses that are allowed to pass in data or requests.
Name Changes to this property will trigger replacement. string
Name of the policy, no longer than 128 characters and no slash characters.
OutboundNetworks []FirewallPolicyOutboundNetworkArgs
Information on network addresses that are allowed to receive data or requests.
Type string
Indicates the class of protection defined by the firewall.
Version string
Aqua version functionality supported
blockIcmpPing Boolean
Indicates whether policy includes blocking incoming 'ping' requests.
blockMetadataService Boolean
Indicates whether policy includes blocking metadata services of the cloud.
description String
Description of the Firewall Policy.
inboundNetworks List<FirewallPolicyInboundNetwork>
Information on network addresses that are allowed to pass in data or requests.
name Changes to this property will trigger replacement. String
Name of the policy, no longer than 128 characters and no slash characters.
outboundNetworks List<FirewallPolicyOutboundNetwork>
Information on network addresses that are allowed to receive data or requests.
type String
Indicates the class of protection defined by the firewall.
version String
Aqua version functionality supported
blockIcmpPing boolean
Indicates whether policy includes blocking incoming 'ping' requests.
blockMetadataService boolean
Indicates whether policy includes blocking metadata services of the cloud.
description string
Description of the Firewall Policy.
inboundNetworks FirewallPolicyInboundNetwork[]
Information on network addresses that are allowed to pass in data or requests.
name Changes to this property will trigger replacement. string
Name of the policy, no longer than 128 characters and no slash characters.
outboundNetworks FirewallPolicyOutboundNetwork[]
Information on network addresses that are allowed to receive data or requests.
type string
Indicates the class of protection defined by the firewall.
version string
Aqua version functionality supported
block_icmp_ping bool
Indicates whether policy includes blocking incoming 'ping' requests.
block_metadata_service bool
Indicates whether policy includes blocking metadata services of the cloud.
description str
Description of the Firewall Policy.
inbound_networks Sequence[FirewallPolicyInboundNetworkArgs]
Information on network addresses that are allowed to pass in data or requests.
name Changes to this property will trigger replacement. str
Name of the policy, no longer than 128 characters and no slash characters.
outbound_networks Sequence[FirewallPolicyOutboundNetworkArgs]
Information on network addresses that are allowed to receive data or requests.
type str
Indicates the class of protection defined by the firewall.
version str
Aqua version functionality supported
blockIcmpPing Boolean
Indicates whether policy includes blocking incoming 'ping' requests.
blockMetadataService Boolean
Indicates whether policy includes blocking metadata services of the cloud.
description String
Description of the Firewall Policy.
inboundNetworks List<Property Map>
Information on network addresses that are allowed to pass in data or requests.
name Changes to this property will trigger replacement. String
Name of the policy, no longer than 128 characters and no slash characters.
outboundNetworks List<Property Map>
Information on network addresses that are allowed to receive data or requests.
type String
Indicates the class of protection defined by the firewall.
version String
Aqua version functionality supported

Outputs

All input properties are implicitly available as output properties. Additionally, the FirewallPolicy resource produces the following output properties:

Author string
Username of the account that created the policy.
Id string
The provider-assigned unique ID for this managed resource.
Lastupdate int
Timestamp of the last update in Unix time format.
Author string
Username of the account that created the policy.
Id string
The provider-assigned unique ID for this managed resource.
Lastupdate int
Timestamp of the last update in Unix time format.
author String
Username of the account that created the policy.
id String
The provider-assigned unique ID for this managed resource.
lastupdate Integer
Timestamp of the last update in Unix time format.
author string
Username of the account that created the policy.
id string
The provider-assigned unique ID for this managed resource.
lastupdate number
Timestamp of the last update in Unix time format.
author str
Username of the account that created the policy.
id str
The provider-assigned unique ID for this managed resource.
lastupdate int
Timestamp of the last update in Unix time format.
author String
Username of the account that created the policy.
id String
The provider-assigned unique ID for this managed resource.
lastupdate Number
Timestamp of the last update in Unix time format.

Look up Existing FirewallPolicy Resource

Get an existing FirewallPolicy 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?: FirewallPolicyState, opts?: CustomResourceOptions): FirewallPolicy
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        author: Optional[str] = None,
        block_icmp_ping: Optional[bool] = None,
        block_metadata_service: Optional[bool] = None,
        description: Optional[str] = None,
        inbound_networks: Optional[Sequence[FirewallPolicyInboundNetworkArgs]] = None,
        lastupdate: Optional[int] = None,
        name: Optional[str] = None,
        outbound_networks: Optional[Sequence[FirewallPolicyOutboundNetworkArgs]] = None,
        type: Optional[str] = None,
        version: Optional[str] = None) -> FirewallPolicy
func GetFirewallPolicy(ctx *Context, name string, id IDInput, state *FirewallPolicyState, opts ...ResourceOption) (*FirewallPolicy, error)
public static FirewallPolicy Get(string name, Input<string> id, FirewallPolicyState? state, CustomResourceOptions? opts = null)
public static FirewallPolicy get(String name, Output<String> id, FirewallPolicyState state, CustomResourceOptions options)
resources:  _:    type: aquasec:FirewallPolicy    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Author string
Username of the account that created the policy.
BlockIcmpPing bool
Indicates whether policy includes blocking incoming 'ping' requests.
BlockMetadataService bool
Indicates whether policy includes blocking metadata services of the cloud.
Description string
Description of the Firewall Policy.
InboundNetworks List<Pulumiverse.Aquasec.Inputs.FirewallPolicyInboundNetwork>
Information on network addresses that are allowed to pass in data or requests.
Lastupdate int
Timestamp of the last update in Unix time format.
Name Changes to this property will trigger replacement. string
Name of the policy, no longer than 128 characters and no slash characters.
OutboundNetworks List<Pulumiverse.Aquasec.Inputs.FirewallPolicyOutboundNetwork>
Information on network addresses that are allowed to receive data or requests.
Type string
Indicates the class of protection defined by the firewall.
Version string
Aqua version functionality supported
Author string
Username of the account that created the policy.
BlockIcmpPing bool
Indicates whether policy includes blocking incoming 'ping' requests.
BlockMetadataService bool
Indicates whether policy includes blocking metadata services of the cloud.
Description string
Description of the Firewall Policy.
InboundNetworks []FirewallPolicyInboundNetworkArgs
Information on network addresses that are allowed to pass in data or requests.
Lastupdate int
Timestamp of the last update in Unix time format.
Name Changes to this property will trigger replacement. string
Name of the policy, no longer than 128 characters and no slash characters.
OutboundNetworks []FirewallPolicyOutboundNetworkArgs
Information on network addresses that are allowed to receive data or requests.
Type string
Indicates the class of protection defined by the firewall.
Version string
Aqua version functionality supported
author String
Username of the account that created the policy.
blockIcmpPing Boolean
Indicates whether policy includes blocking incoming 'ping' requests.
blockMetadataService Boolean
Indicates whether policy includes blocking metadata services of the cloud.
description String
Description of the Firewall Policy.
inboundNetworks List<FirewallPolicyInboundNetwork>
Information on network addresses that are allowed to pass in data or requests.
lastupdate Integer
Timestamp of the last update in Unix time format.
name Changes to this property will trigger replacement. String
Name of the policy, no longer than 128 characters and no slash characters.
outboundNetworks List<FirewallPolicyOutboundNetwork>
Information on network addresses that are allowed to receive data or requests.
type String
Indicates the class of protection defined by the firewall.
version String
Aqua version functionality supported
author string
Username of the account that created the policy.
blockIcmpPing boolean
Indicates whether policy includes blocking incoming 'ping' requests.
blockMetadataService boolean
Indicates whether policy includes blocking metadata services of the cloud.
description string
Description of the Firewall Policy.
inboundNetworks FirewallPolicyInboundNetwork[]
Information on network addresses that are allowed to pass in data or requests.
lastupdate number
Timestamp of the last update in Unix time format.
name Changes to this property will trigger replacement. string
Name of the policy, no longer than 128 characters and no slash characters.
outboundNetworks FirewallPolicyOutboundNetwork[]
Information on network addresses that are allowed to receive data or requests.
type string
Indicates the class of protection defined by the firewall.
version string
Aqua version functionality supported
author str
Username of the account that created the policy.
block_icmp_ping bool
Indicates whether policy includes blocking incoming 'ping' requests.
block_metadata_service bool
Indicates whether policy includes blocking metadata services of the cloud.
description str
Description of the Firewall Policy.
inbound_networks Sequence[FirewallPolicyInboundNetworkArgs]
Information on network addresses that are allowed to pass in data or requests.
lastupdate int
Timestamp of the last update in Unix time format.
name Changes to this property will trigger replacement. str
Name of the policy, no longer than 128 characters and no slash characters.
outbound_networks Sequence[FirewallPolicyOutboundNetworkArgs]
Information on network addresses that are allowed to receive data or requests.
type str
Indicates the class of protection defined by the firewall.
version str
Aqua version functionality supported
author String
Username of the account that created the policy.
blockIcmpPing Boolean
Indicates whether policy includes blocking incoming 'ping' requests.
blockMetadataService Boolean
Indicates whether policy includes blocking metadata services of the cloud.
description String
Description of the Firewall Policy.
inboundNetworks List<Property Map>
Information on network addresses that are allowed to pass in data or requests.
lastupdate Number
Timestamp of the last update in Unix time format.
name Changes to this property will trigger replacement. String
Name of the policy, no longer than 128 characters and no slash characters.
outboundNetworks List<Property Map>
Information on network addresses that are allowed to receive data or requests.
type String
Indicates the class of protection defined by the firewall.
version String
Aqua version functionality supported

Supporting Types

FirewallPolicyInboundNetwork
, FirewallPolicyInboundNetworkArgs

Allow This property is required. bool
Indicates whether the specified resources are allowed to pass in data or requests.
PortRange This property is required. string
Range of ports affected by firewall.
ResourceType This property is required. string
Type of the resource
Resource string
Information of the resource.
Allow This property is required. bool
Indicates whether the specified resources are allowed to pass in data or requests.
PortRange This property is required. string
Range of ports affected by firewall.
ResourceType This property is required. string
Type of the resource
Resource string
Information of the resource.
allow This property is required. Boolean
Indicates whether the specified resources are allowed to pass in data or requests.
portRange This property is required. String
Range of ports affected by firewall.
resourceType This property is required. String
Type of the resource
resource String
Information of the resource.
allow This property is required. boolean
Indicates whether the specified resources are allowed to pass in data or requests.
portRange This property is required. string
Range of ports affected by firewall.
resourceType This property is required. string
Type of the resource
resource string
Information of the resource.
allow This property is required. bool
Indicates whether the specified resources are allowed to pass in data or requests.
port_range This property is required. str
Range of ports affected by firewall.
resource_type This property is required. str
Type of the resource
resource str
Information of the resource.
allow This property is required. Boolean
Indicates whether the specified resources are allowed to pass in data or requests.
portRange This property is required. String
Range of ports affected by firewall.
resourceType This property is required. String
Type of the resource
resource String
Information of the resource.

FirewallPolicyOutboundNetwork
, FirewallPolicyOutboundNetworkArgs

Allow This property is required. bool
Indicates whether the specified resources are allowed to receive data or requests.
PortRange This property is required. string
Range of ports affected by firewall.
ResourceType This property is required. string
Type of the resource.
Resource string
Information of the resource.
Allow This property is required. bool
Indicates whether the specified resources are allowed to receive data or requests.
PortRange This property is required. string
Range of ports affected by firewall.
ResourceType This property is required. string
Type of the resource.
Resource string
Information of the resource.
allow This property is required. Boolean
Indicates whether the specified resources are allowed to receive data or requests.
portRange This property is required. String
Range of ports affected by firewall.
resourceType This property is required. String
Type of the resource.
resource String
Information of the resource.
allow This property is required. boolean
Indicates whether the specified resources are allowed to receive data or requests.
portRange This property is required. string
Range of ports affected by firewall.
resourceType This property is required. string
Type of the resource.
resource string
Information of the resource.
allow This property is required. bool
Indicates whether the specified resources are allowed to receive data or requests.
port_range This property is required. str
Range of ports affected by firewall.
resource_type This property is required. str
Type of the resource.
resource str
Information of the resource.
allow This property is required. Boolean
Indicates whether the specified resources are allowed to receive data or requests.
portRange This property is required. String
Range of ports affected by firewall.
resourceType This property is required. String
Type of the resource.
resource String
Information of the resource.

Package Details

Repository
aquasec pulumiverse/pulumi-aquasec
License
Apache-2.0
Notes
This Pulumi package is based on the aquasec Terraform Provider.