Class: AWSCDK::DataPipeline::CfnPipeline::FieldProperty

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

Overview

A key-value pair that describes a property of a PipelineObject .

The value is specified as either a string value ( StringValue ) or a reference to another object ( RefValue ) but not as both. To view fields for a data pipeline object, see Pipeline Object Reference in the AWS Data Pipeline Developer Guide .

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(key:, ref_value: nil, string_value: nil) ⇒ FieldProperty

Returns a new instance of FieldProperty.

Parameters:

  • key (String) —

    Specifies the name of a field for a particular object.

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

    A field value that you specify as an identifier of another object in the same pipeline definition.

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

    A field value that you specify as a string.



633
634
635
636
637
638
639
640
 
# File 'data_pipeline/cfn_pipeline.rb', line 633

def initialize(key:, ref_value: nil, string_value: nil)
  @key = key
  Jsii::Type.check_type(@key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  @ref_value = ref_value
  Jsii::Type.check_type(@ref_value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "refValue") unless @ref_value.nil?
  @string_value = string_value
  Jsii::Type.check_type(@string_value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "stringValue") unless @string_value.nil?
end

Instance Attribute Details

#key ⇒ String (readonly)

Specifies the name of a field for a particular object.

To view valid values for a particular field, see Pipeline Object Reference in the AWS Data Pipeline Developer Guide .

Returns:

  • (String)

See Also:



648
649
650
 
# File 'data_pipeline/cfn_pipeline.rb', line 648

def key
  @key
end

#ref_value ⇒ String? (readonly)

A field value that you specify as an identifier of another object in the same pipeline definition.

You can specify the field value as either a string value ( StringValue ) or a reference to another object ( RefValue ), but not both.

Required if the key that you are using requires it.

Returns:

  • (String, nil)

See Also:



657
658
659
 
# File 'data_pipeline/cfn_pipeline.rb', line 657

def ref_value
  @ref_value
end

#string_value ⇒ String? (readonly)

A field value that you specify as a string.

To view valid values for a particular field, see Pipeline Object Reference in the AWS Data Pipeline Developer Guide .

You can specify the field value as either a string value ( StringValue ) or a reference to another object ( RefValue ), but not both.

Required if the key that you are using requires it.

Returns:

  • (String, nil)

See Also:



668
669
670
 
# File 'data_pipeline/cfn_pipeline.rb', line 668

def string_value
  @string_value
end

Class Method Details

.jsii_properties ⇒ Object 



670
671
672
673
674
675
676
 
# File 'data_pipeline/cfn_pipeline.rb', line 670

def self.jsii_properties
  {
    :key => "key",
    :ref_value => "refValue",
    :string_value => "stringValue",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



678
679
680
681
682
683
684
685
686
 
# File 'data_pipeline/cfn_pipeline.rb', line 678

def to_jsii
  result = {}
  result.merge!({
    "key" => @key,
    "refValue" => @ref_value,
    "stringValue" => @string_value,
  })
  result.compact
end