Class: AWSCDK::Pipes::CfnPipe::PipeEnrichmentParametersProperty

Inherits:

Jsii::Struct

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

Defined in:

pipes/cfn_pipe.rb

Overview

The parameters required to set up enrichment on your pipe.

See Also:

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

Instance Attribute Summary

• #http_parameters ⇒ AWSCDK::IResolvable, ... readonly

  Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination.

• #input_template ⇒ String^? readonly

  Valid JSON text passed to the enrichment.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(http_parameters: nil, input_template: nil) ⇒ PipeEnrichmentParametersProperty constructor

  A new instance of PipeEnrichmentParametersProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(http_parameters: nil, input_template: nil) ⇒ PipeEnrichmentParametersProperty

Returns a new instance of PipeEnrichmentParametersProperty.

Parameters:

• http_parameters (AWSCDK::IResolvable, AWSCDK::Pipes::CfnPipe::PipeEnrichmentHttpParametersProperty, nil) (defaults to: nil) —

  Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination.

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

  Valid JSON text passed to the enrichment.

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

def initialize(http_parameters: nil, input_template: nil)
  @http_parameters = http_parameters.is_a?(Hash) ? ::AWSCDK::Pipes::CfnPipe::PipeEnrichmentHttpParametersProperty.new(**http_parameters.transform_keys(&:to_sym)) : http_parameters
  Jsii::Type.check_type(@http_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19waXBlcy5DZm5QaXBlLlBpcGVFbnJpY2htZW50SHR0cFBhcmFtZXRlcnNQcm9wZXJ0eSJ9XX19")), "httpParameters") unless @http_parameters.nil?
  @input_template = input_template
  Jsii::Type.check_type(@input_template, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "inputTemplate") unless @input_template.nil?
end

Instance Attribute Details

#http_parameters ⇒ AWSCDK::IResolvable, ... (readonly)

Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination.

If you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request. If you're using ApiDestinations, the corresponding Connection can also have these values configured. In case of any conflicting keys, values from the Connection take precedence.

Returns:

• (AWSCDK::IResolvable, AWSCDK::Pipes::CfnPipe::PipeEnrichmentHttpParametersProperty, nil)

See Also:

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

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

def http_parameters
  @http_parameters
end

#input_template ⇒ String^? (readonly)

Valid JSON text passed to the enrichment.

In this case, nothing from the event itself is passed to the enrichment. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format .

To remove an input template, specify an empty string.

Returns:

• (String, nil)

See Also:

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

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

def input_template
  @input_template
end

Class Method Details

.jsii_properties ⇒ Object

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

def self.jsii_properties
  {
    :http_parameters => "httpParameters",
    :input_template => "inputTemplate",
  }
end

Instance Method Details

#to_jsii ⇒ Object

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

def to_jsii
  result = {}
  result.merge!({
    "httpParameters" => @http_parameters,
    "inputTemplate" => @input_template,
  })
  result.compact
end