pipelines

Creates, updates, deletes or gets a pipeline resource or lists pipelines in a region

Overview

Name	pipelines
Type	Resource
Description	An example resource schema demonstrating some basic constructs and validation rules.
Id	awscc.datapipeline.pipelines

Fields

get (all properties)

Name	Datatype	Description
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.
▶parameter_objects	array	The parameter objects used with the pipeline.
▶parameter_values	array	The parameter values used with the pipeline.
▶pipeline_objects	array	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	array	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.
pipeline_id	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
pipeline_id	string
region	string	AWS region.

For more information, see AWS::DataPipeline::Pipeline.

Methods

Name	Resource	Accessible by	Required Params
create_resource	pipelines	INSERT	Name, region
delete_resource	pipelines	DELETE	Identifier, region
update_resource	pipelines	UPDATE	Identifier, PatchDocument, region
list_resources	pipelines_list_only	SELECT	region
get_resource	pipelines	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual pipeline.

SELECT
  region,
  activate,
  description,
  name,
  parameter_objects,
  parameter_values,
  pipeline_objects,
  pipeline_tags,
  pipeline_id
FROM awscc.datapipeline.pipelines
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ pipeline_id }}';

list (identifiers only)

Lists all pipelines in a region.

SELECT
  region,
  pipeline_id
FROM awscc.datapipeline.pipelines_list_only
WHERE
  region = '{{ region }}';

INSERT example

Use the following StackQL query and manifest file to create a new pipeline resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.datapipeline.pipelines (
  Name,
  region
)
SELECT
  '{{ name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.datapipeline.pipelines (
  Activate,
  Description,
  Name,
  ParameterObjects,
  ParameterValues,
  PipelineObjects,
  PipelineTags,
  region
)
SELECT
  '{{ activate }}',
  '{{ description }}',
  '{{ name }}',
  '{{ parameter_objects }}',
  '{{ parameter_values }}',
  '{{ pipeline_objects }}',
  '{{ pipeline_tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: pipeline
  props:
    - name: activate
      value: '{{ activate }}'
    - name: description
      value: '{{ description }}'
    - name: name
      value: '{{ name }}'
    - name: parameter_objects
      value:
        - attributes:
            - key: '{{ key }}'
              string_value: '{{ string_value }}'
          id: '{{ id }}'
    - name: parameter_values
      value:
        - id: '{{ id }}'
          string_value: '{{ string_value }}'
    - name: pipeline_objects
      value:
        - fields:
            - key: '{{ key }}'
              ref_value: '{{ ref_value }}'
              string_value: '{{ string_value }}'
          id: '{{ id }}'
          name: '{{ name }}'
    - name: pipeline_tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

Use the following StackQL query and manifest file to update a pipeline resource, using stack-deploy.

/*+ update */
UPDATE awscc.datapipeline.pipelines
SET PatchDocument = string('{{ {
    "Activate": activate,
    "ParameterObjects": parameter_objects,
    "ParameterValues": parameter_values,
    "PipelineObjects": pipeline_objects,
    "PipelineTags": pipeline_tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ pipeline_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.datapipeline.pipelines
WHERE
  Identifier = '{{ pipeline_id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

To operate on the pipelines resource, the following permissions are required:

Create

datapipeline:CreatePipeline,
datapipeline:PutPipelineDefinition,
datapipeline:GetPipelineDefinition,
datapipeline:DescribePipelines,
datapipeline:ValidatePipelineDefinition,
datapipeline:ActivatePipeline,
datapipeline:AddTags,
iam:PassRole

Read

datapipeline:GetPipelineDefinition,
datapipeline:DescribePipelines

Update

datapipeline:PutPipelineDefinition,
datapipeline:AddTags,
datapipeline:RemoveTags,
datapipeline:DeactivatePipeline,
datapipeline:GetPipelineDefinition,
datapipeline:ActivatePipeline,
datapipeline:ValidatePipelineDefinition,
datapipeline:DescribePipelines,
datapipeline:AddTags,
datapipeline:RemoveTags,
iam:PassRole

Delete

datapipeline:DeletePipeline,
datapipeline:DescribePipelines,
datapipeline:GetPipelineDefinition,
datapipeline:RemoveTags

List

datapipeline:ListPipelines