Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. datapipeline
  5. Pipeline

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.datapipeline.Pipeline

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi
pulumi/pulumi-aws-native

    An example resource schema demonstrating some basic constructs and validation rules.

    Create Pipeline Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Pipeline(name: string, args?: PipelineArgs, opts?: CustomResourceOptions);
    @overload
def Pipeline(resource_name: str,
             args: Optional[PipelineArgs] = None,
             opts: Optional[ResourceOptions] = None)

@overload
def Pipeline(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             activate: Optional[bool] = None,
             description: Optional[str] = None,
             name: Optional[str] = None,
             parameter_objects: Optional[Sequence[PipelineParameterObjectArgs]] = None,
             parameter_values: Optional[Sequence[PipelineParameterValueArgs]] = None,
             pipeline_objects: Optional[Sequence[PipelineObjectArgs]] = None,
             pipeline_tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewPipeline(ctx *Context, name string, args *PipelineArgs, opts ...ResourceOption) (*Pipeline, error)
    public Pipeline(string name, PipelineArgs? args = null, CustomResourceOptions? opts = null)
    public Pipeline(String name, PipelineArgs args)
public Pipeline(String name, PipelineArgs args, CustomResourceOptions options)

    type: aws-native:datapipeline:Pipeline
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args PipelineArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PipelineArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PipelineArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PipelineArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PipelineArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    const pipelineResource = new aws_native.datapipeline.Pipeline("pipelineResource", {
    activate: false,
    description: "string",
    name: "string",
    parameterObjects: [{
        attributes: [{
            key: "string",
            stringValue: "string",
        }],
        id: "string",
    }],
    parameterValues: [{
        id: "string",
        stringValue: "string",
    }],
    pipelineObjects: [{
        fields: [{
            key: "string",
            refValue: "string",
            stringValue: "string",
        }],
        id: "string",
        name: "string",
    }],
    pipelineTags: [{
        key: "string",
        value: "string",
    }],
});

    Coming soon!

    Pipeline Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Pipeline resource accepts the following input properties:

    Activate bool
    Indicates whether to validate and start the pipeline or stop an active pipeline. By default, the value is set to true.
    Description string
    A description of the pipeline.
    Name string
    The name of the pipeline.
    ParameterObjects List<Pulumi.AwsNative.DataPipeline.Inputs.PipelineParameterObject>
    The parameter objects used with the pipeline.
    ParameterValues List<Pulumi.AwsNative.DataPipeline.Inputs.PipelineParameterValue>
    The parameter values used with the pipeline.
    PipelineObjects List<Pulumi.AwsNative.DataPipeline.Inputs.PipelineObject>
    The objects that define the pipeline. These objects overwrite the existing pipeline definition. Not all objects, fields, and values can be updated. For information about restrictions, see Editing Your Pipeline in the AWS Data Pipeline Developer Guide.
    PipelineTags List<Pulumi.AwsNative.Inputs.Tag>
    A list of arbitrary tags (key-value pairs) to associate with the pipeline, which you can use to control permissions. For more information, see Controlling Access to Pipelines and Resources in the AWS Data Pipeline Developer Guide.
    Activate bool
    Indicates whether to validate and start the pipeline or stop an active pipeline. By default, the value is set to true.
    Description string
    A description of the pipeline.
    Name string
    The name of the pipeline.
    ParameterObjects []PipelineParameterObjectArgs
    The parameter objects used with the pipeline.
    ParameterValues []PipelineParameterValueArgs
    The parameter values used with the pipeline.
    PipelineObjects []PipelineObjectArgs
    The objects that define the pipeline. These objects overwrite the existing pipeline definition. Not all objects, fields, and values can be updated. For information about restrictions, see Editing Your Pipeline in the AWS Data Pipeline Developer Guide.
    PipelineTags TagArgs
    A list of arbitrary tags (key-value pairs) to associate with the pipeline, which you can use to control permissions. For more information, see Controlling Access to Pipelines and Resources in the AWS Data Pipeline Developer Guide.
    activate Boolean
    Indicates whether to validate and start the pipeline or stop an active pipeline. By default, the value is set to true.
    description String
    A description of the pipeline.
    name String
    The name of the pipeline.
    parameterObjects List<PipelineParameterObject>
    The parameter objects used with the pipeline.
    parameterValues List<PipelineParameterValue>
    The parameter values used with the pipeline.
    pipelineObjects List<PipelineObject>
    The objects that define the pipeline. These objects overwrite the existing pipeline definition. Not all objects, fields, and values can be updated. For information about restrictions, see Editing Your Pipeline in the AWS Data Pipeline Developer Guide.
    pipelineTags List<Tag>
    A list of arbitrary tags (key-value pairs) to associate with the pipeline, which you can use to control permissions. For more information, see Controlling Access to Pipelines and Resources in the AWS Data Pipeline Developer Guide.
    activate boolean
    Indicates whether to validate and start the pipeline or stop an active pipeline. By default, the value is set to true.
    description string
    A description of the pipeline.
    name string
    The name of the pipeline.
    parameterObjects PipelineParameterObject[]
    The parameter objects used with the pipeline.
    parameterValues PipelineParameterValue[]
    The parameter values used with the pipeline.
    pipelineObjects PipelineObject[]
    The objects that define the pipeline. These objects overwrite the existing pipeline definition. Not all objects, fields, and values can be updated. For information about restrictions, see Editing Your Pipeline in the AWS Data Pipeline Developer Guide.
    pipelineTags Tag[]
    A list of arbitrary tags (key-value pairs) to associate with the pipeline, which you can use to control permissions. For more information, see Controlling Access to Pipelines and Resources in the AWS Data Pipeline Developer Guide.
    activate bool
    Indicates whether to validate and start the pipeline or stop an active pipeline. By default, the value is set to true.
    description str
    A description of the pipeline.
    name str
    The name of the pipeline.
    parameter_objects Sequence[PipelineParameterObjectArgs]
    The parameter objects used with the pipeline.
    parameter_values Sequence[PipelineParameterValueArgs]
    The parameter values used with the pipeline.
    pipeline_objects Sequence[PipelineObjectArgs]
    The objects that define the pipeline. These objects overwrite the existing pipeline definition. Not all objects, fields, and values can be updated. For information about restrictions, see Editing Your Pipeline in the AWS Data Pipeline Developer Guide.
    pipeline_tags Sequence[TagArgs]
    A list of arbitrary tags (key-value pairs) to associate with the pipeline, which you can use to control permissions. For more information, see Controlling Access to Pipelines and Resources in the AWS Data Pipeline Developer Guide.
    activate Boolean
    Indicates whether to validate and start the pipeline or stop an active pipeline. By default, the value is set to true.
    description String
    A description of the pipeline.
    name String
    The name of the pipeline.
    parameterObjects List<Property Map>
    The parameter objects used with the pipeline.
    parameterValues List<Property Map>
    The parameter values used with the pipeline.
    pipelineObjects List<Property Map>
    The objects that define the pipeline. These objects overwrite the existing pipeline definition. Not all objects, fields, and values can be updated. For information about restrictions, see Editing Your Pipeline in the AWS Data Pipeline Developer Guide.
    pipelineTags List<Property Map>
    A list of arbitrary tags (key-value pairs) to associate with the pipeline, which you can use to control permissions. For more information, see Controlling Access to Pipelines and Resources in the AWS Data Pipeline Developer Guide.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Pipeline resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    PipelineId string
    Id string
    The provider-assigned unique ID for this managed resource.
    PipelineId string
    id String
    The provider-assigned unique ID for this managed resource.
    pipelineId String
    id string
    The provider-assigned unique ID for this managed resource.
    pipelineId string
    id str
    The provider-assigned unique ID for this managed resource.
    pipeline_id str
    id String
    The provider-assigned unique ID for this managed resource.
    pipelineId String

    Supporting Types

    PipelineField, PipelineFieldArgs

    Key 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 string
    A field value that you specify as an identifier of another object in the same pipeline definition.
    StringValue string
    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.
    Key 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 string
    A field value that you specify as an identifier of another object in the same pipeline definition.
    StringValue string
    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.
    key 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 String
    A field value that you specify as an identifier of another object in the same pipeline definition.
    stringValue String
    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.
    key 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 string
    A field value that you specify as an identifier of another object in the same pipeline definition.
    stringValue string
    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.
    key str
    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.
    ref_value str
    A field value that you specify as an identifier of another object in the same pipeline definition.
    string_value str
    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.
    key 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 String
    A field value that you specify as an identifier of another object in the same pipeline definition.
    stringValue String
    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.

    PipelineObject, PipelineObjectArgs

    Fields List<Pulumi.AwsNative.DataPipeline.Inputs.PipelineField>
    Key-value pairs that define the properties of the object.
    Id string
    The ID of the object.
    Name string
    The name of the object.
    Fields []PipelineField
    Key-value pairs that define the properties of the object.
    Id string
    The ID of the object.
    Name string
    The name of the object.
    fields List<PipelineField>
    Key-value pairs that define the properties of the object.
    id String
    The ID of the object.
    name String
    The name of the object.
    fields PipelineField[]
    Key-value pairs that define the properties of the object.
    id string
    The ID of the object.
    name string
    The name of the object.
    fields Sequence[PipelineField]
    Key-value pairs that define the properties of the object.
    id str
    The ID of the object.
    name str
    The name of the object.
    fields List<Property Map>
    Key-value pairs that define the properties of the object.
    id String
    The ID of the object.
    name String
    The name of the object.

    PipelineParameterAttribute, PipelineParameterAttributeArgs

    Key string
    The field identifier.
    StringValue string
    The field value, expressed as a String.
    Key string
    The field identifier.
    StringValue string
    The field value, expressed as a String.
    key String
    The field identifier.
    stringValue String
    The field value, expressed as a String.
    key string
    The field identifier.
    stringValue string
    The field value, expressed as a String.
    key str
    The field identifier.
    string_value str
    The field value, expressed as a String.
    key String
    The field identifier.
    stringValue String
    The field value, expressed as a String.

    PipelineParameterObject, PipelineParameterObjectArgs

    Attributes List<Pulumi.AwsNative.DataPipeline.Inputs.PipelineParameterAttribute>
    The attributes of the parameter object.
    Id string
    The ID of the parameter object.
    Attributes []PipelineParameterAttribute
    The attributes of the parameter object.
    Id string
    The ID of the parameter object.
    attributes List<PipelineParameterAttribute>
    The attributes of the parameter object.
    id String
    The ID of the parameter object.
    attributes PipelineParameterAttribute[]
    The attributes of the parameter object.
    id string
    The ID of the parameter object.
    attributes Sequence[PipelineParameterAttribute]
    The attributes of the parameter object.
    id str
    The ID of the parameter object.
    attributes List<Property Map>
    The attributes of the parameter object.
    id String
    The ID of the parameter object.

    PipelineParameterValue, PipelineParameterValueArgs

    Id string
    The ID of the parameter value.
    StringValue string
    The field value, expressed as a String.
    Id string
    The ID of the parameter value.
    StringValue string
    The field value, expressed as a String.
    id String
    The ID of the parameter value.
    stringValue String
    The field value, expressed as a String.
    id string
    The ID of the parameter value.
    stringValue string
    The field value, expressed as a String.
    id str
    The ID of the parameter value.
    string_value str
    The field value, expressed as a String.
    id String
    The ID of the parameter value.
    stringValue String
    The field value, expressed as a String.

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi
    pulumi/pulumi-aws-native