Akamai

v3.0.0 published on Monday, Jul 25, 2022 by Pulumi

AppSecAdvancedSettingsLogging

Scopes: Security configuration; security policy

Enables, disables, or updates HTTP header logging settings. By default, this operation applies at the configuration level, which means that it applies to all the security policies within that configuration. However, by using the security_policy_id parameter you can specify custom settings for an individual security policy.

Related API Endpoint: /appsec/v1/configs/{configId}/versions/{versionNumber}/advanced-settings/logging

Example Usage

using System.IO;
using Pulumi;
using Akamai = Pulumi.Akamai;

class MyStack : Stack
{
    public MyStack()
    {
        var configuration = Output.Create(Akamai.GetAppSecConfiguration.InvokeAsync(new Akamai.GetAppSecConfigurationArgs
        {
            Name = "Documentation",
        }));
        var logging = new Akamai.AppSecAdvancedSettingsLogging("logging", new Akamai.AppSecAdvancedSettingsLoggingArgs
        {
            ConfigId = configuration.Apply(configuration => configuration.ConfigId),
            Logging = File.ReadAllText($"{path.Module}/logging.json"),
        });
        // USE CASE: User wants to configure logging settings for a security policy.
        var policyLogging = new Akamai.AppSecAdvancedSettingsLogging("policyLogging", new Akamai.AppSecAdvancedSettingsLoggingArgs
        {
            ConfigId = configuration.Apply(configuration => configuration.ConfigId),
            SecurityPolicyId = "gms1_134637",
            Logging = File.ReadAllText($"{path.Module}/logging.json"),
        });
    }

}
package main

import (
	"fmt"
	"io/ioutil"

	"github.com/pulumi/pulumi-akamai/sdk/v3/go/akamai"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func readFileOrPanic(path string) pulumi.StringPtrInput {
	data, err := ioutil.ReadFile(path)
	if err != nil {
		panic(err.Error())
	}
	return pulumi.String(string(data))
}

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
		}
		_, err = akamai.NewAppSecAdvancedSettingsLogging(ctx, "logging", &akamai.AppSecAdvancedSettingsLoggingArgs{
			ConfigId: pulumi.Int(configuration.ConfigId),
			Logging:  readFileOrPanic(fmt.Sprintf("%v/logging.json", path.Module)),
		})
		if err != nil {
			return err
		}
		_, err = akamai.NewAppSecAdvancedSettingsLogging(ctx, "policyLogging", &akamai.AppSecAdvancedSettingsLoggingArgs{
			ConfigId:         pulumi.Int(configuration.ConfigId),
			SecurityPolicyId: pulumi.String("gms1_134637"),
			Logging:          readFileOrPanic(fmt.Sprintf("%v/logging.json", path.Module)),
		})
		if err != nil {
			return err
		}
		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.AppSecAdvancedSettingsLogging;
import com.pulumi.akamai.AppSecAdvancedSettingsLoggingArgs;
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());

        var logging = new AppSecAdvancedSettingsLogging("logging", AppSecAdvancedSettingsLoggingArgs.builder()        
            .configId(configuration.applyValue(getAppSecConfigurationResult -> getAppSecConfigurationResult.configId()))
            .logging(Files.readString(Paths.get(String.format("%s/logging.json", path.module()))))
            .build());

        var policyLogging = new AppSecAdvancedSettingsLogging("policyLogging", AppSecAdvancedSettingsLoggingArgs.builder()        
            .configId(configuration.applyValue(getAppSecConfigurationResult -> getAppSecConfigurationResult.configId()))
            .securityPolicyId("gms1_134637")
            .logging(Files.readString(Paths.get(String.format("%s/logging.json", path.module()))))
            .build());

    }
}
import pulumi
import pulumi_akamai as akamai

configuration = akamai.get_app_sec_configuration(name="Documentation")
logging = akamai.AppSecAdvancedSettingsLogging("logging",
    config_id=configuration.config_id,
    logging=(lambda path: open(path).read())(f"{path['module']}/logging.json"))
# USE CASE: User wants to configure logging settings for a security policy.
policy_logging = akamai.AppSecAdvancedSettingsLogging("policyLogging",
    config_id=configuration.config_id,
    security_policy_id="gms1_134637",
    logging=(lambda path: open(path).read())(f"{path['module']}/logging.json"))
import * as pulumi from "@pulumi/pulumi";
import * as akamai from "@pulumi/akamai";
import * as fs from "fs";

const configuration = akamai.getAppSecConfiguration({
    name: "Documentation",
});
const logging = new akamai.AppSecAdvancedSettingsLogging("logging", {
    configId: configuration.then(configuration => configuration.configId),
    logging: fs.readFileSync(`${path.module}/logging.json`),
});
// USE CASE: User wants to configure logging settings for a security policy.
const policyLogging = new akamai.AppSecAdvancedSettingsLogging("policyLogging", {
    configId: configuration.then(configuration => configuration.configId),
    securityPolicyId: "gms1_134637",
    logging: fs.readFileSync(`${path.module}/logging.json`),
});

Coming soon!

Create a AppSecAdvancedSettingsLogging Resource

new AppSecAdvancedSettingsLogging(name: string, args: AppSecAdvancedSettingsLoggingArgs, opts?: CustomResourceOptions);
@overload
def AppSecAdvancedSettingsLogging(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  config_id: Optional[int] = None,
                                  logging: Optional[str] = None,
                                  security_policy_id: Optional[str] = None)
@overload
def AppSecAdvancedSettingsLogging(resource_name: str,
                                  args: AppSecAdvancedSettingsLoggingArgs,
                                  opts: Optional[ResourceOptions] = None)
func NewAppSecAdvancedSettingsLogging(ctx *Context, name string, args AppSecAdvancedSettingsLoggingArgs, opts ...ResourceOption) (*AppSecAdvancedSettingsLogging, error)
public AppSecAdvancedSettingsLogging(string name, AppSecAdvancedSettingsLoggingArgs args, CustomResourceOptions? opts = null)
public AppSecAdvancedSettingsLogging(String name, AppSecAdvancedSettingsLoggingArgs args)
public AppSecAdvancedSettingsLogging(String name, AppSecAdvancedSettingsLoggingArgs args, CustomResourceOptions options)
type: akamai:AppSecAdvancedSettingsLogging
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args AppSecAdvancedSettingsLoggingArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args AppSecAdvancedSettingsLoggingArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args AppSecAdvancedSettingsLoggingArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args AppSecAdvancedSettingsLoggingArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args AppSecAdvancedSettingsLoggingArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

AppSecAdvancedSettingsLogging Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The AppSecAdvancedSettingsLogging resource accepts the following input properties:

ConfigId int

. Unique identifier of the security configuration containing the logging settings being modified.

Logging string

. Path to a JSON file containing the logging settings to be configured. A sample JSON file can be found in the Modify HTTP header log settings for a configuration section of the Application Security API documentation.

SecurityPolicyId string

. Unique identifier of the security policies whose settings are being modified. If not included, the logging settings are modified at the configuration scope and, as a result, apply to all the security policies associated with the configuration.

ConfigId int

. Unique identifier of the security configuration containing the logging settings being modified.

Logging string

. Path to a JSON file containing the logging settings to be configured. A sample JSON file can be found in the Modify HTTP header log settings for a configuration section of the Application Security API documentation.

SecurityPolicyId string

. Unique identifier of the security policies whose settings are being modified. If not included, the logging settings are modified at the configuration scope and, as a result, apply to all the security policies associated with the configuration.

configId Integer

. Unique identifier of the security configuration containing the logging settings being modified.

logging String

. Path to a JSON file containing the logging settings to be configured. A sample JSON file can be found in the Modify HTTP header log settings for a configuration section of the Application Security API documentation.

securityPolicyId String

. Unique identifier of the security policies whose settings are being modified. If not included, the logging settings are modified at the configuration scope and, as a result, apply to all the security policies associated with the configuration.

configId number

. Unique identifier of the security configuration containing the logging settings being modified.

logging string

. Path to a JSON file containing the logging settings to be configured. A sample JSON file can be found in the Modify HTTP header log settings for a configuration section of the Application Security API documentation.

securityPolicyId string

. Unique identifier of the security policies whose settings are being modified. If not included, the logging settings are modified at the configuration scope and, as a result, apply to all the security policies associated with the configuration.

config_id int

. Unique identifier of the security configuration containing the logging settings being modified.

logging str

. Path to a JSON file containing the logging settings to be configured. A sample JSON file can be found in the Modify HTTP header log settings for a configuration section of the Application Security API documentation.

security_policy_id str

. Unique identifier of the security policies whose settings are being modified. If not included, the logging settings are modified at the configuration scope and, as a result, apply to all the security policies associated with the configuration.

configId Number

. Unique identifier of the security configuration containing the logging settings being modified.

logging String

. Path to a JSON file containing the logging settings to be configured. A sample JSON file can be found in the Modify HTTP header log settings for a configuration section of the Application Security API documentation.

securityPolicyId String

. Unique identifier of the security policies whose settings are being modified. If not included, the logging settings are modified at the configuration scope and, as a result, apply to all the security policies associated with the configuration.

Outputs

All input properties are implicitly available as output properties. Additionally, the AppSecAdvancedSettingsLogging resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

Id string

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

id string

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

Look up an Existing AppSecAdvancedSettingsLogging Resource

Get an existing AppSecAdvancedSettingsLogging resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: AppSecAdvancedSettingsLoggingState, opts?: CustomResourceOptions): AppSecAdvancedSettingsLogging
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config_id: Optional[int] = None,
        logging: Optional[str] = None,
        security_policy_id: Optional[str] = None) -> AppSecAdvancedSettingsLogging
func GetAppSecAdvancedSettingsLogging(ctx *Context, name string, id IDInput, state *AppSecAdvancedSettingsLoggingState, opts ...ResourceOption) (*AppSecAdvancedSettingsLogging, error)
public static AppSecAdvancedSettingsLogging Get(string name, Input<string> id, AppSecAdvancedSettingsLoggingState? state, CustomResourceOptions? opts = null)
public static AppSecAdvancedSettingsLogging get(String name, Output<String> id, AppSecAdvancedSettingsLoggingState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
ConfigId int

. Unique identifier of the security configuration containing the logging settings being modified.

Logging string

. Path to a JSON file containing the logging settings to be configured. A sample JSON file can be found in the Modify HTTP header log settings for a configuration section of the Application Security API documentation.

SecurityPolicyId string

. Unique identifier of the security policies whose settings are being modified. If not included, the logging settings are modified at the configuration scope and, as a result, apply to all the security policies associated with the configuration.

ConfigId int

. Unique identifier of the security configuration containing the logging settings being modified.

Logging string

. Path to a JSON file containing the logging settings to be configured. A sample JSON file can be found in the Modify HTTP header log settings for a configuration section of the Application Security API documentation.

SecurityPolicyId string

. Unique identifier of the security policies whose settings are being modified. If not included, the logging settings are modified at the configuration scope and, as a result, apply to all the security policies associated with the configuration.

configId Integer

. Unique identifier of the security configuration containing the logging settings being modified.

logging String

. Path to a JSON file containing the logging settings to be configured. A sample JSON file can be found in the Modify HTTP header log settings for a configuration section of the Application Security API documentation.

securityPolicyId String

. Unique identifier of the security policies whose settings are being modified. If not included, the logging settings are modified at the configuration scope and, as a result, apply to all the security policies associated with the configuration.

configId number

. Unique identifier of the security configuration containing the logging settings being modified.

logging string

. Path to a JSON file containing the logging settings to be configured. A sample JSON file can be found in the Modify HTTP header log settings for a configuration section of the Application Security API documentation.

securityPolicyId string

. Unique identifier of the security policies whose settings are being modified. If not included, the logging settings are modified at the configuration scope and, as a result, apply to all the security policies associated with the configuration.

config_id int

. Unique identifier of the security configuration containing the logging settings being modified.

logging str

. Path to a JSON file containing the logging settings to be configured. A sample JSON file can be found in the Modify HTTP header log settings for a configuration section of the Application Security API documentation.

security_policy_id str

. Unique identifier of the security policies whose settings are being modified. If not included, the logging settings are modified at the configuration scope and, as a result, apply to all the security policies associated with the configuration.

configId Number

. Unique identifier of the security configuration containing the logging settings being modified.

logging String

. Path to a JSON file containing the logging settings to be configured. A sample JSON file can be found in the Modify HTTP header log settings for a configuration section of the Application Security API documentation.

securityPolicyId String

. Unique identifier of the security policies whose settings are being modified. If not included, the logging settings are modified at the configuration scope and, as a result, apply to all the security policies associated with the configuration.

Package Details

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

This Pulumi package is based on the akamai Terraform Provider.