Class: AWSCDK::Glue::CfnWorkflowProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
glue/cfn_workflow_props.rb

Overview

Properties for defining a CfnWorkflow.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(default_run_properties: nil, description: nil, max_concurrent_runs: nil, name: nil, tags: nil) ⇒ CfnWorkflowProps

Returns a new instance of CfnWorkflowProps.

Parameters:

  • default_run_properties (Object, nil) (defaults to: nil) —

    A collection of properties to be used as part of each execution of the workflow.

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

    A description of the workflow.

  • max_concurrent_runs (Numeric, nil) (defaults to: nil) —

    You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs.

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

    The name of the workflow representing the flow.

  • tags (Object, nil) (defaults to: nil) —

    The tags to use with this workflow.



14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'glue/cfn_workflow_props.rb', line 14

def initialize(default_run_properties: nil, description: nil, max_concurrent_runs: nil, name: nil, tags: nil)
  @default_run_properties = default_run_properties
  Jsii::Type.check_type(@default_run_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "defaultRunProperties") unless @default_run_properties.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @max_concurrent_runs = max_concurrent_runs
  Jsii::Type.check_type(@max_concurrent_runs, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxConcurrentRuns") unless @max_concurrent_runs.nil?
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
  @tags = tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "tags") unless @tags.nil?
end

Instance Attribute Details

#default_run_properties ⇒ Object? (readonly)

A collection of properties to be used as part of each execution of the workflow.

Returns:

  • (Object, nil)

See Also:



31
32
33
 
# File 'glue/cfn_workflow_props.rb', line 31

def default_run_properties
  @default_run_properties
end

#description ⇒ String? (readonly)

A description of the workflow.

Returns:

  • (String, nil)

See Also:



36
37
38
 
# File 'glue/cfn_workflow_props.rb', line 36

def description
  @description
end

#max_concurrent_runs ⇒ Numeric? (readonly)

You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs.

If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.

Returns:

  • (Numeric, nil)

See Also:



43
44
45
 
# File 'glue/cfn_workflow_props.rb', line 43

def max_concurrent_runs
  @max_concurrent_runs
end

#name ⇒ String? (readonly)

The name of the workflow representing the flow.

Returns:

  • (String, nil)

See Also:



48
49
50
 
# File 'glue/cfn_workflow_props.rb', line 48

def name
  @name
end

#tags ⇒ Object? (readonly)

The tags to use with this workflow.

Returns:

  • (Object, nil)

See Also:



53
54
55
 
# File 'glue/cfn_workflow_props.rb', line 53

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



55
56
57
58
59
60
61
62
63
 
# File 'glue/cfn_workflow_props.rb', line 55

def self.jsii_properties
  {
    :default_run_properties => "defaultRunProperties",
    :description => "description",
    :max_concurrent_runs => "maxConcurrentRuns",
    :name => "name",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



65
66
67
68
69
70
71
72
73
74
75
 
# File 'glue/cfn_workflow_props.rb', line 65

def to_jsii
  result = {}
  result.merge!({
    "defaultRunProperties" => @default_run_properties,
    "description" => @description,
    "maxConcurrentRuns" => @max_concurrent_runs,
    "name" => @name,
    "tags" => @tags,
  })
  result.compact
end