Interface ICfnSubscriberProps

Properties for defining a CfnSubscriber.

Namespace: Amazon.CDK.AWS.SecurityLake

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnSubscriberProps

Syntax (vb)

Public Interface ICfnSubscriberProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securitylake-subscriber.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.SecurityLake;

             var cfnSubscriberProps = new CfnSubscriberProps {
                 AccessTypes = new [] { "accessTypes" },
                 DataLakeArn = "dataLakeArn",
                 Sources = new [] { new SourceProperty {
                     AwsLogSource = new AwsLogSourceProperty {
                         SourceName = "sourceName",
                         SourceVersion = "sourceVersion"
                     },
                     CustomLogSource = new CustomLogSourceProperty {
                         SourceName = "sourceName",
                         SourceVersion = "sourceVersion"
                     }
                 } },
                 SubscriberIdentity = new SubscriberIdentityProperty {
                     ExternalId = "externalId",
                     Principal = "principal"
                 },
                 SubscriberName = "subscriberName",

                 // the properties below are optional
                 SubscriberDescription = "subscriberDescription",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Properties

AccessTypes	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.
DataLakeArn	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 .
SubscriberDescription	The subscriber descriptions for a subscriber account.
SubscriberIdentity	The AWS identity used to access your data.
SubscriberName	The name of your Amazon Security Lake subscriber account.
Tags	An array of objects, one for each tag to associate with the subscriber.

Properties

AccessTypes

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.

string[] AccessTypes { get; }

Property Value

string[]

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securitylake-subscriber.html#cfn-securitylake-subscriber-accesstypes

DataLakeArn

The Amazon Resource Name (ARN) used to create the data lake.

string DataLakeArn { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securitylake-subscriber.html#cfn-securitylake-subscriber-datalakearn

Sources

Amazon Security Lake supports log and event collection for natively supported AWS services .

object Sources { get; }

Property Value

object

Remarks

For more information, see the Amazon Security Lake User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securitylake-subscriber.html#cfn-securitylake-subscriber-sources

Type union: either IResolvable or (either IResolvable or CfnSubscriber.ISourceProperty)[]

SubscriberDescription

The subscriber descriptions for a subscriber account.

string? SubscriberDescription { get; }

Property Value

string

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securitylake-subscriber.html#cfn-securitylake-subscriber-subscriberdescription

SubscriberIdentity

The AWS identity used to access your data.

object SubscriberIdentity { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securitylake-subscriber.html#cfn-securitylake-subscriber-subscriberidentity

Type union: either IResolvable or CfnSubscriber.ISubscriberIdentityProperty

SubscriberName

The name of your Amazon Security Lake subscriber account.

string SubscriberName { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securitylake-subscriber.html#cfn-securitylake-subscriber-subscribername

Tags

An array of objects, one for each tag to associate with the subscriber.

ICfnTag[]? Tags { get; }

Property Value

ICfnTag[]

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securitylake-subscriber.html#cfn-securitylake-subscriber-tags