Experimental
@aws-cdk/integ-tests-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
HttpApiCall
Construct that creates a custom resource that will perform an HTTP API Call.
Example
declare const stack: Stack;
new HttpApiCall(stack, 'MyAsssertion', {
url: 'https://example-api.com/abc',
});
# stack: Stack
HttpApiCall(stack, "MyAsssertion",
url="https://example-api.com/abc"
)
Stack stack;
HttpApiCall.Builder.create(stack, "MyAsssertion")
.url("https://example-api.com/abc")
.build();
// Install: dotnet add package Amazon.CDK.IntegTests.Alpha
Stack stack;
new HttpApiCall(stack, "MyAsssertion", new HttpCallProps {
Url = "https://example-api.com/abc"
});
// Install: go get github.com/aws/aws-cdk-go/awscdkintegtestsalpha/v2
var stack Stack
awscdkintegtestsalpha.NewHttpApiCall(stack, jsii.String("MyAsssertion"), &HttpCallProps{
Url: jsii.String("https://example-api.com/abc"),
})
Initializer
new HttpApiCall(scope: Construct, id: string, props: HttpCallProps)
HttpApiCall(scope: Construct, id: str, props: HttpCallProps)
new HttpApiCall(Construct scope, String id, HttpCallProps props)
new HttpApiCall(Construct scope, string id, HttpCallProps props)
NewHttpApiCall(Scope Construct, Id *string, Props HttpCallProps)
Construct Props
fetchOptionsoptionalFetchOptionsfetch_optionsoptionalFetchOptionsfetchOptionsoptionalFetchOptionsFetchOptionsoptionalFetchOptionsFetchOptionsoptionalFetchOptions#providerLogLeveloptionalApplicationLogLevelprovider_log_leveloptionalApplicationLogLevelproviderLogLeveloptionalApplicationLogLevelProviderLogLeveloptionalApplicationLogLevelProviderLogLeveloptionalApplicationLogLevel= ApplicationLogLevel.FATAL#Properties
providerAssertionsProviderproviderAssertionsProviderproviderAssertionsProviderProviderAssertionsProviderProviderAssertionsProvider#This can be used to add additional IAM policies the provider role policy
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#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#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#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#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#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.
next(next: IApiCall): IApiCalldef next(self, next: IApiCall) -> IApiCallpublic IApiCall next(IApiCall next)public IApiCall Next(IApiCall next)func Next(Next IApiCall) IApiCall#Returns the IApiCall provided as next
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#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#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#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