Skip to content

Get Policy

fms_get_policy R Documentation

Returns information about the specified Firewall Manager policy

Description

Returns information about the specified Firewall Manager policy.

Usage

fms_get_policy(PolicyId)

Arguments

PolicyId

[required] The ID of the Firewall Manager policy that you want the details for.

Value

A list with the following syntax:

list(
  Policy = list(
    PolicyId = "string",
    PolicyName = "string",
    PolicyUpdateToken = "string",
    SecurityServicePolicyData = list(
      Type = "WAF"|"WAFV2"|"SHIELD_ADVANCED"|"SECURITY_GROUPS_COMMON"|"SECURITY_GROUPS_CONTENT_AUDIT"|"SECURITY_GROUPS_USAGE_AUDIT"|"NETWORK_FIREWALL"|"DNS_FIREWALL"|"THIRD_PARTY_FIREWALL"|"IMPORT_NETWORK_FIREWALL"|"NETWORK_ACL_COMMON",
      ManagedServiceData = "string",
      PolicyOption = list(
        NetworkFirewallPolicy = list(
          FirewallDeploymentModel = "CENTRALIZED"|"DISTRIBUTED"
        ),
        ThirdPartyFirewallPolicy = list(
          FirewallDeploymentModel = "CENTRALIZED"|"DISTRIBUTED"
        ),
        NetworkAclCommonPolicy = list(
          NetworkAclEntrySet = list(
            FirstEntries = list(
              list(
                IcmpTypeCode = list(
                  Code = 123,
                  Type = 123
                ),
                Protocol = "string",
                PortRange = list(
                  From = 123,
                  To = 123
                ),
                CidrBlock = "string",
                Ipv6CidrBlock = "string",
                RuleAction = "allow"|"deny",
                Egress = TRUE|FALSE
              )
            ),
            ForceRemediateForFirstEntries = TRUE|FALSE,
            LastEntries = list(
              list(
                IcmpTypeCode = list(
                  Code = 123,
                  Type = 123
                ),
                Protocol = "string",
                PortRange = list(
                  From = 123,
                  To = 123
                ),
                CidrBlock = "string",
                Ipv6CidrBlock = "string",
                RuleAction = "allow"|"deny",
                Egress = TRUE|FALSE
              )
            ),
            ForceRemediateForLastEntries = TRUE|FALSE
          )
        )
      )
    ),
    ResourceType = "string",
    ResourceTypeList = list(
      "string"
    ),
    ResourceTags = list(
      list(
        Key = "string",
        Value = "string"
      )
    ),
    ExcludeResourceTags = TRUE|FALSE,
    RemediationEnabled = TRUE|FALSE,
    DeleteUnusedFMManagedResources = TRUE|FALSE,
    IncludeMap = list(
      list(
        "string"
      )
    ),
    ExcludeMap = list(
      list(
        "string"
      )
    ),
    ResourceSetIds = list(
      "string"
    ),
    PolicyDescription = "string",
    PolicyStatus = "ACTIVE"|"OUT_OF_ADMIN_SCOPE"
  ),
  PolicyArn = "string"
)

Request syntax

svc$get_policy(
  PolicyId = "string"
)