Package software.amazon.awscdk.services.datapipeline

Interface CfnPipeline.FieldProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPipeline.FieldProperty.Jsii$Proxy

Enclosing class:

CfnPipeline

@Stability(Stable)
public static interface CfnPipeline.FieldProperty
extends software.amazon.jsii.JsiiSerializable

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 .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.datapipeline.*;
 FieldProperty fieldProperty = FieldProperty.builder()
         .key("key")
         // the properties below are optional
         .refValue("refValue")
         .stringValue("stringValue")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPipeline.FieldProperty.Builder	A builder for CfnPipeline.FieldProperty
static final class	CfnPipeline.FieldProperty.Jsii$Proxy	An implementation for CfnPipeline.FieldProperty

Method Summary

Modifier and Type	Method	Description
static CfnPipeline.FieldProperty.Builder	builder()
String	getKey()	Specifies the name of a field for a particular object.
default String	getRefValue()	A field value that you specify as an identifier of another object in the same pipeline definition.
default String	getStringValue()	A field value that you specify as a string.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getKey

@Stability(Stable)
@NotNull
String getKey()

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 .

getRefValue

@Stability(Stable)
@Nullable
default String getRefValue()

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.

getStringValue

@Stability(Stable)
@Nullable
default String getStringValue()

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.

builder

@Stability(Stable)
static CfnPipeline.FieldProperty.Builder builder()

Returns:

a CfnPipeline.FieldProperty.Builder of CfnPipeline.FieldProperty