Class: AWSCDK::Redshift::CfnCluster::LoggingPropertiesProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
redshift/cfn_cluster.rb

Overview

Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(bucket_name: nil, log_destination_type: nil, log_exports: nil, s3_key_prefix: nil) ⇒ LoggingPropertiesProperty

Returns a new instance of LoggingPropertiesProperty.

Parameters:

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

    The name of an existing S3 bucket where the log files are to be stored.

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

    The log destination type.

  • log_exports (Array<String>, nil) (defaults to: nil) —

    The collection of exported log types.

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

    The prefix applied to the log file names.



1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
 
# File 'redshift/cfn_cluster.rb', line 1271

def initialize(bucket_name: nil, log_destination_type: nil, log_exports: nil, s3_key_prefix: nil)
  @bucket_name = bucket_name
  Jsii::Type.check_type(@bucket_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "bucketName") unless @bucket_name.nil?
  @log_destination_type = log_destination_type
  Jsii::Type.check_type(@log_destination_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "logDestinationType") unless @log_destination_type.nil?
  @log_exports = log_exports
  Jsii::Type.check_type(@log_exports, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "logExports") unless @log_exports.nil?
  @s3_key_prefix = s3_key_prefix
  Jsii::Type.check_type(@s3_key_prefix, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "s3KeyPrefix") unless @s3_key_prefix.nil?
end

Instance Attribute Details

#bucket_name ⇒ String? (readonly)

The name of an existing S3 bucket where the log files are to be stored.

Constraints:

  • Must be in the same region as the cluster
  • The cluster must have read bucket and put object permissions

Returns:

  • (String, nil)

See Also:



1291
1292
1293
 
# File 'redshift/cfn_cluster.rb', line 1291

def bucket_name
  @bucket_name
end

#log_destination_type ⇒ String? (readonly)

The log destination type.

An enum with possible values of s3 and cloudwatch .

Returns:

  • (String, nil)

See Also:



1298
1299
1300
 
# File 'redshift/cfn_cluster.rb', line 1298

def log_destination_type
  @log_destination_type
end

#log_exports ⇒ Array<String>? (readonly)

The collection of exported log types.

Possible values are connectionlog , useractivitylog , and userlog .

Returns:

  • (Array<String>, nil)

See Also:



1305
1306
1307
 
# File 'redshift/cfn_cluster.rb', line 1305

def log_exports
  @log_exports
end

#s3_key_prefix ⇒ String? (readonly)

The prefix applied to the log file names.

Valid characters are any letter from any language, any whitespace character, any numeric character, and the following characters: underscore ( _ ), period ( . ), colon ( : ), slash ( / ), equal ( = ), plus ( + ), backslash ( \ ), hyphen ( - ), at symbol ( @ ).

Returns:

  • (String, nil)

See Also:



1312
1313
1314
 
# File 'redshift/cfn_cluster.rb', line 1312

def s3_key_prefix
  @s3_key_prefix
end

Class Method Details

.jsii_properties ⇒ Object 



1314
1315
1316
1317
1318
1319
1320
1321
 
# File 'redshift/cfn_cluster.rb', line 1314

def self.jsii_properties
  {
    :bucket_name => "bucketName",
    :log_destination_type => "logDestinationType",
    :log_exports => "logExports",
    :s3_key_prefix => "s3KeyPrefix",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
 
# File 'redshift/cfn_cluster.rb', line 1323

def to_jsii
  result = {}
  result.merge!({
    "bucketName" => @bucket_name,
    "logDestinationType" => @log_destination_type,
    "logExports" => @log_exports,
    "s3KeyPrefix" => @s3_key_prefix,
  })
  result.compact
end