Module: AWSCDK::APIGatewayv2::IHttpRoute

Includes:
IRoute
Included in:
HttpRoute
Defined in:
api_gatewayv2/i_http_route.rb

Overview

Represents a Route for an HTTP API.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'api_gatewayv2/i_http_route.rb', line 118

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :route_ref => { kind: :property, name: "routeRef", is_optional: false },
    :route_id => { kind: :property, name: "routeId", is_optional: false },
    :http_api => { kind: :property, name: "httpApi", is_optional: false },
    :route_arn => { kind: :property, name: "routeArn", is_optional: false },
    :path => { kind: :property, name: "path", is_optional: true },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :grant_invoke => { kind: :method, name: "grantInvoke", is_optional: false },
  }
end

Instance Method Details

#apply_removal_policy(policy) ⇒ void

This method returns an undefined value.

Apply the given removal policy to this resource.

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

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

Parameters:



98
99
100
101
 
# File 'api_gatewayv2/i_http_route.rb', line 98

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

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

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

Returns:



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

def env()
  jsii_get_property("env")
end

#grant_invoke(grantee, options = nil) ⇒ AWSCDK::IAM::Grant

Grant access to invoke the route.

This method requires that the authorizer of the route is undefined or is an HttpIamAuthorizer.

Parameters:

Returns:



111
112
113
114
115
116
 
# File 'api_gatewayv2/i_http_route.rb', line 111

def grant_invoke(grantee, options = nil)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  options = options.is_a?(Hash) ? ::AWSCDK::APIGatewayv2::GrantInvokeOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheXYyLkdyYW50SW52b2tlT3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("grantInvoke", [grantee, options])
end

#http_api ⇒ AWSCDK::APIGatewayv2::IHttpAPI

The HTTP API associated with this route.

Returns:



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

def http_api()
  jsii_get_property("httpApi")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


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

def node()
  jsii_get_property("node")
end

#path ⇒ String?

Returns the path component of this HTTP route, undefined if the path is the catch-all route.

Returns:

  • (String, nil) 


68
69
70
 
# File 'api_gatewayv2/i_http_route.rb', line 68

def path()
  jsii_get_property("path")
end

#route_arn ⇒ String

Returns the arn of the route.

Returns:

  • (String) 


61
62
63
 
# File 'api_gatewayv2/i_http_route.rb', line 61

def route_arn()
  jsii_get_property("routeArn")
end

#route_id ⇒ String

Id of the Route.

Returns:

  • (String) 


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

def route_id()
  jsii_get_property("routeId")
end

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

A reference to a Route resource.

Returns:



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

def route_ref()
  jsii_get_property("routeRef")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



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

def stack()
  jsii_get_property("stack")
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

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

Parameters:

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

    The mixins to apply.

Returns:

  • (Constructs::IConstruct) —

    This construct for chaining



79
80
81
82
83
84
 
# File 'api_gatewayv2/i_http_route.rb', line 79

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