interface FieldProperty

Language	Type name
.NET	`Amazon.CDK.CfnPropertyMixins.AWS.DataPipeline.CfnPipelinePropsMixin.FieldProperty`
Go	`github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awsdatapipeline#CfnPipelinePropsMixin_FieldProperty`
Java	`software.amazon.awscdk.cfnpropertymixins.services.datapipeline.CfnPipelinePropsMixin.FieldProperty`
Python	`aws_cdk.cfn_property_mixins.aws_datapipeline.CfnPipelinePropsMixin.FieldProperty`
TypeScript	`@aws-cdk/cfn-property-mixins` » `aws_datapipeline` » `CfnPipelinePropsMixin` » `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/cfn-property-mixins';
const fieldProperty: datapipeline.CfnPipelinePropsMixin.FieldProperty = {
  key: 'key',
  refValue: 'refValue',
  stringValue: 'stringValue',
};

Properties

Name	Type	Description
key?	`string`	Specifies the name of a field for a particular object.
refValue?	`string`	A field value that you specify as an identifier of another object in the same pipeline definition.
stringValue?	`string \|` `IInstanceProfileRef` `\|` `IRoleRef` `\|` `ITopicRef`	A field value that you specify as a string.

key?

Type: string (optional)

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 | IInstanceProfileRef | IRoleRef | ITopicRef (optional)

A field value that you specify as a string.