Skip to content

/AWS1/CL_FMSPOLICY

An Firewall Manager policy.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_policyname TYPE /AWS1/FMSRESOURCENAME /AWS1/FMSRESOURCENAME

The name of the Firewall Manager policy.

io_securityservicepolicydata TYPE REF TO /AWS1/CL_FMSSECSVCPOLICYDATA /AWS1/CL_FMSSECSVCPOLICYDATA

Details about the security service that is being used to protect the resources.

iv_resourcetype TYPE /AWS1/FMSRESOURCETYPE /AWS1/FMSRESOURCETYPE

The type of resource protected by or in scope of the policy. This is in the format shown in the Amazon Web Services Resource Types Reference. To apply this policy to multiple resource types, specify a resource type of ResourceTypeList and then specify the resource types in a ResourceTypeList.

The following are valid resource types for each Firewall Manager policy type:

  • Amazon Web Services WAF Classic - AWS::ApiGateway::Stage, AWS::CloudFront::Distribution, and AWS::ElasticLoadBalancingV2::LoadBalancer.

  • WAF - AWS::ApiGateway::Stage, AWS::ElasticLoadBalancingV2::LoadBalancer, and AWS::CloudFront::Distribution.

  • Shield Advanced - AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::ElasticLoadBalancing::LoadBalancer, AWS::EC2::EIP, and AWS::CloudFront::Distribution.

  • Network ACL - AWS::EC2::Subnet.

  • Security group usage audit - AWS::EC2::SecurityGroup.

  • Security group content audit - AWS::EC2::SecurityGroup, AWS::EC2::NetworkInterface, and AWS::EC2::Instance.

  • DNS Firewall, Network Firewall, and third-party firewall - AWS::EC2::VPC.

iv_excluderesourcetags TYPE /AWS1/FMSBOOLEAN /AWS1/FMSBOOLEAN

If set to True, resources with the tags that are specified in the ResourceTag array are not in scope of the policy. If set to False, and the ResourceTag array is not null, only resources with the specified tags are in scope of the policy.

iv_remediationenabled TYPE /AWS1/FMSBOOLEAN /AWS1/FMSBOOLEAN

Indicates if the policy should be automatically applied to new resources.

Optional arguments:

iv_policyid TYPE /AWS1/FMSPOLICYID /AWS1/FMSPOLICYID

The ID of the Firewall Manager policy.

iv_policyupdatetoken TYPE /AWS1/FMSPOLICYUPDATETOKEN /AWS1/FMSPOLICYUPDATETOKEN

A unique identifier for each update to the policy. When issuing a PutPolicy request, the PolicyUpdateToken in the request must match the PolicyUpdateToken of the current policy version. To get the PolicyUpdateToken of the current policy version, use a GetPolicy request.

it_resourcetypelist TYPE /AWS1/CL_FMSRESOURCETYPELIST_W=>TT_RESOURCETYPELIST TT_RESOURCETYPELIST

An array of ResourceType objects. Use this only to specify multiple resource types. To specify a single resource type, use ResourceType.

it_resourcetags TYPE /AWS1/CL_FMSRESOURCETAG=>TT_RESOURCETAGS TT_RESOURCETAGS

An array of ResourceTag objects.

iv_delunusedfmmanagedresrcs TYPE /AWS1/FMSBOOLEAN /AWS1/FMSBOOLEAN

Indicates whether Firewall Manager should automatically remove protections from resources that leave the policy scope and clean up resources that Firewall Manager is managing for accounts when those accounts leave policy scope. For example, Firewall Manager will disassociate a Firewall Manager managed web ACL from a protected customer resource when the customer resource leaves policy scope.

By default, Firewall Manager doesn't remove protections or delete Firewall Manager managed resources.

This option is not available for Shield Advanced or WAF Classic policies.

it_includemap TYPE /AWS1/CL_FMSCUSPLYSCOPEIDLST_W=>TT_CUSTOMERPOLICYSCOPEMAP TT_CUSTOMERPOLICYSCOPEMAP

Specifies the Amazon Web Services account IDs and Organizations organizational units (OUs) to include in the policy. Specifying an OU is the equivalent of specifying all accounts in the OU and in any of its child OUs, including any child OUs and accounts that are added at a later time.

You can specify inclusions or exclusions, but not both. If you specify an IncludeMap, Firewall Manager applies the policy to all accounts specified by the IncludeMap, and does not evaluate any ExcludeMap specifications. If you do not specify an IncludeMap, then Firewall Manager applies the policy to all accounts except for those specified by the ExcludeMap.

You can specify account IDs, OUs, or a combination:

  • Specify account IDs by setting the key to ACCOUNT. For example, the following is a valid map: {“ACCOUNT” : [“accountID1”, “accountID2”]}.

  • Specify OUs by setting the key to ORG_UNIT. For example, the following is a valid map: {“ORG_UNIT” : [“ouid111”, “ouid112”]}.

  • Specify accounts and OUs together in a single map, separated with a comma. For example, the following is a valid map: {“ACCOUNT” : [“accountID1”, “accountID2”], “ORG_UNIT” : [“ouid111”, “ouid112”]}.

it_excludemap TYPE /AWS1/CL_FMSCUSPLYSCOPEIDLST_W=>TT_CUSTOMERPOLICYSCOPEMAP TT_CUSTOMERPOLICYSCOPEMAP

Specifies the Amazon Web Services account IDs and Organizations organizational units (OUs) to exclude from the policy. Specifying an OU is the equivalent of specifying all accounts in the OU and in any of its child OUs, including any child OUs and accounts that are added at a later time.

You can specify inclusions or exclusions, but not both. If you specify an IncludeMap, Firewall Manager applies the policy to all accounts specified by the IncludeMap, and does not evaluate any ExcludeMap specifications. If you do not specify an IncludeMap, then Firewall Manager applies the policy to all accounts except for those specified by the ExcludeMap.

You can specify account IDs, OUs, or a combination:

  • Specify account IDs by setting the key to ACCOUNT. For example, the following is a valid map: {“ACCOUNT” : [“accountID1”, “accountID2”]}.

  • Specify OUs by setting the key to ORG_UNIT. For example, the following is a valid map: {“ORG_UNIT” : [“ouid111”, “ouid112”]}.

  • Specify accounts and OUs together in a single map, separated with a comma. For example, the following is a valid map: {“ACCOUNT” : [“accountID1”, “accountID2”], “ORG_UNIT” : [“ouid111”, “ouid112”]}.

it_resourcesetids TYPE /AWS1/CL_FMSRESOURCESETIDS_W=>TT_RESOURCESETIDS TT_RESOURCESETIDS

The unique identifiers of the resource sets used by the policy.

iv_policydescription TYPE /AWS1/FMSRESOURCEDESCRIPTION /AWS1/FMSRESOURCEDESCRIPTION

Your description of the Firewall Manager policy.

iv_policystatus TYPE /AWS1/FMSCUSTOMERPOLICYSTATUS /AWS1/FMSCUSTOMERPOLICYSTATUS

Indicates whether the policy is in or out of an admin's policy or Region scope.

  • ACTIVE - The administrator can manage and delete the policy.

  • OUT_OF_ADMIN_SCOPE - The administrator can view the policy, but they can't edit or delete the policy. Existing policy protections stay in place. Any new resources that come into scope of the policy won't be protected.

iv_resourcetaglogicalop TYPE /AWS1/FMSRESOURCETAGLOGICALOP /AWS1/FMSRESOURCETAGLOGICALOP

Specifies whether to combine multiple resource tags with AND, so that a resource must have all tags to be included or excluded, or OR, so that a resource must have at least one tag.

Default: AND

Queryable Attributes

PolicyId

The ID of the Firewall Manager policy.

Accessible with the following methods

Method Description
GET_POLICYID() Getter for POLICYID, with configurable default
ASK_POLICYID() Getter for POLICYID w/ exceptions if field has no value
HAS_POLICYID() Determine if POLICYID has a value

PolicyName

The name of the Firewall Manager policy.

Accessible with the following methods

Method Description
GET_POLICYNAME() Getter for POLICYNAME, with configurable default
ASK_POLICYNAME() Getter for POLICYNAME w/ exceptions if field has no value
HAS_POLICYNAME() Determine if POLICYNAME has a value

PolicyUpdateToken

A unique identifier for each update to the policy. When issuing a PutPolicy request, the PolicyUpdateToken in the request must match the PolicyUpdateToken of the current policy version. To get the PolicyUpdateToken of the current policy version, use a GetPolicy request.

Accessible with the following methods

Method Description
GET_POLICYUPDATETOKEN() Getter for POLICYUPDATETOKEN, with configurable default
ASK_POLICYUPDATETOKEN() Getter for POLICYUPDATETOKEN w/ exceptions if field has no v
HAS_POLICYUPDATETOKEN() Determine if POLICYUPDATETOKEN has a value

SecurityServicePolicyData

Details about the security service that is being used to protect the resources.

Accessible with the following methods

Method Description
GET_SECSERVICEPOLICYDATA() Getter for SECURITYSERVICEPOLICYDATA

ResourceType

The type of resource protected by or in scope of the policy. This is in the format shown in the Amazon Web Services Resource Types Reference. To apply this policy to multiple resource types, specify a resource type of ResourceTypeList and then specify the resource types in a ResourceTypeList.

The following are valid resource types for each Firewall Manager policy type:

  • Amazon Web Services WAF Classic - AWS::ApiGateway::Stage, AWS::CloudFront::Distribution, and AWS::ElasticLoadBalancingV2::LoadBalancer.

  • WAF - AWS::ApiGateway::Stage, AWS::ElasticLoadBalancingV2::LoadBalancer, and AWS::CloudFront::Distribution.

  • Shield Advanced - AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::ElasticLoadBalancing::LoadBalancer, AWS::EC2::EIP, and AWS::CloudFront::Distribution.

  • Network ACL - AWS::EC2::Subnet.

  • Security group usage audit - AWS::EC2::SecurityGroup.

  • Security group content audit - AWS::EC2::SecurityGroup, AWS::EC2::NetworkInterface, and AWS::EC2::Instance.

  • DNS Firewall, Network Firewall, and third-party firewall - AWS::EC2::VPC.

Accessible with the following methods

Method Description
GET_RESOURCETYPE() Getter for RESOURCETYPE, with configurable default
ASK_RESOURCETYPE() Getter for RESOURCETYPE w/ exceptions if field has no value
HAS_RESOURCETYPE() Determine if RESOURCETYPE has a value

ResourceTypeList

An array of ResourceType objects. Use this only to specify multiple resource types. To specify a single resource type, use ResourceType.

Accessible with the following methods

Method Description
GET_RESOURCETYPELIST() Getter for RESOURCETYPELIST, with configurable default
ASK_RESOURCETYPELIST() Getter for RESOURCETYPELIST w/ exceptions if field has no va
HAS_RESOURCETYPELIST() Determine if RESOURCETYPELIST has a value

ResourceTags

An array of ResourceTag objects.

Accessible with the following methods

Method Description
GET_RESOURCETAGS() Getter for RESOURCETAGS, with configurable default
ASK_RESOURCETAGS() Getter for RESOURCETAGS w/ exceptions if field has no value
HAS_RESOURCETAGS() Determine if RESOURCETAGS has a value

ExcludeResourceTags

If set to True, resources with the tags that are specified in the ResourceTag array are not in scope of the policy. If set to False, and the ResourceTag array is not null, only resources with the specified tags are in scope of the policy.

Accessible with the following methods

Method Description
GET_EXCLUDERESOURCETAGS() Getter for EXCLUDERESOURCETAGS

RemediationEnabled

Indicates if the policy should be automatically applied to new resources.

Accessible with the following methods

Method Description
GET_REMEDIATIONENABLED() Getter for REMEDIATIONENABLED

DeleteUnusedFMManagedResources

Indicates whether Firewall Manager should automatically remove protections from resources that leave the policy scope and clean up resources that Firewall Manager is managing for accounts when those accounts leave policy scope. For example, Firewall Manager will disassociate a Firewall Manager managed web ACL from a protected customer resource when the customer resource leaves policy scope.

By default, Firewall Manager doesn't remove protections or delete Firewall Manager managed resources.

This option is not available for Shield Advanced or WAF Classic policies.

Accessible with the following methods

Method Description
GET_DELUNUSEDFMMANAGEDRESRCS() Getter for DELETEUNUSEDFMMANAGEDRESRCS

IncludeMap

Specifies the Amazon Web Services account IDs and Organizations organizational units (OUs) to include in the policy. Specifying an OU is the equivalent of specifying all accounts in the OU and in any of its child OUs, including any child OUs and accounts that are added at a later time.

You can specify inclusions or exclusions, but not both. If you specify an IncludeMap, Firewall Manager applies the policy to all accounts specified by the IncludeMap, and does not evaluate any ExcludeMap specifications. If you do not specify an IncludeMap, then Firewall Manager applies the policy to all accounts except for those specified by the ExcludeMap.

You can specify account IDs, OUs, or a combination:

  • Specify account IDs by setting the key to ACCOUNT. For example, the following is a valid map: {“ACCOUNT” : [“accountID1”, “accountID2”]}.

  • Specify OUs by setting the key to ORG_UNIT. For example, the following is a valid map: {“ORG_UNIT” : [“ouid111”, “ouid112”]}.

  • Specify accounts and OUs together in a single map, separated with a comma. For example, the following is a valid map: {“ACCOUNT” : [“accountID1”, “accountID2”], “ORG_UNIT” : [“ouid111”, “ouid112”]}.

Accessible with the following methods

Method Description
GET_INCLUDEMAP() Getter for INCLUDEMAP, with configurable default
ASK_INCLUDEMAP() Getter for INCLUDEMAP w/ exceptions if field has no value
HAS_INCLUDEMAP() Determine if INCLUDEMAP has a value

ExcludeMap

Specifies the Amazon Web Services account IDs and Organizations organizational units (OUs) to exclude from the policy. Specifying an OU is the equivalent of specifying all accounts in the OU and in any of its child OUs, including any child OUs and accounts that are added at a later time.

You can specify inclusions or exclusions, but not both. If you specify an IncludeMap, Firewall Manager applies the policy to all accounts specified by the IncludeMap, and does not evaluate any ExcludeMap specifications. If you do not specify an IncludeMap, then Firewall Manager applies the policy to all accounts except for those specified by the ExcludeMap.

You can specify account IDs, OUs, or a combination:

  • Specify account IDs by setting the key to ACCOUNT. For example, the following is a valid map: {“ACCOUNT” : [“accountID1”, “accountID2”]}.

  • Specify OUs by setting the key to ORG_UNIT. For example, the following is a valid map: {“ORG_UNIT” : [“ouid111”, “ouid112”]}.

  • Specify accounts and OUs together in a single map, separated with a comma. For example, the following is a valid map: {“ACCOUNT” : [“accountID1”, “accountID2”], “ORG_UNIT” : [“ouid111”, “ouid112”]}.

Accessible with the following methods

Method Description
GET_EXCLUDEMAP() Getter for EXCLUDEMAP, with configurable default
ASK_EXCLUDEMAP() Getter for EXCLUDEMAP w/ exceptions if field has no value
HAS_EXCLUDEMAP() Determine if EXCLUDEMAP has a value

ResourceSetIds

The unique identifiers of the resource sets used by the policy.

Accessible with the following methods

Method Description
GET_RESOURCESETIDS() Getter for RESOURCESETIDS, with configurable default
ASK_RESOURCESETIDS() Getter for RESOURCESETIDS w/ exceptions if field has no valu
HAS_RESOURCESETIDS() Determine if RESOURCESETIDS has a value

PolicyDescription

Your description of the Firewall Manager policy.

Accessible with the following methods

Method Description
GET_POLICYDESCRIPTION() Getter for POLICYDESCRIPTION, with configurable default
ASK_POLICYDESCRIPTION() Getter for POLICYDESCRIPTION w/ exceptions if field has no v
HAS_POLICYDESCRIPTION() Determine if POLICYDESCRIPTION has a value

PolicyStatus

Indicates whether the policy is in or out of an admin's policy or Region scope.

  • ACTIVE - The administrator can manage and delete the policy.

  • OUT_OF_ADMIN_SCOPE - The administrator can view the policy, but they can't edit or delete the policy. Existing policy protections stay in place. Any new resources that come into scope of the policy won't be protected.

Accessible with the following methods

Method Description
GET_POLICYSTATUS() Getter for POLICYSTATUS, with configurable default
ASK_POLICYSTATUS() Getter for POLICYSTATUS w/ exceptions if field has no value
HAS_POLICYSTATUS() Determine if POLICYSTATUS has a value

ResourceTagLogicalOperator

Specifies whether to combine multiple resource tags with AND, so that a resource must have all tags to be included or excluded, or OR, so that a resource must have at least one tag.

Default: AND

Accessible with the following methods

Method Description
GET_RESOURCETAGLOGICALOP() Getter for RESOURCETAGLOGICALOPERATOR, with configurable def
ASK_RESOURCETAGLOGICALOP() Getter for RESOURCETAGLOGICALOPERATOR w/ exceptions if field
HAS_RESOURCETAGLOGICALOP() Determine if RESOURCETAGLOGICALOPERATOR has a value