Class: AWSCDK::DataPipeline::CfnPipelineProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
data_pipeline/cfn_pipeline_props.rb

Overview

Properties for defining a CfnPipeline.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, activate: nil, description: nil, parameter_objects: nil, parameter_values: nil, pipeline_objects: nil, pipeline_tags: nil) ⇒ CfnPipelineProps

Returns a new instance of CfnPipelineProps.

Parameters:



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'data_pipeline/cfn_pipeline_props.rb', line 16

def initialize(name:, activate: nil, description: nil, parameter_objects: nil, parameter_values: nil, pipeline_objects: nil, pipeline_tags: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @activate = activate
  Jsii::Type.check_type(@activate, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "activate") unless @activate.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @parameter_objects = parameter_objects
  Jsii::Type.check_type(@parameter_objects, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZGF0YXBpcGVsaW5lLkNmblBpcGVsaW5lLlBhcmFtZXRlck9iamVjdFByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "parameterObjects") unless @parameter_objects.nil?
  @parameter_values = parameter_values
  Jsii::Type.check_type(@parameter_values, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZGF0YXBpcGVsaW5lLkNmblBpcGVsaW5lLlBhcmFtZXRlclZhbHVlUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "parameterValues") unless @parameter_values.nil?
  @pipeline_objects = pipeline_objects
  Jsii::Type.check_type(@pipeline_objects, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZGF0YXBpcGVsaW5lLkNmblBpcGVsaW5lLlBpcGVsaW5lT2JqZWN0UHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "pipelineObjects") unless @pipeline_objects.nil?
  @pipeline_tags = pipeline_tags.is_a?(Array) ? pipeline_tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::DataPipeline::CfnPipeline::PipelineTagProperty.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : pipeline_tags
  Jsii::Type.check_type(@pipeline_tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kYXRhcGlwZWxpbmUuQ2ZuUGlwZWxpbmUuUGlwZWxpbmVUYWdQcm9wZXJ0eSJ9LCJraW5kIjoiYXJyYXkifX0=")), "pipelineTags") unless @pipeline_tags.nil?
end

Instance Attribute Details

#activate ⇒ Boolean, ... (readonly)

Indicates whether to validate and start the pipeline or stop an active pipeline.

By default, the value is set to true .

Returns:

See Also:



44
45
46
 
# File 'data_pipeline/cfn_pipeline_props.rb', line 44

def activate
  @activate
end

#description ⇒ String? (readonly)

A description of the pipeline.

Returns:

  • (String, nil)

See Also:



49
50
51
 
# File 'data_pipeline/cfn_pipeline_props.rb', line 49

def description
  @description
end

#name ⇒ String (readonly)

The name of the pipeline.

Returns:

  • (String)

See Also:



37
38
39
 
# File 'data_pipeline/cfn_pipeline_props.rb', line 37

def name
  @name
end

#parameter_objects ⇒ AWSCDK::IResolvable, ... (readonly)

The parameter objects used with the pipeline.

Returns:

See Also:



54
55
56
 
# File 'data_pipeline/cfn_pipeline_props.rb', line 54

def parameter_objects
  @parameter_objects
end

#parameter_values ⇒ AWSCDK::IResolvable, ... (readonly)

The parameter values used with the pipeline.

Returns:

See Also:



59
60
61
 
# File 'data_pipeline/cfn_pipeline_props.rb', line 59

def parameter_values
  @parameter_values
end

#pipeline_objects ⇒ AWSCDK::IResolvable, ... (readonly)

The objects that define the pipeline.

These objects overwrite the existing pipeline definition. Not all objects, fields, and values can be updated. For information about restrictions, see Editing Your Pipeline in the AWS Data Pipeline Developer Guide .

Returns:

See Also:



66
67
68
 
# File 'data_pipeline/cfn_pipeline_props.rb', line 66

def pipeline_objects
  @pipeline_objects
end

#pipeline_tags ⇒ Array<AWSCDK::DataPipeline::CfnPipeline::PipelineTagProperty>? (readonly)

A list of arbitrary tags (key-value pairs) to associate with the pipeline, which you can use to control permissions.

For more information, see Controlling Access to Pipelines and Resources in the AWS Data Pipeline Developer Guide .

Returns:

See Also:



73
74
75
 
# File 'data_pipeline/cfn_pipeline_props.rb', line 73

def pipeline_tags
  @pipeline_tags
end

Class Method Details

.jsii_properties ⇒ Object 



75
76
77
78
79
80
81
82
83
84
85
 
# File 'data_pipeline/cfn_pipeline_props.rb', line 75

def self.jsii_properties
  {
    :name => "name",
    :activate => "activate",
    :description => "description",
    :parameter_objects => "parameterObjects",
    :parameter_values => "parameterValues",
    :pipeline_objects => "pipelineObjects",
    :pipeline_tags => "pipelineTags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'data_pipeline/cfn_pipeline_props.rb', line 87

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "activate" => @activate,
    "description" => @description,
    "parameterObjects" => @parameter_objects,
    "parameterValues" => @parameter_values,
    "pipelineObjects" => @pipeline_objects,
    "pipelineTags" => @pipeline_tags,
  })
  result.compact
end