Module: AWSCDK::Lambda::IFunctionURL

Includes:
IResource, Interfaces::AWSLambda::IURLRef
Included in:
FunctionURL
Defined in:
lambda/i_function_url.rb

Overview

A Lambda function Url.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lambda/i_function_url.rb', line 106

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 },
    :url_ref => { kind: :property, name: "urlRef", is_optional: false },
    :auth_type => { kind: :property, name: "authType", is_optional: false },
    :function_arn => { kind: :property, name: "functionArn", is_optional: false },
    :url => { kind: :property, name: "url", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :grant_invoke_url => { kind: :method, name: "grantInvokeUrl", 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:



92
93
94
95
 
# File 'lambda/i_function_url.rb', line 92

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

#auth_type ⇒ AWSCDK::Lambda::FunctionURLAuthType

The authType of the function URL, used for access control.

Returns:



48
49
50
 
# File 'lambda/i_function_url.rb', line 48

def auth_type()
  jsii_get_property("authType")
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:



27
28
29
 
# File 'lambda/i_function_url.rb', line 27

def env()
  jsii_get_property("env")
end

#function_arn ⇒ String

The ARN of the function this URL refers to.

Returns:

  • (String) 


55
56
57
 
# File 'lambda/i_function_url.rb', line 55

def function_arn()
  jsii_get_property("functionArn")
end

#grant_invoke_url(identity) ⇒ AWSCDK::IAM::Grant

Grant the given identity permissions to invoke this Lambda Function URL.

Parameters:

Returns:



101
102
103
104
 
# File 'lambda/i_function_url.rb', line 101

def grant_invoke_url(identity)
  Jsii::Type.check_type(identity, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "identity")
  jsii_call_method("grantInvokeUrl", [identity])
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


12
13
14
 
# File 'lambda/i_function_url.rb', line 12

def node()
  jsii_get_property("node")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



34
35
36
 
# File 'lambda/i_function_url.rb', line 34

def stack()
  jsii_get_property("stack")
end

#url ⇒ String

The url of the Lambda function.

Returns:

  • (String) 


62
63
64
 
# File 'lambda/i_function_url.rb', line 62

def url()
  jsii_get_property("url")
end

#url_ref ⇒ AWSCDK::Interfaces::AWSLambda::URLReference

A reference to a Url resource.

Returns:



41
42
43
 
# File 'lambda/i_function_url.rb', line 41

def url_ref()
  jsii_get_property("urlRef")
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



73
74
75
76
77
78
 
# File 'lambda/i_function_url.rb', line 73

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