API.md

API Reference

Classes

Name	Description
CodePipelineIamRole	No description
DataBrewCodePipeline	No description
FirstCommitHandler	No description
IamRole	IAM Role.
InfraIamRole	No description
PreProductionLambda	No description
ProductionLambda	No description

Structs

Name	Description
CodePipelineIamRoleProps	No description
DataBrewCodePipelineProps	No description
FirstCommitHandlerProps	No description
IamRoleProps	No description
InfraIamRoleProps	No description
PreProductionLambdaProps	No description
ProductionLambdaProps	No description

class CodePipelineIamRole

Implements: IConstruct, IDependable Extends: Construct

Initializer

new CodePipelineIamRole(scope: Construct, name: string, props: CodePipelineIamRoleProps)

• scope (Construct) No description
• name (string) No description
• props (CodePipelineIamRoleProps) No description
  • bucketArn (string) The ARN of the S3 bucket where you store your artifacts.
  • preproductionLambdaArn (string) The ARN of the Lambda function for the pre-production account.
  • productionLambdaArn (string) The ARN of the Lambda function for the production account.
  • roleName (string) The role name for the CodePipeline CICD pipeline. Default: 'DataBrew-Recipe-Pipeline-Role'

Properties

Name	Type	Description
role	aws_iam.Role	The representative of the IAM role for the CodePipeline CICD pipeline.
roleArn	string	The ARN of the IAM role for the CodePipeline CICD pipeline.

class DataBrewCodePipeline

Implements: IConstruct, IDependable Extends: Construct

Initializer

new DataBrewCodePipeline(scope: Construct, name: string, props: DataBrewCodePipelineProps)

• scope (Construct) No description
• name (string) No description
• props (DataBrewCodePipelineProps) No description
  • preproductionIamRoleArn (string) The ARN of the IAM role in the pre-production account.
  • productionIamRoleArn (string) The ARN of the IAM role in the production account.
  • branchName (string) The name of the branch that will trigger the DataBrew CICD pipeline. Default: 'main'
  • bucketName (string) The name of the S3 bucket for the CodePipeline DataBrew CICD pipeline. Default: 'databrew-cicd-codepipelineartifactstorebucket'
  • firstStageArtifactName (string) the (required) name of the Artifact at the first stage. Default: 'SourceOutput'
  • pipelineName (string) The name of the CodePipeline Databrew CICD pipeline. Default: 'DataBrew-Recipe-Application'
  • repoName (string) The name of the CodeCommit repositroy for the DataBrew CICD pipeline. Default: 'DataBrew-Recipes-Repo'

Properties

Name	Type	Description
branchName	string	The name of the branch that will trigger the DataBrew CICD pipeline.
bucketArn	string	The ARN of the S3 bucket for the CodePipeline DataBrew CICD pipeline.
codeCommitRepoArn	string	The ARN of the CodeCommit repository.
codePipelineArn	string	The ARN of the DataBrew CICD pipeline.
firstStageArtifactName	string	the (required) name of the Artifact at the first stage.
preproductionFunctionArn	string	The ARN of the Lambda function for the pre-production account.
productionFunctionArn	string	The ARN of the Lambda function for the production account.
repoName	string	The name of the CodeCommit repositroy for the DataBrew CICD pipeline.

class FirstCommitHandler

Implements: IConstruct, IDependable Extends: Construct

Initializer

new FirstCommitHandler(scope: Construct, name: string, props: FirstCommitHandlerProps)

• scope (Construct) No description
• name (string) No description
• props (FirstCommitHandlerProps) No description
  • branchName (string) The branch name used in the CodeCommit repo.
  • codeCommitRepoArn (string) The ARN of the CodeCommit repository.
  • repoName (string) The name of the CodeCommit repo.
  • functionName (string) The name of the Lambda function which deals with first commit via AWS CodeCommit. Default: 'FirstCommitHandler'
  • roleName (string) The name of the IAM role for the Lambda function which deals with first commit via AWS CodeCommit. Default: 'LambdaForInitialCommitRole'

Properties

Name	Type	Description
function	aws_lambda.IFunction	The representative of Lambda function which deals with first commit via AWS CodeCommit.
functionName	string	The name of the Lambda function which deals with first commit via AWS CodeCommit.
roleName	string	The name of the IAM role for the Lambda function which deals with first commit via AWS CodeCommit.

class IamRole

IAM Role.

Defines an IAM role for pre-production and production AWS accounts.

Implements: IConstruct, IDependable Extends: Construct

Initializer

new IamRole(scope: Construct, name: string, props: IamRoleProps)

• scope (Construct) No description
• name (string) No description
• props (IamRoleProps) No description
  • accountID (string) The ID of your infrastructure account.
  • environment (string) 'preproduction' or 'production'.
  • roleName (string) The role name. Default: '{environment}-Databrew-Cicd-Role'

Properties

Name	Type	Description
roleArn	string	The ARN of the IAM role for pre-production or production.

class InfraIamRole

Implements: IConstruct, IDependable Extends: Construct

Initializer

new InfraIamRole(scope: Construct, name: string, props: InfraIamRoleProps)

• scope (Construct) No description
• name (string) No description
• props (InfraIamRoleProps) No description
  • roleName (string) The role name for the infrastructure account. Default: 'CrossAccountRepositoryContributorRole'

Properties

Name	Type	Description
roleArn	string	The ARN of the IAM role for the infrastructure account.

class PreProductionLambda

Implements: IConstruct, IDependable Extends: Construct

Initializer

new PreProductionLambda(scope: Construct, name: string, props: PreProductionLambdaProps)

• scope (Construct) No description
• name (string) No description
• props (PreProductionLambdaProps) No description
  • bucketArn (string) The ARN of the S3 bucket for the DataBrew CICD pipeline.
  • preproductionIamRoleArn (string) The ARN of the IAM role in the pre-production account.
  • functionName (string) The Lambda funciton name for the pre-production account. Default: 'PreProd-DataBrew-Recipe-Deployer'
  • roleName (string) The name of the IAM role for the pre-produciton Lambda function. Default: 'PreProd-DataBrew-Recipe-Deployer-role'

Properties

Name	Type	Description
function	aws_lambda.IFunction	The representative of Lambda function for the pre-production account.
functionName	string	The Lambda funciton name for the pre-production account.
roleName	string	The name of the IAM role for the pre-produciton Lambda function.

class ProductionLambda

Implements: IConstruct, IDependable Extends: Construct

Initializer

new ProductionLambda(scope: Construct, name: string, props: ProductionLambdaProps)

• scope (Construct) No description
• name (string) No description
• props (ProductionLambdaProps) No description
  • bucketArn (string) The ARN of the S3 bucket for the DataBrew CICD pipeline.
  • productionIamRoleArn (string) The ARN of the IAM role in the production account.
  • functionName (string) The Lambda funciton name for the production account. Default: 'Prod-DataBrew-Recipe-Deployer'
  • roleName (string) The name of the IAM role for the produciton Lambda function. Default: 'Prod-DataBrew-Recipe-Deployer-role'

Properties

Name	Type	Description
function	aws_lambda.IFunction	The representative of Lambda function for the production account.
functionName	string	The Lambda funciton name for the production account.
roleName	string	The name of the IAM role for the produciton Lambda function.

struct CodePipelineIamRoleProps

Name	Type	Description
bucketArn	string	The ARN of the S3 bucket where you store your artifacts.
preproductionLambdaArn	string	The ARN of the Lambda function for the pre-production account.
productionLambdaArn	string	The ARN of the Lambda function for the production account.
roleName?	string	The role name for the CodePipeline CICD pipeline. Default: 'DataBrew-Recipe-Pipeline-Role'

struct DataBrewCodePipelineProps

Name	Type	Description
preproductionIamRoleArn	string	The ARN of the IAM role in the pre-production account.
productionIamRoleArn	string	The ARN of the IAM role in the production account.
branchName?	string	The name of the branch that will trigger the DataBrew CICD pipeline. Default: 'main'
bucketName?	string	The name of the S3 bucket for the CodePipeline DataBrew CICD pipeline. Default: 'databrew-cicd-codepipelineartifactstorebucket'
firstStageArtifactName?	string	the (required) name of the Artifact at the first stage. Default: 'SourceOutput'
pipelineName?	string	The name of the CodePipeline Databrew CICD pipeline. Default: 'DataBrew-Recipe-Application'
repoName?	string	The name of the CodeCommit repositroy for the DataBrew CICD pipeline. Default: 'DataBrew-Recipes-Repo'

struct FirstCommitHandlerProps

Name	Type	Description
branchName	string	The branch name used in the CodeCommit repo.
codeCommitRepoArn	string	The ARN of the CodeCommit repository.
repoName	string	The name of the CodeCommit repo.
functionName?	string	The name of the Lambda function which deals with first commit via AWS CodeCommit. Default: 'FirstCommitHandler'
roleName?	string	The name of the IAM role for the Lambda function which deals with first commit via AWS CodeCommit. Default: 'LambdaForInitialCommitRole'

struct IamRoleProps

Name	Type	Description
accountID	string	The ID of your infrastructure account.
environment	string	'preproduction' or 'production'.
roleName?	string	The role name. Default: '{environment}-Databrew-Cicd-Role'

struct InfraIamRoleProps

Name	Type	Description
roleName?	string	The role name for the infrastructure account. Default: 'CrossAccountRepositoryContributorRole'

struct PreProductionLambdaProps

Name	Type	Description
bucketArn	string	The ARN of the S3 bucket for the DataBrew CICD pipeline.
preproductionIamRoleArn	string	The ARN of the IAM role in the pre-production account.
functionName?	string	The Lambda funciton name for the pre-production account. Default: 'PreProd-DataBrew-Recipe-Deployer'
roleName?	string	The name of the IAM role for the pre-produciton Lambda function. Default: 'PreProd-DataBrew-Recipe-Deployer-role'

struct ProductionLambdaProps

Name	Type	Description
bucketArn	string	The ARN of the S3 bucket for the DataBrew CICD pipeline.
productionIamRoleArn	string	The ARN of the IAM role in the production account.
functionName?	string	The Lambda funciton name for the production account. Default: 'Prod-DataBrew-Recipe-Deployer'
roleName?	string	The name of the IAM role for the produciton Lambda function. Default: 'Prod-DataBrew-Recipe-Deployer-role'