Package software.amazon.awscdk.cfnpropertymixins.services.cognito

Interface CfnLogDeliveryConfigurationPropsMixin.LogConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLogDeliveryConfigurationPropsMixin.LogConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnLogDeliveryConfigurationPropsMixin

@Stability(Stable)
public static interface CfnLogDeliveryConfigurationPropsMixin.LogConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

The configuration of user event logs to an external AWS service like Amazon Data Firehose, Amazon S3, or Amazon CloudWatch Logs.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.cognito.*;
 LogConfigurationProperty logConfigurationProperty = LogConfigurationProperty.builder()
         .cloudWatchLogsConfiguration(CloudWatchLogsConfigurationProperty.builder()
                 .logGroupArn("logGroupArn")
                 .build())
         .eventSource("eventSource")
         .firehoseConfiguration(FirehoseConfigurationProperty.builder()
                 .streamArn("streamArn")
                 .build())
         .logLevel("logLevel")
         .s3Configuration(S3ConfigurationProperty.builder()
                 .bucketArn("bucketArn")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-logconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnLogDeliveryConfigurationPropsMixin.LogConfigurationProperty.Builder	builder()
default Object	getCloudWatchLogsConfiguration()	Configuration for the CloudWatch log group destination of user pool detailed activity logging, or of user activity log export with advanced security features.
default String	getEventSource()	The source of events that your user pool sends for logging.
default Object	getFirehoseConfiguration()	Configuration for the Amazon Data Firehose stream destination of user activity log export with threat protection.
default String	getLogLevel()	The errorlevel selection of logs that a user pool sends for detailed activity logging.
default Object	getS3Configuration()	Configuration for the Amazon S3 bucket destination of user activity log export with threat protection.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCloudWatchLogsConfiguration

@Stability(Stable)
@Nullable
default Object getCloudWatchLogsConfiguration()

Configuration for the CloudWatch log group destination of user pool detailed activity logging, or of user activity log export with advanced security features.

Returns union: either IResolvable or CfnLogDeliveryConfigurationPropsMixin.CloudWatchLogsConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-logconfiguration.html#cfn-cognito-logdeliveryconfiguration-logconfiguration-cloudwatchlogsconfiguration

getEventSource

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

The source of events that your user pool sends for logging.

To send error-level logs about user notification activity, set to userNotification . To send info-level logs about threat-protection user activity in user pools with the Plus feature plan, set to userAuthEvents .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-logconfiguration.html#cfn-cognito-logdeliveryconfiguration-logconfiguration-eventsource

getFirehoseConfiguration

@Stability(Stable)
@Nullable
default Object getFirehoseConfiguration()

Configuration for the Amazon Data Firehose stream destination of user activity log export with threat protection.

Returns union: either IResolvable or CfnLogDeliveryConfigurationPropsMixin.FirehoseConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-logconfiguration.html#cfn-cognito-logdeliveryconfiguration-logconfiguration-firehoseconfiguration

getLogLevel

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

The errorlevel selection of logs that a user pool sends for detailed activity logging.

To send userNotification activity with information about message delivery , choose ERROR with CloudWatchLogsConfiguration . To send userAuthEvents activity with user logs from threat protection with the Plus feature plan, choose INFO with one of CloudWatchLogsConfiguration , FirehoseConfiguration , or S3Configuration .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-logconfiguration.html#cfn-cognito-logdeliveryconfiguration-logconfiguration-loglevel

getS3Configuration

@Stability(Stable)
@Nullable
default Object getS3Configuration()

Configuration for the Amazon S3 bucket destination of user activity log export with threat protection.

Returns union: either IResolvable or CfnLogDeliveryConfigurationPropsMixin.S3ConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-logconfiguration.html#cfn-cognito-logdeliveryconfiguration-logconfiguration-s3configuration

builder

@Stability(Stable)
static CfnLogDeliveryConfigurationPropsMixin.LogConfigurationProperty.Builder builder()

Returns:

a CfnLogDeliveryConfigurationPropsMixin.LogConfigurationProperty.Builder of CfnLogDeliveryConfigurationPropsMixin.LogConfigurationProperty