PolicySummary (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Details of the Firewall Manager policy.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

PolicySummary()

Constructors
Constructor and Description
`PolicySummary()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PolicySummary`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getDeleteUnusedFMManagedResources()` Indicates whether 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.
`String`	`getPolicyArn()` The Amazon Resource Name (ARN) of the specified policy.
`String`	`getPolicyId()` The ID of the specified policy.
`String`	`getPolicyName()` The name of the specified policy.
`String`	`getPolicyStatus()` Indicates whether the policy is in or out of an admin's policy or Region scope.
`Boolean`	`getRemediationEnabled()` Indicates if the policy should be automatically applied to new resources.
`String`	`getResourceType()` The type of resource protected by or in scope of the policy.
`String`	`getSecurityServiceType()` The service that the policy is using to protect the resources.
`int`	`hashCode()`
`Boolean`	`isDeleteUnusedFMManagedResources()` Indicates whether 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.
`Boolean`	`isRemediationEnabled()` Indicates if the policy should be automatically applied to new resources.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDeleteUnusedFMManagedResources(Boolean deleteUnusedFMManagedResources)` Indicates whether 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.
`void`	`setPolicyArn(String policyArn)` The Amazon Resource Name (ARN) of the specified policy.
`void`	`setPolicyId(String policyId)` The ID of the specified policy.
`void`	`setPolicyName(String policyName)` The name of the specified policy.
`void`	`setPolicyStatus(String policyStatus)` Indicates whether the policy is in or out of an admin's policy or Region scope.
`void`	`setRemediationEnabled(Boolean remediationEnabled)` Indicates if the policy should be automatically applied to new resources.
`void`	`setResourceType(String resourceType)` The type of resource protected by or in scope of the policy.
`void`	`setSecurityServiceType(String securityServiceType)` The service that the policy is using to protect the resources.
`String`	`toString()` Returns a string representation of this object.
`PolicySummary`	`withDeleteUnusedFMManagedResources(Boolean deleteUnusedFMManagedResources)` Indicates whether 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.
`PolicySummary`	`withPolicyArn(String policyArn)` The Amazon Resource Name (ARN) of the specified policy.
`PolicySummary`	`withPolicyId(String policyId)` The ID of the specified policy.
`PolicySummary`	`withPolicyName(String policyName)` The name of the specified policy.
`PolicySummary`	`withPolicyStatus(CustomerPolicyStatus policyStatus)` Indicates whether the policy is in or out of an admin's policy or Region scope.
`PolicySummary`	`withPolicyStatus(String policyStatus)` Indicates whether the policy is in or out of an admin's policy or Region scope.
`PolicySummary`	`withRemediationEnabled(Boolean remediationEnabled)` Indicates if the policy should be automatically applied to new resources.
`PolicySummary`	`withResourceType(String resourceType)` The type of resource protected by or in scope of the policy.
`PolicySummary`	`withSecurityServiceType(SecurityServiceType securityServiceType)` The service that the policy is using to protect the resources.
`PolicySummary`	`withSecurityServiceType(String securityServiceType)` The service that the policy is using to protect the resources.

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

- Constructor Detail
  - PolicySummary
```
public PolicySummary()
```
- Method Detail
  - setPolicyArn
```
public void setPolicyArn(String policyArn)
```
    The Amazon Resource Name (ARN) of the specified policy.
    
    Parameters:
    
    policyArn - The Amazon Resource Name (ARN) of the specified policy.
  - getPolicyArn
```
public String getPolicyArn()
```
    The Amazon Resource Name (ARN) of the specified policy.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the specified policy.
  - withPolicyArn
```
public PolicySummary withPolicyArn(String policyArn)
```
    The Amazon Resource Name (ARN) of the specified policy.
    
    Parameters:
    
    policyArn - The Amazon Resource Name (ARN) of the specified policy.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPolicyId
```
public void setPolicyId(String policyId)
```
    The ID of the specified policy.
    
    Parameters:
    
    policyId - The ID of the specified policy.
  - getPolicyId
```
public String getPolicyId()
```
    The ID of the specified policy.
    
    Returns:
    
    The ID of the specified policy.
  - withPolicyId
```
public PolicySummary withPolicyId(String policyId)
```
    The ID of the specified policy.
    
    Parameters:
    
    policyId - The ID of the specified policy.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPolicyName
```
public void setPolicyName(String policyName)
```
    The name of the specified policy.
    
    Parameters:
    
    policyName - The name of the specified policy.
  - getPolicyName
```
public String getPolicyName()
```
    The name of the specified policy.
    
    Returns:
    
    The name of the specified policy.
  - withPolicyName
```
public PolicySummary withPolicyName(String policyName)
```
    The name of the specified policy.
    
    Parameters:
    
    policyName - The name of the specified policy.
    
    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 protected by or in scope of the policy. This is in the format shown in the Amazon Web Services Resource Types Reference.
    
    Parameters:
    
    resourceType - The type of resource protected by or in scope of the policy. This is in the format shown in the Amazon Web Services Resource Types Reference.
  - getResourceType
```
public String getResourceType()
```
    The type of resource protected by or in scope of the policy. This is in the format shown in the Amazon Web Services Resource Types Reference.
    
    Returns:
    
    The type of resource protected by or in scope of the policy. This is in the format shown in the Amazon Web Services Resource Types Reference.
  - withResourceType
```
public PolicySummary withResourceType(String resourceType)
```
    The type of resource protected by or in scope of the policy. This is in the format shown in the Amazon Web Services Resource Types Reference.
    
    Parameters:
    
    resourceType - The type of resource protected by or in scope of the policy. This is in the format shown in the Amazon Web Services Resource Types Reference.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSecurityServiceType
```
public void setSecurityServiceType(String securityServiceType)
```
    The service that the policy is using to protect the resources. This specifies the type of policy that is created, either an WAF policy, a Shield Advanced policy, or a security group policy.
    
    Parameters:
    
    securityServiceType - The service that the policy is using to protect the resources. This specifies the type of policy that is created, either an WAF policy, a Shield Advanced policy, or a security group policy.
    
    See Also:
    
    SecurityServiceType
  - getSecurityServiceType
```
public String getSecurityServiceType()
```
    The service that the policy is using to protect the resources. This specifies the type of policy that is created, either an WAF policy, a Shield Advanced policy, or a security group policy.
    
    Returns:
    
    The service that the policy is using to protect the resources. This specifies the type of policy that is created, either an WAF policy, a Shield Advanced policy, or a security group policy.
    
    See Also:
    
    SecurityServiceType
  - withSecurityServiceType
```
public PolicySummary withSecurityServiceType(String securityServiceType)
```
    The service that the policy is using to protect the resources. This specifies the type of policy that is created, either an WAF policy, a Shield Advanced policy, or a security group policy.
    
    Parameters:
    
    securityServiceType - The service that the policy is using to protect the resources. This specifies the type of policy that is created, either an WAF policy, a Shield Advanced policy, or a security group policy.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SecurityServiceType
  - withSecurityServiceType
```
public PolicySummary withSecurityServiceType(SecurityServiceType securityServiceType)
```
    The service that the policy is using to protect the resources. This specifies the type of policy that is created, either an WAF policy, a Shield Advanced policy, or a security group policy.
    
    Parameters:
    
    securityServiceType - The service that the policy is using to protect the resources. This specifies the type of policy that is created, either an WAF policy, a Shield Advanced policy, or a security group policy.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SecurityServiceType
  - 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 PolicySummary 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.
  - setDeleteUnusedFMManagedResources
```
public void setDeleteUnusedFMManagedResources(Boolean deleteUnusedFMManagedResources)
```
    Indicates whether 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 WAF Classic policies.
    
    Parameters:
    
    deleteUnusedFMManagedResources - Indicates whether 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 WAF Classic policies.
  - getDeleteUnusedFMManagedResources
```
public Boolean getDeleteUnusedFMManagedResources()
```
    Indicates whether 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 WAF Classic policies.
    
    Returns:
    
    Indicates whether 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 WAF Classic policies.
  - withDeleteUnusedFMManagedResources
```
public PolicySummary withDeleteUnusedFMManagedResources(Boolean deleteUnusedFMManagedResources)
```
    Indicates whether 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 WAF Classic policies.
    
    Parameters:
    
    deleteUnusedFMManagedResources - Indicates whether 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 WAF Classic policies.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isDeleteUnusedFMManagedResources
```
public Boolean isDeleteUnusedFMManagedResources()
```
    Indicates whether 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 WAF Classic policies.
    
    Returns:
    
    Indicates whether 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 WAF Classic policies.
  - setPolicyStatus
```
public void setPolicyStatus(String policyStatus)
```
    Indicates whether the policy is in or out of an admin's policy or Region scope.
    - ACTIVE - The administrator can manage and delete the policy.
    - OUT_OF_ADMIN_SCOPE - The administrator can view the policy, but they can't edit or delete the policy. Existing policy protections stay in place. Any new resources that come into scope of the policy won't be protected.
    Parameters:
    policyStatus - Indicates whether the policy is in or out of an admin's policy or Region scope.
    
    ACTIVE - The administrator can manage and delete the policy.
    
    OUT_OF_ADMIN_SCOPE - The administrator can view the policy, but they can't edit or delete the policy. Existing policy protections stay in place. Any new resources that come into scope of the policy won't be protected.
    See Also:
    
    CustomerPolicyStatus
  - getPolicyStatus
```
public String getPolicyStatus()
```
    Indicates whether the policy is in or out of an admin's policy or Region scope.
    - ACTIVE - The administrator can manage and delete the policy.
    - OUT_OF_ADMIN_SCOPE - The administrator can view the policy, but they can't edit or delete the policy. Existing policy protections stay in place. Any new resources that come into scope of the policy won't be protected.
    Returns:
    Indicates whether the policy is in or out of an admin's policy or Region scope.
    
    ACTIVE - The administrator can manage and delete the policy.
    
    OUT_OF_ADMIN_SCOPE - The administrator can view the policy, but they can't edit or delete the policy. Existing policy protections stay in place. Any new resources that come into scope of the policy won't be protected.
    See Also:
    
    CustomerPolicyStatus
  - withPolicyStatus
```
public PolicySummary withPolicyStatus(String policyStatus)
```
    Indicates whether the policy is in or out of an admin's policy or Region scope.
    - ACTIVE - The administrator can manage and delete the policy.
    - OUT_OF_ADMIN_SCOPE - The administrator can view the policy, but they can't edit or delete the policy. Existing policy protections stay in place. Any new resources that come into scope of the policy won't be protected.
    Parameters:
    policyStatus - Indicates whether the policy is in or out of an admin's policy or Region scope.
    
    ACTIVE - The administrator can manage and delete the policy.
    
    OUT_OF_ADMIN_SCOPE - The administrator can view the policy, but they can't edit or delete the policy. Existing policy protections stay in place. Any new resources that come into scope of the policy won't be protected.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CustomerPolicyStatus
  - withPolicyStatus
```
public PolicySummary withPolicyStatus(CustomerPolicyStatus policyStatus)
```
    Indicates whether the policy is in or out of an admin's policy or Region scope.
    - ACTIVE - The administrator can manage and delete the policy.
    - OUT_OF_ADMIN_SCOPE - The administrator can view the policy, but they can't edit or delete the policy. Existing policy protections stay in place. Any new resources that come into scope of the policy won't be protected.
    Parameters:
    policyStatus - Indicates whether the policy is in or out of an admin's policy or Region scope.
    
    ACTIVE - The administrator can manage and delete the policy.
    
    OUT_OF_ADMIN_SCOPE - The administrator can view the policy, but they can't edit or delete the policy. Existing policy protections stay in place. Any new resources that come into scope of the policy won't be protected.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CustomerPolicyStatus
  - 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 PolicySummary clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.772

Class PolicySummary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PolicySummary

Method Detail

setPolicyArn

getPolicyArn

withPolicyArn

setPolicyId

getPolicyId

withPolicyId

setPolicyName

getPolicyName

withPolicyName

setResourceType

getResourceType

withResourceType

setSecurityServiceType

getSecurityServiceType

withSecurityServiceType

withSecurityServiceType

setRemediationEnabled

getRemediationEnabled

withRemediationEnabled

isRemediationEnabled

setDeleteUnusedFMManagedResources

getDeleteUnusedFMManagedResources

withDeleteUnusedFMManagedResources

isDeleteUnusedFMManagedResources

setPolicyStatus

getPolicyStatus

withPolicyStatus

withPolicyStatus

toString

equals

hashCode

clone

marshall