1. Pulumi Registry
  2. Akamai
  3. API Docs
  4. getAppSecRatePolicies
akamai logo
Akamai v4.1.0, Jan 25 23

akamai.getAppSecRatePolicies

Scopes: Security configuration; rate policy

Returns information about your rate policies. Rate polices help you monitor and moderate the number and rate of all the requests you receive; in turn, this helps you prevent your website from being overwhelmed by a dramatic, and unexpected, surge in traffic.

Related API Endpoint: /appsec/v1/configs/{configId}/versions/{versionNumber}/rate-policies

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 the ID and name of the rate policies.
  • json. JSON-formatted list of the rate policy information.

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 ratePolicies = Akamai.GetAppSecRatePolicies.Invoke(new()
    {
        ConfigId = configuration.Apply(getAppSecConfigurationResult => getAppSecConfigurationResult.ConfigId),
    });

    var ratePolicy = Akamai.GetAppSecRatePolicies.Invoke(new()
    {
        ConfigId = configuration.Apply(getAppSecConfigurationResult => getAppSecConfigurationResult.ConfigId),
        RatePolicyId = 122149,
    });

    return new Dictionary<string, object?>
    {
        ["ratePoliciesOutput"] = ratePolicies.Apply(getAppSecRatePoliciesResult => getAppSecRatePoliciesResult.OutputText),
        ["ratePoliciesJson"] = ratePolicies.Apply(getAppSecRatePoliciesResult => getAppSecRatePoliciesResult.Json),
        ["ratePolicyJson"] = ratePolicy.Apply(getAppSecRatePoliciesResult => getAppSecRatePoliciesResult.Json),
        ["ratePolicyOutput"] = ratePolicy.Apply(getAppSecRatePoliciesResult => getAppSecRatePoliciesResult.OutputText),
    };
});

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
		}
		ratePolicies, err := akamai.GetAppSecRatePolicies(ctx, &akamai.GetAppSecRatePoliciesArgs{
			ConfigId: configuration.ConfigId,
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("ratePoliciesOutput", ratePolicies.OutputText)
		ctx.Export("ratePoliciesJson", ratePolicies.Json)
		ratePolicy, err := akamai.GetAppSecRatePolicies(ctx, &akamai.GetAppSecRatePoliciesArgs{
			ConfigId:     configuration.ConfigId,
			RatePolicyId: pulumi.IntRef(122149),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("ratePolicyJson", ratePolicy.Json)
		ctx.Export("ratePolicyOutput", ratePolicy.OutputText)
		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.inputs.GetAppSecRatePoliciesArgs;
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());

        final var ratePolicies = AkamaiFunctions.getAppSecRatePolicies(GetAppSecRatePoliciesArgs.builder()
            .configId(configuration.applyValue(getAppSecConfigurationResult -> getAppSecConfigurationResult.configId()))
            .build());

        ctx.export("ratePoliciesOutput", ratePolicies.applyValue(getAppSecRatePoliciesResult -> getAppSecRatePoliciesResult.outputText()));
        ctx.export("ratePoliciesJson", ratePolicies.applyValue(getAppSecRatePoliciesResult -> getAppSecRatePoliciesResult.json()));
        final var ratePolicy = AkamaiFunctions.getAppSecRatePolicies(GetAppSecRatePoliciesArgs.builder()
            .configId(configuration.applyValue(getAppSecConfigurationResult -> getAppSecConfigurationResult.configId()))
            .ratePolicyId("122149")
            .build());

        ctx.export("ratePolicyJson", ratePolicy.applyValue(getAppSecRatePoliciesResult -> getAppSecRatePoliciesResult.json()));
        ctx.export("ratePolicyOutput", ratePolicy.applyValue(getAppSecRatePoliciesResult -> getAppSecRatePoliciesResult.outputText()));
    }
}

import pulumi
import pulumi_akamai as akamai

configuration = akamai.get_app_sec_configuration(name="Documentation")
rate_policies = akamai.get_app_sec_rate_policies(config_id=configuration.config_id)
pulumi.export("ratePoliciesOutput", rate_policies.output_text)
pulumi.export("ratePoliciesJson", rate_policies.json)
rate_policy = akamai.get_app_sec_rate_policies(config_id=configuration.config_id,
    rate_policy_id=122149)
pulumi.export("ratePolicyJson", rate_policy.json)
pulumi.export("ratePolicyOutput", rate_policy.output_text)

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

const configuration = akamai.getAppSecConfiguration({
    name: "Documentation",
});
const ratePolicies = configuration.then(configuration => akamai.getAppSecRatePolicies({
    configId: configuration.configId,
}));
export const ratePoliciesOutput = ratePolicies.then(ratePolicies => ratePolicies.outputText);
export const ratePoliciesJson = ratePolicies.then(ratePolicies => ratePolicies.json);
const ratePolicy = configuration.then(configuration => akamai.getAppSecRatePolicies({
    configId: configuration.configId,
    ratePolicyId: 122149,
}));
export const ratePolicyJson = ratePolicy.then(ratePolicy => ratePolicy.json);
export const ratePolicyOutput = ratePolicy.then(ratePolicy => ratePolicy.outputText);

variables:
  configuration:
    fn::invoke:
      Function: akamai:getAppSecConfiguration
      Arguments:
        name: Documentation
  ratePolicies:
    fn::invoke:
      Function: akamai:getAppSecRatePolicies
      Arguments:
        configId: ${configuration.configId}
  ratePolicy:
    fn::invoke:
      Function: akamai:getAppSecRatePolicies
      Arguments:
        configId: ${configuration.configId}
        ratePolicyId: '122149'
outputs:
  ratePoliciesOutput: ${ratePolicies.outputText}
  ratePoliciesJson: ${ratePolicies.json} # USE CASE: User wants to see a specific rate policy.
  ratePolicyJson: ${ratePolicy.json}
  ratePolicyOutput: ${ratePolicy.outputText}

Using getAppSecRatePolicies

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 getAppSecRatePolicies(args: GetAppSecRatePoliciesArgs, opts?: InvokeOptions): Promise<GetAppSecRatePoliciesResult>
function getAppSecRatePoliciesOutput(args: GetAppSecRatePoliciesOutputArgs, opts?: InvokeOptions): Output<GetAppSecRatePoliciesResult>
def get_app_sec_rate_policies(config_id: Optional[int] = None,
                              rate_policy_id: Optional[int] = None,
                              opts: Optional[InvokeOptions] = None) -> GetAppSecRatePoliciesResult
def get_app_sec_rate_policies_output(config_id: Optional[pulumi.Input[int]] = None,
                              rate_policy_id: Optional[pulumi.Input[int]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetAppSecRatePoliciesResult]
func GetAppSecRatePolicies(ctx *Context, args *GetAppSecRatePoliciesArgs, opts ...InvokeOption) (*GetAppSecRatePoliciesResult, error)
func GetAppSecRatePoliciesOutput(ctx *Context, args *GetAppSecRatePoliciesOutputArgs, opts ...InvokeOption) GetAppSecRatePoliciesResultOutput

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

public static class GetAppSecRatePolicies 
{
    public static Task<GetAppSecRatePoliciesResult> InvokeAsync(GetAppSecRatePoliciesArgs args, InvokeOptions? opts = null)
    public static Output<GetAppSecRatePoliciesResult> Invoke(GetAppSecRatePoliciesInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetAppSecRatePoliciesResult> getAppSecRatePolicies(GetAppSecRatePoliciesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: akamai:index/getAppSecRatePolicies:getAppSecRatePolicies
  arguments:
    # arguments dictionary

The following arguments are supported:

ConfigId int

. Unique identifier of the security configuration associated with the rate policies.

RatePolicyId int

. Unique identifier of the rate policy you want to return information for. If not included, information is returned for all your rate policies.

ConfigId int

. Unique identifier of the security configuration associated with the rate policies.

RatePolicyId int

. Unique identifier of the rate policy you want to return information for. If not included, information is returned for all your rate policies.

configId Integer

. Unique identifier of the security configuration associated with the rate policies.

ratePolicyId Integer

. Unique identifier of the rate policy you want to return information for. If not included, information is returned for all your rate policies.

configId number

. Unique identifier of the security configuration associated with the rate policies.

ratePolicyId number

. Unique identifier of the rate policy you want to return information for. If not included, information is returned for all your rate policies.

config_id int

. Unique identifier of the security configuration associated with the rate policies.

rate_policy_id int

. Unique identifier of the rate policy you want to return information for. If not included, information is returned for all your rate policies.

configId Number

. Unique identifier of the security configuration associated with the rate policies.

ratePolicyId Number

. Unique identifier of the rate policy you want to return information for. If not included, information is returned for all your rate policies.

getAppSecRatePolicies Result

The following output properties are available:

ConfigId int
Id string

The provider-assigned unique ID for this managed resource.

Json string
OutputText string
RatePolicyId int
ConfigId int
Id string

The provider-assigned unique ID for this managed resource.

Json string
OutputText string
RatePolicyId int
configId Integer
id String

The provider-assigned unique ID for this managed resource.

json String
outputText String
ratePolicyId Integer
configId number
id string

The provider-assigned unique ID for this managed resource.

json string
outputText string
ratePolicyId number
config_id int
id str

The provider-assigned unique ID for this managed resource.

json str
output_text str
rate_policy_id int
configId Number
id String

The provider-assigned unique ID for this managed resource.

json String
outputText String
ratePolicyId Number

Package Details

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

This Pulumi package is based on the akamai Terraform Provider.