@aws-sdk/client-wafv2

DeleteIPSetCommandInput Interface

The input for DeleteIPSetCommand.

Members

Name
Type
Details
Id Requiredstring | undefined

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

LockToken Requiredstring | undefined

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

Name Requiredstring | undefined

The name of the IP set. You cannot change the name of an IPSet after you create it.

Scope RequiredScope | undefined

Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use CLOUDFRONT.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

  • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

  • API and SDKs - For all calls, use the Region endpoint us-east-1.

Full Signature

export interface DeleteIPSetCommandInput extends DeleteIPSetRequest