Policy (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.fms.model.Policy

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Policy.Builder,Policy>

@Generated(value="software.amazon.awssdk:codegen")
public final class Policy
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Policy.Builder,Policy>

An AWS Firewall Manager policy.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Policy.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Policy.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Policy.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`Map<CustomerPolicyScopeIdType,List<String>>`	`excludeMap()` Specifies the AWS account IDs to exclude from the policy.
`Map<String,List<String>>`	`excludeMapAsStrings()` Specifies the AWS account IDs to exclude from the policy.
`Boolean`	`excludeResourceTags()` If set to `True`, resources with the tags that are specified in the `ResourceTag` array are not protected by the policy.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Map<CustomerPolicyScopeIdType,List<String>>`	`includeMap()` Specifies the AWS account IDs to include in the policy.
`Map<String,List<String>>`	`includeMapAsStrings()` Specifies the AWS account IDs to include in the policy.
`String`	`policyId()` The ID of the AWS Firewall Manager policy.
`String`	`policyName()` The friendly name of the AWS Firewall Manager policy.
`String`	`policyUpdateToken()` A unique identifier for each update to the policy.
`Boolean`	`remediationEnabled()` Indicates if the policy should be automatically applied to new resources.
`List<ResourceTag>`	`resourceTags()` An array of `ResourceTag` objects.
`String`	`resourceType()` The type of resource to protect with the policy, either an Application Load Balancer or a CloudFront distribution.
`List<SdkField<?>>`	`sdkFields()`
`SecurityServicePolicyData`	`securityServicePolicyData()` Details about the security service that is being used to protect the resources.
`static Class<? extends Policy.Builder>`	`serializableBuilderClass()`
`Policy.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - policyId
```
public String policyId()
```
    The ID of the AWS Firewall Manager policy.
    
    Returns:
    
    The ID of the AWS Firewall Manager policy.
  - policyName
```
public String policyName()
```
    The friendly name of the AWS Firewall Manager policy.
    
    Returns:
    
    The friendly name of the AWS Firewall Manager policy.
  - policyUpdateToken
```
public 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.
    
    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.
  - securityServicePolicyData
```
public SecurityServicePolicyData securityServicePolicyData()
```
    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.
  - resourceType
```
public String resourceType()
```
    The type of resource to protect with the policy, either an Application Load Balancer or a CloudFront distribution. This is in the format shown in AWS Resource Types Reference. Valid values are AWS::ElasticLoadBalancingV2::LoadBalancer or AWS::CloudFront::Distribution.
    
    Returns:
    
    The type of resource to protect with the policy, either an Application Load Balancer or a CloudFront distribution. This is in the format shown in AWS Resource Types Reference. Valid values are AWS::ElasticLoadBalancingV2::LoadBalancer or AWS::CloudFront::Distribution.
  - resourceTags
```
public List<ResourceTag> resourceTags()
```
    An array of ResourceTag objects.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    An array of ResourceTag objects.
  - excludeResourceTags
```
public 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.
    
    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.
  - remediationEnabled
```
public Boolean remediationEnabled()
```
    Indicates if the policy should be automatically applied to new resources.
    
    Returns:
    
    Indicates if the policy should be automatically applied to new resources.
  - includeMap
```
public Map<CustomerPolicyScopeIdType,List<String>> includeMap()
```
    Specifies the AWS account IDs to include in the policy. If IncludeMap is null, all accounts in the AWS Organization are included in the policy. If IncludeMap is not null, only values listed in IncludeMap will be included in the policy.
    
    The key to the map is ACCOUNT. For example, a valid IncludeMap would be {“ACCOUNT” : [“accountID1”, “accountID2”]}.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Specifies the AWS account IDs to include in the policy. If IncludeMap is null, all accounts in the AWS Organization are included in the policy. If IncludeMap is not null, only values listed in IncludeMap will be included in the policy.
    
    The key to the map is ACCOUNT. For example, a valid IncludeMap would be {“ACCOUNT” : [“accountID1”, “accountID2”]}.
  - includeMapAsStrings
```
public Map<String,List<String>> includeMapAsStrings()
```
    Specifies the AWS account IDs to include in the policy. If IncludeMap is null, all accounts in the AWS Organization are included in the policy. If IncludeMap is not null, only values listed in IncludeMap will be included in the policy.
    
    The key to the map is ACCOUNT. For example, a valid IncludeMap would be {“ACCOUNT” : [“accountID1”, “accountID2”]}.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Specifies the AWS account IDs to include in the policy. If IncludeMap is null, all accounts in the AWS Organization are included in the policy. If IncludeMap is not null, only values listed in IncludeMap will be included in the policy.
    
    The key to the map is ACCOUNT. For example, a valid IncludeMap would be {“ACCOUNT” : [“accountID1”, “accountID2”]}.
  - excludeMap
```
public Map<CustomerPolicyScopeIdType,List<String>> excludeMap()
```
    Specifies the AWS account IDs to exclude from the policy. The IncludeMap values are evaluated first, with all of 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”]}.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Specifies the AWS account IDs to exclude from the policy. The IncludeMap values are evaluated first, with all of 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”]}.
  - excludeMapAsStrings
```
public Map<String,List<String>> excludeMapAsStrings()
```
    Specifies the AWS account IDs to exclude from the policy. The IncludeMap values are evaluated first, with all of 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”]}.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Specifies the AWS account IDs to exclude from the policy. The IncludeMap values are evaluated first, with all of 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”]}.
  - toBuilder
```
public Policy.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Policy.Builder,Policy>
    
    Returns:
    
    a builder for type T
  - builder
```
public static Policy.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Policy.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class Policy

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

policyId

policyName

policyUpdateToken

securityServicePolicyData

resourceType

resourceTags

excludeResourceTags

remediationEnabled

includeMap

includeMapAsStrings

excludeMap

excludeMapAsStrings

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields