Module: AWSCDK::APIGatewayv2::IHttpIntegration

Includes:
IIntegration
Included in:
HttpIntegration
Defined in:
api_gatewayv2/i_http_integration.rb

Overview

Represents an Integration for an HTTP API.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'api_gatewayv2/i_http_integration.rb', line 89

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :integration_ref => { kind: :property, name: "integrationRef", is_optional: false },
    :integration_id => { kind: :property, name: "integrationId", is_optional: false },
    :http_api => { kind: :property, name: "httpApi", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
  }
end

Instance Method Details

#apply_removal_policy(policy) ⇒ void

This method returns an undefined value.

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:



84
85
86
87
 
# File 'api_gatewayv2/i_http_integration.rb', line 84

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Returns:



26
27
28
 
# File 'api_gatewayv2/i_http_integration.rb', line 26

def env()
  jsii_get_property("env")
end

#http_api ⇒ AWSCDK::APIGatewayv2::IHttpAPI

The HTTP API associated with this integration.

Returns:



54
55
56
 
# File 'api_gatewayv2/i_http_integration.rb', line 54

def http_api()
  jsii_get_property("httpApi")
end

#integration_id ⇒ String

Id of the integration.

Returns:

  • (String) 


47
48
49
 
# File 'api_gatewayv2/i_http_integration.rb', line 47

def integration_id()
  jsii_get_property("integrationId")
end

#integration_ref ⇒ AWSCDK::Interfaces::AWSApigatewayv2::IntegrationReference

A reference to a Integration resource.

Returns:



40
41
42
 
# File 'api_gatewayv2/i_http_integration.rb', line 40

def integration_ref()
  jsii_get_property("integrationRef")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


11
12
13
 
# File 'api_gatewayv2/i_http_integration.rb', line 11

def node()
  jsii_get_property("node")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



33
34
35
 
# File 'api_gatewayv2/i_http_integration.rb', line 33

def stack()
  jsii_get_property("stack")
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.

Parameters:

  • mixins (Array<Constructs::IMixin>) —

    The mixins to apply.

Returns:

  • (Constructs::IConstruct) —

    This construct for chaining



65
66
67
68
69
70
 
# File 'api_gatewayv2/i_http_integration.rb', line 65

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end