GetPolicyResult

data class GetPolicyResult(val arn: String? = null, val excludeMap: PolicyIeMap? = null, val excludeResourceTags: Boolean? = null, val id: String? = null, val includeMap: PolicyIeMap? = null, val policyDescription: String? = null, val policyName: String? = null, val remediationEnabled: Boolean? = null, val resourceSetIds: List<String>? = null, val resourceTags: List<PolicyResourceTag>? = null, val resourceType: String? = null, val resourceTypeList: List<String>? = null, val resourcesCleanUp: Boolean? = null, val securityServicePolicyData: PolicySecurityServicePolicyData? = null, val tags: List<Tag>? = null)

Constructors

Link copied to clipboard
constructor(arn: String? = null, excludeMap: PolicyIeMap? = null, excludeResourceTags: Boolean? = null, id: String? = null, includeMap: PolicyIeMap? = null, policyDescription: String? = null, policyName: String? = null, remediationEnabled: Boolean? = null, resourceSetIds: List<String>? = null, resourceTags: List<PolicyResourceTag>? = null, resourceType: String? = null, resourceTypeList: List<String>? = null, resourcesCleanUp: Boolean? = null, securityServicePolicyData: PolicySecurityServicePolicyData? = null, tags: List<Tag>? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val arn: String? = null

The Amazon Resource Name (ARN) of the policy.

Link copied to clipboard
val excludeMap: PolicyIeMap? = null

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:

Link copied to clipboard

Used only when tags are specified in the ResourceTags property. If this property is True , resources with the specified tags are not in scope of the policy. If it's False , only resources with the specified tags are in scope of the policy.

Link copied to clipboard
val id: String? = null

The ID of the policy.

Link copied to clipboard
val includeMap: PolicyIeMap? = null

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:

Link copied to clipboard

Your description of the AWS Firewall Manager policy.

Link copied to clipboard
val policyName: String? = null

The name of the AWS Firewall Manager policy.

Link copied to clipboard

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

Link copied to clipboard

Indicates whether AWS 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 AWS WAF Classic policies.

Link copied to clipboard
val resourceSetIds: List<String>? = null

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

Link copied to clipboard

An array of ResourceTag objects, used to explicitly include resources in the policy scope or explicitly exclude them. If this isn't set, then tags aren't used to modify policy scope. See also ExcludeResourceTags .

Link copied to clipboard
val resourceType: String? = null

The type of resource protected by or in scope of the policy. This is in the format shown in the AWS 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:

Link copied to clipboard

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

Link copied to clipboard

Details about the security service that is being used to protect the resources. This contains the following settings:

Link copied to clipboard
val tags: List<Tag>? = null

A collection of key:value pairs associated with an AWS resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each AWS resource.