Package software.amazon.awscdk.services.cognito

Class CfnLogDeliveryConfiguration

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.cognito.CfnLogDeliveryConfiguration
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ILogDeliveryConfigurationRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:40:01.151Z") @Stability(Stable) public class CfnLogDeliveryConfiguration extends CfnResource implements IInspectable, ILogDeliveryConfigurationRef
Sets up or modifies the logging configuration of a user pool.

User pools can export user notification logs and, when threat protection is active, user-activity logs. For more information, see Exporting user pool 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.services.cognito.*;
 CfnLogDeliveryConfiguration cfnLogDeliveryConfiguration = CfnLogDeliveryConfiguration.Builder.create(this, "MyCfnLogDeliveryConfiguration")
         .userPoolId("userPoolId")
         // the properties below are optional
         .logConfigurations(List.of(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()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnLogDeliveryConfiguration

      protected CfnLogDeliveryConfiguration(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnLogDeliveryConfiguration

      protected CfnLogDeliveryConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnLogDeliveryConfiguration

      @Stability(Stable) public CfnLogDeliveryConfiguration(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnLogDeliveryConfigurationProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      A user pool ID, for example us-east-1_EXAMPLE .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getLogDeliveryConfigurationRef

      @Stability(Stable) @NotNull public LogDeliveryConfigurationReference getLogDeliveryConfigurationRef()
      A reference to a LogDeliveryConfiguration resource.
      Specified by:
      getLogDeliveryConfigurationRef in interface ILogDeliveryConfigurationRef

    • getUserPoolId

      @Stability(Stable) @NotNull public String getUserPoolId()
      The ID of the user pool where you configured logging.

    • setUserPoolId

      @Stability(Stable) public void setUserPoolId(@NotNull String value)
      The ID of the user pool where you configured logging.

    • getLogConfigurations

      @Stability(Stable) @Nullable public Object getLogConfigurations()
      A logging destination of a user pool.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnLogDeliveryConfiguration.LogConfigurationProperty>

    • setLogConfigurations

      @Stability(Stable) public void setLogConfigurations(@Nullable IResolvable value)
      A logging destination of a user pool.

    • setLogConfigurations

      @Stability(Stable) public void setLogConfigurations(@Nullable List<Object> value)
      A logging destination of a user pool.