Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. securitylake
  5. Subscriber
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-aws

aws.securitylake.Subscriber

Explore with Pulumi AI

aws logo
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-aws

    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 depends_on statement.

    Example Usage

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

const example = new aws.securitylake.Subscriber("example", {
    subscriberName: "example-name",
    accessType: "S3",
    source: {
        awsLogSourceResource: {
            sourceName: "ROUTE53",
            sourceVersion: "1.0",
        },
    },
    subscriberIdentity: {
        externalId: "example",
        principal: "1234567890",
    },
}, {
    dependsOn: [exampleAwsSecuritylakeDataLake],
});

    import pulumi
import pulumi_aws as aws

example = aws.securitylake.Subscriber("example",
    subscriber_name="example-name",
    access_type="S3",
    source={
        "aws_log_source_resource": {
            "source_name": "ROUTE53",
            "source_version": "1.0",
        },
    },
    subscriber_identity={
        "external_id": "example",
        "principal": "1234567890",
    },
    opts = pulumi.ResourceOptions(depends_on=[example_aws_securitylake_data_lake]))

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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{
			SubscriberName: pulumi.String("example-name"),
			AccessType:     pulumi.String("S3"),
			Source: &securitylake.SubscriberSourceArgs{
				AwsLogSourceResource: &securitylake.SubscriberSourceAwsLogSourceResourceArgs{
					SourceName:    pulumi.String("ROUTE53"),
					SourceVersion: pulumi.String("1.0"),
				},
			},
			SubscriberIdentity: &securitylake.SubscriberSubscriberIdentityArgs{
				ExternalId: pulumi.String("example"),
				Principal:  pulumi.String("1234567890"),
			},
		}, pulumi.DependsOn([]pulumi.Resource{
			exampleAwsSecuritylakeDataLake,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}

    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()
    {
        SubscriberName = "example-name",
        AccessType = "S3",
        Source = new Aws.SecurityLake.Inputs.SubscriberSourceArgs
        {
            AwsLogSourceResource = new Aws.SecurityLake.Inputs.SubscriberSourceAwsLogSourceResourceArgs
            {
                SourceName = "ROUTE53",
                SourceVersion = "1.0",
            },
        },
        SubscriberIdentity = new Aws.SecurityLake.Inputs.SubscriberSubscriberIdentityArgs
        {
            ExternalId = "example",
            Principal = "1234567890",
        },
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            exampleAwsSecuritylakeDataLake,
        },
    });

});

    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.SubscriberSourceArgs;
import com.pulumi.aws.securitylake.inputs.SubscriberSourceAwsLogSourceResourceArgs;
import com.pulumi.aws.securitylake.inputs.SubscriberSubscriberIdentityArgs;
import com.pulumi.resources.CustomResourceOptions;
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) {
        var example = new Subscriber("example", SubscriberArgs.builder()
            .subscriberName("example-name")
            .accessType("S3")
            .source(SubscriberSourceArgs.builder()
                .awsLogSourceResource(SubscriberSourceAwsLogSourceResourceArgs.builder()
                    .sourceName("ROUTE53")
                    .sourceVersion("1.0")
                    .build())
                .build())
            .subscriberIdentity(SubscriberSubscriberIdentityArgs.builder()
                .externalId("example")
                .principal("1234567890")
                .build())
            .build(), CustomResourceOptions.builder()
                .dependsOn(exampleAwsSecuritylakeDataLake)
                .build());

    }
}

    resources:
  example:
    type: aws:securitylake:Subscriber
    properties:
      subscriberName: example-name
      accessType: S3
      source:
        awsLogSourceResource:
          sourceName: ROUTE53
          sourceVersion: '1.0'
      subscriberIdentity:
        externalId: example
        principal: '1234567890'
    options:
      dependson:
        - ${exampleAwsSecuritylakeDataLake}

    Create Subscriber Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Subscriber(name: string, args?: SubscriberArgs, opts?: CustomResourceOptions);
    @overload
def Subscriber(resource_name: str,
               args: Optional[SubscriberArgs] = None,
               opts: Optional[ResourceOptions] = None)

@overload
def Subscriber(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               access_type: Optional[str] = None,
               source: Optional[SubscriberSourceArgs] = None,
               subscriber_description: Optional[str] = None,
               subscriber_identity: Optional[SubscriberSubscriberIdentityArgs] = None,
               subscriber_name: Optional[str] = None,
               tags: Optional[Mapping[str, str]] = None,
               timeouts: Optional[SubscriberTimeoutsArgs] = None)
    func NewSubscriber(ctx *Context, name string, args *SubscriberArgs, opts ...ResourceOption) (*Subscriber, error)
    public Subscriber(string name, SubscriberArgs? args = null, CustomResourceOptions? opts = null)
    public Subscriber(String name, SubscriberArgs args)
public Subscriber(String name, SubscriberArgs args, CustomResourceOptions options)

    type: aws:securitylake:Subscriber
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

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

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var subscriberResource = new Aws.SecurityLake.Subscriber("subscriberResource", new()
{
    AccessType = "string",
    Source = new Aws.SecurityLake.Inputs.SubscriberSourceArgs
    {
        AwsLogSourceResource = new Aws.SecurityLake.Inputs.SubscriberSourceAwsLogSourceResourceArgs
        {
            SourceName = "string",
            SourceVersion = "string",
        },
        CustomLogSourceResource = new Aws.SecurityLake.Inputs.SubscriberSourceCustomLogSourceResourceArgs
        {
            SourceName = "string",
            Attributes = new[]
            {
                new Aws.SecurityLake.Inputs.SubscriberSourceCustomLogSourceResourceAttributeArgs
                {
                    CrawlerArn = "string",
                    DatabaseArn = "string",
                    TableArn = "string",
                },
            },
            Providers = new[]
            {
                new Aws.SecurityLake.Inputs.SubscriberSourceCustomLogSourceResourceProviderArgs
                {
                    Location = "string",
                    RoleArn = "string",
                },
            },
            SourceVersion = "string",
        },
    },
    SubscriberDescription = "string",
    SubscriberIdentity = new Aws.SecurityLake.Inputs.SubscriberSubscriberIdentityArgs
    {
        ExternalId = "string",
        Principal = "string",
    },
    SubscriberName = "string",
    Tags = 
    {
        { "string", "string" },
    },
    Timeouts = new Aws.SecurityLake.Inputs.SubscriberTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
});

    example, err := securitylake.NewSubscriber(ctx, "subscriberResource", &securitylake.SubscriberArgs{
	AccessType: pulumi.String("string"),
	Source: &securitylake.SubscriberSourceArgs{
		AwsLogSourceResource: &securitylake.SubscriberSourceAwsLogSourceResourceArgs{
			SourceName:    pulumi.String("string"),
			SourceVersion: pulumi.String("string"),
		},
		CustomLogSourceResource: &securitylake.SubscriberSourceCustomLogSourceResourceArgs{
			SourceName: pulumi.String("string"),
			Attributes: securitylake.SubscriberSourceCustomLogSourceResourceAttributeArray{
				&securitylake.SubscriberSourceCustomLogSourceResourceAttributeArgs{
					CrawlerArn:  pulumi.String("string"),
					DatabaseArn: pulumi.String("string"),
					TableArn:    pulumi.String("string"),
				},
			},
			Providers: securitylake.SubscriberSourceCustomLogSourceResourceProviderArray{
				&securitylake.SubscriberSourceCustomLogSourceResourceProviderArgs{
					Location: pulumi.String("string"),
					RoleArn:  pulumi.String("string"),
				},
			},
			SourceVersion: pulumi.String("string"),
		},
	},
	SubscriberDescription: pulumi.String("string"),
	SubscriberIdentity: &securitylake.SubscriberSubscriberIdentityArgs{
		ExternalId: pulumi.String("string"),
		Principal:  pulumi.String("string"),
	},
	SubscriberName: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Timeouts: &securitylake.SubscriberTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
})

    var subscriberResource = new Subscriber("subscriberResource", SubscriberArgs.builder()
    .accessType("string")
    .source(SubscriberSourceArgs.builder()
        .awsLogSourceResource(SubscriberSourceAwsLogSourceResourceArgs.builder()
            .sourceName("string")
            .sourceVersion("string")
            .build())
        .customLogSourceResource(SubscriberSourceCustomLogSourceResourceArgs.builder()
            .sourceName("string")
            .attributes(SubscriberSourceCustomLogSourceResourceAttributeArgs.builder()
                .crawlerArn("string")
                .databaseArn("string")
                .tableArn("string")
                .build())
            .providers(SubscriberSourceCustomLogSourceResourceProviderArgs.builder()
                .location("string")
                .roleArn("string")
                .build())
            .sourceVersion("string")
            .build())
        .build())
    .subscriberDescription("string")
    .subscriberIdentity(SubscriberSubscriberIdentityArgs.builder()
        .externalId("string")
        .principal("string")
        .build())
    .subscriberName("string")
    .tags(Map.of("string", "string"))
    .timeouts(SubscriberTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .build());

    subscriber_resource = aws.securitylake.Subscriber("subscriberResource",
    access_type="string",
    source={
        "awsLogSourceResource": {
            "sourceName": "string",
            "sourceVersion": "string",
        },
        "customLogSourceResource": {
            "sourceName": "string",
            "attributes": [{
                "crawlerArn": "string",
                "databaseArn": "string",
                "tableArn": "string",
            }],
            "providers": [{
                "location": "string",
                "roleArn": "string",
            }],
            "sourceVersion": "string",
        },
    },
    subscriber_description="string",
    subscriber_identity={
        "externalId": "string",
        "principal": "string",
    },
    subscriber_name="string",
    tags={
        "string": "string",
    },
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    })

    const subscriberResource = new aws.securitylake.Subscriber("subscriberResource", {
    accessType: "string",
    source: {
        awsLogSourceResource: {
            sourceName: "string",
            sourceVersion: "string",
        },
        customLogSourceResource: {
            sourceName: "string",
            attributes: [{
                crawlerArn: "string",
                databaseArn: "string",
                tableArn: "string",
            }],
            providers: [{
                location: "string",
                roleArn: "string",
            }],
            sourceVersion: "string",
        },
    },
    subscriberDescription: "string",
    subscriberIdentity: {
        externalId: "string",
        principal: "string",
    },
    subscriberName: "string",
    tags: {
        string: "string",
    },
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
});

    type: aws:securitylake:Subscriber
properties:
    accessType: string
    source:
        awsLogSourceResource:
            sourceName: string
            sourceVersion: string
        customLogSourceResource:
            attributes:
                - crawlerArn: string
                  databaseArn: string
                  tableArn: string
            providers:
                - location: string
                  roleArn: string
            sourceName: string
            sourceVersion: string
    subscriberDescription: string
    subscriberIdentity:
        externalId: string
        principal: string
    subscriberName: string
    tags:
        string: string
    timeouts:
        create: string
        delete: string
        update: string

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

    AccessType string
    The Amazon S3 or Lake Formation access type.
    Source 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 source Blocks below.
    SubscriberDescription string
    The description for your subscriber account in Security Lake.
    SubscriberIdentity SubscriberSubscriberIdentity
    The AWS identity used to access your data. See subscriber_identity Block below.
    SubscriberName string
    The name of your Security Lake subscriber account.
    Tags Dictionary<string, string>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Timeouts SubscriberTimeouts
    AccessType string
    The Amazon S3 or Lake Formation access type.
    Source SubscriberSourceArgs
    The supported AWS services from which logs and events are collected. Security Lake supports log and event collection for natively supported AWS services. See source Blocks below.
    SubscriberDescription string
    The description for your subscriber account in Security Lake.
    SubscriberIdentity SubscriberSubscriberIdentityArgs
    The AWS identity used to access your data. See subscriber_identity Block below.
    SubscriberName string
    The name of your Security Lake subscriber account.
    Tags map[string]string
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Timeouts SubscriberTimeoutsArgs
    accessType String
    The Amazon S3 or Lake Formation access type.
    source 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 source Blocks below.
    subscriberDescription String
    The description for your subscriber account in Security Lake.
    subscriberIdentity SubscriberSubscriberIdentity
    The AWS identity used to access your data. See subscriber_identity Block below.
    subscriberName String
    The name of your Security Lake subscriber account.
    tags Map<String,String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts SubscriberTimeouts
    accessType string
    The Amazon S3 or Lake Formation access type.
    source 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 source Blocks below.
    subscriberDescription string
    The description for your subscriber account in Security Lake.
    subscriberIdentity SubscriberSubscriberIdentity
    The AWS identity used to access your data. See subscriber_identity Block below.
    subscriberName string
    The name of your Security Lake subscriber account.
    tags {[key: string]: string}
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts SubscriberTimeouts
    access_type str
    The Amazon S3 or Lake Formation access type.
    source SubscriberSourceArgs
    The supported AWS services from which logs and events are collected. Security Lake supports log and event collection for natively supported AWS services. See source Blocks below.
    subscriber_description str
    The description for your subscriber account in Security Lake.
    subscriber_identity SubscriberSubscriberIdentityArgs
    The AWS identity used to access your data. See subscriber_identity Block below.
    subscriber_name str
    The name of your Security Lake subscriber account.
    tags Mapping[str, str]
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts SubscriberTimeoutsArgs
    accessType String
    The Amazon S3 or Lake Formation access type.
    source Property Map
    The supported AWS services from which logs and events are collected. Security Lake supports log and event collection for natively supported AWS services. See source Blocks below.
    subscriberDescription String
    The description for your subscriber account in Security Lake.
    subscriberIdentity Property Map
    The AWS identity used to access your data. See subscriber_identity Block below.
    subscriberName String
    The name of your Security Lake subscriber account.
    tags Map<String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts Property Map

    Outputs

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

    Arn string
    ARN of the Data Lake.
    Id string
    The provider-assigned unique ID for this managed resource.
    ResourceShareArn string
    The Amazon Resource Name (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.
    ResourceShareName string
    The name of the resource share.
    RoleArn string
    The ARN of the IAM role to be used by the entity putting logs into your custom source partition.
    S3BucketArn string
    The ARN for the Amazon Security Lake Amazon S3 bucket.
    SubscriberEndpoint string
    The subscriber endpoint to which exception messages are posted.
    SubscriberStatus string
    The subscriber status of the Amazon Security Lake subscriber account.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    ARN of the Data Lake.
    Id string
    The provider-assigned unique ID for this managed resource.
    ResourceShareArn string
    The Amazon Resource Name (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.
    ResourceShareName string
    The name of the resource share.
    RoleArn string
    The ARN of the IAM role to be used by the entity putting logs into your custom source partition.
    S3BucketArn string
    The ARN for the Amazon Security Lake Amazon S3 bucket.
    SubscriberEndpoint string
    The subscriber endpoint to which exception messages are posted.
    SubscriberStatus string
    The subscriber status of the Amazon Security Lake subscriber account.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the Data Lake.
    id String
    The provider-assigned unique ID for this managed resource.
    resourceShareArn String
    The Amazon Resource Name (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.
    resourceShareName String
    The name of the resource share.
    roleArn String
    The ARN of the IAM role to be used by the entity putting logs into your custom source partition.
    s3BucketArn String
    The ARN for the Amazon Security Lake Amazon S3 bucket.
    subscriberEndpoint String
    The subscriber endpoint to which exception messages are posted.
    subscriberStatus String
    The subscriber status of the Amazon Security Lake subscriber account.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    ARN of the Data Lake.
    id string
    The provider-assigned unique ID for this managed resource.
    resourceShareArn string
    The Amazon Resource Name (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.
    resourceShareName string
    The name of the resource share.
    roleArn string
    The ARN of the IAM role to be used by the entity putting logs into your custom source partition.
    s3BucketArn string
    The ARN for the Amazon Security Lake Amazon S3 bucket.
    subscriberEndpoint string
    The subscriber endpoint to which exception messages are posted.
    subscriberStatus string
    The subscriber status of the Amazon Security Lake subscriber account.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    ARN of the Data Lake.
    id str
    The provider-assigned unique ID for this managed resource.
    resource_share_arn str
    The Amazon Resource Name (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.
    resource_share_name str
    The name of the resource share.
    role_arn str
    The ARN of the IAM role to be used by the entity putting logs into your custom source partition.
    s3_bucket_arn str
    The ARN for the Amazon Security Lake Amazon S3 bucket.
    subscriber_endpoint str
    The subscriber endpoint to which exception messages are posted.
    subscriber_status str
    The subscriber status of the Amazon Security Lake subscriber account.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the Data Lake.
    id String
    The provider-assigned unique ID for this managed resource.
    resourceShareArn String
    The Amazon Resource Name (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.
    resourceShareName String
    The name of the resource share.
    roleArn String
    The ARN of the IAM role to be used by the entity putting logs into your custom source partition.
    s3BucketArn String
    The ARN for the Amazon Security Lake Amazon S3 bucket.
    subscriberEndpoint String
    The subscriber endpoint to which exception messages are posted.
    subscriberStatus String
    The subscriber status of the Amazon Security Lake subscriber account.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing Subscriber Resource

    Get an existing Subscriber 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?: SubscriberState, opts?: CustomResourceOptions): Subscriber
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_type: Optional[str] = None,
        arn: Optional[str] = None,
        resource_share_arn: Optional[str] = None,
        resource_share_name: Optional[str] = None,
        role_arn: Optional[str] = None,
        s3_bucket_arn: Optional[str] = None,
        source: Optional[SubscriberSourceArgs] = None,
        subscriber_description: Optional[str] = None,
        subscriber_endpoint: Optional[str] = None,
        subscriber_identity: Optional[SubscriberSubscriberIdentityArgs] = None,
        subscriber_name: Optional[str] = None,
        subscriber_status: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        timeouts: Optional[SubscriberTimeoutsArgs] = None) -> Subscriber
    func GetSubscriber(ctx *Context, name string, id IDInput, state *SubscriberState, opts ...ResourceOption) (*Subscriber, error)
    public static Subscriber Get(string name, Input<string> id, SubscriberState? state, CustomResourceOptions? opts = null)
    public static Subscriber get(String name, Output<String> id, SubscriberState 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:
    AccessType string
    The Amazon S3 or Lake Formation access type.
    Arn string
    ARN of the Data Lake.
    ResourceShareArn string
    The Amazon Resource Name (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.
    ResourceShareName string
    The name of the resource share.
    RoleArn string
    The ARN of the IAM role to be used by the entity putting logs into your custom source partition.
    S3BucketArn string
    The ARN for the Amazon Security Lake Amazon S3 bucket.
    Source 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 source Blocks below.
    SubscriberDescription string
    The description for your subscriber account in Security Lake.
    SubscriberEndpoint string
    The subscriber endpoint to which exception messages are posted.
    SubscriberIdentity SubscriberSubscriberIdentity
    The AWS identity used to access your data. See subscriber_identity Block below.
    SubscriberName string
    The name of your Security Lake subscriber account.
    SubscriberStatus string
    The subscriber status of the Amazon Security Lake subscriber account.
    Tags Dictionary<string, string>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Timeouts SubscriberTimeouts
    AccessType string
    The Amazon S3 or Lake Formation access type.
    Arn string
    ARN of the Data Lake.
    ResourceShareArn string
    The Amazon Resource Name (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.
    ResourceShareName string
    The name of the resource share.
    RoleArn string
    The ARN of the IAM role to be used by the entity putting logs into your custom source partition.
    S3BucketArn string
    The ARN for the Amazon Security Lake Amazon S3 bucket.
    Source SubscriberSourceArgs
    The supported AWS services from which logs and events are collected. Security Lake supports log and event collection for natively supported AWS services. See source Blocks below.
    SubscriberDescription string
    The description for your subscriber account in Security Lake.
    SubscriberEndpoint string
    The subscriber endpoint to which exception messages are posted.
    SubscriberIdentity SubscriberSubscriberIdentityArgs
    The AWS identity used to access your data. See subscriber_identity Block below.
    SubscriberName string
    The name of your Security Lake subscriber account.
    SubscriberStatus string
    The subscriber status of the Amazon Security Lake subscriber account.
    Tags map[string]string
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Timeouts SubscriberTimeoutsArgs
    accessType String
    The Amazon S3 or Lake Formation access type.
    arn String
    ARN of the Data Lake.
    resourceShareArn String
    The Amazon Resource Name (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.
    resourceShareName String
    The name of the resource share.
    roleArn String
    The ARN of the IAM role to be used by the entity putting logs into your custom source partition.
    s3BucketArn String
    The ARN for the Amazon Security Lake Amazon S3 bucket.
    source 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 source Blocks below.
    subscriberDescription String
    The description for your subscriber account in Security Lake.
    subscriberEndpoint String
    The subscriber endpoint to which exception messages are posted.
    subscriberIdentity SubscriberSubscriberIdentity
    The AWS identity used to access your data. See subscriber_identity Block below.
    subscriberName String
    The name of your Security Lake subscriber account.
    subscriberStatus String
    The subscriber status of the Amazon Security Lake subscriber account.
    tags Map<String,String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    timeouts SubscriberTimeouts
    accessType string
    The Amazon S3 or Lake Formation access type.
    arn string
    ARN of the Data Lake.
    resourceShareArn string
    The Amazon Resource Name (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.
    resourceShareName string
    The name of the resource share.
    roleArn string
    The ARN of the IAM role to be used by the entity putting logs into your custom source partition.
    s3BucketArn string
    The ARN for the Amazon Security Lake Amazon S3 bucket.
    source 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 source Blocks below.
    subscriberDescription string
    The description for your subscriber account in Security Lake.
    subscriberEndpoint string
    The subscriber endpoint to which exception messages are posted.
    subscriberIdentity SubscriberSubscriberIdentity
    The AWS identity used to access your data. See subscriber_identity Block below.
    subscriberName string
    The name of your Security Lake subscriber account.
    subscriberStatus string
    The subscriber status of the Amazon Security Lake subscriber account.
    tags {[key: string]: string}
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    timeouts SubscriberTimeouts
    access_type str
    The Amazon S3 or Lake Formation access type.
    arn str
    ARN of the Data Lake.
    resource_share_arn str
    The Amazon Resource Name (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.
    resource_share_name str
    The name of the resource share.
    role_arn str
    The ARN of the IAM role to be used by the entity putting logs into your custom source partition.
    s3_bucket_arn str
    The ARN for the Amazon Security Lake Amazon S3 bucket.
    source SubscriberSourceArgs
    The supported AWS services from which logs and events are collected. Security Lake supports log and event collection for natively supported AWS services. See source Blocks below.
    subscriber_description str
    The description for your subscriber account in Security Lake.
    subscriber_endpoint str
    The subscriber endpoint to which exception messages are posted.
    subscriber_identity SubscriberSubscriberIdentityArgs
    The AWS identity used to access your data. See subscriber_identity Block below.
    subscriber_name str
    The name of your Security Lake subscriber account.
    subscriber_status str
    The subscriber status of the Amazon Security Lake subscriber account.
    tags Mapping[str, str]
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    timeouts SubscriberTimeoutsArgs
    accessType String
    The Amazon S3 or Lake Formation access type.
    arn String
    ARN of the Data Lake.
    resourceShareArn String
    The Amazon Resource Name (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.
    resourceShareName String
    The name of the resource share.
    roleArn String
    The ARN of the IAM role to be used by the entity putting logs into your custom source partition.
    s3BucketArn String
    The ARN for the Amazon Security Lake Amazon S3 bucket.
    source Property Map
    The supported AWS services from which logs and events are collected. Security Lake supports log and event collection for natively supported AWS services. See source Blocks below.
    subscriberDescription String
    The description for your subscriber account in Security Lake.
    subscriberEndpoint String
    The subscriber endpoint to which exception messages are posted.
    subscriberIdentity Property Map
    The AWS identity used to access your data. See subscriber_identity Block below.
    subscriberName String
    The name of your Security Lake subscriber account.
    subscriberStatus String
    The subscriber status of the Amazon Security Lake subscriber account.
    tags Map<String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    timeouts Property Map

    Supporting Types

    SubscriberSource, SubscriberSourceArgs

    AwsLogSourceResource SubscriberSourceAwsLogSourceResource
    Amazon Security Lake supports log and event collection for natively supported AWS services. See aws_log_source_resource Block below.
    CustomLogSourceResource SubscriberSourceCustomLogSourceResource
    Amazon Security Lake supports custom source types. See custom_log_source_resource Block below.
    AwsLogSourceResource SubscriberSourceAwsLogSourceResource
    Amazon Security Lake supports log and event collection for natively supported AWS services. See aws_log_source_resource Block below.
    CustomLogSourceResource SubscriberSourceCustomLogSourceResource
    Amazon Security Lake supports custom source types. See custom_log_source_resource Block below.
    awsLogSourceResource SubscriberSourceAwsLogSourceResource
    Amazon Security Lake supports log and event collection for natively supported AWS services. See aws_log_source_resource Block below.
    customLogSourceResource SubscriberSourceCustomLogSourceResource
    Amazon Security Lake supports custom source types. See custom_log_source_resource Block below.
    awsLogSourceResource SubscriberSourceAwsLogSourceResource
    Amazon Security Lake supports log and event collection for natively supported AWS services. See aws_log_source_resource Block below.
    customLogSourceResource SubscriberSourceCustomLogSourceResource
    Amazon Security Lake supports custom source types. See custom_log_source_resource Block below.
    aws_log_source_resource SubscriberSourceAwsLogSourceResource
    Amazon Security Lake supports log and event collection for natively supported AWS services. See aws_log_source_resource Block below.
    custom_log_source_resource SubscriberSourceCustomLogSourceResource
    Amazon Security Lake supports custom source types. See custom_log_source_resource Block below.
    awsLogSourceResource Property Map
    Amazon Security Lake supports log and event collection for natively supported AWS services. See aws_log_source_resource Block below.
    customLogSourceResource Property Map
    Amazon Security Lake supports custom source types. See custom_log_source_resource Block below.

    SubscriberSourceAwsLogSourceResource, SubscriberSourceAwsLogSourceResourceArgs

    SourceName string
    Provides data expiration details of Amazon Security Lake object.
    SourceVersion string
    Provides data storage transition details of Amazon Security Lake object.
    SourceName string
    Provides data expiration details of Amazon Security Lake object.
    SourceVersion string
    Provides data storage transition details of Amazon Security Lake object.
    sourceName String
    Provides data expiration details of Amazon Security Lake object.
    sourceVersion String
    Provides data storage transition details of Amazon Security Lake object.
    sourceName string
    Provides data expiration details of Amazon Security Lake object.
    sourceVersion string
    Provides data storage transition details of Amazon Security Lake object.
    source_name str
    Provides data expiration details of Amazon Security Lake object.
    source_version str
    Provides data storage transition details of Amazon Security Lake object.
    sourceName String
    Provides data expiration details of Amazon Security Lake object.
    sourceVersion String
    Provides data storage transition details of Amazon Security Lake object.

    SubscriberSourceCustomLogSourceResource, SubscriberSourceCustomLogSourceResourceArgs

    SourceName string
    The name for a third-party custom source. This must be a Regionally unique value.
    Attributes List<SubscriberSourceCustomLogSourceResourceAttribute>
    The attributes of the third-party custom source. See attributes Block below.
    Providers List<SubscriberSourceCustomLogSourceResourceProvider>
    The details of the log provider for the third-party custom source. See provider Block below.
    SourceVersion string
    The version for a third-party custom source. This must be a Regionally unique value.
    SourceName string
    The name for a third-party custom source. This must be a Regionally unique value.
    Attributes []SubscriberSourceCustomLogSourceResourceAttribute
    The attributes of the third-party custom source. See attributes Block below.
    Providers []SubscriberSourceCustomLogSourceResourceProvider
    The details of the log provider for the third-party custom source. See provider Block below.
    SourceVersion string
    The version for a third-party custom source. This must be a Regionally unique value.
    sourceName String
    The name for a third-party custom source. This must be a Regionally unique value.
    attributes List<SubscriberSourceCustomLogSourceResourceAttribute>
    The attributes of the third-party custom source. See attributes Block below.
    providers List<SubscriberSourceCustomLogSourceResourceProvider>
    The details of the log provider for the third-party custom source. See provider Block below.
    sourceVersion String
    The version for a third-party custom source. This must be a Regionally unique value.
    sourceName string
    The name for a third-party custom source. This must be a Regionally unique value.
    attributes SubscriberSourceCustomLogSourceResourceAttribute[]
    The attributes of the third-party custom source. See attributes Block below.
    providers SubscriberSourceCustomLogSourceResourceProvider[]
    The details of the log provider for the third-party custom source. See provider Block below.
    sourceVersion string
    The version for a third-party custom source. This must be a Regionally unique value.
    source_name str
    The name for a third-party custom source. This must be a Regionally unique value.
    attributes Sequence[SubscriberSourceCustomLogSourceResourceAttribute]
    The attributes of the third-party custom source. See attributes Block below.
    providers Sequence[SubscriberSourceCustomLogSourceResourceProvider]
    The details of the log provider for the third-party custom source. See provider Block below.
    source_version str
    The version for a third-party custom source. This must be a Regionally unique value.
    sourceName String
    The name for a third-party custom source. This must be a Regionally unique value.
    attributes List<Property Map>
    The attributes of the third-party custom source. See attributes Block below.
    providers List<Property Map>
    The details of the log provider for the third-party custom source. See provider Block below.
    sourceVersion String
    The version for a third-party custom source. This must be a Regionally unique value.

    SubscriberSourceCustomLogSourceResourceAttribute, SubscriberSourceCustomLogSourceResourceAttributeArgs

    CrawlerArn string
    The ARN of the AWS Glue crawler.
    DatabaseArn string
    The ARN of the AWS Glue database where results are written.
    TableArn string
    The ARN of the AWS Glue table.
    CrawlerArn string
    The ARN of the AWS Glue crawler.
    DatabaseArn string
    The ARN of the AWS Glue database where results are written.
    TableArn string
    The ARN of the AWS Glue table.
    crawlerArn String
    The ARN of the AWS Glue crawler.
    databaseArn String
    The ARN of the AWS Glue database where results are written.
    tableArn String
    The ARN of the AWS Glue table.
    crawlerArn string
    The ARN of the AWS Glue crawler.
    databaseArn string
    The ARN of the AWS Glue database where results are written.
    tableArn string
    The ARN of the AWS Glue table.
    crawler_arn str
    The ARN of the AWS Glue crawler.
    database_arn str
    The ARN of the AWS Glue database where results are written.
    table_arn str
    The ARN of the AWS Glue table.
    crawlerArn String
    The ARN of the AWS Glue crawler.
    databaseArn String
    The ARN of the AWS Glue database where results are written.
    tableArn String
    The ARN of the AWS Glue table.

    SubscriberSourceCustomLogSourceResourceProvider, SubscriberSourceCustomLogSourceResourceProviderArgs

    Location string
    The location of the partition in the Amazon S3 bucket for Security Lake.
    RoleArn string
    The ARN of the IAM role to be used by the entity putting logs into your custom source partition.
    Location string
    The location of the partition in the Amazon S3 bucket for Security Lake.
    RoleArn string
    The ARN of the IAM role to be used by the entity putting logs into your custom source partition.
    location String
    The location of the partition in the Amazon S3 bucket for Security Lake.
    roleArn String
    The ARN of the IAM role to be used by the entity putting logs into your custom source partition.
    location string
    The location of the partition in the Amazon S3 bucket for Security Lake.
    roleArn string
    The ARN of the IAM role to be used by the entity putting logs into your custom source partition.
    location str
    The location of the partition in the Amazon S3 bucket for Security Lake.
    role_arn str
    The ARN of the IAM role to be used by the entity putting logs into your custom source partition.
    location String
    The location of the partition in the Amazon S3 bucket for Security Lake.
    roleArn String
    The ARN of the IAM role to be used by the entity putting logs into your custom source partition.

    SubscriberSubscriberIdentity, SubscriberSubscriberIdentityArgs

    ExternalId string
    The AWS Regions where Security Lake is automatically enabled.
    Principal string
    Provides encryption details of Amazon Security Lake object.
    ExternalId string
    The AWS Regions where Security Lake is automatically enabled.
    Principal string
    Provides encryption details of Amazon Security Lake object.
    externalId String
    The AWS Regions where Security Lake is automatically enabled.
    principal String
    Provides encryption details of Amazon Security Lake object.
    externalId string
    The AWS Regions where Security Lake is automatically enabled.
    principal string
    Provides encryption details of Amazon Security Lake object.
    external_id str
    The AWS Regions where Security Lake is automatically enabled.
    principal str
    Provides encryption details of Amazon Security Lake object.
    externalId String
    The AWS Regions where Security Lake is automatically enabled.
    principal String
    Provides encryption details of Amazon Security Lake object.

    SubscriberTimeouts, SubscriberTimeoutsArgs

    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

    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

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
    pulumi/pulumi-aws