@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
96 lines (95 loc) • 4.46 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* An example resource schema demonstrating some basic constructs and validation rules.
*/
export declare class Pipeline extends pulumi.CustomResource {
/**
* Get an existing Pipeline resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Pipeline;
/**
* Returns true if the given object is an instance of Pipeline. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Pipeline;
/**
* Indicates whether to validate and start the pipeline or stop an active pipeline. By default, the value is set to true.
*/
readonly activate: pulumi.Output<boolean | undefined>;
/**
* A description of the pipeline.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The name of the pipeline.
*/
readonly name: pulumi.Output<string>;
/**
* The parameter objects used with the pipeline.
*/
readonly parameterObjects: pulumi.Output<outputs.datapipeline.PipelineParameterObject[] | undefined>;
/**
* The parameter values used with the pipeline.
*/
readonly parameterValues: pulumi.Output<outputs.datapipeline.PipelineParameterValue[] | undefined>;
/**
* The ID of the pipeline.
*/
readonly pipelineId: pulumi.Output<string>;
/**
* 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.
*/
readonly pipelineObjects: pulumi.Output<outputs.datapipeline.PipelineObject[] | undefined>;
/**
* 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.
*/
readonly pipelineTags: pulumi.Output<outputs.Tag[] | undefined>;
/**
* Create a Pipeline resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: PipelineArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Pipeline resource.
*/
export interface PipelineArgs {
/**
* Indicates whether to validate and start the pipeline or stop an active pipeline. By default, the value is set to true.
*/
activate?: pulumi.Input<boolean>;
/**
* A description of the pipeline.
*/
description?: pulumi.Input<string>;
/**
* The name of the pipeline.
*/
name?: pulumi.Input<string>;
/**
* The parameter objects used with the pipeline.
*/
parameterObjects?: pulumi.Input<pulumi.Input<inputs.datapipeline.PipelineParameterObjectArgs>[]>;
/**
* The parameter values used with the pipeline.
*/
parameterValues?: pulumi.Input<pulumi.Input<inputs.datapipeline.PipelineParameterValueArgs>[]>;
/**
* 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.
*/
pipelineObjects?: pulumi.Input<pulumi.Input<inputs.datapipeline.PipelineObjectArgs>[]>;
/**
* 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.
*/
pipelineTags?: pulumi.Input<pulumi.Input<inputs.TagArgs>[]>;
}