getAppSecExportConfiguration

Scopes: Security configuration and version

Returns comprehensive details about a security configuration, including rate policies, security policies, rules, hostnames, and match targets.

Related API Endpoint: /appsec/v1/export/configs/{configId}/versions/{versionNumber}

Output Options

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

  • json. Complete set of information about the specified security configuration version in JSON format. Includes the types available for the search parameter as well as additional fields such as createDate and createdBy.
  • output_text. Tabular report showing the types of data specified in the search parameter. Valid only if the search parameter references at least one type.

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 export = Output.Tuple(configuration, configuration).Apply(values =>
        {
            var configuration = values.Item1;
            var configuration1 = values.Item2;
            return Output.Create(Akamai.GetAppSecExportConfiguration.InvokeAsync(new Akamai.GetAppSecExportConfigurationArgs
            {
                ConfigId = configuration.ConfigId,
                Version = configuration1.LatestVersion,
                Searches = 
                {
                    "securityPolicies",
                    "selectedHosts",
                },
            }));
        });
        this.Json = export.Apply(export => export.Json);
        this.Text = export.Apply(export => export.OutputText);
    }

    [Output("json")]
    public Output<string> Json { get; set; }
    [Output("text")]
    public Output<string> Text { 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
		}
		export, err := akamai.GetAppSecExportConfiguration(ctx, &GetAppSecExportConfigurationArgs{
			ConfigId: configuration.ConfigId,
			Version:  configuration.LatestVersion,
			Searches: []string{
				"securityPolicies",
				"selectedHosts",
			},
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("json", export.Json)
		ctx.Export("text", export.OutputText)
		return nil
	})
}
import pulumi
import pulumi_akamai as akamai

configuration = akamai.get_app_sec_configuration(name="Documentation")
export = akamai.get_app_sec_export_configuration(config_id=configuration.config_id,
    version=configuration.latest_version,
    searches=[
        "securityPolicies",
        "selectedHosts",
    ])
pulumi.export("json", export.json)
pulumi.export("text", export.output_text)
import * as pulumi from "@pulumi/pulumi";
import * as akamai from "@pulumi/akamai";

const configuration = akamai.getAppSecConfiguration({
    name: "Documentation",
});
const export = Promise.all([configuration, configuration]).then(([configuration, configuration1]) => akamai.getAppSecExportConfiguration({
    configId: configuration.configId,
    version: configuration1.latestVersion,
    searches: [
        "securityPolicies",
        "selectedHosts",
    ],
}));
export const json = _export.then(_export => _export.json);
export const text = _export.then(_export => _export.outputText);

Using getAppSecExportConfiguration

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 getAppSecExportConfiguration(args: GetAppSecExportConfigurationArgs, opts?: InvokeOptions): Promise<GetAppSecExportConfigurationResult>
function getAppSecExportConfigurationOutput(args: GetAppSecExportConfigurationOutputArgs, opts?: InvokeOptions): Output<GetAppSecExportConfigurationResult>
def get_app_sec_export_configuration(config_id: Optional[int] = None,
                                     searches: Optional[Sequence[str]] = None,
                                     version: Optional[int] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetAppSecExportConfigurationResult
def get_app_sec_export_configuration_output(config_id: Optional[pulumi.Input[int]] = None,
                                     searches: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                                     version: Optional[pulumi.Input[int]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[GetAppSecExportConfigurationResult]
func GetAppSecExportConfiguration(ctx *Context, args *GetAppSecExportConfigurationArgs, opts ...InvokeOption) (*GetAppSecExportConfigurationResult, error)
func GetAppSecExportConfigurationOutput(ctx *Context, args *GetAppSecExportConfigurationOutputArgs, opts ...InvokeOption) GetAppSecExportConfigurationResultOutput

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

public static class GetAppSecExportConfiguration 
{
    public static Task<GetAppSecExportConfigurationResult> InvokeAsync(GetAppSecExportConfigurationArgs args, InvokeOptions? opts = null)
    public static Output<GetAppSecExportConfigurationResult> Invoke(GetAppSecExportConfigurationInvokeArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

ConfigId int
. Unique identifier of the security configuration you want to return information for.
Version int
. Version number of the security configuration.
Searches List<string>

. JSON array of strings specifying the types of information to be retrieved. Allowed values include:

  • AdvancedSettingsLogging
  • AdvancedSettingsPrefetch
  • ApiRequestConstraints
  • AttackGroup
  • AttackGroupConditionException
  • Eval
  • EvalRuleConditionException
  • CustomDeny
  • CustomRule
  • CustomRuleAction
  • IPGeoFirewall
  • MatchTarget
  • PenaltyBox
  • RatePolicy
  • RatePolicyAction
  • ReputationProfile
  • ReputationProfileAction
  • Rule
  • RuleConditionException
  • SecurityPolicy
  • SiemSettings
  • SlowPost
ConfigId int
. Unique identifier of the security configuration you want to return information for.
Version int
. Version number of the security configuration.
Searches []string

. JSON array of strings specifying the types of information to be retrieved. Allowed values include:

  • AdvancedSettingsLogging
  • AdvancedSettingsPrefetch
  • ApiRequestConstraints
  • AttackGroup
  • AttackGroupConditionException
  • Eval
  • EvalRuleConditionException
  • CustomDeny
  • CustomRule
  • CustomRuleAction
  • IPGeoFirewall
  • MatchTarget
  • PenaltyBox
  • RatePolicy
  • RatePolicyAction
  • ReputationProfile
  • ReputationProfileAction
  • Rule
  • RuleConditionException
  • SecurityPolicy
  • SiemSettings
  • SlowPost
configId number
. Unique identifier of the security configuration you want to return information for.
version number
. Version number of the security configuration.
searches string[]

. JSON array of strings specifying the types of information to be retrieved. Allowed values include:

  • AdvancedSettingsLogging
  • AdvancedSettingsPrefetch
  • ApiRequestConstraints
  • AttackGroup
  • AttackGroupConditionException
  • Eval
  • EvalRuleConditionException
  • CustomDeny
  • CustomRule
  • CustomRuleAction
  • IPGeoFirewall
  • MatchTarget
  • PenaltyBox
  • RatePolicy
  • RatePolicyAction
  • ReputationProfile
  • ReputationProfileAction
  • Rule
  • RuleConditionException
  • SecurityPolicy
  • SiemSettings
  • SlowPost
config_id int
. Unique identifier of the security configuration you want to return information for.
version int
. Version number of the security configuration.
searches Sequence[str]

. JSON array of strings specifying the types of information to be retrieved. Allowed values include:

  • AdvancedSettingsLogging
  • AdvancedSettingsPrefetch
  • ApiRequestConstraints
  • AttackGroup
  • AttackGroupConditionException
  • Eval
  • EvalRuleConditionException
  • CustomDeny
  • CustomRule
  • CustomRuleAction
  • IPGeoFirewall
  • MatchTarget
  • PenaltyBox
  • RatePolicy
  • RatePolicyAction
  • ReputationProfile
  • ReputationProfileAction
  • Rule
  • RuleConditionException
  • SecurityPolicy
  • SiemSettings
  • SlowPost

getAppSecExportConfiguration Result

The following output properties are available:

ConfigId int
Id string
The provider-assigned unique ID for this managed resource.
Json string
OutputText string
Version int
Searches List<string>
ConfigId int
Id string
The provider-assigned unique ID for this managed resource.
Json string
OutputText string
Version int
Searches []string
configId number
id string
The provider-assigned unique ID for this managed resource.
json string
outputText string
version number
searches string[]
config_id int
id str
The provider-assigned unique ID for this managed resource.
json str
output_text str
version int
searches Sequence[str]

Package Details

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