AWS CDK Reference

Appearance

v2.274.0

Experimental

@aws-cdk/integ-tests-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

LambdaInvokeFunction ​

An AWS Lambda Invoke function API call.

Use this instead of the generic AwsApiCall in order to invoke a lambda function. This will automatically create the correct permissions to invoke the function

Stability
Experimental
Source
lib/assertions/sdk.ts

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as integ_tests_alpha from '@aws-cdk/integ-tests-alpha';
import { aws_logs as logs } from 'aws-cdk-lib';
const lambdaInvokeFunction = new integ_tests_alpha.LambdaInvokeFunction(this, 'MyLambdaInvokeFunction', {
  functionName: 'functionName',

  // the properties below are optional
  invocationType: integ_tests_alpha.InvocationType.EVENT,
  logRetention: logs.RetentionDays.ONE_DAY,
  logType: integ_tests_alpha.LogType.NONE,
  payload: 'payload',
});
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.integ_tests_alpha as integ_tests_alpha
from aws_cdk import aws_logs as logs

lambda_invoke_function = integ_tests_alpha.LambdaInvokeFunction(self, "MyLambdaInvokeFunction",
    function_name="functionName",

    # the properties below are optional
    invocation_type=integ_tests_alpha.InvocationType.EVENT,
    log_retention=logs.RetentionDays.ONE_DAY,
    log_type=integ_tests_alpha.LogType.NONE,
    payload="payload"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.integtests.alpha.*;
import software.amazon.awscdk.services.logs.*;

LambdaInvokeFunction lambdaInvokeFunction = LambdaInvokeFunction.Builder.create(this, "MyLambdaInvokeFunction")
        .functionName("functionName")

        // the properties below are optional
        .invocationType(InvocationType.EVENT)
        .logRetention(RetentionDays.ONE_DAY)
        .logType(LogType.NONE)
        .payload("payload")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.IntegTests.Alpha
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.IntegTests.Alpha;
using Amazon.CDK.AWS.Logs;

var lambdaInvokeFunction = new LambdaInvokeFunction(this, "MyLambdaInvokeFunction", new LambdaInvokeFunctionProps {
    FunctionName = "functionName",

    // the properties below are optional
    InvocationType = InvocationType.EVENT,
    LogRetention = RetentionDays.ONE_DAY,
    LogType = LogType.NONE,
    Payload = "payload"
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdkintegtestsalpha/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdkintegtestsalpha"
import "github.com/aws/aws-cdk-go/awscdk"

lambdaInvokeFunction := integ_tests_alpha.NewLambdaInvokeFunction(this, jsii.String("MyLambdaInvokeFunction"), &LambdaInvokeFunctionProps{
	FunctionName: jsii.String("functionName"),

	// the properties below are optional
	InvocationType: integ_tests_alpha.InvocationType_EVENT,
	LogRetention: awscdk.Aws_logs.RetentionDays_ONE_DAY,
	LogType: integ_tests_alpha.LogType_NONE,
	Payload: jsii.String("payload"),
})

Initializer ​

ts
new LambdaInvokeFunction(scope: Construct, id: string, props: LambdaInvokeFunctionProps)
python
LambdaInvokeFunction(scope: Construct, id: str, props: LambdaInvokeFunctionProps)
java
new LambdaInvokeFunction(Construct scope, String id, LambdaInvokeFunctionProps props)
csharp
new LambdaInvokeFunction(Construct scope, string id, LambdaInvokeFunctionProps props)
go
NewLambdaInvokeFunction(Scope Construct, Id *string, Props LambdaInvokeFunctionProps)

Construct Props ​

functionNamestringfunction_namestrfunctionNameStringFunctionNamestringFunctionName*stringrequired#
The name of the function to invoke.
invocationTypeInvocationTypeinvocation_typeInvocationTypeinvocationTypeInvocationTypeInvocationTypeInvocationTypeInvocationTypeInvocationType= InvocationType.REQUEST_RESPONSE#
The type of invocation to use.
logRetentionRetentionDayslog_retentionRetentionDayslogRetentionRetentionDaysLogRetentionRetentionDaysLogRetentionRetentionDays#
How long, in days, the log contents will be retained.

Default: no retention days specified

logTypeLogTypelog_typeLogTypelogTypeLogTypeLogTypeLogTypeLogTypeLogType= LogType.NONE#
Whether to return the logs as part of the response.
payloadstringpayloadstrpayloadStringPayloadstringPayload*string#
Payload to send as part of the invoke.

Default: no payload

Properties ​

nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#
The tree node.
providerAssertionsProviderproviderAssertionsProviderproviderAssertionsProviderProviderAssertionsProviderProviderAssertionsProviderrequired#
access the AssertionsProvider.

This can be used to add additional IAM policies the provider role policy

waiterProviderAssertionsProviderwaiter_providerAssertionsProviderwaiterProviderAssertionsProviderWaiterProviderAssertionsProviderWaiterProviderAssertionsProvider#
access the AssertionsProvider for the waiter state machine.

This can be used to add additional IAM policies the provider role policy

example
ts
declare const apiCall: AwsApiCall;
apiCall.waiterProvider?.addToRolePolicy({
  Effect: 'Allow',
  Action: ['s3:GetObject'],
  Resource: ['*'],
});

Methods ​

assertAtPath(path: string, expected: ExpectedResult): IApiCalldef assert_at_path(self, path: str, expected: ExpectedResult) -> IApiCallpublic IApiCall assertAtPath(String path, ExpectedResult expected)public IApiCall AssertAtPath(string path, ExpectedResult expected)func AssertAtPath(Path *string, Expected ExpectedResult) IApiCall#
Assert that the ExpectedResult is equal to the result of the AwsApiCall at the given path.

Providing a path will filter the output of the initial API call.

For example the SQS.receiveMessage api response would look like:

If you wanted to assert the value of Body you could do

expect(expected: ExpectedResult): IApiCalldef expect(self, expected: ExpectedResult) -> IApiCallpublic IApiCall expect(ExpectedResult expected)public IApiCall Expect(ExpectedResult expected)func Expect(Expected ExpectedResult) IApiCall#
Assert that the ExpectedResult is equal to the result of the AwsApiCall.
getAtt(attributeName: string): Referencedef get_att(self, attribute_name: str) -> Referencepublic Reference getAtt(String attributeName)public Reference GetAtt(string attributeName)func GetAtt(AttributeName *string) Reference#
Returns the value of an attribute of the custom resource of an arbitrary type.

Attributes are returned from the custom resource provider through the Data map where the key is the attribute name.

getAttString(attributeName: string): stringdef get_att_string(self, attribute_name: str) -> strpublic String getAttString(String attributeName)public string GetAttString(string attributeName)func GetAttString(AttributeName *string) *string#
Returns the value of an attribute of the custom resource of type string.

Attributes are returned from the custom resource provider through the Data map where the key is the attribute name.

isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#
Checks if `x` is a construct.
notes · 1 parameter · returns

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

  • xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#
Returns a string representation of this construct.
waitForAssertions(options?: WaiterStateMachineOptions): IApiCalldef wait_for_assertions(self, options: typing.Optional[WaiterStateMachineOptions] = None) -> IApiCallpublic IApiCall waitForAssertions(WaiterStateMachineOptions options)public IApiCall WaitForAssertions(WaiterStateMachineOptions? options = null)func WaitForAssertions(Options WaiterStateMachineOptions) IApiCall#
Wait for the IApiCall to return the expected response.

If no expected response is specified then it will wait for the IApiCall to return a success

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) 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. Use multiple with() calls if subsequent mixins should apply to added constructs.

1 parameter · returns

Parameters

  • mixinsmixinsmixinsmixinsMixins — The mixins to apply.

Returns: This construct for chaining