Akamai

v3.1.1 published on Tuesday, Nov 1, 2022 by Pulumi

getAppSecBypassNetworkLists

Scopes: Security configuration

Returns information about the network lists assigned to the bypass network list; networks on this list are not subject to firewall checking.

Note that this data source is only applicable to WAP (Web Application Protector) configurations.

Related API Endpoint:/appsec/v1/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/bypass-network-lists

Output Options

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

  • bypass_network_list. List of network IDs.
  • json. JSON-formatted list of information about the bypass networks.
  • output_text. Tabular report showing the bypass network list information.

Example Usage

Basic 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 bypassNetworkLists = configuration.Apply(configuration => Output.Create(Akamai.GetAppSecBypassNetworkLists.InvokeAsync(new Akamai.GetAppSecBypassNetworkListsArgs
        {
            ConfigId = configuration.ConfigId,
            SecurityPolicyId = "gms1_134637",
        })));
        this.BypassNetworkListsOutput = bypassNetworkLists.Apply(bypassNetworkLists => bypassNetworkLists.OutputText);
        this.BypassNetworkListsJson = bypassNetworkLists.Apply(bypassNetworkLists => bypassNetworkLists.Json);
        this.BypassNetworkListsIdList = bypassNetworkLists.Apply(bypassNetworkLists => bypassNetworkLists.BypassNetworkLists);
    }

    [Output("bypassNetworkListsOutput")]
    public Output<string> BypassNetworkListsOutput { get; set; }
    [Output("bypassNetworkListsJson")]
    public Output<string> BypassNetworkListsJson { get; set; }
    [Output("bypassNetworkListsIdList")]
    public Output<string> BypassNetworkListsIdList { get; set; }
}
package main

import (
	"github.com/pulumi/pulumi-akamai/sdk/v3/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
		}
		bypassNetworkLists, err := akamai.GetAppSecBypassNetworkLists(ctx, &GetAppSecBypassNetworkListsArgs{
			ConfigId:         configuration.ConfigId,
			SecurityPolicyId: "gms1_134637",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("bypassNetworkListsOutput", bypassNetworkLists.OutputText)
		ctx.Export("bypassNetworkListsJson", bypassNetworkLists.Json)
		ctx.Export("bypassNetworkListsIdList", bypassNetworkLists.BypassNetworkLists)
		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.GetAppSecBypassNetworkListsArgs;
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 bypassNetworkLists = AkamaiFunctions.getAppSecBypassNetworkLists(GetAppSecBypassNetworkListsArgs.builder()
            .configId(configuration.applyValue(getAppSecConfigurationResult -> getAppSecConfigurationResult.configId()))
            .securityPolicyId("gms1_134637")
            .build());

        ctx.export("bypassNetworkListsOutput", bypassNetworkLists.applyValue(getAppSecBypassNetworkListsResult -> getAppSecBypassNetworkListsResult.outputText()));
        ctx.export("bypassNetworkListsJson", bypassNetworkLists.applyValue(getAppSecBypassNetworkListsResult -> getAppSecBypassNetworkListsResult.json()));
        ctx.export("bypassNetworkListsIdList", bypassNetworkLists.applyValue(getAppSecBypassNetworkListsResult -> getAppSecBypassNetworkListsResult.bypassNetworkLists()));
    }
}
import pulumi
import pulumi_akamai as akamai

configuration = akamai.get_app_sec_configuration(name="Documentation")
bypass_network_lists = akamai.get_app_sec_bypass_network_lists(config_id=configuration.config_id,
    security_policy_id="gms1_134637")
pulumi.export("bypassNetworkListsOutput", bypass_network_lists.output_text)
pulumi.export("bypassNetworkListsJson", bypass_network_lists.json)
pulumi.export("bypassNetworkListsIdList", bypass_network_lists.bypass_network_lists)
import * as pulumi from "@pulumi/pulumi";
import * as akamai from "@pulumi/akamai";

const configuration = akamai.getAppSecConfiguration({
    name: "Documentation",
});
const bypassNetworkLists = configuration.then(configuration => akamai.getAppSecBypassNetworkLists({
    configId: configuration.configId,
    securityPolicyId: "gms1_134637",
}));
export const bypassNetworkListsOutput = bypassNetworkLists.then(bypassNetworkLists => bypassNetworkLists.outputText);
export const bypassNetworkListsJson = bypassNetworkLists.then(bypassNetworkLists => bypassNetworkLists.json);
export const bypassNetworkListsIdList = bypassNetworkLists.then(bypassNetworkLists => bypassNetworkLists.bypassNetworkLists);
variables:
  configuration:
    Fn::Invoke:
      Function: akamai:getAppSecConfiguration
      Arguments:
        name: Documentation
  bypassNetworkLists: # USE CASE: User wants to display returned data in a table.
    Fn::Invoke:
      Function: akamai:getAppSecBypassNetworkLists
      Arguments:
        configId: ${configuration.configId}
        securityPolicyId: gms1_134637
outputs:
  bypassNetworkListsOutput: ${bypassNetworkLists.outputText}
  bypassNetworkListsJson: ${bypassNetworkLists.json}
  bypassNetworkListsIdList: ${bypassNetworkLists.bypassNetworkLists}

Using getAppSecBypassNetworkLists

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 getAppSecBypassNetworkLists(args: GetAppSecBypassNetworkListsArgs, opts?: InvokeOptions): Promise<GetAppSecBypassNetworkListsResult>
function getAppSecBypassNetworkListsOutput(args: GetAppSecBypassNetworkListsOutputArgs, opts?: InvokeOptions): Output<GetAppSecBypassNetworkListsResult>
def get_app_sec_bypass_network_lists(config_id: Optional[int] = None,
                                     security_policy_id: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetAppSecBypassNetworkListsResult
def get_app_sec_bypass_network_lists_output(config_id: Optional[pulumi.Input[int]] = None,
                                     security_policy_id: Optional[pulumi.Input[str]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[GetAppSecBypassNetworkListsResult]
func GetAppSecBypassNetworkLists(ctx *Context, args *GetAppSecBypassNetworkListsArgs, opts ...InvokeOption) (*GetAppSecBypassNetworkListsResult, error)
func GetAppSecBypassNetworkListsOutput(ctx *Context, args *GetAppSecBypassNetworkListsOutputArgs, opts ...InvokeOption) GetAppSecBypassNetworkListsResultOutput

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

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

The following arguments are supported:

ConfigId int

. Unique identifier of the security configuration associated with the bypass network lists.

SecurityPolicyId string

. Unique identifier of the security policy associated with the bypass network lists.

ConfigId int

. Unique identifier of the security configuration associated with the bypass network lists.

SecurityPolicyId string

. Unique identifier of the security policy associated with the bypass network lists.

configId Integer

. Unique identifier of the security configuration associated with the bypass network lists.

securityPolicyId String

. Unique identifier of the security policy associated with the bypass network lists.

configId number

. Unique identifier of the security configuration associated with the bypass network lists.

securityPolicyId string

. Unique identifier of the security policy associated with the bypass network lists.

config_id int

. Unique identifier of the security configuration associated with the bypass network lists.

security_policy_id str

. Unique identifier of the security policy associated with the bypass network lists.

configId Number

. Unique identifier of the security configuration associated with the bypass network lists.

securityPolicyId String

. Unique identifier of the security policy associated with the bypass network lists.

getAppSecBypassNetworkLists Result

The following output properties are available:

BypassNetworkLists List<string>
ConfigId int
Id string

The provider-assigned unique ID for this managed resource.

Json string
OutputText string
SecurityPolicyId string
BypassNetworkLists []string
ConfigId int
Id string

The provider-assigned unique ID for this managed resource.

Json string
OutputText string
SecurityPolicyId string
bypassNetworkLists List<String>
configId Integer
id String

The provider-assigned unique ID for this managed resource.

json String
outputText String
securityPolicyId String
bypassNetworkLists string[]
configId number
id string

The provider-assigned unique ID for this managed resource.

json string
outputText string
securityPolicyId string
bypass_network_lists Sequence[str]
config_id int
id str

The provider-assigned unique ID for this managed resource.

json str
output_text str
security_policy_id str
bypassNetworkLists List<String>
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.