Class: Ansible::Ruby::Modules::Data_pipeline

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/amazon/data_pipeline.rb

Overview

Create and manage AWS Datapipelines. Creation is not idempotent in AWS, so the I(uniqueId) is created by hashing the options (minus objects) given to the datapipeline. The pipeline definition must be in the format given here U(docs.aws.amazon.com/datapipeline/latest/APIReference/API_PutPipelineDefinition.html#API_PutPipelineDefinition_RequestSyntax). Also operations will wait for a configurable amount of time to ensure the pipeline is in the requested state.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#description ⇒ String?

Returns An optional description for the pipeline being created.

Returns:

  • (String, nil) —

    An optional description for the pipeline being created.



18
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/data_pipeline.rb', line 18

attribute :description

#name ⇒ String

Returns The name of the Datapipeline to create/modify/delete.

Returns:

  • (String) —

    The name of the Datapipeline to create/modify/delete.



14
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/data_pipeline.rb', line 14

attribute :name

#objects ⇒ String?

Returns A list of pipeline object definitions, each of which is a dict that takes the keys C(id), C(name) and C(fields).

Returns:

  • (String, nil) —

    A list of pipeline object definitions, each of which is a dict that takes the keys C(id), C(name) and C(fields).



22
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/data_pipeline.rb', line 22

attribute :objects

#parameters ⇒ String?

Returns A list of parameter objects (dicts) in the pipeline definition.

Returns:

  • (String, nil) —

    A list of parameter objects (dicts) in the pipeline definition.



26
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/data_pipeline.rb', line 26

attribute :parameters

#state ⇒ :present, ...

Returns The requested state of the pipeline.

Returns:

  • (:present, :absent, :active, :inactive, nil) —

    The requested state of the pipeline.



38
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/data_pipeline.rb', line 38

attribute :state

#tags ⇒ Hash?

Returns A dict of key:value pair(s) to add to the pipeline.

Returns:

  • (Hash, nil) —

    A dict of key:value pair(s) to add to the pipeline.



42
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/data_pipeline.rb', line 42

attribute :tags

#timeout ⇒ Integer?

Returns Time in seconds to wait for the pipeline to transition to the requested state, fail otherwise.

Returns:

  • (Integer, nil) —

    Time in seconds to wait for the pipeline to transition to the requested state, fail otherwise.



34
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/data_pipeline.rb', line 34

attribute :timeout

#values ⇒ String?

Returns A list of parameter values (dicts) in the pipeline definition. Each dict takes the keys C(id) and C(stringValue) both of which are strings.

Returns:

  • (String, nil) —

    A list of parameter values (dicts) in the pipeline definition. Each dict takes the keys C(id) and C(stringValue) both of which are strings.



30
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/data_pipeline.rb', line 30

attribute :values