Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. datapipeline
  5. getPipeline

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.datapipeline.getPipeline

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

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

    Using getPipeline

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getPipeline(args: GetPipelineArgs, opts?: InvokeOptions): Promise<GetPipelineResult>
function getPipelineOutput(args: GetPipelineOutputArgs, opts?: InvokeOptions): Output<GetPipelineResult>
    def get_pipeline(pipeline_id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetPipelineResult
def get_pipeline_output(pipeline_id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetPipelineResult]
    func LookupPipeline(ctx *Context, args *LookupPipelineArgs, opts ...InvokeOption) (*LookupPipelineResult, error)
func LookupPipelineOutput(ctx *Context, args *LookupPipelineOutputArgs, opts ...InvokeOption) LookupPipelineResultOutput

    > Note: This function is named LookupPipeline in the Go SDK.

    public static class GetPipeline 
{
    public static Task<GetPipelineResult> InvokeAsync(GetPipelineArgs args, InvokeOptions? opts = null)
    public static Output<GetPipelineResult> Invoke(GetPipelineInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPipelineResult> getPipeline(GetPipelineArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:datapipeline:getPipeline
  arguments:
    # arguments dictionary

    The following arguments are supported:

    PipelineId string
    The ID of the pipeline.
    PipelineId string
    The ID of the pipeline.
    pipelineId String
    The ID of the pipeline.
    pipelineId string
    The ID of the pipeline.
    pipeline_id str
    The ID of the pipeline.
    pipelineId String
    The ID of the pipeline.

    getPipeline Result

    The following output properties are available:

    Activate bool
    Indicates whether to validate and start the pipeline or stop an active pipeline. By default, the value is set to true.
    ParameterObjects List<Pulumi.AwsNative.DataPipeline.Outputs.PipelineParameterObject>
    The parameter objects used with the pipeline.
    ParameterValues List<Pulumi.AwsNative.DataPipeline.Outputs.PipelineParameterValue>
    The parameter values used with the pipeline.
    PipelineId string
    The ID of the pipeline.
    PipelineObjects List<Pulumi.AwsNative.DataPipeline.Outputs.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.Outputs.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.
    ParameterObjects []PipelineParameterObject
    The parameter objects used with the pipeline.
    ParameterValues []PipelineParameterValue
    The parameter values used with the pipeline.
    PipelineId string
    The ID of 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 Boolean
    Indicates whether to validate and start the pipeline or stop an active pipeline. By default, the value is set to true.
    parameterObjects List<PipelineParameterObject>
    The parameter objects used with the pipeline.
    parameterValues List<PipelineParameterValue>
    The parameter values used with the pipeline.
    pipelineId String
    The ID of 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.
    parameterObjects PipelineParameterObject[]
    The parameter objects used with the pipeline.
    parameterValues PipelineParameterValue[]
    The parameter values used with the pipeline.
    pipelineId string
    The ID of 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.
    parameter_objects Sequence[PipelineParameterObject]
    The parameter objects used with the pipeline.
    parameter_values Sequence[PipelineParameterValue]
    The parameter values used with the pipeline.
    pipeline_id str
    The ID of the pipeline.
    pipeline_objects Sequence[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.
    pipeline_tags Sequence[root_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.
    parameterObjects List<Property Map>
    The parameter objects used with the pipeline.
    parameterValues List<Property Map>
    The parameter values used with the pipeline.
    pipelineId String
    The ID of 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.

    Supporting Types

    PipelineField

    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

    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

    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

    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

    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

    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

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-aws-native