Class: AWSCDK::Pipes::CfnPipe::PipeEnrichmentHttpParametersProperty

Inherits:

Jsii::Struct

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

Defined in:

pipes/cfn_pipe.rb

Overview

These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.

In the latter case, these are merged with any InvocationParameters specified on the Connection, with any values from the Connection taking precedence.

See Also:

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

Instance Attribute Summary

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

  The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.

• #path_parameter_values ⇒ Array<String>^? readonly

  The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("*").

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

  The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(header_parameters: nil, path_parameter_values: nil, query_string_parameters: nil) ⇒ PipeEnrichmentHttpParametersProperty constructor

  A new instance of PipeEnrichmentHttpParametersProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(header_parameters: nil, path_parameter_values: nil, query_string_parameters: nil) ⇒ PipeEnrichmentHttpParametersProperty

Returns a new instance of PipeEnrichmentHttpParametersProperty.

Parameters:

• header_parameters (AWSCDK::IResolvable, Hash{String => String}, nil) (defaults to: nil) —

  The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.

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

  The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("*").

• query_string_parameters (AWSCDK::IResolvable, Hash{String => String}, nil) (defaults to: nil) —

  The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.

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

def initialize(header_parameters: nil, path_parameter_values: nil, query_string_parameters: nil)
  @header_parameters = header_parameters
  Jsii::Type.check_type(@header_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsicHJpbWl0aXZlIjoic3RyaW5nIn0sImtpbmQiOiJtYXAifX1dfX0=")), "headerParameters") unless @header_parameters.nil?
  @path_parameter_values = path_parameter_values
  Jsii::Type.check_type(@path_parameter_values, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "pathParameterValues") unless @path_parameter_values.nil?
  @query_string_parameters = query_string_parameters
  Jsii::Type.check_type(@query_string_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsicHJpbWl0aXZlIjoic3RyaW5nIn0sImtpbmQiOiJtYXAifX1dfX0=")), "queryStringParameters") unless @query_string_parameters.nil?
end

Instance Attribute Details

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

The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.

Returns:

• (AWSCDK::IResolvable, Hash{String => String}, nil)

See Also:

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

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

def header_parameters
  @header_parameters
end

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

The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("*").

Returns:

• (Array<String>, nil)

See Also:

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

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

def path_parameter_values
  @path_parameter_values
end

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

The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.

Returns:

• (AWSCDK::IResolvable, Hash{String => String}, nil)

See Also:

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

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

def query_string_parameters
  @query_string_parameters
end

Class Method Details

.jsii_properties ⇒ Object

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

def self.jsii_properties
  {
    :header_parameters => "headerParameters",
    :path_parameter_values => "pathParameterValues",
    :query_string_parameters => "queryStringParameters",
  }
end

Instance Method Details

#to_jsii ⇒ Object

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

def to_jsii
  result = {}
  result.merge!({
    "headerParameters" => @header_parameters,
    "pathParameterValues" => @path_parameter_values,
    "queryStringParameters" => @query_string_parameters,
  })
  result.compact
end