CustomLogSource class
Resource for managing an AWS Security Lake Custom Log Source.
> NOTE: The underlying aws.securitylake.DataLake must be configured before creating the aws.securitylake.CustomLogSource. Use a dependsOn statement.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.securitylake.CustomLogSource("example", {
configuration: {
crawlerConfiguration: {
roleArn: customLog.arn,
},
providerIdentity: {
externalId: "example-id",
principal: "123456789012",
},
},
sourceName: "example-name",
sourceVersion: "1.0",
eventClasses: ["FILE_ACTIVITY"],
}, {
dependsOn: [exampleAwsSecuritylakeDataLake],
});
import pulumi
import pulumi_aws as aws
example = aws.securitylake.CustomLogSource("example",
configuration={
"crawler_configuration": {
"role_arn": custom_log["arn"],
},
"provider_identity": {
"external_id": "example-id",
"principal": "123456789012",
},
},
source_name="example-name",
source_version="1.0",
event_classes=["FILE_ACTIVITY"],
opts = pulumi.ResourceOptions(depends_on=[example_aws_securitylake_data_lake]))
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.SecurityLake.CustomLogSource("example", new()
{
Configuration = new Aws.SecurityLake.Inputs.CustomLogSourceConfigurationArgs
{
CrawlerConfiguration = new Aws.SecurityLake.Inputs.CustomLogSourceConfigurationCrawlerConfigurationArgs
{
RoleArn = customLog.Arn,
},
ProviderIdentity = new Aws.SecurityLake.Inputs.CustomLogSourceConfigurationProviderIdentityArgs
{
ExternalId = "example-id",
Principal = "123456789012",
},
},
SourceName = "example-name",
SourceVersion = "1.0",
EventClasses = new[]
{
"FILE_ACTIVITY",
},
}, new CustomResourceOptions
{
DependsOn =
{
exampleAwsSecuritylakeDataLake,
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/securitylake"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := securitylake.NewCustomLogSource(ctx, "example", &securitylake.CustomLogSourceArgs{
Configuration: &securitylake.CustomLogSourceConfigurationArgs{
CrawlerConfiguration: &securitylake.CustomLogSourceConfigurationCrawlerConfigurationArgs{
RoleArn: pulumi.Any(customLog.Arn),
},
ProviderIdentity: &securitylake.CustomLogSourceConfigurationProviderIdentityArgs{
ExternalId: pulumi.String("example-id"),
Principal: pulumi.String("123456789012"),
},
},
SourceName: pulumi.String("example-name"),
SourceVersion: pulumi.String("1.0"),
EventClasses: pulumi.StringArray{
pulumi.String("FILE_ACTIVITY"),
},
}, pulumi.DependsOn([]pulumi.Resource{
exampleAwsSecuritylakeDataLake,
}))
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_securitylake_customlogsource" "example" {
depends_on = [exampleAwsSecuritylakeDataLake]
configuration = {
crawler_configuration = {
role_arn = customLog.arn
}
provider_identity = {
external_id = "example-id"
principal = "123456789012"
}
}
source_name = "example-name"
source_version = "1.0"
event_classes = ["FILE_ACTIVITY"]
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.securitylake.CustomLogSource;
import com.pulumi.aws.securitylake.CustomLogSourceArgs;
import com.pulumi.aws.securitylake.inputs.CustomLogSourceConfigurationArgs;
import com.pulumi.aws.securitylake.inputs.CustomLogSourceConfigurationCrawlerConfigurationArgs;
import com.pulumi.aws.securitylake.inputs.CustomLogSourceConfigurationProviderIdentityArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.ArrayList;
import java.util.Arrays;
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) {
var example = new CustomLogSource("example", CustomLogSourceArgs.builder()
.configuration(CustomLogSourceConfigurationArgs.builder()
.crawlerConfiguration(CustomLogSourceConfigurationCrawlerConfigurationArgs.builder()
.roleArn(customLog.arn())
.build())
.providerIdentity(CustomLogSourceConfigurationProviderIdentityArgs.builder()
.externalId("example-id")
.principal("123456789012")
.build())
.build())
.sourceName("example-name")
.sourceVersion("1.0")
.eventClasses("FILE_ACTIVITY")
.build(), CustomResourceOptions.builder()
.dependsOn(exampleAwsSecuritylakeDataLake)
.build());
}
}
resources:
example:
type: aws:securitylake:CustomLogSource
properties:
configuration:
crawlerConfiguration:
roleArn: ${customLog.arn}
providerIdentity:
externalId: example-id
principal: '123456789012'
sourceName: example-name
sourceVersion: '1.0'
eventClasses:
- FILE_ACTIVITY
options:
dependsOn:
- ${exampleAwsSecuritylakeDataLake}
Import
Using pulumi import, import Custom log sources using the source name. For example:
$ pulumi import aws:securitylake/customLogSource:CustomLogSource example example-name
Constructors
- CustomLogSource(String name, {CustomLogSourceArgs? args, CustomResourceOptions? options})
-
Creates a new CustomLogSource.
nameThe Pulumi resource name.argsArguments used to configure this CustomLogSource. The set of arguments for CustomLogSource.optionsResource options controlling this resource's behavior. - CustomLogSource.reference(String urn)
- Creates a typed reference to an existing CustomLogSource resource.
Properties
-
attributes
↔ Output<
List< CustomLogSourceAttribute> > -
The attributes of a third-party custom source.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
configuration
↔ Output<
CustomLogSourceConfiguration> -
The configuration for the third-party custom source.
latefinal
-
eventClasses
↔ Output<
List< String> ?> -
The Open Cybersecurity Schema Framework (OCSF) event classes which describes the type of data that the custom source will send to Security Lake.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
providerDetails
↔ Output<
List< CustomLogSourceProviderDetail> > -
The details of the log provider for a third-party custom source.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
sourceName
↔ Output<
String> -
Specify the name for a third-party custom source.
This must be a Regionally unique value.
Has a maximum length of 20.
latefinal
-
sourceVersion
↔ Output<
String> -
Specify the source version for the third-party custom source, to limit log collection to a specific version of custom data source.
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {CustomLogSourceState? state, CustomResourceOptions? options}) → CustomLogSource -
Gets an existing CustomLogSource resource's state with the given
nameandid.