Class: AWSCDK::Pipes::CfnPipe::PipeLogConfigurationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
pipes/cfn_pipe.rb

Overview

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

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(cloudwatch_logs_log_destination: nil, firehose_log_destination: nil, include_execution_data: nil, level: nil, s3_log_destination: nil) ⇒ PipeLogConfigurationProperty

Returns a new instance of PipeLogConfigurationProperty.

Parameters:



2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
 
# File 'pipes/cfn_pipe.rb', line 2167

def initialize(cloudwatch_logs_log_destination: nil, firehose_log_destination: nil, include_execution_data: nil, level: nil, s3_log_destination: nil)
  @cloudwatch_logs_log_destination = cloudwatch_logs_log_destination.is_a?(Hash) ? ::AWSCDK::Pipes::CfnPipe::CloudwatchLogsLogDestinationProperty.new(**cloudwatch_logs_log_destination.transform_keys(&:to_sym)) : cloudwatch_logs_log_destination
  Jsii::Type.check_type(@cloudwatch_logs_log_destination, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19waXBlcy5DZm5QaXBlLkNsb3Vkd2F0Y2hMb2dzTG9nRGVzdGluYXRpb25Qcm9wZXJ0eSJ9XX19")), "cloudwatchLogsLogDestination") unless @cloudwatch_logs_log_destination.nil?
  @firehose_log_destination = firehose_log_destination.is_a?(Hash) ? ::AWSCDK::Pipes::CfnPipe::FirehoseLogDestinationProperty.new(**firehose_log_destination.transform_keys(&:to_sym)) : firehose_log_destination
  Jsii::Type.check_type(@firehose_log_destination, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19waXBlcy5DZm5QaXBlLkZpcmVob3NlTG9nRGVzdGluYXRpb25Qcm9wZXJ0eSJ9XX19")), "firehoseLogDestination") unless @firehose_log_destination.nil?
  @include_execution_data = include_execution_data
  Jsii::Type.check_type(@include_execution_data, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "includeExecutionData") unless @include_execution_data.nil?
  @level = level
  Jsii::Type.check_type(@level, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "level") unless @level.nil?
  @s3_log_destination = s3_log_destination.is_a?(Hash) ? ::AWSCDK::Pipes::CfnPipe::S3LogDestinationProperty.new(**s3_log_destination.transform_keys(&:to_sym)) : s3_log_destination
  Jsii::Type.check_type(@s3_log_destination, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19waXBlcy5DZm5QaXBlLlMzTG9nRGVzdGluYXRpb25Qcm9wZXJ0eSJ9XX19")), "s3LogDestination") unless @s3_log_destination.nil?
end

Instance Attribute Details

#cloudwatch_logs_log_destination ⇒ AWSCDK::IResolvable, ... (readonly)

The logging configuration settings for the pipe.

Returns:

See Also:



2184
2185
2186
 
# File 'pipes/cfn_pipe.rb', line 2184

def cloudwatch_logs_log_destination
  @cloudwatch_logs_log_destination
end

#firehose_log_destination ⇒ AWSCDK::IResolvable, ... (readonly)

The Amazon Data Firehose logging configuration settings for the pipe.

Returns:

See Also:



2189
2190
2191
 
# File 'pipes/cfn_pipe.rb', line 2189

def firehose_log_destination
  @firehose_log_destination
end

#include_execution_data ⇒ Array<String>? (readonly)

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

Returns:

  • (Array<String>, nil)

See Also:



2200
2201
2202
 
# File 'pipes/cfn_pipe.rb', line 2200

def include_execution_data
  @include_execution_data
end

#level ⇒ String? (readonly)

The level of logging detail to include.

This applies to all log destinations for the pipe.

Returns:

  • (String, nil)

See Also:



2207
2208
2209
 
# File 'pipes/cfn_pipe.rb', line 2207

def level
  @level
end

#s3_log_destination ⇒ AWSCDK::IResolvable, ... (readonly)

The Amazon S3 logging configuration settings for the pipe.

Returns:

See Also:



2212
2213
2214
 
# File 'pipes/cfn_pipe.rb', line 2212

def s3_log_destination
  @s3_log_destination
end

Class Method Details

.jsii_properties ⇒ Object 



2214
2215
2216
2217
2218
2219
2220
2221
2222
 
# File 'pipes/cfn_pipe.rb', line 2214

def self.jsii_properties
  {
    :cloudwatch_logs_log_destination => "cloudwatchLogsLogDestination",
    :firehose_log_destination => "firehoseLogDestination",
    :include_execution_data => "includeExecutionData",
    :level => "level",
    :s3_log_destination => "s3LogDestination",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
 
# File 'pipes/cfn_pipe.rb', line 2224

def to_jsii
  result = {}
  result.merge!({
    "cloudwatchLogsLogDestination" => @cloudwatch_logs_log_destination,
    "firehoseLogDestination" => @firehose_log_destination,
    "includeExecutionData" => @include_execution_data,
    "level" => @level,
    "s3LogDestination" => @s3_log_destination,
  })
  result.compact
end