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

Class DeletePolicyRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.fms.model.FmsRequest

software.amazon.awssdk.services.fms.model.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>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DeletePolicyRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DeletePolicyRequest.Builder	builder()
Boolean	deleteAllPolicyResources()	If True, the request performs cleanup according to the policy type.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	policyId()	The ID of the policy that you want to delete.
List<SdkField<?>>	sdkFields()
static Class<? extends DeletePolicyRequest.Builder>	serializableBuilderClass()
DeletePolicyRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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 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

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

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()

Specified by:

toBuilder in interface ToCopyableBuilder<DeletePolicyRequest.Builder,DeletePolicyRequest>

Specified by:

toBuilder in class FmsRequest

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo