Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Native
  3. API Docs
  4. networkfirewall
  5. getFirewall

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.networkfirewall.getFirewall

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource type definition for AWS::NetworkFirewall::Firewall

    Using getFirewall

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getFirewall(args: GetFirewallArgs, opts?: InvokeOptions): Promise<GetFirewallResult>
function getFirewallOutput(args: GetFirewallOutputArgs, opts?: InvokeOptions): Output<GetFirewallResult>
    def get_firewall(firewall_arn: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetFirewallResult
def get_firewall_output(firewall_arn: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetFirewallResult]
    func LookupFirewall(ctx *Context, args *LookupFirewallArgs, opts ...InvokeOption) (*LookupFirewallResult, error)
func LookupFirewallOutput(ctx *Context, args *LookupFirewallOutputArgs, opts ...InvokeOption) LookupFirewallResultOutput

    > Note: This function is named LookupFirewall in the Go SDK.

    public static class GetFirewall 
{
    public static Task<GetFirewallResult> InvokeAsync(GetFirewallArgs args, InvokeOptions? opts = null)
    public static Output<GetFirewallResult> Invoke(GetFirewallInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetFirewallResult> getFirewall(GetFirewallArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:networkfirewall:getFirewall
  arguments:
    # arguments dictionary

    The following arguments are supported:

    FirewallArn string
    The Amazon Resource Name (ARN) of the Firewall .
    FirewallArn string
    The Amazon Resource Name (ARN) of the Firewall .
    firewallArn String
    The Amazon Resource Name (ARN) of the Firewall .
    firewallArn string
    The Amazon Resource Name (ARN) of the Firewall .
    firewall_arn str
    The Amazon Resource Name (ARN) of the Firewall .
    firewallArn String
    The Amazon Resource Name (ARN) of the Firewall .

    getFirewall Result

    The following output properties are available:

    DeleteProtection bool
    A flag indicating whether it is possible to delete the firewall. A setting of TRUE indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE .
    Description string
    A description of the firewall.
    EndpointIds List<string>
    The unique IDs of the firewall endpoints for all of the subnets that you attached to the firewall. The subnets are not listed in any particular order. For example: ["us-west-2c:vpce-111122223333", "us-west-2a:vpce-987654321098", "us-west-2b:vpce-012345678901"] .
    FirewallArn string
    The Amazon Resource Name (ARN) of the Firewall .
    FirewallId string
    The name of the Firewall resource.
    FirewallPolicyArn string

    The Amazon Resource Name (ARN) of the firewall policy.

    The relationship of firewall to firewall policy is many to one. Each firewall requires one firewall policy association, and you can use the same firewall policy for multiple firewalls.

    FirewallPolicyChangeProtection bool
    A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE .
    SubnetChangeProtection bool
    A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE .
    SubnetMappings List<Pulumi.AwsNative.NetworkFirewall.Outputs.FirewallSubnetMapping>
    The public subnets that Network Firewall is using for the firewall. Each subnet must belong to a different Availability Zone.
    Tags List<Pulumi.AwsNative.Outputs.Tag>

    An array of key-value pairs to apply to this resource.

    For more information, see Tag .

    DeleteProtection bool
    A flag indicating whether it is possible to delete the firewall. A setting of TRUE indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE .
    Description string
    A description of the firewall.
    EndpointIds []string
    The unique IDs of the firewall endpoints for all of the subnets that you attached to the firewall. The subnets are not listed in any particular order. For example: ["us-west-2c:vpce-111122223333", "us-west-2a:vpce-987654321098", "us-west-2b:vpce-012345678901"] .
    FirewallArn string
    The Amazon Resource Name (ARN) of the Firewall .
    FirewallId string
    The name of the Firewall resource.
    FirewallPolicyArn string

    The Amazon Resource Name (ARN) of the firewall policy.

    The relationship of firewall to firewall policy is many to one. Each firewall requires one firewall policy association, and you can use the same firewall policy for multiple firewalls.

    FirewallPolicyChangeProtection bool
    A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE .
    SubnetChangeProtection bool
    A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE .
    SubnetMappings []FirewallSubnetMapping
    The public subnets that Network Firewall is using for the firewall. Each subnet must belong to a different Availability Zone.
    Tags Tag

    An array of key-value pairs to apply to this resource.

    For more information, see Tag .

    deleteProtection Boolean
    A flag indicating whether it is possible to delete the firewall. A setting of TRUE indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE .
    description String
    A description of the firewall.
    endpointIds List<String>
    The unique IDs of the firewall endpoints for all of the subnets that you attached to the firewall. The subnets are not listed in any particular order. For example: ["us-west-2c:vpce-111122223333", "us-west-2a:vpce-987654321098", "us-west-2b:vpce-012345678901"] .
    firewallArn String
    The Amazon Resource Name (ARN) of the Firewall .
    firewallId String
    The name of the Firewall resource.
    firewallPolicyArn String

    The Amazon Resource Name (ARN) of the firewall policy.

    The relationship of firewall to firewall policy is many to one. Each firewall requires one firewall policy association, and you can use the same firewall policy for multiple firewalls.

    firewallPolicyChangeProtection Boolean
    A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE .
    subnetChangeProtection Boolean
    A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE .
    subnetMappings List<FirewallSubnetMapping>
    The public subnets that Network Firewall is using for the firewall. Each subnet must belong to a different Availability Zone.
    tags List<Tag>

    An array of key-value pairs to apply to this resource.

    For more information, see Tag .

    deleteProtection boolean
    A flag indicating whether it is possible to delete the firewall. A setting of TRUE indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE .
    description string
    A description of the firewall.
    endpointIds string[]
    The unique IDs of the firewall endpoints for all of the subnets that you attached to the firewall. The subnets are not listed in any particular order. For example: ["us-west-2c:vpce-111122223333", "us-west-2a:vpce-987654321098", "us-west-2b:vpce-012345678901"] .
    firewallArn string
    The Amazon Resource Name (ARN) of the Firewall .
    firewallId string
    The name of the Firewall resource.
    firewallPolicyArn string

    The Amazon Resource Name (ARN) of the firewall policy.

    The relationship of firewall to firewall policy is many to one. Each firewall requires one firewall policy association, and you can use the same firewall policy for multiple firewalls.

    firewallPolicyChangeProtection boolean
    A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE .
    subnetChangeProtection boolean
    A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE .
    subnetMappings FirewallSubnetMapping[]
    The public subnets that Network Firewall is using for the firewall. Each subnet must belong to a different Availability Zone.
    tags Tag[]

    An array of key-value pairs to apply to this resource.

    For more information, see Tag .

    delete_protection bool
    A flag indicating whether it is possible to delete the firewall. A setting of TRUE indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE .
    description str
    A description of the firewall.
    endpoint_ids Sequence[str]
    The unique IDs of the firewall endpoints for all of the subnets that you attached to the firewall. The subnets are not listed in any particular order. For example: ["us-west-2c:vpce-111122223333", "us-west-2a:vpce-987654321098", "us-west-2b:vpce-012345678901"] .
    firewall_arn str
    The Amazon Resource Name (ARN) of the Firewall .
    firewall_id str
    The name of the Firewall resource.
    firewall_policy_arn str

    The Amazon Resource Name (ARN) of the firewall policy.

    The relationship of firewall to firewall policy is many to one. Each firewall requires one firewall policy association, and you can use the same firewall policy for multiple firewalls.

    firewall_policy_change_protection bool
    A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE .
    subnet_change_protection bool
    A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE .
    subnet_mappings Sequence[FirewallSubnetMapping]
    The public subnets that Network Firewall is using for the firewall. Each subnet must belong to a different Availability Zone.
    tags Sequence[root_Tag]

    An array of key-value pairs to apply to this resource.

    For more information, see Tag .

    deleteProtection Boolean
    A flag indicating whether it is possible to delete the firewall. A setting of TRUE indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE .
    description String
    A description of the firewall.
    endpointIds List<String>
    The unique IDs of the firewall endpoints for all of the subnets that you attached to the firewall. The subnets are not listed in any particular order. For example: ["us-west-2c:vpce-111122223333", "us-west-2a:vpce-987654321098", "us-west-2b:vpce-012345678901"] .
    firewallArn String
    The Amazon Resource Name (ARN) of the Firewall .
    firewallId String
    The name of the Firewall resource.
    firewallPolicyArn String

    The Amazon Resource Name (ARN) of the firewall policy.

    The relationship of firewall to firewall policy is many to one. Each firewall requires one firewall policy association, and you can use the same firewall policy for multiple firewalls.

    firewallPolicyChangeProtection Boolean
    A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE .
    subnetChangeProtection Boolean
    A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE .
    subnetMappings List<Property Map>
    The public subnets that Network Firewall is using for the firewall. Each subnet must belong to a different Availability Zone.
    tags List<Property Map>

    An array of key-value pairs to apply to this resource.

    For more information, see Tag .

    Supporting Types

    FirewallSubnetMapping

    SubnetId string
    A SubnetId.
    IpAddressType string
    A IPAddressType
    SubnetId string
    A SubnetId.
    IpAddressType string
    A IPAddressType
    subnetId String
    A SubnetId.
    ipAddressType String
    A IPAddressType
    subnetId string
    A SubnetId.
    ipAddressType string
    A IPAddressType
    subnet_id str
    A SubnetId.
    ip_address_type str
    A IPAddressType
    subnetId String
    A SubnetId.
    ipAddressType String
    A IPAddressType

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
    pulumi/pulumi-aws-native