Skip to content
v2.277.0

S3LogConfigurationProperty Struct ​

The S3 log configuration.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_workspacesweb as workspacesweb } from 'aws-cdk-lib';
const s3LogConfigurationProperty: workspacesweb.CfnSessionLogger.S3LogConfigurationProperty = {
  bucket: 'bucket',
  folderStructure: 'folderStructure',
  logFileFormat: 'logFileFormat',

  // the properties below are optional
  bucketOwner: 'bucketOwner',
  keyPrefix: 'keyPrefix',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_workspacesweb as workspacesweb

s3_log_configuration_property = workspacesweb.CfnSessionLogger.S3LogConfigurationProperty(
    bucket="bucket",
    folder_structure="folderStructure",
    log_file_format="logFileFormat",

    # the properties below are optional
    bucket_owner="bucketOwner",
    key_prefix="keyPrefix"
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.WorkSpacesWeb;

var s3LogConfigurationProperty = new S3LogConfigurationProperty {
    Bucket = "bucket",
    FolderStructure = "folderStructure",
    LogFileFormat = "logFileFormat",

    // the properties below are optional
    BucketOwner = "bucketOwner",
    KeyPrefix = "keyPrefix"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

s3LogConfigurationProperty := &S3LogConfigurationProperty{
	Bucket: jsii.String("bucket"),
	FolderStructure: jsii.String("folderStructure"),
	LogFileFormat: jsii.String("logFileFormat"),

	// the properties below are optional
	BucketOwner: jsii.String("bucketOwner"),
	KeyPrefix: jsii.String("keyPrefix"),
}

Properties ​

bucketstringbucketstrbucketStringBucketstringBucket*string required #
The S3 bucket name where logs are delivered.
bucketOwneroptionalstringbucket_owneroptionalstrbucketOwneroptionalStringBucketOwneroptionalstringBucketOwneroptional*string #
The expected bucket owner of the target S3 bucket.

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

folderStructurestringfolder_structurestrfolderStructureStringFolderStructurestringFolderStructure*string required #
The folder structure that defines the organizational structure for log files in S3.
keyPrefixoptionalstringkey_prefixoptionalstrkeyPrefixoptionalStringKeyPrefixoptionalstringKeyPrefixoptional*string #
The S3 path prefix that determines where log files are stored.
logFileFormatstringlog_file_formatstrlogFileFormatStringLogFileFormatstringLogFileFormat*string required #
The format of the LogFile that is written to S3.