Package software.amazon.awscdk.services.workspacesweb

Interface CfnSessionLogger.S3LogConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSessionLogger.S3LogConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnSessionLogger

@Stability(Stable)
public static interface CfnSessionLogger.S3LogConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

The S3 log configuration.

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.*;
 S3LogConfigurationProperty s3LogConfigurationProperty = S3LogConfigurationProperty.builder()
         .bucket("bucket")
         .folderStructure("folderStructure")
         .logFileFormat("logFileFormat")
         // the properties below are optional
         .bucketOwner("bucketOwner")
         .keyPrefix("keyPrefix")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-sessionlogger-s3logconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnSessionLogger.S3LogConfigurationProperty.Builder	builder()
String	getBucket()	The S3 bucket name where logs are delivered.
default String	getBucketOwner()	The expected bucket owner of the target S3 bucket.
String	getFolderStructure()	The folder structure that defines the organizational structure for log files in S3.
default String	getKeyPrefix()	The S3 path prefix that determines where log files are stored.
String	getLogFileFormat()	The format of the LogFile that is written to S3.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBucket

@Stability(Stable)
@NotNull
String getBucket()

The S3 bucket name where logs are delivered.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-sessionlogger-s3logconfiguration.html#cfn-workspacesweb-sessionlogger-s3logconfiguration-bucket

getFolderStructure

@Stability(Stable)
@NotNull
String getFolderStructure()

The folder structure that defines the organizational structure for log files in S3.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-sessionlogger-s3logconfiguration.html#cfn-workspacesweb-sessionlogger-s3logconfiguration-folderstructure

getLogFileFormat

@Stability(Stable)
@NotNull
String getLogFileFormat()

The format of the LogFile that is written to S3.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-sessionlogger-s3logconfiguration.html#cfn-workspacesweb-sessionlogger-s3logconfiguration-logfileformat

getBucketOwner

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

The expected bucket owner of the target S3 bucket.

The caller must have permissions to write to the target bucket.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-sessionlogger-s3logconfiguration.html#cfn-workspacesweb-sessionlogger-s3logconfiguration-bucketowner

getKeyPrefix

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

The S3 path prefix that determines where log files are stored.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-sessionlogger-s3logconfiguration.html#cfn-workspacesweb-sessionlogger-s3logconfiguration-keyprefix

builder

@Stability(Stable)
static CfnSessionLogger.S3LogConfigurationProperty.Builder builder()

Returns:

a CfnSessionLogger.S3LogConfigurationProperty.Builder of CfnSessionLogger.S3LogConfigurationProperty