wafv2/aws.sdk.kotlin.services.wafv2

Package-level declarations

Types

This is the latest version of the WAF API, released in November, 2019. The names of the entities that you use to access this API, like endpoints and namespaces, all have the versioning information added, like "V2" or "v2", to distinguish from the prior version. We recommend migrating your resources to this version, because it has a number of significant improvements.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Functions

associateWebAcl

inline suspend fun Wafv2Client.associateWebAcl(crossinline block: AssociateWebAclRequest.Builder.() -> Unit): AssociateWebAclResponse

Associates a web ACL with a regional application resource, to protect the resource. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

checkCapacity

inline suspend fun Wafv2Client.checkCapacity(crossinline block: CheckCapacityRequest.Builder.() -> Unit): CheckCapacityResponse

Returns the web ACL capacity unit (WCU) requirements for a specified scope and set of rules. You can use this to check the capacity requirements for the rules you want to use in a RuleGroup or WebACL.

createApiKey

inline suspend fun Wafv2Client.createApiKey(crossinline block: CreateApiKeyRequest.Builder.() -> Unit): CreateApiKeyResponse

Creates an API key that contains a set of token domains.

createIpSet

inline suspend fun Wafv2Client.createIpSet(crossinline block: CreateIpSetRequest.Builder.() -> Unit): CreateIpSetResponse

Creates an IPSet, which you use to identify web requests that originate from specific IP addresses or ranges of IP addresses. For example, if you're receiving a lot of requests from a ranges of IP addresses, you can configure WAF to block them using an IPSet that lists those IP addresses.

createRegexPatternSet

inline suspend fun Wafv2Client.createRegexPatternSet(crossinline block: CreateRegexPatternSetRequest.Builder.() -> Unit): CreateRegexPatternSetResponse

Creates a RegexPatternSet, which you reference in a RegexPatternSetReferenceStatement, to have WAF inspect a web request component for the specified patterns.

createRuleGroup

inline suspend fun Wafv2Client.createRuleGroup(crossinline block: CreateRuleGroupRequest.Builder.() -> Unit): CreateRuleGroupResponse

Creates a RuleGroup per the specifications provided.

createWebAcl

inline suspend fun Wafv2Client.createWebAcl(crossinline block: CreateWebAclRequest.Builder.() -> Unit): CreateWebAclResponse

Creates a WebACL per the specifications provided.

deleteApiKey

inline suspend fun Wafv2Client.deleteApiKey(crossinline block: DeleteApiKeyRequest.Builder.() -> Unit): DeleteApiKeyResponse

Deletes the specified API key.

deleteFirewallManagerRuleGroups

inline suspend fun Wafv2Client.deleteFirewallManagerRuleGroups(crossinline block: DeleteFirewallManagerRuleGroupsRequest.Builder.() -> Unit): DeleteFirewallManagerRuleGroupsResponse

Deletes all rule groups that are managed by Firewall Manager for the specified web ACL.

deleteIpSet

inline suspend fun Wafv2Client.deleteIpSet(crossinline block: DeleteIpSetRequest.Builder.() -> Unit): DeleteIpSetResponse

Deletes the specified IPSet.

deleteLoggingConfiguration

inline suspend fun Wafv2Client.deleteLoggingConfiguration(crossinline block: DeleteLoggingConfigurationRequest.Builder.() -> Unit): DeleteLoggingConfigurationResponse

Deletes the LoggingConfiguration from the specified web ACL.

deletePermissionPolicy

inline suspend fun Wafv2Client.deletePermissionPolicy(crossinline block: DeletePermissionPolicyRequest.Builder.() -> Unit): DeletePermissionPolicyResponse

Permanently deletes an IAM policy from the specified rule group.

deleteRegexPatternSet

inline suspend fun Wafv2Client.deleteRegexPatternSet(crossinline block: DeleteRegexPatternSetRequest.Builder.() -> Unit): DeleteRegexPatternSetResponse

Deletes the specified RegexPatternSet.

deleteRuleGroup

inline suspend fun Wafv2Client.deleteRuleGroup(crossinline block: DeleteRuleGroupRequest.Builder.() -> Unit): DeleteRuleGroupResponse

Deletes the specified RuleGroup.

deleteWebAcl

inline suspend fun Wafv2Client.deleteWebAcl(crossinline block: DeleteWebAclRequest.Builder.() -> Unit): DeleteWebAclResponse

Deletes the specified WebACL.

describeAllManagedProducts

inline suspend fun Wafv2Client.describeAllManagedProducts(crossinline block: DescribeAllManagedProductsRequest.Builder.() -> Unit): DescribeAllManagedProductsResponse

Provides high-level information for the Amazon Web Services Managed Rules rule groups and Amazon Web Services Marketplace managed rule groups.

describeManagedProductsByVendor

inline suspend fun Wafv2Client.describeManagedProductsByVendor(crossinline block: DescribeManagedProductsByVendorRequest.Builder.() -> Unit): DescribeManagedProductsByVendorResponse

Provides high-level information for the managed rule groups owned by a specific vendor.

describeManagedRuleGroup

inline suspend fun Wafv2Client.describeManagedRuleGroup(crossinline block: DescribeManagedRuleGroupRequest.Builder.() -> Unit): DescribeManagedRuleGroupResponse

Provides high-level information for a managed rule group, including descriptions of the rules.

disassociateWebAcl

inline suspend fun Wafv2Client.disassociateWebAcl(crossinline block: DisassociateWebAclRequest.Builder.() -> Unit): DisassociateWebAclResponse

Disassociates the specified regional application resource from any existing web ACL association. A resource can have at most one web ACL association. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

generateMobileSdkReleaseUrl

inline suspend fun Wafv2Client.generateMobileSdkReleaseUrl(crossinline block: GenerateMobileSdkReleaseUrlRequest.Builder.() -> Unit): GenerateMobileSdkReleaseUrlResponse

Generates a presigned download URL for the specified release of the mobile SDK.

getDecryptedApiKey

inline suspend fun Wafv2Client.getDecryptedApiKey(crossinline block: GetDecryptedApiKeyRequest.Builder.() -> Unit): GetDecryptedApiKeyResponse

Returns your API key in decrypted form. Use this to check the token domains that you have defined for the key.

getIpSet

inline suspend fun Wafv2Client.getIpSet(crossinline block: GetIpSetRequest.Builder.() -> Unit): GetIpSetResponse

Retrieves the specified IPSet.

getLoggingConfiguration

inline suspend fun Wafv2Client.getLoggingConfiguration(crossinline block: GetLoggingConfigurationRequest.Builder.() -> Unit): GetLoggingConfigurationResponse

Returns the LoggingConfiguration for the specified web ACL.

getManagedRuleSet

inline suspend fun Wafv2Client.getManagedRuleSet(crossinline block: GetManagedRuleSetRequest.Builder.() -> Unit): GetManagedRuleSetResponse

Retrieves the specified managed rule set.

getMobileSdkRelease

inline suspend fun Wafv2Client.getMobileSdkRelease(crossinline block: GetMobileSdkReleaseRequest.Builder.() -> Unit): GetMobileSdkReleaseResponse

Retrieves information for the specified mobile SDK release, including release notes and tags.

getPermissionPolicy

inline suspend fun Wafv2Client.getPermissionPolicy(crossinline block: GetPermissionPolicyRequest.Builder.() -> Unit): GetPermissionPolicyResponse

Returns the IAM policy that is attached to the specified rule group.

getRateBasedStatementManagedKeys

inline suspend fun Wafv2Client.getRateBasedStatementManagedKeys(crossinline block: GetRateBasedStatementManagedKeysRequest.Builder.() -> Unit): GetRateBasedStatementManagedKeysResponse

Retrieves the IP addresses that are currently blocked by a rate-based rule instance. This is only available for rate-based rules that aggregate solely on the IP address or on the forwarded IP address.

getRegexPatternSet

inline suspend fun Wafv2Client.getRegexPatternSet(crossinline block: GetRegexPatternSetRequest.Builder.() -> Unit): GetRegexPatternSetResponse

Retrieves the specified RegexPatternSet.

getRuleGroup

inline suspend fun Wafv2Client.getRuleGroup(crossinline block: GetRuleGroupRequest.Builder.() -> Unit): GetRuleGroupResponse

Retrieves the specified RuleGroup.

getSampledRequests

inline suspend fun Wafv2Client.getSampledRequests(crossinline block: GetSampledRequestsRequest.Builder.() -> Unit): GetSampledRequestsResponse

Gets detailed information about a specified number of requests--a sample--that WAF randomly selects from among the first 5,000 requests that your Amazon Web Services resource received during a time range that you choose. You can specify a sample size of up to 500 requests, and you can specify any time range in the previous three hours.

getWebAcl

inline suspend fun Wafv2Client.getWebAcl(crossinline block: GetWebAclRequest.Builder.() -> Unit): GetWebAclResponse

Retrieves the specified WebACL.

getWebAclForResource

inline suspend fun Wafv2Client.getWebAclForResource(crossinline block: GetWebAclForResourceRequest.Builder.() -> Unit): GetWebAclForResourceResponse

Retrieves the WebACL for the specified resource.

listApiKeys

inline suspend fun Wafv2Client.listApiKeys(crossinline block: ListApiKeysRequest.Builder.() -> Unit): ListApiKeysResponse

Retrieves a list of the API keys that you've defined for the specified scope.

listAvailableManagedRuleGroups

inline suspend fun Wafv2Client.listAvailableManagedRuleGroups(crossinline block: ListAvailableManagedRuleGroupsRequest.Builder.() -> Unit): ListAvailableManagedRuleGroupsResponse

Retrieves an array of managed rule groups that are available for you to use. This list includes all Amazon Web Services Managed Rules rule groups and all of the Amazon Web Services Marketplace managed rule groups that you're subscribed to.

listAvailableManagedRuleGroupVersions

inline suspend fun Wafv2Client.listAvailableManagedRuleGroupVersions(crossinline block: ListAvailableManagedRuleGroupVersionsRequest.Builder.() -> Unit): ListAvailableManagedRuleGroupVersionsResponse

Returns a list of the available versions for the specified managed rule group.

listIpSets

inline suspend fun Wafv2Client.listIpSets(crossinline block: ListIpSetsRequest.Builder.() -> Unit): ListIpSetsResponse

Retrieves an array of IPSetSummary objects for the IP sets that you manage.

listLoggingConfigurations

inline suspend fun Wafv2Client.listLoggingConfigurations(crossinline block: ListLoggingConfigurationsRequest.Builder.() -> Unit): ListLoggingConfigurationsResponse

Retrieves an array of your LoggingConfiguration objects.

listManagedRuleSets

inline suspend fun Wafv2Client.listManagedRuleSets(crossinline block: ListManagedRuleSetsRequest.Builder.() -> Unit): ListManagedRuleSetsResponse

Retrieves the managed rule sets that you own.

listMobileSdkReleases

inline suspend fun Wafv2Client.listMobileSdkReleases(crossinline block: ListMobileSdkReleasesRequest.Builder.() -> Unit): ListMobileSdkReleasesResponse

Retrieves a list of the available releases for the mobile SDK and the specified device platform.

listRegexPatternSets

inline suspend fun Wafv2Client.listRegexPatternSets(crossinline block: ListRegexPatternSetsRequest.Builder.() -> Unit): ListRegexPatternSetsResponse

Retrieves an array of RegexPatternSetSummary objects for the regex pattern sets that you manage.

listResourcesForWebAcl

inline suspend fun Wafv2Client.listResourcesForWebAcl(crossinline block: ListResourcesForWebAclRequest.Builder.() -> Unit): ListResourcesForWebAclResponse

Retrieves an array of the Amazon Resource Names (ARNs) for the regional resources that are associated with the specified web ACL.

listRuleGroups

inline suspend fun Wafv2Client.listRuleGroups(crossinline block: ListRuleGroupsRequest.Builder.() -> Unit): ListRuleGroupsResponse

Retrieves an array of RuleGroupSummary objects for the rule groups that you manage.

listTagsForResource

inline suspend fun Wafv2Client.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Retrieves the TagInfoForResource for the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.

listWebAcls

inline suspend fun Wafv2Client.listWebAcls(crossinline block: ListWebAclsRequest.Builder.() -> Unit): ListWebAclsResponse

Retrieves an array of WebACLSummary objects for the web ACLs that you manage.

putLoggingConfiguration

inline suspend fun Wafv2Client.putLoggingConfiguration(crossinline block: PutLoggingConfigurationRequest.Builder.() -> Unit): PutLoggingConfigurationResponse

Enables the specified LoggingConfiguration, to start logging from a web ACL, according to the configuration provided.

putManagedRuleSetVersions

inline suspend fun Wafv2Client.putManagedRuleSetVersions(crossinline block: PutManagedRuleSetVersionsRequest.Builder.() -> Unit): PutManagedRuleSetVersionsResponse

Defines the versions of your managed rule set that you are offering to the customers. Customers see your offerings as managed rule groups with versioning.

putPermissionPolicy

inline suspend fun Wafv2Client.putPermissionPolicy(crossinline block: PutPermissionPolicyRequest.Builder.() -> Unit): PutPermissionPolicyResponse

Attaches an IAM policy to the specified resource. Use this to share a rule group across accounts.

tagResource

inline suspend fun Wafv2Client.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Associates tags with the specified Amazon Web Services resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.

untagResource

inline suspend fun Wafv2Client.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Disassociates tags from an Amazon Web Services resource. Tags are key:value pairs that you can associate with Amazon Web Services resources. For example, the tag key might be "customer" and the tag value might be "companyA." You can specify one or more tags to add to each container. You can add up to 50 tags to each Amazon Web Services resource.

updateIpSet

inline suspend fun Wafv2Client.updateIpSet(crossinline block: UpdateIpSetRequest.Builder.() -> Unit): UpdateIpSetResponse

Updates the specified IPSet.

updateManagedRuleSetVersionExpiryDate

inline suspend fun Wafv2Client.updateManagedRuleSetVersionExpiryDate(crossinline block: UpdateManagedRuleSetVersionExpiryDateRequest.Builder.() -> Unit): UpdateManagedRuleSetVersionExpiryDateResponse

Updates the expiration information for your managed rule set. Use this to initiate the expiration of a managed rule group version. After you initiate expiration for a version, WAF excludes it from the response to ListAvailableManagedRuleGroupVersions for the managed rule group.

updateRegexPatternSet

inline suspend fun Wafv2Client.updateRegexPatternSet(crossinline block: UpdateRegexPatternSetRequest.Builder.() -> Unit): UpdateRegexPatternSetResponse

Updates the specified RegexPatternSet.

updateRuleGroup

inline suspend fun Wafv2Client.updateRuleGroup(crossinline block: UpdateRuleGroupRequest.Builder.() -> Unit): UpdateRuleGroupResponse

Updates the specified RuleGroup.

updateWebAcl

inline suspend fun Wafv2Client.updateWebAcl(crossinline block: UpdateWebAclRequest.Builder.() -> Unit): UpdateWebAclResponse

Updates the specified WebACL. While updating a web ACL, WAF provides continuous coverage to the resources that you have associated with the web ACL.

withConfig

fun Wafv2Client.withConfig(block: Wafv2Client.Config.Builder.() -> Unit): Wafv2Client

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.