Policy (AWS Java SDK :: Services

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)`
`boolean`	`equalsBySdkFields(Object obj)`
`Map<CustomerPolicyScopeIdType,List<String>>`	`excludeMap()` Specifies the AWS account IDs and AWS Organizations organizational units (OUs) to exclude from the policy.
`Map<String,List<String>>`	`excludeMapAsStrings()` Specifies the AWS account IDs and AWS Organizations organizational units (OUs) to exclude from the policy.
`Boolean`	`excludeResourceTags()` If set to `True`, resources with the tags that are specified in the `ResourceTag` array are not in scope of the policy.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasExcludeMap()` Returns true if the ExcludeMap property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasIncludeMap()` Returns true if the IncludeMap property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasResourceTags()` Returns true if the ResourceTags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasResourceTypeList()` Returns true if the ResourceTypeList property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`Map<CustomerPolicyScopeIdType,List<String>>`	`includeMap()` Specifies the AWS account IDs and AWS Organizations organizational units (OUs) to include in the policy.
`Map<String,List<String>>`	`includeMapAsStrings()` Specifies the AWS account IDs and AWS Organizations organizational units (OUs) to include in the policy.
`String`	`policyId()` The ID of the AWS Firewall Manager policy.
`String`	`policyName()` The 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 protected by or in scope of the policy.
`List<String>`	`resourceTypeList()` An array of `ResourceType`.
`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()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, 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 name of the AWS Firewall Manager policy.
    
    Returns:
    
    The 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 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:
    
    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.
  - hasResourceTypeList
```
public boolean hasResourceTypeList()
```
    Returns true if the ResourceTypeList property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - resourceTypeList
```
public List<String> resourceTypeList()
```
    An array of ResourceType.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasResourceTypeList() to see if a value was sent in this field.
    
    Returns:
    
    An array of ResourceType.
  - hasResourceTags
```
public boolean hasResourceTags()
```
    Returns true if the ResourceTags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - resourceTags
```
public List<ResourceTag> resourceTags()
```
    An array of ResourceTag objects.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasResourceTags() to see if a value was sent in this field.
    
    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 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:
    
    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.
  - 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 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”]}.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasIncludeMap() to see if a value was sent in this field.
    Returns:
    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”]} .
  - hasIncludeMap
```
public boolean hasIncludeMap()
```
    Returns true if the IncludeMap property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - includeMapAsStrings
```
public Map<String,List<String>> includeMapAsStrings()
```
    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”]}.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasIncludeMap() to see if a value was sent in this field.
    Returns:
    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”]} .
  - excludeMap
```
public Map<CustomerPolicyScopeIdType,List<String>> excludeMap()
```
    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”]}.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasExcludeMap() to see if a value was sent in this field.
    Returns:
    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”]} .
  - hasExcludeMap
```
public boolean hasExcludeMap()
```
    Returns true if the ExcludeMap property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - excludeMapAsStrings
```
public Map<String,List<String>> excludeMapAsStrings()
```
    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”]}.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasExcludeMap() to see if a value was sent in this field.
    Returns:
    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”]} .
  - toBuilder
```
public Policy.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Policy.Builder,Policy>
  - 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
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

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

hasResourceTypeList

resourceTypeList

hasResourceTags

resourceTags

excludeResourceTags

remediationEnabled

includeMap

hasIncludeMap

includeMapAsStrings

excludeMap

hasExcludeMap

excludeMapAsStrings

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields