Package software.amazon.awscdk.services.cognito

Interface CfnLogDeliveryConfiguration.LogConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLogDeliveryConfiguration.LogConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnLogDeliveryConfiguration

@Stability(Stable)
public static interface CfnLogDeliveryConfiguration.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.

This data type is a request parameter of SetLogDeliveryConfiguration and a response parameter of GetLogDeliveryConfiguration .

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.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	CfnLogDeliveryConfiguration.LogConfigurationProperty.Builder	A builder for CfnLogDeliveryConfiguration.LogConfigurationProperty
static final class	CfnLogDeliveryConfiguration.LogConfigurationProperty.Jsii$Proxy	An implementation for CfnLogDeliveryConfiguration.LogConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnLogDeliveryConfiguration.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 advanced security features.
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 advanced security features.

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.

This data type is a request parameter of SetLogDeliveryConfiguration and a response parameter of GetLogDeliveryConfiguration .

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 advanced security features user activity, 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 advanced security features.

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 advanced security features, 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 advanced security features.

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 CfnLogDeliveryConfiguration.LogConfigurationProperty.Builder builder()

Returns:

a CfnLogDeliveryConfiguration.LogConfigurationProperty.Builder of CfnLogDeliveryConfiguration.LogConfigurationProperty