Class: AWSCDK::DataBrew::CfnScheduleProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
data_brew/cfn_schedule_props.rb

Overview

Properties for defining a CfnSchedule.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(cron_expression:, name:, job_names: nil, tags: nil) ⇒ CfnScheduleProps

Returns a new instance of CfnScheduleProps.

Parameters:

  • cron_expression (String) —

    The dates and times when the job is to run.

  • name (String) —

    The name of the schedule.

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

    A list of jobs to be run, according to the schedule.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    Metadata tags that have been applied to the schedule.



13
14
15
16
17
18
19
20
21
22
 
# File 'data_brew/cfn_schedule_props.rb', line 13

def initialize(cron_expression:, name:, job_names: nil, tags: nil)
  @cron_expression = cron_expression
  Jsii::Type.check_type(@cron_expression, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cronExpression")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @job_names = job_names
  Jsii::Type.check_type(@job_names, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "jobNames") unless @job_names.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#cron_expression ⇒ String (readonly)

The dates and times when the job is to run.

For more information, see Working with cron expressions for recipe jobs in the AWS Glue DataBrew Developer Guide .

Returns:

  • (String)

See Also:



30
31
32
 
# File 'data_brew/cfn_schedule_props.rb', line 30

def cron_expression
  @cron_expression
end

#job_names ⇒ Array<String>? (readonly)

A list of jobs to be run, according to the schedule.

Returns:

  • (Array<String>, nil)

See Also:



40
41
42
 
# File 'data_brew/cfn_schedule_props.rb', line 40

def job_names
  @job_names
end

#name ⇒ String (readonly)

The name of the schedule.

Returns:

  • (String)

See Also:



35
36
37
 
# File 'data_brew/cfn_schedule_props.rb', line 35

def name
  @name
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

Metadata tags that have been applied to the schedule.

Returns:

See Also:



45
46
47
 
# File 'data_brew/cfn_schedule_props.rb', line 45

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



47
48
49
50
51
52
53
54
 
# File 'data_brew/cfn_schedule_props.rb', line 47

def self.jsii_properties
  {
    :cron_expression => "cronExpression",
    :name => "name",
    :job_names => "jobNames",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



56
57
58
59
60
61
62
63
64
65
 
# File 'data_brew/cfn_schedule_props.rb', line 56

def to_jsii
  result = {}
  result.merge!({
    "cronExpression" => @cron_expression,
    "name" => @name,
    "jobNames" => @job_names,
    "tags" => @tags,
  })
  result.compact
end