aws-cdk-lib.aws_datapipeline.CfnPipeline.FieldProperty

interface FieldProperty

LanguageType name
.NETAmazon.CDK.AWS.DataPipeline.CfnPipeline.FieldProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsdatapipeline#CfnPipeline_FieldProperty
Javasoftware.amazon.awscdk.services.datapipeline.CfnPipeline.FieldProperty
Pythonaws_cdk.aws_datapipeline.CfnPipeline.FieldProperty
TypeScript aws-cdk-lib » 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 { aws_datapipeline as datapipeline } from 'aws-cdk-lib';
const fieldProperty: datapipeline.CfnPipeline.FieldProperty = {
  key: 'key',

  // the properties below are optional
  refValue: 'refValue',
  stringValue: 'stringValue',
};

Properties

NameTypeDescription
keystringSpecifies the name of a field for a particular object.
refValue?stringA field value that you specify as an identifier of another object in the same pipeline definition.
stringValue?stringA 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.