akamai.AppSecAttackGroup
Scopes: Attack group
Modify an attack group’s action, conditions, and exceptions. Attack groups are collections of Kona Rule Set rules used to streamline the management of website protections.
Related API Endpoints: /appsec/v1/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/attack-groups/{attackGroupId} and /appsec/v1/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/attack-groups/{attackGroupId}/condition-exception
Example Usage
Basic usage
using System.Collections.Generic;
using System.IO;
using Pulumi;
using Akamai = Pulumi.Akamai;
return await Deployment.RunAsync(() =>
{
var configuration = Akamai.GetAppSecConfiguration.Invoke(new()
{
Name = "Documentation",
});
var attackGroup = new Akamai.AppSecAttackGroup("attackGroup", new()
{
ConfigId = configuration.Apply(getAppSecConfigurationResult => getAppSecConfigurationResult.ConfigId),
SecurityPolicyId = "gms1_134637",
AttackGroup = "SQL",
AttackGroupAction = "deny",
ConditionException = File.ReadAllText($"{path.Module}/condition_exception.json"),
});
});
package main
import (
"fmt"
"os"
"github.com/pulumi/pulumi-akamai/sdk/v4/go/akamai"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func readFileOrPanic(path string) pulumi.StringPtrInput {
data, err := os.ReadFile(path)
if err != nil {
panic(err.Error())
}
return pulumi.String(string(data))
}
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
configuration, err := akamai.LookupAppSecConfiguration(ctx, &akamai.LookupAppSecConfigurationArgs{
Name: pulumi.StringRef("Documentation"),
}, nil)
if err != nil {
return err
}
_, err = akamai.NewAppSecAttackGroup(ctx, "attackGroup", &akamai.AppSecAttackGroupArgs{
ConfigId: *pulumi.Int(configuration.ConfigId),
SecurityPolicyId: pulumi.String("gms1_134637"),
AttackGroup: pulumi.String("SQL"),
AttackGroupAction: pulumi.String("deny"),
ConditionException: readFileOrPanic(fmt.Sprintf("%v/condition_exception.json", path.Module)),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.akamai.AkamaiFunctions;
import com.pulumi.akamai.inputs.GetAppSecConfigurationArgs;
import com.pulumi.akamai.AppSecAttackGroup;
import com.pulumi.akamai.AppSecAttackGroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var configuration = AkamaiFunctions.getAppSecConfiguration(GetAppSecConfigurationArgs.builder()
.name("Documentation")
.build());
var attackGroup = new AppSecAttackGroup("attackGroup", AppSecAttackGroupArgs.builder()
.configId(configuration.applyValue(getAppSecConfigurationResult -> getAppSecConfigurationResult.configId()))
.securityPolicyId("gms1_134637")
.attackGroup("SQL")
.attackGroupAction("deny")
.conditionException(Files.readString(Paths.get(String.format("%s/condition_exception.json", path.module()))))
.build());
}
}
import pulumi
import pulumi_akamai as akamai
configuration = akamai.get_app_sec_configuration(name="Documentation")
attack_group = akamai.AppSecAttackGroup("attackGroup",
config_id=configuration.config_id,
security_policy_id="gms1_134637",
attack_group="SQL",
attack_group_action="deny",
condition_exception=(lambda path: open(path).read())(f"{path['module']}/condition_exception.json"))
import * as pulumi from "@pulumi/pulumi";
import * as akamai from "@pulumi/akamai";
import * as fs from "fs";
const configuration = akamai.getAppSecConfiguration({
name: "Documentation",
});
const attackGroup = new akamai.AppSecAttackGroup("attackGroup", {
configId: configuration.then(configuration => configuration.configId),
securityPolicyId: "gms1_134637",
attackGroup: "SQL",
attackGroupAction: "deny",
conditionException: fs.readFileSync(`${path.module}/condition_exception.json`),
});
resources:
attackGroup:
type: akamai:AppSecAttackGroup
properties:
configId: ${configuration.configId}
securityPolicyId: gms1_134637
attackGroup: SQL
attackGroupAction: deny
conditionException:
fn::readFile: ${path.module}/condition_exception.json
variables:
configuration:
fn::invoke:
Function: akamai:getAppSecConfiguration
Arguments:
name: Documentation
Create AppSecAttackGroup Resource
new AppSecAttackGroup(name: string, args: AppSecAttackGroupArgs, opts?: CustomResourceOptions);
@overload
def AppSecAttackGroup(resource_name: str,
opts: Optional[ResourceOptions] = None,
attack_group: Optional[str] = None,
attack_group_action: Optional[str] = None,
condition_exception: Optional[str] = None,
config_id: Optional[int] = None,
security_policy_id: Optional[str] = None)
@overload
def AppSecAttackGroup(resource_name: str,
args: AppSecAttackGroupArgs,
opts: Optional[ResourceOptions] = None)
func NewAppSecAttackGroup(ctx *Context, name string, args AppSecAttackGroupArgs, opts ...ResourceOption) (*AppSecAttackGroup, error)
public AppSecAttackGroup(string name, AppSecAttackGroupArgs args, CustomResourceOptions? opts = null)
public AppSecAttackGroup(String name, AppSecAttackGroupArgs args)
public AppSecAttackGroup(String name, AppSecAttackGroupArgs args, CustomResourceOptions options)
type: akamai:AppSecAttackGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AppSecAttackGroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args AppSecAttackGroupArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args AppSecAttackGroupArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AppSecAttackGroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AppSecAttackGroupArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
AppSecAttackGroup Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The AppSecAttackGroup resource accepts the following input properties:
- Attack
Group string . Unique name of the attack group being modified.
- Attack
Group stringAction . Action taken any time the attack group is triggered. Allowed values are:
- alert. Record information about the request.
- deny. Block the request,
- **deny_custom_{custom_deny_id}**. Take the action specified by the custom deny.
- none. Take no action.
- Config
Id int . Unique identifier of the security configuration associated with the attack group being modified.
- Security
Policy stringId . Unique identifier of the security policy associated with the attack group being modified.
- Condition
Exception string . Path to a JSON file containing the conditions and exceptions to be assigned to the attack group.
- Attack
Group string . Unique name of the attack group being modified.
- Attack
Group stringAction . Action taken any time the attack group is triggered. Allowed values are:
- alert. Record information about the request.
- deny. Block the request,
- **deny_custom_{custom_deny_id}**. Take the action specified by the custom deny.
- none. Take no action.
- Config
Id int . Unique identifier of the security configuration associated with the attack group being modified.
- Security
Policy stringId . Unique identifier of the security policy associated with the attack group being modified.
- Condition
Exception string . Path to a JSON file containing the conditions and exceptions to be assigned to the attack group.
- attack
Group String . Unique name of the attack group being modified.
- attack
Group StringAction . Action taken any time the attack group is triggered. Allowed values are:
- alert. Record information about the request.
- deny. Block the request,
- **deny_custom_{custom_deny_id}**. Take the action specified by the custom deny.
- none. Take no action.
- config
Id Integer . Unique identifier of the security configuration associated with the attack group being modified.
- security
Policy StringId . Unique identifier of the security policy associated with the attack group being modified.
- condition
Exception String . Path to a JSON file containing the conditions and exceptions to be assigned to the attack group.
- attack
Group string . Unique name of the attack group being modified.
- attack
Group stringAction . Action taken any time the attack group is triggered. Allowed values are:
- alert. Record information about the request.
- deny. Block the request,
- **deny_custom_{custom_deny_id}**. Take the action specified by the custom deny.
- none. Take no action.
- config
Id number . Unique identifier of the security configuration associated with the attack group being modified.
- security
Policy stringId . Unique identifier of the security policy associated with the attack group being modified.
- condition
Exception string . Path to a JSON file containing the conditions and exceptions to be assigned to the attack group.
- attack_
group str . Unique name of the attack group being modified.
- attack_
group_ straction . Action taken any time the attack group is triggered. Allowed values are:
- alert. Record information about the request.
- deny. Block the request,
- **deny_custom_{custom_deny_id}**. Take the action specified by the custom deny.
- none. Take no action.
- config_
id int . Unique identifier of the security configuration associated with the attack group being modified.
- security_
policy_ strid . Unique identifier of the security policy associated with the attack group being modified.
- condition_
exception str . Path to a JSON file containing the conditions and exceptions to be assigned to the attack group.
- attack
Group String . Unique name of the attack group being modified.
- attack
Group StringAction . Action taken any time the attack group is triggered. Allowed values are:
- alert. Record information about the request.
- deny. Block the request,
- **deny_custom_{custom_deny_id}**. Take the action specified by the custom deny.
- none. Take no action.
- config
Id Number . Unique identifier of the security configuration associated with the attack group being modified.
- security
Policy StringId . Unique identifier of the security policy associated with the attack group being modified.
- condition
Exception String . Path to a JSON file containing the conditions and exceptions to be assigned to the attack group.
Outputs
All input properties are implicitly available as output properties. Additionally, the AppSecAttackGroup resource produces the following output properties:
- Id string
The provider-assigned unique ID for this managed resource.
- Id string
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
- id string
The provider-assigned unique ID for this managed resource.
- id str
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
Look up Existing AppSecAttackGroup Resource
Get an existing AppSecAttackGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: AppSecAttackGroupState, opts?: CustomResourceOptions): AppSecAttackGroup
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
attack_group: Optional[str] = None,
attack_group_action: Optional[str] = None,
condition_exception: Optional[str] = None,
config_id: Optional[int] = None,
security_policy_id: Optional[str] = None) -> AppSecAttackGroup
func GetAppSecAttackGroup(ctx *Context, name string, id IDInput, state *AppSecAttackGroupState, opts ...ResourceOption) (*AppSecAttackGroup, error)
public static AppSecAttackGroup Get(string name, Input<string> id, AppSecAttackGroupState? state, CustomResourceOptions? opts = null)
public static AppSecAttackGroup get(String name, Output<String> id, AppSecAttackGroupState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Attack
Group string . Unique name of the attack group being modified.
- Attack
Group stringAction . Action taken any time the attack group is triggered. Allowed values are:
- alert. Record information about the request.
- deny. Block the request,
- **deny_custom_{custom_deny_id}**. Take the action specified by the custom deny.
- none. Take no action.
- Condition
Exception string . Path to a JSON file containing the conditions and exceptions to be assigned to the attack group.
- Config
Id int . Unique identifier of the security configuration associated with the attack group being modified.
- Security
Policy stringId . Unique identifier of the security policy associated with the attack group being modified.
- Attack
Group string . Unique name of the attack group being modified.
- Attack
Group stringAction . Action taken any time the attack group is triggered. Allowed values are:
- alert. Record information about the request.
- deny. Block the request,
- **deny_custom_{custom_deny_id}**. Take the action specified by the custom deny.
- none. Take no action.
- Condition
Exception string . Path to a JSON file containing the conditions and exceptions to be assigned to the attack group.
- Config
Id int . Unique identifier of the security configuration associated with the attack group being modified.
- Security
Policy stringId . Unique identifier of the security policy associated with the attack group being modified.
- attack
Group String . Unique name of the attack group being modified.
- attack
Group StringAction . Action taken any time the attack group is triggered. Allowed values are:
- alert. Record information about the request.
- deny. Block the request,
- **deny_custom_{custom_deny_id}**. Take the action specified by the custom deny.
- none. Take no action.
- condition
Exception String . Path to a JSON file containing the conditions and exceptions to be assigned to the attack group.
- config
Id Integer . Unique identifier of the security configuration associated with the attack group being modified.
- security
Policy StringId . Unique identifier of the security policy associated with the attack group being modified.
- attack
Group string . Unique name of the attack group being modified.
- attack
Group stringAction . Action taken any time the attack group is triggered. Allowed values are:
- alert. Record information about the request.
- deny. Block the request,
- **deny_custom_{custom_deny_id}**. Take the action specified by the custom deny.
- none. Take no action.
- condition
Exception string . Path to a JSON file containing the conditions and exceptions to be assigned to the attack group.
- config
Id number . Unique identifier of the security configuration associated with the attack group being modified.
- security
Policy stringId . Unique identifier of the security policy associated with the attack group being modified.
- attack_
group str . Unique name of the attack group being modified.
- attack_
group_ straction . Action taken any time the attack group is triggered. Allowed values are:
- alert. Record information about the request.
- deny. Block the request,
- **deny_custom_{custom_deny_id}**. Take the action specified by the custom deny.
- none. Take no action.
- condition_
exception str . Path to a JSON file containing the conditions and exceptions to be assigned to the attack group.
- config_
id int . Unique identifier of the security configuration associated with the attack group being modified.
- security_
policy_ strid . Unique identifier of the security policy associated with the attack group being modified.
- attack
Group String . Unique name of the attack group being modified.
- attack
Group StringAction . Action taken any time the attack group is triggered. Allowed values are:
- alert. Record information about the request.
- deny. Block the request,
- **deny_custom_{custom_deny_id}**. Take the action specified by the custom deny.
- none. Take no action.
- condition
Exception String . Path to a JSON file containing the conditions and exceptions to be assigned to the attack group.
- config
Id Number . Unique identifier of the security configuration associated with the attack group being modified.
- security
Policy StringId . Unique identifier of the security policy associated with the attack group being modified.
Package Details
- Repository
- Akamai pulumi/pulumi-akamai
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
akamai
Terraform Provider.