CfnSubscriberPropsMixin

class aws_cdk.mixins_preview.aws_securitylake.mixins.CfnSubscriberPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a subscriber for accounts that are already enabled in Amazon Security Lake.

You can create a subscriber with access to data in the current AWS Region.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securitylake-subscriber.html
CloudformationResource:: AWS::SecurityLake::Subscriber
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_securitylake import mixins as securitylake_mixins

cfn_subscriber_props_mixin = securitylake_mixins.CfnSubscriberPropsMixin(securitylake_mixins.CfnSubscriberMixinProps(
    access_types=["accessTypes"],
    data_lake_arn="dataLakeArn",
    sources=[securitylake_mixins.CfnSubscriberPropsMixin.SourceProperty(
        aws_log_source=securitylake_mixins.CfnSubscriberPropsMixin.AwsLogSourceProperty(
            source_name="sourceName",
            source_version="sourceVersion"
        ),
        custom_log_source=securitylake_mixins.CfnSubscriberPropsMixin.CustomLogSourceProperty(
            source_name="sourceName",
            source_version="sourceVersion"
        )
    )],
    subscriber_description="subscriberDescription",
    subscriber_identity=securitylake_mixins.CfnSubscriberPropsMixin.SubscriberIdentityProperty(
        external_id="externalId",
        principal="principal"
    ),
    subscriber_name="subscriberName",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::SecurityLake::Subscriber.

Parameters:

props (Union[CfnSubscriberMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['accessTypes', 'dataLakeArn', 'sources', 'subscriberDescription', 'subscriberIdentity', 'subscriberName', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

AwsLogSourceProperty

class CfnSubscriberPropsMixin.AwsLogSourceProperty(*, source_name=None, source_version=None)

Bases: object

Adds a natively supported AWS service as an Amazon Security Lake source.

Enables source types for member accounts in required AWS Regions, based on the parameters you specify. You can choose any source type in any Region for either accounts that are part of a trusted organization or standalone accounts. Once you add an AWS service as a source, Security Lake starts collecting logs and events from it.

Parameters:

source_name (Optional[str]) – Source name of the natively supported AWS service that is supported as an Amazon Security Lake source. For the list of sources supported by Amazon Security Lake see Collecting data from AWS services in the Amazon Security Lake User Guide.
source_version (Optional[str]) – Source version of the natively supported AWS service that is supported as an Amazon Security Lake source. For more details about source versions supported by Amazon Security Lake see OCSF source identification in the Amazon Security Lake User Guide.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-subscriber-awslogsource.html

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.mixins_preview.aws_securitylake import mixins as securitylake_mixins

aws_log_source_property = securitylake_mixins.CfnSubscriberPropsMixin.AwsLogSourceProperty(
    source_name="sourceName",
    source_version="sourceVersion"
)

Attributes

source_name

Source name of the natively supported AWS service that is supported as an Amazon Security Lake source.

For the list of sources supported by Amazon Security Lake see Collecting data from AWS services in the Amazon Security Lake User Guide.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-subscriber-awslogsource.html#cfn-securitylake-subscriber-awslogsource-sourcename

source_version

Source version of the natively supported AWS service that is supported as an Amazon Security Lake source.

For more details about source versions supported by Amazon Security Lake see OCSF source identification in the Amazon Security Lake User Guide.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-subscriber-awslogsource.html#cfn-securitylake-subscriber-awslogsource-sourceversion

CustomLogSourceProperty

class CfnSubscriberPropsMixin.CustomLogSourceProperty(*, source_name=None, source_version=None)

Bases: object

Third-party custom log source that meets the requirements to be added to Amazon Security Lake .

For more details, see Custom log source in the Amazon Security Lake User Guide .

Parameters:

source_name (Optional[str]) – The name of the custom log source.
source_version (Optional[str]) – The source version of the custom log source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-subscriber-customlogsource.html

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.mixins_preview.aws_securitylake import mixins as securitylake_mixins

custom_log_source_property = securitylake_mixins.CfnSubscriberPropsMixin.CustomLogSourceProperty(
    source_name="sourceName",
    source_version="sourceVersion"
)

Attributes

source_name

The name of the custom log source.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-subscriber-customlogsource.html#cfn-securitylake-subscriber-customlogsource-sourcename

source_version

The source version of the custom log source.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-subscriber-customlogsource.html#cfn-securitylake-subscriber-customlogsource-sourceversion

SourceProperty

class CfnSubscriberPropsMixin.SourceProperty(*, aws_log_source=None, custom_log_source=None)

Bases: object

Sources are logs and events generated from a single system that match a specific event class in the Open Cybersecurity Schema Framework (OCSF) schema.

Amazon Security Lake can collect logs and events from a variety of sources, including natively supported AWS services and third-party custom sources.

Parameters:

aws_log_source (Union[IResolvable, AwsLogSourceProperty, Dict[str, Any], None]) – The natively supported AWS service which is used a Amazon Security Lake source to collect logs and events from.
custom_log_source (Union[IResolvable, CustomLogSourceProperty, Dict[str, Any], None]) – The custom log source AWS which is used a Amazon Security Lake source to collect logs and events from.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-subscriber-source.html

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.mixins_preview.aws_securitylake import mixins as securitylake_mixins

source_property = securitylake_mixins.CfnSubscriberPropsMixin.SourceProperty(
    aws_log_source=securitylake_mixins.CfnSubscriberPropsMixin.AwsLogSourceProperty(
        source_name="sourceName",
        source_version="sourceVersion"
    ),
    custom_log_source=securitylake_mixins.CfnSubscriberPropsMixin.CustomLogSourceProperty(
        source_name="sourceName",
        source_version="sourceVersion"
    )
)

Attributes

aws_log_source

The natively supported AWS service which is used a Amazon Security Lake source to collect logs and events from.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-subscriber-source.html#cfn-securitylake-subscriber-source-awslogsource

custom_log_source

The custom log source AWS which is used a Amazon Security Lake source to collect logs and events from.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-subscriber-source.html#cfn-securitylake-subscriber-source-customlogsource

SubscriberIdentityProperty

class CfnSubscriberPropsMixin.SubscriberIdentityProperty(*, external_id=None, principal=None)

Bases: object

Specify the AWS account ID and external ID that the subscriber will use to access source data.

Parameters:

external_id (Optional[str]) – The external ID is a unique identifier that the subscriber provides to you.
principal (Optional[str]) – Principals can include accounts, users, roles, federated users, or AWS services.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securitylake-subscriber-subscriberidentity.html

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.mixins_preview.aws_securitylake import mixins as securitylake_mixins

subscriber_identity_property = securitylake_mixins.CfnSubscriberPropsMixin.SubscriberIdentityProperty(
    external_id="externalId",
    principal="principal"
)

Attributes

external_id

The external ID is a unique identifier that the subscriber provides to you.

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

principal

Principals can include accounts, users, roles, federated users, or AWS services.

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