public static final class IAlias.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements IAlias.Jsii$Default
IAlias.Jsii$Default, IAlias.Jsii$Proxy
Modifier | Constructor and Description |
---|---|
protected |
Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
void |
addEventSource(IEventSource source)
Adds an event source to this function.
|
EventSourceMapping |
addEventSourceMapping(java.lang.String id,
EventSourceMappingOptions options)
Adds an event source that maps to this AWS Lambda function.
|
FunctionUrl |
addFunctionUrl()
Adds a url to this lambda function.
|
FunctionUrl |
addFunctionUrl(FunctionUrlOptions options)
Adds a url to this lambda function.
|
void |
addPermission(java.lang.String id,
Permission permission)
Adds a permission to the Lambda resource policy.
|
void |
addToRolePolicy(PolicyStatement statement)
Adds a statement to the IAM role assumed by the instance.
|
void |
applyRemovalPolicy(RemovalPolicy policy)
Apply the given removal policy to this resource.
|
void |
configureAsyncInvoke(EventInvokeConfigOptions options)
Configures options for asynchronous invocation.
|
java.lang.String |
getAliasName()
Name of this alias.
|
Architecture |
getArchitecture()
The system architectures compatible with this lambda function.
|
Connections |
getConnections()
The network connections associated with this resource.
|
ResourceEnvironment |
getEnv()
The environment this resource belongs to.
|
java.lang.String |
getFunctionArn()
The ARN of the function.
|
java.lang.String |
getFunctionName()
The name of the function.
|
IPrincipal |
getGrantPrincipal()
The principal to grant permissions to.
|
java.lang.Boolean |
getIsBoundToVpc()
Whether or not this Lambda function was bound to a VPC.
|
IVersion |
getLatestVersion()
The `$LATEST` version of this function.
|
ConstructNode |
getNode()
The construct tree node for this construct.
|
ConstructNode |
getPermissionsNode()
The construct node where permissions are attached.
|
java.util.List<java.lang.String> |
getResourceArnsForGrantInvoke()
The ARN(s) to put into the resource field of the generated IAM policy for grantInvoke().
|
IRole |
getRole()
The IAM role associated with this function.
|
Stack |
getStack()
The stack in which this resource is defined.
|
IVersion |
getVersion()
The underlying Lambda function version.
|
Grant |
grantInvoke(IGrantable identity)
Grant the given identity permissions to invoke this Lambda.
|
Grant |
grantInvokeUrl(IGrantable identity)
Grant the given identity permissions to invoke this Lambda Function URL.
|
Metric |
metric(java.lang.String metricName)
Return the given named metric for this Lambda Return the given named metric for this Function.
|
Metric |
metric(java.lang.String metricName,
MetricOptions props)
Return the given named metric for this Lambda Return the given named metric for this Function.
|
Metric |
metricDuration()
Metric for the Duration of this Lambda How long execution of this Lambda takes.
|
Metric |
metricDuration(MetricOptions props)
Metric for the Duration of this Lambda How long execution of this Lambda takes.
|
Metric |
metricErrors()
How many invocations of this Lambda fail.
|
Metric |
metricErrors(MetricOptions props)
How many invocations of this Lambda fail.
|
Metric |
metricInvocations()
Metric for the number of invocations of this Lambda How often this Lambda is invoked.
|
Metric |
metricInvocations(MetricOptions props)
Metric for the number of invocations of this Lambda How often this Lambda is invoked.
|
Metric |
metricThrottles()
Metric for the number of throttled invocations of this Lambda How often this Lambda is throttled.
|
Metric |
metricThrottles(MetricOptions props)
Metric for the number of throttled invocations of this Lambda How often this Lambda is throttled.
|
public final ConstructNode getNode()
getNode
in interface IConstruct
getNode
in interface IConstruct.Jsii$Default
getNode
in interface IResource.Jsii$Default
getNode
in interface IAlias.Jsii$Default
getNode
in interface IFunction.Jsii$Default
public final ResourceEnvironment getEnv()
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
getEnv
in interface IResource
getEnv
in interface IResource.Jsii$Default
getEnv
in interface IAlias.Jsii$Default
getEnv
in interface IFunction.Jsii$Default
public final Stack getStack()
getStack
in interface IResource
getStack
in interface IResource.Jsii$Default
getStack
in interface IAlias.Jsii$Default
getStack
in interface IFunction.Jsii$Default
public final Connections getConnections()
getConnections
in interface IConnectable
getConnections
in interface IConnectable.Jsii$Default
getConnections
in interface IAlias.Jsii$Default
getConnections
in interface IFunction.Jsii$Default
public final IPrincipal getGrantPrincipal()
getGrantPrincipal
in interface IGrantable
getGrantPrincipal
in interface IGrantable.Jsii$Default
getGrantPrincipal
in interface IAlias.Jsii$Default
getGrantPrincipal
in interface IFunction.Jsii$Default
public final Architecture getArchitecture()
getArchitecture
in interface IAlias.Jsii$Default
getArchitecture
in interface IFunction
getArchitecture
in interface IFunction.Jsii$Default
public final java.lang.String getFunctionArn()
getFunctionArn
in interface IAlias.Jsii$Default
getFunctionArn
in interface IFunction
getFunctionArn
in interface IFunction.Jsii$Default
public final java.lang.String getFunctionName()
getFunctionName
in interface IAlias.Jsii$Default
getFunctionName
in interface IFunction
getFunctionName
in interface IFunction.Jsii$Default
public final java.lang.Boolean getIsBoundToVpc()
If this is is false
, trying to access the connections
object will fail.
getIsBoundToVpc
in interface IAlias.Jsii$Default
getIsBoundToVpc
in interface IFunction
getIsBoundToVpc
in interface IFunction.Jsii$Default
public final IVersion getLatestVersion()
Note that this is reference to a non-specific AWS Lambda version, which means the function this version refers to can return different results in different invocations.
To obtain a reference to an explicit version which references the current
function configuration, use lambdaFunction.currentVersion
instead.
getLatestVersion
in interface IAlias.Jsii$Default
getLatestVersion
in interface IFunction
getLatestVersion
in interface IFunction.Jsii$Default
public final ConstructNode getPermissionsNode()
getPermissionsNode
in interface IAlias.Jsii$Default
getPermissionsNode
in interface IFunction
getPermissionsNode
in interface IFunction.Jsii$Default
public final java.util.List<java.lang.String> getResourceArnsForGrantInvoke()
This property is for cdk modules to consume only. You should not need to use this property. Instead, use grantInvoke() directly.
getResourceArnsForGrantInvoke
in interface IAlias.Jsii$Default
getResourceArnsForGrantInvoke
in interface IFunction
getResourceArnsForGrantInvoke
in interface IFunction.Jsii$Default
public final IRole getRole()
getRole
in interface IAlias.Jsii$Default
getRole
in interface IFunction
getRole
in interface IFunction.Jsii$Default
public final java.lang.String getAliasName()
getAliasName
in interface IAlias
getAliasName
in interface IAlias.Jsii$Default
public final IVersion getVersion()
getVersion
in interface IAlias
getVersion
in interface IAlias.Jsii$Default
public final void applyRemovalPolicy(RemovalPolicy policy)
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
).
applyRemovalPolicy
in interface IResource
applyRemovalPolicy
in interface IResource.Jsii$Default
applyRemovalPolicy
in interface IAlias.Jsii$Default
applyRemovalPolicy
in interface IFunction.Jsii$Default
policy
- This parameter is required.public final void addEventSource(IEventSource source)
Event sources are implemented in the @aws-cdk/aws-lambda-event-sources module.
The following example adds an SQS Queue as an event source:
import { SqsEventSource } from '@aws-cdk/aws-lambda-event-sources'; myFunction.addEventSource(new SqsEventSource(myQueue));
addEventSource
in interface IAlias.Jsii$Default
addEventSource
in interface IFunction
addEventSource
in interface IFunction.Jsii$Default
source
- This parameter is required.public final EventSourceMapping addEventSourceMapping(java.lang.String id, EventSourceMappingOptions options)
addEventSourceMapping
in interface IAlias.Jsii$Default
addEventSourceMapping
in interface IFunction
addEventSourceMapping
in interface IFunction.Jsii$Default
id
- construct ID. This parameter is required.options
- mapping options. This parameter is required.public final FunctionUrl addFunctionUrl(FunctionUrlOptions options)
addFunctionUrl
in interface IAlias.Jsii$Default
addFunctionUrl
in interface IFunction
addFunctionUrl
in interface IFunction.Jsii$Default
options
- public final FunctionUrl addFunctionUrl()
addFunctionUrl
in interface IFunction
public final void addPermission(java.lang.String id, Permission permission)
addPermission
in interface IAlias.Jsii$Default
addPermission
in interface IFunction
addPermission
in interface IFunction.Jsii$Default
id
- The id for the permission construct. This parameter is required.permission
- The permission to grant to this Lambda function. This parameter is required.public final void addToRolePolicy(PolicyStatement statement)
addToRolePolicy
in interface IAlias.Jsii$Default
addToRolePolicy
in interface IFunction
addToRolePolicy
in interface IFunction.Jsii$Default
statement
- This parameter is required.public final void configureAsyncInvoke(EventInvokeConfigOptions options)
configureAsyncInvoke
in interface IAlias.Jsii$Default
configureAsyncInvoke
in interface IFunction
configureAsyncInvoke
in interface IFunction.Jsii$Default
options
- This parameter is required.public final Grant grantInvoke(IGrantable identity)
grantInvoke
in interface IAlias.Jsii$Default
grantInvoke
in interface IFunction
grantInvoke
in interface IFunction.Jsii$Default
identity
- This parameter is required.public final Grant grantInvokeUrl(IGrantable identity)
grantInvokeUrl
in interface IAlias.Jsii$Default
grantInvokeUrl
in interface IFunction
grantInvokeUrl
in interface IFunction.Jsii$Default
identity
- This parameter is required.public final Metric metric(java.lang.String metricName, MetricOptions props)
metric
in interface IAlias.Jsii$Default
metric
in interface IFunction
metric
in interface IFunction.Jsii$Default
metricName
- This parameter is required.props
- public final Metric metric(java.lang.String metricName)
public final Metric metricDuration(MetricOptions props)
Average over 5 minutes
Default: average over 5 minutes
metricDuration
in interface IAlias.Jsii$Default
metricDuration
in interface IFunction
metricDuration
in interface IFunction.Jsii$Default
props
- public final Metric metricDuration()
Average over 5 minutes
Default: average over 5 minutes
metricDuration
in interface IFunction
public final Metric metricErrors(MetricOptions props)
Sum over 5 minutes
metricErrors
in interface IAlias.Jsii$Default
metricErrors
in interface IFunction
metricErrors
in interface IFunction.Jsii$Default
props
- public final Metric metricErrors()
Sum over 5 minutes
metricErrors
in interface IFunction
public final Metric metricInvocations(MetricOptions props)
Sum over 5 minutes
Default: sum over 5 minutes
metricInvocations
in interface IAlias.Jsii$Default
metricInvocations
in interface IFunction
metricInvocations
in interface IFunction.Jsii$Default
props
- public final Metric metricInvocations()
Sum over 5 minutes
Default: sum over 5 minutes
metricInvocations
in interface IFunction
public final Metric metricThrottles(MetricOptions props)
Sum over 5 minutes
Default: sum over 5 minutes
metricThrottles
in interface IAlias.Jsii$Default
metricThrottles
in interface IFunction
metricThrottles
in interface IFunction.Jsii$Default
props
- public final Metric metricThrottles()
Sum over 5 minutes
Default: sum over 5 minutes
metricThrottles
in interface IFunction