Skip to content

SubscriberResource

Source code in docs_src/capo_securitylake/types/subscriber_resource.py
class SubscriberResource(TypedDict, closed=True):
    subscriber_id: "capo_securitylake.types.uuid.UUID"
    """<p>The subscriber ID of the Amazon Security Lake subscriber account.</p>"""
    subscriber_arn: "capo_securitylake.types.amazon_resource_name.AmazonResourceName"
    """<p>The subscriber ARN of the Amazon Security Lake subscriber account.</p>"""
    subscriber_identity: "capo_securitylake.types.aws_identity.AwsIdentity"
    """<p>The Amazon Web Services identity used to access your data.</p>"""
    subscriber_name: "capo_securitylake.types.safe_string.SafeString"
    """<p>The name of your Amazon Security Lake subscriber account.</p>"""
    subscriber_description: NotRequired[
        "capo_securitylake.types.safe_string.SafeString"
    ]
    """<p>The subscriber descriptions for a subscriber account. The description for a subscriber includes <code>subscriberName</code>, <code>accountID</code>, <code>externalID</code>, and <code>subscriberId</code>.</p>"""
    sources: "capo_securitylake.types.log_source_resource_list.LogSourceResourceList"
    """<p>Amazon Security Lake supports log and event collection for natively supported Amazon Web Services services. For more information, see the <a href="https://docs.aws.amazon.com/security-lake/latest/userguide/source-management.html">Amazon Security Lake User Guide</a>.</p>"""
    access_types: NotRequired["capo_securitylake.types.access_type_list.AccessTypeList"]
    """<p>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.</p> <p> Subscribers can consume data by directly querying Lake Formation tables in your Amazon S3 bucket through services like Amazon Athena. This subscription type is defined as <code>LAKEFORMATION</code>.</p>"""
    role_arn: NotRequired["capo_securitylake.types.role_arn.RoleArn"]
    """<p>The Amazon Resource Name (ARN) specifying the role of the subscriber.</p>"""
    s3_bucket_arn: NotRequired["capo_securitylake.types.s3_bucket_arn.S3BucketArn"]
    """<p>The ARN for the Amazon S3 bucket.</p>"""
    subscriber_endpoint: NotRequired["capo_securitylake.types.safe_string.SafeString"]
    """<p>The subscriber endpoint to which exception messages are posted.</p>"""
    subscriber_status: NotRequired[
        "capo_securitylake.types.subscriber_status.SubscriberStatus"
    ]
    """<p>The subscriber status of the Amazon Security Lake subscriber account.</p>"""
    resource_share_arn: NotRequired[
        "capo_securitylake.types.resource_share_arn.ResourceShareArn"
    ]
    """<p>The Amazon Resource Name (ARN) which uniquely defines the Amazon Web Services RAM resource share. Before accepting the RAM resource share invitation, you can view details related to the RAM resource share.</p> <p>This field is available only for Lake Formation subscribers created after March 8, 2023.</p>"""
    resource_share_name: NotRequired[
        "capo_securitylake.types.resource_share_name.ResourceShareName"
    ]
    """<p>The name of the resource share.</p>"""
    created_at: NotRequired["datetime.datetime"]
    """<p>The date and time when the subscriber was created.</p>"""
    updated_at: NotRequired["datetime.datetime"]
    """<p>The date and time when the subscriber was last updated.</p>"""

access_types instance-attribute

access_types: NotRequired[AccessTypeList]

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 Lake Formation tables in your Amazon S3 bucket through services like Amazon Athena. This subscription type is defined as LAKEFORMATION.

created_at instance-attribute

created_at: NotRequired[datetime]

The date and time when the subscriber was created.

resource_share_arn instance-attribute

resource_share_arn: NotRequired[ResourceShareArn]

The Amazon Resource Name (ARN) which uniquely defines the Amazon Web Services RAM resource share. Before accepting the RAM resource share invitation, you can view details related to the RAM resource share.

This field is available only for Lake Formation subscribers created after March 8, 2023.

resource_share_name instance-attribute

resource_share_name: NotRequired[ResourceShareName]

The name of the resource share.

role_arn instance-attribute

role_arn: NotRequired[RoleArn]

The Amazon Resource Name (ARN) specifying the role of the subscriber.

s3_bucket_arn instance-attribute

s3_bucket_arn: NotRequired[S3BucketArn]

The ARN for the Amazon S3 bucket.

sources instance-attribute

Amazon Security Lake supports log and event collection for natively supported Amazon Web Services services. For more information, see the Amazon Security Lake User Guide.

subscriber_arn instance-attribute

subscriber_arn: AmazonResourceName

The subscriber ARN of the Amazon Security Lake subscriber account.

subscriber_description instance-attribute

subscriber_description: NotRequired[SafeString]

The subscriber descriptions for a subscriber account. The description for a subscriber includes subscriberName, accountID, externalID, and subscriberId.

subscriber_endpoint instance-attribute

subscriber_endpoint: NotRequired[SafeString]

The subscriber endpoint to which exception messages are posted.

subscriber_id instance-attribute

subscriber_id: UUID

The subscriber ID of the Amazon Security Lake subscriber account.

subscriber_identity instance-attribute

subscriber_identity: AwsIdentity

The Amazon Web Services identity used to access your data.

subscriber_name instance-attribute

subscriber_name: SafeString

The name of your Amazon Security Lake subscriber account.

subscriber_status instance-attribute

subscriber_status: NotRequired[SubscriberStatus]

The subscriber status of the Amazon Security Lake subscriber account.

updated_at instance-attribute

updated_at: NotRequired[datetime]

The date and time when the subscriber was last updated.