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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:description, :tags]

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

The ARN of the pipe.

Returns:

  • (String) 


757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
 
# File 'lib/aws-sdk-pipes/types.rb', line 757

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

#creation_time ⇒ Time

The time the pipe was created.

Returns:

  • (Time) 


757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
 
# File 'lib/aws-sdk-pipes/types.rb', line 757

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

#current_state ⇒ String

The state the pipe is in.

Returns:

  • (String) 


757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
 
# File 'lib/aws-sdk-pipes/types.rb', line 757

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

#description ⇒ String

A description of the pipe.

Returns:

  • (String) 


757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
 
# File 'lib/aws-sdk-pipes/types.rb', line 757

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

#desired_state ⇒ String

The state the pipe should be in.

Returns:

  • (String) 


757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
 
# File 'lib/aws-sdk-pipes/types.rb', line 757

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

#enrichment ⇒ String

The ARN of the enrichment resource.

Returns:

  • (String) 


757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
 
# File 'lib/aws-sdk-pipes/types.rb', line 757

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

#enrichment_parameters ⇒ Types::PipeEnrichmentParameters

The parameters required to set up enrichment on your pipe.

Returns:



757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
 
# File 'lib/aws-sdk-pipes/types.rb', line 757

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

#kms_key_identifier ⇒ String

The identifier of the KMS customer managed key for EventBridge to use to encrypt pipe data, if one has been specified.

For more information, see [Data encryption in EventBridge] in the *Amazon EventBridge User Guide*.

[1]: docs.aws.amazon.com/eventbridge/latest/userguide/eb-encryption.html

Returns:

  • (String) 


757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
 
# File 'lib/aws-sdk-pipes/types.rb', line 757

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

#last_modified_time ⇒ Time

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

[1]: www.w3.org/TR/NOTE-datetime

Returns:

  • (Time) 


757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
 
# File 'lib/aws-sdk-pipes/types.rb', line 757

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

#log_configuration ⇒ Types::PipeLogConfiguration

The logging configuration settings for the pipe.

Returns:



757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
 
# File 'lib/aws-sdk-pipes/types.rb', line 757

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

#name ⇒ String

The name of the pipe.

Returns:

  • (String) 


757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
 
# File 'lib/aws-sdk-pipes/types.rb', line 757

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

#role_arn ⇒ String

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

Returns:

  • (String) 


757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
 
# File 'lib/aws-sdk-pipes/types.rb', line 757

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

#source ⇒ String

The ARN of the source resource.

Returns:

  • (String) 


757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
 
# File 'lib/aws-sdk-pipes/types.rb', line 757

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

#source_parameters ⇒ Types::PipeSourceParameters

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

Returns:



757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
 
# File 'lib/aws-sdk-pipes/types.rb', line 757

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

#state_reason ⇒ String

The reason the pipe is in its current state.

Returns:

  • (String) 


757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
 
# File 'lib/aws-sdk-pipes/types.rb', line 757

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

#tags ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
 
# File 'lib/aws-sdk-pipes/types.rb', line 757

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

#target ⇒ String

The ARN of the target resource.

Returns:

  • (String) 


757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
 
# File 'lib/aws-sdk-pipes/types.rb', line 757

class DescribePipeResponse < Struct.new(
  :arn,
  :name,
  :description,
  :desired_state,
  :current_state,
  :state_reason,
  :source,
  :source_parameters,
  :enrichment,
  :enrichment_parameters,
  :target,
  :target_parameters,
  :role_arn,
  :tags,
  :creation_time,
  :last_modified_time,
  :log_configuration,
  :kms_key_identifier)
  SENSITIVE = [:description, :tags]
  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*.

[1]: docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-target.html

Returns:



757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
 
# File 'lib/aws-sdk-pipes/types.rb', line 757

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