Describe Firewall Policy

networkfirewall_describe_firewall_policy

R Documentation

Returns the data objects for the specified firewall policy

Description

Returns the data objects for the specified firewall policy.

Usage

networkfirewall_describe_firewall_policy(FirewallPolicyName,
  FirewallPolicyArn)

Arguments

FirewallPolicyName

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

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

FirewallPolicyArn

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

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

Value

A list with the following syntax:

list(
  UpdateToken = "string",
  FirewallPolicyResponse = list(
    FirewallPolicyName = "string",
    FirewallPolicyArn = "string",
    FirewallPolicyId = "string",
    Description = "string",
    FirewallPolicyStatus = "ACTIVE"|"DELETING"|"ERROR",
    Tags = list(
      list(
        Key = "string",
        Value = "string"
      )
    ),
    ConsumedStatelessRuleCapacity = 123,
    ConsumedStatefulRuleCapacity = 123,
    NumberOfAssociations = 123,
    EncryptionConfiguration = list(
      KeyId = "string",
      Type = "CUSTOMER_KMS"|"AWS_OWNED_KMS_KEY"
    ),
    LastModifiedTime = as.POSIXct(
      "2015-01-01"
    )
  ),
  FirewallPolicy = list(
    StatelessRuleGroupReferences = list(
      list(
        ResourceArn = "string",
        Priority = 123
      )
    ),
    StatelessDefaultActions = list(
      "string"
    ),
    StatelessFragmentDefaultActions = list(
      "string"
    ),
    StatelessCustomActions = list(
      list(
        ActionName = "string",
        ActionDefinition = list(
          PublishMetricAction = list(
            Dimensions = list(
              list(
                Value = "string"
              )
            )
          )
        )
      )
    ),
    StatefulRuleGroupReferences = list(
      list(
        ResourceArn = "string",
        Priority = 123,
        Override = list(
          Action = "DROP_TO_ALERT"
        )
      )
    ),
    StatefulDefaultActions = list(
      "string"
    ),
    StatefulEngineOptions = list(
      RuleOrder = "DEFAULT_ACTION_ORDER"|"STRICT_ORDER",
      StreamExceptionPolicy = "DROP"|"CONTINUE"|"REJECT"
    ),
    TLSInspectionConfigurationArn = "string",
    PolicyVariables = list(
      RuleVariables = list(
        list(
          Definition = list(
            "string"
          )
        )
      )
    )
  )
)

Request syntax

svc$describe_firewall_policy(
  FirewallPolicyName = "string",
  FirewallPolicyArn = "string"
)