Class IAlias.Jsii$Proxy
- All Implemented Interfaces:
IConstruct,IConstruct.Jsii$Default,IDependable,IDependable.Jsii$Default,IResource,IResource.Jsii$Default,IConnectable,IConnectable.Jsii$Default,IGrantable,IGrantable.Jsii$Default,IAlias,IAlias.Jsii$Default,IFunction,IFunction.Jsii$Default,software.amazon.jsii.JsiiSerializable,software.constructs.IConstruct,software.constructs.IConstruct.Jsii$Default
- Enclosing interface:
- IAlias
-
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.lambda.IAlias
IAlias.Jsii$Default, IAlias.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.services.ec2.IConnectable
IConnectable.Jsii$Default, IConnectable.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default, IConstruct.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.amazon.awscdk.core.IDependable
IDependable.Jsii$Default, 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.iam.IGrantable
IGrantable.Jsii$Default, IGrantable.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.core.IResource
IResource.Jsii$Default, IResource.Jsii$Proxy -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal 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 StringName of this alias.final ArchitectureThe system architectures compatible with this lambda function.final ConnectionsThe network connections associated with this resource.final ResourceEnvironmentgetEnv()The environment this resource belongs to.final StringThe ARN of the function.final StringThe name of the function.final IPrincipalThe principal to grant permissions to.final BooleanWhether or not this Lambda function was bound to a VPC.final IVersionThe$LATESTversion of this function.final ConstructNodegetNode()The construct tree node for this construct.final ConstructNodeThe 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 IVersionThe underlying Lambda function version.final GrantgrantInvoke(IGrantable identity) Grant the given identity permissions to invoke this Lambda.final GrantgrantInvokeUrl(IGrantable identity) Grant the given identity permissions to invoke this Lambda Function URL.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
The construct tree node for this construct.- Specified by:
getNodein interfaceIAlias.Jsii$Default- Specified by:
getNodein interfaceIConstruct- Specified by:
getNodein interfaceIConstruct.Jsii$Default- Specified by:
getNodein interfaceIFunction.Jsii$Default- Specified by:
getNodein interfaceIResource.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 interfaceIAlias.Jsii$Default- Specified by:
getEnvin interfaceIFunction.Jsii$Default- Specified by:
getEnvin interfaceIResource- Specified by:
getEnvin interfaceIResource.Jsii$Default
-
getStack
The stack in which this resource is defined.- Specified by:
getStackin interfaceIAlias.Jsii$Default- Specified by:
getStackin interfaceIFunction.Jsii$Default- Specified by:
getStackin interfaceIResource- Specified by:
getStackin interfaceIResource.Jsii$Default
-
getConnections
The network connections associated with this resource.- Specified by:
getConnectionsin interfaceIAlias.Jsii$Default- Specified by:
getConnectionsin interfaceIConnectable- Specified by:
getConnectionsin interfaceIConnectable.Jsii$Default- Specified by:
getConnectionsin interfaceIFunction.Jsii$Default
-
getGrantPrincipal
The principal to grant permissions to.- Specified by:
getGrantPrincipalin interfaceIAlias.Jsii$Default- Specified by:
getGrantPrincipalin interfaceIFunction.Jsii$Default- Specified by:
getGrantPrincipalin interfaceIGrantable- Specified by:
getGrantPrincipalin interfaceIGrantable.Jsii$Default
-
getArchitecture
The system architectures compatible with this lambda function.- Specified by:
getArchitecturein interfaceIAlias.Jsii$Default- Specified by:
getArchitecturein interfaceIFunction- Specified by:
getArchitecturein interfaceIFunction.Jsii$Default
-
getFunctionArn
The ARN of the function.- Specified by:
getFunctionArnin interfaceIAlias.Jsii$Default- Specified by:
getFunctionArnin interfaceIFunction- Specified by:
getFunctionArnin interfaceIFunction.Jsii$Default
-
getFunctionName
The name of the function.- Specified by:
getFunctionNamein interfaceIAlias.Jsii$Default- Specified by:
getFunctionNamein interfaceIFunction- Specified by:
getFunctionNamein interfaceIFunction.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 interfaceIAlias.Jsii$Default- Specified by:
getIsBoundToVpcin interfaceIFunction- Specified by:
getIsBoundToVpcin interfaceIFunction.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 interfaceIAlias.Jsii$Default- Specified by:
getLatestVersionin interfaceIFunction- Specified by:
getLatestVersionin interfaceIFunction.Jsii$Default
-
getPermissionsNode
The construct node where permissions are attached.- Specified by:
getPermissionsNodein interfaceIAlias.Jsii$Default- Specified by:
getPermissionsNodein interfaceIFunction- Specified by:
getPermissionsNodein interfaceIFunction.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 interfaceIAlias.Jsii$Default- Specified by:
getResourceArnsForGrantInvokein interfaceIFunction- Specified by:
getResourceArnsForGrantInvokein interfaceIFunction.Jsii$Default
-
getRole
The IAM role associated with this function.- Specified by:
getRolein interfaceIAlias.Jsii$Default- Specified by:
getRolein interfaceIFunction- Specified by:
getRolein interfaceIFunction.Jsii$Default
-
getAliasName
Name of this alias.- Specified by:
getAliasNamein interfaceIAlias- Specified by:
getAliasNamein interfaceIAlias.Jsii$Default
-
getVersion
The underlying Lambda function version.- Specified by:
getVersionin interfaceIAlias- Specified by:
getVersionin interfaceIAlias.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 interfaceIAlias.Jsii$Default- Specified by:
applyRemovalPolicyin interfaceIFunction.Jsii$Default- Specified by:
applyRemovalPolicyin interfaceIResource- Specified by:
applyRemovalPolicyin interfaceIResource.Jsii$Default- Parameters:
policy- This parameter is required.
-
addEventSource
Adds an event source to this function.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));- Specified by:
addEventSourcein interfaceIAlias.Jsii$Default- Specified by:
addEventSourcein interfaceIFunction- Specified by:
addEventSourcein interfaceIFunction.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 interfaceIAlias.Jsii$Default- Specified by:
addEventSourceMappingin interfaceIFunction- Specified by:
addEventSourceMappingin interfaceIFunction.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 interfaceIAlias.Jsii$Default- Specified by:
addFunctionUrlin interfaceIFunction- Specified by:
addFunctionUrlin interfaceIFunction.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 interfaceIAlias.Jsii$Default- Specified by:
addPermissionin interfaceIFunction- Specified by:
addPermissionin interfaceIFunction.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 interfaceIAlias.Jsii$Default- Specified by:
addToRolePolicyin interfaceIFunction- Specified by:
addToRolePolicyin interfaceIFunction.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 interfaceIAlias.Jsii$Default- Specified by:
configureAsyncInvokein interfaceIFunction- Specified by:
configureAsyncInvokein interfaceIFunction.Jsii$Default- Parameters:
options- This parameter is required.
-
grantInvoke
Grant the given identity permissions to invoke this Lambda.- Specified by:
grantInvokein interfaceIAlias.Jsii$Default- Specified by:
grantInvokein interfaceIFunction- Specified by:
grantInvokein interfaceIFunction.Jsii$Default- Parameters:
identity- This parameter is required.
-
grantInvokeUrl
Grant the given identity permissions to invoke this Lambda Function URL.- Specified by:
grantInvokeUrlin interfaceIAlias.Jsii$Default- Specified by:
grantInvokeUrlin interfaceIFunction- Specified by:
grantInvokeUrlin interfaceIFunction.Jsii$Default- Parameters:
identity- 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 interfaceIAlias.Jsii$Default- Specified by:
metricin interfaceIFunction- Specified by:
metricin interfaceIFunction.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 interfaceIAlias.Jsii$Default- Specified by:
metricDurationin interfaceIFunction- Specified by:
metricDurationin interfaceIFunction.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 interfaceIAlias.Jsii$Default- Specified by:
metricErrorsin interfaceIFunction- Specified by:
metricErrorsin interfaceIFunction.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 interfaceIAlias.Jsii$Default- Specified by:
metricInvocationsin interfaceIFunction- Specified by:
metricInvocationsin interfaceIFunction.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 interfaceIAlias.Jsii$Default- Specified by:
metricThrottlesin interfaceIFunction- Specified by:
metricThrottlesin interfaceIFunction.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
-