AWS CDK Reference

Appearance

v2.273.0

Experimental

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

AwsApiCall ​

Construct that creates a custom resource that will perform a query using the AWS SDK.

Stability
Experimental
Source
lib/assertions/sdk.ts

Example ​

ts
declare const stack: Stack;

new AwsApiCall(stack, 'MyAssertion', {
  service: 'SQS',
  api: 'receiveMessage',
  parameters: {
    QueueUrl: 'url',
  },
});
python
# stack: Stack


AwsApiCall(stack, "MyAssertion",
    service="SQS",
    api="receiveMessage",
    parameters={
        "QueueUrl": "url"
    }
)
java
Stack stack;


AwsApiCall.Builder.create(stack, "MyAssertion")
        .service("SQS")
        .api("receiveMessage")
        .parameters(Map.of(
                "QueueUrl", "url"))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.IntegTests.Alpha
Stack stack;


new AwsApiCall(stack, "MyAssertion", new AwsApiCallProps {
    Service = "SQS",
    Api = "receiveMessage",
    Parameters = new Dictionary<string, string> {
        { "QueueUrl", "url" }
    }
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdkintegtestsalpha/v2
var stack Stack


awscdkintegtestsalpha.NewAwsApiCall(stack, jsii.String("MyAssertion"), &AwsApiCallProps{
	Service: jsii.String("SQS"),
	Api: jsii.String("receiveMessage"),
	Parameters: map[string]*string{
		"QueueUrl": jsii.String("url"),
	},
})

Initializer ​

ts
new AwsApiCall(scope: Construct, id: string, props: AwsApiCallProps)
python
AwsApiCall(scope: Construct, id: str, props: AwsApiCallProps)
java
new AwsApiCall(Construct scope, String id, AwsApiCallProps props)
csharp
new AwsApiCall(Construct scope, string id, AwsApiCallProps props)
go
NewAwsApiCall(Scope Construct, Id *string, Props AwsApiCallProps)

Construct Props ​

apistringapistrapiStringApistringApi*stringrequired#
The api call to make, i.e. getBucketLifecycle.
outputPathsstring[]output_pathstyping.List[str]outputPathsList<String>OutputPathsstring[]OutputPaths*[]*string= return all data#
Restrict the data returned by the API call to specific paths in the API response.

Use this to limit the data returned by the custom resource if working with API calls that could potentially result in custom response objects exceeding the hard limit of 4096 bytes.

parametersanyparametersAnyparametersObjectParametersobjectParametersinterface{}= no parameters#
Any parameters to pass to the api call.
providerLogLevelApplicationLogLevelprovider_log_levelApplicationLogLevelproviderLogLevelApplicationLogLevelProviderLogLevelApplicationLogLevelProviderLogLevelApplicationLogLevel= ApplicationLogLevel.FATAL#
The log level of the provider lambda function.
servicestringservicestrserviceStringServicestringService*stringrequired#
The AWS service, i.e. S3.

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