Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. securitylake
  5. getSubscriber

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.securitylake.getSubscriber

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

Resource Type definition for AWS::SecurityLake::Subscriber

Using getSubscriber

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getSubscriber(args: GetSubscriberArgs, opts?: InvokeOptions): Promise<GetSubscriberResult>
function getSubscriberOutput(args: GetSubscriberOutputArgs, opts?: InvokeOptions): Output<GetSubscriberResult>
Copy
def get_subscriber(subscriber_arn: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetSubscriberResult
def get_subscriber_output(subscriber_arn: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetSubscriberResult]
Copy
func LookupSubscriber(ctx *Context, args *LookupSubscriberArgs, opts ...InvokeOption) (*LookupSubscriberResult, error)
func LookupSubscriberOutput(ctx *Context, args *LookupSubscriberOutputArgs, opts ...InvokeOption) LookupSubscriberResultOutput
Copy

> Note: This function is named LookupSubscriber in the Go SDK.

public static class GetSubscriber 
{
    public static Task<GetSubscriberResult> InvokeAsync(GetSubscriberArgs args, InvokeOptions? opts = null)
    public static Output<GetSubscriberResult> Invoke(GetSubscriberInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetSubscriberResult> getSubscriber(GetSubscriberArgs args, InvokeOptions options)
public static Output<GetSubscriberResult> getSubscriber(GetSubscriberArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:securitylake:getSubscriber
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

SubscriberArn This property is required. string
The Amazon Resource Name (ARN) of the Security Lake subscriber.
SubscriberArn This property is required. string
The Amazon Resource Name (ARN) of the Security Lake subscriber.
subscriberArn This property is required. String
The Amazon Resource Name (ARN) of the Security Lake subscriber.
subscriberArn This property is required. string
The Amazon Resource Name (ARN) of the Security Lake subscriber.
subscriber_arn This property is required. str
The Amazon Resource Name (ARN) of the Security Lake subscriber.
subscriberArn This property is required. String
The Amazon Resource Name (ARN) of the Security Lake subscriber.

getSubscriber Result

The following output properties are available:

AccessTypes List<Pulumi.AwsNative.SecurityLake.SubscriberAccessTypesItem>

You can choose to notify subscribers of new objects with an Amazon Simple Queue Service (Amazon SQS) queue or through messaging to an HTTPS endpoint provided by the subscriber.

Subscribers can consume data by directly querying AWS Lake Formation tables in your Amazon S3 bucket through services like Amazon Athena. This subscription type is defined as LAKEFORMATION .

ResourceShareArn string
The Amazon Resource Name (ARN) of the Amazon Security Lake subscriber.
ResourceShareName string
The ARN name of the Amazon Security Lake subscriber.
S3BucketArn string
The Amazon Resource Name (ARN) of the S3 bucket.
Sources List<Pulumi.AwsNative.SecurityLake.Outputs.SubscriberSource>
The supported AWS services from which logs and events are collected.
SubscriberArn string
The Amazon Resource Name (ARN) of the Security Lake subscriber.
SubscriberDescription string
The description for your subscriber account in Security Lake.
SubscriberIdentity Pulumi.AwsNative.SecurityLake.Outputs.SubscriberIdentityProperties
The AWS identity used to access your data.
SubscriberName string
The name of your Security Lake subscriber account.
SubscriberRoleArn string
The Amazon Resource Name (ARN) of the role used to create the Security Lake subscriber.
Tags List<Pulumi.AwsNative.Outputs.Tag>
An array of objects, one for each tag to associate with the subscriber. For each tag, you must specify both a tag key and a tag value. A tag value cannot be null, but it can be an empty string.
AccessTypes []SubscriberAccessTypesItem

You can choose to notify subscribers of new objects with an Amazon Simple Queue Service (Amazon SQS) queue or through messaging to an HTTPS endpoint provided by the subscriber.

Subscribers can consume data by directly querying AWS Lake Formation tables in your Amazon S3 bucket through services like Amazon Athena. This subscription type is defined as LAKEFORMATION .

ResourceShareArn string
The Amazon Resource Name (ARN) of the Amazon Security Lake subscriber.
ResourceShareName string
The ARN name of the Amazon Security Lake subscriber.
S3BucketArn string
The Amazon Resource Name (ARN) of the S3 bucket.
Sources []SubscriberSource
The supported AWS services from which logs and events are collected.
SubscriberArn string
The Amazon Resource Name (ARN) of the Security Lake subscriber.
SubscriberDescription string
The description for your subscriber account in Security Lake.
SubscriberIdentity SubscriberIdentityProperties
The AWS identity used to access your data.
SubscriberName string
The name of your Security Lake subscriber account.
SubscriberRoleArn string
The Amazon Resource Name (ARN) of the role used to create the Security Lake subscriber.
Tags Tag
An array of objects, one for each tag to associate with the subscriber. For each tag, you must specify both a tag key and a tag value. A tag value cannot be null, but it can be an empty string.
accessTypes List<SubscriberAccessTypesItem>

You can choose to notify subscribers of new objects with an Amazon Simple Queue Service (Amazon SQS) queue or through messaging to an HTTPS endpoint provided by the subscriber.

Subscribers can consume data by directly querying AWS Lake Formation tables in your Amazon S3 bucket through services like Amazon Athena. This subscription type is defined as LAKEFORMATION .

resourceShareArn String
The Amazon Resource Name (ARN) of the Amazon Security Lake subscriber.
resourceShareName String
The ARN name of the Amazon Security Lake subscriber.
s3BucketArn String
The Amazon Resource Name (ARN) of the S3 bucket.
sources List<SubscriberSource>
The supported AWS services from which logs and events are collected.
subscriberArn String
The Amazon Resource Name (ARN) of the Security Lake subscriber.
subscriberDescription String
The description for your subscriber account in Security Lake.
subscriberIdentity SubscriberIdentityProperties
The AWS identity used to access your data.
subscriberName String
The name of your Security Lake subscriber account.
subscriberRoleArn String
The Amazon Resource Name (ARN) of the role used to create the Security Lake subscriber.
tags List<Tag>
An array of objects, one for each tag to associate with the subscriber. For each tag, you must specify both a tag key and a tag value. A tag value cannot be null, but it can be an empty string.
accessTypes SubscriberAccessTypesItem[]

You can choose to notify subscribers of new objects with an Amazon Simple Queue Service (Amazon SQS) queue or through messaging to an HTTPS endpoint provided by the subscriber.

Subscribers can consume data by directly querying AWS Lake Formation tables in your Amazon S3 bucket through services like Amazon Athena. This subscription type is defined as LAKEFORMATION .

resourceShareArn string
The Amazon Resource Name (ARN) of the Amazon Security Lake subscriber.
resourceShareName string
The ARN name of the Amazon Security Lake subscriber.
s3BucketArn string
The Amazon Resource Name (ARN) of the S3 bucket.
sources SubscriberSource[]
The supported AWS services from which logs and events are collected.
subscriberArn string
The Amazon Resource Name (ARN) of the Security Lake subscriber.
subscriberDescription string
The description for your subscriber account in Security Lake.
subscriberIdentity SubscriberIdentityProperties
The AWS identity used to access your data.
subscriberName string
The name of your Security Lake subscriber account.
subscriberRoleArn string
The Amazon Resource Name (ARN) of the role used to create the Security Lake subscriber.
tags Tag[]
An array of objects, one for each tag to associate with the subscriber. For each tag, you must specify both a tag key and a tag value. A tag value cannot be null, but it can be an empty string.
access_types Sequence[SubscriberAccessTypesItem]

You can choose to notify subscribers of new objects with an Amazon Simple Queue Service (Amazon SQS) queue or through messaging to an HTTPS endpoint provided by the subscriber.

Subscribers can consume data by directly querying AWS Lake Formation tables in your Amazon S3 bucket through services like Amazon Athena. This subscription type is defined as LAKEFORMATION .

resource_share_arn str
The Amazon Resource Name (ARN) of the Amazon Security Lake subscriber.
resource_share_name str
The ARN name of the Amazon Security Lake subscriber.
s3_bucket_arn str
The Amazon Resource Name (ARN) of the S3 bucket.
sources Sequence[SubscriberSource]
The supported AWS services from which logs and events are collected.
subscriber_arn str
The Amazon Resource Name (ARN) of the Security Lake subscriber.
subscriber_description str
The description for your subscriber account in Security Lake.
subscriber_identity SubscriberIdentityProperties
The AWS identity used to access your data.
subscriber_name str
The name of your Security Lake subscriber account.
subscriber_role_arn str
The Amazon Resource Name (ARN) of the role used to create the Security Lake subscriber.
tags Sequence[root_Tag]
An array of objects, one for each tag to associate with the subscriber. For each tag, you must specify both a tag key and a tag value. A tag value cannot be null, but it can be an empty string.
accessTypes List<"LAKEFORMATION" | "S3">

You can choose to notify subscribers of new objects with an Amazon Simple Queue Service (Amazon SQS) queue or through messaging to an HTTPS endpoint provided by the subscriber.

Subscribers can consume data by directly querying AWS Lake Formation tables in your Amazon S3 bucket through services like Amazon Athena. This subscription type is defined as LAKEFORMATION .

resourceShareArn String
The Amazon Resource Name (ARN) of the Amazon Security Lake subscriber.
resourceShareName String
The ARN name of the Amazon Security Lake subscriber.
s3BucketArn String
The Amazon Resource Name (ARN) of the S3 bucket.
sources List<Property Map>
The supported AWS services from which logs and events are collected.
subscriberArn String
The Amazon Resource Name (ARN) of the Security Lake subscriber.
subscriberDescription String
The description for your subscriber account in Security Lake.
subscriberIdentity Property Map
The AWS identity used to access your data.
subscriberName String
The name of your Security Lake subscriber account.
subscriberRoleArn String
The Amazon Resource Name (ARN) of the role used to create the Security Lake subscriber.
tags List<Property Map>
An array of objects, one for each tag to associate with the subscriber. For each tag, you must specify both a tag key and a tag value. A tag value cannot be null, but it can be an empty string.

Supporting Types

SubscriberAccessTypesItem

SubscriberAwsLogSource

SourceName string
The name for a AWS source. This must be a Regionally unique value.
SourceVersion string
The version for a AWS source. This must be a Regionally unique value.
SourceName string
The name for a AWS source. This must be a Regionally unique value.
SourceVersion string
The version for a AWS source. This must be a Regionally unique value.
sourceName String
The name for a AWS source. This must be a Regionally unique value.
sourceVersion String
The version for a AWS source. This must be a Regionally unique value.
sourceName string
The name for a AWS source. This must be a Regionally unique value.
sourceVersion string
The version for a AWS source. This must be a Regionally unique value.
source_name str
The name for a AWS source. This must be a Regionally unique value.
source_version str
The version for a AWS source. This must be a Regionally unique value.
sourceName String
The name for a AWS source. This must be a Regionally unique value.
sourceVersion String
The version for a AWS source. This must be a Regionally unique value.

SubscriberCustomLogSource

SourceName string
The name for a third-party custom source. This must be a Regionally unique value.
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.
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.
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.
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.
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.
sourceVersion String
The version for a third-party custom source. This must be a Regionally unique value.

SubscriberIdentityProperties

ExternalId This property is required. string
The external ID used to establish trust relationship with the AWS identity.
Principal This property is required. string
The AWS identity principal.
ExternalId This property is required. string
The external ID used to establish trust relationship with the AWS identity.
Principal This property is required. string
The AWS identity principal.
externalId This property is required. String
The external ID used to establish trust relationship with the AWS identity.
principal This property is required. String
The AWS identity principal.
externalId This property is required. string
The external ID used to establish trust relationship with the AWS identity.
principal This property is required. string
The AWS identity principal.
external_id This property is required. str
The external ID used to establish trust relationship with the AWS identity.
principal This property is required. str
The AWS identity principal.
externalId This property is required. String
The external ID used to establish trust relationship with the AWS identity.
principal This property is required. String
The AWS identity principal.

SubscriberSource

Tag

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native