Package software.amazon.awscdk.services.pipes

Interface CfnPipe.PipeLogConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPipe.PipeLogConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnPipe

@Stability(Stable)
public static interface CfnPipe.PipeLogConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Represents the configuration settings for the logs to which this pipe should report events.

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.pipes.*;
 PipeLogConfigurationProperty pipeLogConfigurationProperty = PipeLogConfigurationProperty.builder()
         .cloudwatchLogsLogDestination(CloudwatchLogsLogDestinationProperty.builder()
                 .logGroupArn("logGroupArn")
                 .build())
         .firehoseLogDestination(FirehoseLogDestinationProperty.builder()
                 .deliveryStreamArn("deliveryStreamArn")
                 .build())
         .includeExecutionData(List.of("includeExecutionData"))
         .level("level")
         .s3LogDestination(S3LogDestinationProperty.builder()
                 .bucketName("bucketName")
                 .bucketOwner("bucketOwner")
                 .outputFormat("outputFormat")
                 .prefix("prefix")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipelogconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnPipe.PipeLogConfigurationProperty.Builder	builder()
default Object	getCloudwatchLogsLogDestination()	The logging configuration settings for the pipe.
default Object	getFirehoseLogDestination()	The Amazon Data Firehose logging configuration settings for the pipe.
default List<String>	getIncludeExecutionData()	Whether the execution data (specifically, the payload , awsRequest , and awsResponse fields) is included in the log messages for this pipe.
default String	getLevel()	The level of logging detail to include.
default Object	getS3LogDestination()	The Amazon S3 logging configuration settings for the pipe.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCloudwatchLogsLogDestination

@Stability(Stable)
@Nullable
default Object getCloudwatchLogsLogDestination()

The logging configuration settings for the pipe.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipelogconfiguration.html#cfn-pipes-pipe-pipelogconfiguration-cloudwatchlogslogdestination

getFirehoseLogDestination

@Stability(Stable)
@Nullable
default Object getFirehoseLogDestination()

The Amazon Data Firehose logging configuration settings for the pipe.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipelogconfiguration.html#cfn-pipes-pipe-pipelogconfiguration-firehoselogdestination

getIncludeExecutionData

@Stability(Stable)
@Nullable
default List<String> getIncludeExecutionData()

Whether the execution data (specifically, the payload , awsRequest , and awsResponse fields) is included in the log messages for this pipe.

This applies to all log destinations for the pipe.

For more information, see Including execution data in logs in the Amazon EventBridge User Guide .

Allowed values: ALL

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipelogconfiguration.html#cfn-pipes-pipe-pipelogconfiguration-includeexecutiondata

getLevel

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

The level of logging detail to include.

This applies to all log destinations for the pipe.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipelogconfiguration.html#cfn-pipes-pipe-pipelogconfiguration-level

getS3LogDestination

@Stability(Stable)
@Nullable
default Object getS3LogDestination()

The Amazon S3 logging configuration settings for the pipe.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipelogconfiguration.html#cfn-pipes-pipe-pipelogconfiguration-s3logdestination

builder

@Stability(Stable)
static CfnPipe.PipeLogConfigurationProperty.Builder builder()

Returns:

a CfnPipe.PipeLogConfigurationProperty.Builder of CfnPipe.PipeLogConfigurationProperty