Class: Aws::FMS::Types::Policy

Inherits:

Struct

Object
Struct
Aws::FMS::Types::Policy

show all

Includes:: Structure

Defined in:: lib/aws-sdk-fms/types.rb

Overview

An Firewall Manager policy.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#delete_unused_fm_managed_resources ⇒ Boolean

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.
#exclude_map ⇒ Hash<String,Array<String>>

Specifies the Amazon Web Services account IDs and Organizations organizational units (OUs) to exclude from the policy.
#exclude_resource_tags ⇒ Boolean

If set to ‘True`, resources with the tags that are specified in the `ResourceTag` array are not in scope of the policy.
#include_map ⇒ Hash<String,Array<String>>

Specifies the Amazon Web Services account IDs and Organizations organizational units (OUs) to include in the policy.
#policy_description ⇒ String

Your description of the Firewall Manager policy.
#policy_id ⇒ String

The ID of the Firewall Manager policy.
#policy_name ⇒ String

The name of the Firewall Manager policy.
#policy_status ⇒ String

Indicates whether the policy is in or out of an admin’s policy or Region scope.
#policy_update_token ⇒ String

A unique identifier for each update to the policy.
#remediation_enabled ⇒ Boolean

Indicates if the policy should be automatically applied to new resources.
#resource_set_ids ⇒ Array<String>

The unique identifiers of the resource sets used by the policy.
#resource_tags ⇒ Array<Types::ResourceTag>

An array of ‘ResourceTag` objects.
#resource_type ⇒ String

The type of resource protected by or in scope of the policy.
#resource_type_list ⇒ Array<String>

An array of ‘ResourceType` objects.
#security_service_policy_data ⇒ Types::SecurityServicePolicyData

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

Instance Attribute Details

#delete_unused_fm_managed_resources ⇒ `Boolean`

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.

Returns:

(Boolean)

# File 'lib/aws-sdk-fms/types.rb', line 3555

class Policy < Struct.new(
  :policy_id,
  :policy_name,
  :policy_update_token,
  :security_service_policy_data,
  :resource_type,
  :resource_type_list,
  :resource_tags,
  :exclude_resource_tags,
  :remediation_enabled,
  :delete_unused_fm_managed_resources,
  :include_map,
  :exclude_map,
  :resource_set_ids,
  :policy_description,
  :policy_status)
  SENSITIVE = []
  include Aws::Structure
end

#exclude_map ⇒ `Hash<String,Array<String>>`

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: `: [“accountID1”, “accountID2”]`.
Specify OUs by setting the key to ‘ORG_UNIT`. For example, the following is a valid map: `: [“ouid111”, “ouid112”]`.
Specify accounts and OUs together in a single map, separated with a comma. For example, the following is a valid map: ‘: [“accountID1”, “accountID2”], “ORG_UNIT” : [“ouid111”, “ouid112”]`.

Returns:

(Hash<String,Array<String>>)

# File 'lib/aws-sdk-fms/types.rb', line 3555

class Policy < Struct.new(
  :policy_id,
  :policy_name,
  :policy_update_token,
  :security_service_policy_data,
  :resource_type,
  :resource_type_list,
  :resource_tags,
  :exclude_resource_tags,
  :remediation_enabled,
  :delete_unused_fm_managed_resources,
  :include_map,
  :exclude_map,
  :resource_set_ids,
  :policy_description,
  :policy_status)
  SENSITIVE = []
  include Aws::Structure
end

#exclude_resource_tags ⇒ `Boolean`

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.

Returns:

(Boolean)

# File 'lib/aws-sdk-fms/types.rb', line 3555

class Policy < Struct.new(
  :policy_id,
  :policy_name,
  :policy_update_token,
  :security_service_policy_data,
  :resource_type,
  :resource_type_list,
  :resource_tags,
  :exclude_resource_tags,
  :remediation_enabled,
  :delete_unused_fm_managed_resources,
  :include_map,
  :exclude_map,
  :resource_set_ids,
  :policy_description,
  :policy_status)
  SENSITIVE = []
  include Aws::Structure
end

#include_map ⇒ `Hash<String,Array<String>>`

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 account IDs, OUs, or a combination:

Specify account IDs by setting the key to ‘ACCOUNT`. For example, the following is a valid map: `: [“accountID1”, “accountID2”]`.
Specify OUs by setting the key to ‘ORG_UNIT`. For example, the following is a valid map: `: [“ouid111”, “ouid112”]`.
Specify accounts and OUs together in a single map, separated with a comma. For example, the following is a valid map: ‘: [“accountID1”, “accountID2”], “ORG_UNIT” : [“ouid111”, “ouid112”]`.

Returns:

(Hash<String,Array<String>>)

# File 'lib/aws-sdk-fms/types.rb', line 3555

class Policy < Struct.new(
  :policy_id,
  :policy_name,
  :policy_update_token,
  :security_service_policy_data,
  :resource_type,
  :resource_type_list,
  :resource_tags,
  :exclude_resource_tags,
  :remediation_enabled,
  :delete_unused_fm_managed_resources,
  :include_map,
  :exclude_map,
  :resource_set_ids,
  :policy_description,
  :policy_status)
  SENSITIVE = []
  include Aws::Structure
end

#policy_description ⇒ `String`

Your description of the Firewall Manager policy.

Returns:

(String)

# File 'lib/aws-sdk-fms/types.rb', line 3555

class Policy < Struct.new(
  :policy_id,
  :policy_name,
  :policy_update_token,
  :security_service_policy_data,
  :resource_type,
  :resource_type_list,
  :resource_tags,
  :exclude_resource_tags,
  :remediation_enabled,
  :delete_unused_fm_managed_resources,
  :include_map,
  :exclude_map,
  :resource_set_ids,
  :policy_description,
  :policy_status)
  SENSITIVE = []
  include Aws::Structure
end

#policy_id ⇒ `String`

The ID of the Firewall Manager policy.

Returns:

(String)

# File 'lib/aws-sdk-fms/types.rb', line 3555

class Policy < Struct.new(
  :policy_id,
  :policy_name,
  :policy_update_token,
  :security_service_policy_data,
  :resource_type,
  :resource_type_list,
  :resource_tags,
  :exclude_resource_tags,
  :remediation_enabled,
  :delete_unused_fm_managed_resources,
  :include_map,
  :exclude_map,
  :resource_set_ids,
  :policy_description,
  :policy_status)
  SENSITIVE = []
  include Aws::Structure
end

#policy_name ⇒ `String`

The name of the Firewall Manager policy.

Returns:

(String)

# File 'lib/aws-sdk-fms/types.rb', line 3555

class Policy < Struct.new(
  :policy_id,
  :policy_name,
  :policy_update_token,
  :security_service_policy_data,
  :resource_type,
  :resource_type_list,
  :resource_tags,
  :exclude_resource_tags,
  :remediation_enabled,
  :delete_unused_fm_managed_resources,
  :include_map,
  :exclude_map,
  :resource_set_ids,
  :policy_description,
  :policy_status)
  SENSITIVE = []
  include Aws::Structure
end

#policy_status ⇒ `String`

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.

Returns:

(String)

# File 'lib/aws-sdk-fms/types.rb', line 3555

class Policy < Struct.new(
  :policy_id,
  :policy_name,
  :policy_update_token,
  :security_service_policy_data,
  :resource_type,
  :resource_type_list,
  :resource_tags,
  :exclude_resource_tags,
  :remediation_enabled,
  :delete_unused_fm_managed_resources,
  :include_map,
  :exclude_map,
  :resource_set_ids,
  :policy_description,
  :policy_status)
  SENSITIVE = []
  include Aws::Structure
end

#policy_update_token ⇒ `String`

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.

Returns:

(String)

# File 'lib/aws-sdk-fms/types.rb', line 3555

class Policy < Struct.new(
  :policy_id,
  :policy_name,
  :policy_update_token,
  :security_service_policy_data,
  :resource_type,
  :resource_type_list,
  :resource_tags,
  :exclude_resource_tags,
  :remediation_enabled,
  :delete_unused_fm_managed_resources,
  :include_map,
  :exclude_map,
  :resource_set_ids,
  :policy_description,
  :policy_status)
  SENSITIVE = []
  include Aws::Structure
end

#remediation_enabled ⇒ `Boolean`

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

Returns:

(Boolean)

# File 'lib/aws-sdk-fms/types.rb', line 3555

class Policy < Struct.new(
  :policy_id,
  :policy_name,
  :policy_update_token,
  :security_service_policy_data,
  :resource_type,
  :resource_type_list,
  :resource_tags,
  :exclude_resource_tags,
  :remediation_enabled,
  :delete_unused_fm_managed_resources,
  :include_map,
  :exclude_map,
  :resource_set_ids,
  :policy_description,
  :policy_status)
  SENSITIVE = []
  include Aws::Structure
end

#resource_set_ids ⇒ `Array<String>`

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

Returns:

(Array<String>)

# File 'lib/aws-sdk-fms/types.rb', line 3555

class Policy < Struct.new(
  :policy_id,
  :policy_name,
  :policy_update_token,
  :security_service_policy_data,
  :resource_type,
  :resource_type_list,
  :resource_tags,
  :exclude_resource_tags,
  :remediation_enabled,
  :delete_unused_fm_managed_resources,
  :include_map,
  :exclude_map,
  :resource_set_ids,
  :policy_description,
  :policy_status)
  SENSITIVE = []
  include Aws::Structure
end

#resource_tags ⇒ `Array<Types::ResourceTag>`

An array of ‘ResourceTag` objects.

Returns:

(Array<Types::ResourceTag>)

# File 'lib/aws-sdk-fms/types.rb', line 3555

class Policy < Struct.new(
  :policy_id,
  :policy_name,
  :policy_update_token,
  :security_service_policy_data,
  :resource_type,
  :resource_type_list,
  :resource_tags,
  :exclude_resource_tags,
  :remediation_enabled,
  :delete_unused_fm_managed_resources,
  :include_map,
  :exclude_map,
  :resource_set_ids,
  :policy_description,
  :policy_status)
  SENSITIVE = []
  include Aws::Structure
end

#resource_type ⇒ `String`

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`.

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

Returns:

(String)

# File 'lib/aws-sdk-fms/types.rb', line 3555

class Policy < Struct.new(
  :policy_id,
  :policy_name,
  :policy_update_token,
  :security_service_policy_data,
  :resource_type,
  :resource_type_list,
  :resource_tags,
  :exclude_resource_tags,
  :remediation_enabled,
  :delete_unused_fm_managed_resources,
  :include_map,
  :exclude_map,
  :resource_set_ids,
  :policy_description,
  :policy_status)
  SENSITIVE = []
  include Aws::Structure
end

#resource_type_list ⇒ `Array<String>`

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

Returns:

(Array<String>)

# File 'lib/aws-sdk-fms/types.rb', line 3555

class Policy < Struct.new(
  :policy_id,
  :policy_name,
  :policy_update_token,
  :security_service_policy_data,
  :resource_type,
  :resource_type_list,
  :resource_tags,
  :exclude_resource_tags,
  :remediation_enabled,
  :delete_unused_fm_managed_resources,
  :include_map,
  :exclude_map,
  :resource_set_ids,
  :policy_description,
  :policy_status)
  SENSITIVE = []
  include Aws::Structure
end

#security_service_policy_data ⇒ `Types::SecurityServicePolicyData`

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

Returns:

(Types::SecurityServicePolicyData)

# File 'lib/aws-sdk-fms/types.rb', line 3555

class Policy < Struct.new(
  :policy_id,
  :policy_name,
  :policy_update_token,
  :security_service_policy_data,
  :resource_type,
  :resource_type_list,
  :resource_tags,
  :exclude_resource_tags,
  :remediation_enabled,
  :delete_unused_fm_managed_resources,
  :include_map,
  :exclude_map,
  :resource_set_ids,
  :policy_description,
  :policy_status)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::FMS::Types::Policy

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#delete_unused_fm_managed_resources ⇒ Boolean

#exclude_map ⇒ Hash<String,Array<String>>

#exclude_resource_tags ⇒ Boolean

#include_map ⇒ Hash<String,Array<String>>

#policy_description ⇒ String

#policy_id ⇒ String

#policy_name ⇒ String

#policy_status ⇒ String

#policy_update_token ⇒ String

#remediation_enabled ⇒ Boolean

#resource_set_ids ⇒ Array<String>

#resource_tags ⇒ Array<Types::ResourceTag>

#resource_type ⇒ String

#resource_type_list ⇒ Array<String>

#security_service_policy_data ⇒ Types::SecurityServicePolicyData

#delete_unused_fm_managed_resources ⇒ `Boolean`

#exclude_map ⇒ `Hash<String,Array<String>>`

#exclude_resource_tags ⇒ `Boolean`

#include_map ⇒ `Hash<String,Array<String>>`

#policy_description ⇒ `String`

#policy_id ⇒ `String`

#policy_name ⇒ `String`

#policy_status ⇒ `String`

#policy_update_token ⇒ `String`

#remediation_enabled ⇒ `Boolean`

#resource_set_ids ⇒ `Array<String>`

#resource_tags ⇒ `Array<Types::ResourceTag>`

#resource_type ⇒ `String`

#resource_type_list ⇒ `Array<String>`

#security_service_policy_data ⇒ `Types::SecurityServicePolicyData`