Package software.amazon.awssdk.services.fms.model

Class PolicySummary

java.lang.Object
software.amazon.awssdk.services.fms.model.PolicySummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<PolicySummary.Builder,PolicySummary>
@Generated("software.amazon.awssdk:codegen") public final class PolicySummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PolicySummary.Builder,PolicySummary>

Details of the Firewall Manager policy.

See Also:

  • Method Details

    • policyArn

      public final String policyArn()

      The Amazon Resource Name (ARN) of the specified policy.

      Returns:
      The Amazon Resource Name (ARN) of the specified policy.

    • policyId

      public final String policyId()

      The ID of the specified policy.

      Returns:
      The ID of the specified policy.

    • policyName

      public final String policyName()

      The name of the specified policy.

      Returns:
      The name of the specified policy.

    • resourceType

      public final 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. For 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 Network Firewall policy or DNS 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 Amazon Web Services Resource Types Reference. For 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 Network Firewall policy or DNS Firewall policy, the value is AWS::EC2::VPC.

    • securityServiceType

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, securityServiceType will return SecurityServiceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from securityServiceTypeAsString().

      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:

    • securityServiceTypeAsString

      public final String securityServiceTypeAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, securityServiceType will return SecurityServiceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from securityServiceTypeAsString().

      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:

    • remediationEnabled

      public final 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.

    • deleteUnusedFMManagedResources

      public final 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.

      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.

    • policyStatus

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, policyStatus will return CustomerPolicyStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from policyStatusAsString().

      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:

    • policyStatusAsString

      public final String policyStatusAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, policyStatus will return CustomerPolicyStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from policyStatusAsString().

      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:

    • toBuilder

      public PolicySummary.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<PolicySummary.Builder,PolicySummary>
      Returns:
      a builder for type T

    • builder

      public static PolicySummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PolicySummary.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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 final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final 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.