`boto3_datapipeline`¶

Manage Data Pipelines using boto3.¶

Renamed from boto_datapipeline to boto3_datapipeline and updated to call the refactored boto3_datapipeline execution module.

Create and destroy Data Pipelines. Be aware that this interacts with Amazon’s services, and so may incur charges.

depends:

boto3 >= 1.28.0
botocore >= 1.31.0

This module uses boto3, which can be installed via package, or pip.

This module accepts explicit Data Pipeline credentials but can also utilize IAM roles assigned to the instance through Instance Profiles. Dynamic credentials are then automatically obtained from AWS API and no further configuration is necessary. More Information available at:

http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html

If IAM roles are not used you need to specify them either in the minion’s config file or as a profile. For example, to specify them in the minion’s config file:

datapipeline.keyid: GKTADJGHEIQSXMKKRBJ08H
datapipeline.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs

It’s also possible to specify key, keyid and region via a profile, either as a passed in dict, or as a string to pull from pillars or minion config:

myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    region: us-east-1

ensure-present:
  boto3_datapipeline.present:
    - name: example
    - pipeline_objects_from_pillars: my_pipeline_objects
    - parameter_objects_from_pillars: my_parameter_objects
    - parameter_values_from_pillars: my_parameter_values
    - region: us-east-1
    - profile: myprofile

Added in version 1.0.0.

saltext.boto3.states.boto3_datapipeline.__virtual__()[source]¶: Only load if the boto3_datapipeline execution module is available.

saltext.boto3.states.boto3_datapipeline.present(name, pipeline_objects=None, pipeline_objects_from_pillars='boto3_datapipeline_pipeline_objects', parameter_objects=None, parameter_objects_from_pillars='boto3_datapipeline_parameter_objects', parameter_values=None, parameter_values_from_pillars='boto3_datapipeline_parameter_values', region=None, key=None, keyid=None, profile=None)[source]¶

Ensure the data pipeline exists with matching definition.

name: Name of the service to ensure a data pipeline exists for.
pipeline_objects: Pipeline objects to use. Will override objects read from pillars.
pipeline_objects_from_pillars: The pillar key to use for lookup.
parameter_objects: Parameter objects to use. Will override objects read from pillars.
parameter_objects_from_pillars: The pillar key to use for lookup.
parameter_values: Parameter values to use. Will override values read from pillars.
parameter_values_from_pillars: The pillar key to use for lookup.
region: Region to connect to.
key: Secret key to be used.
keyid: Access key to be used.
profile: A dict with region, key and keyid, or a pillar key (string) that contains a dict with region, key and keyid.

Example:

ensure-present:
  boto3_datapipeline.present:
    - name: example

saltext.boto3.states.boto3_datapipeline.absent(name, region=None, key=None, keyid=None, profile=None)[source]¶

Ensure a pipeline with the given name does not exist.

name: Name of the service to ensure a data pipeline does not exist for.
region: Region to connect to.
key: Secret key to be used.
keyid: Access key to be used.
profile: A dict with region, key and keyid, or a pillar key (string) that contains a dict with region, key and keyid.

Example:

ensure-absent:
  boto3_datapipeline.absent:
    - name: example

boto3_datapipeline¶

Manage Data Pipelines using boto3.¶

`boto3_datapipeline`¶