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.

S3LogDestination Class ​

S3 bucket for delivery of pipe logs.

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 s3LogDestination = new pipes_alpha.S3LogDestination({
  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 = pipes_alpha.S3LogDestination(
    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;

S3LogDestination s3LogDestination = S3LogDestination.Builder.create()
        .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 s3LogDestination = new S3LogDestination(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 "github.com/aws/aws-cdk-go/awscdkpipesalpha"
import "github.com/aws/aws-cdk-go/awscdk"

var bucket Bucket

s3LogDestination := pipes_alpha.NewS3LogDestination(&S3LogDestinationProps{
	Bucket: bucket,

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

Initializer ​

ts
new S3LogDestination(parameters: S3LogDestinationProps)
python
S3LogDestination(parameters: S3LogDestinationProps)
java
new S3LogDestination(S3LogDestinationProps parameters)
csharp
new S3LogDestination(S3LogDestinationProps parameters)
go
NewS3LogDestination(Parameters S3LogDestinationProps)

Methods ​

bind(_pipe: IPipe): LogDestinationConfigdef bind(self, _pipe: IPipe) -> LogDestinationConfigpublic LogDestinationConfig bind(IPipe _pipe)public LogDestinationConfig Bind(IPipe _pipe)func Bind(_pipe IPipe) LogDestinationConfig#
Bind the log destination to the pipe.
grantPush(pipeRole: IRole): voiddef grant_push(self, pipe_role: IRole) -> Nonepublic void grantPush(IRole pipeRole)public void GrantPush(IRole pipeRole)func GrantPush(PipeRole IRole)#
Grant the pipe role to push to the log destination.