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

Inherits:

Struct

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

Defined in:

gems/aws-sdk-fms/lib/aws-sdk-fms/types.rb

Overview

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
  include_map: {
    "ACCOUNT" => ["CustomerPolicyScopeId"],
  },
  exclude_map: {
    "ACCOUNT" => ["CustomerPolicyScopeId"],
  },
}

An AWS Firewall Manager policy.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

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

  Specifies the AWS account IDs and AWS 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 AWS account IDs and AWS Organizations organizational units (OUs) to include in the policy.

• #policy_id ⇒ String

  The ID of the AWS Firewall Manager policy.

• #policy_name ⇒ String

  The name of the AWS Firewall Manager policy.

• #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_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.

• #security_service_policy_data ⇒ Types::SecurityServicePolicyData

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

Instance Attribute Details

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

Specifies the AWS account IDs and AWS 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, AWS 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”]\}.

Returns:

• (Hash<String,Array<String>>)

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

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,
  :include_map,
  :exclude_map)
  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 'gems/aws-sdk-fms/lib/aws-sdk-fms/types.rb', line 1667

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,
  :include_map,
  :exclude_map)
  SENSITIVE = []
  include Aws::Structure
end

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

Specifies the AWS account IDs and AWS 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, AWS 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”]\}.

Returns:

• (Hash<String,Array<String>>)

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

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,
  :include_map,
  :exclude_map)
  SENSITIVE = []
  include Aws::Structure
end

#policy_id ⇒ String

The ID of the AWS Firewall Manager policy.

Returns:

• (String)

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

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,
  :include_map,
  :exclude_map)
  SENSITIVE = []
  include Aws::Structure
end

#policy_name ⇒ String

The name of the AWS Firewall Manager policy.

Returns:

• (String)

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

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,
  :include_map,
  :exclude_map)
  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 'gems/aws-sdk-fms/lib/aws-sdk-fms/types.rb', line 1667

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,
  :include_map,
  :exclude_map)
  SENSITIVE = []
  include Aws::Structure
end

#remediation_enabled ⇒ Boolean

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

Returns:

• (Boolean)

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

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,
  :include_map,
  :exclude_map)
  SENSITIVE = []
  include Aws::Structure
end

#resource_tags ⇒ Array<Types::ResourceTag>

An array of ResourceTag objects.

Returns:

• (Array<Types::ResourceTag>)

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

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,
  :include_map,
  :exclude_map)
  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 AWS Resource Types Reference. For AWS WAF and Shield Advanced, examples 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 AWS Network Firewall policy, the value is AWS::EC2::VPC.

Returns:

• (String)

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

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,
  :include_map,
  :exclude_map)
  SENSITIVE = []
  include Aws::Structure
end

#resource_type_list ⇒ Array<String>

An array of ResourceType.

Returns:

• (Array<String>)

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

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,
  :include_map,
  :exclude_map)
  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 'gems/aws-sdk-fms/lib/aws-sdk-fms/types.rb', line 1667

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,
  :include_map,
  :exclude_map)
  SENSITIVE = []
  include Aws::Structure
end