Class: AWSCDK::APIGatewayv2::CfnIntegrationResponse

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

Overview

The AWS::ApiGatewayV2::IntegrationResponse resource updates an integration response for an WebSocket API.

For more information, see Set up WebSocket API Integration Responses in API Gateway in the API Gateway Developer Guide .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnIntegrationResponse

Create a new AWS::ApiGatewayV2::IntegrationResponse.

Parameters:



19
20
21
22
23
24
25
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 19

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::APIGatewayv2::CfnIntegrationResponseProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheXYyLkNmbkludGVncmF0aW9uUmVzcG9uc2VQcm9wcyJ9")), "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) 


178
179
180
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 178

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

.is_cfn_integration_response(x) ⇒ Boolean

Checks whether the given object is a CfnIntegrationResponse.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


80
81
82
83
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 80

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

.jsii_overridable_methods ⇒ Object 



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
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 27

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_response_id => { kind: :property, name: "attrIntegrationResponseId", is_optional: false },
    :integration_response_ref => { kind: :property, name: "integrationResponseRef", is_optional: false },
    :api_id => { kind: :property, name: "apiId", is_optional: false },
    :integration_id => { kind: :property, name: "integrationId", is_optional: false },
    :integration_response_key => { kind: :property, name: "integrationResponseKey", is_optional: false },
    :response_parameters => { kind: :property, name: "responseParameters", is_optional: false },
    :response_templates => { kind: :property, name: "responseTemplates", is_optional: false },
    :content_handling_strategy => { kind: :property, name: "contentHandlingStrategy", is_optional: true },
    :template_selection_expression => { kind: :property, name: "templateSelectionExpression", 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.



316
317
318
319
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 316

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:



328
329
330
331
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 328

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:



338
339
340
341
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 338

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:



349
350
351
352
353
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 349

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.


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

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.



416
417
418
419
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 416

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.



428
429
430
431
432
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 428

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) 


199
200
201
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 199

def api_id()
  jsii_get_property("apiId")
end

#api_id=(value) ⇒ Object 



203
204
205
206
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 203

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:



441
442
443
444
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 441

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:



463
464
465
466
467
468
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 463

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_response_id ⇒ String

The integration response ID.

Returns:

  • (String) 


185
186
187
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 185

def attr_integration_response_id()
  jsii_get_property("attrIntegrationResponseId")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



131
132
133
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 131

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


136
137
138
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 136

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


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

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}) 


141
142
143
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 141

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


148
149
150
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 148

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#content_handling_strategy ⇒ String?

Supported only for WebSocket APIs.

Returns:

  • (String, nil) 


259
260
261
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 259

def content_handling_strategy()
  jsii_get_property("contentHandlingStrategy")
end

#content_handling_strategy=(value) ⇒ Object 



263
264
265
266
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 263

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>) 


93
94
95
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 93

def creation_stack()
  jsii_get_property("creationStack")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



153
154
155
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 153

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:



485
486
487
488
489
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 485

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:



496
497
498
499
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 496

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:



566
567
568
569
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 566

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

#integration_id ⇒ String

The integration ID.

Returns:

  • (String) 


211
212
213
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 211

def integration_id()
  jsii_get_property("integrationId")
end

#integration_id=(value) ⇒ Object 



215
216
217
218
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 215

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

#integration_response_key ⇒ String

The integration response key.

Returns:

  • (String) 


223
224
225
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 223

def integration_response_key()
  jsii_get_property("integrationResponseKey")
end

#integration_response_key=(value) ⇒ Object 



227
228
229
230
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 227

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

#integration_response_ref ⇒ AWSCDK::Interfaces::AWSApigatewayv2::IntegrationResponseReference

A reference to a IntegrationResponse resource.

Returns:



192
193
194
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 192

def integration_response_ref()
  jsii_get_property("integrationResponseRef")
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) 


105
106
107
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 105

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


88
89
90
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 88

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:



507
508
509
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 507

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:



514
515
516
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 514

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.



307
308
309
310
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 307

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

#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) 


124
125
126
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 124

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:



525
526
527
528
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 525

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}) 


532
533
534
535
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 532

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:



542
543
544
545
546
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 542

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

#response_parameters ⇒ Object

A key-value map specifying response parameters that are passed to the method response from the backend.

Returns:

  • (Object) 


235
236
237
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 235

def response_parameters()
  jsii_get_property("responseParameters")
end

#response_parameters=(value) ⇒ Object 



239
240
241
242
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 239

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

#response_templates ⇒ Object

The collection of response templates for the integration response as a string-to-string map of key-value pairs.

Returns:

  • (Object) 


247
248
249
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 247

def response_templates()
  jsii_get_property("responseTemplates")
end

#response_templates=(value) ⇒ Object 



251
252
253
254
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 251

def response_templates=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "responseTemplates")
  jsii_set_property("responseTemplates", 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.



551
552
553
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 551

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:



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

def stack()
  jsii_get_property("stack")
end

#template_selection_expression ⇒ String?

The template selection expression for the integration response.

Returns:

  • (String, nil) 


271
272
273
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 271

def template_selection_expression()
  jsii_get_property("templateSelectionExpression")
end

#template_selection_expression=(value) ⇒ Object 



275
276
277
278
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 275

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

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



283
284
285
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 283

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}) 


161
162
163
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 161

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}) 


171
172
173
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 171

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


557
558
559
560
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 557

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) 


296
297
298
299
300
301
 
# File 'api_gatewayv2/cfn_integration_response.rb', line 296

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