Akamai

Pulumi Official
Package maintained by Pulumi
v2.9.0 published on Wednesday, Apr 6, 2022 by Pulumi

getAppSecRuleUpgradeDetails

Scopes: Security policy

Returns information indicating which of your Kona Rule Sets (if any) need to be updated. A value of false indicates that no updates are required.

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

Output Options

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

  • output_text. Tabular report showing changes (additions and deletions) to the rules for the specified security policy.
  • json. JSON-formatted list of the changes (additions and deletions) to the rules for the specified security policy.

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 upgradeDetails = configuration.Apply(configuration => Output.Create(Akamai.GetAppSecRuleUpgradeDetails.InvokeAsync(new Akamai.GetAppSecRuleUpgradeDetailsArgs
        {
            ConfigId = configuration.ConfigId,
            SecurityPolicyId = "gms1_134637",
        })));
        this.UpgradeDetailsText = upgradeDetails.Apply(upgradeDetails => upgradeDetails.OutputText);
        this.UpgradeDetailsJson = upgradeDetails.Apply(upgradeDetails => upgradeDetails.Json);
    }

    [Output("upgradeDetailsText")]
    public Output<string> UpgradeDetailsText { get; set; }
    [Output("upgradeDetailsJson")]
    public Output<string> UpgradeDetailsJson { 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 {
		configuration, err := akamai.LookupAppSecConfiguration(ctx, &GetAppSecConfigurationArgs{
			Name: pulumi.StringRef("Documentation"),
		}, nil)
		if err != nil {
			return err
		}
		upgradeDetails, err := akamai.GetAppSecRuleUpgradeDetails(ctx, &GetAppSecRuleUpgradeDetailsArgs{
			ConfigId:         configuration.ConfigId,
			SecurityPolicyId: "gms1_134637",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("upgradeDetailsText", upgradeDetails.OutputText)
		ctx.Export("upgradeDetailsJson", upgradeDetails.Json)
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_akamai as akamai

configuration = akamai.get_app_sec_configuration(name="Documentation")
upgrade_details = akamai.get_app_sec_rule_upgrade_details(config_id=configuration.config_id,
    security_policy_id="gms1_134637")
pulumi.export("upgradeDetailsText", upgrade_details.output_text)
pulumi.export("upgradeDetailsJson", upgrade_details.json)
import * as pulumi from "@pulumi/pulumi";
import * as akamai from "@pulumi/akamai";

const configuration = akamai.getAppSecConfiguration({
    name: "Documentation",
});
const upgradeDetails = configuration.then(configuration => akamai.getAppSecRuleUpgradeDetails({
    configId: configuration.configId,
    securityPolicyId: "gms1_134637",
}));
export const upgradeDetailsText = upgradeDetails.then(upgradeDetails => upgradeDetails.outputText);
export const upgradeDetailsJson = upgradeDetails.then(upgradeDetails => upgradeDetails.json);

Coming soon!

Using getAppSecRuleUpgradeDetails

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getAppSecRuleUpgradeDetails(args: GetAppSecRuleUpgradeDetailsArgs, opts?: InvokeOptions): Promise<GetAppSecRuleUpgradeDetailsResult>
function getAppSecRuleUpgradeDetailsOutput(args: GetAppSecRuleUpgradeDetailsOutputArgs, opts?: InvokeOptions): Output<GetAppSecRuleUpgradeDetailsResult>
def get_app_sec_rule_upgrade_details(config_id: Optional[int] = None,
                                     security_policy_id: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetAppSecRuleUpgradeDetailsResult
def get_app_sec_rule_upgrade_details_output(config_id: Optional[pulumi.Input[int]] = None,
                                     security_policy_id: Optional[pulumi.Input[str]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[GetAppSecRuleUpgradeDetailsResult]
func GetAppSecRuleUpgradeDetails(ctx *Context, args *GetAppSecRuleUpgradeDetailsArgs, opts ...InvokeOption) (*GetAppSecRuleUpgradeDetailsResult, error)
func GetAppSecRuleUpgradeDetailsOutput(ctx *Context, args *GetAppSecRuleUpgradeDetailsOutputArgs, opts ...InvokeOption) GetAppSecRuleUpgradeDetailsResultOutput

> Note: This function is named GetAppSecRuleUpgradeDetails in the Go SDK.

public static class GetAppSecRuleUpgradeDetails 
{
    public static Task<GetAppSecRuleUpgradeDetailsResult> InvokeAsync(GetAppSecRuleUpgradeDetailsArgs args, InvokeOptions? opts = null)
    public static Output<GetAppSecRuleUpgradeDetailsResult> Invoke(GetAppSecRuleUpgradeDetailsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetAppSecRuleUpgradeDetailsResult> getAppSecRuleUpgradeDetails(GetAppSecRuleUpgradeDetailsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: akamai:index/getAppSecRuleUpgradeDetails:getAppSecRuleUpgradeDetails
  Arguments:
    # Arguments dictionary

The following arguments are supported:

ConfigId int

. Unique identifier of the security configuration associated with the Kona Rule Sets.

SecurityPolicyId string

. Unique identifier of the security policy associated with the Kona Rule Sets.

ConfigId int

. Unique identifier of the security configuration associated with the Kona Rule Sets.

SecurityPolicyId string

. Unique identifier of the security policy associated with the Kona Rule Sets.

configId Integer

. Unique identifier of the security configuration associated with the Kona Rule Sets.

securityPolicyId String

. Unique identifier of the security policy associated with the Kona Rule Sets.

configId number

. Unique identifier of the security configuration associated with the Kona Rule Sets.

securityPolicyId string

. Unique identifier of the security policy associated with the Kona Rule Sets.

config_id int

. Unique identifier of the security configuration associated with the Kona Rule Sets.

security_policy_id str

. Unique identifier of the security policy associated with the Kona Rule Sets.

configId Number

. Unique identifier of the security configuration associated with the Kona Rule Sets.

securityPolicyId String

. Unique identifier of the security policy associated with the Kona Rule Sets.

getAppSecRuleUpgradeDetails Result

The following output properties are available:

ConfigId int
Id string

The provider-assigned unique ID for this managed resource.

Json string
OutputText string
SecurityPolicyId string
ConfigId int
Id string

The provider-assigned unique ID for this managed resource.

Json string
OutputText string
SecurityPolicyId string
configId Integer
id String

The provider-assigned unique ID for this managed resource.

json String
outputText String
securityPolicyId String
configId number
id string

The provider-assigned unique ID for this managed resource.

json string
outputText string
securityPolicyId string
config_id int
id str

The provider-assigned unique ID for this managed resource.

json str
output_text str
security_policy_id str
configId Number
id String

The provider-assigned unique ID for this managed resource.

json String
outputText String
securityPolicyId String

Package Details

Repository
https://github.com/pulumi/pulumi-akamai
License
Apache-2.0
Notes

This Pulumi package is based on the akamai Terraform Provider.