Class: AWSCDK::StepFunctionsTasks::Monitoring

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
step_functions_tasks/monitoring.rb

Overview

Configuration setting for monitoring.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(log_bucket: nil, logging: nil, log_group: nil, log_stream_name_prefix: nil, persistent_app_ui: nil) ⇒ Monitoring

Returns a new instance of Monitoring.

Parameters:

  • log_bucket (AWSCDK::S3::IBucket, nil) (defaults to: nil) —

    Amazon S3 Bucket for monitoring log publishing.

  • logging (Boolean, nil) (defaults to: nil) —

    Enable logging for this job.

  • log_group (AWSCDK::Logs::ILogGroup, nil) (defaults to: nil) —

    A log group for CloudWatch monitoring.

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

    A log stream name prefix for Cloudwatch monitoring.

  • persistent_app_ui (Boolean, nil) (defaults to: nil) —

    Monitoring configurations for the persistent application UI.



12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'step_functions_tasks/monitoring.rb', line 12

def initialize(log_bucket: nil, logging: nil, log_group: nil, log_stream_name_prefix: nil, persistent_app_ui: nil)
  @log_bucket = log_bucket
  Jsii::Type.check_type(@log_bucket, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfczMuSUJ1Y2tldCJ9")), "logBucket") unless @log_bucket.nil?
  @logging = logging
  Jsii::Type.check_type(@logging, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "logging") unless @logging.nil?
  @log_group = log_group
  Jsii::Type.check_type(@log_group, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbG9ncy5JTG9nR3JvdXAifQ==")), "logGroup") unless @log_group.nil?
  @log_stream_name_prefix = log_stream_name_prefix
  Jsii::Type.check_type(@log_stream_name_prefix, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "logStreamNamePrefix") unless @log_stream_name_prefix.nil?
  @persistent_app_ui = persistent_app_ui
  Jsii::Type.check_type(@persistent_app_ui, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "persistentAppUI") unless @persistent_app_ui.nil?
end

Instance Attribute Details

#log_bucket ⇒ AWSCDK::S3::IBucket? (readonly)

Note:

Default: - if logging is manually set to true and a logBucket is not provided, a logBucket will be automatically generated`.

Amazon S3 Bucket for monitoring log publishing.

You can configure your jobs to send log information to Amazon S3.

Returns:



31
32
33
 
# File 'step_functions_tasks/monitoring.rb', line 31

def log_bucket
  @log_bucket
end

#log_group ⇒ AWSCDK::Logs::ILogGroup? (readonly)

Note:

Default: - if logging is manually set to true and a logGroup is not provided, a logGroup will be automatically generated`.

A log group for CloudWatch monitoring.

You can configure your jobs to send log information to CloudWatch Logs.

Returns:



46
47
48
 
# File 'step_functions_tasks/monitoring.rb', line 46

def log_group
  @log_group
end

#log_stream_name_prefix ⇒ String? (readonly)

Note:

Default: - Log streams created in this log group have no default prefix

A log stream name prefix for Cloudwatch monitoring.

Returns:

  • (String, nil) 


51
52
53
 
# File 'step_functions_tasks/monitoring.rb', line 51

def log_stream_name_prefix
  @log_stream_name_prefix
end

#logging ⇒ Boolean? (readonly)

Note:

Default: true - true if values are provided for logGroup or logBucket, false otherwise

Enable logging for this job.

If set to true, will automatically create a Cloudwatch Log Group and S3 bucket. This will be set to true implicitly if values are provided for log_group or log_bucket.

Returns:

  • (Boolean, nil) 


39
40
41
 
# File 'step_functions_tasks/monitoring.rb', line 39

def logging
  @logging
end

#persistent_app_ui ⇒ Boolean? (readonly)

Note:

Default: true

Monitoring configurations for the persistent application UI.

Returns:

  • (Boolean, nil) 


56
57
58
 
# File 'step_functions_tasks/monitoring.rb', line 56

def persistent_app_ui
  @persistent_app_ui
end

Class Method Details

.jsii_properties ⇒ Object 



58
59
60
61
62
63
64
65
66
 
# File 'step_functions_tasks/monitoring.rb', line 58

def self.jsii_properties
  {
    :log_bucket => "logBucket",
    :logging => "logging",
    :log_group => "logGroup",
    :log_stream_name_prefix => "logStreamNamePrefix",
    :persistent_app_ui => "persistentAppUI",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



68
69
70
71
72
73
74
75
76
77
78
 
# File 'step_functions_tasks/monitoring.rb', line 68

def to_jsii
  result = {}
  result.merge!({
    "logBucket" => @log_bucket,
    "logging" => @logging,
    "logGroup" => @log_group,
    "logStreamNamePrefix" => @log_stream_name_prefix,
    "persistentAppUI" => @persistent_app_ui,
  })
  result.compact
end