Package software.amazon.awscdk.services.securitylake

Interface CfnSubscriberProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSubscriberProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-06T23:25:16.981Z")
@Stability(Stable)
public interface CfnSubscriberProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnSubscriber.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.securitylake.*;
 CfnSubscriberProps cfnSubscriberProps = CfnSubscriberProps.builder()
         .accessTypes(List.of("accessTypes"))
         .dataLakeArn("dataLakeArn")
         .sources(List.of(SourceProperty.builder()
                 .awsLogSource(AwsLogSourceProperty.builder()
                         .sourceName("sourceName")
                         .sourceVersion("sourceVersion")
                         .build())
                 .customLogSource(CustomLogSourceProperty.builder()
                         .sourceName("sourceName")
                         .sourceVersion("sourceVersion")
                         .build())
                 .build()))
         .subscriberIdentity(SubscriberIdentityProperty.builder()
                 .externalId("externalId")
                 .principal("principal")
                 .build())
         .subscriberName("subscriberName")
         // the properties below are optional
         .subscriberDescription("subscriberDescription")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnSubscriberProps.Builder	A builder for CfnSubscriberProps
static final class	CfnSubscriberProps.Jsii$Proxy	An implementation for CfnSubscriberProps

Method Summary

Modifier and Type	Method	Description
static CfnSubscriberProps.Builder	builder()
List<String>	getAccessTypes()	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	getDataLakeArn()	The Amazon Resource Name (ARN) used to create the data lake.
Object	getSources()	Amazon Security Lake supports log and event collection for natively supported AWS services .
default String	getSubscriberDescription()	The subscriber descriptions for a subscriber account.
Object	getSubscriberIdentity()	The AWS identity used to access your data.
String	getSubscriberName()	The name of your Amazon Security Lake subscriber account.
default List<CfnTag>	getTags()	An array of objects, one for each tag to associate with the subscriber.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAccessTypes

@Stability(Stable)
@NotNull
List<String> getAccessTypes()

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 .

See Also:

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

getDataLakeArn

@Stability(Stable)
@NotNull
String getDataLakeArn()

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

See Also:

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

getSources

@Stability(Stable)
@NotNull
Object getSources()

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

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

See Also:

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

getSubscriberIdentity

@Stability(Stable)
@NotNull
Object getSubscriberIdentity()

The AWS identity used to access your data.

See Also:

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

getSubscriberName

@Stability(Stable)
@NotNull
String getSubscriberName()

The name of your Amazon Security Lake subscriber account.

See Also:

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

getSubscriberDescription

@Stability(Stable)
@Nullable
default String getSubscriberDescription()

The subscriber descriptions for a subscriber account.

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

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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 Also:

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

builder

@Stability(Stable)
static CfnSubscriberProps.Builder builder()

Returns:

a CfnSubscriberProps.Builder of CfnSubscriberProps