akamai.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
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 siemDefinition = Akamai.GetAppSecSiemDefinitions.Invoke(new()
{
SiemDefinitionName = "SIEM Version 01",
});
var securityPolicies = Akamai.GetAppSecSecurityPolicy.Invoke(new()
{
ConfigId = configuration.Apply(getAppSecConfigurationResult => getAppSecConfigurationResult.ConfigId),
});
var siem = new Akamai.AppSecSiemSettings("siem", new()
{
ConfigId = configuration.Apply(getAppSecConfigurationResult => getAppSecConfigurationResult.ConfigId),
EnableSiem = true,
EnableForAllPolicies = false,
EnableBotmanSiem = true,
SiemId = siemDefinition.Apply(getAppSecSiemDefinitionsResult => getAppSecSiemDefinitionsResult.Id),
SecurityPolicyIds = securityPolicies.Apply(getAppSecSecurityPolicyResult => getAppSecSecurityPolicyResult.SecurityPolicyIdLists),
});
});
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
}
siemDefinition, err := akamai.GetAppSecSiemDefinitions(ctx, &akamai.GetAppSecSiemDefinitionsArgs{
SiemDefinitionName: pulumi.StringRef("SIEM Version 01"),
}, nil)
if err != nil {
return err
}
securityPolicies, err := akamai.LookupAppSecSecurityPolicy(ctx, &akamai.LookupAppSecSecurityPolicyArgs{
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
})
}
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.GetAppSecSiemDefinitionsArgs;
import com.pulumi.akamai.inputs.GetAppSecSecurityPolicyArgs;
import com.pulumi.akamai.AppSecSiemSettings;
import com.pulumi.akamai.AppSecSiemSettingsArgs;
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 siemDefinition = AkamaiFunctions.getAppSecSiemDefinitions(GetAppSecSiemDefinitionsArgs.builder()
.siemDefinitionName("SIEM Version 01")
.build());
final var securityPolicies = AkamaiFunctions.getAppSecSecurityPolicy(GetAppSecSecurityPolicyArgs.builder()
.configId(configuration.applyValue(getAppSecConfigurationResult -> getAppSecConfigurationResult.configId()))
.build());
var siem = new AppSecSiemSettings("siem", AppSecSiemSettingsArgs.builder()
.configId(configuration.applyValue(getAppSecConfigurationResult -> getAppSecConfigurationResult.configId()))
.enableSiem(true)
.enableForAllPolicies(false)
.enableBotmanSiem(true)
.siemId(siemDefinition.applyValue(getAppSecSiemDefinitionsResult -> getAppSecSiemDefinitionsResult.id()))
.securityPolicyIds(securityPolicies.applyValue(getAppSecSecurityPolicyResult -> getAppSecSecurityPolicyResult.securityPolicyIdLists()))
.build());
}
}
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),
});
resources:
siem:
type: akamai:AppSecSiemSettings
properties:
configId: ${configuration.configId}
enableSiem: true
enableForAllPolicies: false
enableBotmanSiem: true
siemId: ${siemDefinition.id}
securityPolicyIds: ${securityPolicies.securityPolicyIdLists}
variables:
configuration:
fn::invoke:
Function: akamai:getAppSecConfiguration
Arguments:
name: Documentation
siemDefinition:
fn::invoke:
Function: akamai:getAppSecSiemDefinitions
Arguments:
siemDefinitionName: SIEM Version 01
securityPolicies:
fn::invoke:
Function: akamai:getAppSecSecurityPolicy
Arguments:
configId: ${configuration.configId}
Create 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:
- Config
Id int . Unique identifier of the security configuration associated with the SIEM settings being modified.
- Enable
Botman boolSiem . 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 boolAll Policies . 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 List<string>Ids 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 boolSiem . 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 boolAll Policies . 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 []stringIds JSON array of IDs for the security policies where SIEM integration is to be enabled.
- config
Id Integer . Unique identifier of the security configuration associated with the SIEM settings being modified.
- enable
Botman BooleanSiem . 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 BooleanAll Policies . 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 Boolean . Set to true to enable SIEM; set to false to disable SIEM.
- siem
Id Integer . Unique identifier of the SIEM settings being modified.
- security
Policy List<String>Ids JSON array of IDs for the security policies where SIEM integration is to be enabled.
- config
Id number . Unique identifier of the security configuration associated with the SIEM settings being modified.
- enable
Botman booleanSiem . 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 booleanAll Policies . 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 boolean . Set to true to enable SIEM; set to false to disable SIEM.
- siem
Id number . Unique identifier of the SIEM settings being modified.
- security
Policy string[]Ids 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_ boolsiem . 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_ boolall_ policies . 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_ Sequence[str]ids JSON array of IDs for the security policies where SIEM integration is to be enabled.
- config
Id Number . Unique identifier of the security configuration associated with the SIEM settings being modified.
- enable
Botman BooleanSiem . 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 BooleanAll Policies . 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 Boolean . Set to true to enable SIEM; set to false to disable SIEM.
- siem
Id Number . Unique identifier of the SIEM settings being modified.
- security
Policy List<String>Ids 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 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.
- Config
Id int . Unique identifier of the security configuration associated with the SIEM settings being modified.
- Enable
Botman boolSiem . 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 boolAll Policies . 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 List<string>Ids 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.
- Config
Id int . Unique identifier of the security configuration associated with the SIEM settings being modified.
- Enable
Botman boolSiem . 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 boolAll Policies . 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 []stringIds 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.
- config
Id Integer . Unique identifier of the security configuration associated with the SIEM settings being modified.
- enable
Botman BooleanSiem . 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 BooleanAll Policies . 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 Boolean . Set to true to enable SIEM; set to false to disable SIEM.
- security
Policy List<String>Ids JSON array of IDs for the security policies where SIEM integration is to be enabled.
- siem
Id Integer . Unique identifier of the SIEM settings being modified.
- config
Id number . Unique identifier of the security configuration associated with the SIEM settings being modified.
- enable
Botman booleanSiem . 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 booleanAll Policies . 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 boolean . Set to true to enable SIEM; set to false to disable SIEM.
- security
Policy string[]Ids JSON array of IDs for the security policies where SIEM integration is to be enabled.
- siem
Id 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_ boolsiem . 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_ boolall_ policies . 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_ Sequence[str]ids 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.
- config
Id Number . Unique identifier of the security configuration associated with the SIEM settings being modified.
- enable
Botman BooleanSiem . 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 BooleanAll Policies . 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 Boolean . Set to true to enable SIEM; set to false to disable SIEM.
- security
Policy List<String>Ids JSON array of IDs for the security policies where SIEM integration is to be enabled.
- siem
Id Number . Unique identifier of the SIEM settings being modified.
Package Details
- Repository
- Akamai pulumi/pulumi-akamai
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
akamai
Terraform Provider.