akamai.getAppSecVersionNotes

Scopes: Security configuration

Returns the most recent version notes for a security configuration.

Related API Endpoint: /appsec/v1/configs/{configId}/versions/{versionNumber}/version-notes

Output Options

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

  • json. JSON-formatted list showing the version notes.
  • output_text. Tabular report showing the version notes.

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

    return new Dictionary<string, object?>
    {
        ["versionNotesText"] = versionNotes.Apply(getAppSecVersionNotesResult => getAppSecVersionNotesResult.OutputText),
        ["versionNotesJson"] = versionNotes.Apply(getAppSecVersionNotesResult => getAppSecVersionNotesResult.Json),
    };
});
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
		}
		versionNotes, err := akamai.GetAppSecVersionNotes(ctx, &akamai.GetAppSecVersionNotesArgs{
			ConfigId: configuration.ConfigId,
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("versionNotesText", versionNotes.OutputText)
		ctx.Export("versionNotesJson", versionNotes.Json)
		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.GetAppSecVersionNotesArgs;
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 versionNotes = AkamaiFunctions.getAppSecVersionNotes(GetAppSecVersionNotesArgs.builder()
            .configId(configuration.applyValue(getAppSecConfigurationResult -> getAppSecConfigurationResult.configId()))
            .build());

        ctx.export("versionNotesText", versionNotes.applyValue(getAppSecVersionNotesResult -> getAppSecVersionNotesResult.outputText()));
        ctx.export("versionNotesJson", versionNotes.applyValue(getAppSecVersionNotesResult -> getAppSecVersionNotesResult.json()));
    }
}
import pulumi
import pulumi_akamai as akamai

configuration = akamai.get_app_sec_configuration(name="Documentation")
version_notes = akamai.get_app_sec_version_notes(config_id=configuration.config_id)
pulumi.export("versionNotesText", version_notes.output_text)
pulumi.export("versionNotesJson", version_notes.json)
import * as pulumi from "@pulumi/pulumi";
import * as akamai from "@pulumi/akamai";

const configuration = akamai.getAppSecConfiguration({
    name: "Documentation",
});
const versionNotes = configuration.then(configuration => akamai.getAppSecVersionNotes({
    configId: configuration.configId,
}));
export const versionNotesText = versionNotes.then(versionNotes => versionNotes.outputText);
export const versionNotesJson = versionNotes.then(versionNotes => versionNotes.json);
variables:
  configuration: # USE CASE: User wants to view the version notes for the most-recent version of a security configuration.
    fn::invoke:
      Function: akamai:getAppSecConfiguration
      Arguments:
        name: Documentation
  versionNotes:
    fn::invoke:
      Function: akamai:getAppSecVersionNotes
      Arguments:
        configId: ${configuration.configId}
outputs:
  versionNotesText: ${versionNotes.outputText}
  versionNotesJson: ${versionNotes.json}

Using getAppSecVersionNotes

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 getAppSecVersionNotes(args: GetAppSecVersionNotesArgs, opts?: InvokeOptions): Promise<GetAppSecVersionNotesResult>
function getAppSecVersionNotesOutput(args: GetAppSecVersionNotesOutputArgs, opts?: InvokeOptions): Output<GetAppSecVersionNotesResult>
def get_app_sec_version_notes(config_id: Optional[int] = None,
                              opts: Optional[InvokeOptions] = None) -> GetAppSecVersionNotesResult
def get_app_sec_version_notes_output(config_id: Optional[pulumi.Input[int]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetAppSecVersionNotesResult]
func GetAppSecVersionNotes(ctx *Context, args *GetAppSecVersionNotesArgs, opts ...InvokeOption) (*GetAppSecVersionNotesResult, error)
func GetAppSecVersionNotesOutput(ctx *Context, args *GetAppSecVersionNotesOutputArgs, opts ...InvokeOption) GetAppSecVersionNotesResultOutput

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

public static class GetAppSecVersionNotes 
{
    public static Task<GetAppSecVersionNotesResult> InvokeAsync(GetAppSecVersionNotesArgs args, InvokeOptions? opts = null)
    public static Output<GetAppSecVersionNotesResult> Invoke(GetAppSecVersionNotesInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetAppSecVersionNotesResult> getAppSecVersionNotes(GetAppSecVersionNotesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: akamai:index/getAppSecVersionNotes:getAppSecVersionNotes
  arguments:
    # arguments dictionary

The following arguments are supported:

ConfigId int

. Unique identifier of the security configuration you want to return information for.

ConfigId int

. Unique identifier of the security configuration you want to return information for.

configId Integer

. Unique identifier of the security configuration you want to return information for.

configId number

. Unique identifier of the security configuration you want to return information for.

config_id int

. Unique identifier of the security configuration you want to return information for.

configId Number

. Unique identifier of the security configuration you want to return information for.

getAppSecVersionNotes Result

The following output properties are available:

ConfigId int
Id string

The provider-assigned unique ID for this managed resource.

Json string
OutputText string
ConfigId int
Id string

The provider-assigned unique ID for this managed resource.

Json string
OutputText string
configId Integer
id String

The provider-assigned unique ID for this managed resource.

json String
outputText String
configId number
id string

The provider-assigned unique ID for this managed resource.

json string
outputText string
config_id int
id str

The provider-assigned unique ID for this managed resource.

json str
output_text str
configId Number
id String

The provider-assigned unique ID for this managed resource.

json String
outputText String

Package Details

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

This Pulumi package is based on the akamai Terraform Provider.