Package software.amazon.awscdk.services.workspacesweb

Class CfnSessionLogger

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.workspacesweb.CfnSessionLogger
All Implemented Interfaces:
IInspectable, IEnvironmentAware, ISessionLoggerRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-20T23:37:32.175Z") @Stability(Stable) public class CfnSessionLogger extends CfnResource implements IInspectable, ISessionLoggerRef, ITaggableV2
The session logger resource.

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.workspacesweb.*;
 Object all;
 CfnSessionLogger cfnSessionLogger = CfnSessionLogger.Builder.create(this, "MyCfnSessionLogger")
         .eventFilter(EventFilterProperty.builder()
                 .all(all)
                 .include(List.of("include"))
                 .build())
         .logConfiguration(LogConfigurationProperty.builder()
                 .s3(S3LogConfigurationProperty.builder()
                         .bucket("bucket")
                         .folderStructure("folderStructure")
                         .logFileFormat("logFileFormat")
                         // the properties below are optional
                         .bucketOwner("bucketOwner")
                         .keyPrefix("keyPrefix")
                         .build())
                 .build())
         // the properties below are optional
         .additionalEncryptionContext(Map.of(
                 "additionalEncryptionContextKey", "additionalEncryptionContext"))
         .customerManagedKey("customerManagedKey")
         .displayName("displayName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .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

    • CfnSessionLogger

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

    • CfnSessionLogger

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

    • CfnSessionLogger

      @Stability(Stable) public CfnSessionLogger(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnSessionLoggerProps props)
      Create a new AWS::WorkSpacesWeb::SessionLogger.

      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

    • arnForSessionLogger

      @Stability(Stable) @NotNull public static String arnForSessionLogger(@NotNull ISessionLoggerRef resource)
      Parameters:
      resource - This parameter is required.

    • 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.

    • getAttrAssociatedPortalArns

      @Stability(Stable) @NotNull public List<String> getAttrAssociatedPortalArns()
      The associated portal ARN.

    • getAttrCreationDate

      @Stability(Stable) @NotNull public String getAttrCreationDate()
      The date the session logger resource was created.

    • getAttrSessionLoggerArn

      @Stability(Stable) @NotNull public String getAttrSessionLoggerArn()
      The ARN of the session logger resource.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

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

    • getSessionLoggerRef

      @Stability(Stable) @NotNull public SessionLoggerReference getSessionLoggerRef()
      A reference to a SessionLogger resource.
      Specified by:
      getSessionLoggerRef in interface ISessionLoggerRef

    • getEventFilter

      @Stability(Stable) @NotNull public Object getEventFilter()
      The filter that specifies which events to monitor.

      Returns union: either IResolvable or CfnSessionLogger.EventFilterProperty

    • setEventFilter

      @Stability(Stable) public void setEventFilter(@NotNull IResolvable value)
      The filter that specifies which events to monitor.

    • setEventFilter

      @Stability(Stable) public void setEventFilter(@NotNull CfnSessionLogger.EventFilterProperty value)
      The filter that specifies which events to monitor.

    • getLogConfiguration

      @Stability(Stable) @NotNull public Object getLogConfiguration()
      The configuration that specifies where logs are fowarded.

      Returns union: either IResolvable or CfnSessionLogger.LogConfigurationProperty

    • setLogConfiguration

      @Stability(Stable) public void setLogConfiguration(@NotNull IResolvable value)
      The configuration that specifies where logs are fowarded.

    • setLogConfiguration

      @Stability(Stable) public void setLogConfiguration(@NotNull CfnSessionLogger.LogConfigurationProperty value)
      The configuration that specifies where logs are fowarded.

    • getAdditionalEncryptionContext

      @Stability(Stable) @Nullable public Object getAdditionalEncryptionContext()
      The additional encryption context of the session logger.

      Returns union: either Mapinvalid input: '<'String, String> or IResolvable

    • setAdditionalEncryptionContext

      @Stability(Stable) public void setAdditionalEncryptionContext(@Nullable Map<String,String> value)
      The additional encryption context of the session logger.

    • setAdditionalEncryptionContext

      @Stability(Stable) public void setAdditionalEncryptionContext(@Nullable IResolvable value)
      The additional encryption context of the session logger.

    • getCustomerManagedKey

      @Stability(Stable) @Nullable public String getCustomerManagedKey()
      The custom managed key of the session logger.

    • setCustomerManagedKey

      @Stability(Stable) public void setCustomerManagedKey(@Nullable String value)
      The custom managed key of the session logger.

    • getDisplayName

      @Stability(Stable) @Nullable public String getDisplayName()
      The human-readable display name.

    • setDisplayName

      @Stability(Stable) public void setDisplayName(@Nullable String value)
      The human-readable display name.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The tags of the session logger.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The tags of the session logger.