interface FieldProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.DataPipeline.CfnPipeline.FieldProperty |
 Java | software.amazon.awscdk.services.datapipeline.CfnPipeline.FieldProperty |
 Python | aws_cdk.aws_datapipeline.CfnPipeline.FieldProperty |
 TypeScript | @aws-cdk/aws-datapipeline » CfnPipeline » FieldProperty |
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 * as datapipeline from '@aws-cdk/aws-datapipeline';
const fieldProperty: datapipeline.CfnPipeline.FieldProperty = {
key: 'key',
// the properties below are optional
refValue: 'refValue',
stringValue: 'stringValue',
};
Properties
| Name | Type | Description |
|---|---|---|
| key | string | Specifies the name of a field for a particular object. |
| ref | string | A field value that you specify as an identifier of another object in the same pipeline definition. |
| string | string | A field value that you specify as a string. |
key
Type:
string
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 .
refValue?
Type:
string
(optional)
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.
stringValue?
Type:
string
(optional)
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.