We recommend new projects start with resources from the AWS provider.
AWS Cloud Control v1.15.0 published on Wednesday, Dec 11, 2024 by Pulumi
aws-native.datapipeline.getPipeline
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
AWS Cloud Control v1.15.0 published on Wednesday, Dec 11, 2024 by Pulumi
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:
- Pipeline
Id string - The ID of the pipeline.
- Pipeline
Id string - The ID of the pipeline.
- pipeline
Id String - The ID of the pipeline.
- pipeline
Id string - The ID of the pipeline.
- pipeline_
id str - The ID of the pipeline.
- pipeline
Id 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.
- Parameter
Objects List<Pulumi.Aws Native. Data Pipeline. Outputs. Pipeline Parameter Object> - The parameter objects used with the pipeline.
- Parameter
Values List<Pulumi.Aws Native. Data Pipeline. Outputs. Pipeline Parameter Value> - The parameter values used with the pipeline.
- Pipeline
Id string - The ID of the pipeline.
- Pipeline
Objects List<Pulumi.Aws Native. Data Pipeline. Outputs. Pipeline Object> - 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.
- List<Pulumi.
Aws Native. 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.
- Parameter
Objects []PipelineParameter Object - The parameter objects used with the pipeline.
- Parameter
Values []PipelineParameter Value - The parameter values used with the pipeline.
- Pipeline
Id string - The ID of the pipeline.
- Pipeline
Objects []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.
- 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.
- parameter
Objects List<PipelineParameter Object> - The parameter objects used with the pipeline.
- parameter
Values List<PipelineParameter Value> - The parameter values used with the pipeline.
- pipeline
Id String - The ID of the pipeline.
- pipeline
Objects 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.
- 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.
- parameter
Objects PipelineParameter Object[] - The parameter objects used with the pipeline.
- parameter
Values PipelineParameter Value[] - The parameter values used with the pipeline.
- pipeline
Id string - The ID of the pipeline.
- pipeline
Objects 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.
- 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[PipelineParameter Object] - The parameter objects used with the pipeline.
- parameter_
values Sequence[PipelineParameter Value] - 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.
- 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.
- parameter
Objects List<Property Map> - The parameter objects used with the pipeline.
- parameter
Values List<Property Map> - The parameter values used with the pipeline.
- pipeline
Id String - The ID of the pipeline.
- pipeline
Objects 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.
- 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.
- Ref
Value string - A field value that you specify as an identifier of another object in the same pipeline definition.
- String
Value 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.
- Ref
Value string - A field value that you specify as an identifier of another object in the same pipeline definition.
- String
Value 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.
- ref
Value String - A field value that you specify as an identifier of another object in the same pipeline definition.
- string
Value 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.
- ref
Value string - A field value that you specify as an identifier of another object in the same pipeline definition.
- string
Value 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.
- ref
Value String - A field value that you specify as an identifier of another object in the same pipeline definition.
- string
Value 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.
Aws Native. Data Pipeline. Inputs. Pipeline Field> - 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
[]Pipeline
Field - 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<Pipeline
Field> - 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
Pipeline
Field[] - 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[Pipeline
Field] - 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.
- String
Value string - The field value, expressed as a String.
- Key string
- The field identifier.
- String
Value string - The field value, expressed as a String.
- key String
- The field identifier.
- string
Value String - The field value, expressed as a String.
- key string
- The field identifier.
- string
Value 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.
- string
Value String - The field value, expressed as a String.
PipelineParameterObject
- Attributes
List<Pulumi.
Aws Native. Data Pipeline. Inputs. Pipeline Parameter Attribute> - The attributes of the parameter object.
- Id string
- The ID of the parameter object.
- Attributes
[]Pipeline
Parameter Attribute - The attributes of the parameter object.
- Id string
- The ID of the parameter object.
- attributes
List<Pipeline
Parameter Attribute> - The attributes of the parameter object.
- id String
- The ID of the parameter object.
- attributes
Pipeline
Parameter Attribute[] - The attributes of the parameter object.
- id string
- The ID of the parameter object.
- attributes
Sequence[Pipeline
Parameter Attribute] - 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.
- String
Value string - The field value, expressed as a String.
- Id string
- The ID of the parameter value.
- String
Value string - The field value, expressed as a String.
- id String
- The ID of the parameter value.
- string
Value String - The field value, expressed as a String.
- id string
- The ID of the parameter value.
- string
Value 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.
- string
Value String - The field value, expressed as a String.
Tag
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
AWS Cloud Control v1.15.0 published on Wednesday, Dec 11, 2024 by Pulumi