CfnSubscriberProps
- class aws_cdk.aws_securitylake.CfnSubscriberProps(*, access_types, data_lake_arn, sources, subscriber_identity, subscriber_name, subscriber_description=None, tags=None)
Bases:
object
Properties for defining a
CfnSubscriber
.- Parameters:
access_types (
Sequence
[str
]) – 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 asLAKEFORMATION
.data_lake_arn (
str
) – The Amazon Resource Name (ARN) used to create the data lake.sources (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,SourceProperty
,Dict
[str
,Any
]]]]) – Amazon Security Lake supports log and event collection for natively supported AWS services . For more information, see the Amazon Security Lake User Guide .subscriber_identity (
Union
[IResolvable
,SubscriberIdentityProperty
,Dict
[str
,Any
]]) – The AWS identity used to access your data.subscriber_name (
str
) – The name of your Amazon Security Lake subscriber account.subscriber_description (
Optional
[str
]) – The subscriber descriptions for a subscriber account. The description for a subscriber includessubscriberName
,accountID
,externalID
, andsubscriberId
.tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – 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.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_securitylake as securitylake cfn_subscriber_props = securitylake.CfnSubscriberProps( access_types=["accessTypes"], data_lake_arn="dataLakeArn", sources=[securitylake.CfnSubscriber.SourceProperty( aws_log_source=securitylake.CfnSubscriber.AwsLogSourceProperty( source_name="sourceName", source_version="sourceVersion" ), custom_log_source=securitylake.CfnSubscriber.CustomLogSourceProperty( source_name="sourceName", source_version="sourceVersion" ) )], subscriber_identity=securitylake.CfnSubscriber.SubscriberIdentityProperty( external_id="externalId", principal="principal" ), subscriber_name="subscriberName", # the properties below are optional subscriber_description="subscriberDescription", tags=[CfnTag( key="key", value="value" )] )
Attributes
- access_types
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
The Amazon Resource Name (ARN) used to create the data lake.
- sources
Amazon Security Lake supports log and event collection for natively supported AWS services .
For more information, see the Amazon Security Lake User Guide .
- subscriber_description
The subscriber descriptions for a subscriber account.
The description for a subscriber includes
subscriberName
,accountID
,externalID
, andsubscriberId
.
- subscriber_identity
The AWS identity used to access your data.
- subscriber_name
The name of your Amazon Security Lake subscriber account.
- tags
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.