Class CloudFormationCustomResource

A test construct for a CloudFormation Custom Resource

See

https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudformation.CfnCustomResource.html

Hierarchy

RemovableResource
Hierarchy
- CloudFormationCustomResource

Index

Constructors

constructor

new CloudFormationCustomResource(template: AdvancedTemplate, props?: any): CloudFormationCustomResource
Parameters
- template: AdvancedTemplate
- Optional props: any
Returns CloudFormationCustomResource
Overrides RemovableResource.constructor
- Defined in cloudformation.ts:10

Properties

`Protected` definitionMatcher

definitionMatcher: Dict

Member

The matching definition of the resource (including the Properties).

`Protected` dependencyMatcher

dependencyMatcher: string[]

Member

The matching dependency keys of the resource (DependsOn).

`Protected` key

key: string

Member

The matching key of the resource.

`Protected` metadataMatcher

metadataMatcher: any

Member

The matching Metadata of the resource.

`Protected` propertiesMatcher

propertiesMatcher: any

Member

The matching Properties of the resource.

`Protected` template

template: AdvancedTemplate

Member

The parsed template.

Accessors

arn

get arn(): Matcher
The matcher for the ARN of the resource.

Returns Matcher
Inherited from RemovableResource.arn
- Defined in resource.ts:194

`Protected` definition

get definition(): any
The definition of the resource from the template.

Throws
if the resource is not found.

Throws
if more than one matching resource is found.

Returns any
Inherited from RemovableResource.definition
- Defined in resource.ts:165

id

get id(): string
The key/ID of the resource from the template.

Returns string
Inherited from RemovableResource.id
- Defined in resource.ts:180

metadata

get metadata(): Dict
The metadata of the resource from the template.

Returns Dict
Inherited from RemovableResource.metadata
- Defined in resource.ts:187

ref

get ref(): Matcher
The matcher for the Ref of the resource.

Returns Matcher
Inherited from RemovableResource.ref
- Defined in resource.ts:201

Methods

assert

assert(condition: boolean, message: string): void
Asserts the condition and in case of failure, fails with a detailed error containing the template's debug information.

Throws
if the condition is false.
Parameters
- condition: boolean
  
  The condition to evaluate for true.
- message: string
  
  The message to fail if the condition is false.
Returns void
Inherited from RemovableResource.assert
- Defined in resource.ts:270

count

count(): number
The number of resources matching from the template.

Returns

Returns number
Inherited from RemovableResource.count
- Defined in resource.ts:211

countIs

countIs(count: number): void
Checks if the number of matching resources is expected.

Throws
if the number of the matching resources is not the expected.
Parameters
- count: number
  
  The expected number of matching resources.
Returns void
Inherited from RemovableResource.countIs
- Defined in resource.ts:237

dependsOn

dependsOn(resource: Resource): CloudFormationCustomResource
Sets a matching dependency of the resource (DependsOn root property).

Returns
Parameters
- resource: Resource
  
  The test construct to match dependency on.
Returns CloudFormationCustomResource
Inherited from RemovableResource.dependsOn
- Defined in resource.ts:296

doesNotExist

doesNotExist(): void
Checks if the matching resource does not exist.

Throws
if the matching resource exists.

Returns void
Inherited from RemovableResource.doesNotExist
- Defined in resource.ts:220

exists

exists(): void
Checks if the matching resource exists.

Throws
if the matching resource does not exist.

Returns void
Inherited from RemovableResource.exists
- Defined in resource.ts:228

find

find(): KeyAndProps
Returns dictionary (object) of the matching resources from the template, considering the matching definition and the key, if set.

Returns

Returns KeyAndProps
Inherited from RemovableResource.find
- Defined in resource.ts:139

findSimilarType

findSimilarType(): KeyAndProps
Returns the dictionary (object) of the resources with the same type as the current one.

Returns

Returns KeyAndProps
Inherited from RemovableResource.findSimilarType
- Defined in resource.ts:156

hasTag

hasTag(key: string, value?: string): CloudFormationCustomResource
Checks if the tag with the given name (and optionally value) exists on the resource.

Returns

Throws
if the tag is not found.
Parameters
- key: string
  
  The exact name of the tag.
- Optional value: string
  
  Either empty to check only for the tag or the exact value of the tag.
Returns CloudFormationCustomResource
Inherited from RemovableResource.hasTag
- Defined in resource.ts:281

toDebugString

toDebugString(): string
Returns debug information (as JSON string) of the test construct, including the matching definition and the resources with the same type found in the template.

Returns

Returns string
Inherited from RemovableResource.toDebugString
- Defined in resource.ts:255

toJSON

toJSON(): any
Converts the resource to its CloudFormation definition from the template.

Returns

Returns any
Inherited from RemovableResource.toJSON
- Defined in resource.ts:245

withMetadata

withMetadata(key: string, value?: any): CloudFormationCustomResource
Sets/Overwrites a particular property in Metadata.

Returns
Parameters
- key: string
  
  The key of the metadata.
- Optional value: any
  
  The metadata's value, either a matching string, a Matcher, or not set to only match for the existence of the property.
Returns CloudFormationCustomResource
Inherited from RemovableResource.withMetadata
- Defined in resource.ts:92

withPartialKey

withPartialKey(key: string): CloudFormationCustomResource
Sets the matching key.

Returns
Parameters
- key: string
  
  The exact or partial key.
Returns CloudFormationCustomResource
Inherited from RemovableResource.withPartialKey
- Defined in resource.ts:54

withProperty

withProperty(key: string, value?: any): CloudFormationCustomResource
Sets/Overwrites a particular property in Properties.

Returns
Parameters
- key: string
  
  The key of the property.
- Optional value: any
  
  The property's value, either a matching string, a Matcher, or not set to only match for the existence of the property.
Returns CloudFormationCustomResource
Inherited from RemovableResource.withProperty
- Defined in resource.ts:67

withRemovalPolicy

withRemovalPolicy(policy: RemovalPolicy): CloudFormationCustomResource
Sets matching properties inferred from the RemovalPolicy (i.e. DeletionPolicy, UpdateReplacePolicy).

See
https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.RemovalPolicy.html

Returns
Parameters
- policy: RemovalPolicy
  
  The RemovalPolicy to match with.
Returns CloudFormationCustomResource
Inherited from RemovableResource.withRemovalPolicy
- Defined in resource.ts:327

withRootProperty

withRootProperty(key: string, value?: any): CloudFormationCustomResource
Sets/Overwrites a particular property in the root definition.

Returns
Parameters
- key: string
  
  The key of the property.
- Optional value: any
  
  The metadata's value, either a matching string, a Matcher, or not set to only match for the existence of the property.
Returns CloudFormationCustomResource
Inherited from RemovableResource.withRootProperty
- Defined in resource.ts:117

withServiceToken

withServiceToken(resource: Resource): CloudFormationCustomResource
Sets a matching service token to another test construct resource

Returns
Parameters
- resource: Resource
  
  The test construct resource
Returns CloudFormationCustomResource
- Defined in cloudformation.ts:19

Class CloudFormationCustomResource

See

Hierarchy

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

template: AdvancedTemplate

Optional props: any

Returns CloudFormationCustomResource

Properties

Protected definitionMatcher

Member

Protected dependencyMatcher

Member

Protected key

Member

Protected metadataMatcher

Member

Protected propertiesMatcher

Member

Protected template

Member

Accessors

arn

Returns Matcher

Protected definition

Throws

Throws

Returns any

id

Returns string

metadata

Returns Dict

ref

Returns Matcher

Methods

assert

Throws

Parameters

condition: boolean

message: string

Returns void

count

Returns

Returns number

countIs

Throws

Parameters

count: number

Returns void

dependsOn

Returns

Parameters

resource: Resource

Returns CloudFormationCustomResource

doesNotExist

Throws

Returns void

exists

Throws

Returns void

find

Returns

Returns KeyAndProps

findSimilarType

Returns

Returns KeyAndProps

hasTag

Returns

Throws

Parameters

key: string

Optional value: string

Returns CloudFormationCustomResource

`Optional` props: any

`Protected` definitionMatcher

`Protected` dependencyMatcher

`Protected` key

`Protected` metadataMatcher

`Protected` propertiesMatcher

`Protected` template

`Protected` definition

`Optional` value: string

`Optional` value: any

`Optional` value: any

`Optional` value: any