Class: AWSCDK::Pipes::CfnPipe::S3LogDestinationProperty

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

Overview

Represents the Amazon S3 logging configuration settings for the pipe.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(bucket_name: nil, bucket_owner: nil, output_format: nil, prefix: nil) ⇒ S3LogDestinationProperty

Returns a new instance of S3LogDestinationProperty.

Parameters:

  • bucket_name (String, nil) (defaults to: nil) —

    The name of the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.

  • bucket_owner (String, nil) (defaults to: nil) —

    The AWS account that owns the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.

  • output_format (String, nil) (defaults to: nil) —

    The format EventBridge uses for the log records.

  • prefix (String, nil) (defaults to: nil) —

    The prefix text with which to begin Amazon S3 log object names.



4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
 
# File 'pipes/cfn_pipe.rb', line 4114

def initialize(bucket_name: nil, bucket_owner: nil, output_format: nil, prefix: nil)
  @bucket_name = bucket_name
  Jsii::Type.check_type(@bucket_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "bucketName") unless @bucket_name.nil?
  @bucket_owner = bucket_owner
  Jsii::Type.check_type(@bucket_owner, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "bucketOwner") unless @bucket_owner.nil?
  @output_format = output_format
  Jsii::Type.check_type(@output_format, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "outputFormat") unless @output_format.nil?
  @prefix = prefix
  Jsii::Type.check_type(@prefix, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "prefix") unless @prefix.nil?
end

Instance Attribute Details

#bucket_name ⇒ String? (readonly)

The name of the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.

Returns:

  • (String, nil)

See Also:



4129
4130
4131
 
# File 'pipes/cfn_pipe.rb', line 4129

def bucket_name
  @bucket_name
end

#bucket_owner ⇒ String? (readonly)

The AWS account that owns the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.

Returns:

  • (String, nil)

See Also:



4134
4135
4136
 
# File 'pipes/cfn_pipe.rb', line 4134

def bucket_owner
  @bucket_owner
end

#output_format ⇒ String? (readonly)

The format EventBridge uses for the log records.

EventBridge currently only supports json formatting.

Returns:

  • (String, nil)

See Also:



4141
4142
4143
 
# File 'pipes/cfn_pipe.rb', line 4141

def output_format
  @output_format
end

#prefix ⇒ String? (readonly)

The prefix text with which to begin Amazon S3 log object names.

For more information, see Organizing objects using prefixes in the Amazon Simple Storage Service User Guide .

Returns:

  • (String, nil)

See Also:



4148
4149
4150
 
# File 'pipes/cfn_pipe.rb', line 4148

def prefix
  @prefix
end

Class Method Details

.jsii_properties ⇒ Object 



4150
4151
4152
4153
4154
4155
4156
4157
 
# File 'pipes/cfn_pipe.rb', line 4150

def self.jsii_properties
  {
    :bucket_name => "bucketName",
    :bucket_owner => "bucketOwner",
    :output_format => "outputFormat",
    :prefix => "prefix",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
 
# File 'pipes/cfn_pipe.rb', line 4159

def to_jsii
  result = {}
  result.merge!({
    "bucketName" => @bucket_name,
    "bucketOwner" => @bucket_owner,
    "outputFormat" => @output_format,
    "prefix" => @prefix,
  })
  result.compact
end