1. Pulumi Registry
  2. Akamai
  3. API Docs
  4. AppSecRuleUpgrade
akamai logo
Akamai v4.3.0, Mar 6 23

akamai.AppSecRuleUpgrade

Output Options

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

  • current_ruleset. Versioning information for your current KRS rule set.

  • mode. Specifies the current upgrade mode type. Valid values are:

    • KRS. Rulesets must be manually upgraded.

    • AAG. Rulesets are automatically upgraded by Akamai.

    • ASE_MANUAL. Adaptive Security Engine rulesets must be manually upgraded.

    • ASE_AUTO. Adaptive Security Engine rulesets are automatically updated by Akamai.

  • eval_status. Returns enabled if an evaluation is currently in progress; otherwise returns disabled.

Example Usage

Basic usage

using System.Collections.Generic;
using Pulumi;
using Akamai = Pulumi.Akamai;

return await Deployment.RunAsync(() => 
{
    var configuration = Akamai.GetAppSecConfiguration.Invoke(new()
    {
        Name = "Documentation",
    });

    var ruleUpgrade = new Akamai.AppSecRuleUpgrade("ruleUpgrade", new()
    {
        ConfigId = configuration.Apply(getAppSecConfigurationResult => getAppSecConfigurationResult.ConfigId),
        SecurityPolicyId = "gms1_134637",
    });

    return new Dictionary<string, object?>
    {
        ["ruleUpgradeCurrentRuleset"] = ruleUpgrade.CurrentRuleset,
        ["ruleUpgradeMode"] = ruleUpgrade.Mode,
        ["ruleUpgradeEvalStatus"] = ruleUpgrade.EvalStatus,
    };
});

package main

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

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
		}
		ruleUpgrade, err := akamai.NewAppSecRuleUpgrade(ctx, "ruleUpgrade", &akamai.AppSecRuleUpgradeArgs{
			ConfigId:         *pulumi.Int(configuration.ConfigId),
			SecurityPolicyId: pulumi.String("gms1_134637"),
		})
		if err != nil {
			return err
		}
		ctx.Export("ruleUpgradeCurrentRuleset", ruleUpgrade.CurrentRuleset)
		ctx.Export("ruleUpgradeMode", ruleUpgrade.Mode)
		ctx.Export("ruleUpgradeEvalStatus", ruleUpgrade.EvalStatus)
		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.AppSecRuleUpgrade;
import com.pulumi.akamai.AppSecRuleUpgradeArgs;
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 ruleUpgrade = new AppSecRuleUpgrade("ruleUpgrade", AppSecRuleUpgradeArgs.builder()        
            .configId(configuration.applyValue(getAppSecConfigurationResult -> getAppSecConfigurationResult.configId()))
            .securityPolicyId("gms1_134637")
            .build());

        ctx.export("ruleUpgradeCurrentRuleset", ruleUpgrade.currentRuleset());
        ctx.export("ruleUpgradeMode", ruleUpgrade.mode());
        ctx.export("ruleUpgradeEvalStatus", ruleUpgrade.evalStatus());
    }
}

import pulumi
import pulumi_akamai as akamai

configuration = akamai.get_app_sec_configuration(name="Documentation")
rule_upgrade = akamai.AppSecRuleUpgrade("ruleUpgrade",
    config_id=configuration.config_id,
    security_policy_id="gms1_134637")
pulumi.export("ruleUpgradeCurrentRuleset", rule_upgrade.current_ruleset)
pulumi.export("ruleUpgradeMode", rule_upgrade.mode)
pulumi.export("ruleUpgradeEvalStatus", rule_upgrade.eval_status)

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

const configuration = akamai.getAppSecConfiguration({
    name: "Documentation",
});
const ruleUpgrade = new akamai.AppSecRuleUpgrade("ruleUpgrade", {
    configId: configuration.then(configuration => configuration.configId),
    securityPolicyId: "gms1_134637",
});
export const ruleUpgradeCurrentRuleset = ruleUpgrade.currentRuleset;
export const ruleUpgradeMode = ruleUpgrade.mode;
export const ruleUpgradeEvalStatus = ruleUpgrade.evalStatus;

resources:
  ruleUpgrade:
    type: akamai:AppSecRuleUpgrade
    properties:
      configId: ${configuration.configId}
      securityPolicyId: gms1_134637
variables:
  configuration:
    fn::invoke:
      Function: akamai:getAppSecConfiguration
      Arguments:
        name: Documentation
outputs:
  ruleUpgradeCurrentRuleset: ${ruleUpgrade.currentRuleset}
  ruleUpgradeMode: ${ruleUpgrade.mode}
  ruleUpgradeEvalStatus: ${ruleUpgrade.evalStatus}

Create AppSecRuleUpgrade Resource

new AppSecRuleUpgrade(name: string, args: AppSecRuleUpgradeArgs, opts?: CustomResourceOptions);
@overload
def AppSecRuleUpgrade(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      config_id: Optional[int] = None,
                      security_policy_id: Optional[str] = None,
                      upgrade_mode: Optional[str] = None)
@overload
def AppSecRuleUpgrade(resource_name: str,
                      args: AppSecRuleUpgradeArgs,
                      opts: Optional[ResourceOptions] = None)
func NewAppSecRuleUpgrade(ctx *Context, name string, args AppSecRuleUpgradeArgs, opts ...ResourceOption) (*AppSecRuleUpgrade, error)
public AppSecRuleUpgrade(string name, AppSecRuleUpgradeArgs args, CustomResourceOptions? opts = null)
public AppSecRuleUpgrade(String name, AppSecRuleUpgradeArgs args)
public AppSecRuleUpgrade(String name, AppSecRuleUpgradeArgs args, CustomResourceOptions options)

type: akamai:AppSecRuleUpgrade
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args AppSecRuleUpgradeArgs
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 AppSecRuleUpgradeArgs
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 AppSecRuleUpgradeArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args AppSecRuleUpgradeArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args AppSecRuleUpgradeArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

ConfigId int

. Unique identifier of the security configuration associated with the ruleset being upgraded.

SecurityPolicyId string

. Unique identifier of the security policy associated with the ruleset being upgraded.

UpgradeMode string

. (Optional). Modifies the upgrade type for organizations running the ASE beta. Allowed values are:

  • ASE_AUTO. Akamai automatically updates your rulesets.
  • ASE_MANUAL. Manually updates your rulesets.
ConfigId int

. Unique identifier of the security configuration associated with the ruleset being upgraded.

SecurityPolicyId string

. Unique identifier of the security policy associated with the ruleset being upgraded.

UpgradeMode string

. (Optional). Modifies the upgrade type for organizations running the ASE beta. Allowed values are:

  • ASE_AUTO. Akamai automatically updates your rulesets.
  • ASE_MANUAL. Manually updates your rulesets.
configId Integer

. Unique identifier of the security configuration associated with the ruleset being upgraded.

securityPolicyId String

. Unique identifier of the security policy associated with the ruleset being upgraded.

upgradeMode String

. (Optional). Modifies the upgrade type for organizations running the ASE beta. Allowed values are:

  • ASE_AUTO. Akamai automatically updates your rulesets.
  • ASE_MANUAL. Manually updates your rulesets.
configId number

. Unique identifier of the security configuration associated with the ruleset being upgraded.

securityPolicyId string

. Unique identifier of the security policy associated with the ruleset being upgraded.

upgradeMode string

. (Optional). Modifies the upgrade type for organizations running the ASE beta. Allowed values are:

  • ASE_AUTO. Akamai automatically updates your rulesets.
  • ASE_MANUAL. Manually updates your rulesets.
config_id int

. Unique identifier of the security configuration associated with the ruleset being upgraded.

security_policy_id str

. Unique identifier of the security policy associated with the ruleset being upgraded.

upgrade_mode str

. (Optional). Modifies the upgrade type for organizations running the ASE beta. Allowed values are:

  • ASE_AUTO. Akamai automatically updates your rulesets.
  • ASE_MANUAL. Manually updates your rulesets.
configId Number

. Unique identifier of the security configuration associated with the ruleset being upgraded.

securityPolicyId String

. Unique identifier of the security policy associated with the ruleset being upgraded.

upgradeMode String

. (Optional). Modifies the upgrade type for organizations running the ASE beta. Allowed values are:

  • ASE_AUTO. Akamai automatically updates your rulesets.
  • ASE_MANUAL. Manually updates your rulesets.

Outputs

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

CurrentRuleset string

Versioning information for the current KRS rule set

EvalStatus string

Whether an evaluation is currently in progress

Id string

The provider-assigned unique ID for this managed resource.

Mode string

Upgrade mode (KRS, AAG, ASE_MANUAL or ASE_AUTO)

CurrentRuleset string

Versioning information for the current KRS rule set

EvalStatus string

Whether an evaluation is currently in progress

Id string

The provider-assigned unique ID for this managed resource.

Mode string

Upgrade mode (KRS, AAG, ASE_MANUAL or ASE_AUTO)

currentRuleset String

Versioning information for the current KRS rule set

evalStatus String

Whether an evaluation is currently in progress

id String

The provider-assigned unique ID for this managed resource.

mode String

Upgrade mode (KRS, AAG, ASE_MANUAL or ASE_AUTO)

currentRuleset string

Versioning information for the current KRS rule set

evalStatus string

Whether an evaluation is currently in progress

id string

The provider-assigned unique ID for this managed resource.

mode string

Upgrade mode (KRS, AAG, ASE_MANUAL or ASE_AUTO)

current_ruleset str

Versioning information for the current KRS rule set

eval_status str

Whether an evaluation is currently in progress

id str

The provider-assigned unique ID for this managed resource.

mode str

Upgrade mode (KRS, AAG, ASE_MANUAL or ASE_AUTO)

currentRuleset String

Versioning information for the current KRS rule set

evalStatus String

Whether an evaluation is currently in progress

id String

The provider-assigned unique ID for this managed resource.

mode String

Upgrade mode (KRS, AAG, ASE_MANUAL or ASE_AUTO)

Look up Existing AppSecRuleUpgrade Resource

Get an existing AppSecRuleUpgrade 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?: AppSecRuleUpgradeState, opts?: CustomResourceOptions): AppSecRuleUpgrade
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config_id: Optional[int] = None,
        current_ruleset: Optional[str] = None,
        eval_status: Optional[str] = None,
        mode: Optional[str] = None,
        security_policy_id: Optional[str] = None,
        upgrade_mode: Optional[str] = None) -> AppSecRuleUpgrade
func GetAppSecRuleUpgrade(ctx *Context, name string, id IDInput, state *AppSecRuleUpgradeState, opts ...ResourceOption) (*AppSecRuleUpgrade, error)
public static AppSecRuleUpgrade Get(string name, Input<string> id, AppSecRuleUpgradeState? state, CustomResourceOptions? opts = null)
public static AppSecRuleUpgrade get(String name, Output<String> id, AppSecRuleUpgradeState 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.
The following state arguments are supported:
ConfigId int

. Unique identifier of the security configuration associated with the ruleset being upgraded.

CurrentRuleset string

Versioning information for the current KRS rule set

EvalStatus string

Whether an evaluation is currently in progress

Mode string

Upgrade mode (KRS, AAG, ASE_MANUAL or ASE_AUTO)

SecurityPolicyId string

. Unique identifier of the security policy associated with the ruleset being upgraded.

UpgradeMode string

. (Optional). Modifies the upgrade type for organizations running the ASE beta. Allowed values are:

  • ASE_AUTO. Akamai automatically updates your rulesets.
  • ASE_MANUAL. Manually updates your rulesets.
ConfigId int

. Unique identifier of the security configuration associated with the ruleset being upgraded.

CurrentRuleset string

Versioning information for the current KRS rule set

EvalStatus string

Whether an evaluation is currently in progress

Mode string

Upgrade mode (KRS, AAG, ASE_MANUAL or ASE_AUTO)

SecurityPolicyId string

. Unique identifier of the security policy associated with the ruleset being upgraded.

UpgradeMode string

. (Optional). Modifies the upgrade type for organizations running the ASE beta. Allowed values are:

  • ASE_AUTO. Akamai automatically updates your rulesets.
  • ASE_MANUAL. Manually updates your rulesets.
configId Integer

. Unique identifier of the security configuration associated with the ruleset being upgraded.

currentRuleset String

Versioning information for the current KRS rule set

evalStatus String

Whether an evaluation is currently in progress

mode String

Upgrade mode (KRS, AAG, ASE_MANUAL or ASE_AUTO)

securityPolicyId String

. Unique identifier of the security policy associated with the ruleset being upgraded.

upgradeMode String

. (Optional). Modifies the upgrade type for organizations running the ASE beta. Allowed values are:

  • ASE_AUTO. Akamai automatically updates your rulesets.
  • ASE_MANUAL. Manually updates your rulesets.
configId number

. Unique identifier of the security configuration associated with the ruleset being upgraded.

currentRuleset string

Versioning information for the current KRS rule set

evalStatus string

Whether an evaluation is currently in progress

mode string

Upgrade mode (KRS, AAG, ASE_MANUAL or ASE_AUTO)

securityPolicyId string

. Unique identifier of the security policy associated with the ruleset being upgraded.

upgradeMode string

. (Optional). Modifies the upgrade type for organizations running the ASE beta. Allowed values are:

  • ASE_AUTO. Akamai automatically updates your rulesets.
  • ASE_MANUAL. Manually updates your rulesets.
config_id int

. Unique identifier of the security configuration associated with the ruleset being upgraded.

current_ruleset str

Versioning information for the current KRS rule set

eval_status str

Whether an evaluation is currently in progress

mode str

Upgrade mode (KRS, AAG, ASE_MANUAL or ASE_AUTO)

security_policy_id str

. Unique identifier of the security policy associated with the ruleset being upgraded.

upgrade_mode str

. (Optional). Modifies the upgrade type for organizations running the ASE beta. Allowed values are:

  • ASE_AUTO. Akamai automatically updates your rulesets.
  • ASE_MANUAL. Manually updates your rulesets.
configId Number

. Unique identifier of the security configuration associated with the ruleset being upgraded.

currentRuleset String

Versioning information for the current KRS rule set

evalStatus String

Whether an evaluation is currently in progress

mode String

Upgrade mode (KRS, AAG, ASE_MANUAL or ASE_AUTO)

securityPolicyId String

. Unique identifier of the security policy associated with the ruleset being upgraded.

upgradeMode String

. (Optional). Modifies the upgrade type for organizations running the ASE beta. Allowed values are:

  • ASE_AUTO. Akamai automatically updates your rulesets.
  • ASE_MANUAL. Manually updates your rulesets.

Package Details

Repository
Akamai pulumi/pulumi-akamai
License
Apache-2.0
Notes

This Pulumi package is based on the akamai Terraform Provider.