Class: AWSCDK::APIGatewayv2::CfnRoute

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

Overview

The AWS::ApiGatewayV2::Route resource creates a route for an API.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnRoute

Create a new AWS::ApiGatewayV2::Route.

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::CfnRouteProps) —

    Resource properties.



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

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


181
182
183
 
# File 'api_gatewayv2/cfn_route.rb', line 181

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

.is_cfn_route(x) ⇒ Boolean

Checks whether the given object is a CfnRoute.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


83
84
85
86
 
# File 'api_gatewayv2/cfn_route.rb', line 83

def self.is_cfn_route(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigatewayv2.CfnRoute", "isCfnRoute", [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
 
# File 'api_gatewayv2/cfn_route.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_route_id => { kind: :property, name: "attrRouteId", is_optional: false },
    :route_ref => { kind: :property, name: "routeRef", is_optional: false },
    :api_id => { kind: :property, name: "apiId", is_optional: false },
    :request_models => { kind: :property, name: "requestModels", is_optional: false },
    :request_parameters => { kind: :property, name: "requestParameters", is_optional: false },
    :route_key => { kind: :property, name: "routeKey", is_optional: false },
    :api_key_required => { kind: :property, name: "apiKeyRequired", is_optional: true },
    :authorization_scopes => { kind: :property, name: "authorizationScopes", is_optional: true },
    :authorization_type => { kind: :property, name: "authorizationType", is_optional: true },
    :authorizer_id => { kind: :property, name: "authorizerId", is_optional: true },
    :model_selection_expression => { kind: :property, name: "modelSelectionExpression", is_optional: true },
    :operation_name => { kind: :property, name: "operationName", is_optional: true },
    :route_response_selection_expression => { kind: :property, name: "routeResponseSelectionExpression", is_optional: true },
    :target => { kind: :property, name: "target", 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.



379
380
381
382
 
# File 'api_gatewayv2/cfn_route.rb', line 379

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:



391
392
393
394
 
# File 'api_gatewayv2/cfn_route.rb', line 391

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:



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

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:



412
413
414
415
416
 
# File 'api_gatewayv2/cfn_route.rb', line 412

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.


469
470
471
472
473
 
# File 'api_gatewayv2/cfn_route.rb', line 469

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.



479
480
481
482
 
# File 'api_gatewayv2/cfn_route.rb', line 479

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.



491
492
493
494
495
 
# File 'api_gatewayv2/cfn_route.rb', line 491

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) 


202
203
204
 
# File 'api_gatewayv2/cfn_route.rb', line 202

def api_id()
  jsii_get_property("apiId")
end

#api_id=(value) ⇒ Object 



206
207
208
209
 
# File 'api_gatewayv2/cfn_route.rb', line 206

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

#api_key_required ⇒ Boolean, ...

Specifies whether an API key is required for the route.

Returns:



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

def api_key_required()
  jsii_get_property("apiKeyRequired")
end

#api_key_required=(value) ⇒ Object 



254
255
256
257
 
# File 'api_gatewayv2/cfn_route.rb', line 254

def api_key_required=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "apiKeyRequired") unless value.nil?
  jsii_set_property("apiKeyRequired", 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:



504
505
506
507
 
# File 'api_gatewayv2/cfn_route.rb', line 504

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:



526
527
528
529
530
531
 
# File 'api_gatewayv2/cfn_route.rb', line 526

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

The route ID.

Returns:

  • (String) 


188
189
190
 
# File 'api_gatewayv2/cfn_route.rb', line 188

def attr_route_id()
  jsii_get_property("attrRouteId")
end

#authorization_scopes ⇒ Array<String>?

The authorization scopes supported by this route.

Returns:

  • (Array<String>, nil) 


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

def authorization_scopes()
  jsii_get_property("authorizationScopes")
end

#authorization_scopes=(value) ⇒ Object 



266
267
268
269
 
# File 'api_gatewayv2/cfn_route.rb', line 266

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

#authorization_type ⇒ String?

The authorization type for the route.

Returns:

  • (String, nil) 


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

def authorization_type()
  jsii_get_property("authorizationType")
end

#authorization_type=(value) ⇒ Object 



278
279
280
281
 
# File 'api_gatewayv2/cfn_route.rb', line 278

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

#authorizer_id ⇒ String?

The identifier of the Authorizer resource to be associated with this route.

Returns:

  • (String, nil) 


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

def authorizer_id()
  jsii_get_property("authorizerId")
end

#authorizer_id=(value) ⇒ Object 



290
291
292
293
 
# File 'api_gatewayv2/cfn_route.rb', line 290

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

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



134
135
136
 
# File 'api_gatewayv2/cfn_route.rb', line 134

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


139
140
141
 
# File 'api_gatewayv2/cfn_route.rb', line 139

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


535
536
537
538
 
# File 'api_gatewayv2/cfn_route.rb', line 535

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


144
145
146
 
# File 'api_gatewayv2/cfn_route.rb', line 144

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


151
152
153
 
# File 'api_gatewayv2/cfn_route.rb', line 151

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


96
97
98
 
# File 'api_gatewayv2/cfn_route.rb', line 96

def creation_stack()
  jsii_get_property("creationStack")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



156
157
158
 
# File 'api_gatewayv2/cfn_route.rb', line 156

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:



548
549
550
551
552
 
# File 'api_gatewayv2/cfn_route.rb', line 548

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:



559
560
561
562
 
# File 'api_gatewayv2/cfn_route.rb', line 559

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:



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

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
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) 


108
109
110
 
# File 'api_gatewayv2/cfn_route.rb', line 108

def logical_id()
  jsii_get_property("logicalId")
end

#model_selection_expression ⇒ String?

The model selection expression for the route.

Returns:

  • (String, nil) 


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

def model_selection_expression()
  jsii_get_property("modelSelectionExpression")
end

#model_selection_expression=(value) ⇒ Object 



302
303
304
305
 
# File 'api_gatewayv2/cfn_route.rb', line 302

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


91
92
93
 
# File 'api_gatewayv2/cfn_route.rb', line 91

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:



570
571
572
 
# File 'api_gatewayv2/cfn_route.rb', line 570

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:



577
578
579
 
# File 'api_gatewayv2/cfn_route.rb', line 577

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

#operation_name ⇒ String?

The operation name for the route.

Returns:

  • (String, nil) 


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

def operation_name()
  jsii_get_property("operationName")
end

#operation_name=(value) ⇒ Object 



314
315
316
317
 
# File 'api_gatewayv2/cfn_route.rb', line 314

def operation_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "operationName") unless value.nil?
  jsii_set_property("operationName", value)
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.



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

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) 


127
128
129
 
# File 'api_gatewayv2/cfn_route.rb', line 127

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:



588
589
590
591
 
# File 'api_gatewayv2/cfn_route.rb', line 588

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


595
596
597
598
 
# File 'api_gatewayv2/cfn_route.rb', line 595

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:



605
606
607
608
609
 
# File 'api_gatewayv2/cfn_route.rb', line 605

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_models ⇒ Object

The request models for the route.

Returns:

  • (Object) 


214
215
216
 
# File 'api_gatewayv2/cfn_route.rb', line 214

def request_models()
  jsii_get_property("requestModels")
end

#request_models=(value) ⇒ Object 



218
219
220
221
 
# File 'api_gatewayv2/cfn_route.rb', line 218

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

#request_parameters ⇒ Object

The request parameters for the route.

Returns:

  • (Object) 


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

def request_parameters()
  jsii_get_property("requestParameters")
end

#request_parameters=(value) ⇒ Object 



230
231
232
233
 
# File 'api_gatewayv2/cfn_route.rb', line 230

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

#route_key ⇒ String

The route key for the route.

Returns:

  • (String) 


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

def route_key()
  jsii_get_property("routeKey")
end

#route_key=(value) ⇒ Object 



242
243
244
245
 
# File 'api_gatewayv2/cfn_route.rb', line 242

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

#route_ref ⇒ AWSCDK::Interfaces::AWSApigatewayv2::RouteReference

A reference to a Route resource.

Returns:



195
196
197
 
# File 'api_gatewayv2/cfn_route.rb', line 195

def route_ref()
  jsii_get_property("routeRef")
end

#route_response_selection_expression ⇒ String?

The route response selection expression for the route.

Returns:

  • (String, nil) 


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

def route_response_selection_expression()
  jsii_get_property("routeResponseSelectionExpression")
end

#route_response_selection_expression=(value) ⇒ Object 



326
327
328
329
 
# File 'api_gatewayv2/cfn_route.rb', line 326

def route_response_selection_expression=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "routeResponseSelectionExpression") unless value.nil?
  jsii_set_property("routeResponseSelectionExpression", 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.



614
615
616
 
# File 'api_gatewayv2/cfn_route.rb', line 614

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:



117
118
119
 
# File 'api_gatewayv2/cfn_route.rb', line 117

def stack()
  jsii_get_property("stack")
end

#target ⇒ String?

The target for the route.

Returns:

  • (String, nil) 


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

def target()
  jsii_get_property("target")
end

#target=(value) ⇒ Object 



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

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

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



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

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


164
165
166
 
# File 'api_gatewayv2/cfn_route.rb', line 164

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


174
175
176
 
# File 'api_gatewayv2/cfn_route.rb', line 174

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


620
621
622
623
 
# File 'api_gatewayv2/cfn_route.rb', line 620

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) 


359
360
361
362
363
364
 
# File 'api_gatewayv2/cfn_route.rb', line 359

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