Class: Aws::Pipes::Types::DescribePipeResponse

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[:description]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The ARN of the pipe.

Returns:

  • (String)


727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 727

class DescribePipeResponse < Struct.new(
  :arn,
  :creation_time,
  :current_state,
  :description,
  :desired_state,
  :enrichment,
  :enrichment_parameters,
  :last_modified_time,
  :log_configuration,
  :name,
  :role_arn,
  :source,
  :source_parameters,
  :state_reason,
  :tags,
  :target,
  :target_parameters)
  SENSITIVE = [:description]
  include Aws::Structure
end

#creation_timeTime

The time the pipe was created.

Returns:

  • (Time)


727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 727

class DescribePipeResponse < Struct.new(
  :arn,
  :creation_time,
  :current_state,
  :description,
  :desired_state,
  :enrichment,
  :enrichment_parameters,
  :last_modified_time,
  :log_configuration,
  :name,
  :role_arn,
  :source,
  :source_parameters,
  :state_reason,
  :tags,
  :target,
  :target_parameters)
  SENSITIVE = [:description]
  include Aws::Structure
end

#current_stateString

The state the pipe is in.

Returns:

  • (String)


727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 727

class DescribePipeResponse < Struct.new(
  :arn,
  :creation_time,
  :current_state,
  :description,
  :desired_state,
  :enrichment,
  :enrichment_parameters,
  :last_modified_time,
  :log_configuration,
  :name,
  :role_arn,
  :source,
  :source_parameters,
  :state_reason,
  :tags,
  :target,
  :target_parameters)
  SENSITIVE = [:description]
  include Aws::Structure
end

#descriptionString

A description of the pipe.

Returns:

  • (String)


727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 727

class DescribePipeResponse < Struct.new(
  :arn,
  :creation_time,
  :current_state,
  :description,
  :desired_state,
  :enrichment,
  :enrichment_parameters,
  :last_modified_time,
  :log_configuration,
  :name,
  :role_arn,
  :source,
  :source_parameters,
  :state_reason,
  :tags,
  :target,
  :target_parameters)
  SENSITIVE = [:description]
  include Aws::Structure
end

#desired_stateString

The state the pipe should be in.

Returns:

  • (String)


727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 727

class DescribePipeResponse < Struct.new(
  :arn,
  :creation_time,
  :current_state,
  :description,
  :desired_state,
  :enrichment,
  :enrichment_parameters,
  :last_modified_time,
  :log_configuration,
  :name,
  :role_arn,
  :source,
  :source_parameters,
  :state_reason,
  :tags,
  :target,
  :target_parameters)
  SENSITIVE = [:description]
  include Aws::Structure
end

#enrichmentString

The ARN of the enrichment resource.

Returns:

  • (String)


727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 727

class DescribePipeResponse < Struct.new(
  :arn,
  :creation_time,
  :current_state,
  :description,
  :desired_state,
  :enrichment,
  :enrichment_parameters,
  :last_modified_time,
  :log_configuration,
  :name,
  :role_arn,
  :source,
  :source_parameters,
  :state_reason,
  :tags,
  :target,
  :target_parameters)
  SENSITIVE = [:description]
  include Aws::Structure
end

#enrichment_parametersTypes::PipeEnrichmentParameters

The parameters required to set up enrichment on your pipe.



727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 727

class DescribePipeResponse < Struct.new(
  :arn,
  :creation_time,
  :current_state,
  :description,
  :desired_state,
  :enrichment,
  :enrichment_parameters,
  :last_modified_time,
  :log_configuration,
  :name,
  :role_arn,
  :source,
  :source_parameters,
  :state_reason,
  :tags,
  :target,
  :target_parameters)
  SENSITIVE = [:description]
  include Aws::Structure
end

#last_modified_timeTime

When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

Returns:

  • (Time)


727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 727

class DescribePipeResponse < Struct.new(
  :arn,
  :creation_time,
  :current_state,
  :description,
  :desired_state,
  :enrichment,
  :enrichment_parameters,
  :last_modified_time,
  :log_configuration,
  :name,
  :role_arn,
  :source,
  :source_parameters,
  :state_reason,
  :tags,
  :target,
  :target_parameters)
  SENSITIVE = [:description]
  include Aws::Structure
end

#log_configurationTypes::PipeLogConfiguration

The logging configuration settings for the pipe.



727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 727

class DescribePipeResponse < Struct.new(
  :arn,
  :creation_time,
  :current_state,
  :description,
  :desired_state,
  :enrichment,
  :enrichment_parameters,
  :last_modified_time,
  :log_configuration,
  :name,
  :role_arn,
  :source,
  :source_parameters,
  :state_reason,
  :tags,
  :target,
  :target_parameters)
  SENSITIVE = [:description]
  include Aws::Structure
end

#nameString

The name of the pipe.

Returns:

  • (String)


727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 727

class DescribePipeResponse < Struct.new(
  :arn,
  :creation_time,
  :current_state,
  :description,
  :desired_state,
  :enrichment,
  :enrichment_parameters,
  :last_modified_time,
  :log_configuration,
  :name,
  :role_arn,
  :source,
  :source_parameters,
  :state_reason,
  :tags,
  :target,
  :target_parameters)
  SENSITIVE = [:description]
  include Aws::Structure
end

#role_arnString

The ARN of the role that allows the pipe to send data to the target.

Returns:

  • (String)


727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 727

class DescribePipeResponse < Struct.new(
  :arn,
  :creation_time,
  :current_state,
  :description,
  :desired_state,
  :enrichment,
  :enrichment_parameters,
  :last_modified_time,
  :log_configuration,
  :name,
  :role_arn,
  :source,
  :source_parameters,
  :state_reason,
  :tags,
  :target,
  :target_parameters)
  SENSITIVE = [:description]
  include Aws::Structure
end

#sourceString

The ARN of the source resource.

Returns:

  • (String)


727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 727

class DescribePipeResponse < Struct.new(
  :arn,
  :creation_time,
  :current_state,
  :description,
  :desired_state,
  :enrichment,
  :enrichment_parameters,
  :last_modified_time,
  :log_configuration,
  :name,
  :role_arn,
  :source,
  :source_parameters,
  :state_reason,
  :tags,
  :target,
  :target_parameters)
  SENSITIVE = [:description]
  include Aws::Structure
end

#source_parametersTypes::PipeSourceParameters

The parameters required to set up a source for your pipe.



727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 727

class DescribePipeResponse < Struct.new(
  :arn,
  :creation_time,
  :current_state,
  :description,
  :desired_state,
  :enrichment,
  :enrichment_parameters,
  :last_modified_time,
  :log_configuration,
  :name,
  :role_arn,
  :source,
  :source_parameters,
  :state_reason,
  :tags,
  :target,
  :target_parameters)
  SENSITIVE = [:description]
  include Aws::Structure
end

#state_reasonString

The reason the pipe is in its current state.

Returns:

  • (String)


727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 727

class DescribePipeResponse < Struct.new(
  :arn,
  :creation_time,
  :current_state,
  :description,
  :desired_state,
  :enrichment,
  :enrichment_parameters,
  :last_modified_time,
  :log_configuration,
  :name,
  :role_arn,
  :source,
  :source_parameters,
  :state_reason,
  :tags,
  :target,
  :target_parameters)
  SENSITIVE = [:description]
  include Aws::Structure
end

#tagsHash<String,String>

The list of key-value pairs to associate with the pipe.

Returns:

  • (Hash<String,String>)


727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 727

class DescribePipeResponse < Struct.new(
  :arn,
  :creation_time,
  :current_state,
  :description,
  :desired_state,
  :enrichment,
  :enrichment_parameters,
  :last_modified_time,
  :log_configuration,
  :name,
  :role_arn,
  :source,
  :source_parameters,
  :state_reason,
  :tags,
  :target,
  :target_parameters)
  SENSITIVE = [:description]
  include Aws::Structure
end

#targetString

The ARN of the target resource.

Returns:

  • (String)


727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 727

class DescribePipeResponse < Struct.new(
  :arn,
  :creation_time,
  :current_state,
  :description,
  :desired_state,
  :enrichment,
  :enrichment_parameters,
  :last_modified_time,
  :log_configuration,
  :name,
  :role_arn,
  :source,
  :source_parameters,
  :state_reason,
  :tags,
  :target,
  :target_parameters)
  SENSITIVE = [:description]
  include Aws::Structure
end

#target_parametersTypes::PipeTargetParameters

The parameters required to set up a target for your pipe.

For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide.



727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 727

class DescribePipeResponse < Struct.new(
  :arn,
  :creation_time,
  :current_state,
  :description,
  :desired_state,
  :enrichment,
  :enrichment_parameters,
  :last_modified_time,
  :log_configuration,
  :name,
  :role_arn,
  :source,
  :source_parameters,
  :state_reason,
  :tags,
  :target,
  :target_parameters)
  SENSITIVE = [:description]
  include Aws::Structure
end