CfnSubscriber

class aws_cdk.aws_securitylake.CfnSubscriber(scope, id, *, access_types, data_lake_arn, sources, subscriber_identity, subscriber_name, subscriber_description=None, tags=None)

Bases: CfnResource

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
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 = securitylake.CfnSubscriber(self, "MyCfnSubscriber",
    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"
    )]
)

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
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 as LAKEFORMATION .
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 includes subscriberName , accountID , externalID , and subscriberId .
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.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str) –
value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

policy (Optional[RemovalPolicy]) –
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::SecurityLake::Subscriber'

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.

attr_resource_share_arn

The Amazon Resource Name (ARN) of the Amazon Security Lake subscriber.

CloudformationAttribute:: ResourceShareArn

attr_resource_share_name

The ARN name of the Amazon Security Lake subscriber.

CloudformationAttribute:: ResourceShareName

attr_s3_bucket_arn

The Amazon Resource Name (ARN) of the S3 bucket.

CloudformationAttribute:: S3BucketArn

attr_subscriber_arn

The Amazon Resource Name (ARN) of the Security Lake subscriber.

CloudformationAttribute:: SubscriberArn

attr_subscriber_role_arn

The Amazon Resource Name (ARN) of the role used to create the Security Lake subscriber.

CloudformationAttribute:: SubscriberRoleArn

cdk_tag_manager: Tag Manager which manages the tags for this resource.

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

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

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

node: The tree node.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

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

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

subscriber_description: The subscriber descriptions for a subscriber account.

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.

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

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

AwsLogSourceProperty

class CfnSubscriber.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 import aws_securitylake as securitylake

aws_log_source_property = securitylake.CfnSubscriber.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 CfnSubscriber.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 import aws_securitylake as securitylake

custom_log_source_property = securitylake.CfnSubscriber.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 CfnSubscriber.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 import aws_securitylake as securitylake

source_property = 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"
    )
)

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 CfnSubscriber.SubscriberIdentityProperty(*, external_id, principal)

Bases: object

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

Parameters:

external_id (str) – The external ID is a unique identifier that the subscriber provides to you.
principal (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 import aws_securitylake as securitylake

subscriber_identity_property = securitylake.CfnSubscriber.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