← All packages

Akamai

Pulumi Official

Package maintained by Pulumi

v2.9.0 published on Wednesday, Apr 6, 2022 by Pulumi

Source code

AppSecSiemSettings

Scopes: Security configuration

Modifies SIEM (Security Information and Event Management) integration settings for a security configuration.

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

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 updated SIEM integration settings.

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 siemDefinition = Output.Create(Akamai.GetAppSecSiemDefinitions.InvokeAsync(new Akamai.GetAppSecSiemDefinitionsArgs
        {
            SiemDefinitionName = "SIEM Version 01",
        }));
        var securityPolicies = configuration.Apply(configuration => Output.Create(Akamai.GetAppSecSecurityPolicy.InvokeAsync(new Akamai.GetAppSecSecurityPolicyArgs
        {
            ConfigId = configuration.ConfigId,
        })));
        var siem = new Akamai.AppSecSiemSettings("siem", new Akamai.AppSecSiemSettingsArgs
        {
            ConfigId = configuration.Apply(configuration => configuration.ConfigId),
            EnableSiem = true,
            EnableForAllPolicies = false,
            EnableBotmanSiem = true,
            SiemId = siemDefinition.Apply(siemDefinition => siemDefinition.Id),
            SecurityPolicyIds = securityPolicies.Apply(securityPolicies => securityPolicies.SecurityPolicyIdLists),
        });
    }

}

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 {
		configuration, err := akamai.LookupAppSecConfiguration(ctx, &GetAppSecConfigurationArgs{
			Name: pulumi.StringRef("Documentation"),
		}, nil)
		if err != nil {
			return err
		}
		siemDefinition, err := akamai.GetAppSecSiemDefinitions(ctx, &GetAppSecSiemDefinitionsArgs{
			SiemDefinitionName: pulumi.StringRef("SIEM Version 01"),
		}, nil)
		if err != nil {
			return err
		}
		securityPolicies, err := akamai.LookupAppSecSecurityPolicy(ctx, &GetAppSecSecurityPolicyArgs{
			ConfigId: configuration.ConfigId,
		}, nil)
		if err != nil {
			return err
		}
		_, err = akamai.NewAppSecSiemSettings(ctx, "siem", &akamai.AppSecSiemSettingsArgs{
			ConfigId:             pulumi.Int(configuration.ConfigId),
			EnableSiem:           pulumi.Bool(true),
			EnableForAllPolicies: pulumi.Bool(false),
			EnableBotmanSiem:     pulumi.Bool(true),
			SiemId:               pulumi.String(siemDefinition.Id),
			SecurityPolicyIds:    interface{}(securityPolicies.SecurityPolicyIdLists),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_akamai as akamai

configuration = akamai.get_app_sec_configuration(name="Documentation")
siem_definition = akamai.get_app_sec_siem_definitions(siem_definition_name="SIEM Version 01")
security_policies = akamai.get_app_sec_security_policy(config_id=configuration.config_id)
siem = akamai.AppSecSiemSettings("siem",
    config_id=configuration.config_id,
    enable_siem=True,
    enable_for_all_policies=False,
    enable_botman_siem=True,
    siem_id=siem_definition.id,
    security_policy_ids=security_policies.security_policy_id_lists)

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

const configuration = akamai.getAppSecConfiguration({
    name: "Documentation",
});
const siemDefinition = akamai.getAppSecSiemDefinitions({
    siemDefinitionName: "SIEM Version 01",
});
const securityPolicies = configuration.then(configuration => akamai.getAppSecSecurityPolicy({
    configId: configuration.configId,
}));
const siem = new akamai.AppSecSiemSettings("siem", {
    configId: configuration.then(configuration => configuration.configId),
    enableSiem: true,
    enableForAllPolicies: false,
    enableBotmanSiem: true,
    siemId: siemDefinition.then(siemDefinition => siemDefinition.id),
    securityPolicyIds: securityPolicies.then(securityPolicies => securityPolicies.securityPolicyIdLists),
});

Coming soon!

Create a AppSecSiemSettings Resource

new AppSecSiemSettings(name: string, args: AppSecSiemSettingsArgs, opts?: CustomResourceOptions);

@overload
def AppSecSiemSettings(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       config_id: Optional[int] = None,
                       enable_botman_siem: Optional[bool] = None,
                       enable_for_all_policies: Optional[bool] = None,
                       enable_siem: Optional[bool] = None,
                       security_policy_ids: Optional[Sequence[str]] = None,
                       siem_id: Optional[int] = None)
@overload
def AppSecSiemSettings(resource_name: str,
                       args: AppSecSiemSettingsArgs,
                       opts: Optional[ResourceOptions] = None)

func NewAppSecSiemSettings(ctx *Context, name string, args AppSecSiemSettingsArgs, opts ...ResourceOption) (*AppSecSiemSettings, error)

public AppSecSiemSettings(string name, AppSecSiemSettingsArgs args, CustomResourceOptions? opts = null)

public AppSecSiemSettings(String name, AppSecSiemSettingsArgs args)
public AppSecSiemSettings(String name, AppSecSiemSettingsArgs args, CustomResourceOptions options)

type: akamai:AppSecSiemSettings
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AppSecSiemSettingsArgs: 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 AppSecSiemSettingsArgs: 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 AppSecSiemSettingsArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AppSecSiemSettingsArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args AppSecSiemSettingsArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

AppSecSiemSettings 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 AppSecSiemSettings resource accepts the following input properties:

ConfigId int: . Unique identifier of the security configuration associated with the SIEM settings being modified.
EnableBotmanSiem bool: . Set to true to include Bot Manager events in your SIEM events; set to false to exclude Bot Manager events from your SIEM events.
EnableForAllPolicies bool: . Set to true to enable SIEM on all security policies in the security configuration; set to false to only enable SIEM on the security policies specified by the security_policy_ids argument.
EnableSiem bool: . Set to true to enable SIEM; set to false to disable SIEM.
SiemId int: . Unique identifier of the SIEM settings being modified.
SecurityPolicyIds List<string>: JSON array of IDs for the security policies where SIEM integration is to be enabled.

ConfigId int: . Unique identifier of the security configuration associated with the SIEM settings being modified.
EnableBotmanSiem bool: . Set to true to include Bot Manager events in your SIEM events; set to false to exclude Bot Manager events from your SIEM events.
EnableForAllPolicies bool: . Set to true to enable SIEM on all security policies in the security configuration; set to false to only enable SIEM on the security policies specified by the security_policy_ids argument.
EnableSiem bool: . Set to true to enable SIEM; set to false to disable SIEM.
SiemId int: . Unique identifier of the SIEM settings being modified.
SecurityPolicyIds []string: JSON array of IDs for the security policies where SIEM integration is to be enabled.

configId Integer: . Unique identifier of the security configuration associated with the SIEM settings being modified.
enableBotmanSiem Boolean: . Set to true to include Bot Manager events in your SIEM events; set to false to exclude Bot Manager events from your SIEM events.
enableForAllPolicies Boolean: . Set to true to enable SIEM on all security policies in the security configuration; set to false to only enable SIEM on the security policies specified by the security_policy_ids argument.
enableSiem Boolean: . Set to true to enable SIEM; set to false to disable SIEM.
siemId Integer: . Unique identifier of the SIEM settings being modified.
securityPolicyIds List: JSON array of IDs for the security policies where SIEM integration is to be enabled.

configId number: . Unique identifier of the security configuration associated with the SIEM settings being modified.
enableBotmanSiem boolean: . Set to true to include Bot Manager events in your SIEM events; set to false to exclude Bot Manager events from your SIEM events.
enableForAllPolicies boolean: . Set to true to enable SIEM on all security policies in the security configuration; set to false to only enable SIEM on the security policies specified by the security_policy_ids argument.
enableSiem boolean: . Set to true to enable SIEM; set to false to disable SIEM.
siemId number: . Unique identifier of the SIEM settings being modified.
securityPolicyIds string[]: JSON array of IDs for the security policies where SIEM integration is to be enabled.

config_id int: . Unique identifier of the security configuration associated with the SIEM settings being modified.
enable_botman_siem bool: . Set to true to include Bot Manager events in your SIEM events; set to false to exclude Bot Manager events from your SIEM events.
enable_for_all_policies bool: . Set to true to enable SIEM on all security policies in the security configuration; set to false to only enable SIEM on the security policies specified by the security_policy_ids argument.
enable_siem bool: . Set to true to enable SIEM; set to false to disable SIEM.
siem_id int: . Unique identifier of the SIEM settings being modified.
security_policy_ids Sequence[str]: JSON array of IDs for the security policies where SIEM integration is to be enabled.

configId Number: . Unique identifier of the security configuration associated with the SIEM settings being modified.
enableBotmanSiem Boolean: . Set to true to include Bot Manager events in your SIEM events; set to false to exclude Bot Manager events from your SIEM events.
enableForAllPolicies Boolean: . Set to true to enable SIEM on all security policies in the security configuration; set to false to only enable SIEM on the security policies specified by the security_policy_ids argument.
enableSiem Boolean: . Set to true to enable SIEM; set to false to disable SIEM.
siemId Number: . Unique identifier of the SIEM settings being modified.
securityPolicyIds List: JSON array of IDs for the security policies where SIEM integration is to be enabled.

Outputs

All input properties are implicitly available as output properties. Additionally, the AppSecSiemSettings 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 AppSecSiemSettings Resource

Get an existing AppSecSiemSettings 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?: AppSecSiemSettingsState, opts?: CustomResourceOptions): AppSecSiemSettings

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config_id: Optional[int] = None,
        enable_botman_siem: Optional[bool] = None,
        enable_for_all_policies: Optional[bool] = None,
        enable_siem: Optional[bool] = None,
        security_policy_ids: Optional[Sequence[str]] = None,
        siem_id: Optional[int] = None) -> AppSecSiemSettings

func GetAppSecSiemSettings(ctx *Context, name string, id IDInput, state *AppSecSiemSettingsState, opts ...ResourceOption) (*AppSecSiemSettings, error)

public static AppSecSiemSettings Get(string name, Input<string> id, AppSecSiemSettingsState? state, CustomResourceOptions? opts = null)

public static AppSecSiemSettings get(String name, Output<String> id, AppSecSiemSettingsState 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 associated with the SIEM settings being modified.
EnableBotmanSiem bool: . Set to true to include Bot Manager events in your SIEM events; set to false to exclude Bot Manager events from your SIEM events.
EnableForAllPolicies bool: . Set to true to enable SIEM on all security policies in the security configuration; set to false to only enable SIEM on the security policies specified by the security_policy_ids argument.
EnableSiem bool: . Set to true to enable SIEM; set to false to disable SIEM.
SecurityPolicyIds List<string>: JSON array of IDs for the security policies where SIEM integration is to be enabled.
SiemId int: . Unique identifier of the SIEM settings being modified.

ConfigId int: . Unique identifier of the security configuration associated with the SIEM settings being modified.
EnableBotmanSiem bool: . Set to true to include Bot Manager events in your SIEM events; set to false to exclude Bot Manager events from your SIEM events.
EnableForAllPolicies bool: . Set to true to enable SIEM on all security policies in the security configuration; set to false to only enable SIEM on the security policies specified by the security_policy_ids argument.
EnableSiem bool: . Set to true to enable SIEM; set to false to disable SIEM.
SecurityPolicyIds []string: JSON array of IDs for the security policies where SIEM integration is to be enabled.
SiemId int: . Unique identifier of the SIEM settings being modified.

configId Integer: . Unique identifier of the security configuration associated with the SIEM settings being modified.
enableBotmanSiem Boolean: . Set to true to include Bot Manager events in your SIEM events; set to false to exclude Bot Manager events from your SIEM events.
enableForAllPolicies Boolean: . Set to true to enable SIEM on all security policies in the security configuration; set to false to only enable SIEM on the security policies specified by the security_policy_ids argument.
enableSiem Boolean: . Set to true to enable SIEM; set to false to disable SIEM.
securityPolicyIds List: JSON array of IDs for the security policies where SIEM integration is to be enabled.
siemId Integer: . Unique identifier of the SIEM settings being modified.

configId number: . Unique identifier of the security configuration associated with the SIEM settings being modified.
enableBotmanSiem boolean: . Set to true to include Bot Manager events in your SIEM events; set to false to exclude Bot Manager events from your SIEM events.
enableForAllPolicies boolean: . Set to true to enable SIEM on all security policies in the security configuration; set to false to only enable SIEM on the security policies specified by the security_policy_ids argument.
enableSiem boolean: . Set to true to enable SIEM; set to false to disable SIEM.
securityPolicyIds string[]: JSON array of IDs for the security policies where SIEM integration is to be enabled.
siemId number: . Unique identifier of the SIEM settings being modified.

config_id int: . Unique identifier of the security configuration associated with the SIEM settings being modified.
enable_botman_siem bool: . Set to true to include Bot Manager events in your SIEM events; set to false to exclude Bot Manager events from your SIEM events.
enable_for_all_policies bool: . Set to true to enable SIEM on all security policies in the security configuration; set to false to only enable SIEM on the security policies specified by the security_policy_ids argument.
enable_siem bool: . Set to true to enable SIEM; set to false to disable SIEM.
security_policy_ids Sequence[str]: JSON array of IDs for the security policies where SIEM integration is to be enabled.
siem_id int: . Unique identifier of the SIEM settings being modified.

configId Number: . Unique identifier of the security configuration associated with the SIEM settings being modified.
enableBotmanSiem Boolean: . Set to true to include Bot Manager events in your SIEM events; set to false to exclude Bot Manager events from your SIEM events.
enableForAllPolicies Boolean: . Set to true to enable SIEM on all security policies in the security configuration; set to false to only enable SIEM on the security policies specified by the security_policy_ids argument.
enableSiem Boolean: . Set to true to enable SIEM; set to false to disable SIEM.
securityPolicyIds List: JSON array of IDs for the security policies where SIEM integration is to be enabled.
siemId Number: . Unique identifier of the SIEM settings being modified.

Package Details

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