Pulumi Registry
← All packages

Akamai

v2.6.0 published on Thursday, Dec 30, 2021 by Pulumi
Source code
  1. Akamai
  2. AppSecEval

AppSecEval

Scopes: Security policy

Issues an evaluation mode command (Start, Stop, Restart, Update, or Complete) to a security configuration. Evaluation mode is used for testing and fine-tuning your Kona Rule Set rules and configuration settings. In evaluation mode rules are triggered by events, but the only thing those rules do is record the actions they would have taken had the event occurred on the production network.

Related API Endpoint: /appsec/v1/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/eval

Output Options

The following options can be used to determine the information returned, and how that returned information is formatted:

  • evaluation_ruleset. Versioning information for the Kona Rule Set being evaluated.
  • expiration_date. Date when the evaluation period ends.
  • current_ruleset. Versioning information for the Kona Rule Set currently in use on the production network.
  • eval_status. If true, an evaluation is currently in progress; if false, evaluation is either paused or is not running.

Example Usage

using Pulumi;
using Akamai = Pulumi.Akamai;

class MyStack : Stack
{
    public MyStack()
    {
        var configuration = Output.Create(Akamai.GetAppSecConfiguration.InvokeAsync(new Akamai.GetAppSecConfigurationArgs
        {
            Name = "Documentation",
        }));
        var evalOperation = new Akamai.AppSecEval("evalOperation", new Akamai.AppSecEvalArgs
        {
            ConfigId = configuration.Apply(configuration => configuration.ConfigId),
            SecurityPolicyId = "gms1_134637",
            EvalOperation = "START",
        });
        this.EvalModeEvaluatingRuleset = evalOperation.EvaluatingRuleset;
        this.EvalModeExpirationDate = evalOperation.ExpirationDate;
        this.EvalModeCurrentRuleset = evalOperation.CurrentRuleset;
        this.EvalModeStatus = evalOperation.EvalStatus;
    }

    [Output("evalModeEvaluatingRuleset")]
    public Output<string> EvalModeEvaluatingRuleset { get; set; }
    [Output("evalModeExpirationDate")]
    public Output<string> EvalModeExpirationDate { get; set; }
    [Output("evalModeCurrentRuleset")]
    public Output<string> EvalModeCurrentRuleset { get; set; }
    [Output("evalModeStatus")]
    public Output<string> EvalModeStatus { get; set; }
}

package main

import (
	"github.com/pulumi/pulumi-akamai/sdk/v2/go/akamai"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		opt0 := "Documentation"
		configuration, err := akamai.LookupAppSecConfiguration(ctx, &GetAppSecConfigurationArgs{
			Name: &opt0,
		}, nil)
		if err != nil {
			return err
		}
		evalOperation, err := akamai.NewAppSecEval(ctx, "evalOperation", &akamai.AppSecEvalArgs{
			ConfigId:         pulumi.Int(configuration.ConfigId),
			SecurityPolicyId: pulumi.String("gms1_134637"),
			EvalOperation:    pulumi.String("START"),
		})
		if err != nil {
			return err
		}
		ctx.Export("evalModeEvaluatingRuleset", evalOperation.EvaluatingRuleset)
		ctx.Export("evalModeExpirationDate", evalOperation.ExpirationDate)
		ctx.Export("evalModeCurrentRuleset", evalOperation.CurrentRuleset)
		ctx.Export("evalModeStatus", evalOperation.EvalStatus)
		return nil
	})
}

import pulumi
import pulumi_akamai as akamai

configuration = akamai.get_app_sec_configuration(name="Documentation")
eval_operation = akamai.AppSecEval("evalOperation",
    config_id=configuration.config_id,
    security_policy_id="gms1_134637",
    eval_operation="START")
pulumi.export("evalModeEvaluatingRuleset", eval_operation.evaluating_ruleset)
pulumi.export("evalModeExpirationDate", eval_operation.expiration_date)
pulumi.export("evalModeCurrentRuleset", eval_operation.current_ruleset)
pulumi.export("evalModeStatus", eval_operation.eval_status)

import * as pulumi from "@pulumi/pulumi";
import * as akamai from "@pulumi/akamai";

const configuration = akamai.getAppSecConfiguration({
    name: "Documentation",
});
const evalOperation = new akamai.AppSecEval("evalOperation", {
    configId: configuration.then(configuration => configuration.configId),
    securityPolicyId: "gms1_134637",
    evalOperation: "START",
});
export const evalModeEvaluatingRuleset = evalOperation.evaluatingRuleset;
export const evalModeExpirationDate = evalOperation.expirationDate;
export const evalModeCurrentRuleset = evalOperation.currentRuleset;
export const evalModeStatus = evalOperation.evalStatus;

Create a AppSecEval Resource

new AppSecEval(name: string, args: AppSecEvalArgs, opts?: CustomResourceOptions);
 
@overload
def AppSecEval(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               config_id: Optional[int] = None,
               eval_mode: Optional[str] = None,
               eval_operation: Optional[str] = None,
               security_policy_id: Optional[str] = None)
@overload
def AppSecEval(resource_name: str,
               args: AppSecEvalArgs,
               opts: Optional[ResourceOptions] = None)
 
func NewAppSecEval(ctx *Context, name string, args AppSecEvalArgs, opts ...ResourceOption) (*AppSecEval, error)
 
public AppSecEval(string name, AppSecEvalArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args AppSecEvalArgs
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 AppSecEvalArgs
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 AppSecEvalArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args AppSecEvalArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

AppSecEval 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 AppSecEval resource accepts the following input properties:

ConfigId int
. Unique identifier of the security configuration where evaluation mode will take place (or is currently taking place).
EvalOperation string

. Evaluation mode operation. Allowed values are:

  • START. Starts evaluation mode. By default, evaluation mode runs for four weeks.
  • STOP, Pauses evaluation mode without upgrading the Kona Rule Set on your production network.
  • RESTART. Resumes an evaluation trial that was paused by using the STOP command.
  • UPDATE. Upgrades the Kona Rule Set rules in the evaluation ruleset to their latest versions.
  • COMPLETE. Concludes the evaluation period (even if the four-week trial mode is not over) and automatically upgrades the Kona Rule Set on your production network to the same rule set you just finished evaluating.
SecurityPolicyId string
. Unique identifier of the security policy associated with the evaluation process.
EvalMode string
. Set to ASE_AUTO to have your Kona Rule Set rules automatically updated during the evaluation period; set to ASE_MANUAL if you want to manually update your evaluation rules. Note that this option is only available to organizations running the Adaptive Security Engine (ASE) beta. For more information about ASE, please contact your Akamai representative.
ConfigId int
. Unique identifier of the security configuration where evaluation mode will take place (or is currently taking place).
EvalOperation string

. Evaluation mode operation. Allowed values are:

  • START. Starts evaluation mode. By default, evaluation mode runs for four weeks.
  • STOP, Pauses evaluation mode without upgrading the Kona Rule Set on your production network.
  • RESTART. Resumes an evaluation trial that was paused by using the STOP command.
  • UPDATE. Upgrades the Kona Rule Set rules in the evaluation ruleset to their latest versions.
  • COMPLETE. Concludes the evaluation period (even if the four-week trial mode is not over) and automatically upgrades the Kona Rule Set on your production network to the same rule set you just finished evaluating.
SecurityPolicyId string
. Unique identifier of the security policy associated with the evaluation process.
EvalMode string
. Set to ASE_AUTO to have your Kona Rule Set rules automatically updated during the evaluation period; set to ASE_MANUAL if you want to manually update your evaluation rules. Note that this option is only available to organizations running the Adaptive Security Engine (ASE) beta. For more information about ASE, please contact your Akamai representative.
configId number
. Unique identifier of the security configuration where evaluation mode will take place (or is currently taking place).
evalOperation string

. Evaluation mode operation. Allowed values are:

  • START. Starts evaluation mode. By default, evaluation mode runs for four weeks.
  • STOP, Pauses evaluation mode without upgrading the Kona Rule Set on your production network.
  • RESTART. Resumes an evaluation trial that was paused by using the STOP command.
  • UPDATE. Upgrades the Kona Rule Set rules in the evaluation ruleset to their latest versions.
  • COMPLETE. Concludes the evaluation period (even if the four-week trial mode is not over) and automatically upgrades the Kona Rule Set on your production network to the same rule set you just finished evaluating.
securityPolicyId string
. Unique identifier of the security policy associated with the evaluation process.
evalMode string
. Set to ASE_AUTO to have your Kona Rule Set rules automatically updated during the evaluation period; set to ASE_MANUAL if you want to manually update your evaluation rules. Note that this option is only available to organizations running the Adaptive Security Engine (ASE) beta. For more information about ASE, please contact your Akamai representative.
config_id int
. Unique identifier of the security configuration where evaluation mode will take place (or is currently taking place).
eval_operation str

. Evaluation mode operation. Allowed values are:

  • START. Starts evaluation mode. By default, evaluation mode runs for four weeks.
  • STOP, Pauses evaluation mode without upgrading the Kona Rule Set on your production network.
  • RESTART. Resumes an evaluation trial that was paused by using the STOP command.
  • UPDATE. Upgrades the Kona Rule Set rules in the evaluation ruleset to their latest versions.
  • COMPLETE. Concludes the evaluation period (even if the four-week trial mode is not over) and automatically upgrades the Kona Rule Set on your production network to the same rule set you just finished evaluating.
security_policy_id str
. Unique identifier of the security policy associated with the evaluation process.
eval_mode str
. Set to ASE_AUTO to have your Kona Rule Set rules automatically updated during the evaluation period; set to ASE_MANUAL if you want to manually update your evaluation rules. Note that this option is only available to organizations running the Adaptive Security Engine (ASE) beta. For more information about ASE, please contact your Akamai representative.

Outputs

All input properties are implicitly available as output properties. Additionally, the AppSecEval resource produces the following output properties:

CurrentRuleset string
EvalStatus string
EvaluatingRuleset string
ExpirationDate string
Id string
The provider-assigned unique ID for this managed resource.
CurrentRuleset string
EvalStatus string
EvaluatingRuleset string
ExpirationDate string
Id string
The provider-assigned unique ID for this managed resource.
currentRuleset string
evalStatus string
evaluatingRuleset string
expirationDate string
id string
The provider-assigned unique ID for this managed resource.
current_ruleset str
eval_status str
evaluating_ruleset str
expiration_date str
id str
The provider-assigned unique ID for this managed resource.

Look up an Existing AppSecEval Resource

Get an existing AppSecEval 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?: AppSecEvalState, opts?: CustomResourceOptions): AppSecEval
 
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config_id: Optional[int] = None,
        current_ruleset: Optional[str] = None,
        eval_mode: Optional[str] = None,
        eval_operation: Optional[str] = None,
        eval_status: Optional[str] = None,
        evaluating_ruleset: Optional[str] = None,
        expiration_date: Optional[str] = None,
        security_policy_id: Optional[str] = None) -> AppSecEval
 
func GetAppSecEval(ctx *Context, name string, id IDInput, state *AppSecEvalState, opts ...ResourceOption) (*AppSecEval, error)
 
public static AppSecEval Get(string name, Input<string> id, AppSecEvalState? state, CustomResourceOptions? opts = null)
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.

The following state arguments are supported:

ConfigId int
. Unique identifier of the security configuration where evaluation mode will take place (or is currently taking place).
CurrentRuleset string
EvalMode string
. Set to ASE_AUTO to have your Kona Rule Set rules automatically updated during the evaluation period; set to ASE_MANUAL if you want to manually update your evaluation rules. Note that this option is only available to organizations running the Adaptive Security Engine (ASE) beta. For more information about ASE, please contact your Akamai representative.
EvalOperation string

. Evaluation mode operation. Allowed values are:

  • START. Starts evaluation mode. By default, evaluation mode runs for four weeks.
  • STOP, Pauses evaluation mode without upgrading the Kona Rule Set on your production network.
  • RESTART. Resumes an evaluation trial that was paused by using the STOP command.
  • UPDATE. Upgrades the Kona Rule Set rules in the evaluation ruleset to their latest versions.
  • COMPLETE. Concludes the evaluation period (even if the four-week trial mode is not over) and automatically upgrades the Kona Rule Set on your production network to the same rule set you just finished evaluating.
EvalStatus string
EvaluatingRuleset string
ExpirationDate string
SecurityPolicyId string
. Unique identifier of the security policy associated with the evaluation process.
ConfigId int
. Unique identifier of the security configuration where evaluation mode will take place (or is currently taking place).
CurrentRuleset string
EvalMode string
. Set to ASE_AUTO to have your Kona Rule Set rules automatically updated during the evaluation period; set to ASE_MANUAL if you want to manually update your evaluation rules. Note that this option is only available to organizations running the Adaptive Security Engine (ASE) beta. For more information about ASE, please contact your Akamai representative.
EvalOperation string

. Evaluation mode operation. Allowed values are:

  • START. Starts evaluation mode. By default, evaluation mode runs for four weeks.
  • STOP, Pauses evaluation mode without upgrading the Kona Rule Set on your production network.
  • RESTART. Resumes an evaluation trial that was paused by using the STOP command.
  • UPDATE. Upgrades the Kona Rule Set rules in the evaluation ruleset to their latest versions.
  • COMPLETE. Concludes the evaluation period (even if the four-week trial mode is not over) and automatically upgrades the Kona Rule Set on your production network to the same rule set you just finished evaluating.
EvalStatus string
EvaluatingRuleset string
ExpirationDate string
SecurityPolicyId string
. Unique identifier of the security policy associated with the evaluation process.
configId number
. Unique identifier of the security configuration where evaluation mode will take place (or is currently taking place).
currentRuleset string
evalMode string
. Set to ASE_AUTO to have your Kona Rule Set rules automatically updated during the evaluation period; set to ASE_MANUAL if you want to manually update your evaluation rules. Note that this option is only available to organizations running the Adaptive Security Engine (ASE) beta. For more information about ASE, please contact your Akamai representative.
evalOperation string

. Evaluation mode operation. Allowed values are:

  • START. Starts evaluation mode. By default, evaluation mode runs for four weeks.
  • STOP, Pauses evaluation mode without upgrading the Kona Rule Set on your production network.
  • RESTART. Resumes an evaluation trial that was paused by using the STOP command.
  • UPDATE. Upgrades the Kona Rule Set rules in the evaluation ruleset to their latest versions.
  • COMPLETE. Concludes the evaluation period (even if the four-week trial mode is not over) and automatically upgrades the Kona Rule Set on your production network to the same rule set you just finished evaluating.
evalStatus string
evaluatingRuleset string
expirationDate string
securityPolicyId string
. Unique identifier of the security policy associated with the evaluation process.
config_id int
. Unique identifier of the security configuration where evaluation mode will take place (or is currently taking place).
current_ruleset str
eval_mode str
. Set to ASE_AUTO to have your Kona Rule Set rules automatically updated during the evaluation period; set to ASE_MANUAL if you want to manually update your evaluation rules. Note that this option is only available to organizations running the Adaptive Security Engine (ASE) beta. For more information about ASE, please contact your Akamai representative.
eval_operation str

. Evaluation mode operation. Allowed values are:

  • START. Starts evaluation mode. By default, evaluation mode runs for four weeks.
  • STOP, Pauses evaluation mode without upgrading the Kona Rule Set on your production network.
  • RESTART. Resumes an evaluation trial that was paused by using the STOP command.
  • UPDATE. Upgrades the Kona Rule Set rules in the evaluation ruleset to their latest versions.
  • COMPLETE. Concludes the evaluation period (even if the four-week trial mode is not over) and automatically upgrades the Kona Rule Set on your production network to the same rule set you just finished evaluating.
eval_status str
evaluating_ruleset str
expiration_date str
security_policy_id str
. Unique identifier of the security policy associated with the evaluation process.

Package Details

Repository
https://github.com/pulumi/pulumi-akamai
License
Apache-2.0
Notes
This Pulumi package is based on the akamai Terraform Provider.