class Aws::FMS::Types::Policy

An Firewall Manager policy.

@note When making an API call, you may pass Policy

data as a hash:

    {
      policy_id: "PolicyId",
      policy_name: "ResourceName", # required
      policy_update_token: "PolicyUpdateToken",
      security_service_policy_data: { # required
        type: "WAF", # required, accepts WAF, WAFV2, SHIELD_ADVANCED, SECURITY_GROUPS_COMMON, SECURITY_GROUPS_CONTENT_AUDIT, SECURITY_GROUPS_USAGE_AUDIT, NETWORK_FIREWALL, DNS_FIREWALL
        managed_service_data: "ManagedServiceData",
      },
      resource_type: "ResourceType", # required
      resource_type_list: ["ResourceType"],
      resource_tags: [
        {
          key: "ResourceTagKey", # required
          value: "ResourceTagValue",
        },
      ],
      exclude_resource_tags: false, # required
      remediation_enabled: false, # required
      delete_unused_fm_managed_resources: false,
      include_map: {
        "ACCOUNT" => ["CustomerPolicyScopeId"],
      },
      exclude_map: {
        "ACCOUNT" => ["CustomerPolicyScopeId"],
      },
    }

@!attribute [rw] policy_id

The ID of the Firewall Manager policy.
@return [String]

@!attribute [rw] policy_name

The name of the Firewall Manager policy.
@return [String]

@!attribute [rw] policy_update_token

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.
@return [String]

@!attribute [rw] security_service_policy_data

Details about the security service that is being used to protect the
resources.
@return [Types::SecurityServicePolicyData]

@!attribute [rw] resource_type

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][1]. To apply this policy to multiple resource types,
specify a resource type of `ResourceTypeList` and then specify the
resource types in a `ResourceTypeList`.

For WAF and Shield Advanced, example resource types include
`AWS::ElasticLoadBalancingV2::LoadBalancer` and
`AWS::CloudFront::Distribution`. For a security group common policy,
valid values are `AWS::EC2::NetworkInterface` and
`AWS::EC2::Instance`. For a security group content audit policy,
valid values are `AWS::EC2::SecurityGroup`,
`AWS::EC2::NetworkInterface`, and `AWS::EC2::Instance`. For a
security group usage audit policy, the value is
`AWS::EC2::SecurityGroup`. For an Network Firewall policy or DNS
Firewall policy, the value is `AWS::EC2::VPC`.

[1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html
@return [String]

@!attribute [rw] resource_type_list

An array of `ResourceType` objects. Use this only to specify
multiple resource types. To specify a single resource type, use
`ResourceType`.
@return [Array<String>]

@!attribute [rw] resource_tags

An array of `ResourceTag` objects.
@return [Array<Types::ResourceTag>]

@!attribute [rw] exclude_resource_tags

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.
@return [Boolean]

@!attribute [rw] remediation_enabled

Indicates if the policy should be automatically applied to new
resources.
@return [Boolean]

@!attribute [rw] delete_unused_fm_managed_resources

Indicates whether Firewall Manager should delete Firewall Manager
managed resources, such as web ACLs and security groups, when they
are not in use by the Firewall Manager policy. By default, Firewall
Manager doesn't delete unused Firewall Manager managed resources.
This option is not available for Shield Advanced or WAF Classic
policies.
@return [Boolean]

@!attribute [rw] include_map

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”]\}`.
@return [Hash<String,Array<String>>]

@!attribute [rw] exclude_map

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”]\}`.
@return [Hash<String,Array<String>>]

@see docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/Policy AWS API Documentation

Constants

SENSITIVE