Interface DeletePolicyRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<DeletePolicyRequest.Builder,DeletePolicyRequest>, FmsRequest.Builder, SdkBuilder<DeletePolicyRequest.Builder,DeletePolicyRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
DeletePolicyRequest
@Mutable @NotThreadSafe public static interface DeletePolicyRequest.Builder extends FmsRequest.Builder, SdkPojo, CopyableBuilder<DeletePolicyRequest.Builder,DeletePolicyRequest>

  • Method Details

    • policyId

      DeletePolicyRequest.Builder policyId(String policyId)

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

      Parameters:
      policyId - The ID of the policy that you want to delete. You can retrieve this ID from PutPolicy and ListPolicies.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deleteAllPolicyResources

      DeletePolicyRequest.Builder deleteAllPolicyResources(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      DeletePolicyRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      DeletePolicyRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.