Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. securitylake
  5. Subscriber

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.securitylake.Subscriber

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::SecurityLake::Subscriber

    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: SubscriberArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def Subscriber(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               access_types: Optional[Sequence[SubscriberAccessTypesItem]] = None,
               data_lake_arn: Optional[str] = None,
               sources: Optional[Sequence[SubscriberSourceArgs]] = None,
               subscriber_identity: Optional[SubscriberIdentityPropertiesArgs] = None,
               subscriber_description: Optional[str] = None,
               subscriber_name: Optional[str] = None,
               tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewSubscriber(ctx *Context, name string, args SubscriberArgs, opts ...ResourceOption) (*Subscriber, error)
    public Subscriber(string name, SubscriberArgs args, CustomResourceOptions? opts = null)
    public Subscriber(String name, SubscriberArgs args)
public Subscriber(String name, SubscriberArgs args, CustomResourceOptions options)

    type: aws-native: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.

    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:

    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 .

    DataLakeArn string
    The ARN for the data lake.
    Sources List<Pulumi.AwsNative.SecurityLake.Inputs.SubscriberSource>
    The supported AWS services from which logs and events are collected.
    SubscriberIdentity Pulumi.AwsNative.SecurityLake.Inputs.SubscriberIdentityProperties
    The AWS identity used to access your data.
    SubscriberDescription string
    The description for your subscriber account in Security Lake.
    SubscriberName string
    The name of your Security Lake subscriber account.
    Tags List<Pulumi.AwsNative.Inputs.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 .

    DataLakeArn string
    The ARN for the data lake.
    Sources []SubscriberSourceArgs
    The supported AWS services from which logs and events are collected.
    SubscriberIdentity SubscriberIdentityPropertiesArgs
    The AWS identity used to access your data.
    SubscriberDescription string
    The description for your subscriber account in Security Lake.
    SubscriberName string
    The name of your Security Lake subscriber account.
    Tags TagArgs
    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 .

    dataLakeArn String
    The ARN for the data lake.
    sources List<SubscriberSource>
    The supported AWS services from which logs and events are collected.
    subscriberIdentity SubscriberIdentityProperties
    The AWS identity used to access your data.
    subscriberDescription String
    The description for your subscriber account in Security Lake.
    subscriberName String
    The name of your Security Lake subscriber account.
    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 .

    dataLakeArn string
    The ARN for the data lake.
    sources SubscriberSource[]
    The supported AWS services from which logs and events are collected.
    subscriberIdentity SubscriberIdentityProperties
    The AWS identity used to access your data.
    subscriberDescription string
    The description for your subscriber account in Security Lake.
    subscriberName string
    The name of your Security Lake subscriber account.
    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 .

    data_lake_arn str
    The ARN for the data lake.
    sources Sequence[SubscriberSourceArgs]
    The supported AWS services from which logs and events are collected.
    subscriber_identity SubscriberIdentityPropertiesArgs
    The AWS identity used to access your data.
    subscriber_description str
    The description for your subscriber account in Security Lake.
    subscriber_name str
    The name of your Security Lake subscriber account.
    tags Sequence[TagArgs]
    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 .

    dataLakeArn String
    The ARN for the data lake.
    sources List<Property Map>
    The supported AWS services from which logs and events are collected.
    subscriberIdentity Property Map
    The AWS identity used to access your data.
    subscriberDescription String
    The description for your subscriber account in Security Lake.
    subscriberName String
    The name of your Security Lake subscriber account.
    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.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    SubscriberArn string
    The Amazon Resource Name (ARN) of the Security Lake subscriber.
    SubscriberRoleArn string
    The Amazon Resource Name (ARN) of the role used to create the Security Lake subscriber.
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    SubscriberArn string
    The Amazon Resource Name (ARN) of the Security Lake subscriber.
    SubscriberRoleArn string
    The Amazon Resource Name (ARN) of the role used to create the Security Lake subscriber.
    id String
    The provider-assigned unique ID for this managed resource.
    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.
    subscriberArn String
    The Amazon Resource Name (ARN) of the Security Lake subscriber.
    subscriberRoleArn String
    The Amazon Resource Name (ARN) of the role used to create the Security Lake subscriber.
    id string
    The provider-assigned unique ID for this managed resource.
    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.
    subscriberArn string
    The Amazon Resource Name (ARN) of the Security Lake subscriber.
    subscriberRoleArn string
    The Amazon Resource Name (ARN) of the role used to create the Security Lake subscriber.
    id str
    The provider-assigned unique ID for this managed resource.
    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.
    subscriber_arn str
    The Amazon Resource Name (ARN) of the Security Lake subscriber.
    subscriber_role_arn str
    The Amazon Resource Name (ARN) of the role used to create the Security Lake subscriber.
    id String
    The provider-assigned unique ID for this managed resource.
    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.
    subscriberArn String
    The Amazon Resource Name (ARN) of the Security Lake subscriber.
    subscriberRoleArn String
    The Amazon Resource Name (ARN) of the role used to create the Security Lake subscriber.

    Supporting Types

    SubscriberAccessTypesItem, SubscriberAccessTypesItemArgs

    Lakeformation
    LAKEFORMATION
    S3
    S3
    SubscriberAccessTypesItemLakeformation
    LAKEFORMATION
    SubscriberAccessTypesItemS3
    S3
    Lakeformation
    LAKEFORMATION
    S3
    S3
    Lakeformation
    LAKEFORMATION
    S3
    S3
    LAKEFORMATION
    LAKEFORMATION
    S3
    S3
    "LAKEFORMATION"
    LAKEFORMATION
    "S3"
    S3

    SubscriberAwsLogSource, SubscriberAwsLogSourceArgs

    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, SubscriberCustomLogSourceArgs

    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, SubscriberIdentityPropertiesArgs

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

    SubscriberSource, SubscriberSourceArgs

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws-native