Policy (AWS Java SDK for Firewall Management 1.11.570 API)

java.lang.Object
- com.amazonaws.services.fms.model.Policy

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Policy
extends Object
implements Serializable, Cloneable, StructuredPojo

An AWS Firewall Manager policy.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Policy()

Constructors
Constructor and Description
`Policy()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Policy`	`addExcludeMapEntry(String key, List<String> value)`
`Policy`	`addIncludeMapEntry(String key, List<String> value)`
`Policy`	`clearExcludeMapEntries()` Removes all the entries added into ExcludeMap.
`Policy`	`clearIncludeMapEntries()` Removes all the entries added into IncludeMap.
`Policy`	`clone()`
`boolean`	`equals(Object obj)`
`Map<String,List<String>>`	`getExcludeMap()` Specifies the AWS account IDs to exclude from the policy.
`Boolean`	`getExcludeResourceTags()` If set to `True`, resources with the tags that are specified in the `ResourceTag` array are not protected by the policy.
`Map<String,List<String>>`	`getIncludeMap()` Specifies the AWS account IDs to include in the policy.
`String`	`getPolicyId()` The ID of the AWS Firewall Manager policy.
`String`	`getPolicyName()` The friendly name of the AWS Firewall Manager policy.
`String`	`getPolicyUpdateToken()` A unique identifier for each update to the policy.
`Boolean`	`getRemediationEnabled()` Indicates if the policy should be automatically applied to new resources.
`List<ResourceTag>`	`getResourceTags()` An array of `ResourceTag` objects.
`String`	`getResourceType()` The type of resource to protect with the policy.
`List<String>`	`getResourceTypeList()` An array of `ResourceType`.
`SecurityServicePolicyData`	`getSecurityServicePolicyData()` Details about the security service that is being used to protect the resources.
`int`	`hashCode()`
`Boolean`	`isExcludeResourceTags()` If set to `True`, resources with the tags that are specified in the `ResourceTag` array are not protected by the policy.
`Boolean`	`isRemediationEnabled()` Indicates if the policy should be automatically applied to new resources.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setExcludeMap(Map<String,List<String>> excludeMap)` Specifies the AWS account IDs to exclude from the policy.
`void`	`setExcludeResourceTags(Boolean excludeResourceTags)` If set to `True`, resources with the tags that are specified in the `ResourceTag` array are not protected by the policy.
`void`	`setIncludeMap(Map<String,List<String>> includeMap)` Specifies the AWS account IDs to include in the policy.
`void`	`setPolicyId(String policyId)` The ID of the AWS Firewall Manager policy.
`void`	`setPolicyName(String policyName)` The friendly name of the AWS Firewall Manager policy.
`void`	`setPolicyUpdateToken(String policyUpdateToken)` A unique identifier for each update to the policy.
`void`	`setRemediationEnabled(Boolean remediationEnabled)` Indicates if the policy should be automatically applied to new resources.
`void`	`setResourceTags(Collection<ResourceTag> resourceTags)` An array of `ResourceTag` objects.
`void`	`setResourceType(String resourceType)` The type of resource to protect with the policy.
`void`	`setResourceTypeList(Collection<String> resourceTypeList)` An array of `ResourceType`.
`void`	`setSecurityServicePolicyData(SecurityServicePolicyData securityServicePolicyData)` Details about the security service that is being used to protect the resources.
`String`	`toString()` Returns a string representation of this object.
`Policy`	`withExcludeMap(Map<String,List<String>> excludeMap)` Specifies the AWS account IDs to exclude from the policy.
`Policy`	`withExcludeResourceTags(Boolean excludeResourceTags)` If set to `True`, resources with the tags that are specified in the `ResourceTag` array are not protected by the policy.
`Policy`	`withIncludeMap(Map<String,List<String>> includeMap)` Specifies the AWS account IDs to include in the policy.
`Policy`	`withPolicyId(String policyId)` The ID of the AWS Firewall Manager policy.
`Policy`	`withPolicyName(String policyName)` The friendly name of the AWS Firewall Manager policy.
`Policy`	`withPolicyUpdateToken(String policyUpdateToken)` A unique identifier for each update to the policy.
`Policy`	`withRemediationEnabled(Boolean remediationEnabled)` Indicates if the policy should be automatically applied to new resources.
`Policy`	`withResourceTags(Collection<ResourceTag> resourceTags)` An array of `ResourceTag` objects.
`Policy`	`withResourceTags(ResourceTag... resourceTags)` An array of `ResourceTag` objects.
`Policy`	`withResourceType(String resourceType)` The type of resource to protect with the policy.
`Policy`	`withResourceTypeList(Collection<String> resourceTypeList)` An array of `ResourceType`.
`Policy`	`withResourceTypeList(String... resourceTypeList)` An array of `ResourceType`.
`Policy`	`withSecurityServicePolicyData(SecurityServicePolicyData securityServicePolicyData)` Details about the security service that is being used to protect the resources.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Policy
```
public Policy()
```
- Method Detail
  - setPolicyId
```
public void setPolicyId(String policyId)
```
    The ID of the AWS Firewall Manager policy.
    
    Parameters:
    
    policyId - The ID of the AWS Firewall Manager policy.
  - getPolicyId
```
public String getPolicyId()
```
    The ID of the AWS Firewall Manager policy.
    
    Returns:
    
    The ID of the AWS Firewall Manager policy.
  - withPolicyId
```
public Policy withPolicyId(String policyId)
```
    The ID of the AWS Firewall Manager policy.
    
    Parameters:
    
    policyId - The ID of the AWS Firewall Manager policy.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPolicyName
```
public void setPolicyName(String policyName)
```
    The friendly name of the AWS Firewall Manager policy.
    
    Parameters:
    
    policyName - The friendly name of the AWS Firewall Manager policy.
  - getPolicyName
```
public String getPolicyName()
```
    The friendly name of the AWS Firewall Manager policy.
    
    Returns:
    
    The friendly name of the AWS Firewall Manager policy.
  - withPolicyName
```
public Policy withPolicyName(String policyName)
```
    The friendly name of the AWS Firewall Manager policy.
    
    Parameters:
    
    policyName - The friendly name of the AWS Firewall Manager policy.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPolicyUpdateToken
```
public void setPolicyUpdateToken(String 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.
    
    Parameters:
    
    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.
  - getPolicyUpdateToken
```
public String getPolicyUpdateToken()
```
    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:
    
    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.
  - withPolicyUpdateToken
```
public Policy withPolicyUpdateToken(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSecurityServicePolicyData
```
public void setSecurityServicePolicyData(SecurityServicePolicyData securityServicePolicyData)
```
    Details about the security service that is being used to protect the resources.
    
    Parameters:
    
    securityServicePolicyData - Details about the security service that is being used to protect the resources.
  - getSecurityServicePolicyData
```
public SecurityServicePolicyData getSecurityServicePolicyData()
```
    Details about the security service that is being used to protect the resources.
    
    Returns:
    
    Details about the security service that is being used to protect the resources.
  - withSecurityServicePolicyData
```
public Policy withSecurityServicePolicyData(SecurityServicePolicyData securityServicePolicyData)
```
    Details about the security service that is being used to protect the resources.
    
    Parameters:
    
    securityServicePolicyData - Details about the security service that is being used to protect the resources.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResourceType
```
public void setResourceType(String resourceType)
```
    The type of resource to protect with the policy. This is in the format shown in AWS Resource Types Reference. For example: AWS::ElasticLoadBalancingV2::LoadBalancer or AWS::CloudFront::Distribution.
    
    Parameters:
    
    resourceType - The type of resource to protect with the policy. This is in the format shown in AWS Resource Types Reference. For example: AWS::ElasticLoadBalancingV2::LoadBalancer or AWS::CloudFront::Distribution.
  - getResourceType
```
public String getResourceType()
```
    The type of resource to protect with the policy. This is in the format shown in AWS Resource Types Reference. For example: AWS::ElasticLoadBalancingV2::LoadBalancer or AWS::CloudFront::Distribution.
    
    Returns:
    
    The type of resource to protect with the policy. This is in the format shown in AWS Resource Types Reference. For example: AWS::ElasticLoadBalancingV2::LoadBalancer or AWS::CloudFront::Distribution.
  - withResourceType
```
public Policy withResourceType(String resourceType)
```
    The type of resource to protect with the policy. This is in the format shown in AWS Resource Types Reference. For example: AWS::ElasticLoadBalancingV2::LoadBalancer or AWS::CloudFront::Distribution.
    
    Parameters:
    
    resourceType - The type of resource to protect with the policy. This is in the format shown in AWS Resource Types Reference. For example: AWS::ElasticLoadBalancingV2::LoadBalancer or AWS::CloudFront::Distribution.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getResourceTypeList
```
public List<String> getResourceTypeList()
```
    An array of ResourceType.
    
    Returns:
    
    An array of ResourceType.
  - setResourceTypeList
```
public void setResourceTypeList(Collection<String> resourceTypeList)
```
    An array of ResourceType.
    
    Parameters:
    
    resourceTypeList - An array of ResourceType.
  - withResourceTypeList
```
public Policy withResourceTypeList(String... resourceTypeList)
```
    An array of ResourceType.
    
    NOTE: This method appends the values to the existing list (if any). Use setResourceTypeList(java.util.Collection) or withResourceTypeList(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    resourceTypeList - An array of ResourceType.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withResourceTypeList
```
public Policy withResourceTypeList(Collection<String> resourceTypeList)
```
    An array of ResourceType.
    
    Parameters:
    
    resourceTypeList - An array of ResourceType.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getResourceTags
```
public List<ResourceTag> getResourceTags()
```
    An array of ResourceTag objects.
    
    Returns:
    
    An array of ResourceTag objects.
  - setResourceTags
```
public void setResourceTags(Collection<ResourceTag> resourceTags)
```
    An array of ResourceTag objects.
    
    Parameters:
    
    resourceTags - An array of ResourceTag objects.
  - withResourceTags
```
public Policy withResourceTags(ResourceTag... resourceTags)
```
    An array of ResourceTag objects.
    
    NOTE: This method appends the values to the existing list (if any). Use setResourceTags(java.util.Collection) or withResourceTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    resourceTags - An array of ResourceTag objects.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withResourceTags
```
public Policy withResourceTags(Collection<ResourceTag> resourceTags)
```
    An array of ResourceTag objects.
    
    Parameters:
    
    resourceTags - An array of ResourceTag objects.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExcludeResourceTags
```
public void setExcludeResourceTags(Boolean excludeResourceTags)
```
    If set to True, resources with the tags that are specified in the ResourceTag array are not protected by the policy. If set to False, and the ResourceTag array is not null, only resources with the specified tags are associated with the policy.
    
    Parameters:
    
    excludeResourceTags - If set to True, resources with the tags that are specified in the ResourceTag array are not protected by the policy. If set to False, and the ResourceTag array is not null, only resources with the specified tags are associated with the policy.
  - getExcludeResourceTags
```
public Boolean getExcludeResourceTags()
```
    If set to True, resources with the tags that are specified in the ResourceTag array are not protected by the policy. If set to False, and the ResourceTag array is not null, only resources with the specified tags are associated with the policy.
    
    Returns:
    
    If set to True, resources with the tags that are specified in the ResourceTag array are not protected by the policy. If set to False, and the ResourceTag array is not null, only resources with the specified tags are associated with the policy.
  - withExcludeResourceTags
```
public Policy withExcludeResourceTags(Boolean excludeResourceTags)
```
    If set to True, resources with the tags that are specified in the ResourceTag array are not protected by the policy. If set to False, and the ResourceTag array is not null, only resources with the specified tags are associated with the policy.
    
    Parameters:
    
    excludeResourceTags - If set to True, resources with the tags that are specified in the ResourceTag array are not protected by the policy. If set to False, and the ResourceTag array is not null, only resources with the specified tags are associated with the policy.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isExcludeResourceTags
```
public Boolean isExcludeResourceTags()
```
    If set to True, resources with the tags that are specified in the ResourceTag array are not protected by the policy. If set to False, and the ResourceTag array is not null, only resources with the specified tags are associated with the policy.
    
    Returns:
    
    If set to True, resources with the tags that are specified in the ResourceTag array are not protected by the policy. If set to False, and the ResourceTag array is not null, only resources with the specified tags are associated with the policy.
  - setRemediationEnabled
```
public void setRemediationEnabled(Boolean remediationEnabled)
```
    Indicates if the policy should be automatically applied to new resources.
    
    Parameters:
    
    remediationEnabled - Indicates if the policy should be automatically applied to new resources.
  - getRemediationEnabled
```
public Boolean getRemediationEnabled()
```
    Indicates if the policy should be automatically applied to new resources.
    
    Returns:
    
    Indicates if the policy should be automatically applied to new resources.
  - withRemediationEnabled
```
public Policy withRemediationEnabled(Boolean remediationEnabled)
```
    Indicates if the policy should be automatically applied to new resources.
    
    Parameters:
    
    remediationEnabled - Indicates if the policy should be automatically applied to new resources.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isRemediationEnabled
```
public Boolean isRemediationEnabled()
```
    Indicates if the policy should be automatically applied to new resources.
    
    Returns:
    
    Indicates if the policy should be automatically applied to new resources.
  - getIncludeMap
```
public Map<String,List<String>> getIncludeMap()
```
    Specifies the AWS account IDs to include in the policy. If IncludeMap is null, all accounts in the organization in AWS Organizations are included in the policy. If IncludeMap is not null, only values listed in IncludeMap are included in the policy.
    
    The key to the map is ACCOUNT. For example, a valid IncludeMap would be {“ACCOUNT” : [“accountID1”, “accountID2”]}.
    
    Returns:
    
    Specifies the AWS account IDs to include in the policy. If IncludeMap is null, all accounts in the organization in AWS Organizations are included in the policy. If IncludeMap is not null, only values listed in IncludeMap are included in the policy.
    
    The key to the map is ACCOUNT. For example, a valid IncludeMap would be {“ACCOUNT” : [“accountID1”, “accountID2”]}.
  - setIncludeMap
```
public void setIncludeMap(Map<String,List<String>> includeMap)
```
    Specifies the AWS account IDs to include in the policy. If IncludeMap is null, all accounts in the organization in AWS Organizations are included in the policy. If IncludeMap is not null, only values listed in IncludeMap are included in the policy.
    
    The key to the map is ACCOUNT. For example, a valid IncludeMap would be {“ACCOUNT” : [“accountID1”, “accountID2”]}.
    
    Parameters:
    
    includeMap - Specifies the AWS account IDs to include in the policy. If IncludeMap is null, all accounts in the organization in AWS Organizations are included in the policy. If IncludeMap is not null, only values listed in IncludeMap are included in the policy.
    
    The key to the map is ACCOUNT. For example, a valid IncludeMap would be {“ACCOUNT” : [“accountID1”, “accountID2”]}.
  - withIncludeMap
```
public Policy withIncludeMap(Map<String,List<String>> includeMap)
```
    Specifies the AWS account IDs to include in the policy. If IncludeMap is null, all accounts in the organization in AWS Organizations are included in the policy. If IncludeMap is not null, only values listed in IncludeMap are included in the policy.
    
    The key to the map is ACCOUNT. For example, a valid IncludeMap would be {“ACCOUNT” : [“accountID1”, “accountID2”]}.
    
    Parameters:
    
    includeMap - Specifies the AWS account IDs to include in the policy. If IncludeMap is null, all accounts in the organization in AWS Organizations are included in the policy. If IncludeMap is not null, only values listed in IncludeMap are included in the policy.
    
    The key to the map is ACCOUNT. For example, a valid IncludeMap would be {“ACCOUNT” : [“accountID1”, “accountID2”]}.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addIncludeMapEntry
```
public Policy addIncludeMapEntry(String key,
                                 List<String> value)
```
  - clearIncludeMapEntries
```
public Policy clearIncludeMapEntries()
```
    Removes all the entries added into IncludeMap.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getExcludeMap
```
public Map<String,List<String>> getExcludeMap()
```
    Specifies the AWS account IDs to exclude from the policy. The IncludeMap values are evaluated first, with all the appropriate account IDs added to the policy. Then the accounts listed in ExcludeMap are removed, resulting in the final list of accounts to add to the policy.
    
    The key to the map is ACCOUNT. For example, a valid ExcludeMap would be {“ACCOUNT” : [“accountID1”, “accountID2”]}.
    
    Returns:
    
    Specifies the AWS account IDs to exclude from the policy. The IncludeMap values are evaluated first, with all the appropriate account IDs added to the policy. Then the accounts listed in ExcludeMap are removed, resulting in the final list of accounts to add to the policy.
    
    The key to the map is ACCOUNT. For example, a valid ExcludeMap would be {“ACCOUNT” : [“accountID1”, “accountID2”]}.
  - setExcludeMap
```
public void setExcludeMap(Map<String,List<String>> excludeMap)
```
    Specifies the AWS account IDs to exclude from the policy. The IncludeMap values are evaluated first, with all the appropriate account IDs added to the policy. Then the accounts listed in ExcludeMap are removed, resulting in the final list of accounts to add to the policy.
    
    The key to the map is ACCOUNT. For example, a valid ExcludeMap would be {“ACCOUNT” : [“accountID1”, “accountID2”]}.
    
    Parameters:
    
    excludeMap - Specifies the AWS account IDs to exclude from the policy. The IncludeMap values are evaluated first, with all the appropriate account IDs added to the policy. Then the accounts listed in ExcludeMap are removed, resulting in the final list of accounts to add to the policy.
    
    The key to the map is ACCOUNT. For example, a valid ExcludeMap would be {“ACCOUNT” : [“accountID1”, “accountID2”]}.
  - withExcludeMap
```
public Policy withExcludeMap(Map<String,List<String>> excludeMap)
```
    Specifies the AWS account IDs to exclude from the policy. The IncludeMap values are evaluated first, with all the appropriate account IDs added to the policy. Then the accounts listed in ExcludeMap are removed, resulting in the final list of accounts to add to the policy.
    
    The key to the map is ACCOUNT. For example, a valid ExcludeMap would be {“ACCOUNT” : [“accountID1”, “accountID2”]}.
    
    Parameters:
    
    excludeMap - Specifies the AWS account IDs to exclude from the policy. The IncludeMap values are evaluated first, with all the appropriate account IDs added to the policy. Then the accounts listed in ExcludeMap are removed, resulting in the final list of accounts to add to the policy.
    
    The key to the map is ACCOUNT. For example, a valid ExcludeMap would be {“ACCOUNT” : [“accountID1”, “accountID2”]}.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addExcludeMapEntry
```
public Policy addExcludeMapEntry(String key,
                                 List<String> value)
```
  - clearExcludeMapEntries
```
public Policy clearExcludeMapEntries()
```
    Removes all the entries added into ExcludeMap.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Policy clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class Policy

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Policy

Method Detail

setPolicyId

getPolicyId

withPolicyId

setPolicyName

getPolicyName

withPolicyName

setPolicyUpdateToken

getPolicyUpdateToken

withPolicyUpdateToken

setSecurityServicePolicyData

getSecurityServicePolicyData

withSecurityServicePolicyData

setResourceType

getResourceType

withResourceType

getResourceTypeList

setResourceTypeList

withResourceTypeList

withResourceTypeList

getResourceTags

setResourceTags

withResourceTags

withResourceTags

setExcludeResourceTags

getExcludeResourceTags

withExcludeResourceTags

isExcludeResourceTags

setRemediationEnabled

getRemediationEnabled

withRemediationEnabled

isRemediationEnabled

getIncludeMap

setIncludeMap

withIncludeMap

addIncludeMapEntry

clearIncludeMapEntries

getExcludeMap

setExcludeMap

withExcludeMap

addExcludeMapEntry

clearExcludeMapEntries

toString

equals

hashCode

clone

marshall