Class DeletePolicyRequest

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DeletePolicyRequest.Builder,DeletePolicyRequest>

@Generated("software.amazon.awssdk:codegen") public final class DeletePolicyRequest extends FmsRequest implements ToCopyableBuilder<DeletePolicyRequest.Builder,DeletePolicyRequest>
  • Method Details

    • policyId

      public final String policyId()

      The ID of the policy that you want to delete. You can retrieve this ID from PutPolicy and ListPolicies.

      Returns:
      The ID of the policy that you want to delete. You can retrieve this ID from PutPolicy and ListPolicies.
    • deleteAllPolicyResources

      public final Boolean deleteAllPolicyResources()

      If True, the request performs cleanup according to the policy type.

      For WAF and Shield Advanced policies, the cleanup does the following:

      • Deletes rule groups created by Firewall Manager

      • Removes web ACLs from in-scope resources

      • Deletes web ACLs that contain no rules or rule groups

      For security group policies, the cleanup does the following for each security group in the policy:

      • Disassociates the security group from in-scope resources

      • Deletes the security group if it was created through Firewall Manager and if it's no longer associated with any resources through another policy

      For security group common policies, even if set to False, Firewall Manager deletes all security groups created by Firewall Manager that aren't associated with any other resources through another policy.

      After the cleanup, in-scope resources are no longer protected by web ACLs in this policy. Protection of out-of-scope resources remains unchanged. Scope is determined by tags that you create and accounts that you associate with the policy. When creating the policy, if you specify that only resources in specific accounts or with specific tags are in scope of the policy, those accounts and resources are handled by the policy. All others are out of scope. If you don't specify tags or accounts, all resources are in scope.

      Returns:
      If True, the request performs cleanup according to the policy type.

      For WAF and Shield Advanced policies, the cleanup does the following:

      • Deletes rule groups created by Firewall Manager

      • Removes web ACLs from in-scope resources

      • Deletes web ACLs that contain no rules or rule groups

      For security group policies, the cleanup does the following for each security group in the policy:

      • Disassociates the security group from in-scope resources

      • Deletes the security group if it was created through Firewall Manager and if it's no longer associated with any resources through another policy

      For security group common policies, even if set to False, Firewall Manager deletes all security groups created by Firewall Manager that aren't associated with any other resources through another policy.

      After the cleanup, in-scope resources are no longer protected by web ACLs in this policy. Protection of out-of-scope resources remains unchanged. Scope is determined by tags that you create and accounts that you associate with the policy. When creating the policy, if you specify that only resources in specific accounts or with specific tags are in scope of the policy, those accounts and resources are handled by the policy. All others are out of scope. If you don't specify tags or accounts, all resources are in scope.

    • toBuilder

      public DeletePolicyRequest.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<DeletePolicyRequest.Builder,DeletePolicyRequest>
      Specified by:
      toBuilder in class FmsRequest
      Returns:
      a builder for type T
    • builder

      public static DeletePolicyRequest.Builder builder()
    • serializableBuilderClass

      public static Class<? extends DeletePolicyRequest.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest
    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value
    • 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.