Class: AWSCDK::APIGatewayv2::CfnAPIGatewayManagedOverrides::IntegrationOverridesProperty

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

Overview

The IntegrationOverrides property overrides the integration settings for an API Gateway-managed integration.

If you remove this property, API Gateway restores the default values.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(description: nil, integration_method: nil, payload_format_version: nil, timeout_in_millis: nil) ⇒ IntegrationOverridesProperty

Returns a new instance of IntegrationOverridesProperty.

Parameters:

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

    The description of the integration.

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

    Specifies the integration's HTTP method type.

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

    Specifies the format of the payload sent to an integration.

  • timeout_in_millis (Numeric, nil) (defaults to: nil) —

    Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs.



594
595
596
597
598
599
600
601
602
603
 
# File 'api_gatewayv2/cfn_api_gateway_managed_overrides.rb', line 594

def initialize(description: nil, integration_method: nil, payload_format_version: nil, timeout_in_millis: nil)
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @integration_method = integration_method
  Jsii::Type.check_type(@integration_method, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "integrationMethod") unless @integration_method.nil?
  @payload_format_version = payload_format_version
  Jsii::Type.check_type(@payload_format_version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "payloadFormatVersion") unless @payload_format_version.nil?
  @timeout_in_millis = timeout_in_millis
  Jsii::Type.check_type(@timeout_in_millis, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "timeoutInMillis") unless @timeout_in_millis.nil?
end

Instance Attribute Details

#description ⇒ String? (readonly)

The description of the integration.

Returns:

  • (String, nil)

See Also:



609
610
611
 
# File 'api_gatewayv2/cfn_api_gateway_managed_overrides.rb', line 609

def description
  @description
end

#integration_method ⇒ String? (readonly)

Specifies the integration's HTTP method type.

For WebSocket APIs, if you use a Lambda integration, you must set the integration method to POST .

Returns:

  • (String, nil)

See Also:



616
617
618
 
# File 'api_gatewayv2/cfn_api_gateway_managed_overrides.rb', line 616

def integration_method
  @integration_method
end

#payload_format_version ⇒ String? (readonly)

Specifies the format of the payload sent to an integration.

Required for HTTP APIs. For HTTP APIs, supported values for Lambda proxy integrations are 1.0 and 2.0 . For all other integrations, 1.0 is the only supported value. To learn more, see Working with AWS Lambda proxy integrations for HTTP APIs .

Returns:

  • (String, nil)

See Also:



623
624
625
 
# File 'api_gatewayv2/cfn_api_gateway_managed_overrides.rb', line 623

def payload_format_version
  @payload_format_version
end

#timeout_in_millis ⇒ Numeric? (readonly)

Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs.

The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.

Returns:

  • (Numeric, nil)

See Also:



630
631
632
 
# File 'api_gatewayv2/cfn_api_gateway_managed_overrides.rb', line 630

def timeout_in_millis
  @timeout_in_millis
end

Class Method Details

.jsii_properties ⇒ Object 



632
633
634
635
636
637
638
639
 
# File 'api_gatewayv2/cfn_api_gateway_managed_overrides.rb', line 632

def self.jsii_properties
  {
    :description => "description",
    :integration_method => "integrationMethod",
    :payload_format_version => "payloadFormatVersion",
    :timeout_in_millis => "timeoutInMillis",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



641
642
643
644
645
646
647
648
649
650
 
# File 'api_gatewayv2/cfn_api_gateway_managed_overrides.rb', line 641

def to_jsii
  result = {}
  result.merge!({
    "description" => @description,
    "integrationMethod" => @integration_method,
    "payloadFormatVersion" => @payload_format_version,
    "timeoutInMillis" => @timeout_in_millis,
  })
  result.compact
end