Subscriber class
Resource for managing an AWS Security Lake Subscriber.
> NOTE: The underlying aws.securitylake.DataLake must be configured before creating the aws.securitylake.Subscriber. 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.Subscriber("example", {
subscriberIdentity: {
externalId: "example",
principal: "1234567890",
},
sources: [{
awsLogSourceResource: {
sourceName: "ROUTE53",
sourceVersion: "1.0",
},
}],
subscriberName: "example-name",
accessType: "S3",
}, {
dependsOn: [exampleAwsSecuritylakeDataLake],
});
import pulumi
import pulumi_aws as aws
example = aws.securitylake.Subscriber("example",
subscriber_identity={
"external_id": "example",
"principal": "1234567890",
},
sources=[{
"aws_log_source_resource": {
"source_name": "ROUTE53",
"source_version": "1.0",
},
}],
subscriber_name="example-name",
access_type="S3",
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.Subscriber("example", new()
{
SubscriberIdentity = new Aws.SecurityLake.Inputs.SubscriberSubscriberIdentityArgs
{
ExternalId = "example",
Principal = "1234567890",
},
Sources = new[]
{
new Aws.SecurityLake.Inputs.SubscriberSourceArgs
{
AwsLogSourceResource = new Aws.SecurityLake.Inputs.SubscriberSourceAwsLogSourceResourceArgs
{
SourceName = "ROUTE53",
SourceVersion = "1.0",
},
},
},
SubscriberName = "example-name",
AccessType = "S3",
}, 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.NewSubscriber(ctx, "example", &securitylake.SubscriberArgs{
SubscriberIdentity: &securitylake.SubscriberSubscriberIdentityArgs{
ExternalId: pulumi.String("example"),
Principal: pulumi.String("1234567890"),
},
Sources: securitylake.SubscriberSourceArray{
&securitylake.SubscriberSourceArgs{
AwsLogSourceResource: &securitylake.SubscriberSourceAwsLogSourceResourceArgs{
SourceName: pulumi.String("ROUTE53"),
SourceVersion: pulumi.String("1.0"),
},
},
},
SubscriberName: pulumi.String("example-name"),
AccessType: pulumi.String("S3"),
}, pulumi.DependsOn([]pulumi.Resource{
exampleAwsSecuritylakeDataLake,
}))
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_securitylake_subscriber" "example" {
depends_on = [exampleAwsSecuritylakeDataLake]
subscriber_identity = {
external_id = "example"
principal = "1234567890"
}
sources {
aws_log_source_resource = {
source_name = "ROUTE53"
source_version = "1.0"
}
}
subscriber_name = "example-name"
access_type = "S3"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.securitylake.Subscriber;
import com.pulumi.aws.securitylake.SubscriberArgs;
import com.pulumi.aws.securitylake.inputs.SubscriberSubscriberIdentityArgs;
import com.pulumi.aws.securitylake.inputs.SubscriberSourceArgs;
import com.pulumi.aws.securitylake.inputs.SubscriberSourceAwsLogSourceResourceArgs;
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 Subscriber("example", SubscriberArgs.builder()
.subscriberIdentity(SubscriberSubscriberIdentityArgs.builder()
.externalId("example")
.principal("1234567890")
.build())
.sources(SubscriberSourceArgs.builder()
.awsLogSourceResource(SubscriberSourceAwsLogSourceResourceArgs.builder()
.sourceName("ROUTE53")
.sourceVersion("1.0")
.build())
.build())
.subscriberName("example-name")
.accessType("S3")
.build(), CustomResourceOptions.builder()
.dependsOn(exampleAwsSecuritylakeDataLake)
.build());
}
}
resources:
example:
type: aws:securitylake:Subscriber
properties:
subscriberIdentity:
externalId: example
principal: '1234567890'
sources:
- awsLogSourceResource:
sourceName: ROUTE53
sourceVersion: '1.0'
subscriberName: example-name
accessType: S3
options:
dependsOn:
- ${exampleAwsSecuritylakeDataLake}
Multiple Log Sources
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.securitylake.Subscriber("example", {
subscriberIdentity: {
externalId: "example",
principal: "1234567890",
},
sources: [
{
awsLogSourceResource: {
sourceName: "SH_FINDINGS",
sourceVersion: "2.0",
},
},
{
awsLogSourceResource: {
sourceName: "ROUTE53",
sourceVersion: "2.0",
},
},
],
subscriberName: "example-name",
accessType: "S3",
}, {
dependsOn: [exampleAwsSecuritylakeDataLake],
});
import pulumi
import pulumi_aws as aws
example = aws.securitylake.Subscriber("example",
subscriber_identity={
"external_id": "example",
"principal": "1234567890",
},
sources=[
{
"aws_log_source_resource": {
"source_name": "SH_FINDINGS",
"source_version": "2.0",
},
},
{
"aws_log_source_resource": {
"source_name": "ROUTE53",
"source_version": "2.0",
},
},
],
subscriber_name="example-name",
access_type="S3",
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.Subscriber("example", new()
{
SubscriberIdentity = new Aws.SecurityLake.Inputs.SubscriberSubscriberIdentityArgs
{
ExternalId = "example",
Principal = "1234567890",
},
Sources = new[]
{
new Aws.SecurityLake.Inputs.SubscriberSourceArgs
{
AwsLogSourceResource = new Aws.SecurityLake.Inputs.SubscriberSourceAwsLogSourceResourceArgs
{
SourceName = "SH_FINDINGS",
SourceVersion = "2.0",
},
},
new Aws.SecurityLake.Inputs.SubscriberSourceArgs
{
AwsLogSourceResource = new Aws.SecurityLake.Inputs.SubscriberSourceAwsLogSourceResourceArgs
{
SourceName = "ROUTE53",
SourceVersion = "2.0",
},
},
},
SubscriberName = "example-name",
AccessType = "S3",
}, 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.NewSubscriber(ctx, "example", &securitylake.SubscriberArgs{
SubscriberIdentity: &securitylake.SubscriberSubscriberIdentityArgs{
ExternalId: pulumi.String("example"),
Principal: pulumi.String("1234567890"),
},
Sources: securitylake.SubscriberSourceArray{
&securitylake.SubscriberSourceArgs{
AwsLogSourceResource: &securitylake.SubscriberSourceAwsLogSourceResourceArgs{
SourceName: pulumi.String("SH_FINDINGS"),
SourceVersion: pulumi.String("2.0"),
},
},
&securitylake.SubscriberSourceArgs{
AwsLogSourceResource: &securitylake.SubscriberSourceAwsLogSourceResourceArgs{
SourceName: pulumi.String("ROUTE53"),
SourceVersion: pulumi.String("2.0"),
},
},
},
SubscriberName: pulumi.String("example-name"),
AccessType: pulumi.String("S3"),
}, pulumi.DependsOn([]pulumi.Resource{
exampleAwsSecuritylakeDataLake,
}))
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_securitylake_subscriber" "example" {
depends_on = [exampleAwsSecuritylakeDataLake]
subscriber_identity = {
external_id = "example"
principal = "1234567890"
}
sources {
aws_log_source_resource = {
source_name = "SH_FINDINGS"
source_version = "2.0"
}
}
sources {
aws_log_source_resource = {
source_name = "ROUTE53"
source_version = "2.0"
}
}
subscriber_name = "example-name"
access_type = "S3"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.securitylake.Subscriber;
import com.pulumi.aws.securitylake.SubscriberArgs;
import com.pulumi.aws.securitylake.inputs.SubscriberSubscriberIdentityArgs;
import com.pulumi.aws.securitylake.inputs.SubscriberSourceArgs;
import com.pulumi.aws.securitylake.inputs.SubscriberSourceAwsLogSourceResourceArgs;
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 Subscriber("example", SubscriberArgs.builder()
.subscriberIdentity(SubscriberSubscriberIdentityArgs.builder()
.externalId("example")
.principal("1234567890")
.build())
.sources(
SubscriberSourceArgs.builder()
.awsLogSourceResource(SubscriberSourceAwsLogSourceResourceArgs.builder()
.sourceName("SH_FINDINGS")
.sourceVersion("2.0")
.build())
.build(),
SubscriberSourceArgs.builder()
.awsLogSourceResource(SubscriberSourceAwsLogSourceResourceArgs.builder()
.sourceName("ROUTE53")
.sourceVersion("2.0")
.build())
.build())
.subscriberName("example-name")
.accessType("S3")
.build(), CustomResourceOptions.builder()
.dependsOn(exampleAwsSecuritylakeDataLake)
.build());
}
}
resources:
example:
type: aws:securitylake:Subscriber
properties:
subscriberIdentity:
externalId: example
principal: '1234567890'
sources:
- awsLogSourceResource:
sourceName: SH_FINDINGS
sourceVersion: '2.0'
- awsLogSourceResource:
sourceName: ROUTE53
sourceVersion: '2.0'
subscriberName: example-name
accessType: S3
options:
dependsOn:
- ${exampleAwsSecuritylakeDataLake}
Import
Using pulumi import, import Security Lake subscriber using the subscriber ID. For example:
$ pulumi import aws:securitylake/subscriber:Subscriber example 9f3bfe79-d543-474d-a93c-f3846805d208
Constructors
- Subscriber(String name, {SubscriberArgs? args, CustomResourceOptions? options})
-
Creates a new Subscriber.
nameThe Pulumi resource name.argsArguments used to configure this Subscriber. The set of arguments for Subscriber.optionsResource options controlling this resource's behavior. - Subscriber.reference(String urn)
- Creates a typed reference to an existing Subscriber resource.
Properties
-
accessType
↔ Output<
String> -
The Amazon S3 or Lake Formation access type.
latefinal
-
arn
↔ Output<
String> -
The ARN of the subscriber.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
- 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
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
ARN which uniquely defines the AWS RAM resource share. Before accepting the RAM resource share invitation, you can view details related to the RAM resource share.
latefinal
-
The name of the resource share.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
-
roleArn
↔ Output<
String> -
The ARN of the IAM role to be used by the entity putting logs into your custom source partition.
latefinal
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
s3BucketArn
↔ Output<
String> -
The ARN for the Amazon Security Lake Amazon S3 bucket.
latefinal
-
sources
↔ Output<
List< SubscriberSource> > -
The supported AWS services from which logs and events are collected. Security Lake supports log and event collection for natively supported AWS services. See
sourceBlocks below.latefinal -
subscriberDescription
↔ Output<
String?> -
The description for your subscriber account in Security Lake.
latefinal
-
subscriberEndpoint
↔ Output<
String> -
The subscriber endpoint to which exception messages are posted.
latefinal
-
subscriberIdentity
↔ Output<
SubscriberSubscriberIdentity> -
The AWS identity used to access your data. See
subscriberIdentityBlock below.latefinal -
subscriberName
↔ Output<
String?> -
The name of your Security Lake subscriber account.
latefinal
-
subscriberStatus
↔ Output<
String> -
The subscriber status of the Amazon Security Lake subscriber account.
latefinal
-
Key-value map of resource tags. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
timeouts
↔ Output<
SubscriberTimeouts?> -
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, {SubscriberState? state, CustomResourceOptions? options}) → Subscriber -
Gets an existing Subscriber resource's state with the given
nameandid.