@aws-cdk_integ-tests-alpha.ApiCallBase

class ApiCallBase ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.IntegTests.Alpha.ApiCallBase
Gogithub.com/aws/aws-cdk-go/awscdkintegtestsalpha/v2#ApiCallBase
Javasoftware.amazon.awscdk.integtests.alpha.ApiCallBase
Pythonaws_cdk.integ_tests_alpha.ApiCallBase
TypeScript (source)@aws-cdk/integ-tests-alpha ยป ApiCallBase

Implements IConstruct, IDependable, IApiCall

Extends Construct

Implemented by AwsApiCall, HttpApiCall, LambdaInvokeFunction

Base class for an ApiCall.

Initializer

new ApiCallBase(scope: Construct, id: string)

Parameters

  • scope Construct
  • id string

Properties

NameTypeDescription
apiCallResource๐Ÿ”นCustomResource
flattenResponse๐Ÿ”นstring
node๐Ÿ”นNodeThe tree node.
provider๐Ÿ”นAssertionsProvideraccess the AssertionsProvider.
expectedResult?๐Ÿ”นstring
stateMachineArn?๐Ÿ”นstring

apiCallResource๐Ÿ”น

Type: CustomResource


flattenResponse๐Ÿ”น

Type: string


node๐Ÿ”น

Type: Node

The tree node.


provider๐Ÿ”น

Type: AssertionsProvider

access the AssertionsProvider.

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


expectedResult?๐Ÿ”น

Type: string (optional)


stateMachineArn?๐Ÿ”น

Type: string (optional)

Methods

NameDescription
assertAtPath(path, expected)๐Ÿ”นAssert that the ExpectedResult is equal to the result of the AwsApiCall at the given path.
expect(expected)๐Ÿ”นAssert that the ExpectedResult is equal to the result of the AwsApiCall.
getAtt(attributeName)๐Ÿ”นReturns the value of an attribute of the custom resource of an arbitrary type.
getAttString(attributeName)๐Ÿ”นReturns the value of an attribute of the custom resource of type string.
next(next)๐Ÿ”นAllows you to chain IApiCalls. This adds an explicit dependency betweent the two resources.
toString()๐Ÿ”นReturns a string representation of this construct.
waitForAssertions(options?)๐Ÿ”นWait for the IApiCall to return the expected response.

assertAtPath(path, expected)๐Ÿ”น

public assertAtPath(path: string, expected: ExpectedResult): IApiCall

Parameters

  • path string
  • expected ExpectedResult

Returns

  • 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)๐Ÿ”น

public expect(expected: ExpectedResult): IApiCall

Parameters

  • expected ExpectedResult

Returns

  • IApiCall

Assert that the ExpectedResult is equal to the result of the AwsApiCall.


getAtt(attributeName)๐Ÿ”น

public getAtt(attributeName: string): Reference

Parameters

  • attributeName string

Returns

  • 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)๐Ÿ”น

public getAttString(attributeName: string): string

Parameters

  • attributeName string

Returns

  • 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.


next(next)๐Ÿ”น

public next(next: IApiCall): IApiCall

Parameters

  • next IApiCall

Returns

  • IApiCall

Allows you to chain IApiCalls. This adds an explicit dependency betweent the two resources.

Returns the IApiCall provided as next


toString()๐Ÿ”น

public toString(): string

Returns

  • string

Returns a string representation of this construct.


waitForAssertions(options?)๐Ÿ”น

public waitForAssertions(options?: WaiterStateMachineOptions): IApiCall

Parameters

  • options WaiterStateMachineOptions

Returns

  • 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