Skip to content
v2.277.0

Experimental

@aws-cdk/aws-pipes-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

S3LogDestinationProps Struct ​

Properties for S3LogDestination.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as pipes_alpha from '@aws-cdk/aws-pipes-alpha';
import { aws_s3 as s3 } from 'aws-cdk-lib';

declare const bucket: s3.Bucket;
const s3LogDestinationProps: pipes_alpha.S3LogDestinationProps = {
  bucket: bucket,

  // the properties below are optional
  bucketOwner: 'bucketOwner',
  outputFormat: pipes_alpha.S3OutputFormat.PLAIN,
  prefix: 'prefix',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_pipes_alpha as pipes_alpha
from aws_cdk import aws_s3 as s3

# bucket: s3.Bucket

s3_log_destination_props = pipes_alpha.S3LogDestinationProps(
    bucket=bucket,

    # the properties below are optional
    bucket_owner="bucketOwner",
    output_format=pipes_alpha.S3OutputFormat.PLAIN,
    prefix="prefix"
)
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.pipes.alpha.*;
import software.amazon.awscdk.services.s3.*;

Bucket bucket;

S3LogDestinationProps s3LogDestinationProps = S3LogDestinationProps.builder()
        .bucket(bucket)

        // the properties below are optional
        .bucketOwner("bucketOwner")
        .outputFormat(S3OutputFormat.PLAIN)
        .prefix("prefix")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.AWS.Pipes.Alpha
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Pipes.Alpha;
using Amazon.CDK.AWS.S3;

Bucket bucket;

var s3LogDestinationProps = new S3LogDestinationProps {
    Bucket = bucket,

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

var bucket Bucket

s3LogDestinationProps := &S3LogDestinationProps{
	Bucket: bucket,

	// the properties below are optional
	BucketOwner: jsii.String("bucketOwner"),
	OutputFormat: pipes_alpha.S3OutputFormat_PLAIN,
	Prefix: jsii.String("prefix"),
}

Properties ​

bucketIBucketbucketIBucketbucketIBucketBucketIBucketBucketIBucket required #
The S3 bucket to deliver the log records for the pipe.

The bucket can be in the same or a different AWS Account. If the bucket is in a different account, specify bucketOwner. You must also allow access to the Pipes role in the bucket policy of the cross-account bucket.

bucketOwneroptionalstringbucket_owneroptionalstrbucketOwneroptionalStringBucketOwneroptionalstringBucketOwneroptional*string #
The AWS Account that owns the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.

Default: account ID derived from bucket

outputFormatoptionalS3OutputFormatoutput_formatoptionalS3OutputFormatoutputFormatoptionalS3OutputFormatOutputFormatoptionalS3OutputFormatOutputFormatoptionalS3OutputFormat = `S3OutputFormat.JSON` #
The format for the log records.
prefixoptionalstringprefixoptionalstrprefixoptionalStringPrefixoptionalstringPrefixoptional*string #
The prefix text with which to begin Amazon S3 log object names.

Default: no prefix