Class: Aws::Pipes::Types::Pipe

Inherits:

Struct

• Object
• Struct
• Aws::Pipes::Types::Pipe

Defined in:

gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb

Overview

An object that represents a pipe. Amazon EventBridgePipes connect event sources to targets and reduces the need for specialized knowledge and integration code.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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.

• #desired_state ⇒ String

  The state the pipe should be in.

• #enrichment ⇒ String

  The ARN of the enrichment resource.

• #last_modified_time ⇒ Time

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

• #name ⇒ String

  The name of the pipe.

• #source ⇒ String

  The ARN of the source resource.

• #state_reason ⇒ String

  The reason the pipe is in its current state.

• #target ⇒ String

  The ARN of the target resource.

Instance Attribute Details

#arn ⇒ String

The ARN of the pipe.

Returns:

• (String)

# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 1379

class Pipe < Struct.new(
  :arn,
  :creation_time,
  :current_state,
  :desired_state,
  :enrichment,
  :last_modified_time,
  :name,
  :source,
  :state_reason,
  :target)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ Time

The time the pipe was created.

Returns:

• (Time)

# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 1379

class Pipe < Struct.new(
  :arn,
  :creation_time,
  :current_state,
  :desired_state,
  :enrichment,
  :last_modified_time,
  :name,
  :source,
  :state_reason,
  :target)
  SENSITIVE = []
  include Aws::Structure
end

#current_state ⇒ String

The state the pipe is in.

Returns:

• (String)

# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 1379

class Pipe < Struct.new(
  :arn,
  :creation_time,
  :current_state,
  :desired_state,
  :enrichment,
  :last_modified_time,
  :name,
  :source,
  :state_reason,
  :target)
  SENSITIVE = []
  include Aws::Structure
end

#desired_state ⇒ String

The state the pipe should be in.

Returns:

• (String)

# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 1379

class Pipe < Struct.new(
  :arn,
  :creation_time,
  :current_state,
  :desired_state,
  :enrichment,
  :last_modified_time,
  :name,
  :source,
  :state_reason,
  :target)
  SENSITIVE = []
  include Aws::Structure
end

#enrichment ⇒ String

The ARN of the enrichment resource.

Returns:

• (String)

# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 1379

class Pipe < Struct.new(
  :arn,
  :creation_time,
  :current_state,
  :desired_state,
  :enrichment,
  :last_modified_time,
  :name,
  :source,
  :state_reason,
  :target)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_time ⇒ Time

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

Returns:

• (Time)

# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 1379

class Pipe < Struct.new(
  :arn,
  :creation_time,
  :current_state,
  :desired_state,
  :enrichment,
  :last_modified_time,
  :name,
  :source,
  :state_reason,
  :target)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the pipe.

Returns:

• (String)

# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 1379

class Pipe < Struct.new(
  :arn,
  :creation_time,
  :current_state,
  :desired_state,
  :enrichment,
  :last_modified_time,
  :name,
  :source,
  :state_reason,
  :target)
  SENSITIVE = []
  include Aws::Structure
end

#source ⇒ String

The ARN of the source resource.

Returns:

• (String)

# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 1379

class Pipe < Struct.new(
  :arn,
  :creation_time,
  :current_state,
  :desired_state,
  :enrichment,
  :last_modified_time,
  :name,
  :source,
  :state_reason,
  :target)
  SENSITIVE = []
  include Aws::Structure
end

#state_reason ⇒ String

The reason the pipe is in its current state.

Returns:

• (String)

# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 1379

class Pipe < Struct.new(
  :arn,
  :creation_time,
  :current_state,
  :desired_state,
  :enrichment,
  :last_modified_time,
  :name,
  :source,
  :state_reason,
  :target)
  SENSITIVE = []
  include Aws::Structure
end

#target ⇒ String

The ARN of the target resource.

Returns:

• (String)

# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 1379

class Pipe < Struct.new(
  :arn,
  :creation_time,
  :current_state,
  :desired_state,
  :enrichment,
  :last_modified_time,
  :name,
  :source,
  :state_reason,
  :target)
  SENSITIVE = []
  include Aws::Structure
end