com.amazonaws.services.fms.model

Class DeletePolicyRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.fms.model.DeletePolicyRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DeletePolicyRequest()

Method Summary

Modifier and Type	Method and Description
DeletePolicyRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Boolean	getDeleteAllPolicyResources() If True, the request performs cleanup according to the policy type.
String	getPolicyId() The ID of the policy that you want to delete.
int	hashCode()
Boolean	isDeleteAllPolicyResources() If True, the request performs cleanup according to the policy type.
void	setDeleteAllPolicyResources(Boolean deleteAllPolicyResources) If True, the request performs cleanup according to the policy type.
void	setPolicyId(String policyId) The ID of the policy that you want to delete.
String	toString() Returns a string representation of this object.
DeletePolicyRequest	withDeleteAllPolicyResources(Boolean deleteAllPolicyResources) If True, the request performs cleanup according to the policy type.
DeletePolicyRequest	withPolicyId(String policyId) The ID of the policy that you want to delete.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DeletePolicyRequest

public DeletePolicyRequest()

Method Detail

setPolicyId

public void setPolicyId(String policyId)

The ID of the policy that you want to delete. PolicyId is returned by PutPolicy and by ListPolicies.

Parameters:

policyId - The ID of the policy that you want to delete. PolicyId is returned by PutPolicy and by ListPolicies.

getPolicyId

public String getPolicyId()

The ID of the policy that you want to delete. PolicyId is returned by PutPolicy and by ListPolicies.

Returns:

The ID of the policy that you want to delete. PolicyId is returned by PutPolicy and by ListPolicies.

withPolicyId

public DeletePolicyRequest withPolicyId(String policyId)

The ID of the policy that you want to delete. PolicyId is returned by PutPolicy and by ListPolicies.

Parameters:

policyId - The ID of the policy that you want to delete. PolicyId is returned by PutPolicy and by ListPolicies.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDeleteAllPolicyResources

public void setDeleteAllPolicyResources(Boolean deleteAllPolicyResources)

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

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

• Deletes rule groups created by AWS 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.

Parameters:

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

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

• Deletes rule groups created by AWS 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.

getDeleteAllPolicyResources

public Boolean getDeleteAllPolicyResources()

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

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

• Deletes rule groups created by AWS 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 AWS WAF and Shield Advanced policies, the cleanup does the following:

• Deletes rule groups created by AWS 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.

withDeleteAllPolicyResources

public DeletePolicyRequest withDeleteAllPolicyResources(Boolean deleteAllPolicyResources)

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

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

• Deletes rule groups created by AWS 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.

Parameters:

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

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

• Deletes rule groups created by AWS 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:

Returns a reference to this object so that method calls can be chained together.

isDeleteAllPolicyResources

public Boolean isDeleteAllPolicyResources()

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

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

• Deletes rule groups created by AWS 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 AWS WAF and Shield Advanced policies, the cleanup does the following:

• Deletes rule groups created by AWS 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.

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

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()