# API Reference
## Constructs
### CodePipelineIamRole
#### Initializers
```typescript
import { CodePipelineIamRole } from 'cdk-databrew-cicd'
new CodePipelineIamRole(scope: Construct, name: string, props: CodePipelineIamRoleProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| name | string | *No description.* |
| props | CodePipelineIamRoleProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `name`Required
- *Type:* string
---
##### `props`Required
- *Type:* CodePipelineIamRoleProps
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
---
##### `isConstruct`
```typescript
import { CodePipelineIamRole } from 'cdk-databrew-cicd'
CodePipelineIamRole.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.
###### `x`Required
- *Type:* any
Any object.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
| role | aws-cdk-lib.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. |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `role`Required
```typescript
public readonly role: Role;
```
- *Type:* aws-cdk-lib.aws_iam.Role
The representative of the IAM role for the CodePipeline CICD pipeline.
---
##### `roleArn`Required
```typescript
public readonly roleArn: string;
```
- *Type:* string
The ARN of the IAM role for the CodePipeline CICD pipeline.
---
### DataBrewCodePipeline
#### Initializers
```typescript
import { DataBrewCodePipeline } from 'cdk-databrew-cicd'
new DataBrewCodePipeline(scope: Construct, name: string, props: DataBrewCodePipelineProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| name | string | *No description.* |
| props | DataBrewCodePipelineProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `name`Required
- *Type:* string
---
##### `props`Required
- *Type:* DataBrewCodePipelineProps
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
---
##### `isConstruct`
```typescript
import { DataBrewCodePipeline } from 'cdk-databrew-cicd'
DataBrewCodePipeline.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.
###### `x`Required
- *Type:* any
Any object.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
| 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. |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `branchName`Required
```typescript
public readonly branchName: string;
```
- *Type:* string
The name of the branch that will trigger the DataBrew CICD pipeline.
---
##### `bucketArn`Required
```typescript
public readonly bucketArn: string;
```
- *Type:* string
The ARN of the S3 bucket for the CodePipeline DataBrew CICD pipeline.
---
##### `codeCommitRepoArn`Required
```typescript
public readonly codeCommitRepoArn: string;
```
- *Type:* string
The ARN of the CodeCommit repository.
---
##### `codePipelineArn`Required
```typescript
public readonly codePipelineArn: string;
```
- *Type:* string
The ARN of the DataBrew CICD pipeline.
---
##### `firstStageArtifactName`Required
```typescript
public readonly firstStageArtifactName: string;
```
- *Type:* string
the (required) name of the Artifact at the first stage.
---
##### `preproductionFunctionArn`Required
```typescript
public readonly preproductionFunctionArn: string;
```
- *Type:* string
The ARN of the Lambda function for the pre-production account.
---
##### `productionFunctionArn`Required
```typescript
public readonly productionFunctionArn: string;
```
- *Type:* string
The ARN of the Lambda function for the production account.
---
##### `repoName`Required
```typescript
public readonly repoName: string;
```
- *Type:* string
The name of the CodeCommit repositroy for the DataBrew CICD pipeline.
---
### FirstCommitHandler
#### Initializers
```typescript
import { FirstCommitHandler } from 'cdk-databrew-cicd'
new FirstCommitHandler(scope: Construct, name: string, props: FirstCommitHandlerProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| name | string | *No description.* |
| props | FirstCommitHandlerProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `name`Required
- *Type:* string
---
##### `props`Required
- *Type:* FirstCommitHandlerProps
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
---
##### `isConstruct`
```typescript
import { FirstCommitHandler } from 'cdk-databrew-cicd'
FirstCommitHandler.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.
###### `x`Required
- *Type:* any
Any object.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
| function | aws-cdk-lib.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. |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `function`Required
```typescript
public readonly function: IFunction;
```
- *Type:* aws-cdk-lib.aws_lambda.IFunction
The representative of Lambda function which deals with first commit via AWS CodeCommit.
---
##### `functionName`Required
```typescript
public readonly functionName: string;
```
- *Type:* string
The name of the Lambda function which deals with first commit via AWS CodeCommit.
---
##### `roleName`Required
```typescript
public readonly roleName: string;
```
- *Type:* string
The name of the IAM role for the Lambda function which deals with first commit via AWS CodeCommit.
---
### IamRole
IAM Role.
Defines an IAM role for pre-production and production AWS accounts.
#### Initializers
```typescript
import { IamRole } from 'cdk-databrew-cicd'
new IamRole(scope: Construct, name: string, props: IamRoleProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| name | string | *No description.* |
| props | IamRoleProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `name`Required
- *Type:* string
---
##### `props`Required
- *Type:* IamRoleProps
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
---
##### `isConstruct`
```typescript
import { IamRole } from 'cdk-databrew-cicd'
IamRole.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.
###### `x`Required
- *Type:* any
Any object.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
| roleArn | string | The ARN of the IAM role for pre-production or production. |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `roleArn`Required
```typescript
public readonly roleArn: string;
```
- *Type:* string
The ARN of the IAM role for pre-production or production.
---
### InfraIamRole
#### Initializers
```typescript
import { InfraIamRole } from 'cdk-databrew-cicd'
new InfraIamRole(scope: Construct, name: string, props: InfraIamRoleProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| name | string | *No description.* |
| props | InfraIamRoleProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `name`Required
- *Type:* string
---
##### `props`Required
- *Type:* InfraIamRoleProps
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
---
##### `isConstruct`
```typescript
import { InfraIamRole } from 'cdk-databrew-cicd'
InfraIamRole.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.
###### `x`Required
- *Type:* any
Any object.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
| roleArn | string | The ARN of the IAM role for the infrastructure account. |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `roleArn`Required
```typescript
public readonly roleArn: string;
```
- *Type:* string
The ARN of the IAM role for the infrastructure account.
---
### PreProductionLambda
#### Initializers
```typescript
import { PreProductionLambda } from 'cdk-databrew-cicd'
new PreProductionLambda(scope: Construct, name: string, props: PreProductionLambdaProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| name | string | *No description.* |
| props | PreProductionLambdaProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `name`Required
- *Type:* string
---
##### `props`Required
- *Type:* PreProductionLambdaProps
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
---
##### `isConstruct`
```typescript
import { PreProductionLambda } from 'cdk-databrew-cicd'
PreProductionLambda.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.
###### `x`Required
- *Type:* any
Any object.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
| function | aws-cdk-lib.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. |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `function`Required
```typescript
public readonly function: IFunction;
```
- *Type:* aws-cdk-lib.aws_lambda.IFunction
The representative of Lambda function for the pre-production account.
---
##### `functionName`Required
```typescript
public readonly functionName: string;
```
- *Type:* string
The Lambda funciton name for the pre-production account.
---
##### `roleName`Required
```typescript
public readonly roleName: string;
```
- *Type:* string
The name of the IAM role for the pre-produciton Lambda function.
---
### ProductionLambda
#### Initializers
```typescript
import { ProductionLambda } from 'cdk-databrew-cicd'
new ProductionLambda(scope: Construct, name: string, props: ProductionLambdaProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| name | string | *No description.* |
| props | ProductionLambdaProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `name`Required
- *Type:* string
---
##### `props`Required
- *Type:* ProductionLambdaProps
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
---
##### `isConstruct`
```typescript
import { ProductionLambda } from 'cdk-databrew-cicd'
ProductionLambda.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.
###### `x`Required
- *Type:* any
Any object.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
| function | aws-cdk-lib.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. |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `function`Required
```typescript
public readonly function: IFunction;
```
- *Type:* aws-cdk-lib.aws_lambda.IFunction
The representative of Lambda function for the production account.
---
##### `functionName`Required
```typescript
public readonly functionName: string;
```
- *Type:* string
The Lambda funciton name for the production account.
---
##### `roleName`Required
```typescript
public readonly roleName: string;
```
- *Type:* string
The name of the IAM role for the produciton Lambda function.
---
## Structs
### CodePipelineIamRoleProps
#### Initializer
```typescript
import { CodePipelineIamRoleProps } from 'cdk-databrew-cicd'
const codePipelineIamRoleProps: CodePipelineIamRoleProps = { ... }
```
#### Properties
| **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. |
---
##### `bucketArn`Required
```typescript
public readonly bucketArn: string;
```
- *Type:* string
The ARN of the S3 bucket where you store your artifacts.
---
##### `preproductionLambdaArn`Required
```typescript
public readonly preproductionLambdaArn: string;
```
- *Type:* string
The ARN of the Lambda function for the pre-production account.
---
##### `productionLambdaArn`Required
```typescript
public readonly productionLambdaArn: string;
```
- *Type:* string
The ARN of the Lambda function for the production account.
---
##### `roleName`Optional
```typescript
public readonly roleName: string;
```
- *Type:* string
- *Default:* 'DataBrew-Recipe-Pipeline-Role'
The role name for the CodePipeline CICD pipeline.
---
### DataBrewCodePipelineProps
#### Initializer
```typescript
import { DataBrewCodePipelineProps } from 'cdk-databrew-cicd'
const dataBrewCodePipelineProps: DataBrewCodePipelineProps = { ... }
```
#### Properties
| **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. |
| bucketName | string | The name of the S3 bucket for the CodePipeline DataBrew CICD pipeline. |
| firstStageArtifactName | string | the (required) name of the Artifact at the first stage. |
| pipelineName | string | The name of the CodePipeline Databrew CICD pipeline. |
| repoName | string | The name of the CodeCommit repositroy for the DataBrew CICD pipeline. |
---
##### `preproductionIamRoleArn`Required
```typescript
public readonly preproductionIamRoleArn: string;
```
- *Type:* string
The ARN of the IAM role in the pre-production account.
---
##### `productionIamRoleArn`Required
```typescript
public readonly productionIamRoleArn: string;
```
- *Type:* string
The ARN of the IAM role in the production account.
---
##### `branchName`Optional
```typescript
public readonly branchName: string;
```
- *Type:* string
- *Default:* 'main'
The name of the branch that will trigger the DataBrew CICD pipeline.
---
##### `bucketName`Optional
```typescript
public readonly bucketName: string;
```
- *Type:* string
- *Default:* 'databrew-cicd-codepipelineartifactstorebucket'
The name of the S3 bucket for the CodePipeline DataBrew CICD pipeline.
---
##### `firstStageArtifactName`Optional
```typescript
public readonly firstStageArtifactName: string;
```
- *Type:* string
- *Default:* 'SourceOutput'
the (required) name of the Artifact at the first stage.
---
##### `pipelineName`Optional
```typescript
public readonly pipelineName: string;
```
- *Type:* string
- *Default:* 'DataBrew-Recipe-Application'
The name of the CodePipeline Databrew CICD pipeline.
---
##### `repoName`Optional
```typescript
public readonly repoName: string;
```
- *Type:* string
- *Default:* 'DataBrew-Recipes-Repo'
The name of the CodeCommit repositroy for the DataBrew CICD pipeline.
---
### FirstCommitHandlerProps
#### Initializer
```typescript
import { FirstCommitHandlerProps } from 'cdk-databrew-cicd'
const firstCommitHandlerProps: FirstCommitHandlerProps = { ... }
```
#### Properties
| **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. |
| roleName | string | The name of the IAM role for the Lambda function which deals with first commit via AWS CodeCommit. |
---
##### `branchName`Required
```typescript
public readonly branchName: string;
```
- *Type:* string
The branch name used in the CodeCommit repo.
---
##### `codeCommitRepoArn`Required
```typescript
public readonly codeCommitRepoArn: string;
```
- *Type:* string
The ARN of the CodeCommit repository.
---
##### `repoName`Required
```typescript
public readonly repoName: string;
```
- *Type:* string
The name of the CodeCommit repo.
---
##### `functionName`Optional
```typescript
public readonly functionName: string;
```
- *Type:* string
- *Default:* 'FirstCommitHandler'
The name of the Lambda function which deals with first commit via AWS CodeCommit.
---
##### `roleName`Optional
```typescript
public readonly roleName: string;
```
- *Type:* string
- *Default:* 'LambdaForInitialCommitRole'
The name of the IAM role for the Lambda function which deals with first commit via AWS CodeCommit.
---
### IamRoleProps
#### Initializer
```typescript
import { IamRoleProps } from 'cdk-databrew-cicd'
const iamRoleProps: IamRoleProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| accountID | string | The ID of your infrastructure account. |
| environment | string | 'preproduction' or 'production'. |
| roleName | string | The role name. |
---
##### `accountID`Required
```typescript
public readonly accountID: string;
```
- *Type:* string
The ID of your infrastructure account.
---
##### `environment`Required
```typescript
public readonly environment: string;
```
- *Type:* string
'preproduction' or 'production'.
---
##### `roleName`Optional
```typescript
public readonly roleName: string;
```
- *Type:* string
- *Default:* '{environment}-Databrew-Cicd-Role'
The role name.
---
### InfraIamRoleProps
#### Initializer
```typescript
import { InfraIamRoleProps } from 'cdk-databrew-cicd'
const infraIamRoleProps: InfraIamRoleProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| roleName | string | The role name for the infrastructure account. |
---
##### `roleName`Optional
```typescript
public readonly roleName: string;
```
- *Type:* string
- *Default:* 'CrossAccountRepositoryContributorRole'
The role name for the infrastructure account.
---
### PreProductionLambdaProps
#### Initializer
```typescript
import { PreProductionLambdaProps } from 'cdk-databrew-cicd'
const preProductionLambdaProps: PreProductionLambdaProps = { ... }
```
#### Properties
| **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. |
| roleName | string | The name of the IAM role for the pre-produciton Lambda function. |
---
##### `bucketArn`Required
```typescript
public readonly bucketArn: string;
```
- *Type:* string
The ARN of the S3 bucket for the DataBrew CICD pipeline.
---
##### `preproductionIamRoleArn`Required
```typescript
public readonly preproductionIamRoleArn: string;
```
- *Type:* string
The ARN of the IAM role in the pre-production account.
---
##### `functionName`Optional
```typescript
public readonly functionName: string;
```
- *Type:* string
- *Default:* 'PreProd-DataBrew-Recipe-Deployer'
The Lambda funciton name for the pre-production account.
---
##### `roleName`Optional
```typescript
public readonly roleName: string;
```
- *Type:* string
- *Default:* 'PreProd-DataBrew-Recipe-Deployer-role'
The name of the IAM role for the pre-produciton Lambda function.
---
### ProductionLambdaProps
#### Initializer
```typescript
import { ProductionLambdaProps } from 'cdk-databrew-cicd'
const productionLambdaProps: ProductionLambdaProps = { ... }
```
#### Properties
| **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. |
| roleName | string | The name of the IAM role for the produciton Lambda function. |
---
##### `bucketArn`Required
```typescript
public readonly bucketArn: string;
```
- *Type:* string
The ARN of the S3 bucket for the DataBrew CICD pipeline.
---
##### `productionIamRoleArn`Required
```typescript
public readonly productionIamRoleArn: string;
```
- *Type:* string
The ARN of the IAM role in the production account.
---
##### `functionName`Optional
```typescript
public readonly functionName: string;
```
- *Type:* string
- *Default:* 'Prod-DataBrew-Recipe-Deployer'
The Lambda funciton name for the production account.
---
##### `roleName`Optional
```typescript
public readonly roleName: string;
```
- *Type:* string
- *Default:* 'Prod-DataBrew-Recipe-Deployer-role'
The name of the IAM role for the produciton Lambda function.
---