Returns the data objects for the specified firewall¶

Description¶

Returns the data objects for the specified firewall.

Usage¶

networkfirewall_describe_firewall(FirewallName, FirewallArn)

Arguments¶

FirewallName

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

You must specify the ARN or the name, and you can specify both.
FirewallArn

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

Value¶

A list with the following syntax:

list(
  UpdateToken = "string",
  Firewall = list(
    FirewallName = "string",
    FirewallArn = "string",
    FirewallPolicyArn = "string",
    VpcId = "string",
    SubnetMappings = list(
      list(
        SubnetId = "string",
        IPAddressType = "DUALSTACK"|"IPV4"|"IPV6"
      )
    ),
    DeleteProtection = TRUE|FALSE,
    SubnetChangeProtection = TRUE|FALSE,
    FirewallPolicyChangeProtection = TRUE|FALSE,
    Description = "string",
    FirewallId = "string",
    Tags = list(
      list(
        Key = "string",
        Value = "string"
      )
    ),
    EncryptionConfiguration = list(
      KeyId = "string",
      Type = "CUSTOMER_KMS"|"AWS_OWNED_KMS_KEY"
    ),
    NumberOfAssociations = 123,
    EnabledAnalysisTypes = list(
      "TLS_SNI"|"HTTP_HOST"
    ),
    TransitGatewayId = "string",
    TransitGatewayOwnerAccountId = "string",
    AvailabilityZoneMappings = list(
      list(
        AvailabilityZone = "string"
      )
    ),
    AvailabilityZoneChangeProtection = TRUE|FALSE,
    NatGatewayMappings = list(
      list(
        NatGatewayId = "string"
      )
    ),
    ProxySettings = list(
      ListenerProperties = list(
        list(
          Port = 123,
          Type = "HTTP"|"HTTPS"
        )
      )
    ),
    NoSourcePreservation = TRUE|FALSE,
    VpcEndpoint = list(
      VpcId = "string",
      SubnetMappings = list(
        list(
          SubnetId = "string",
          IPAddressType = "DUALSTACK"|"IPV4"|"IPV6"
        )
      )
    )
  ),
  FirewallStatus = list(
    Status = "PROVISIONING"|"DELETING"|"READY"|"FAILED",
    ConfigurationSyncStateSummary = "PENDING"|"IN_SYNC"|"CAPACITY_CONSTRAINED",
    SyncStates = list(
      list(
        Attachment = list(
          SubnetId = "string",
          EndpointId = "string",
          Status = "CREATING"|"DELETING"|"FAILED"|"ERROR"|"SCALING"|"READY",
          StatusMessage = "string",
          DnsName = "string"
        ),
        Config = list(
          list(
            SyncStatus = "PENDING"|"IN_SYNC"|"CAPACITY_CONSTRAINED"|"NOT_SUBSCRIBED"|"DEPRECATED",
            UpdateToken = "string"
          )
        ),
        NatGatewayAttachments = list(
          list(
            NatGatewayId = "string",
            Status = "CREATING"|"READY"|"UPDATING"|"FAILED"|"DELETING",
            StatusMessage = "string",
            DnsName = "string"
          )
        )
      )
    ),
    CapacityUsageSummary = list(
      CIDRs = list(
        AvailableCIDRCount = 123,
        UtilizedCIDRCount = 123,
        IPSetReferences = list(
          list(
            ResolvedCIDRCount = 123
          )
        )
      )
    ),
    TransitGatewayAttachmentSyncState = list(
      AttachmentId = "string",
      TransitGatewayAttachmentStatus = "CREATING"|"DELETING"|"DELETED"|"FAILED"|"ERROR"|"READY"|"PENDING_ACCEPTANCE"|"REJECTING"|"REJECTED",
      StatusMessage = "string"
    )
  )
)

Request syntax¶

svc$describe_firewall(
  FirewallName = "string",
  FirewallArn = "string"
)