Class IVersion.Jsii$Proxy
- All Implemented Interfaces:
IResource,IResource.Jsii$Default,IConnectable,IConnectable.Jsii$Default,IGrantable,IGrantable.Jsii$Default,IFunction,IFunction.Jsii$Default,IFunctionRef,IFunctionRef.Jsii$Default,IVersion,IVersion.Jsii$Default,IVersionRef,IVersionRef.Jsii$Default,software.amazon.jsii.JsiiSerializable,software.constructs.IConstruct,software.constructs.IConstruct.Jsii$Default,software.constructs.IDependable,software.constructs.IDependable.Jsii$Default
- Enclosing interface:
IVersion
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.amazon.awscdk.services.ec2.IConnectable
IConnectable.Jsii$Default, IConnectable.Jsii$ProxyNested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$ProxyNested classes/interfaces inherited from interface software.constructs.IDependable
software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.services.lambda.IFunction
IFunction.Jsii$Default, IFunction.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.services.lambda.IFunctionRef
IFunctionRef.Jsii$Default, IFunctionRef.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.services.iam.IGrantable
IGrantable.Jsii$Default, IGrantable.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.IResource
IResource.Jsii$Default, IResource.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.services.lambda.IVersion
IVersion.Jsii$Default, IVersion.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.services.lambda.IVersionRef
IVersionRef.Jsii$Default, IVersionRef.Jsii$Proxy -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal AliasDeprecated.final AliasaddAlias(String aliasName, AliasOptions options) Deprecated.CallingaddAliason aVersionobject will cause the Alias to be replaced on every function update.final voidaddEventSource(IEventSource source) Adds an event source to this function.final EventSourceMappingaddEventSourceMapping(String id, EventSourceMappingOptions options) Adds an event source that maps to this AWS Lambda function.final FunctionUrlAdds a url to this lambda function.final FunctionUrladdFunctionUrl(FunctionUrlOptions options) Adds a url to this lambda function.final voidaddPermission(String id, Permission permission) Adds a permission to the Lambda resource policy.final voidaddToRolePolicy(PolicyStatement statement) Adds a statement to the IAM role assumed by the instance.final voidapplyRemovalPolicy(RemovalPolicy policy) Apply the given removal policy to this resource.final voidConfigures options for asynchronous invocation.final ArchitectureThe system architectures compatible with this lambda function.final ConnectionsThe network connections associated with this resource.final StringThe ARN of the version for Lambda@Edge.final ResourceEnvironmentgetEnv()The environment this resource belongs to.final StringThe ARN of the function.final StringThe name of the function.final FunctionReference(experimental) A reference to a Function resource.final IPrincipalThe principal to grant permissions to.final BooleanWhether or not this Lambda function was bound to a VPC.final IFunctionThe underlying AWS Lambda function.final IVersionThe$LATESTversion of this function.final software.constructs.NodegetNode()The tree node.final software.constructs.NodeThe construct node where permissions are attached.The ARN(s) to put into the resource field of the generated IAM policy for grantInvoke().final IRolegetRole()The IAM role associated with this function.final StackgetStack()The stack in which this resource is defined.final StringThe most recently deployed version of this function.final VersionReference(experimental) A reference to a Version resource.final GrantgrantInvoke(IGrantable identity) Grant the given identity permissions to invoke this Lambda.grantInvokeCompositePrincipal(CompositePrincipal compositePrincipal) Grant multiple principals the ability to invoke this Lambda via CompositePrincipal.final GrantgrantInvokeLatestVersion(IGrantable identity) Grant the given identity permissions to invoke the $LATEST version or unqualified version of this Lambda.final GrantgrantInvokeUrl(IGrantable identity) Grant the given identity permissions to invoke this Lambda Function URL.final GrantgrantInvokeVersion(IGrantable identity, IVersion version) Grant the given identity permissions to invoke the given version of this Lambda.final MetricReturn the given named metric for this Lambda Return the given named metric for this Function.final Metricmetric(String metricName, MetricOptions props) Return the given named metric for this Lambda Return the given named metric for this Function.final MetricMetric for the Duration of this Lambda How long execution of this Lambda takes.final MetricmetricDuration(MetricOptions props) Metric for the Duration of this Lambda How long execution of this Lambda takes.final MetricHow many invocations of this Lambda fail.final MetricmetricErrors(MetricOptions props) How many invocations of this Lambda fail.final MetricMetric for the number of invocations of this Lambda How often this Lambda is invoked.final MetricmetricInvocations(MetricOptions props) Metric for the number of invocations of this Lambda How often this Lambda is invoked.final MetricMetric for the number of throttled invocations of this Lambda How often this Lambda is throttled.final MetricmetricThrottles(MetricOptions props) Metric for the number of throttled invocations of this Lambda How often this Lambda is throttled.Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Constructor Details
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
-
-
Method Details
-
getNode
@Stability(Stable) @NotNull public final software.constructs.Node getNode()The tree node.- Specified by:
getNodein interfacesoftware.constructs.IConstruct- Specified by:
getNodein interfacesoftware.constructs.IConstruct.Jsii$Default- Specified by:
getNodein interfaceIFunction- Specified by:
getNodein interfaceIFunction.Jsii$Default- Specified by:
getNodein interfaceIFunctionRef.Jsii$Default- Specified by:
getNodein interfaceIResource.Jsii$Default- Specified by:
getNodein interfaceIVersion- Specified by:
getNodein interfaceIVersion.Jsii$Default- Specified by:
getNodein interfaceIVersionRef.Jsii$Default
-
getEnv
The environment this resource belongs to.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.
- Specified by:
getEnvin interfaceIFunction.Jsii$Default- Specified by:
getEnvin interfaceIResource- Specified by:
getEnvin interfaceIResource.Jsii$Default- Specified by:
getEnvin interfaceIVersion.Jsii$Default
-
getStack
The stack in which this resource is defined.- Specified by:
getStackin interfaceIFunction.Jsii$Default- Specified by:
getStackin interfaceIResource- Specified by:
getStackin interfaceIResource.Jsii$Default- Specified by:
getStackin interfaceIVersion.Jsii$Default
-
getConnections
The network connections associated with this resource.- Specified by:
getConnectionsin interfaceIConnectable- Specified by:
getConnectionsin interfaceIConnectable.Jsii$Default- Specified by:
getConnectionsin interfaceIFunction.Jsii$Default- Specified by:
getConnectionsin interfaceIVersion.Jsii$Default
-
getGrantPrincipal
The principal to grant permissions to.- Specified by:
getGrantPrincipalin interfaceIFunction.Jsii$Default- Specified by:
getGrantPrincipalin interfaceIGrantable- Specified by:
getGrantPrincipalin interfaceIGrantable.Jsii$Default- Specified by:
getGrantPrincipalin interfaceIVersion.Jsii$Default
-
getFunctionRef
(experimental) A reference to a Function resource.- Specified by:
getFunctionRefin interfaceIFunction.Jsii$Default- Specified by:
getFunctionRefin interfaceIFunctionRef- Specified by:
getFunctionRefin interfaceIFunctionRef.Jsii$Default- Specified by:
getFunctionRefin interfaceIVersion.Jsii$Default
-
getArchitecture
The system architectures compatible with this lambda function.- Specified by:
getArchitecturein interfaceIFunction- Specified by:
getArchitecturein interfaceIFunction.Jsii$Default- Specified by:
getArchitecturein interfaceIVersion.Jsii$Default
-
getFunctionArn
The ARN of the function.- Specified by:
getFunctionArnin interfaceIFunction- Specified by:
getFunctionArnin interfaceIFunction.Jsii$Default- Specified by:
getFunctionArnin interfaceIVersion.Jsii$Default
-
getFunctionName
The name of the function.- Specified by:
getFunctionNamein interfaceIFunction- Specified by:
getFunctionNamein interfaceIFunction.Jsii$Default- Specified by:
getFunctionNamein interfaceIVersion.Jsii$Default
-
getIsBoundToVpc
Whether or not this Lambda function was bound to a VPC.If this is is
false, trying to access theconnectionsobject will fail.- Specified by:
getIsBoundToVpcin interfaceIFunction- Specified by:
getIsBoundToVpcin interfaceIFunction.Jsii$Default- Specified by:
getIsBoundToVpcin interfaceIVersion.Jsii$Default
-
getLatestVersion
The$LATESTversion of this function.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.currentVersioninstead.- Specified by:
getLatestVersionin interfaceIFunction- Specified by:
getLatestVersionin interfaceIFunction.Jsii$Default- Specified by:
getLatestVersionin interfaceIVersion.Jsii$Default
-
getPermissionsNode
@Stability(Stable) @NotNull public final software.constructs.Node getPermissionsNode()The construct node where permissions are attached.- Specified by:
getPermissionsNodein interfaceIFunction- Specified by:
getPermissionsNodein interfaceIFunction.Jsii$Default- Specified by:
getPermissionsNodein interfaceIVersion.Jsii$Default
-
getResourceArnsForGrantInvoke
The ARN(s) to put into the resource field of the generated IAM policy for grantInvoke().This property is for cdk modules to consume only. You should not need to use this property. Instead, use grantInvoke() directly.
- Specified by:
getResourceArnsForGrantInvokein interfaceIFunction- Specified by:
getResourceArnsForGrantInvokein interfaceIFunction.Jsii$Default- Specified by:
getResourceArnsForGrantInvokein interfaceIVersion.Jsii$Default
-
getRole
The IAM role associated with this function.- Specified by:
getRolein interfaceIFunction- Specified by:
getRolein interfaceIFunction.Jsii$Default- Specified by:
getRolein interfaceIVersion.Jsii$Default
-
getVersionRef
(experimental) A reference to a Version resource.- Specified by:
getVersionRefin interfaceIVersion.Jsii$Default- Specified by:
getVersionRefin interfaceIVersionRef- Specified by:
getVersionRefin interfaceIVersionRef.Jsii$Default
-
getEdgeArn
The ARN of the version for Lambda@Edge.- Specified by:
getEdgeArnin interfaceIVersion- Specified by:
getEdgeArnin interfaceIVersion.Jsii$Default
-
getLambda
The underlying AWS Lambda function.- Specified by:
getLambdain interfaceIVersion- Specified by:
getLambdain interfaceIVersion.Jsii$Default
-
getVersion
The most recently deployed version of this function.- Specified by:
getVersionin interfaceIVersion- Specified by:
getVersionin interfaceIVersion.Jsii$Default
-
applyRemovalPolicy
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).- Specified by:
applyRemovalPolicyin interfaceIFunction.Jsii$Default- Specified by:
applyRemovalPolicyin interfaceIResource- Specified by:
applyRemovalPolicyin interfaceIResource.Jsii$Default- Specified by:
applyRemovalPolicyin interfaceIVersion.Jsii$Default- Parameters:
policy- This parameter is required.
-
addEventSource
Adds an event source to this function.Event sources are implemented in the aws-cdk-lib/aws-lambda-event-sources module.
The following example adds an SQS Queue as an event source:
import { SqsEventSource } from 'aws-cdk-lib/aws-lambda-event-sources'; myFunction.addEventSource(new SqsEventSource(myQueue));- Specified by:
addEventSourcein interfaceIFunction- Specified by:
addEventSourcein interfaceIFunction.Jsii$Default- Specified by:
addEventSourcein interfaceIVersion.Jsii$Default- Parameters:
source- This parameter is required.
-
addEventSourceMapping
@Stability(Stable) @NotNull public final EventSourceMapping addEventSourceMapping(@NotNull String id, @NotNull EventSourceMappingOptions options) Adds an event source that maps to this AWS Lambda function.- Specified by:
addEventSourceMappingin interfaceIFunction- Specified by:
addEventSourceMappingin interfaceIFunction.Jsii$Default- Specified by:
addEventSourceMappingin interfaceIVersion.Jsii$Default- Parameters:
id- construct ID. This parameter is required.options- mapping options. This parameter is required.
-
addFunctionUrl
@Stability(Stable) @NotNull public final FunctionUrl addFunctionUrl(@Nullable FunctionUrlOptions options) Adds a url to this lambda function.- Specified by:
addFunctionUrlin interfaceIFunction- Specified by:
addFunctionUrlin interfaceIFunction.Jsii$Default- Specified by:
addFunctionUrlin interfaceIVersion.Jsii$Default- Parameters:
options-
-
addFunctionUrl
Adds a url to this lambda function.- Specified by:
addFunctionUrlin interfaceIFunction
-
addPermission
@Stability(Stable) public final void addPermission(@NotNull String id, @NotNull Permission permission) Adds a permission to the Lambda resource policy.- Specified by:
addPermissionin interfaceIFunction- Specified by:
addPermissionin interfaceIFunction.Jsii$Default- Specified by:
addPermissionin interfaceIVersion.Jsii$Default- Parameters:
id- The id for the permission construct. This parameter is required.permission- The permission to grant to this Lambda function. This parameter is required.- See Also:
-
addToRolePolicy
Adds a statement to the IAM role assumed by the instance.- Specified by:
addToRolePolicyin interfaceIFunction- Specified by:
addToRolePolicyin interfaceIFunction.Jsii$Default- Specified by:
addToRolePolicyin interfaceIVersion.Jsii$Default- Parameters:
statement- This parameter is required.
-
configureAsyncInvoke
@Stability(Stable) public final void configureAsyncInvoke(@NotNull EventInvokeConfigOptions options) Configures options for asynchronous invocation.- Specified by:
configureAsyncInvokein interfaceIFunction- Specified by:
configureAsyncInvokein interfaceIFunction.Jsii$Default- Specified by:
configureAsyncInvokein interfaceIVersion.Jsii$Default- Parameters:
options- This parameter is required.
-
grantInvoke
Grant the given identity permissions to invoke this Lambda.- Specified by:
grantInvokein interfaceIFunction- Specified by:
grantInvokein interfaceIFunction.Jsii$Default- Specified by:
grantInvokein interfaceIVersion.Jsii$Default- Parameters:
identity- This parameter is required.
-
grantInvokeCompositePrincipal
@Stability(Stable) @NotNull public final List<Grant> grantInvokeCompositePrincipal(@NotNull CompositePrincipal compositePrincipal) Grant multiple principals the ability to invoke this Lambda via CompositePrincipal.- Specified by:
grantInvokeCompositePrincipalin interfaceIFunction- Specified by:
grantInvokeCompositePrincipalin interfaceIFunction.Jsii$Default- Specified by:
grantInvokeCompositePrincipalin interfaceIVersion.Jsii$Default- Parameters:
compositePrincipal- This parameter is required.
-
grantInvokeLatestVersion
@Stability(Stable) @NotNull public final Grant grantInvokeLatestVersion(@NotNull IGrantable identity) Grant the given identity permissions to invoke the $LATEST version or unqualified version of this Lambda.- Specified by:
grantInvokeLatestVersionin interfaceIFunction- Specified by:
grantInvokeLatestVersionin interfaceIFunction.Jsii$Default- Specified by:
grantInvokeLatestVersionin interfaceIVersion.Jsii$Default- Parameters:
identity- This parameter is required.
-
grantInvokeUrl
Grant the given identity permissions to invoke this Lambda Function URL.- Specified by:
grantInvokeUrlin interfaceIFunction- Specified by:
grantInvokeUrlin interfaceIFunction.Jsii$Default- Specified by:
grantInvokeUrlin interfaceIVersion.Jsii$Default- Parameters:
identity- This parameter is required.
-
grantInvokeVersion
@Stability(Stable) @NotNull public final Grant grantInvokeVersion(@NotNull IGrantable identity, @NotNull IVersion version) Grant the given identity permissions to invoke the given version of this Lambda.- Specified by:
grantInvokeVersionin interfaceIFunction- Specified by:
grantInvokeVersionin interfaceIFunction.Jsii$Default- Specified by:
grantInvokeVersionin interfaceIVersion.Jsii$Default- Parameters:
identity- This parameter is required.version- This parameter is required.
-
metric
@Stability(Stable) @NotNull public final Metric metric(@NotNull String metricName, @Nullable MetricOptions props) Return the given named metric for this Lambda Return the given named metric for this Function.- Specified by:
metricin interfaceIFunction- Specified by:
metricin interfaceIFunction.Jsii$Default- Specified by:
metricin interfaceIVersion.Jsii$Default- Parameters:
metricName- This parameter is required.props-
-
metric
Return the given named metric for this Lambda Return the given named metric for this Function. -
metricDuration
Metric for the Duration of this Lambda How long execution of this Lambda takes.Average over 5 minutes
Default: average over 5 minutes
- Specified by:
metricDurationin interfaceIFunction- Specified by:
metricDurationin interfaceIFunction.Jsii$Default- Specified by:
metricDurationin interfaceIVersion.Jsii$Default- Parameters:
props-
-
metricDuration
Metric for the Duration of this Lambda How long execution of this Lambda takes.Average over 5 minutes
Default: average over 5 minutes
- Specified by:
metricDurationin interfaceIFunction
-
metricErrors
How many invocations of this Lambda fail.Sum over 5 minutes
- Specified by:
metricErrorsin interfaceIFunction- Specified by:
metricErrorsin interfaceIFunction.Jsii$Default- Specified by:
metricErrorsin interfaceIVersion.Jsii$Default- Parameters:
props-
-
metricErrors
How many invocations of this Lambda fail.Sum over 5 minutes
- Specified by:
metricErrorsin interfaceIFunction
-
metricInvocations
Metric for the number of invocations of this Lambda How often this Lambda is invoked.Sum over 5 minutes
Default: sum over 5 minutes
- Specified by:
metricInvocationsin interfaceIFunction- Specified by:
metricInvocationsin interfaceIFunction.Jsii$Default- Specified by:
metricInvocationsin interfaceIVersion.Jsii$Default- Parameters:
props-
-
metricInvocations
Metric for the number of invocations of this Lambda How often this Lambda is invoked.Sum over 5 minutes
Default: sum over 5 minutes
- Specified by:
metricInvocationsin interfaceIFunction
-
metricThrottles
Metric for the number of throttled invocations of this Lambda How often this Lambda is throttled.Sum over 5 minutes
Default: sum over 5 minutes
- Specified by:
metricThrottlesin interfaceIFunction- Specified by:
metricThrottlesin interfaceIFunction.Jsii$Default- Specified by:
metricThrottlesin interfaceIVersion.Jsii$Default- Parameters:
props-
-
metricThrottles
Metric for the number of throttled invocations of this Lambda How often this Lambda is throttled.Sum over 5 minutes
Default: sum over 5 minutes
- Specified by:
metricThrottlesin interfaceIFunction
-
addAlias
@Stability(Deprecated) @Deprecated @NotNull public final Alias addAlias(@NotNull String aliasName, @Nullable AliasOptions options) Deprecated.CallingaddAliason aVersionobject will cause the Alias to be replaced on every function update. Callfunction.addAlias()ornew Alias()instead.(deprecated) Defines an alias for this version.- Specified by:
addAliasin interfaceIVersion- Specified by:
addAliasin interfaceIVersion.Jsii$Default- Parameters:
aliasName- The name of the alias. This parameter is required.options- Alias options.
-
addAlias
Deprecated.CallingaddAliason aVersionobject will cause the Alias to be replaced on every function update. Callfunction.addAlias()ornew Alias()instead.(deprecated) Defines an alias for this version.
-
addAliason aVersionobject will cause the Alias to be replaced on every function update.