Skip to content

API.md

Latest commit

 

History

History
182 lines (111 loc) · 6.42 KB

API.md

File metadata and controls

182 lines (111 loc) · 6.42 KB
Raw

API Reference

Constructs

CDKCodeBuildSonarcloud

Initializers 

import { CDKCodeBuildSonarcloud } from 'cdk-codebuild-sonarcloud'

new CDKCodeBuildSonarcloud(scope: Construct, id: string, props: CDKCodeBuildSonarcloudProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props CDKCodeBuildSonarcloudProps No description.
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string
propsRequired

Methods

Name Description
toString Returns a string representation of this construct.
toString 
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { CDKCodeBuildSonarcloud } from 'cdk-codebuild-sonarcloud'

CDKCodeBuildSonarcloud.isConstruct(x: any)

Checks if x is a construct.

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.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
buildAction aws-cdk-lib.aws_codepipeline_actions.CodeBuildAction No description.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

buildActionRequired 
public readonly buildAction: CodeBuildAction;
  • Type: aws-cdk-lib.aws_codepipeline_actions.CodeBuildAction

Structs

CDKCodeBuildSonarcloudProps

Initializer 

import { CDKCodeBuildSonarcloudProps } from 'cdk-codebuild-sonarcloud'

const cDKCodeBuildSonarcloudProps: CDKCodeBuildSonarcloudProps = { ... }

Properties

Name Type Description
sonarOrganizationName string No description.
sonarProjectName string No description.
sourceOutput aws-cdk-lib.aws_codepipeline.Artifact No description.
sonarOrganizationNameRequired 
public readonly sonarOrganizationName: string;
  • Type: string
sonarProjectNameRequired 
public readonly sonarProjectName: string;
  • Type: string
sourceOutputRequired 
public readonly sourceOutput: Artifact;
  • Type: aws-cdk-lib.aws_codepipeline.Artifact