Class: AWSCDK::Pipes::CfnPipe::PipeTargetEventBridgeEventBusParametersProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Pipes::CfnPipe::PipeTargetEventBridgeEventBusParametersProperty

Defined in:

pipes/cfn_pipe.rb

Overview

The parameters for using an EventBridge event bus as a target.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargeteventbridgeeventbusparameters.html

Instance Attribute Summary

• #detail_type ⇒ String^? readonly

  A free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.

• #endpoint_id ⇒ String^? readonly

  The URL subdomain of the endpoint.

• #resources ⇒ Array<String>^? readonly

  AWS resources, identified by Amazon Resource Name (ARN), which the event primarily concerns.

• #source ⇒ String^? readonly

  The source of the event.

• #time ⇒ String^? readonly

  The time stamp of the event, per RFC3339 .

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(detail_type: nil, endpoint_id: nil, resources: nil, source: nil, time: nil) ⇒ PipeTargetEventBridgeEventBusParametersProperty constructor

  A new instance of PipeTargetEventBridgeEventBusParametersProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(detail_type: nil, endpoint_id: nil, resources: nil, source: nil, time: nil) ⇒ PipeTargetEventBridgeEventBusParametersProperty

Returns a new instance of PipeTargetEventBridgeEventBusParametersProperty.

Parameters:

• detail_type (String, nil) (defaults to: nil) —

  A free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.

• endpoint_id (String, nil) (defaults to: nil) —

  The URL subdomain of the endpoint.

• resources (Array<String>, nil) (defaults to: nil) —

  AWS resources, identified by Amazon Resource Name (ARN), which the event primarily concerns.

• source (String, nil) (defaults to: nil) —

  The source of the event.

• time (String, nil) (defaults to: nil) —

  The time stamp of the event, per RFC3339 . If no time stamp is provided, the time stamp of the PutEvents call is used.

# File 'pipes/cfn_pipe.rb', line 3323

def initialize(detail_type: nil, endpoint_id: nil, resources: nil, source: nil, time: nil)
  @detail_type = detail_type
  Jsii::Type.check_type(@detail_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "detailType") unless @detail_type.nil?
  @endpoint_id = endpoint_id
  Jsii::Type.check_type(@endpoint_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "endpointId") unless @endpoint_id.nil?
  @resources = resources
  Jsii::Type.check_type(@resources, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "resources") unless @resources.nil?
  @source = source
  Jsii::Type.check_type(@source, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "source") unless @source.nil?
  @time = time
  Jsii::Type.check_type(@time, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "time") unless @time.nil?
end

Instance Attribute Details

#detail_type ⇒ String^? (readonly)

A free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargeteventbridgeeventbusparameters.html#cfn-pipes-pipe-pipetargeteventbridgeeventbusparameters-detailtype

# File 'pipes/cfn_pipe.rb', line 3340

def detail_type
  @detail_type
end

#endpoint_id ⇒ String^? (readonly)

The URL subdomain of the endpoint.

For example, if the URL for Endpoint is https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is abcde.veo .

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargeteventbridgeeventbusparameters.html#cfn-pipes-pipe-pipetargeteventbridgeeventbusparameters-endpointid

# File 'pipes/cfn_pipe.rb', line 3347

def endpoint_id
  @endpoint_id
end

#resources ⇒ Array<String>^? (readonly)

AWS resources, identified by Amazon Resource Name (ARN), which the event primarily concerns.

Any number, including zero, may be present.

Returns:

• (Array<String>, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargeteventbridgeeventbusparameters.html#cfn-pipes-pipe-pipetargeteventbridgeeventbusparameters-resources

# File 'pipes/cfn_pipe.rb', line 3354

def resources
  @resources
end

#source ⇒ String^? (readonly)

The source of the event.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargeteventbridgeeventbusparameters.html#cfn-pipes-pipe-pipetargeteventbridgeeventbusparameters-source

# File 'pipes/cfn_pipe.rb', line 3359

def source
  @source
end

#time ⇒ String^? (readonly)

The time stamp of the event, per RFC3339 . If no time stamp is provided, the time stamp of the PutEvents call is used.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargeteventbridgeeventbusparameters.html#cfn-pipes-pipe-pipetargeteventbridgeeventbusparameters-time

# File 'pipes/cfn_pipe.rb', line 3364

def time
  @time
end

Class Method Details

.jsii_properties ⇒ Object

# File 'pipes/cfn_pipe.rb', line 3366

def self.jsii_properties
  {
    :detail_type => "detailType",
    :endpoint_id => "endpointId",
    :resources => "resources",
    :source => "source",
    :time => "time",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'pipes/cfn_pipe.rb', line 3376

def to_jsii
  result = {}
  result.merge!({
    "detailType" => @detail_type,
    "endpointId" => @endpoint_id,
    "resources" => @resources,
    "source" => @source,
    "time" => @time,
  })
  result.compact
end