Class AdvancedTemplate

CloudFormation/CDK template assertion class, based on CDK Assertions Template

Hierarchy

AdvancedTemplate

Constructors

constructor

new AdvancedTemplate(template: Template, region?: string): AdvancedTemplate
Parameters
- template: Template
  
  The parsed template
- Optional region: string
  
  The region of the stack
Returns AdvancedTemplate
- Defined in advanced-template.ts:39

Properties

region

region: string

Member

The region of the stack

`Private` template

template: Template

Member

The parsed template

Methods

apiGatewayAccount

apiGatewayAccount(props?: any): ApiGatewayAccount
Creates an API Gateway Account test construct with the passed Properties.

Returns
Parameters
- Optional props: any
  
  The Properties of the expected test construct.
Returns ApiGatewayAccount
- Defined in advanced-template.ts:231

apiGatewayApiKey

apiGatewayApiKey(props?: any): ApiGatewayApiKey
Creates an API Gateway API Key test construct with the passed Properties.

Returns
Parameters
- Optional props: any
  
  The Properties of the expected test construct.
Returns ApiGatewayApiKey
- Defined in advanced-template.ts:240

apiGatewayBasePathMapping

apiGatewayBasePathMapping(props?: any): ApiGatewayBasePathMapping
Creates an API Gateway Base Path Mapping test construct with the passed Properties.

Returns
Parameters
- Optional props: any
  
  The Properties of the expected test construct.
Returns ApiGatewayBasePathMapping
- Defined in advanced-template.ts:249

apiGatewayDeployment

apiGatewayDeployment(props?: any): ApiGatewayDeployment
Creates an API Gateway Deployment test construct with the passed Properties.

Returns
Parameters
- Optional props: any
  
  The Properties of the expected test construct.
Returns ApiGatewayDeployment
- Defined in advanced-template.ts:258

apiGatewayDomain

apiGatewayDomain(props?: any): ApiGatewayDomain
Creates an API Gateway Domain test construct with the passed Properties.

Returns
Parameters
- Optional props: any
  
  The Properties of the expected test construct.
Returns ApiGatewayDomain
- Defined in advanced-template.ts:267

apiGatewayMethod

apiGatewayMethod(props?: any): ApiGatewayMethod
Creates an API Gateway Method test construct with the passed Properties.

Returns
Parameters
- Optional props: any
  
  The Properties of the expected test construct.
Returns ApiGatewayMethod
- Defined in advanced-template.ts:276

apiGatewayResource

apiGatewayResource(props?: any): ApiGatewayResource
Creates an API Gateway Resource test construct with the passed Properties.

Returns
Parameters
- Optional props: any
  
  The Properties of the expected test construct.
Returns ApiGatewayResource
- Defined in advanced-template.ts:285

apiGatewayRestApi

apiGatewayRestApi(props?: any): ApiGatewayRestApi
Creates an API Gateway REST API test construct with the passed Properties.

Returns
Parameters
- Optional props: any
  
  The Properties of the expected test construct.
Returns ApiGatewayRestApi
- Defined in advanced-template.ts:294

apiGatewayStage

apiGatewayStage(props?: any): ApiGatewayStage
Creates an API Gateway Stage test construct with the passed Properties.

Returns
Parameters
- Optional props: any
  
  The Properties of the expected test construct.
Returns ApiGatewayStage
- Defined in advanced-template.ts:303

apiGatewayUsagePlan

apiGatewayUsagePlan(props?: any): ApiGatewayUsagePlan
Creates an API Gateway Usage Plan test construct with the passed Properties.

Returns
Parameters
- Optional props: any
  
  The Properties of the expected test construct.
Returns ApiGatewayUsagePlan
- Defined in advanced-template.ts:312

apiGatewayUsagePlanKey

apiGatewayUsagePlanKey(props?: any): ApiGatewayUsagePlanKey
Creates an API Gateway Usage Plan Key test construct with the passed Properties.

Returns
Parameters
- Optional props: any
  
  The Properties of the expected test construct.
Returns ApiGatewayUsagePlanKey
- Defined in advanced-template.ts:321

cloudFormationCustomResource

cloudFormationCustomResource(props?: any): CloudFormationCustomResource
Creates a CloudFormation CustomResource test construct with the passed Properties.

Returns
Parameters
- Optional props: any
  
  The Properties of the expected test construct.
Returns CloudFormationCustomResource
- Defined in advanced-template.ts:330

cloudFrontDistribution

cloudFrontDistribution(props?: any): CloudFrontDistribution
Creates a CloudFront Distribution test construct with the passed Properties.

Returns
Parameters
- Optional props: any
  
  The Properties of the expected test construct.
Returns CloudFrontDistribution
- Defined in advanced-template.ts:339

cloudFrontFunction

cloudFrontFunction(props?: any): CloudFrontFunction
Creates a CloudFront Function test construct with the passed Properties.

Returns
Parameters
- Optional props: any
  
  The Properties of the expected test construct.
Returns CloudFrontFunction
- Defined in advanced-template.ts:348

codeBuildProject

codeBuildProject(props?: any): CodeBuildProject
Creates a CodeBuild Project test construct with the passed Properties.

Returns
Parameters
- Optional props: any
  
  The Properties of the expected test construct.
Returns CodeBuildProject
- Defined in advanced-template.ts:357

codeBuildSourceCredentials

codeBuildSourceCredentials(props?: any): CodeBuildSourceCredentials
Creates a CodeBuild SourceCredentials test construct with the passed Properties.

Returns
Parameters
- Optional props: any
  
  The Properties of the expected test construct.
Returns CodeBuildSourceCredentials
- Defined in advanced-template.ts:366

customResource

customResource(props?: any): CustomResource
Creates a CustomResource test construct with the passed Properties.

Returns
Parameters
- Optional props: any
  
  The Properties of the expected test construct.
Returns CustomResource
- Defined in advanced-template.ts:375

debug

debug(): void
Logs the CloudFormation JSON to the console.

Returns void
- Defined in advanced-template.ts:198

dynamoDBTable

dynamoDBTable(props?: any): DynamoDBTable
Creates a DynamoDB Table test construct with the passed Properties.

Returns
Parameters
- Optional props: any
  
  The Properties of the expected test construct.
Returns DynamoDBTable
- Defined in advanced-template.ts:384

findConditions

findConditions(logicalId: string, props?: any): KeyAndProps
Returns the Conditions matching with the passed properties.

See
https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.assertions.Template.html#findwbrconditionslogicalid-props
Parameters
- logicalId: string
- Optional props: any
Returns KeyAndProps
- Defined in advanced-template.ts:83

findMappings

findMappings(logicalId: string, props?: any): KeyAndProps
Returns the Mapping matching with the passed properties.

See
https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.assertions.Template.html#findwbrmappingslogicalid-props
Parameters
- logicalId: string
- Optional props: any
Returns KeyAndProps
- Defined in advanced-template.ts:91

findOutputs

findOutputs(logicalId: string, props?: any): KeyAndProps
Returns the Outputs matching with the passed properties.

See
https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.assertions.Template.html#findwbroutputslogicalid-props
Parameters
- logicalId: string
- Optional props: any
Returns KeyAndProps
- Defined in advanced-template.ts:99

findParameters

findParameters(logicalId: string, props?: any): KeyAndProps
Returns the Parameters matching with the passed properties.

See
https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.assertions.Template.html#findwbrparameterslogicalid-props
Parameters
- logicalId: string
- Optional props: any
Returns KeyAndProps
- Defined in advanced-template.ts:107

findResources

findResources(type: string, props?: any): KeyAndProps
Returns the Resources of type matching with the passed properties.

See
https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.assertions.Template.html#findwbrresourcestype-props
Parameters
- type: string
- Optional props: any
Returns KeyAndProps
- Defined in advanced-template.ts:115

hasCondition

hasCondition(logicalId: string, props: any): void
Checks if there is a Condition matching the passed properties.

See
https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.assertions.Template.html#haswbrconditionlogicalid-props
Parameters
- logicalId: string
- props: any
Returns void
- Defined in advanced-template.ts:123

hasMapping

hasMapping(logicalId: string, props: any): void
Checks if there is a Mapping matching the passed properties.

See
https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.assertions.Template.html#haswbrmappinglogicalid-props
Parameters
- logicalId: string
- props: any
Returns void
- Defined in advanced-template.ts:131

hasOutput

hasOutput(logicalId: string, props: any): void
Checks if there is an Output matching the passed properties.

See
https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.assertions.Template.html#haswbroutputlogicalid-props
Parameters
- logicalId: string
- props: any
Returns void
- Defined in advanced-template.ts:139

hasParameter

hasParameter(logicalId: string, props: any): void
Checks if there is a Parameter matching the passed properties.

See
https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.assertions.Template.html#haswbrparameterlogicalid-props
Parameters
- logicalId: string
- props: any
Returns void
- Defined in advanced-template.ts:147

hasResource

hasResource(type: string, props: any): void
Checks if there is a Resource matching the passed definition.

See
https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.assertions.Template.html#haswbrresourcetype-props
Parameters
- type: string
- props: any
Returns void
- Defined in advanced-template.ts:155

hasResourceProperties

hasResourceProperties(type: string, props: any): void
Checks if there is a Resource matching the passed properties.

See
https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.assertions.Template.html#haswbrresourcewbrpropertiestype-props
Parameters
- type: string
- props: any
Returns void
- Defined in advanced-template.ts:163

iamPolicy

iamPolicy(props?: any): IAMPolicy
Creates an IAM Policy test construct with the passed Properties.

Returns
Parameters
- Optional props: any
  
  The Properties of the expected test construct.
Returns IAMPolicy
- Defined in advanced-template.ts:402

iamRole

iamRole(props?: any): IAMRole
Creates an IAM Role test construct with the passed Properties.

Returns
Parameters
- Optional props: any
  
  The Properties of the expected test construct.
Returns IAMRole
- Defined in advanced-template.ts:393

lambdaFunction

lambdaFunction(props?: any): LambdaFunction
Creates a Lambda Function test construct with the passed Properties.

Returns
Parameters
- Optional props: any
  
  The Properties of the expected test construct.
Returns LambdaFunction
- Defined in advanced-template.ts:411

lambdaPermission

lambdaPermission(props?: any): LambdaPermission
Creates a Lambda Permission test construct with the passed Properties.

Returns
Parameters
- Optional props: any
  
  The Properties of the expected test construct.
Returns LambdaPermission
- Defined in advanced-template.ts:420

logGroup

logGroup(props?: any): LogGroup
Creates a LogGroup test construct with the passed Properties.

Returns
Parameters
- Optional props: any
  
  The Properties of the expected test construct.
Returns LogGroup
- Defined in advanced-template.ts:429

removableResource

removableResource(type: string, props?: any): RemovableResource
Creates a general RemovableResource test construct with the passed type and properties.

Returns
Parameters
- type: string
  
  The CloudFormation resource type
- Optional props: any
  
  The properties of the expected test construct
Returns RemovableResource
- Defined in advanced-template.ts:222

resource

resource(type: string, props?: any): Resource
Creates a general Resource test construct with the passed type and properties.

Returns
Parameters
- type: string
  
  The CloudFormation resource type
- Optional props: any
  
  The properties of the expected test construct
Returns Resource
- Defined in advanced-template.ts:212

resourceCountIs

resourceCountIs(type: string, count: number): void
Checks if the count of the Resources of type is the passed one.

See
https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.assertions.Template.html#resourcewbrcountwbristype-count
Parameters
- type: string
- count: number
Returns void
- Defined in advanced-template.ts:171

route53HostedZone

route53HostedZone(props?: any): Route53HostedZone
Creates a Route53 HostedZone test construct with the passed Properties.

Returns
Parameters
- Optional props: any
  
  The Properties of the expected test construct.
Returns Route53HostedZone
- Defined in advanced-template.ts:438

route53RecordSet

route53RecordSet(props?: any): Route53RecordSet
Creates a Route53 RecordSet test construct with the passed Properties.

Returns
Parameters
- Optional props: any
  
  The Properties of the expected test construct.
Returns Route53RecordSet
- Defined in advanced-template.ts:447

s3Bucket

s3Bucket(props?: any): S3Bucket
Creates an S3 Bucket test construct with the passed Properties.

Returns
Parameters
- Optional props: any
  
  The Properties of the expected test construct.
Returns S3Bucket
- Defined in advanced-template.ts:456

s3BucketPolicy

s3BucketPolicy(props?: any): S3BucketPolicy
Creates an S3 Bucket Policy test construct with the passed Properties.

Returns
Parameters
- Optional props: any
  
  The Properties of the expected test construct.
Returns S3BucketPolicy
- Defined in advanced-template.ts:465

secret

secret(props?: any): Secret
Creates a SecretsManager Secret test construct with the passed Properties.

Returns
Parameters
- Optional props: any
  
  The Properties of the expected test construct.
Returns Secret
- Defined in advanced-template.ts:474

ssmParameter

ssmParameter(props?: any): SSMParameter
Creates an SSM Parameter test construct with the passed Properties.

Returns
Parameters
- Optional props: any
  
  The Properties of the expected test construct.
Returns SSMParameter
- Defined in advanced-template.ts:483

templateMatches

templateMatches(expected: AdvancedTemplate | KeyAndProps): void
Checks if the template matches the passed CloudFormation JSON template.

See
https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.assertions.Template.html#templatewbrmatchesexpected
Parameters
- expected: AdvancedTemplate | KeyAndProps
Returns void
- Defined in advanced-template.ts:179

toJSON

toJSON(): Dict
Returns the CloudFormation JSON template of the current one.

See
https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.assertions.Template.html#towbrjson

Returns Dict
- Defined in advanced-template.ts:191

wafV2WebACL

wafV2WebACL(props?: any): WafV2WebACL
Creates a WAF v2 WebACL test construct with the passed Properties.

Returns
Parameters
- Optional props: any
  
  The Properties of the expected test construct.
Returns WafV2WebACL
- Defined in advanced-template.ts:492

`Static` fromJSON

fromJSON(template: Dict, region?: string): AdvancedTemplate
Parses a template from the CloudFormation template JSON.

Ee
https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.assertions.Template.html#static-fromwbrjsontemplate

Returns
Parameters
- template: Dict
  
  The CloudFormation template, formatted as a nested set of records.
- Optional region: string
  
  The region of the stack.
Returns AdvancedTemplate
- Defined in advanced-template.ts:63

`Static` fromStack

fromStack(stack: Stack): AdvancedTemplate
Parses a template from the CDK stack instance.

See
https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.assertions.Template.html#static-fromwbrstackstack

Returns
Parameters
- stack: Stack
  
  The stack instance
Returns AdvancedTemplate
- Defined in advanced-template.ts:51

`Static` fromString

fromString(template: string, region?: string): AdvancedTemplate
Parses a template from the CloudFormation template.

See
https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.assertions.Template.html#static-fromwbrstringtemplate

Returns
Parameters
- template: string
  
  The CloudFormation template.
- Optional region: string
  
  The region of the stack
Returns AdvancedTemplate
- Defined in advanced-template.ts:75

Class AdvancedTemplate

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

template: Template

Optional region: string

Returns AdvancedTemplate

Properties

region

Member

Private template

Member

Methods

apiGatewayAccount

Returns

Parameters

Optional props: any

Returns ApiGatewayAccount

apiGatewayApiKey

Returns

Parameters

Optional props: any

Returns ApiGatewayApiKey

apiGatewayBasePathMapping

Returns

Parameters

Optional props: any

Returns ApiGatewayBasePathMapping

apiGatewayDeployment

Returns

Parameters

Optional props: any

Returns ApiGatewayDeployment

apiGatewayDomain

Returns

Parameters

Optional props: any

Returns ApiGatewayDomain

apiGatewayMethod

Returns

Parameters

Optional props: any

Returns ApiGatewayMethod

apiGatewayResource

Returns

Parameters

Optional props: any

Returns ApiGatewayResource

apiGatewayRestApi

Returns

Parameters

Optional props: any

Returns ApiGatewayRestApi

apiGatewayStage

Returns

Parameters

Optional props: any

Returns ApiGatewayStage

apiGatewayUsagePlan

Returns

Parameters

Optional props: any

Returns ApiGatewayUsagePlan

apiGatewayUsagePlanKey

Returns

Parameters

Optional props: any

Returns ApiGatewayUsagePlanKey

cloudFormationCustomResource

Returns

Parameters

Optional props: any

Returns CloudFormationCustomResource

cloudFrontDistribution

Returns

`Optional` region: string

`Private` template

`Optional` props: any

`Optional` props: any

`Optional` props: any

`Optional` props: any

`Optional` props: any

`Optional` props: any

`Optional` props: any

`Optional` props: any

`Optional` props: any

`Optional` props: any

`Optional` props: any

`Optional` props: any

`Optional` props: any

`Optional` props: any

`Optional` props: any

`Optional` props: any

`Optional` props: any

`Optional` props: any

`Optional` props: any

`Optional` props: any

`Optional` props: any

`Optional` props: any

`Optional` props: any