Class: Aws::Pipes::Types::DescribePipeResponse
- Inherits:
-
Struct
- Object
- Struct
- Aws::Pipes::Types::DescribePipeResponse
- Defined in:
- gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[:description]
Instance Attribute Summary collapse
-
#arn ⇒ String
The ARN of the pipe.
-
#creation_time ⇒ Time
The time the pipe was created.
-
#current_state ⇒ String
The state the pipe is in.
-
#description ⇒ String
A description of the pipe.
-
#desired_state ⇒ String
The state the pipe should be in.
-
#enrichment ⇒ String
The ARN of the enrichment resource.
-
#enrichment_parameters ⇒ Types::PipeEnrichmentParameters
The parameters required to set up enrichment on your pipe.
-
#last_modified_time ⇒ Time
When the pipe was last updated, in [ISO-8601 format][1] (YYYY-MM-DDThh:mm:ss.sTZD).
-
#log_configuration ⇒ Types::PipeLogConfiguration
The logging configuration settings for the pipe.
-
#name ⇒ String
The name of the pipe.
-
#role_arn ⇒ String
The ARN of the role that allows the pipe to send data to the target.
-
#source ⇒ String
The ARN of the source resource.
-
#source_parameters ⇒ Types::PipeSourceParameters
The parameters required to set up a source for your pipe.
-
#state_reason ⇒ String
The reason the pipe is in its current state.
-
#tags ⇒ Hash<String,String>
The list of key-value pairs to associate with the pipe.
-
#target ⇒ String
The ARN of the target resource.
-
#target_parameters ⇒ Types::PipeTargetParameters
The parameters required to set up a target for your pipe.
Instance Attribute Details
#arn ⇒ String
The ARN of 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 |
#creation_time ⇒ Time
The time the pipe was created.
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_state ⇒ String
The state the pipe is in.
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 |
#description ⇒ String
A description of 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 |
#desired_state ⇒ String
The state the pipe should be in.
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 ⇒ String
The ARN of the enrichment resource.
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_parameters ⇒ Types::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_time ⇒ Time
When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
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_configuration ⇒ Types::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 |
#name ⇒ String
The name of 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 |
#role_arn ⇒ String
The ARN of the role that allows the pipe to send data to the target.
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 ⇒ String
The ARN of the source resource.
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_parameters ⇒ Types::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_reason ⇒ String
The reason the pipe is in its current state.
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 |
#tags ⇒ Hash<String,String>
The list of key-value pairs to associate with 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 |
#target ⇒ String
The ARN of the target resource.
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_parameters ⇒ Types::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 |