We recommend new projects start with resources from the AWS provider.
aws-native.networkfirewall.getFirewall
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
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)
public static Output<GetFirewallResult> getFirewall(GetFirewallArgs args, InvokeOptions options)
fn::invoke:
  function: aws-native:networkfirewall:getFirewall
  arguments:
    # arguments dictionaryThe 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 TRUEindicates 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 toTRUE.
- 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 Firewallresource.
- FirewallPolicy stringArn 
- 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. 
- FirewallPolicy boolChange Protection 
- 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.
- SubnetChange boolProtection 
- 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.Aws Native. Network Firewall. Outputs. Firewall Subnet Mapping> 
- The public subnets that Network Firewall is using for the firewall. Each subnet must belong to a different Availability Zone.
- 
List<Pulumi.Aws Native. 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 TRUEindicates 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 toTRUE.
- 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 Firewallresource.
- FirewallPolicy stringArn 
- 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. 
- FirewallPolicy boolChange Protection 
- 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.
- SubnetChange boolProtection 
- 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 []FirewallSubnet Mapping 
- The public subnets that Network Firewall is using for the firewall. Each subnet must belong to a different Availability Zone.
- 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 TRUEindicates 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 toTRUE.
- 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 Firewallresource.
- firewallPolicy StringArn 
- 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. 
- firewallPolicy BooleanChange Protection 
- 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.
- subnetChange BooleanProtection 
- 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<FirewallSubnet Mapping> 
- The public subnets that Network Firewall is using for the firewall. Each subnet must belong to a different Availability Zone.
- 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 TRUEindicates 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 toTRUE.
- 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 Firewallresource.
- firewallPolicy stringArn 
- 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. 
- firewallPolicy booleanChange Protection 
- 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.
- subnetChange booleanProtection 
- 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 FirewallSubnet Mapping[] 
- The public subnets that Network Firewall is using for the firewall. Each subnet must belong to a different Availability Zone.
- 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 TRUEindicates 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 toTRUE.
- 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 Firewallresource.
- firewall_policy_ strarn 
- 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_ boolchange_ protection 
- 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_ boolprotection 
- 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[FirewallSubnet Mapping] 
- The public subnets that Network Firewall is using for the firewall. Each subnet must belong to a different Availability Zone.
- 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 TRUEindicates 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 toTRUE.
- 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 Firewallresource.
- firewallPolicy StringArn 
- 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. 
- firewallPolicy BooleanChange Protection 
- 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.
- subnetChange BooleanProtection 
- 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.
- 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.
- IpAddress stringType 
- A IPAddressType
- SubnetId string
- A SubnetId.
- IpAddress stringType 
- A IPAddressType
- subnetId String
- A SubnetId.
- ipAddress StringType 
- A IPAddressType
- subnetId string
- A SubnetId.
- ipAddress stringType 
- A IPAddressType
- subnet_id str
- A SubnetId.
- ip_address_ strtype 
- A IPAddressType
- subnetId String
- A SubnetId.
- ipAddress StringType 
- A IPAddressType
Tag
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.