Class: AWSCDK::CleanRooms::CfnMembership::ProtectedQueryS3OutputConfigurationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
clean_rooms/cfn_membership.rb

Overview

Contains the configuration to write the query results to S3.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(bucket:, result_format:, key_prefix: nil, single_file_output: nil) ⇒ ProtectedQueryS3OutputConfigurationProperty

Returns a new instance of ProtectedQueryS3OutputConfigurationProperty.

Parameters:

  • bucket (String) —

    The S3 bucket to unload the protected query results.

  • result_format (String) —

    Intended file format of the result.

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

    The S3 prefix to unload the protected query results.

  • single_file_output (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Indicates whether files should be output as a single file ( TRUE ) or output as multiple files ( FALSE ).



1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
 
# File 'clean_rooms/cfn_membership.rb', line 1138

def initialize(bucket:, result_format:, key_prefix: nil, single_file_output: nil)
  @bucket = bucket
  Jsii::Type.check_type(@bucket, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "bucket")
  @result_format = result_format
  Jsii::Type.check_type(@result_format, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "resultFormat")
  @key_prefix = key_prefix
  Jsii::Type.check_type(@key_prefix, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "keyPrefix") unless @key_prefix.nil?
  @single_file_output = single_file_output
  Jsii::Type.check_type(@single_file_output, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "singleFileOutput") unless @single_file_output.nil?
end

Instance Attribute Details

#bucket ⇒ String (readonly)

The S3 bucket to unload the protected query results.

Returns:

  • (String)

See Also:



1153
1154
1155
 
# File 'clean_rooms/cfn_membership.rb', line 1153

def bucket
  @bucket
end

#key_prefix ⇒ String? (readonly)

The S3 prefix to unload the protected query results.

Returns:

  • (String, nil)

See Also:



1163
1164
1165
 
# File 'clean_rooms/cfn_membership.rb', line 1163

def key_prefix
  @key_prefix
end

#result_format ⇒ String (readonly)

Intended file format of the result.

Returns:

  • (String)

See Also:



1158
1159
1160
 
# File 'clean_rooms/cfn_membership.rb', line 1158

def result_format
  @result_format
end

#single_file_output ⇒ Boolean, ... (readonly)

Indicates whether files should be output as a single file ( TRUE ) or output as multiple files ( FALSE ).

This parameter is only supported for analyses with the Spark analytics engine.

Returns:

See Also:



1170
1171
1172
 
# File 'clean_rooms/cfn_membership.rb', line 1170

def single_file_output
  @single_file_output
end

Class Method Details

.jsii_properties ⇒ Object 



1172
1173
1174
1175
1176
1177
1178
1179
 
# File 'clean_rooms/cfn_membership.rb', line 1172

def self.jsii_properties
  {
    :bucket => "bucket",
    :result_format => "resultFormat",
    :key_prefix => "keyPrefix",
    :single_file_output => "singleFileOutput",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
 
# File 'clean_rooms/cfn_membership.rb', line 1181

def to_jsii
  result = {}
  result.merge!({
    "bucket" => @bucket,
    "resultFormat" => @result_format,
    "keyPrefix" => @key_prefix,
    "singleFileOutput" => @single_file_output,
  })
  result.compact
end