Class: AWSCDK::Sagemaker::CfnPipelineProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
sagemaker/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(pipeline_definition:, pipeline_name:, role_arn:, parallelism_configuration: nil, pipeline_description: nil, pipeline_display_name: nil, tags: nil) ⇒ CfnPipelineProps

Returns a new instance of CfnPipelineProps.

Parameters:

  • pipeline_definition (Object) —

    The definition of the pipeline.

  • pipeline_name (String) —

    The name of the pipeline.

  • role_arn (String, AWSCDK::Interfaces::AWSIAM::IRoleRef) —

    The Amazon Resource Name (ARN) of the IAM role used to execute the pipeline.

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

    The parallelism configuration applied to the pipeline.

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

    The description of the pipeline.

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

    The display name of the pipeline.

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

    The tags of the pipeline.



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

def initialize(pipeline_definition:, pipeline_name:, role_arn:, parallelism_configuration: nil, pipeline_description: nil, pipeline_display_name: nil, tags: nil)
  @pipeline_definition = pipeline_definition
  Jsii::Type.check_type(@pipeline_definition, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "pipelineDefinition")
  @pipeline_name = pipeline_name
  Jsii::Type.check_type(@pipeline_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "pipelineName")
  @role_arn = role_arn
  Jsii::Type.check_type(@role_arn, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19pYW0uSVJvbGVSZWYifV19fQ==")), "roleArn")
  @parallelism_configuration = parallelism_configuration
  Jsii::Type.check_type(@parallelism_configuration, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "parallelismConfiguration") unless @parallelism_configuration.nil?
  @pipeline_description = pipeline_description
  Jsii::Type.check_type(@pipeline_description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "pipelineDescription") unless @pipeline_description.nil?
  @pipeline_display_name = pipeline_display_name
  Jsii::Type.check_type(@pipeline_display_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "pipelineDisplayName") unless @pipeline_display_name.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

#parallelism_configuration ⇒ Object? (readonly)

The parallelism configuration applied to the pipeline.

Returns:

  • (Object, nil)

See Also:



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

def parallelism_configuration
  @parallelism_configuration
end

#pipeline_definition ⇒ Object (readonly)

The definition of the pipeline.

This can be either a JSON string or an Amazon S3 location.

Returns:

  • (Object)

See Also:



39
40
41
 
# File 'sagemaker/cfn_pipeline_props.rb', line 39

def pipeline_definition
  @pipeline_definition
end

#pipeline_description ⇒ String? (readonly)

The description of the pipeline.

Returns:

  • (String, nil)

See Also:



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

def pipeline_description
  @pipeline_description
end

#pipeline_display_name ⇒ String? (readonly)

The display name of the pipeline.

Returns:

  • (String, nil)

See Also:



64
65
66
 
# File 'sagemaker/cfn_pipeline_props.rb', line 64

def pipeline_display_name
  @pipeline_display_name
end

#pipeline_name ⇒ String (readonly)

The name of the pipeline.

Returns:

  • (String)

See Also:



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

def pipeline_name
  @pipeline_name
end

#role_arn ⇒ String, AWSCDK::Interfaces::AWSIAM::IRoleRef (readonly)

The Amazon Resource Name (ARN) of the IAM role used to execute the pipeline.

Returns:

See Also:



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

def role_arn
  @role_arn
end

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

The tags of the pipeline.

Returns:

See Also:



69
70
71
 
# File 'sagemaker/cfn_pipeline_props.rb', line 69

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



71
72
73
74
75
76
77
78
79
80
81
 
# File 'sagemaker/cfn_pipeline_props.rb', line 71

def self.jsii_properties
  {
    :pipeline_definition => "pipelineDefinition",
    :pipeline_name => "pipelineName",
    :role_arn => "roleArn",
    :parallelism_configuration => "parallelismConfiguration",
    :pipeline_description => "pipelineDescription",
    :pipeline_display_name => "pipelineDisplayName",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'sagemaker/cfn_pipeline_props.rb', line 83

def to_jsii
  result = {}
  result.merge!({
    "pipelineDefinition" => @pipeline_definition,
    "pipelineName" => @pipeline_name,
    "roleArn" => @role_arn,
    "parallelismConfiguration" => @parallelism_configuration,
    "pipelineDescription" => @pipeline_description,
    "pipelineDisplayName" => @pipeline_display_name,
    "tags" => @tags,
  })
  result.compact
end