CfnSessionLoggerPropsMixin

class aws_cdk.mixins_preview.aws_workspacesweb.mixins.CfnSessionLoggerPropsMixin(props, *, strategy=None)

Bases: Mixin

The session logger resource.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-sessionlogger.html
CloudformationResource:: AWS::WorkSpacesWeb::SessionLogger
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_workspacesweb import mixins as workspacesweb_mixins

# all: Any

cfn_session_logger_props_mixin = workspacesweb_mixins.CfnSessionLoggerPropsMixin(workspacesweb_mixins.CfnSessionLoggerMixinProps(
    additional_encryption_context={
        "additional_encryption_context_key": "additionalEncryptionContext"
    },
    customer_managed_key="customerManagedKey",
    display_name="displayName",
    event_filter=workspacesweb_mixins.CfnSessionLoggerPropsMixin.EventFilterProperty(
        all=all,
        include=["include"]
    ),
    log_configuration=workspacesweb_mixins.CfnSessionLoggerPropsMixin.LogConfigurationProperty(
        s3=workspacesweb_mixins.CfnSessionLoggerPropsMixin.S3LogConfigurationProperty(
            bucket="bucket",
            bucket_owner="bucketOwner",
            folder_structure="folderStructure",
            key_prefix="keyPrefix",
            log_file_format="logFileFormat"
        )
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::WorkSpacesWeb::SessionLogger.

Parameters:

props (Union[CfnSessionLoggerMixinProps, 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 = ['additionalEncryptionContext', 'customerManagedKey', 'displayName', 'eventFilter', 'logConfiguration', '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

EventFilterProperty

class CfnSessionLoggerPropsMixin.EventFilterProperty(*, all=None, include=None)

Bases: object

The filter that specifies the events to monitor.

Parameters:

all (Any) – The filter that monitors all of the available events, including any new events emitted in the future. The All and Include properties are not required, but one of them should be present. {} is a valid input.
include (Optional[Sequence[str]]) – The filter that monitors only the listed set of events. New events are not auto-monitored. The All and Include properties are not required, but one of them should be present.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-sessionlogger-eventfilter.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_workspacesweb import mixins as workspacesweb_mixins

# all: Any

event_filter_property = workspacesweb_mixins.CfnSessionLoggerPropsMixin.EventFilterProperty(
    all=all,
    include=["include"]
)

Attributes

all

The filter that monitors all of the available events, including any new events emitted in the future.

The All and Include properties are not required, but one of them should be present. {} is a valid input.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-sessionlogger-eventfilter.html#cfn-workspacesweb-sessionlogger-eventfilter-all

include

The filter that monitors only the listed set of events.

New events are not auto-monitored. The All and Include properties are not required, but one of them should be present.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-sessionlogger-eventfilter.html#cfn-workspacesweb-sessionlogger-eventfilter-include

LogConfigurationProperty

class CfnSessionLoggerPropsMixin.LogConfigurationProperty(*, s3=None)

Bases: object

The configuration of the log.

Parameters:: s3 (Union[IResolvable, S3LogConfigurationProperty, Dict[str, Any], None]) – The configuration for delivering the logs to S3.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-sessionlogger-logconfiguration.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_workspacesweb import mixins as workspacesweb_mixins

log_configuration_property = workspacesweb_mixins.CfnSessionLoggerPropsMixin.LogConfigurationProperty(
    s3=workspacesweb_mixins.CfnSessionLoggerPropsMixin.S3LogConfigurationProperty(
        bucket="bucket",
        bucket_owner="bucketOwner",
        folder_structure="folderStructure",
        key_prefix="keyPrefix",
        log_file_format="logFileFormat"
    )
)

Attributes

s3

The configuration for delivering the logs to S3.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-sessionlogger-logconfiguration.html#cfn-workspacesweb-sessionlogger-logconfiguration-s3

S3LogConfigurationProperty

class CfnSessionLoggerPropsMixin.S3LogConfigurationProperty(*, bucket=None, bucket_owner=None, folder_structure=None, key_prefix=None, log_file_format=None)

Bases: object

The S3 log configuration.

Parameters:

bucket (Optional[str]) – The S3 bucket name where logs are delivered.
bucket_owner (Optional[str]) – The expected bucket owner of the target S3 bucket. The caller must have permissions to write to the target bucket.
folder_structure (Optional[str]) – The folder structure that defines the organizational structure for log files in S3.
key_prefix (Optional[str]) – The S3 path prefix that determines where log files are stored.
log_file_format (Optional[str]) – The format of the LogFile that is written to S3.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-sessionlogger-s3logconfiguration.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_workspacesweb import mixins as workspacesweb_mixins

s3_log_configuration_property = workspacesweb_mixins.CfnSessionLoggerPropsMixin.S3LogConfigurationProperty(
    bucket="bucket",
    bucket_owner="bucketOwner",
    folder_structure="folderStructure",
    key_prefix="keyPrefix",
    log_file_format="logFileFormat"
)