Class: AWSCDK::APIGatewayv2::CfnIntegration::ResponseParameterProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
api_gatewayv2/cfn_integration.rb

Overview

Supported only for HTTP APIs.

You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match the pattern <action>:<header>.<location> or overwrite.statuscode . The action can be append , overwrite or remove . The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses .

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(destination: nil, source: nil) ⇒ ResponseParameterProperty

Returns a new instance of ResponseParameterProperty.

Parameters:

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

    Specifies the location of the response to modify, and how to modify it.

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

    Specifies the data to update the parameter with.



789
790
791
792
793
794
 
# File 'api_gatewayv2/cfn_integration.rb', line 789

def initialize(destination: nil, source: nil)
  @destination = destination
  Jsii::Type.check_type(@destination, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "destination") unless @destination.nil?
  @source = source
  Jsii::Type.check_type(@source, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "source") unless @source.nil?
end

Instance Attribute Details

#destination ⇒ String? (readonly)

Specifies the location of the response to modify, and how to modify it.

To learn more, see Transforming API requests and responses .

Returns:

  • (String, nil)

See Also:



802
803
804
 
# File 'api_gatewayv2/cfn_integration.rb', line 802

def destination
  @destination
end

#source ⇒ String? (readonly)

Specifies the data to update the parameter with.

To learn more, see Transforming API requests and responses .

Returns:

  • (String, nil)

See Also:



809
810
811
 
# File 'api_gatewayv2/cfn_integration.rb', line 809

def source
  @source
end

Class Method Details

.jsii_properties ⇒ Object 



811
812
813
814
815
816
 
# File 'api_gatewayv2/cfn_integration.rb', line 811

def self.jsii_properties
  {
    :destination => "destination",
    :source => "source",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



818
819
820
821
822
823
824
825
 
# File 'api_gatewayv2/cfn_integration.rb', line 818

def to_jsii
  result = {}
  result.merge!({
    "destination" => @destination,
    "source" => @source,
  })
  result.compact
end