Class: AWSCDK::APIGatewayv2::CfnIntegration

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, Interfaces::AWSApigatewayv2::IIntegrationRef
Defined in:
api_gatewayv2/cfn_integration.rb

Overview

The AWS::ApiGatewayV2::Integration resource creates an integration for an API.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnIntegration

Create a new AWS::ApiGatewayV2::Integration.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::APIGatewayv2::CfnIntegrationProps) —

    Resource properties.



17
18
19
20
21
22
23
 
# File 'api_gatewayv2/cfn_integration.rb', line 17

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::APIGatewayv2::CfnIntegrationProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheXYyLkNmbkludGVncmF0aW9uUHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


187
188
189
 
# File 'api_gatewayv2/cfn_integration.rb', line 187

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_apigatewayv2.CfnIntegration", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_integration(x) ⇒ Boolean

Checks whether the given object is a CfnIntegration.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


89
90
91
92
 
# File 'api_gatewayv2/cfn_integration.rb', line 89

def self.is_cfn_integration(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigatewayv2.CfnIntegration", "isCfnIntegration", [x])
end

.jsii_overridable_methods ⇒ Object 



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'api_gatewayv2/cfn_integration.rb', line 25

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_integration_id => { kind: :property, name: "attrIntegrationId", is_optional: false },
    :integration_ref => { kind: :property, name: "integrationRef", is_optional: false },
    :api_id => { kind: :property, name: "apiId", is_optional: false },
    :integration_type => { kind: :property, name: "integrationType", is_optional: false },
    :request_parameters => { kind: :property, name: "requestParameters", is_optional: false },
    :request_templates => { kind: :property, name: "requestTemplates", is_optional: false },
    :response_parameters => { kind: :property, name: "responseParameters", is_optional: false },
    :connection_id => { kind: :property, name: "connectionId", is_optional: true },
    :connection_type => { kind: :property, name: "connectionType", is_optional: true },
    :content_handling_strategy => { kind: :property, name: "contentHandlingStrategy", is_optional: true },
    :credentials_arn => { kind: :property, name: "credentialsArn", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :integration_method => { kind: :property, name: "integrationMethod", is_optional: true },
    :integration_subtype => { kind: :property, name: "integrationSubtype", is_optional: true },
    :integration_uri => { kind: :property, name: "integrationUri", is_optional: true },
    :passthrough_behavior => { kind: :property, name: "passthroughBehavior", is_optional: true },
    :payload_format_version => { kind: :property, name: "payloadFormatVersion", is_optional: true },
    :template_selection_expression => { kind: :property, name: "templateSelectionExpression", is_optional: true },
    :timeout_in_millis => { kind: :property, name: "timeoutInMillis", is_optional: true },
    :tls_config => { kind: :property, name: "tlsConfig", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



460
461
462
463
 
# File 'api_gatewayv2/cfn_integration.rb', line 460

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



472
473
474
475
 
# File 'api_gatewayv2/cfn_integration.rb', line 472

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



482
483
484
485
 
# File 'api_gatewayv2/cfn_integration.rb', line 482

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



493
494
495
496
497
 
# File 'api_gatewayv2/cfn_integration.rb', line 493

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


550
551
552
553
554
 
# File 'api_gatewayv2/cfn_integration.rb', line 550

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



560
561
562
563
 
# File 'api_gatewayv2/cfn_integration.rb', line 560

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



572
573
574
575
576
 
# File 'api_gatewayv2/cfn_integration.rb', line 572

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#api_id ⇒ String

The API identifier.

Returns:

  • (String) 


208
209
210
 
# File 'api_gatewayv2/cfn_integration.rb', line 208

def api_id()
  jsii_get_property("apiId")
end

#api_id=(value) ⇒ Object 



212
213
214
215
 
# File 'api_gatewayv2/cfn_integration.rb', line 212

def api_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "apiId")
  jsii_set_property("apiId", value)
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



585
586
587
588
 
# File 'api_gatewayv2/cfn_integration.rb', line 585

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



607
608
609
610
611
612
 
# File 'api_gatewayv2/cfn_integration.rb', line 607

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_integration_id ⇒ String

The integration ID.

Returns:

  • (String) 


194
195
196
 
# File 'api_gatewayv2/cfn_integration.rb', line 194

def attr_integration_id()
  jsii_get_property("attrIntegrationId")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



140
141
142
 
# File 'api_gatewayv2/cfn_integration.rb', line 140

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


145
146
147
 
# File 'api_gatewayv2/cfn_integration.rb', line 145

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


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

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


150
151
152
 
# File 'api_gatewayv2/cfn_integration.rb', line 150

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


157
158
159
 
# File 'api_gatewayv2/cfn_integration.rb', line 157

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#connection_id ⇒ String?

The ID of the VPC link for a private integration.

Returns:

  • (String, nil) 


270
271
272
 
# File 'api_gatewayv2/cfn_integration.rb', line 270

def connection_id()
  jsii_get_property("connectionId")
end

#connection_id=(value) ⇒ Object 



274
275
276
277
 
# File 'api_gatewayv2/cfn_integration.rb', line 274

def connection_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "connectionId") unless value.nil?
  jsii_set_property("connectionId", value)
end

#connection_type ⇒ String?

The type of the network connection to the integration endpoint.

Returns:

  • (String, nil) 


282
283
284
 
# File 'api_gatewayv2/cfn_integration.rb', line 282

def connection_type()
  jsii_get_property("connectionType")
end

#connection_type=(value) ⇒ Object 



286
287
288
289
 
# File 'api_gatewayv2/cfn_integration.rb', line 286

def connection_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "connectionType") unless value.nil?
  jsii_set_property("connectionType", value)
end

#content_handling_strategy ⇒ String?

Supported only for WebSocket APIs.

Returns:

  • (String, nil) 


294
295
296
 
# File 'api_gatewayv2/cfn_integration.rb', line 294

def content_handling_strategy()
  jsii_get_property("contentHandlingStrategy")
end

#content_handling_strategy=(value) ⇒ Object 



298
299
300
301
 
# File 'api_gatewayv2/cfn_integration.rb', line 298

def content_handling_strategy=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "contentHandlingStrategy") unless value.nil?
  jsii_set_property("contentHandlingStrategy", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


102
103
104
 
# File 'api_gatewayv2/cfn_integration.rb', line 102

def creation_stack()
  jsii_get_property("creationStack")
end

#credentials_arn ⇒ String?

Specifies the credentials required for the integration, if any.

Returns:

  • (String, nil) 


306
307
308
 
# File 'api_gatewayv2/cfn_integration.rb', line 306

def credentials_arn()
  jsii_get_property("credentialsArn")
end

#credentials_arn=(value) ⇒ Object 



310
311
312
313
 
# File 'api_gatewayv2/cfn_integration.rb', line 310

def credentials_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "credentialsArn") unless value.nil?
  jsii_set_property("credentialsArn", value)
end

#description ⇒ String?

The description of the integration.

Returns:

  • (String, nil) 


318
319
320
 
# File 'api_gatewayv2/cfn_integration.rb', line 318

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



322
323
324
325
 
# File 'api_gatewayv2/cfn_integration.rb', line 322

def description=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless value.nil?
  jsii_set_property("description", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



162
163
164
 
# File 'api_gatewayv2/cfn_integration.rb', line 162

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



629
630
631
632
633
 
# File 'api_gatewayv2/cfn_integration.rb', line 629

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



640
641
642
643
 
# File 'api_gatewayv2/cfn_integration.rb', line 640

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



710
711
712
713
 
# File 'api_gatewayv2/cfn_integration.rb', line 710

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#integration_method ⇒ String?

Specifies the integration's HTTP method type.

Returns:

  • (String, nil) 


330
331
332
 
# File 'api_gatewayv2/cfn_integration.rb', line 330

def integration_method()
  jsii_get_property("integrationMethod")
end

#integration_method=(value) ⇒ Object 



334
335
336
337
 
# File 'api_gatewayv2/cfn_integration.rb', line 334

def integration_method=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "integrationMethod") unless value.nil?
  jsii_set_property("integrationMethod", value)
end

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

A reference to a Integration resource.

Returns:



201
202
203
 
# File 'api_gatewayv2/cfn_integration.rb', line 201

def integration_ref()
  jsii_get_property("integrationRef")
end

#integration_subtype ⇒ String?

Supported only for HTTP API AWS_PROXY integrations.

Returns:

  • (String, nil) 


342
343
344
 
# File 'api_gatewayv2/cfn_integration.rb', line 342

def integration_subtype()
  jsii_get_property("integrationSubtype")
end

#integration_subtype=(value) ⇒ Object 



346
347
348
349
 
# File 'api_gatewayv2/cfn_integration.rb', line 346

def integration_subtype=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "integrationSubtype") unless value.nil?
  jsii_set_property("integrationSubtype", value)
end

#integration_type ⇒ String

The integration type of an integration.

One of the following:.

Returns:

  • (String) 


222
223
224
 
# File 'api_gatewayv2/cfn_integration.rb', line 222

def integration_type()
  jsii_get_property("integrationType")
end

#integration_type=(value) ⇒ Object 



226
227
228
229
 
# File 'api_gatewayv2/cfn_integration.rb', line 226

def integration_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "integrationType")
  jsii_set_property("integrationType", value)
end

#integration_uri ⇒ String?

For a Lambda integration, specify the URI of a Lambda function.

Returns:

  • (String, nil) 


354
355
356
 
# File 'api_gatewayv2/cfn_integration.rb', line 354

def integration_uri()
  jsii_get_property("integrationUri")
end

#integration_uri=(value) ⇒ Object 



358
359
360
361
 
# File 'api_gatewayv2/cfn_integration.rb', line 358

def integration_uri=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "integrationUri") unless value.nil?
  jsii_set_property("integrationUri", value)
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


114
115
116
 
# File 'api_gatewayv2/cfn_integration.rb', line 114

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


97
98
99
 
# File 'api_gatewayv2/cfn_integration.rb', line 97

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



651
652
653
 
# File 'api_gatewayv2/cfn_integration.rb', line 651

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



658
659
660
 
# File 'api_gatewayv2/cfn_integration.rb', line 658

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



451
452
453
454
 
# File 'api_gatewayv2/cfn_integration.rb', line 451

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#passthrough_behavior ⇒ String?

Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource.

Returns:

  • (String, nil) 


366
367
368
 
# File 'api_gatewayv2/cfn_integration.rb', line 366

def passthrough_behavior()
  jsii_get_property("passthroughBehavior")
end

#passthrough_behavior=(value) ⇒ Object 



370
371
372
373
 
# File 'api_gatewayv2/cfn_integration.rb', line 370

def passthrough_behavior=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "passthroughBehavior") unless value.nil?
  jsii_set_property("passthroughBehavior", value)
end

#payload_format_version ⇒ String?

Specifies the format of the payload sent to an integration.

Returns:

  • (String, nil) 


378
379
380
 
# File 'api_gatewayv2/cfn_integration.rb', line 378

def payload_format_version()
  jsii_get_property("payloadFormatVersion")
end

#payload_format_version=(value) ⇒ Object 



382
383
384
385
 
# File 'api_gatewayv2/cfn_integration.rb', line 382

def payload_format_version=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "payloadFormatVersion") unless value.nil?
  jsii_set_property("payloadFormatVersion", value)
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


133
134
135
 
# File 'api_gatewayv2/cfn_integration.rb', line 133

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



669
670
671
672
 
# File 'api_gatewayv2/cfn_integration.rb', line 669

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


676
677
678
679
 
# File 'api_gatewayv2/cfn_integration.rb', line 676

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



686
687
688
689
690
 
# File 'api_gatewayv2/cfn_integration.rb', line 686

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#request_parameters ⇒ Object

For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend.

Returns:

  • (Object) 


234
235
236
 
# File 'api_gatewayv2/cfn_integration.rb', line 234

def request_parameters()
  jsii_get_property("requestParameters")
end

#request_parameters=(value) ⇒ Object 



238
239
240
241
 
# File 'api_gatewayv2/cfn_integration.rb', line 238

def request_parameters=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "requestParameters")
  jsii_set_property("requestParameters", value)
end

#request_templates ⇒ Object

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client.

Returns:

  • (Object) 


246
247
248
 
# File 'api_gatewayv2/cfn_integration.rb', line 246

def request_templates()
  jsii_get_property("requestTemplates")
end

#request_templates=(value) ⇒ Object 



250
251
252
253
 
# File 'api_gatewayv2/cfn_integration.rb', line 250

def request_templates=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "requestTemplates")
  jsii_set_property("requestTemplates", value)
end

#response_parameters ⇒ Object

Supported only for HTTP APIs.

Returns:

  • (Object) 


258
259
260
 
# File 'api_gatewayv2/cfn_integration.rb', line 258

def response_parameters()
  jsii_get_property("responseParameters")
end

#response_parameters=(value) ⇒ Object 



262
263
264
265
 
# File 'api_gatewayv2/cfn_integration.rb', line 262

def response_parameters=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "responseParameters")
  jsii_set_property("responseParameters", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



695
696
697
 
# File 'api_gatewayv2/cfn_integration.rb', line 695

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



123
124
125
 
# File 'api_gatewayv2/cfn_integration.rb', line 123

def stack()
  jsii_get_property("stack")
end

#template_selection_expression ⇒ String?

The template selection expression for the integration.

Returns:

  • (String, nil) 


390
391
392
 
# File 'api_gatewayv2/cfn_integration.rb', line 390

def template_selection_expression()
  jsii_get_property("templateSelectionExpression")
end

#template_selection_expression=(value) ⇒ Object 



394
395
396
397
 
# File 'api_gatewayv2/cfn_integration.rb', line 394

def template_selection_expression=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "templateSelectionExpression") unless value.nil?
  jsii_set_property("templateSelectionExpression", value)
end

#timeout_in_millis ⇒ Numeric?

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

Returns:

  • (Numeric, nil) 


402
403
404
 
# File 'api_gatewayv2/cfn_integration.rb', line 402

def timeout_in_millis()
  jsii_get_property("timeoutInMillis")
end

#timeout_in_millis=(value) ⇒ Object 



406
407
408
409
 
# File 'api_gatewayv2/cfn_integration.rb', line 406

def timeout_in_millis=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "timeoutInMillis") unless value.nil?
  jsii_set_property("timeoutInMillis", value)
end

#tls_config ⇒ AWSCDK::IResolvable, ...

The TLS configuration for a private integration.

Returns:



414
415
416
 
# File 'api_gatewayv2/cfn_integration.rb', line 414

def tls_config()
  jsii_get_property("tlsConfig")
end

#tls_config=(value) ⇒ Object 



418
419
420
421
422
 
# File 'api_gatewayv2/cfn_integration.rb', line 418

def tls_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::APIGatewayv2::CfnIntegration::TLSConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcGlnYXRld2F5djIuQ2ZuSW50ZWdyYXRpb24uVGxzQ29uZmlnUHJvcGVydHkifV19fQ==")), "tlsConfig") unless value.nil?
  jsii_set_property("tlsConfig", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



427
428
429
 
# File 'api_gatewayv2/cfn_integration.rb', line 427

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


170
171
172
 
# File 'api_gatewayv2/cfn_integration.rb', line 170

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


180
181
182
 
# File 'api_gatewayv2/cfn_integration.rb', line 180

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


701
702
703
704
 
# File 'api_gatewayv2/cfn_integration.rb', line 701

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
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. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


440
441
442
443
444
445
 
# File 'api_gatewayv2/cfn_integration.rb', line 440

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