# API Reference ## Constructs ### AppFlowIngestionStage Stage that contains a step function that runs an AppFlow flow ingestion. If the AppFlow flow name is not supplied, then the flow is created. #### Initializers ```typescript import { AppFlowIngestionStage } from 'aws-ddk-core' new AppFlowIngestionStage(scope: Construct, id: string, props: AppFlowIngestionStageProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | Scope within which this construct is defined. | | id | string | Identifier of the stage. | | props | AppFlowIngestionStageProps | Properties for the stage. | --- ##### `scope`^Required - *Type:* constructs.Construct Scope within which this construct is defined. --- ##### `id`^Required - *Type:* string Identifier of the stage. --- ##### `props`^Required - *Type:* AppFlowIngestionStageProps Properties for the stage. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | addAlarm | Add a CloudWatch alarm for the DataStage. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `addAlarm` ```typescript public addAlarm(id: string, props: AlarmProps): DataStage ``` Add a CloudWatch alarm for the DataStage. ###### `id`^Required - *Type:* string Identifier of the CloudWatch Alarm. --- ###### `props`^Required - *Type:* AlarmProps Properties for the alarm. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { AppFlowIngestionStage } from 'aws-ddk-core' AppFlowIngestionStage.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | description | string | Description of the stage. | | eventPattern | aws-cdk-lib.aws_events.EventPattern | Output event pattern of the stage. | | name | string | Name of the stage. | | targets | aws-cdk-lib.aws_events.IRuleTarget[] | Input targets for the stage. | | alarmsEnabled | boolean | Flag indicating whether the alarms are enabled for this stage. | | cloudwatchAlarms | aws-cdk-lib.aws_cloudwatch.Alarm[] | List of CloudWatch Alarms linked to the stage. | | stateMachine | aws-cdk-lib.aws_stepfunctions.StateMachine | State machine. | | flowName | string | *No description.* | | flowObject | aws-cdk-lib.aws_stepfunctions_tasks.CallAwsService | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string Description of the stage. --- ##### `eventPattern`^Optional ```typescript public readonly eventPattern: EventPattern; ``` - *Type:* aws-cdk-lib.aws_events.EventPattern Output event pattern of the stage. Event pattern describes the structure of output event(s) produced by this stage. Event Rules use event patterns to select events and route them to targets. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Name of the stage. --- ##### `targets`^Optional ```typescript public readonly targets: IRuleTarget[]; ``` - *Type:* aws-cdk-lib.aws_events.IRuleTarget[] Input targets for the stage. Targets are used by Event Rules to describe what should be invoked when a rule matches an event. --- ##### `alarmsEnabled`^Required ```typescript public readonly alarmsEnabled: boolean; ``` - *Type:* boolean Flag indicating whether the alarms are enabled for this stage. --- ##### `cloudwatchAlarms`^Required ```typescript public readonly cloudwatchAlarms: Alarm[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.Alarm[] List of CloudWatch Alarms linked to the stage. --- ##### `stateMachine`^Required ```typescript public readonly stateMachine: StateMachine; ``` - *Type:* aws-cdk-lib.aws_stepfunctions.StateMachine State machine. --- ##### `flowName`^Required ```typescript public readonly flowName: string; ``` - *Type:* string --- ##### `flowObject`^Required ```typescript public readonly flowObject: CallAwsService; ``` - *Type:* aws-cdk-lib.aws_stepfunctions_tasks.CallAwsService --- ### AthenaSQLStage Stage that contains a step function that execute Athena SQL query. #### Initializers ```typescript import { AthenaSQLStage } from 'aws-ddk-core' new AthenaSQLStage(scope: Construct, id: string, props: AthenaToSQLStageProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | Scope within which this construct is defined. | | id | string | Identifier of the stage. | | props | AthenaToSQLStageProps | Properties for the stage. | --- ##### `scope`^Required - *Type:* constructs.Construct Scope within which this construct is defined. --- ##### `id`^Required - *Type:* string Identifier of the stage. --- ##### `props`^Required - *Type:* AthenaToSQLStageProps Properties for the stage. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | addAlarm | Add a CloudWatch alarm for the DataStage. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `addAlarm` ```typescript public addAlarm(id: string, props: AlarmProps): DataStage ``` Add a CloudWatch alarm for the DataStage. ###### `id`^Required - *Type:* string Identifier of the CloudWatch Alarm. --- ###### `props`^Required - *Type:* AlarmProps Properties for the alarm. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { AthenaSQLStage } from 'aws-ddk-core' AthenaSQLStage.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | description | string | Description of the stage. | | eventPattern | aws-cdk-lib.aws_events.EventPattern | Output event pattern of the stage. | | name | string | Name of the stage. | | targets | aws-cdk-lib.aws_events.IRuleTarget[] | Input targets for the stage. | | alarmsEnabled | boolean | Flag indicating whether the alarms are enabled for this stage. | | cloudwatchAlarms | aws-cdk-lib.aws_cloudwatch.Alarm[] | List of CloudWatch Alarms linked to the stage. | | stateMachine | aws-cdk-lib.aws_stepfunctions.StateMachine | State machine. | | eventBridgeEventPath | string | *No description.* | | stateMachineInput | {[ key: string ]: any} | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string Description of the stage. --- ##### `eventPattern`^Optional ```typescript public readonly eventPattern: EventPattern; ``` - *Type:* aws-cdk-lib.aws_events.EventPattern Output event pattern of the stage. Event pattern describes the structure of output event(s) produced by this stage. Event Rules use event patterns to select events and route them to targets. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Name of the stage. --- ##### `targets`^Optional ```typescript public readonly targets: IRuleTarget[]; ``` - *Type:* aws-cdk-lib.aws_events.IRuleTarget[] Input targets for the stage. Targets are used by Event Rules to describe what should be invoked when a rule matches an event. --- ##### `alarmsEnabled`^Required ```typescript public readonly alarmsEnabled: boolean; ``` - *Type:* boolean Flag indicating whether the alarms are enabled for this stage. --- ##### `cloudwatchAlarms`^Required ```typescript public readonly cloudwatchAlarms: Alarm[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.Alarm[] List of CloudWatch Alarms linked to the stage. --- ##### `stateMachine`^Required ```typescript public readonly stateMachine: StateMachine; ``` - *Type:* aws-cdk-lib.aws_stepfunctions.StateMachine State machine. --- ##### `eventBridgeEventPath`^Optional ```typescript public readonly eventBridgeEventPath: string; ``` - *Type:* string --- ##### `stateMachineInput`^Optional ```typescript public readonly stateMachineInput: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} --- ### BaseStack Base Stack to inherit from. Includes configurable termination protection, synthesizer, permissions boundary and tags. #### Initializers ```typescript import { BaseStack } from 'aws-ddk-core' new BaseStack(scope: Construct, id: string, props: BaseStackProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | Scope within which this construct is defined. | | id | string | Identifier of the stack. | | props | BaseStackProps | Stack properties. | --- ##### `scope`^Required - *Type:* constructs.Construct Scope within which this construct is defined. --- ##### `id`^Required - *Type:* string Identifier of the stack. --- ##### `props`^Required - *Type:* BaseStackProps Stack properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | addDependency | Add a dependency between this stack and another stack. | | addMetadata | Adds an arbitrary key-value pair, with information you want to record about the stack. | | addTransform | Add a Transform to this stack. A Transform is a macro that AWS CloudFormation uses to process your template. | | exportStringListValue | Create a CloudFormation Export for a string list value. | | exportValue | Create a CloudFormation Export for a string value. | | formatArn | Creates an ARN from components. | | getLogicalId | Allocates a stack-unique CloudFormation-compatible logical identity for a specific resource. | | regionalFact | Look up a fact value for the given fact for the region of this stack. | | renameLogicalId | Rename a generated logical identities. | | reportMissingContextKey | Indicate that a context key was expected. | | resolve | Resolve a tokenized value in the context of the current stack. | | splitArn | Splits the provided ARN into its components. | | toJsonString | Convert an object, potentially containing tokens, to a JSON string. | | toYamlString | Convert an object, potentially containing tokens, to a YAML string. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `addDependency` ```typescript public addDependency(target: Stack, reason?: string): void ``` Add a dependency between this stack and another stack. This can be used to define dependencies between any two stacks within an app, and also supports nested stacks. ###### `target`^Required - *Type:* aws-cdk-lib.Stack --- ###### `reason`^Optional - *Type:* string --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Adds an arbitrary key-value pair, with information you want to record about the stack. These get translated to the Metadata section of the generated template. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addTransform` ```typescript public addTransform(transform: string): void ``` Add a Transform to this stack. A Transform is a macro that AWS CloudFormation uses to process your template. Duplicate values are removed when stack is synthesized. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html) *Example* ```typescript declare const stack: Stack; stack.addTransform('AWS::Serverless-2016-10-31') ``` ###### `transform`^Required - *Type:* string The transform to add. --- ##### `exportStringListValue` ```typescript public exportStringListValue(exportedValue: any, options?: ExportValueOptions): string[] ``` Create a CloudFormation Export for a string list value. Returns a string list representing the corresponding `Fn.importValue()` expression for this Export. The export expression is automatically wrapped with an `Fn::Join` and the import value with an `Fn::Split`, since CloudFormation can only export strings. You can control the name for the export by passing the `name` option. If you don't supply a value for `name`, the value you're exporting must be a Resource attribute (for example: `bucket.bucketName`) and it will be given the same name as the automatic cross-stack reference that would be created if you used the attribute in another Stack. One of the uses for this method is to *remove* the relationship between two Stacks established by automatic cross-stack references. It will temporarily ensure that the CloudFormation Export still exists while you remove the reference from the consuming stack. After that, you can remove the resource and the manual export. See `exportValue` for an example of this process. ###### `exportedValue`^Required - *Type:* any --- ###### `options`^Optional - *Type:* aws-cdk-lib.ExportValueOptions --- ##### `exportValue` ```typescript public exportValue(exportedValue: any, options?: ExportValueOptions): string ``` Create a CloudFormation Export for a string value. Returns a string representing the corresponding `Fn.importValue()` expression for this Export. You can control the name for the export by passing the `name` option. If you don't supply a value for `name`, the value you're exporting must be a Resource attribute (for example: `bucket.bucketName`) and it will be given the same name as the automatic cross-stack reference that would be created if you used the attribute in another Stack. One of the uses for this method is to *remove* the relationship between two Stacks established by automatic cross-stack references. It will temporarily ensure that the CloudFormation Export still exists while you remove the reference from the consuming stack. After that, you can remove the resource and the manual export. ###### `exportedValue`^Required - *Type:* any --- ###### `options`^Optional - *Type:* aws-cdk-lib.ExportValueOptions --- ##### `formatArn` ```typescript public formatArn(components: ArnComponents): string ``` Creates an ARN from components. If `partition`, `region` or `account` are not specified, the stack's partition, region and account will be used. If any component is the empty string, an empty string will be inserted into the generated ARN at the location that component corresponds to. The ARN will be formatted as follows: arn:{partition}:{service}:{region}:{account}:{resource}{sep}{resource-name} The required ARN pieces that are omitted will be taken from the stack that the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope can be 'undefined'. ###### `components`^Required - *Type:* aws-cdk-lib.ArnComponents --- ##### `getLogicalId` ```typescript public getLogicalId(element: CfnElement): string ``` Allocates a stack-unique CloudFormation-compatible logical identity for a specific resource. This method is called when a `CfnElement` is created and used to render the initial logical identity of resources. Logical ID renames are applied at this stage. This method uses the protected method `allocateLogicalId` to render the logical ID for an element. To modify the naming scheme, extend the `Stack` class and override this method. ###### `element`^Required - *Type:* aws-cdk-lib.CfnElement The CloudFormation element for which a logical identity is needed. --- ##### `regionalFact` ```typescript public regionalFact(factName: string, defaultValue?: string): string ``` Look up a fact value for the given fact for the region of this stack. Will return a definite value only if the region of the current stack is resolved. If not, a lookup map will be added to the stack and the lookup will be done at CDK deployment time. What regions will be included in the lookup map is controlled by the `@aws-cdk/core:target-partitions` context value: it must be set to a list of partitions, and only regions from the given partitions will be included. If no such context key is set, all regions will be included. This function is intended to be used by construct library authors. Application builders can rely on the abstractions offered by construct libraries and do not have to worry about regional facts. If `defaultValue` is not given, it is an error if the fact is unknown for the given region. ###### `factName`^Required - *Type:* string --- ###### `defaultValue`^Optional - *Type:* string --- ##### `renameLogicalId` ```typescript public renameLogicalId(oldId: string, newId: string): void ``` Rename a generated logical identities. To modify the naming scheme strategy, extend the `Stack` class and override the `allocateLogicalId` method. ###### `oldId`^Required - *Type:* string --- ###### `newId`^Required - *Type:* string --- ##### `reportMissingContextKey` ```typescript public reportMissingContextKey(report: MissingContext): void ``` Indicate that a context key was expected. Contains instructions which will be emitted into the cloud assembly on how the key should be supplied. ###### `report`^Required - *Type:* aws-cdk-lib.cloud_assembly_schema.MissingContext The set of parameters needed to obtain the context. --- ##### `resolve` ```typescript public resolve(obj: any): any ``` Resolve a tokenized value in the context of the current stack. ###### `obj`^Required - *Type:* any --- ##### `splitArn` ```typescript public splitArn(arn: string, arnFormat: ArnFormat): ArnComponents ``` Splits the provided ARN into its components. Works both if 'arn' is a string like 'arn:aws:s3:::bucket', and a Token representing a dynamic CloudFormation expression (in which case the returned components will also be dynamic CloudFormation expressions, encoded as Tokens). ###### `arn`^Required - *Type:* string the ARN to split into its components. --- ###### `arnFormat`^Required - *Type:* aws-cdk-lib.ArnFormat the expected format of 'arn' - depends on what format the service 'arn' represents uses. --- ##### `toJsonString` ```typescript public toJsonString(obj: any, space?: number): string ``` Convert an object, potentially containing tokens, to a JSON string. ###### `obj`^Required - *Type:* any --- ###### `space`^Optional - *Type:* number --- ##### `toYamlString` ```typescript public toYamlString(obj: any): string ``` Convert an object, potentially containing tokens, to a YAML string. ###### `obj`^Required - *Type:* any --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isStack | Return whether the given object is a Stack. | | of | Looks up the first stack scope in which `construct` is defined. | | createDefaultPermissionsBoundary | *No description.* | --- ##### ~~`isConstruct`~~ ```typescript import { BaseStack } from 'aws-ddk-core' BaseStack.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isStack` ```typescript import { BaseStack } from 'aws-ddk-core' BaseStack.isStack(x: any) ``` Return whether the given object is a Stack. We do attribute detection since we can't reliably use 'instanceof'. ###### `x`^Required - *Type:* any --- ##### `of` ```typescript import { BaseStack } from 'aws-ddk-core' BaseStack.of(construct: IConstruct) ``` Looks up the first stack scope in which `construct` is defined. Fails if there is no stack up the tree. ###### `construct`^Required - *Type:* constructs.IConstruct The construct to start the search from. --- ##### `createDefaultPermissionsBoundary` ```typescript import { BaseStack } from 'aws-ddk-core' BaseStack.createDefaultPermissionsBoundary(scope: Construct, id: string, props: PermissionsBoundaryProps) ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `props`^Required - *Type:* PermissionsBoundaryProps --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | account | string | The AWS account into which this stack will be deployed. | | artifactId | string | The ID of the cloud assembly artifact for this stack. | | availabilityZones | string[] | Returns the list of AZs that are available in the AWS environment (account/region) associated with this stack. | | bundlingRequired | boolean | Indicates whether the stack requires bundling or not. | | dependencies | aws-cdk-lib.Stack[] | Return the stacks this stack depends on. | | environment | string | The environment coordinates in which this stack is deployed. | | nested | boolean | Indicates if this is a nested stack, in which case `parentStack` will include a reference to it's parent. | | notificationArns | string[] | Returns the list of notification Amazon Resource Names (ARNs) for the current stack. | | partition | string | The partition in which this stack is defined. | | region | string | The AWS region into which this stack will be deployed (e.g. `us-west-2`). | | stackId | string | The ID of the stack. | | stackName | string | The concrete CloudFormation physical stack name. | | synthesizer | aws-cdk-lib.IStackSynthesizer | Synthesis method for this stack. | | tags | aws-cdk-lib.TagManager | Tags to be applied to the stack. | | templateFile | string | The name of the CloudFormation template file emitted to the output directory during synthesis. | | templateOptions | aws-cdk-lib.ITemplateOptions | Options for CloudFormation template (like version, transform, description). | | urlSuffix | string | The Amazon domain suffix for the region in which this stack is defined. | | nestedStackParent | aws-cdk-lib.Stack | If this is a nested stack, returns it's parent stack. | | nestedStackResource | aws-cdk-lib.CfnResource | If this is a nested stack, this represents its `AWS::CloudFormation::Stack` resource. | | terminationProtection | boolean | Whether termination protection is enabled for this stack. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `account`^Required ```typescript public readonly account: string; ``` - *Type:* string The AWS account into which this stack will be deployed. This value is resolved according to the following rules: 1. The value provided to `env.account` when the stack is defined. This can either be a concrete account (e.g. `585695031111`) or the `Aws.ACCOUNT_ID` token. 3. `Aws.ACCOUNT_ID`, which represents the CloudFormation intrinsic reference `{ "Ref": "AWS::AccountId" }` encoded as a string token. Preferably, you should use the return value as an opaque string and not attempt to parse it to implement your logic. If you do, you must first check that it is a concrete value an not an unresolved token. If this value is an unresolved token (`Token.isUnresolved(stack.account)` returns `true`), this implies that the user wishes that this stack will synthesize into a **account-agnostic template**. In this case, your code should either fail (throw an error, emit a synth error using `Annotations.of(construct).addError()`) or implement some other region-agnostic behavior. --- ##### `artifactId`^Required ```typescript public readonly artifactId: string; ``` - *Type:* string The ID of the cloud assembly artifact for this stack. --- ##### `availabilityZones`^Required ```typescript public readonly availabilityZones: string[]; ``` - *Type:* string[] Returns the list of AZs that are available in the AWS environment (account/region) associated with this stack. If the stack is environment-agnostic (either account and/or region are tokens), this property will return an array with 2 tokens that will resolve at deploy-time to the first two availability zones returned from CloudFormation's `Fn::GetAZs` intrinsic function. If they are not available in the context, returns a set of dummy values and reports them as missing, and let the CLI resolve them by calling EC2 `DescribeAvailabilityZones` on the target environment. To specify a different strategy for selecting availability zones override this method. --- ##### `bundlingRequired`^Required ```typescript public readonly bundlingRequired: boolean; ``` - *Type:* boolean Indicates whether the stack requires bundling or not. --- ##### `dependencies`^Required ```typescript public readonly dependencies: Stack[]; ``` - *Type:* aws-cdk-lib.Stack[] Return the stacks this stack depends on. --- ##### `environment`^Required ```typescript public readonly environment: string; ``` - *Type:* string The environment coordinates in which this stack is deployed. In the form `aws://account/region`. Use `stack.account` and `stack.region` to obtain the specific values, no need to parse. You can use this value to determine if two stacks are targeting the same environment. If either `stack.account` or `stack.region` are not concrete values (e.g. `Aws.ACCOUNT_ID` or `Aws.REGION`) the special strings `unknown-account` and/or `unknown-region` will be used respectively to indicate this stack is region/account-agnostic. --- ##### `nested`^Required ```typescript public readonly nested: boolean; ``` - *Type:* boolean Indicates if this is a nested stack, in which case `parentStack` will include a reference to it's parent. --- ##### `notificationArns`^Required ```typescript public readonly notificationArns: string[]; ``` - *Type:* string[] Returns the list of notification Amazon Resource Names (ARNs) for the current stack. --- ##### `partition`^Required ```typescript public readonly partition: string; ``` - *Type:* string The partition in which this stack is defined. --- ##### `region`^Required ```typescript public readonly region: string; ``` - *Type:* string The AWS region into which this stack will be deployed (e.g. `us-west-2`). This value is resolved according to the following rules: 1. The value provided to `env.region` when the stack is defined. This can either be a concrete region (e.g. `us-west-2`) or the `Aws.REGION` token. 3. `Aws.REGION`, which is represents the CloudFormation intrinsic reference `{ "Ref": "AWS::Region" }` encoded as a string token. Preferably, you should use the return value as an opaque string and not attempt to parse it to implement your logic. If you do, you must first check that it is a concrete value an not an unresolved token. If this value is an unresolved token (`Token.isUnresolved(stack.region)` returns `true`), this implies that the user wishes that this stack will synthesize into a **region-agnostic template**. In this case, your code should either fail (throw an error, emit a synth error using `Annotations.of(construct).addError()`) or implement some other region-agnostic behavior. --- ##### `stackId`^Required ```typescript public readonly stackId: string; ``` - *Type:* string The ID of the stack. --- *Example* ```typescript // After resolving, looks like 'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123' ``` ##### `stackName`^Required ```typescript public readonly stackName: string; ``` - *Type:* string The concrete CloudFormation physical stack name. This is either the name defined explicitly in the `stackName` prop or allocated based on the stack's location in the construct tree. Stacks that are directly defined under the app use their construct `id` as their stack name. Stacks that are defined deeper within the tree will use a hashed naming scheme based on the construct path to ensure uniqueness. If you wish to obtain the deploy-time AWS::StackName intrinsic, you can use `Aws.STACK_NAME` directly. --- ##### `synthesizer`^Required ```typescript public readonly synthesizer: IStackSynthesizer; ``` - *Type:* aws-cdk-lib.IStackSynthesizer Synthesis method for this stack. --- ##### `tags`^Required ```typescript public readonly tags: TagManager; ``` - *Type:* aws-cdk-lib.TagManager Tags to be applied to the stack. --- ##### `templateFile`^Required ```typescript public readonly templateFile: string; ``` - *Type:* string The name of the CloudFormation template file emitted to the output directory during synthesis. Example value: `MyStack.template.json` --- ##### `templateOptions`^Required ```typescript public readonly templateOptions: ITemplateOptions; ``` - *Type:* aws-cdk-lib.ITemplateOptions Options for CloudFormation template (like version, transform, description). --- ##### `urlSuffix`^Required ```typescript public readonly urlSuffix: string; ``` - *Type:* string The Amazon domain suffix for the region in which this stack is defined. --- ##### `nestedStackParent`^Optional ```typescript public readonly nestedStackParent: Stack; ``` - *Type:* aws-cdk-lib.Stack If this is a nested stack, returns it's parent stack. --- ##### `nestedStackResource`^Optional ```typescript public readonly nestedStackResource: CfnResource; ``` - *Type:* aws-cdk-lib.CfnResource If this is a nested stack, this represents its `AWS::CloudFormation::Stack` resource. `undefined` for top-level (non-nested) stacks. --- ##### `terminationProtection`^Required ```typescript public readonly terminationProtection: boolean; ``` - *Type:* boolean Whether termination protection is enabled for this stack. --- ### CICDPipelineStack Create a stack that contains DDK Continuous Integration and Delivery (CI/CD) pipeline. The pipeline is based on [CDK self-mutating pipeline](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.pipelines-readme.html) but includes several DDK-specific features, including: - Ability to configure some properties via JSON config e.g. manual approvals for application stages - Defaults for source/synth - CodeCommit & cdk synth, with ability to override them - Ability to connect to private artifactory to pull artifacts from at synth - Security best practices - ensures pipeline buckets block non-SSL, and are KMS-encrypted with rotated keys - Builder interface to avoid chunky constructor methods The user should be able to reuse the pipeline in multiple DDK applications hoping to save LOC. *Example* ```typescript const stack = new CICDPipelineStack(app, "dummy-pipeline", { environmentId: "dev", pipelineName: "dummy-pipeline" }) .addSourceAction({ repositoryName: "dummy-repository" }) .addSynthAction() .buildPipeline() .add_checks() .addStage({ stageId: "dev", stage: devStage, manualApprovals: true }) .synth() .add_notifications(); ``` #### Initializers ```typescript import { CICDPipelineStack } from 'aws-ddk-core' new CICDPipelineStack(scope: Construct, id: string, props: CICDPipelineStackProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | Parent of this stack, usually an `App` or a `Stage`, but could be any construct. | | id | string | The construct ID of this stack. | | props | CICDPipelineStackProps | Stack properties. | --- ##### `scope`^Required - *Type:* constructs.Construct Parent of this stack, usually an `App` or a `Stage`, but could be any construct. --- ##### `id`^Required - *Type:* string The construct ID of this stack. If `stackName` is not explicitly defined, this id (and any parent IDs) will be used to determine the physical ID of the stack. --- ##### `props`^Required - *Type:* CICDPipelineStackProps Stack properties. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | addDependency | Add a dependency between this stack and another stack. | | addMetadata | Adds an arbitrary key-value pair, with information you want to record about the stack. | | addTransform | Add a Transform to this stack. A Transform is a macro that AWS CloudFormation uses to process your template. | | exportStringListValue | Create a CloudFormation Export for a string list value. | | exportValue | Create a CloudFormation Export for a string value. | | formatArn | Creates an ARN from components. | | getLogicalId | Allocates a stack-unique CloudFormation-compatible logical identity for a specific resource. | | regionalFact | Look up a fact value for the given fact for the region of this stack. | | renameLogicalId | Rename a generated logical identities. | | reportMissingContextKey | Indicate that a context key was expected. | | resolve | Resolve a tokenized value in the context of the current stack. | | splitArn | Splits the provided ARN into its components. | | toJsonString | Convert an object, potentially containing tokens, to a JSON string. | | toYamlString | Convert an object, potentially containing tokens, to a YAML string. | | addChecks | Add checks to the pipeline (e.g. linting, security, tests...). | | addCustomStage | Add custom stage to the pipeline. | | addNotifications | Add pipeline notifications. | | addSecurityLintStage | Add linting - cfn-nag, and bandit. | | addSourceAction | Add source action. | | addStage | Add application stage to the CICD pipeline. | | addSynthAction | Add synth action. | | addTestStage | Add test - e.g. pytest. | | addWave | Add multiple application stages in parallel to the CICD pipeline. | | buildPipeline | Build the pipeline structure. | | synth | Synthesize the pipeline. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `addDependency` ```typescript public addDependency(target: Stack, reason?: string): void ``` Add a dependency between this stack and another stack. This can be used to define dependencies between any two stacks within an app, and also supports nested stacks. ###### `target`^Required - *Type:* aws-cdk-lib.Stack --- ###### `reason`^Optional - *Type:* string --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Adds an arbitrary key-value pair, with information you want to record about the stack. These get translated to the Metadata section of the generated template. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addTransform` ```typescript public addTransform(transform: string): void ``` Add a Transform to this stack. A Transform is a macro that AWS CloudFormation uses to process your template. Duplicate values are removed when stack is synthesized. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html) *Example* ```typescript declare const stack: Stack; stack.addTransform('AWS::Serverless-2016-10-31') ``` ###### `transform`^Required - *Type:* string The transform to add. --- ##### `exportStringListValue` ```typescript public exportStringListValue(exportedValue: any, options?: ExportValueOptions): string[] ``` Create a CloudFormation Export for a string list value. Returns a string list representing the corresponding `Fn.importValue()` expression for this Export. The export expression is automatically wrapped with an `Fn::Join` and the import value with an `Fn::Split`, since CloudFormation can only export strings. You can control the name for the export by passing the `name` option. If you don't supply a value for `name`, the value you're exporting must be a Resource attribute (for example: `bucket.bucketName`) and it will be given the same name as the automatic cross-stack reference that would be created if you used the attribute in another Stack. One of the uses for this method is to *remove* the relationship between two Stacks established by automatic cross-stack references. It will temporarily ensure that the CloudFormation Export still exists while you remove the reference from the consuming stack. After that, you can remove the resource and the manual export. See `exportValue` for an example of this process. ###### `exportedValue`^Required - *Type:* any --- ###### `options`^Optional - *Type:* aws-cdk-lib.ExportValueOptions --- ##### `exportValue` ```typescript public exportValue(exportedValue: any, options?: ExportValueOptions): string ``` Create a CloudFormation Export for a string value. Returns a string representing the corresponding `Fn.importValue()` expression for this Export. You can control the name for the export by passing the `name` option. If you don't supply a value for `name`, the value you're exporting must be a Resource attribute (for example: `bucket.bucketName`) and it will be given the same name as the automatic cross-stack reference that would be created if you used the attribute in another Stack. One of the uses for this method is to *remove* the relationship between two Stacks established by automatic cross-stack references. It will temporarily ensure that the CloudFormation Export still exists while you remove the reference from the consuming stack. After that, you can remove the resource and the manual export. ###### `exportedValue`^Required - *Type:* any --- ###### `options`^Optional - *Type:* aws-cdk-lib.ExportValueOptions --- ##### `formatArn` ```typescript public formatArn(components: ArnComponents): string ``` Creates an ARN from components. If `partition`, `region` or `account` are not specified, the stack's partition, region and account will be used. If any component is the empty string, an empty string will be inserted into the generated ARN at the location that component corresponds to. The ARN will be formatted as follows: arn:{partition}:{service}:{region}:{account}:{resource}{sep}{resource-name} The required ARN pieces that are omitted will be taken from the stack that the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope can be 'undefined'. ###### `components`^Required - *Type:* aws-cdk-lib.ArnComponents --- ##### `getLogicalId` ```typescript public getLogicalId(element: CfnElement): string ``` Allocates a stack-unique CloudFormation-compatible logical identity for a specific resource. This method is called when a `CfnElement` is created and used to render the initial logical identity of resources. Logical ID renames are applied at this stage. This method uses the protected method `allocateLogicalId` to render the logical ID for an element. To modify the naming scheme, extend the `Stack` class and override this method. ###### `element`^Required - *Type:* aws-cdk-lib.CfnElement The CloudFormation element for which a logical identity is needed. --- ##### `regionalFact` ```typescript public regionalFact(factName: string, defaultValue?: string): string ``` Look up a fact value for the given fact for the region of this stack. Will return a definite value only if the region of the current stack is resolved. If not, a lookup map will be added to the stack and the lookup will be done at CDK deployment time. What regions will be included in the lookup map is controlled by the `@aws-cdk/core:target-partitions` context value: it must be set to a list of partitions, and only regions from the given partitions will be included. If no such context key is set, all regions will be included. This function is intended to be used by construct library authors. Application builders can rely on the abstractions offered by construct libraries and do not have to worry about regional facts. If `defaultValue` is not given, it is an error if the fact is unknown for the given region. ###### `factName`^Required - *Type:* string --- ###### `defaultValue`^Optional - *Type:* string --- ##### `renameLogicalId` ```typescript public renameLogicalId(oldId: string, newId: string): void ``` Rename a generated logical identities. To modify the naming scheme strategy, extend the `Stack` class and override the `allocateLogicalId` method. ###### `oldId`^Required - *Type:* string --- ###### `newId`^Required - *Type:* string --- ##### `reportMissingContextKey` ```typescript public reportMissingContextKey(report: MissingContext): void ``` Indicate that a context key was expected. Contains instructions which will be emitted into the cloud assembly on how the key should be supplied. ###### `report`^Required - *Type:* aws-cdk-lib.cloud_assembly_schema.MissingContext The set of parameters needed to obtain the context. --- ##### `resolve` ```typescript public resolve(obj: any): any ``` Resolve a tokenized value in the context of the current stack. ###### `obj`^Required - *Type:* any --- ##### `splitArn` ```typescript public splitArn(arn: string, arnFormat: ArnFormat): ArnComponents ``` Splits the provided ARN into its components. Works both if 'arn' is a string like 'arn:aws:s3:::bucket', and a Token representing a dynamic CloudFormation expression (in which case the returned components will also be dynamic CloudFormation expressions, encoded as Tokens). ###### `arn`^Required - *Type:* string the ARN to split into its components. --- ###### `arnFormat`^Required - *Type:* aws-cdk-lib.ArnFormat the expected format of 'arn' - depends on what format the service 'arn' represents uses. --- ##### `toJsonString` ```typescript public toJsonString(obj: any, space?: number): string ``` Convert an object, potentially containing tokens, to a JSON string. ###### `obj`^Required - *Type:* any --- ###### `space`^Optional - *Type:* number --- ##### `toYamlString` ```typescript public toYamlString(obj: any): string ``` Convert an object, potentially containing tokens, to a YAML string. ###### `obj`^Required - *Type:* any --- ##### `addChecks` ```typescript public addChecks(): CICDPipelineStack ``` Add checks to the pipeline (e.g. linting, security, tests...). ##### `addCustomStage` ```typescript public addCustomStage(props: AddCustomStageProps): CICDPipelineStack ``` Add custom stage to the pipeline. ###### `props`^Required - *Type:* AddCustomStageProps Properties for adding a custom stage. --- ##### `addNotifications` ```typescript public addNotifications(props?: AddNotificationsProps): CICDPipelineStack ``` Add pipeline notifications. Create notification rule that sends events to the specified SNS topic. ###### `props`^Optional - *Type:* AddNotificationsProps Notification properties. --- ##### `addSecurityLintStage` ```typescript public addSecurityLintStage(props: AddSecurityLintStageProps): CICDPipelineStack ``` Add linting - cfn-nag, and bandit. ###### `props`^Required - *Type:* AddSecurityLintStageProps Security lint properties. --- ##### `addSourceAction` ```typescript public addSourceAction(props: SourceActionProps): CICDPipelineStack ``` Add source action. ###### `props`^Required - *Type:* SourceActionProps Source action properties. --- ##### `addStage` ```typescript public addStage(props: AddApplicationStageProps): CICDPipelineStack ``` Add application stage to the CICD pipeline. This stage deploys your application infrastructure. ###### `props`^Required - *Type:* AddApplicationStageProps Application stage properties. --- ##### `addSynthAction` ```typescript public addSynthAction(props?: SynthActionProps): CICDPipelineStack ``` Add synth action. During synth can connect and pull artifacts from a private artifactory. ###### `props`^Optional - *Type:* SynthActionProps Synth action properties. --- ##### `addTestStage` ```typescript public addTestStage(props: AddTestStageProps): CICDPipelineStack ``` Add test - e.g. pytest. ###### `props`^Required - *Type:* AddTestStageProps Test stage properties. --- ##### `addWave` ```typescript public addWave(props: AddApplicationWaveProps): CICDPipelineStack ``` Add multiple application stages in parallel to the CICD pipeline. ###### `props`^Required - *Type:* AddApplicationWaveProps Application wave properties. --- ##### `buildPipeline` ```typescript public buildPipeline(props?: AdditionalPipelineProps): CICDPipelineStack ``` Build the pipeline structure. ###### `props`^Optional - *Type:* AdditionalPipelineProps Additional pipeline properties. --- ##### `synth` ```typescript public synth(): CICDPipelineStack ``` Synthesize the pipeline. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isStack | Return whether the given object is a Stack. | | of | Looks up the first stack scope in which `construct` is defined. | | createDefaultPermissionsBoundary | *No description.* | --- ##### ~~`isConstruct`~~ ```typescript import { CICDPipelineStack } from 'aws-ddk-core' CICDPipelineStack.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isStack` ```typescript import { CICDPipelineStack } from 'aws-ddk-core' CICDPipelineStack.isStack(x: any) ``` Return whether the given object is a Stack. We do attribute detection since we can't reliably use 'instanceof'. ###### `x`^Required - *Type:* any --- ##### `of` ```typescript import { CICDPipelineStack } from 'aws-ddk-core' CICDPipelineStack.of(construct: IConstruct) ``` Looks up the first stack scope in which `construct` is defined. Fails if there is no stack up the tree. ###### `construct`^Required - *Type:* constructs.IConstruct The construct to start the search from. --- ##### `createDefaultPermissionsBoundary` ```typescript import { CICDPipelineStack } from 'aws-ddk-core' CICDPipelineStack.createDefaultPermissionsBoundary(scope: Construct, id: string, props: PermissionsBoundaryProps) ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `props`^Required - *Type:* PermissionsBoundaryProps --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | account | string | The AWS account into which this stack will be deployed. | | artifactId | string | The ID of the cloud assembly artifact for this stack. | | availabilityZones | string[] | Returns the list of AZs that are available in the AWS environment (account/region) associated with this stack. | | bundlingRequired | boolean | Indicates whether the stack requires bundling or not. | | dependencies | aws-cdk-lib.Stack[] | Return the stacks this stack depends on. | | environment | string | The environment coordinates in which this stack is deployed. | | nested | boolean | Indicates if this is a nested stack, in which case `parentStack` will include a reference to it's parent. | | notificationArns | string[] | Returns the list of notification Amazon Resource Names (ARNs) for the current stack. | | partition | string | The partition in which this stack is defined. | | region | string | The AWS region into which this stack will be deployed (e.g. `us-west-2`). | | stackId | string | The ID of the stack. | | stackName | string | The concrete CloudFormation physical stack name. | | synthesizer | aws-cdk-lib.IStackSynthesizer | Synthesis method for this stack. | | tags | aws-cdk-lib.TagManager | Tags to be applied to the stack. | | templateFile | string | The name of the CloudFormation template file emitted to the output directory during synthesis. | | templateOptions | aws-cdk-lib.ITemplateOptions | Options for CloudFormation template (like version, transform, description). | | urlSuffix | string | The Amazon domain suffix for the region in which this stack is defined. | | nestedStackParent | aws-cdk-lib.Stack | If this is a nested stack, returns it's parent stack. | | nestedStackResource | aws-cdk-lib.CfnResource | If this is a nested stack, this represents its `AWS::CloudFormation::Stack` resource. | | terminationProtection | boolean | Whether termination protection is enabled for this stack. | | cdkLanguage | string | *No description.* | | config | Configurator | *No description.* | | environmentId | string | *No description.* | | pipelineId | string | *No description.* | | pipelineName | string | *No description.* | | notificationRule | aws-cdk-lib.aws_codestarnotifications.NotificationRule | *No description.* | | pipeline | aws-cdk-lib.pipelines.CodePipeline | *No description.* | | pipelineKey | aws-cdk-lib.aws_kms.CfnKey | *No description.* | | sourceAction | aws-cdk-lib.pipelines.CodePipelineSource | *No description.* | | synthAction | aws-cdk-lib.pipelines.CodeBuildStep | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `account`^Required ```typescript public readonly account: string; ``` - *Type:* string The AWS account into which this stack will be deployed. This value is resolved according to the following rules: 1. The value provided to `env.account` when the stack is defined. This can either be a concrete account (e.g. `585695031111`) or the `Aws.ACCOUNT_ID` token. 3. `Aws.ACCOUNT_ID`, which represents the CloudFormation intrinsic reference `{ "Ref": "AWS::AccountId" }` encoded as a string token. Preferably, you should use the return value as an opaque string and not attempt to parse it to implement your logic. If you do, you must first check that it is a concrete value an not an unresolved token. If this value is an unresolved token (`Token.isUnresolved(stack.account)` returns `true`), this implies that the user wishes that this stack will synthesize into a **account-agnostic template**. In this case, your code should either fail (throw an error, emit a synth error using `Annotations.of(construct).addError()`) or implement some other region-agnostic behavior. --- ##### `artifactId`^Required ```typescript public readonly artifactId: string; ``` - *Type:* string The ID of the cloud assembly artifact for this stack. --- ##### `availabilityZones`^Required ```typescript public readonly availabilityZones: string[]; ``` - *Type:* string[] Returns the list of AZs that are available in the AWS environment (account/region) associated with this stack. If the stack is environment-agnostic (either account and/or region are tokens), this property will return an array with 2 tokens that will resolve at deploy-time to the first two availability zones returned from CloudFormation's `Fn::GetAZs` intrinsic function. If they are not available in the context, returns a set of dummy values and reports them as missing, and let the CLI resolve them by calling EC2 `DescribeAvailabilityZones` on the target environment. To specify a different strategy for selecting availability zones override this method. --- ##### `bundlingRequired`^Required ```typescript public readonly bundlingRequired: boolean; ``` - *Type:* boolean Indicates whether the stack requires bundling or not. --- ##### `dependencies`^Required ```typescript public readonly dependencies: Stack[]; ``` - *Type:* aws-cdk-lib.Stack[] Return the stacks this stack depends on. --- ##### `environment`^Required ```typescript public readonly environment: string; ``` - *Type:* string The environment coordinates in which this stack is deployed. In the form `aws://account/region`. Use `stack.account` and `stack.region` to obtain the specific values, no need to parse. You can use this value to determine if two stacks are targeting the same environment. If either `stack.account` or `stack.region` are not concrete values (e.g. `Aws.ACCOUNT_ID` or `Aws.REGION`) the special strings `unknown-account` and/or `unknown-region` will be used respectively to indicate this stack is region/account-agnostic. --- ##### `nested`^Required ```typescript public readonly nested: boolean; ``` - *Type:* boolean Indicates if this is a nested stack, in which case `parentStack` will include a reference to it's parent. --- ##### `notificationArns`^Required ```typescript public readonly notificationArns: string[]; ``` - *Type:* string[] Returns the list of notification Amazon Resource Names (ARNs) for the current stack. --- ##### `partition`^Required ```typescript public readonly partition: string; ``` - *Type:* string The partition in which this stack is defined. --- ##### `region`^Required ```typescript public readonly region: string; ``` - *Type:* string The AWS region into which this stack will be deployed (e.g. `us-west-2`). This value is resolved according to the following rules: 1. The value provided to `env.region` when the stack is defined. This can either be a concrete region (e.g. `us-west-2`) or the `Aws.REGION` token. 3. `Aws.REGION`, which is represents the CloudFormation intrinsic reference `{ "Ref": "AWS::Region" }` encoded as a string token. Preferably, you should use the return value as an opaque string and not attempt to parse it to implement your logic. If you do, you must first check that it is a concrete value an not an unresolved token. If this value is an unresolved token (`Token.isUnresolved(stack.region)` returns `true`), this implies that the user wishes that this stack will synthesize into a **region-agnostic template**. In this case, your code should either fail (throw an error, emit a synth error using `Annotations.of(construct).addError()`) or implement some other region-agnostic behavior. --- ##### `stackId`^Required ```typescript public readonly stackId: string; ``` - *Type:* string The ID of the stack. --- *Example* ```typescript // After resolving, looks like 'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123' ``` ##### `stackName`^Required ```typescript public readonly stackName: string; ``` - *Type:* string The concrete CloudFormation physical stack name. This is either the name defined explicitly in the `stackName` prop or allocated based on the stack's location in the construct tree. Stacks that are directly defined under the app use their construct `id` as their stack name. Stacks that are defined deeper within the tree will use a hashed naming scheme based on the construct path to ensure uniqueness. If you wish to obtain the deploy-time AWS::StackName intrinsic, you can use `Aws.STACK_NAME` directly. --- ##### `synthesizer`^Required ```typescript public readonly synthesizer: IStackSynthesizer; ``` - *Type:* aws-cdk-lib.IStackSynthesizer Synthesis method for this stack. --- ##### `tags`^Required ```typescript public readonly tags: TagManager; ``` - *Type:* aws-cdk-lib.TagManager Tags to be applied to the stack. --- ##### `templateFile`^Required ```typescript public readonly templateFile: string; ``` - *Type:* string The name of the CloudFormation template file emitted to the output directory during synthesis. Example value: `MyStack.template.json` --- ##### `templateOptions`^Required ```typescript public readonly templateOptions: ITemplateOptions; ``` - *Type:* aws-cdk-lib.ITemplateOptions Options for CloudFormation template (like version, transform, description). --- ##### `urlSuffix`^Required ```typescript public readonly urlSuffix: string; ``` - *Type:* string The Amazon domain suffix for the region in which this stack is defined. --- ##### `nestedStackParent`^Optional ```typescript public readonly nestedStackParent: Stack; ``` - *Type:* aws-cdk-lib.Stack If this is a nested stack, returns it's parent stack. --- ##### `nestedStackResource`^Optional ```typescript public readonly nestedStackResource: CfnResource; ``` - *Type:* aws-cdk-lib.CfnResource If this is a nested stack, this represents its `AWS::CloudFormation::Stack` resource. `undefined` for top-level (non-nested) stacks. --- ##### `terminationProtection`^Required ```typescript public readonly terminationProtection: boolean; ``` - *Type:* boolean Whether termination protection is enabled for this stack. --- ##### `cdkLanguage`^Required ```typescript public readonly cdkLanguage: string; ``` - *Type:* string --- ##### `config`^Required ```typescript public readonly config: Configurator; ``` - *Type:* Configurator --- ##### `environmentId`^Optional ```typescript public readonly environmentId: string; ``` - *Type:* string --- ##### `pipelineId`^Optional ```typescript public readonly pipelineId: string; ``` - *Type:* string --- ##### `pipelineName`^Optional ```typescript public readonly pipelineName: string; ``` - *Type:* string --- ##### `notificationRule`^Optional ```typescript public readonly notificationRule: NotificationRule; ``` - *Type:* aws-cdk-lib.aws_codestarnotifications.NotificationRule --- ##### `pipeline`^Optional ```typescript public readonly pipeline: CodePipeline; ``` - *Type:* aws-cdk-lib.pipelines.CodePipeline --- ##### `pipelineKey`^Optional ```typescript public readonly pipelineKey: CfnKey; ``` - *Type:* aws-cdk-lib.aws_kms.CfnKey --- ##### `sourceAction`^Optional ```typescript public readonly sourceAction: CodePipelineSource; ``` - *Type:* aws-cdk-lib.pipelines.CodePipelineSource --- ##### `synthAction`^Optional ```typescript public readonly synthAction: CodeBuildStep; ``` - *Type:* aws-cdk-lib.pipelines.CodeBuildStep --- ### DataBrewTransformStage Stage that contains a step function that runs DataBrew job. #### Initializers ```typescript import { DataBrewTransformStage } from 'aws-ddk-core' new DataBrewTransformStage(scope: Construct, id: string, props: DataBrewTransformStageProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | Scope within which this construct is defined. | | id | string | Identifier of the stage. | | props | DataBrewTransformStageProps | Properties for the stage. | --- ##### `scope`^Required - *Type:* constructs.Construct Scope within which this construct is defined. --- ##### `id`^Required - *Type:* string Identifier of the stage. --- ##### `props`^Required - *Type:* DataBrewTransformStageProps Properties for the stage. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | addAlarm | Add a CloudWatch alarm for the DataStage. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `addAlarm` ```typescript public addAlarm(id: string, props: AlarmProps): DataStage ``` Add a CloudWatch alarm for the DataStage. ###### `id`^Required - *Type:* string Identifier of the CloudWatch Alarm. --- ###### `props`^Required - *Type:* AlarmProps Properties for the alarm. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { DataBrewTransformStage } from 'aws-ddk-core' DataBrewTransformStage.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | description | string | Description of the stage. | | eventPattern | aws-cdk-lib.aws_events.EventPattern | Output event pattern of the stage. | | name | string | Name of the stage. | | targets | aws-cdk-lib.aws_events.IRuleTarget[] | Input targets for the stage. | | alarmsEnabled | boolean | Flag indicating whether the alarms are enabled for this stage. | | cloudwatchAlarms | aws-cdk-lib.aws_cloudwatch.Alarm[] | List of CloudWatch Alarms linked to the stage. | | stateMachine | aws-cdk-lib.aws_stepfunctions.StateMachine | State machine. | | createJob | boolean | *No description.* | | jobName | string | *No description.* | | job | aws-cdk-lib.aws_databrew.CfnJob | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string Description of the stage. --- ##### `eventPattern`^Optional ```typescript public readonly eventPattern: EventPattern; ``` - *Type:* aws-cdk-lib.aws_events.EventPattern Output event pattern of the stage. Event pattern describes the structure of output event(s) produced by this stage. Event Rules use event patterns to select events and route them to targets. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Name of the stage. --- ##### `targets`^Optional ```typescript public readonly targets: IRuleTarget[]; ``` - *Type:* aws-cdk-lib.aws_events.IRuleTarget[] Input targets for the stage. Targets are used by Event Rules to describe what should be invoked when a rule matches an event. --- ##### `alarmsEnabled`^Required ```typescript public readonly alarmsEnabled: boolean; ``` - *Type:* boolean Flag indicating whether the alarms are enabled for this stage. --- ##### `cloudwatchAlarms`^Required ```typescript public readonly cloudwatchAlarms: Alarm[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.Alarm[] List of CloudWatch Alarms linked to the stage. --- ##### `stateMachine`^Required ```typescript public readonly stateMachine: StateMachine; ``` - *Type:* aws-cdk-lib.aws_stepfunctions.StateMachine State machine. --- ##### `createJob`^Required ```typescript public readonly createJob: boolean; ``` - *Type:* boolean --- ##### `jobName`^Required ```typescript public readonly jobName: string; ``` - *Type:* string --- ##### `job`^Optional ```typescript public readonly job: CfnJob; ``` - *Type:* aws-cdk-lib.aws_databrew.CfnJob --- ### DataPipeline #### Initializers ```typescript import { DataPipeline } from 'aws-ddk-core' new DataPipeline(scope: Construct, id: string, props: DataPipelineProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | DataPipelineProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* DataPipelineProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | addNotifications | *No description.* | | addRule | *No description.* | | addStage | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `addNotifications` ```typescript public addNotifications(notificationsTopic?: ITopic): DataPipeline ``` ###### `notificationsTopic`^Optional - *Type:* aws-cdk-lib.aws_sns.ITopic --- ##### `addRule` ```typescript public addRule(props: AddRuleProps): DataPipeline ``` ###### `props`^Required - *Type:* AddRuleProps --- ##### `addStage` ```typescript public addStage(props: AddStageProps): DataPipeline ``` ###### `props`^Required - *Type:* AddStageProps --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { DataPipeline } from 'aws-ddk-core' DataPipeline.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | description | string | *No description.* | | name | string | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string --- ### DataStage Class that represents a data stage within a data pipeline. To create a DataStage, inherit from this class, add infrastructure required by the stage, and implement `eventPatterns` and `targets` properties. *Example* ```typescript class MyStage extends DataStage: readonly queue: sqs.Queue; constructor(scope: Construct, id: string, props: MyStageProps) { super(scope, id, props); this.queue = sqs.Queue(this, "Queue"); this.eventPatterns = { detail_type: ["my-detail-type"], }; this.targets = [new events_targets.SqsQueue(this.queue)]; } ``` #### Initializers ```typescript import { DataStage } from 'aws-ddk-core' new DataStage(scope: Construct, id: string, props: DataStageProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | Scope within which this construct is defined. | | id | string | Identifier of the stage. | | props | DataStageProps | Properties for the stage. | --- ##### `scope`^Required - *Type:* constructs.Construct Scope within which this construct is defined. --- ##### `id`^Required - *Type:* string Identifier of the stage. --- ##### `props`^Required - *Type:* DataStageProps Properties for the stage. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | addAlarm | Add a CloudWatch alarm for the DataStage. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `addAlarm` ```typescript public addAlarm(id: string, props: AlarmProps): DataStage ``` Add a CloudWatch alarm for the DataStage. ###### `id`^Required - *Type:* string Identifier of the CloudWatch Alarm. --- ###### `props`^Required - *Type:* AlarmProps Properties for the alarm. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { DataStage } from 'aws-ddk-core' DataStage.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | description | string | Description of the stage. | | eventPattern | aws-cdk-lib.aws_events.EventPattern | Output event pattern of the stage. | | name | string | Name of the stage. | | targets | aws-cdk-lib.aws_events.IRuleTarget[] | Input targets for the stage. | | alarmsEnabled | boolean | Flag indicating whether the alarms are enabled for this stage. | | cloudwatchAlarms | aws-cdk-lib.aws_cloudwatch.Alarm[] | List of CloudWatch Alarms linked to the stage. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string Description of the stage. --- ##### `eventPattern`^Optional ```typescript public readonly eventPattern: EventPattern; ``` - *Type:* aws-cdk-lib.aws_events.EventPattern Output event pattern of the stage. Event pattern describes the structure of output event(s) produced by this stage. Event Rules use event patterns to select events and route them to targets. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Name of the stage. --- ##### `targets`^Optional ```typescript public readonly targets: IRuleTarget[]; ``` - *Type:* aws-cdk-lib.aws_events.IRuleTarget[] Input targets for the stage. Targets are used by Event Rules to describe what should be invoked when a rule matches an event. --- ##### `alarmsEnabled`^Required ```typescript public readonly alarmsEnabled: boolean; ``` - *Type:* boolean Flag indicating whether the alarms are enabled for this stage. --- ##### `cloudwatchAlarms`^Required ```typescript public readonly cloudwatchAlarms: Alarm[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.Alarm[] List of CloudWatch Alarms linked to the stage. --- ### EMRServerlessCluster #### Initializers ```typescript import { EMRServerlessCluster } from 'aws-ddk-core' new EMRServerlessCluster(scope: Construct, id: string, props: EMRServerlessClusterProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | EMRServerlessClusterProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* EMRServerlessClusterProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | createVpc | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `createVpc` ```typescript public createVpc(scope: Construct, resourceName: string, vpcCidr: string): IVpc ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `resourceName`^Required - *Type:* string --- ###### `vpcCidr`^Required - *Type:* string --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { EMRServerlessCluster } from 'aws-ddk-core' EMRServerlessCluster.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | emrServerlessApplication | aws-cdk-lib.aws_emrserverless.CfnApplication | *No description.* | | networkConfiguration | aws-cdk-lib.aws_emrserverless.CfnApplication.NetworkConfigurationProperty | *No description.* | | role | aws-cdk-lib.aws_iam.Role | *No description.* | | s3Bucket | aws-cdk-lib.aws_s3.IBucket | *No description.* | | securityGroup | aws-cdk-lib.aws_ec2.SecurityGroup | *No description.* | | vpc | aws-cdk-lib.aws_ec2.IVpc | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `emrServerlessApplication`^Required ```typescript public readonly emrServerlessApplication: CfnApplication; ``` - *Type:* aws-cdk-lib.aws_emrserverless.CfnApplication --- ##### `networkConfiguration`^Required ```typescript public readonly networkConfiguration: NetworkConfigurationProperty; ``` - *Type:* aws-cdk-lib.aws_emrserverless.CfnApplication.NetworkConfigurationProperty --- ##### `role`^Required ```typescript public readonly role: Role; ``` - *Type:* aws-cdk-lib.aws_iam.Role --- ##### `s3Bucket`^Required ```typescript public readonly s3Bucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket --- ##### `securityGroup`^Optional ```typescript public readonly securityGroup: SecurityGroup; ``` - *Type:* aws-cdk-lib.aws_ec2.SecurityGroup --- ##### `vpc`^Optional ```typescript public readonly vpc: IVpc; ``` - *Type:* aws-cdk-lib.aws_ec2.IVpc --- ### EMRServerlessJobStage Stage that contains a step function that runs an EMR Job. #### Initializers ```typescript import { EMRServerlessJobStage } from 'aws-ddk-core' new EMRServerlessJobStage(scope: Construct, id: string, props: EMRServerlessJobStageProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | Scope within which this construct is defined. | | id | string | Identifier of the stage. | | props | EMRServerlessJobStageProps | Properties for the stage. | --- ##### `scope`^Required - *Type:* constructs.Construct Scope within which this construct is defined. --- ##### `id`^Required - *Type:* string Identifier of the stage. --- ##### `props`^Required - *Type:* EMRServerlessJobStageProps Properties for the stage. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | addAlarm | Add a CloudWatch alarm for the DataStage. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `addAlarm` ```typescript public addAlarm(id: string, props: AlarmProps): DataStage ``` Add a CloudWatch alarm for the DataStage. ###### `id`^Required - *Type:* string Identifier of the CloudWatch Alarm. --- ###### `props`^Required - *Type:* AlarmProps Properties for the alarm. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { EMRServerlessJobStage } from 'aws-ddk-core' EMRServerlessJobStage.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | description | string | Description of the stage. | | eventPattern | aws-cdk-lib.aws_events.EventPattern | Output event pattern of the stage. | | name | string | Name of the stage. | | targets | aws-cdk-lib.aws_events.IRuleTarget[] | Input targets for the stage. | | alarmsEnabled | boolean | Flag indicating whether the alarms are enabled for this stage. | | cloudwatchAlarms | aws-cdk-lib.aws_cloudwatch.Alarm[] | List of CloudWatch Alarms linked to the stage. | | stateMachine | aws-cdk-lib.aws_stepfunctions.StateMachine | State machine. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string Description of the stage. --- ##### `eventPattern`^Optional ```typescript public readonly eventPattern: EventPattern; ``` - *Type:* aws-cdk-lib.aws_events.EventPattern Output event pattern of the stage. Event pattern describes the structure of output event(s) produced by this stage. Event Rules use event patterns to select events and route them to targets. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Name of the stage. --- ##### `targets`^Optional ```typescript public readonly targets: IRuleTarget[]; ``` - *Type:* aws-cdk-lib.aws_events.IRuleTarget[] Input targets for the stage. Targets are used by Event Rules to describe what should be invoked when a rule matches an event. --- ##### `alarmsEnabled`^Required ```typescript public readonly alarmsEnabled: boolean; ``` - *Type:* boolean Flag indicating whether the alarms are enabled for this stage. --- ##### `cloudwatchAlarms`^Required ```typescript public readonly cloudwatchAlarms: Alarm[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.Alarm[] List of CloudWatch Alarms linked to the stage. --- ##### `stateMachine`^Required ```typescript public readonly stateMachine: StateMachine; ``` - *Type:* aws-cdk-lib.aws_stepfunctions.StateMachine State machine. --- ### EventStage Class that represents an event stage within a data pipeline. To create an EventStage, inherit from this class, add infrastructure required by the stage, and implement the `eventPattern` property. The `targets` property will be set to null. *Example* ```typescript class MyStage extends EventStage: constructor(scope: Construct, id: string, props: MyStageProps) { super(scope, id, props); this.eventPatterns = { source: ["aws.s3"], detail: props.detail, detail_type: props.detail_type, }; } ``` #### Initializers ```typescript import { EventStage } from 'aws-ddk-core' new EventStage(scope: Construct, id: string, props: EventStageProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | Scope within which this construct is defined. | | id | string | Identifier of the stage. | | props | EventStageProps | Properties for the stage. | --- ##### `scope`^Required - *Type:* constructs.Construct Scope within which this construct is defined. --- ##### `id`^Required - *Type:* string Identifier of the stage. --- ##### `props`^Required - *Type:* EventStageProps Properties for the stage. --- #### 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 { EventStage } from 'aws-ddk-core' EventStage.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | description | string | Description of the stage. | | eventPattern | aws-cdk-lib.aws_events.EventPattern | Output event pattern of the stage. | | name | string | Name of the stage. | | targets | aws-cdk-lib.aws_events.IRuleTarget[] | Input targets for the stage. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string Description of the stage. --- ##### `eventPattern`^Optional ```typescript public readonly eventPattern: EventPattern; ``` - *Type:* aws-cdk-lib.aws_events.EventPattern Output event pattern of the stage. Event pattern describes the structure of output event(s) produced by this stage. Event Rules use event patterns to select events and route them to targets. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Name of the stage. --- ##### `targets`^Optional ```typescript public readonly targets: IRuleTarget[]; ``` - *Type:* aws-cdk-lib.aws_events.IRuleTarget[] Input targets for the stage. Targets are used by Event Rules to describe what should be invoked when a rule matches an event. --- ### FirehoseToS3Stage DDK Kinesis Firehose Delivery stream to S3 stage, with an optional Kinesis Data Stream. #### Initializers ```typescript import { FirehoseToS3Stage } from 'aws-ddk-core' new FirehoseToS3Stage(scope: Construct, id: string, props: FirehoseToS3StageProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | Scope within which this construct is defined. | | id | string | Identifier of the stage. | | props | FirehoseToS3StageProps | Properties for the stage. | --- ##### `scope`^Required - *Type:* constructs.Construct Scope within which this construct is defined. --- ##### `id`^Required - *Type:* string Identifier of the stage. --- ##### `props`^Required - *Type:* FirehoseToS3StageProps Properties for the stage. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | addAlarm | Add a CloudWatch alarm for the DataStage. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `addAlarm` ```typescript public addAlarm(id: string, props: AlarmProps): DataStage ``` Add a CloudWatch alarm for the DataStage. ###### `id`^Required - *Type:* string Identifier of the CloudWatch Alarm. --- ###### `props`^Required - *Type:* AlarmProps Properties for the alarm. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { FirehoseToS3Stage } from 'aws-ddk-core' FirehoseToS3Stage.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | description | string | Description of the stage. | | eventPattern | aws-cdk-lib.aws_events.EventPattern | Output event pattern of the stage. | | name | string | Name of the stage. | | targets | aws-cdk-lib.aws_events.IRuleTarget[] | Input targets for the stage. | | alarmsEnabled | boolean | Flag indicating whether the alarms are enabled for this stage. | | cloudwatchAlarms | aws-cdk-lib.aws_cloudwatch.Alarm[] | List of CloudWatch Alarms linked to the stage. | | bucket | aws-cdk-lib.aws_s3.IBucket | *No description.* | | deliveryStream | @aws-cdk/aws-kinesisfirehose-alpha.DeliveryStream | *No description.* | | dataStream | aws-cdk-lib.aws_kinesis.Stream | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string Description of the stage. --- ##### `eventPattern`^Optional ```typescript public readonly eventPattern: EventPattern; ``` - *Type:* aws-cdk-lib.aws_events.EventPattern Output event pattern of the stage. Event pattern describes the structure of output event(s) produced by this stage. Event Rules use event patterns to select events and route them to targets. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Name of the stage. --- ##### `targets`^Optional ```typescript public readonly targets: IRuleTarget[]; ``` - *Type:* aws-cdk-lib.aws_events.IRuleTarget[] Input targets for the stage. Targets are used by Event Rules to describe what should be invoked when a rule matches an event. --- ##### `alarmsEnabled`^Required ```typescript public readonly alarmsEnabled: boolean; ``` - *Type:* boolean Flag indicating whether the alarms are enabled for this stage. --- ##### `cloudwatchAlarms`^Required ```typescript public readonly cloudwatchAlarms: Alarm[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.Alarm[] List of CloudWatch Alarms linked to the stage. --- ##### `bucket`^Required ```typescript public readonly bucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket --- ##### `deliveryStream`^Required ```typescript public readonly deliveryStream: DeliveryStream; ``` - *Type:* @aws-cdk/aws-kinesisfirehose-alpha.DeliveryStream --- ##### `dataStream`^Optional ```typescript public readonly dataStream: Stream; ``` - *Type:* aws-cdk-lib.aws_kinesis.Stream --- ### GlueTransformStage Stage that contains a step function that runs Glue job, and a Glue crawler afterwards. If the Glue job or crawler names are not supplied, then they are created. #### Initializers ```typescript import { GlueTransformStage } from 'aws-ddk-core' new GlueTransformStage(scope: Construct, id: string, props: GlueTransformStageProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | Scope within which this construct is defined. | | id | string | Identifier of the stage. | | props | GlueTransformStageProps | Properties for the stage. | --- ##### `scope`^Required - *Type:* constructs.Construct Scope within which this construct is defined. --- ##### `id`^Required - *Type:* string Identifier of the stage. --- ##### `props`^Required - *Type:* GlueTransformStageProps Properties for the stage. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | addAlarm | Add a CloudWatch alarm for the DataStage. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `addAlarm` ```typescript public addAlarm(id: string, props: AlarmProps): DataStage ``` Add a CloudWatch alarm for the DataStage. ###### `id`^Required - *Type:* string Identifier of the CloudWatch Alarm. --- ###### `props`^Required - *Type:* AlarmProps Properties for the alarm. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { GlueTransformStage } from 'aws-ddk-core' GlueTransformStage.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | description | string | Description of the stage. | | eventPattern | aws-cdk-lib.aws_events.EventPattern | Output event pattern of the stage. | | name | string | Name of the stage. | | targets | aws-cdk-lib.aws_events.IRuleTarget[] | Input targets for the stage. | | alarmsEnabled | boolean | Flag indicating whether the alarms are enabled for this stage. | | cloudwatchAlarms | aws-cdk-lib.aws_cloudwatch.Alarm[] | List of CloudWatch Alarms linked to the stage. | | stateMachine | aws-cdk-lib.aws_stepfunctions.StateMachine | State machine. | | definition | aws-cdk-lib.aws_stepfunctions.IChainable | *No description.* | | glueJob | @aws-cdk/aws-glue-alpha.IJob | *No description.* | | crawler | aws-cdk-lib.aws_glue.CfnCrawler | *No description.* | | crawlerName | string | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string Description of the stage. --- ##### `eventPattern`^Optional ```typescript public readonly eventPattern: EventPattern; ``` - *Type:* aws-cdk-lib.aws_events.EventPattern Output event pattern of the stage. Event pattern describes the structure of output event(s) produced by this stage. Event Rules use event patterns to select events and route them to targets. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Name of the stage. --- ##### `targets`^Optional ```typescript public readonly targets: IRuleTarget[]; ``` - *Type:* aws-cdk-lib.aws_events.IRuleTarget[] Input targets for the stage. Targets are used by Event Rules to describe what should be invoked when a rule matches an event. --- ##### `alarmsEnabled`^Required ```typescript public readonly alarmsEnabled: boolean; ``` - *Type:* boolean Flag indicating whether the alarms are enabled for this stage. --- ##### `cloudwatchAlarms`^Required ```typescript public readonly cloudwatchAlarms: Alarm[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.Alarm[] List of CloudWatch Alarms linked to the stage. --- ##### `stateMachine`^Required ```typescript public readonly stateMachine: StateMachine; ``` - *Type:* aws-cdk-lib.aws_stepfunctions.StateMachine State machine. --- ##### `definition`^Required ```typescript public readonly definition: IChainable; ``` - *Type:* aws-cdk-lib.aws_stepfunctions.IChainable --- ##### `glueJob`^Required ```typescript public readonly glueJob: IJob; ``` - *Type:* @aws-cdk/aws-glue-alpha.IJob --- ##### `crawler`^Optional ```typescript public readonly crawler: CfnCrawler; ``` - *Type:* aws-cdk-lib.aws_glue.CfnCrawler --- ##### `crawlerName`^Optional ```typescript public readonly crawlerName: string; ``` - *Type:* string --- ### MWAAEnvironment #### Initializers ```typescript import { MWAAEnvironment } from 'aws-ddk-core' new MWAAEnvironment(scope: Construct, id: string, props: MWAAEnvironmentProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | MWAAEnvironmentProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* MWAAEnvironmentProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | createVpc | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `createVpc` ```typescript public createVpc(scope: Construct, environmentName: string, vpcCidr: string): IVpc ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `environmentName`^Required - *Type:* string --- ###### `vpcCidr`^Required - *Type:* string --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { MWAAEnvironment } from 'aws-ddk-core' MWAAEnvironment.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | dagProcessingLogs | string | *No description.* | | dagS3Path | string | *No description.* | | mwaaEnvironment | aws-cdk-lib.aws_mwaa.CfnEnvironment | *No description.* | | s3Bucket | aws-cdk-lib.aws_s3.IBucket | *No description.* | | schedulerLogsLevel | string | *No description.* | | taskLogsLevel | string | *No description.* | | vpc | aws-cdk-lib.aws_ec2.IVpc | *No description.* | | webserverLogsLevel | string | *No description.* | | workerLogsLevel | string | *No description.* | | pluginFile | aws-cdk-lib.aws_s3_deployment.BucketDeployment | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `dagProcessingLogs`^Required ```typescript public readonly dagProcessingLogs: string; ``` - *Type:* string --- ##### `dagS3Path`^Required ```typescript public readonly dagS3Path: string; ``` - *Type:* string --- ##### `mwaaEnvironment`^Required ```typescript public readonly mwaaEnvironment: CfnEnvironment; ``` - *Type:* aws-cdk-lib.aws_mwaa.CfnEnvironment --- ##### `s3Bucket`^Required ```typescript public readonly s3Bucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket --- ##### `schedulerLogsLevel`^Required ```typescript public readonly schedulerLogsLevel: string; ``` - *Type:* string --- ##### `taskLogsLevel`^Required ```typescript public readonly taskLogsLevel: string; ``` - *Type:* string --- ##### `vpc`^Required ```typescript public readonly vpc: IVpc; ``` - *Type:* aws-cdk-lib.aws_ec2.IVpc --- ##### `webserverLogsLevel`^Required ```typescript public readonly webserverLogsLevel: string; ``` - *Type:* string --- ##### `workerLogsLevel`^Required ```typescript public readonly workerLogsLevel: string; ``` - *Type:* string --- ##### `pluginFile`^Optional ```typescript public readonly pluginFile: BucketDeployment; ``` - *Type:* aws-cdk-lib.aws_s3_deployment.BucketDeployment --- ### MWAATriggerDagsStage Stage that contains a step function that runs a Managed Apache Airflow (MWAA) dag or set of dags . #### Initializers ```typescript import { MWAATriggerDagsStage } from 'aws-ddk-core' new MWAATriggerDagsStage(scope: Construct, id: string, props: MWAATriggerDagsStageProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | Scope within which this construct is defined. | | id | string | Identifier of the stage. | | props | MWAATriggerDagsStageProps | Properties for the stage. | --- ##### `scope`^Required - *Type:* constructs.Construct Scope within which this construct is defined. --- ##### `id`^Required - *Type:* string Identifier of the stage. --- ##### `props`^Required - *Type:* MWAATriggerDagsStageProps Properties for the stage. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | addAlarm | Add a CloudWatch alarm for the DataStage. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `addAlarm` ```typescript public addAlarm(id: string, props: AlarmProps): DataStage ``` Add a CloudWatch alarm for the DataStage. ###### `id`^Required - *Type:* string Identifier of the CloudWatch Alarm. --- ###### `props`^Required - *Type:* AlarmProps Properties for the alarm. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { MWAATriggerDagsStage } from 'aws-ddk-core' MWAATriggerDagsStage.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | description | string | Description of the stage. | | eventPattern | aws-cdk-lib.aws_events.EventPattern | Output event pattern of the stage. | | name | string | Name of the stage. | | targets | aws-cdk-lib.aws_events.IRuleTarget[] | Input targets for the stage. | | alarmsEnabled | boolean | Flag indicating whether the alarms are enabled for this stage. | | cloudwatchAlarms | aws-cdk-lib.aws_cloudwatch.Alarm[] | List of CloudWatch Alarms linked to the stage. | | stateMachine | aws-cdk-lib.aws_stepfunctions.StateMachine | State machine. | | mwaaEnvironmentName | string | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string Description of the stage. --- ##### `eventPattern`^Optional ```typescript public readonly eventPattern: EventPattern; ``` - *Type:* aws-cdk-lib.aws_events.EventPattern Output event pattern of the stage. Event pattern describes the structure of output event(s) produced by this stage. Event Rules use event patterns to select events and route them to targets. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Name of the stage. --- ##### `targets`^Optional ```typescript public readonly targets: IRuleTarget[]; ``` - *Type:* aws-cdk-lib.aws_events.IRuleTarget[] Input targets for the stage. Targets are used by Event Rules to describe what should be invoked when a rule matches an event. --- ##### `alarmsEnabled`^Required ```typescript public readonly alarmsEnabled: boolean; ``` - *Type:* boolean Flag indicating whether the alarms are enabled for this stage. --- ##### `cloudwatchAlarms`^Required ```typescript public readonly cloudwatchAlarms: Alarm[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.Alarm[] List of CloudWatch Alarms linked to the stage. --- ##### `stateMachine`^Required ```typescript public readonly stateMachine: StateMachine; ``` - *Type:* aws-cdk-lib.aws_stepfunctions.StateMachine State machine. --- ##### `mwaaEnvironmentName`^Required ```typescript public readonly mwaaEnvironmentName: string; ``` - *Type:* string --- ### RedshiftDataApiStage Stage that contains a step function that executes Redshift Data API statements. #### Initializers ```typescript import { RedshiftDataApiStage } from 'aws-ddk-core' new RedshiftDataApiStage(scope: Construct, id: string, props: RedshiftDataApiStageProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | Scope within which this construct is defined. | | id | string | Identifier of the stage. | | props | RedshiftDataApiStageProps | Properties for the stage. | --- ##### `scope`^Required - *Type:* constructs.Construct Scope within which this construct is defined. --- ##### `id`^Required - *Type:* string Identifier of the stage. --- ##### `props`^Required - *Type:* RedshiftDataApiStageProps Properties for the stage. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | addAlarm | Add a CloudWatch alarm for the DataStage. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `addAlarm` ```typescript public addAlarm(id: string, props: AlarmProps): DataStage ``` Add a CloudWatch alarm for the DataStage. ###### `id`^Required - *Type:* string Identifier of the CloudWatch Alarm. --- ###### `props`^Required - *Type:* AlarmProps Properties for the alarm. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { RedshiftDataApiStage } from 'aws-ddk-core' RedshiftDataApiStage.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | description | string | Description of the stage. | | eventPattern | aws-cdk-lib.aws_events.EventPattern | Output event pattern of the stage. | | name | string | Name of the stage. | | targets | aws-cdk-lib.aws_events.IRuleTarget[] | Input targets for the stage. | | alarmsEnabled | boolean | Flag indicating whether the alarms are enabled for this stage. | | cloudwatchAlarms | aws-cdk-lib.aws_cloudwatch.Alarm[] | List of CloudWatch Alarms linked to the stage. | | stateMachine | aws-cdk-lib.aws_stepfunctions.StateMachine | State machine. | | eventBridgeEventPath | string | *No description.* | | stateMachineInput | {[ key: string ]: any} | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string Description of the stage. --- ##### `eventPattern`^Optional ```typescript public readonly eventPattern: EventPattern; ``` - *Type:* aws-cdk-lib.aws_events.EventPattern Output event pattern of the stage. Event pattern describes the structure of output event(s) produced by this stage. Event Rules use event patterns to select events and route them to targets. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Name of the stage. --- ##### `targets`^Optional ```typescript public readonly targets: IRuleTarget[]; ``` - *Type:* aws-cdk-lib.aws_events.IRuleTarget[] Input targets for the stage. Targets are used by Event Rules to describe what should be invoked when a rule matches an event. --- ##### `alarmsEnabled`^Required ```typescript public readonly alarmsEnabled: boolean; ``` - *Type:* boolean Flag indicating whether the alarms are enabled for this stage. --- ##### `cloudwatchAlarms`^Required ```typescript public readonly cloudwatchAlarms: Alarm[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.Alarm[] List of CloudWatch Alarms linked to the stage. --- ##### `stateMachine`^Required ```typescript public readonly stateMachine: StateMachine; ``` - *Type:* aws-cdk-lib.aws_stepfunctions.StateMachine State machine. --- ##### `eventBridgeEventPath`^Optional ```typescript public readonly eventBridgeEventPath: string; ``` - *Type:* string --- ##### `stateMachineInput`^Optional ```typescript public readonly stateMachineInput: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} --- ### S3EventStage Stage implements an S3 event pattern based on event names, a bucket name and optional key prefix. Amazon EventBridge notifications must be enabled on the bucket in order to use this construct. #### Initializers ```typescript import { S3EventStage } from 'aws-ddk-core' new S3EventStage(scope: Construct, id: string, props: S3EventStageProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | Scope within which this construct is defined. | | id | string | Identifier of the stage. | | props | S3EventStageProps | Properties for the stage. | --- ##### `scope`^Required - *Type:* constructs.Construct Scope within which this construct is defined. --- ##### `id`^Required - *Type:* string Identifier of the stage. --- ##### `props`^Required - *Type:* S3EventStageProps Properties for the stage. --- #### 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 { S3EventStage } from 'aws-ddk-core' S3EventStage.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | description | string | Description of the stage. | | eventPattern | aws-cdk-lib.aws_events.EventPattern | Output event pattern of the stage. | | name | string | Name of the stage. | | targets | aws-cdk-lib.aws_events.IRuleTarget[] | Input targets for the stage. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string Description of the stage. --- ##### `eventPattern`^Optional ```typescript public readonly eventPattern: EventPattern; ``` - *Type:* aws-cdk-lib.aws_events.EventPattern Output event pattern of the stage. Event pattern describes the structure of output event(s) produced by this stage. Event Rules use event patterns to select events and route them to targets. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Name of the stage. --- ##### `targets`^Optional ```typescript public readonly targets: IRuleTarget[]; ``` - *Type:* aws-cdk-lib.aws_events.IRuleTarget[] Input targets for the stage. Targets are used by Event Rules to describe what should be invoked when a rule matches an event. --- ### SnsSqsToLambdaStage Stage implements an SNS Topic connected to an Amazon SQS queue and an AWS Lambda function, with an optional DLQ. #### Initializers ```typescript import { SnsSqsToLambdaStage } from 'aws-ddk-core' new SnsSqsToLambdaStage(scope: Construct, id: string, props: SnsToLambdaStageProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | Scope within which this construct is defined. | | id | string | Identifier of the stage. | | props | SnsToLambdaStageProps | Properties for the stage. | --- ##### `scope`^Required - *Type:* constructs.Construct Scope within which this construct is defined. --- ##### `id`^Required - *Type:* string Identifier of the stage. --- ##### `props`^Required - *Type:* SnsToLambdaStageProps Properties for the stage. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | addAlarm | Add a CloudWatch alarm for the DataStage. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `addAlarm` ```typescript public addAlarm(id: string, props: AlarmProps): DataStage ``` Add a CloudWatch alarm for the DataStage. ###### `id`^Required - *Type:* string Identifier of the CloudWatch Alarm. --- ###### `props`^Required - *Type:* AlarmProps Properties for the alarm. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { SnsSqsToLambdaStage } from 'aws-ddk-core' SnsSqsToLambdaStage.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | description | string | Description of the stage. | | eventPattern | aws-cdk-lib.aws_events.EventPattern | Output event pattern of the stage. | | name | string | Name of the stage. | | targets | aws-cdk-lib.aws_events.IRuleTarget[] | Input targets for the stage. | | alarmsEnabled | boolean | Flag indicating whether the alarms are enabled for this stage. | | cloudwatchAlarms | aws-cdk-lib.aws_cloudwatch.Alarm[] | List of CloudWatch Alarms linked to the stage. | | function | aws-cdk-lib.aws_lambda.IFunction | *No description.* | | queue | aws-cdk-lib.aws_sqs.IQueue | *No description.* | | deadLetterQueue | aws-cdk-lib.aws_sqs.Queue | *No description.* | | topic | aws-cdk-lib.aws_sns.ITopic | *No description.* | | snsDeadLetterQueue | aws-cdk-lib.aws_sqs.Queue | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string Description of the stage. --- ##### `eventPattern`^Optional ```typescript public readonly eventPattern: EventPattern; ``` - *Type:* aws-cdk-lib.aws_events.EventPattern Output event pattern of the stage. Event pattern describes the structure of output event(s) produced by this stage. Event Rules use event patterns to select events and route them to targets. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Name of the stage. --- ##### `targets`^Optional ```typescript public readonly targets: IRuleTarget[]; ``` - *Type:* aws-cdk-lib.aws_events.IRuleTarget[] Input targets for the stage. Targets are used by Event Rules to describe what should be invoked when a rule matches an event. --- ##### `alarmsEnabled`^Required ```typescript public readonly alarmsEnabled: boolean; ``` - *Type:* boolean Flag indicating whether the alarms are enabled for this stage. --- ##### `cloudwatchAlarms`^Required ```typescript public readonly cloudwatchAlarms: Alarm[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.Alarm[] List of CloudWatch Alarms linked to the stage. --- ##### `function`^Required ```typescript public readonly function: IFunction; ``` - *Type:* aws-cdk-lib.aws_lambda.IFunction --- ##### `queue`^Required ```typescript public readonly queue: IQueue; ``` - *Type:* aws-cdk-lib.aws_sqs.IQueue --- ##### `deadLetterQueue`^Optional ```typescript public readonly deadLetterQueue: Queue; ``` - *Type:* aws-cdk-lib.aws_sqs.Queue --- ##### `topic`^Required ```typescript public readonly topic: ITopic; ``` - *Type:* aws-cdk-lib.aws_sns.ITopic --- ##### `snsDeadLetterQueue`^Optional ```typescript public readonly snsDeadLetterQueue: Queue; ``` - *Type:* aws-cdk-lib.aws_sqs.Queue --- ### SqsToLambdaStage Stage implements an Amazon SQS queue connected to an AWS Lambda function, with an optional DLQ. #### Initializers ```typescript import { SqsToLambdaStage } from 'aws-ddk-core' new SqsToLambdaStage(scope: Construct, id: string, props: SqsToLambdaStageProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | Scope within which this construct is defined. | | id | string | Identifier of the stage. | | props | SqsToLambdaStageProps | Properties for the stage. | --- ##### `scope`^Required - *Type:* constructs.Construct Scope within which this construct is defined. --- ##### `id`^Required - *Type:* string Identifier of the stage. --- ##### `props`^Required - *Type:* SqsToLambdaStageProps Properties for the stage. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | addAlarm | Add a CloudWatch alarm for the DataStage. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `addAlarm` ```typescript public addAlarm(id: string, props: AlarmProps): DataStage ``` Add a CloudWatch alarm for the DataStage. ###### `id`^Required - *Type:* string Identifier of the CloudWatch Alarm. --- ###### `props`^Required - *Type:* AlarmProps Properties for the alarm. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { SqsToLambdaStage } from 'aws-ddk-core' SqsToLambdaStage.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | description | string | Description of the stage. | | eventPattern | aws-cdk-lib.aws_events.EventPattern | Output event pattern of the stage. | | name | string | Name of the stage. | | targets | aws-cdk-lib.aws_events.IRuleTarget[] | Input targets for the stage. | | alarmsEnabled | boolean | Flag indicating whether the alarms are enabled for this stage. | | cloudwatchAlarms | aws-cdk-lib.aws_cloudwatch.Alarm[] | List of CloudWatch Alarms linked to the stage. | | function | aws-cdk-lib.aws_lambda.IFunction | *No description.* | | queue | aws-cdk-lib.aws_sqs.IQueue | *No description.* | | deadLetterQueue | aws-cdk-lib.aws_sqs.Queue | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string Description of the stage. --- ##### `eventPattern`^Optional ```typescript public readonly eventPattern: EventPattern; ``` - *Type:* aws-cdk-lib.aws_events.EventPattern Output event pattern of the stage. Event pattern describes the structure of output event(s) produced by this stage. Event Rules use event patterns to select events and route them to targets. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Name of the stage. --- ##### `targets`^Optional ```typescript public readonly targets: IRuleTarget[]; ``` - *Type:* aws-cdk-lib.aws_events.IRuleTarget[] Input targets for the stage. Targets are used by Event Rules to describe what should be invoked when a rule matches an event. --- ##### `alarmsEnabled`^Required ```typescript public readonly alarmsEnabled: boolean; ``` - *Type:* boolean Flag indicating whether the alarms are enabled for this stage. --- ##### `cloudwatchAlarms`^Required ```typescript public readonly cloudwatchAlarms: Alarm[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.Alarm[] List of CloudWatch Alarms linked to the stage. --- ##### `function`^Required ```typescript public readonly function: IFunction; ``` - *Type:* aws-cdk-lib.aws_lambda.IFunction --- ##### `queue`^Required ```typescript public readonly queue: IQueue; ``` - *Type:* aws-cdk-lib.aws_sqs.IQueue --- ##### `deadLetterQueue`^Optional ```typescript public readonly deadLetterQueue: Queue; ``` - *Type:* aws-cdk-lib.aws_sqs.Queue --- ### Stage Abstract class representing a stage. #### Initializers ```typescript import { Stage } from 'aws-ddk-core' new Stage(scope: Construct, id: string, props: StageProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | Scope within which this construct is defined. | | id | string | Identifier of the stage. | | props | StageProps | Properties for the stage. | --- ##### `scope`^Required - *Type:* constructs.Construct Scope within which this construct is defined. --- ##### `id`^Required - *Type:* string Identifier of the stage. --- ##### `props`^Required - *Type:* StageProps Properties for the stage. --- #### 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 { Stage } from 'aws-ddk-core' Stage.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | description | string | Description of the stage. | | eventPattern | aws-cdk-lib.aws_events.EventPattern | Output event pattern of the stage. | | name | string | Name of the stage. | | targets | aws-cdk-lib.aws_events.IRuleTarget[] | Input targets for the stage. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string Description of the stage. --- ##### `eventPattern`^Optional ```typescript public readonly eventPattern: EventPattern; ``` - *Type:* aws-cdk-lib.aws_events.EventPattern Output event pattern of the stage. Event pattern describes the structure of output event(s) produced by this stage. Event Rules use event patterns to select events and route them to targets. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Name of the stage. --- ##### `targets`^Optional ```typescript public readonly targets: IRuleTarget[]; ``` - *Type:* aws-cdk-lib.aws_events.IRuleTarget[] Input targets for the stage. Targets are used by Event Rules to describe what should be invoked when a rule matches an event. --- ### StateMachineStage DataStage with helper methods to simplify StateMachine stages creation. #### Initializers ```typescript import { StateMachineStage } from 'aws-ddk-core' new StateMachineStage(scope: Construct, id: string, props: StateMachineStageProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | Scope within which this construct is defined. | | id | string | Identifier of the stage. | | props | StateMachineStageProps | Properties for the stage. | --- ##### `scope`^Required - *Type:* constructs.Construct Scope within which this construct is defined. --- ##### `id`^Required - *Type:* string Identifier of the stage. --- ##### `props`^Required - *Type:* StateMachineStageProps Properties for the stage. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | addAlarm | Add a CloudWatch alarm for the DataStage. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `addAlarm` ```typescript public addAlarm(id: string, props: AlarmProps): DataStage ``` Add a CloudWatch alarm for the DataStage. ###### `id`^Required - *Type:* string Identifier of the CloudWatch Alarm. --- ###### `props`^Required - *Type:* AlarmProps Properties for the alarm. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { StateMachineStage } from 'aws-ddk-core' StateMachineStage.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | description | string | Description of the stage. | | eventPattern | aws-cdk-lib.aws_events.EventPattern | Output event pattern of the stage. | | name | string | Name of the stage. | | targets | aws-cdk-lib.aws_events.IRuleTarget[] | Input targets for the stage. | | alarmsEnabled | boolean | Flag indicating whether the alarms are enabled for this stage. | | cloudwatchAlarms | aws-cdk-lib.aws_cloudwatch.Alarm[] | List of CloudWatch Alarms linked to the stage. | | stateMachine | aws-cdk-lib.aws_stepfunctions.StateMachine | State machine. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string Description of the stage. --- ##### `eventPattern`^Optional ```typescript public readonly eventPattern: EventPattern; ``` - *Type:* aws-cdk-lib.aws_events.EventPattern Output event pattern of the stage. Event pattern describes the structure of output event(s) produced by this stage. Event Rules use event patterns to select events and route them to targets. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Name of the stage. --- ##### `targets`^Optional ```typescript public readonly targets: IRuleTarget[]; ``` - *Type:* aws-cdk-lib.aws_events.IRuleTarget[] Input targets for the stage. Targets are used by Event Rules to describe what should be invoked when a rule matches an event. --- ##### `alarmsEnabled`^Required ```typescript public readonly alarmsEnabled: boolean; ``` - *Type:* boolean Flag indicating whether the alarms are enabled for this stage. --- ##### `cloudwatchAlarms`^Required ```typescript public readonly cloudwatchAlarms: Alarm[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.Alarm[] List of CloudWatch Alarms linked to the stage. --- ##### `stateMachine`^Required ```typescript public readonly stateMachine: StateMachine; ``` - *Type:* aws-cdk-lib.aws_stepfunctions.StateMachine State machine. --- ## Structs ### AddApplicationStageProps Properties for adding an application stage. #### Initializer ```typescript import { AddApplicationStageProps } from 'aws-ddk-core' const addApplicationStageProps: AddApplicationStageProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | stage | aws-cdk-lib.Stage | Application stage instance. | | stageId | string | Identifier of the stage. | | manualApprovals | boolean | Configure manual approvals. | --- ##### `stage`^Required ```typescript public readonly stage: Stage; ``` - *Type:* aws-cdk-lib.Stage Application stage instance. --- ##### `stageId`^Required ```typescript public readonly stageId: string; ``` - *Type:* string Identifier of the stage. --- ##### `manualApprovals`^Optional ```typescript public readonly manualApprovals: boolean; ``` - *Type:* boolean - *Default:* false Configure manual approvals. --- ### AddApplicationWaveProps Properties for adding an application wave. #### Initializer ```typescript import { AddApplicationWaveProps } from 'aws-ddk-core' const addApplicationWaveProps: AddApplicationWaveProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | stageId | string | Identifier of the wave. | | stages | aws-cdk-lib.Stage[] | Application stage instance. | | manualApprovals | boolean | Configure manual approvals. | --- ##### `stageId`^Required ```typescript public readonly stageId: string; ``` - *Type:* string Identifier of the wave. --- ##### `stages`^Required ```typescript public readonly stages: Stage[]; ``` - *Type:* aws-cdk-lib.Stage[] Application stage instance. --- ##### `manualApprovals`^Optional ```typescript public readonly manualApprovals: boolean; ``` - *Type:* boolean - *Default:* false Configure manual approvals. --- ### AddCustomStageProps Properties for adding a custom stage. #### Initializer ```typescript import { AddCustomStageProps } from 'aws-ddk-core' const addCustomStageProps: AddCustomStageProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | stageName | string | Name of the stage. | | steps | aws-cdk-lib.pipelines.Step[] | Steps to add to this stage. List of Step objects. | --- ##### `stageName`^Required ```typescript public readonly stageName: string; ``` - *Type:* string Name of the stage. --- ##### `steps`^Required ```typescript public readonly steps: Step[]; ``` - *Type:* aws-cdk-lib.pipelines.Step[] Steps to add to this stage. List of Step objects. See [Documentation on aws_cdk.pipelines.Step](https://docs.aws.amazon.com/cdk/api/v1/python/aws_cdk.pipelines/Step.html) for more detail. --- ### AdditionalPipelineProps Additional properties for building the CodePipeline. #### Initializer ```typescript import { AdditionalPipelineProps } from 'aws-ddk-core' const additionalPipelineProps: AdditionalPipelineProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | assetPublishingCodeBuildDefaults | aws-cdk-lib.pipelines.CodeBuildOptions | Additional customizations to apply to the asset publishing CodeBuild projects. | | cliVersion | string | CDK CLI version to use in self-mutation and asset publishing steps. | | codeBuildDefaults | aws-cdk-lib.pipelines.CodeBuildOptions | Customize the CodeBuild projects created for this pipeline. | | codePipeline | aws-cdk-lib.aws_codepipeline.Pipeline | An existing Pipeline to be reused and built upon. | | dockerCredentials | aws-cdk-lib.pipelines.DockerCredential[] | A list of credentials used to authenticate to Docker registries. | | dockerEnabledForSelfMutation | boolean | Enable Docker for the self-mutate step. | | dockerEnabledForSynth | boolean | Enable Docker for the 'synth' step. | | publishAssetsInParallel | boolean | Publish assets in multiple CodeBuild projects. | | reuseCrossRegionSupportStacks | boolean | Reuse the same cross region support stack for all pipelines in the App. | | selfMutation | boolean | Whether the pipeline will update itself. | | selfMutationCodeBuildDefaults | aws-cdk-lib.pipelines.CodeBuildOptions | Additional customizations to apply to the self mutation CodeBuild projects. | | synthCodeBuildDefaults | aws-cdk-lib.pipelines.CodeBuildOptions | Additional customizations to apply to the synthesize CodeBuild projects. | --- ##### `assetPublishingCodeBuildDefaults`^Optional ```typescript public readonly assetPublishingCodeBuildDefaults: CodeBuildOptions; ``` - *Type:* aws-cdk-lib.pipelines.CodeBuildOptions - *Default:* Only `codeBuildDefaults` are applied Additional customizations to apply to the asset publishing CodeBuild projects. --- ##### `cliVersion`^Optional ```typescript public readonly cliVersion: string; ``` - *Type:* string - *Default:* latest version CDK CLI version to use in self-mutation and asset publishing steps. --- ##### `codeBuildDefaults`^Optional ```typescript public readonly codeBuildDefaults: CodeBuildOptions; ``` - *Type:* aws-cdk-lib.pipelines.CodeBuildOptions - *Default:* All projects run non-privileged build, SMALL instance, LinuxBuildImage.STANDARD_6_0 Customize the CodeBuild projects created for this pipeline. --- ##### `codePipeline`^Optional ```typescript public readonly codePipeline: Pipeline; ``` - *Type:* aws-cdk-lib.aws_codepipeline.Pipeline - *Default:* a new underlying pipeline is created. An existing Pipeline to be reused and built upon. --- ##### `dockerCredentials`^Optional ```typescript public readonly dockerCredentials: DockerCredential[]; ``` - *Type:* aws-cdk-lib.pipelines.DockerCredential[] - *Default:* [] A list of credentials used to authenticate to Docker registries. Specify any credentials necessary within the pipeline to build, synth, update, or publish assets. --- ##### `dockerEnabledForSelfMutation`^Optional ```typescript public readonly dockerEnabledForSelfMutation: boolean; ``` - *Type:* boolean - *Default:* false Enable Docker for the self-mutate step. --- ##### `dockerEnabledForSynth`^Optional ```typescript public readonly dockerEnabledForSynth: boolean; ``` - *Type:* boolean - *Default:* false Enable Docker for the 'synth' step. --- ##### `publishAssetsInParallel`^Optional ```typescript public readonly publishAssetsInParallel: boolean; ``` - *Type:* boolean - *Default:* true Publish assets in multiple CodeBuild projects. --- ##### `reuseCrossRegionSupportStacks`^Optional ```typescript public readonly reuseCrossRegionSupportStacks: boolean; ``` - *Type:* boolean - *Default:* true (Use the same support stack for all pipelines in App) Reuse the same cross region support stack for all pipelines in the App. --- ##### `selfMutation`^Optional ```typescript public readonly selfMutation: boolean; ``` - *Type:* boolean - *Default:* true Whether the pipeline will update itself. This needs to be set to `true` to allow the pipeline to reconfigure itself when assets or stages are being added to it, and `true` is the recommended setting. You can temporarily set this to `false` while you are iterating on the pipeline itself and prefer to deploy changes using `cdk deploy`. --- ##### `selfMutationCodeBuildDefaults`^Optional ```typescript public readonly selfMutationCodeBuildDefaults: CodeBuildOptions; ``` - *Type:* aws-cdk-lib.pipelines.CodeBuildOptions - *Default:* Only `codeBuildDefaults` are applied Additional customizations to apply to the self mutation CodeBuild projects. --- ##### `synthCodeBuildDefaults`^Optional ```typescript public readonly synthCodeBuildDefaults: CodeBuildOptions; ``` - *Type:* aws-cdk-lib.pipelines.CodeBuildOptions - *Default:* Only `codeBuildDefaults` are applied Additional customizations to apply to the synthesize CodeBuild projects. --- ### AddNotificationsProps Properties for adding notifications. #### Initializer ```typescript import { AddNotificationsProps } from 'aws-ddk-core' const addNotificationsProps: AddNotificationsProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | notificationRule | aws-cdk-lib.aws_codestarnotifications.NotificationRule | Override notification rule. | --- ##### `notificationRule`^Optional ```typescript public readonly notificationRule: NotificationRule; ``` - *Type:* aws-cdk-lib.aws_codestarnotifications.NotificationRule Override notification rule. --- ### AddRuleProps #### Initializer ```typescript import { AddRuleProps } from 'aws-ddk-core' const addRuleProps: AddRuleProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | eventPattern | aws-cdk-lib.aws_events.EventPattern | *No description.* | | eventTargets | aws-cdk-lib.aws_events.IRuleTarget[] | *No description.* | | id | string | *No description.* | | overrideRule | aws-cdk-lib.aws_events.IRule | *No description.* | | ruleName | string | *No description.* | | schedule | aws-cdk-lib.aws_events.Schedule | *No description.* | --- ##### `eventPattern`^Optional ```typescript public readonly eventPattern: EventPattern; ``` - *Type:* aws-cdk-lib.aws_events.EventPattern --- ##### `eventTargets`^Optional ```typescript public readonly eventTargets: IRuleTarget[]; ``` - *Type:* aws-cdk-lib.aws_events.IRuleTarget[] --- ##### `id`^Optional ```typescript public readonly id: string; ``` - *Type:* string --- ##### `overrideRule`^Optional ```typescript public readonly overrideRule: IRule; ``` - *Type:* aws-cdk-lib.aws_events.IRule --- ##### `ruleName`^Optional ```typescript public readonly ruleName: string; ``` - *Type:* string --- ##### `schedule`^Optional ```typescript public readonly schedule: Schedule; ``` - *Type:* aws-cdk-lib.aws_events.Schedule --- ### AddSecurityLintStageProps Properties for adding a security lint stage. #### Initializer ```typescript import { AddSecurityLintStageProps } from 'aws-ddk-core' const addSecurityLintStageProps: AddSecurityLintStageProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | cfnNagFailBuild | boolean | Fail Codepipeline Build Action on failed results from CfnNag scan. | | cloudAssemblyFileSet | aws-cdk-lib.pipelines.IFileSetProducer | Cloud assembly file set producer. | | stageName | string | Name of the stage. | --- ##### `cfnNagFailBuild`^Optional ```typescript public readonly cfnNagFailBuild: boolean; ``` - *Type:* boolean Fail Codepipeline Build Action on failed results from CfnNag scan. --- ##### `cloudAssemblyFileSet`^Optional ```typescript public readonly cloudAssemblyFileSet: IFileSetProducer; ``` - *Type:* aws-cdk-lib.pipelines.IFileSetProducer Cloud assembly file set producer. --- ##### `stageName`^Optional ```typescript public readonly stageName: string; ``` - *Type:* string Name of the stage. --- ### AddStageProps #### Initializer ```typescript import { AddStageProps } from 'aws-ddk-core' const addStageProps: AddStageProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | stage | Stage | *No description.* | | overrideRule | aws-cdk-lib.aws_events.IRule | *No description.* | | ruleName | string | *No description.* | | schedule | aws-cdk-lib.aws_events.Schedule | *No description.* | | skipRule | boolean | *No description.* | --- ##### `stage`^Required ```typescript public readonly stage: Stage; ``` - *Type:* Stage --- ##### `overrideRule`^Optional ```typescript public readonly overrideRule: IRule; ``` - *Type:* aws-cdk-lib.aws_events.IRule --- ##### `ruleName`^Optional ```typescript public readonly ruleName: string; ``` - *Type:* string --- ##### `schedule`^Optional ```typescript public readonly schedule: Schedule; ``` - *Type:* aws-cdk-lib.aws_events.Schedule --- ##### `skipRule`^Optional ```typescript public readonly skipRule: boolean; ``` - *Type:* boolean --- ### AddTestStageProps Properties for adding a test stage. #### Initializer ```typescript import { AddTestStageProps } from 'aws-ddk-core' const addTestStageProps: AddTestStageProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | cloudAssemblyFileSet | aws-cdk-lib.pipelines.IFileSetProducer | Cloud assembly file set. | | commands | string[] | Additional commands to run in the test. | | stageName | string | Name of the stage. | --- ##### `cloudAssemblyFileSet`^Optional ```typescript public readonly cloudAssemblyFileSet: IFileSetProducer; ``` - *Type:* aws-cdk-lib.pipelines.IFileSetProducer Cloud assembly file set. --- ##### `commands`^Optional ```typescript public readonly commands: string[]; ``` - *Type:* string[] - *Default:* "./test.sh" Additional commands to run in the test. --- ##### `stageName`^Optional ```typescript public readonly stageName: string; ``` - *Type:* string Name of the stage. --- ### AlarmProps Properties for the alarm being added to the DataStage. #### Initializer ```typescript import { AlarmProps } from 'aws-ddk-core' const alarmProps: AlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | Metric to use for creating the stage's CloudWatch Alarm. | | comparisonOperator | aws-cdk-lib.aws_cloudwatch.ComparisonOperator | Comparison operator to use for alarm. | | evaluationPeriods | number | The value against which the specified alarm statistic is compared. | | threshold | number | The number of periods over which data is compared to the specified threshold. | --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric Metric to use for creating the stage's CloudWatch Alarm. --- ##### `comparisonOperator`^Optional ```typescript public readonly comparisonOperator: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* GREATER_THAN_THRESHOLD Comparison operator to use for alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The value against which the specified alarm statistic is compared. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 1 The number of periods over which data is compared to the specified threshold. --- ### AppFlowIngestionStageProps Properties of the AppFlow Ingestion stage. #### Initializer ```typescript import { AppFlowIngestionStageProps } from 'aws-ddk-core' const appFlowIngestionStageProps: AppFlowIngestionStageProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | Description of the stage. | | name | string | Name of the stage. | | additionalRolePolicyStatements | aws-cdk-lib.aws_iam.PolicyStatement[] | Additional IAM policy statements to add to the state machine role. | | alarmsEnabled | boolean | Enable/Disable all alarms in the stage. | | definition | string \| aws-cdk-lib.aws_stepfunctions.IChainable | Steps for the state machine. | | definitionFile | string | File containing a JSON definition for the state machine. | | stateMachineFailedExecutionsAlarmEvaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | stateMachineFailedExecutionsAlarmThreshold | number | The number of failed state machine executions before triggering CW alarm. | | stateMachineInput | {[ key: string ]: any} | Input of the state machine. | | stateMachineName | string | Name of the state machine. | | destinationFlowConfig | aws-cdk-lib.aws_appflow.CfnFlow.DestinationFlowConfigProperty | The flow `appflow.CfnFlow.DestinationFlowConfigProperty` properties. | | flowExecutionStatusCheckPeriod | aws-cdk-lib.Duration | Time to wait between flow execution status checks. | | flowName | string | Name of the AppFlow flow to run. | | flowTasks | aws-cdk-lib.aws_appflow.CfnFlow.TaskProperty[] | The flow tasks properties. | | sourceFlowConfig | aws-cdk-lib.aws_appflow.CfnFlow.SourceFlowConfigProperty | The flow `appflow.CfnFlow.SourceFlowConfigProperty` properties. | --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string Description of the stage. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Name of the stage. --- ##### `additionalRolePolicyStatements`^Optional ```typescript public readonly additionalRolePolicyStatements: PolicyStatement[]; ``` - *Type:* aws-cdk-lib.aws_iam.PolicyStatement[] Additional IAM policy statements to add to the state machine role. --- ##### `alarmsEnabled`^Optional ```typescript public readonly alarmsEnabled: boolean; ``` - *Type:* boolean - *Default:* true Enable/Disable all alarms in the stage. --- ##### `definition`^Optional ```typescript public readonly definition: string | IChainable; ``` - *Type:* string | aws-cdk-lib.aws_stepfunctions.IChainable Steps for the state machine. Can either be provided as 'sfn.IChainable' or a JSON string. --- ##### `definitionFile`^Optional ```typescript public readonly definitionFile: string; ``` - *Type:* string File containing a JSON definition for the state machine. --- ##### `stateMachineFailedExecutionsAlarmEvaluationPeriods`^Optional ```typescript public readonly stateMachineFailedExecutionsAlarmEvaluationPeriods: number; ``` - *Type:* number - *Default:* 1 The number of periods over which data is compared to the specified threshold. --- ##### `stateMachineFailedExecutionsAlarmThreshold`^Optional ```typescript public readonly stateMachineFailedExecutionsAlarmThreshold: number; ``` - *Type:* number - *Default:* 1 The number of failed state machine executions before triggering CW alarm. --- ##### `stateMachineInput`^Optional ```typescript public readonly stateMachineInput: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} Input of the state machine. --- ##### `stateMachineName`^Optional ```typescript public readonly stateMachineName: string; ``` - *Type:* string Name of the state machine. --- ##### `destinationFlowConfig`^Optional ```typescript public readonly destinationFlowConfig: DestinationFlowConfigProperty; ``` - *Type:* aws-cdk-lib.aws_appflow.CfnFlow.DestinationFlowConfigProperty The flow `appflow.CfnFlow.DestinationFlowConfigProperty` properties. --- ##### `flowExecutionStatusCheckPeriod`^Optional ```typescript public readonly flowExecutionStatusCheckPeriod: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* aws_cdk.Duration.seconds(15) Time to wait between flow execution status checks. --- ##### `flowName`^Optional ```typescript public readonly flowName: string; ``` - *Type:* string Name of the AppFlow flow to run. If None, an AppFlow flow is created. --- ##### `flowTasks`^Optional ```typescript public readonly flowTasks: TaskProperty[]; ``` - *Type:* aws-cdk-lib.aws_appflow.CfnFlow.TaskProperty[] The flow tasks properties. --- ##### `sourceFlowConfig`^Optional ```typescript public readonly sourceFlowConfig: SourceFlowConfigProperty; ``` - *Type:* aws-cdk-lib.aws_appflow.CfnFlow.SourceFlowConfigProperty The flow `appflow.CfnFlow.SourceFlowConfigProperty` properties. --- ### AthenaToSQLStageProps Properties for `AthenaSQLStage`. #### Initializer ```typescript import { AthenaToSQLStageProps } from 'aws-ddk-core' const athenaToSQLStageProps: AthenaToSQLStageProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | Description of the stage. | | name | string | Name of the stage. | | additionalRolePolicyStatements | aws-cdk-lib.aws_iam.PolicyStatement[] | Additional IAM policy statements to add to the state machine role. | | alarmsEnabled | boolean | Enable/Disable all alarms in the stage. | | definition | string \| aws-cdk-lib.aws_stepfunctions.IChainable | Steps for the state machine. | | definitionFile | string | File containing a JSON definition for the state machine. | | stateMachineFailedExecutionsAlarmEvaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | stateMachineFailedExecutionsAlarmThreshold | number | The number of failed state machine executions before triggering CW alarm. | | stateMachineInput | {[ key: string ]: any} | Input of the state machine. | | stateMachineName | string | Name of the state machine. | | catalogName | string | Catalog name. | | databaseName | string | Database name. | | encryptionKey | aws-cdk-lib.aws_kms.Key | Encryption KMS key. | | encryptionOption | aws-cdk-lib.aws_stepfunctions_tasks.EncryptionOption | Encryption configuration. | | outputLocation | aws-cdk-lib.aws_s3.Location | Output S3 location. | | parallel | boolean | flag to determine parallel or sequential execution. | | queryString | string[] | SQL queries that will be started. | | queryStringPath | string | dynamic path in statemachine for SQL query to be started. | | workGroup | string | Athena workgroup name. | --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string Description of the stage. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Name of the stage. --- ##### `additionalRolePolicyStatements`^Optional ```typescript public readonly additionalRolePolicyStatements: PolicyStatement[]; ``` - *Type:* aws-cdk-lib.aws_iam.PolicyStatement[] Additional IAM policy statements to add to the state machine role. --- ##### `alarmsEnabled`^Optional ```typescript public readonly alarmsEnabled: boolean; ``` - *Type:* boolean - *Default:* true Enable/Disable all alarms in the stage. --- ##### `definition`^Optional ```typescript public readonly definition: string | IChainable; ``` - *Type:* string | aws-cdk-lib.aws_stepfunctions.IChainable Steps for the state machine. Can either be provided as 'sfn.IChainable' or a JSON string. --- ##### `definitionFile`^Optional ```typescript public readonly definitionFile: string; ``` - *Type:* string File containing a JSON definition for the state machine. --- ##### `stateMachineFailedExecutionsAlarmEvaluationPeriods`^Optional ```typescript public readonly stateMachineFailedExecutionsAlarmEvaluationPeriods: number; ``` - *Type:* number - *Default:* 1 The number of periods over which data is compared to the specified threshold. --- ##### `stateMachineFailedExecutionsAlarmThreshold`^Optional ```typescript public readonly stateMachineFailedExecutionsAlarmThreshold: number; ``` - *Type:* number - *Default:* 1 The number of failed state machine executions before triggering CW alarm. --- ##### `stateMachineInput`^Optional ```typescript public readonly stateMachineInput: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} Input of the state machine. --- ##### `stateMachineName`^Optional ```typescript public readonly stateMachineName: string; ``` - *Type:* string Name of the state machine. --- ##### `catalogName`^Optional ```typescript public readonly catalogName: string; ``` - *Type:* string Catalog name. --- ##### `databaseName`^Optional ```typescript public readonly databaseName: string; ``` - *Type:* string Database name. --- ##### `encryptionKey`^Optional ```typescript public readonly encryptionKey: Key; ``` - *Type:* aws-cdk-lib.aws_kms.Key Encryption KMS key. --- ##### `encryptionOption`^Optional ```typescript public readonly encryptionOption: EncryptionOption; ``` - *Type:* aws-cdk-lib.aws_stepfunctions_tasks.EncryptionOption Encryption configuration. --- ##### `outputLocation`^Optional ```typescript public readonly outputLocation: Location; ``` - *Type:* aws-cdk-lib.aws_s3.Location Output S3 location. --- ##### `parallel`^Optional ```typescript public readonly parallel: boolean; ``` - *Type:* boolean - *Default:* false flag to determine parallel or sequential execution. --- ##### `queryString`^Optional ```typescript public readonly queryString: string[]; ``` - *Type:* string[] SQL queries that will be started. --- ##### `queryStringPath`^Optional ```typescript public readonly queryStringPath: string; ``` - *Type:* string dynamic path in statemachine for SQL query to be started. --- ##### `workGroup`^Optional ```typescript public readonly workGroup: string; ``` - *Type:* string Athena workgroup name. --- ### BaseStackProps Properties of `BaseStack`. #### Initializer ```typescript import { BaseStackProps } from 'aws-ddk-core' const baseStackProps: BaseStackProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | analyticsReporting | boolean | Include runtime versioning information in this Stack. | | crossRegionReferences | boolean | Enable this flag to allow native cross region stack references. | | description | string | A description of the stack. | | env | aws-cdk-lib.Environment | The AWS environment (account/region) where this stack will be deployed. | | notificationArns | string[] | SNS Topic ARNs that will receive stack events. | | permissionsBoundary | aws-cdk-lib.PermissionsBoundary | Options for applying a permissions boundary to all IAM Roles and Users created within this Stage. | | stackName | string | Name to deploy the stack with. | | suppressTemplateIndentation | boolean | Enable this flag to suppress indentation in generated CloudFormation templates. | | synthesizer | aws-cdk-lib.IStackSynthesizer | Synthesis method to use while deploying this stack. | | tags | {[ key: string ]: string} | Stack tags that will be applied to all the taggable resources and the stack itself. | | terminationProtection | boolean | Whether to enable termination protection for this stack. | | config | string \| Configuration | Configuration or path to file which contains the configuration. | | environmentId | string | Identifier of the environment. | | permissionsBoundaryArn | string | ARN of the permissions boundary managed policy. | --- ##### `analyticsReporting`^Optional ```typescript public readonly analyticsReporting: boolean; ``` - *Type:* boolean - *Default:* `analyticsReporting` setting of containing `App`, or value of 'aws:cdk:version-reporting' context key Include runtime versioning information in this Stack. --- ##### `crossRegionReferences`^Optional ```typescript public readonly crossRegionReferences: boolean; ``` - *Type:* boolean - *Default:* false Enable this flag to allow native cross region stack references. Enabling this will create a CloudFormation custom resource in both the producing stack and consuming stack in order to perform the export/import This feature is currently experimental --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* No description. A description of the stack. --- ##### `env`^Optional ```typescript public readonly env: Environment; ``` - *Type:* aws-cdk-lib.Environment - *Default:* The environment of the containing `Stage` if available, otherwise create the stack will be environment-agnostic. The AWS environment (account/region) where this stack will be deployed. Set the `region`/`account` fields of `env` to either a concrete value to select the indicated environment (recommended for production stacks), or to the values of environment variables `CDK_DEFAULT_REGION`/`CDK_DEFAULT_ACCOUNT` to let the target environment depend on the AWS credentials/configuration that the CDK CLI is executed under (recommended for development stacks). If the `Stack` is instantiated inside a `Stage`, any undefined `region`/`account` fields from `env` will default to the same field on the encompassing `Stage`, if configured there. If either `region` or `account` are not set nor inherited from `Stage`, the Stack will be considered "*environment-agnostic*"". Environment-agnostic stacks can be deployed to any environment but may not be able to take advantage of all features of the CDK. For example, they will not be able to use environmental context lookups such as `ec2.Vpc.fromLookup` and will not automatically translate Service Principals to the right format based on the environment's AWS partition, and other such enhancements. --- *Example* ```typescript // Use a concrete account and region to deploy this stack to: // `.account` and `.region` will simply return these values. new Stack(app, 'Stack1', { env: { account: '123456789012', region: 'us-east-1' }, }); // Use the CLI's current credentials to determine the target environment: // `.account` and `.region` will reflect the account+region the CLI // is configured to use (based on the user CLI credentials) new Stack(app, 'Stack2', { env: { account: process.env.CDK_DEFAULT_ACCOUNT, region: process.env.CDK_DEFAULT_REGION }, }); // Define multiple stacks stage associated with an environment const myStage = new Stage(app, 'MyStage', { env: { account: '123456789012', region: 'us-east-1' } }); // both of these stacks will use the stage's account/region: // `.account` and `.region` will resolve to the concrete values as above new MyStack(myStage, 'Stack1'); new YourStack(myStage, 'Stack2'); // Define an environment-agnostic stack: // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively. // which will only resolve to actual values by CloudFormation during deployment. new MyStack(app, 'Stack1'); ``` ##### `notificationArns`^Optional ```typescript public readonly notificationArns: string[]; ``` - *Type:* string[] - *Default:* no notfication arns. SNS Topic ARNs that will receive stack events. --- ##### `permissionsBoundary`^Optional ```typescript public readonly permissionsBoundary: PermissionsBoundary; ``` - *Type:* aws-cdk-lib.PermissionsBoundary - *Default:* no permissions boundary is applied Options for applying a permissions boundary to all IAM Roles and Users created within this Stage. --- ##### `stackName`^Optional ```typescript public readonly stackName: string; ``` - *Type:* string - *Default:* Derived from construct path. Name to deploy the stack with. --- ##### `suppressTemplateIndentation`^Optional ```typescript public readonly suppressTemplateIndentation: boolean; ``` - *Type:* boolean - *Default:* the value of `@aws-cdk/core:suppressTemplateIndentation`, or `false` if that is not set. Enable this flag to suppress indentation in generated CloudFormation templates. If not specified, the value of the `@aws-cdk/core:suppressTemplateIndentation` context key will be used. If that is not specified, then the default value `false` will be used. --- ##### `synthesizer`^Optional ```typescript public readonly synthesizer: IStackSynthesizer; ``` - *Type:* aws-cdk-lib.IStackSynthesizer - *Default:* The synthesizer specified on `App`, or `DefaultStackSynthesizer` otherwise. Synthesis method to use while deploying this stack. The Stack Synthesizer controls aspects of synthesis and deployment, like how assets are referenced and what IAM roles to use. For more information, see the README of the main CDK package. If not specified, the `defaultStackSynthesizer` from `App` will be used. If that is not specified, `DefaultStackSynthesizer` is used if `@aws-cdk/core:newStyleStackSynthesis` is set to `true` or the CDK major version is v2. In CDK v1 `LegacyStackSynthesizer` is the default if no other synthesizer is specified. --- ##### `tags`^Optional ```typescript public readonly tags: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} - *Default:* {} Stack tags that will be applied to all the taggable resources and the stack itself. --- ##### `terminationProtection`^Optional ```typescript public readonly terminationProtection: boolean; ``` - *Type:* boolean - *Default:* false Whether to enable termination protection for this stack. --- ##### `config`^Optional ```typescript public readonly config: string | Configuration; ``` - *Type:* string | Configuration Configuration or path to file which contains the configuration. --- ##### `environmentId`^Optional ```typescript public readonly environmentId: string; ``` - *Type:* string - *Default:* "dev" Identifier of the environment. --- ##### `permissionsBoundaryArn`^Optional ```typescript public readonly permissionsBoundaryArn: string; ``` - *Type:* string ARN of the permissions boundary managed policy. --- ### CICDPipelineStackProps CICD Pipeline Stack properties. #### Initializer ```typescript import { CICDPipelineStackProps } from 'aws-ddk-core' const cICDPipelineStackProps: CICDPipelineStackProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | analyticsReporting | boolean | Include runtime versioning information in this Stack. | | crossRegionReferences | boolean | Enable this flag to allow native cross region stack references. | | description | string | A description of the stack. | | env | aws-cdk-lib.Environment | The AWS environment (account/region) where this stack will be deployed. | | notificationArns | string[] | SNS Topic ARNs that will receive stack events. | | permissionsBoundary | aws-cdk-lib.PermissionsBoundary | Options for applying a permissions boundary to all IAM Roles and Users created within this Stage. | | stackName | string | Name to deploy the stack with. | | suppressTemplateIndentation | boolean | Enable this flag to suppress indentation in generated CloudFormation templates. | | synthesizer | aws-cdk-lib.IStackSynthesizer | Synthesis method to use while deploying this stack. | | tags | {[ key: string ]: string} | Stack tags that will be applied to all the taggable resources and the stack itself. | | terminationProtection | boolean | Whether to enable termination protection for this stack. | | config | string \| Configuration | Configuration or path to file which contains the configuration. | | environmentId | string | Identifier of the environment. | | permissionsBoundaryArn | string | ARN of the permissions boundary managed policy. | | cdkLanguage | string | Language of the CDK construct definitions. | | pipelineName | string | Name of the pipeline. | --- ##### `analyticsReporting`^Optional ```typescript public readonly analyticsReporting: boolean; ``` - *Type:* boolean - *Default:* `analyticsReporting` setting of containing `App`, or value of 'aws:cdk:version-reporting' context key Include runtime versioning information in this Stack. --- ##### `crossRegionReferences`^Optional ```typescript public readonly crossRegionReferences: boolean; ``` - *Type:* boolean - *Default:* false Enable this flag to allow native cross region stack references. Enabling this will create a CloudFormation custom resource in both the producing stack and consuming stack in order to perform the export/import This feature is currently experimental --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* No description. A description of the stack. --- ##### `env`^Optional ```typescript public readonly env: Environment; ``` - *Type:* aws-cdk-lib.Environment - *Default:* The environment of the containing `Stage` if available, otherwise create the stack will be environment-agnostic. The AWS environment (account/region) where this stack will be deployed. Set the `region`/`account` fields of `env` to either a concrete value to select the indicated environment (recommended for production stacks), or to the values of environment variables `CDK_DEFAULT_REGION`/`CDK_DEFAULT_ACCOUNT` to let the target environment depend on the AWS credentials/configuration that the CDK CLI is executed under (recommended for development stacks). If the `Stack` is instantiated inside a `Stage`, any undefined `region`/`account` fields from `env` will default to the same field on the encompassing `Stage`, if configured there. If either `region` or `account` are not set nor inherited from `Stage`, the Stack will be considered "*environment-agnostic*"". Environment-agnostic stacks can be deployed to any environment but may not be able to take advantage of all features of the CDK. For example, they will not be able to use environmental context lookups such as `ec2.Vpc.fromLookup` and will not automatically translate Service Principals to the right format based on the environment's AWS partition, and other such enhancements. --- *Example* ```typescript // Use a concrete account and region to deploy this stack to: // `.account` and `.region` will simply return these values. new Stack(app, 'Stack1', { env: { account: '123456789012', region: 'us-east-1' }, }); // Use the CLI's current credentials to determine the target environment: // `.account` and `.region` will reflect the account+region the CLI // is configured to use (based on the user CLI credentials) new Stack(app, 'Stack2', { env: { account: process.env.CDK_DEFAULT_ACCOUNT, region: process.env.CDK_DEFAULT_REGION }, }); // Define multiple stacks stage associated with an environment const myStage = new Stage(app, 'MyStage', { env: { account: '123456789012', region: 'us-east-1' } }); // both of these stacks will use the stage's account/region: // `.account` and `.region` will resolve to the concrete values as above new MyStack(myStage, 'Stack1'); new YourStack(myStage, 'Stack2'); // Define an environment-agnostic stack: // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively. // which will only resolve to actual values by CloudFormation during deployment. new MyStack(app, 'Stack1'); ``` ##### `notificationArns`^Optional ```typescript public readonly notificationArns: string[]; ``` - *Type:* string[] - *Default:* no notfication arns. SNS Topic ARNs that will receive stack events. --- ##### `permissionsBoundary`^Optional ```typescript public readonly permissionsBoundary: PermissionsBoundary; ``` - *Type:* aws-cdk-lib.PermissionsBoundary - *Default:* no permissions boundary is applied Options for applying a permissions boundary to all IAM Roles and Users created within this Stage. --- ##### `stackName`^Optional ```typescript public readonly stackName: string; ``` - *Type:* string - *Default:* Derived from construct path. Name to deploy the stack with. --- ##### `suppressTemplateIndentation`^Optional ```typescript public readonly suppressTemplateIndentation: boolean; ``` - *Type:* boolean - *Default:* the value of `@aws-cdk/core:suppressTemplateIndentation`, or `false` if that is not set. Enable this flag to suppress indentation in generated CloudFormation templates. If not specified, the value of the `@aws-cdk/core:suppressTemplateIndentation` context key will be used. If that is not specified, then the default value `false` will be used. --- ##### `synthesizer`^Optional ```typescript public readonly synthesizer: IStackSynthesizer; ``` - *Type:* aws-cdk-lib.IStackSynthesizer - *Default:* The synthesizer specified on `App`, or `DefaultStackSynthesizer` otherwise. Synthesis method to use while deploying this stack. The Stack Synthesizer controls aspects of synthesis and deployment, like how assets are referenced and what IAM roles to use. For more information, see the README of the main CDK package. If not specified, the `defaultStackSynthesizer` from `App` will be used. If that is not specified, `DefaultStackSynthesizer` is used if `@aws-cdk/core:newStyleStackSynthesis` is set to `true` or the CDK major version is v2. In CDK v1 `LegacyStackSynthesizer` is the default if no other synthesizer is specified. --- ##### `tags`^Optional ```typescript public readonly tags: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} - *Default:* {} Stack tags that will be applied to all the taggable resources and the stack itself. --- ##### `terminationProtection`^Optional ```typescript public readonly terminationProtection: boolean; ``` - *Type:* boolean - *Default:* false Whether to enable termination protection for this stack. --- ##### `config`^Optional ```typescript public readonly config: string | Configuration; ``` - *Type:* string | Configuration Configuration or path to file which contains the configuration. --- ##### `environmentId`^Optional ```typescript public readonly environmentId: string; ``` - *Type:* string - *Default:* "dev" Identifier of the environment. --- ##### `permissionsBoundaryArn`^Optional ```typescript public readonly permissionsBoundaryArn: string; ``` - *Type:* string ARN of the permissions boundary managed policy. --- ##### `cdkLanguage`^Optional ```typescript public readonly cdkLanguage: string; ``` - *Type:* string - *Default:* "typescript" Language of the CDK construct definitions. --- ##### `pipelineName`^Optional ```typescript public readonly pipelineName: string; ``` - *Type:* string Name of the pipeline. --- ### CodeArtifactPublishActionProps #### Initializer ```typescript import { CodeArtifactPublishActionProps } from 'aws-ddk-core' const codeArtifactPublishActionProps: CodeArtifactPublishActionProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | account | string | *No description.* | | codeartifactDomain | string | *No description.* | | codeartifactDomainOwner | string | *No description.* | | codeartifactRepository | string | *No description.* | | partition | string | *No description.* | | region | string | *No description.* | | codePipelineSource | aws-cdk-lib.pipelines.CodePipelineSource | *No description.* | | rolePolicyStatements | aws-cdk-lib.aws_iam.PolicyStatement[] | *No description.* | --- ##### `account`^Required ```typescript public readonly account: string; ``` - *Type:* string --- ##### `codeartifactDomain`^Required ```typescript public readonly codeartifactDomain: string; ``` - *Type:* string --- ##### `codeartifactDomainOwner`^Required ```typescript public readonly codeartifactDomainOwner: string; ``` - *Type:* string --- ##### `codeartifactRepository`^Required ```typescript public readonly codeartifactRepository: string; ``` - *Type:* string --- ##### `partition`^Required ```typescript public readonly partition: string; ``` - *Type:* string --- ##### `region`^Required ```typescript public readonly region: string; ``` - *Type:* string --- ##### `codePipelineSource`^Optional ```typescript public readonly codePipelineSource: CodePipelineSource; ``` - *Type:* aws-cdk-lib.pipelines.CodePipelineSource --- ##### `rolePolicyStatements`^Optional ```typescript public readonly rolePolicyStatements: PolicyStatement[]; ``` - *Type:* aws-cdk-lib.aws_iam.PolicyStatement[] --- ### CodeCommitSourceActionProps #### Initializer ```typescript import { CodeCommitSourceActionProps } from 'aws-ddk-core' const codeCommitSourceActionProps: CodeCommitSourceActionProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | branch | string | *No description.* | | repositoryName | string | *No description.* | | props | aws-cdk-lib.pipelines.ConnectionSourceOptions | *No description.* | --- ##### `branch`^Required ```typescript public readonly branch: string; ``` - *Type:* string --- ##### `repositoryName`^Required ```typescript public readonly repositoryName: string; ``` - *Type:* string --- ##### `props`^Optional ```typescript public readonly props: ConnectionSourceOptions; ``` - *Type:* aws-cdk-lib.pipelines.ConnectionSourceOptions --- ### Configuration #### Initializer ```typescript import { Configuration } from 'aws-ddk-core' const configuration: Configuration = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | environments | {[ key: string ]: EnvironmentConfiguration} | *No description.* | | account | string | *No description.* | | bootstrap | {[ key: string ]: string} | *No description.* | | ddkBootstrapConfigKey | string | *No description.* | | props | {[ key: string ]: any} | *No description.* | | region | string | *No description.* | | tags | {[ key: string ]: string} | *No description.* | --- ##### `environments`^Required ```typescript public readonly environments: {[ key: string ]: EnvironmentConfiguration}; ``` - *Type:* {[ key: string ]: EnvironmentConfiguration} --- ##### `account`^Optional ```typescript public readonly account: string; ``` - *Type:* string --- ##### `bootstrap`^Optional ```typescript public readonly bootstrap: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} --- ##### `ddkBootstrapConfigKey`^Optional ```typescript public readonly ddkBootstrapConfigKey: string; ``` - *Type:* string --- ##### `props`^Optional ```typescript public readonly props: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} --- ##### `region`^Optional ```typescript public readonly region: string; ``` - *Type:* string --- ##### `tags`^Optional ```typescript public readonly tags: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} --- ### CreateStateMachineResult #### Initializer ```typescript import { CreateStateMachineResult } from 'aws-ddk-core' const createStateMachineResult: CreateStateMachineResult = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | eventPattern | aws-cdk-lib.aws_events.EventPattern | *No description.* | | stateMachine | aws-cdk-lib.aws_stepfunctions.StateMachine | *No description.* | | targets | aws-cdk-lib.aws_events.IRuleTarget[] | *No description.* | --- ##### `eventPattern`^Required ```typescript public readonly eventPattern: EventPattern; ``` - *Type:* aws-cdk-lib.aws_events.EventPattern --- ##### `stateMachine`^Required ```typescript public readonly stateMachine: StateMachine; ``` - *Type:* aws-cdk-lib.aws_stepfunctions.StateMachine --- ##### `targets`^Required ```typescript public readonly targets: IRuleTarget[]; ``` - *Type:* aws-cdk-lib.aws_events.IRuleTarget[] --- ### DataBrewTransformStageProps Properties for `DataBrewTransformStage`. #### Initializer ```typescript import { DataBrewTransformStageProps } from 'aws-ddk-core' const dataBrewTransformStageProps: DataBrewTransformStageProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | Description of the stage. | | name | string | Name of the stage. | | additionalRolePolicyStatements | aws-cdk-lib.aws_iam.PolicyStatement[] | Additional IAM policy statements to add to the state machine role. | | alarmsEnabled | boolean | Enable/Disable all alarms in the stage. | | definition | string \| aws-cdk-lib.aws_stepfunctions.IChainable | Steps for the state machine. | | definitionFile | string | File containing a JSON definition for the state machine. | | stateMachineFailedExecutionsAlarmEvaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | stateMachineFailedExecutionsAlarmThreshold | number | The number of failed state machine executions before triggering CW alarm. | | stateMachineInput | {[ key: string ]: any} | Input of the state machine. | | stateMachineName | string | Name of the state machine. | | createJob | boolean | Whether to create the DataBrew job or not. | | databaseOutputs | aws-cdk-lib.aws_databrew.CfnJob.DatabaseOutputProperty[] | Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into. | | dataCatalogOutputs | aws-cdk-lib.aws_databrew.CfnJob.DataCatalogOutputProperty[] | One or more artifacts that represent the AWS Glue Data Catalog output from running the job. | | datasetName | string | The name of the dataset to use for the job. | | encryptionKeyArn | string | The Amazon Resource Name (ARN) of an encryption key that is used to protect the job output. | | encryptionMode | string | The encryption mode for the job, which can be one of the following:. | | jobName | string | The name of a preexisting DataBrew job to run. | | jobRoleArn | string | The Arn of the job execution role. | | jobSample | aws-cdk-lib.aws_databrew.CfnJob.JobSampleProperty | A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run. | | jobType | string | The type of job to run. | | logSubscription | string | The current status of Amazon CloudWatch logging for the job. | | maxCapacity | number | The maximum number of nodes that can be consumed when the job processes data. | | maxRetries | number | The maximum number of times to retry the job after a job run fails. | | outputLocation | aws-cdk-lib.aws_databrew.CfnJob.OutputLocationProperty | `AWS::DataBrew::Job.OutputLocation`. | | outputs | aws-cdk-lib.aws_databrew.CfnJob.OutputProperty[] | The output properties for the job. | | profileConfiguration | aws-cdk-lib.aws_databrew.CfnJob.ProfileConfigurationProperty | Configuration for profile jobs. | | projectName | string | The name of the project that the job is associated with. | | recipe | aws-cdk-lib.aws_databrew.CfnJob.RecipeProperty | The recipe to be used by the DataBrew job which is a series of data transformation steps. | | tags | aws-cdk-lib.CfnTag[] | Metadata tags that have been applied to the job. | | timeout | number | The job's timeout in minutes. | | validationConfigurations | aws-cdk-lib.aws_databrew.CfnJob.ValidationConfigurationProperty[] | List of validation configurations that are applied to the profile job. | --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string Description of the stage. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Name of the stage. --- ##### `additionalRolePolicyStatements`^Optional ```typescript public readonly additionalRolePolicyStatements: PolicyStatement[]; ``` - *Type:* aws-cdk-lib.aws_iam.PolicyStatement[] Additional IAM policy statements to add to the state machine role. --- ##### `alarmsEnabled`^Optional ```typescript public readonly alarmsEnabled: boolean; ``` - *Type:* boolean - *Default:* true Enable/Disable all alarms in the stage. --- ##### `definition`^Optional ```typescript public readonly definition: string | IChainable; ``` - *Type:* string | aws-cdk-lib.aws_stepfunctions.IChainable Steps for the state machine. Can either be provided as 'sfn.IChainable' or a JSON string. --- ##### `definitionFile`^Optional ```typescript public readonly definitionFile: string; ``` - *Type:* string File containing a JSON definition for the state machine. --- ##### `stateMachineFailedExecutionsAlarmEvaluationPeriods`^Optional ```typescript public readonly stateMachineFailedExecutionsAlarmEvaluationPeriods: number; ``` - *Type:* number - *Default:* 1 The number of periods over which data is compared to the specified threshold. --- ##### `stateMachineFailedExecutionsAlarmThreshold`^Optional ```typescript public readonly stateMachineFailedExecutionsAlarmThreshold: number; ``` - *Type:* number - *Default:* 1 The number of failed state machine executions before triggering CW alarm. --- ##### `stateMachineInput`^Optional ```typescript public readonly stateMachineInput: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} Input of the state machine. --- ##### `stateMachineName`^Optional ```typescript public readonly stateMachineName: string; ``` - *Type:* string Name of the state machine. --- ##### `createJob`^Optional ```typescript public readonly createJob: boolean; ``` - *Type:* boolean Whether to create the DataBrew job or not. --- ##### `databaseOutputs`^Optional ```typescript public readonly databaseOutputs: DatabaseOutputProperty[]; ``` - *Type:* aws-cdk-lib.aws_databrew.CfnJob.DatabaseOutputProperty[] Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-databaseoutputs](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-databaseoutputs) --- ##### `dataCatalogOutputs`^Optional ```typescript public readonly dataCatalogOutputs: DataCatalogOutputProperty[]; ``` - *Type:* aws-cdk-lib.aws_databrew.CfnJob.DataCatalogOutputProperty[] One or more artifacts that represent the AWS Glue Data Catalog output from running the job. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-datacatalogoutputs](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-datacatalogoutputs) --- ##### `datasetName`^Optional ```typescript public readonly datasetName: string; ``` - *Type:* string The name of the dataset to use for the job. --- ##### `encryptionKeyArn`^Optional ```typescript public readonly encryptionKeyArn: string; ``` - *Type:* string The Amazon Resource Name (ARN) of an encryption key that is used to protect the job output. For more information, see [Encrypting data written by DataBrew jobs](https://docs.aws.amazon.com/databrew/latest/dg/encryption-security-configuration.html) > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-encryptionkeyarn](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-encryptionkeyarn) --- ##### `encryptionMode`^Optional ```typescript public readonly encryptionMode: string; ``` - *Type:* string The encryption mode for the job, which can be one of the following:. `SSE-KMS` - Server-side encryption with keys managed by AWS KMS . - `SSE-S3` - Server-side encryption with keys managed by Amazon S3. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-encryptionmode](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-encryptionmode) --- ##### `jobName`^Optional ```typescript public readonly jobName: string; ``` - *Type:* string The name of a preexisting DataBrew job to run. If None, a DataBrew job is created. --- ##### `jobRoleArn`^Optional ```typescript public readonly jobRoleArn: string; ``` - *Type:* string The Arn of the job execution role. Required if job_name is None. --- ##### `jobSample`^Optional ```typescript public readonly jobSample: JobSampleProperty; ``` - *Type:* aws-cdk-lib.aws_databrew.CfnJob.JobSampleProperty A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run. If a `JobSample` value isn't provided, the default value is used. The default value is CUSTOM_ROWS for the mode parameter and 20,000 for the size parameter. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-jobsample](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-jobsample) --- ##### `jobType`^Optional ```typescript public readonly jobType: string; ``` - *Type:* string The type of job to run. Required if job_name is None. --- ##### `logSubscription`^Optional ```typescript public readonly logSubscription: string; ``` - *Type:* string The current status of Amazon CloudWatch logging for the job. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-logsubscription](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-logsubscription) --- ##### `maxCapacity`^Optional ```typescript public readonly maxCapacity: number; ``` - *Type:* number The maximum number of nodes that can be consumed when the job processes data. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-maxcapacity](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-maxcapacity) --- ##### `maxRetries`^Optional ```typescript public readonly maxRetries: number; ``` - *Type:* number The maximum number of times to retry the job after a job run fails. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-maxretries](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-maxretries) --- ##### `outputLocation`^Optional ```typescript public readonly outputLocation: OutputLocationProperty; ``` - *Type:* aws-cdk-lib.aws_databrew.CfnJob.OutputLocationProperty `AWS::DataBrew::Job.OutputLocation`. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-outputlocation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-outputlocation) --- ##### `outputs`^Optional ```typescript public readonly outputs: OutputProperty[]; ``` - *Type:* aws-cdk-lib.aws_databrew.CfnJob.OutputProperty[] The output properties for the job. --- ##### `profileConfiguration`^Optional ```typescript public readonly profileConfiguration: ProfileConfigurationProperty; ``` - *Type:* aws-cdk-lib.aws_databrew.CfnJob.ProfileConfigurationProperty Configuration for profile jobs. Configuration can be used to select columns, do evaluations, and override default parameters of evaluations. When configuration is undefined, the profile job will apply default settings to all supported columns. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-profileconfiguration](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-profileconfiguration) --- ##### `projectName`^Optional ```typescript public readonly projectName: string; ``` - *Type:* string The name of the project that the job is associated with. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-projectname](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-projectname) --- ##### `recipe`^Optional ```typescript public readonly recipe: RecipeProperty; ``` - *Type:* aws-cdk-lib.aws_databrew.CfnJob.RecipeProperty The recipe to be used by the DataBrew job which is a series of data transformation steps. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-recipe](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-recipe) --- ##### `tags`^Optional ```typescript public readonly tags: CfnTag[]; ``` - *Type:* aws-cdk-lib.CfnTag[] Metadata tags that have been applied to the job. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-tags](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-tags) --- ##### `timeout`^Optional ```typescript public readonly timeout: number; ``` - *Type:* number The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of `TIMEOUT` . > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-timeout](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-timeout) --- ##### `validationConfigurations`^Optional ```typescript public readonly validationConfigurations: ValidationConfigurationProperty[]; ``` - *Type:* aws-cdk-lib.aws_databrew.CfnJob.ValidationConfigurationProperty[] List of validation configurations that are applied to the profile job. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-validationconfigurations](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-validationconfigurations) --- ### DataPipelineProps #### Initializer ```typescript import { DataPipelineProps } from 'aws-ddk-core' const dataPipelineProps: DataPipelineProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | *No description.* | | name | string | *No description.* | --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string --- ### DataStageProps Properties for the `DataStage`. #### Initializer ```typescript import { DataStageProps } from 'aws-ddk-core' const dataStageProps: DataStageProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | Description of the stage. | | name | string | Name of the stage. | | alarmsEnabled | boolean | Enable/Disable all alarms in a DataStage. | --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string Description of the stage. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Name of the stage. --- ##### `alarmsEnabled`^Optional ```typescript public readonly alarmsEnabled: boolean; ``` - *Type:* boolean - *Default:* true Enable/Disable all alarms in a DataStage. --- ### DeliveryStreamProps Properties of the Firehose Delivery stream to be created. #### Initializer ```typescript import { DeliveryStreamProps } from 'aws-ddk-core' const deliveryStreamProps: DeliveryStreamProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | deliveryStreamName | string | A name for the delivery stream. | | destinations | @aws-cdk/aws-kinesisfirehose-alpha.IDestination[] | The destinations that this delivery stream will deliver data to. | | encryption | @aws-cdk/aws-kinesisfirehose-alpha.StreamEncryption | Indicates the type of customer master key (CMK) to use for server-side encryption, if any. | | encryptionKey | aws-cdk-lib.aws_kms.IKey | Customer managed key to server-side encrypt data in the stream. | | role | aws-cdk-lib.aws_iam.IRole | The IAM role associated with this delivery stream. | | sourceStream | aws-cdk-lib.aws_kinesis.IStream | The Kinesis data stream to use as a source for this delivery stream. | --- ##### `deliveryStreamName`^Optional ```typescript public readonly deliveryStreamName: string; ``` - *Type:* string - *Default:* a name is generated by CloudFormation. A name for the delivery stream. --- ##### `destinations`^Optional ```typescript public readonly destinations: IDestination[]; ``` - *Type:* @aws-cdk/aws-kinesisfirehose-alpha.IDestination[] The destinations that this delivery stream will deliver data to. Only a singleton array is supported at this time. --- ##### `encryption`^Optional ```typescript public readonly encryption: StreamEncryption; ``` - *Type:* @aws-cdk/aws-kinesisfirehose-alpha.StreamEncryption - *Default:* StreamEncryption.UNENCRYPTED - unless `encryptionKey` is provided, in which case this will be implicitly set to `StreamEncryption.CUSTOMER_MANAGED` Indicates the type of customer master key (CMK) to use for server-side encryption, if any. --- ##### `encryptionKey`^Optional ```typescript public readonly encryptionKey: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey - *Default:* no KMS key will be used; if `encryption` is set to `CUSTOMER_MANAGED`, a KMS key will be created for you Customer managed key to server-side encrypt data in the stream. --- ##### `role`^Optional ```typescript public readonly role: IRole; ``` - *Type:* aws-cdk-lib.aws_iam.IRole - *Default:* a role will be created with default permissions. The IAM role associated with this delivery stream. Assumed by Kinesis Data Firehose to read from sources and encrypt data server-side. --- ##### `sourceStream`^Optional ```typescript public readonly sourceStream: IStream; ``` - *Type:* aws-cdk-lib.aws_kinesis.IStream - *Default:* data must be written to the delivery stream via a direct put. The Kinesis data stream to use as a source for this delivery stream. --- ### EMRServerlessClusterProps #### Initializer ```typescript import { EMRServerlessClusterProps } from 'aws-ddk-core' const eMRServerlessClusterProps: EMRServerlessClusterProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | releaseLabel | string | The EMR release associated with the application. | | type | string | The type of application, such as Spark or Hive. | | architecture | string | The CPU architecture of an application. | | autoStartConfiguration | aws-cdk-lib.IResolvable \| aws-cdk-lib.aws_emrserverless.CfnApplication.AutoStartConfigurationProperty | The configuration for an application to automatically start on job submission. | | autoStopConfiguration | aws-cdk-lib.IResolvable \| aws-cdk-lib.aws_emrserverless.CfnApplication.AutoStopConfigurationProperty | The configuration for an application to automatically stop after a certain amount of time being idle. | | imageConfiguration | aws-cdk-lib.IResolvable \| aws-cdk-lib.aws_emrserverless.CfnApplication.ImageConfigurationInputProperty | The image configuration applied to all worker types. | | initialCapacity |

aws-cdk-lib.IResolvable \| aws-cdk-lib.IResolvable \| aws-cdk-lib.aws_emrserverless.CfnApplication.InitialCapacityConfigKeyValuePairProperty[]

| The initial capacity of the application. | | interactiveConfiguration | aws-cdk-lib.IResolvable \| aws-cdk-lib.aws_emrserverless.CfnApplication.InteractiveConfigurationProperty | The interactive configuration object that enables the interactive use cases for an application. | | maximumCapacity | aws-cdk-lib.IResolvable \| aws-cdk-lib.aws_emrserverless.CfnApplication.MaximumAllowedResourcesProperty | The maximum capacity of the application. | | monitoringConfiguration | aws-cdk-lib.IResolvable \| aws-cdk-lib.aws_emrserverless.CfnApplication.MonitoringConfigurationProperty | A configuration specification to be used when provisioning an application. | | name | string | The name of the application. | | networkConfiguration | aws-cdk-lib.IResolvable \| aws-cdk-lib.aws_emrserverless.CfnApplication.NetworkConfigurationProperty | The network configuration for customer VPC connectivity for the application. | | runtimeConfiguration |

aws-cdk-lib.IResolvable \| aws-cdk-lib.IResolvable \| aws-cdk-lib.aws_emrserverless.CfnApplication.ConfigurationObjectProperty[]

| The [Configuration](https://docs.aws.amazon.com/emr-serverless/latest/APIReference/API_Configuration.html) specifications of an application. Each configuration consists of a classification and properties. You use this parameter when creating or updating an application. To see the runtimeConfiguration object of an application, run the [GetApplication](https://docs.aws.amazon.com/emr-serverless/latest/APIReference/API_GetApplication.html) API operation. | | schedulerConfiguration | aws-cdk-lib.IResolvable \| aws-cdk-lib.aws_emrserverless.CfnApplication.SchedulerConfigurationProperty | The scheduler configuration for batch and streaming jobs running on this application. | | tags | aws-cdk-lib.CfnTag[] | The tags assigned to the application. | | workerTypeSpecifications |

aws-cdk-lib.IResolvable \| {[ key: string ]: aws-cdk-lib.IResolvable \| aws-cdk-lib.aws_emrserverless.CfnApplication.WorkerTypeSpecificationInputProperty}

| The specification applied to each worker type. | | additionalPolicyStatements | aws-cdk-lib.aws_iam.PolicyStatement[] | Additional policy statements to add to the emr role. | | s3Bucket | aws-cdk-lib.aws_s3.IBucket | S3 Bucket. | | securityGroup | aws-cdk-lib.aws_ec2.SecurityGroup | Security Group. | | vpcCidr | string | The IP range (CIDR notation) for this VPC. | | vpcId | string | Existing vpc id. | --- ##### `releaseLabel`^Required ```typescript public readonly releaseLabel: string; ``` - *Type:* string The EMR release associated with the application. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#cfn-emrserverless-application-releaselabel](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#cfn-emrserverless-application-releaselabel) --- ##### `type`^Required ```typescript public readonly type: string; ``` - *Type:* string The type of application, such as Spark or Hive. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#cfn-emrserverless-application-type](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#cfn-emrserverless-application-type) --- ##### `architecture`^Optional ```typescript public readonly architecture: string; ``` - *Type:* string The CPU architecture of an application. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#cfn-emrserverless-application-architecture](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#cfn-emrserverless-application-architecture) --- ##### `autoStartConfiguration`^Optional ```typescript public readonly autoStartConfiguration: IResolvable | AutoStartConfigurationProperty; ``` - *Type:* aws-cdk-lib.IResolvable | aws-cdk-lib.aws_emrserverless.CfnApplication.AutoStartConfigurationProperty The configuration for an application to automatically start on job submission. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#cfn-emrserverless-application-autostartconfiguration](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#cfn-emrserverless-application-autostartconfiguration) --- ##### `autoStopConfiguration`^Optional ```typescript public readonly autoStopConfiguration: IResolvable | AutoStopConfigurationProperty; ``` - *Type:* aws-cdk-lib.IResolvable | aws-cdk-lib.aws_emrserverless.CfnApplication.AutoStopConfigurationProperty The configuration for an application to automatically stop after a certain amount of time being idle. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#cfn-emrserverless-application-autostopconfiguration](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#cfn-emrserverless-application-autostopconfiguration) --- ##### `imageConfiguration`^Optional ```typescript public readonly imageConfiguration: IResolvable | ImageConfigurationInputProperty; ``` - *Type:* aws-cdk-lib.IResolvable | aws-cdk-lib.aws_emrserverless.CfnApplication.ImageConfigurationInputProperty The image configuration applied to all worker types. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#cfn-emrserverless-application-imageconfiguration](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#cfn-emrserverless-application-imageconfiguration) --- ##### `initialCapacity`^Optional ```typescript public readonly initialCapacity: IResolvable | IResolvable | InitialCapacityConfigKeyValuePairProperty[]; ``` - *Type:* aws-cdk-lib.IResolvable | aws-cdk-lib.IResolvable | aws-cdk-lib.aws_emrserverless.CfnApplication.InitialCapacityConfigKeyValuePairProperty[] The initial capacity of the application. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#cfn-emrserverless-application-initialcapacity](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#cfn-emrserverless-application-initialcapacity) --- ##### `interactiveConfiguration`^Optional ```typescript public readonly interactiveConfiguration: IResolvable | InteractiveConfigurationProperty; ``` - *Type:* aws-cdk-lib.IResolvable | aws-cdk-lib.aws_emrserverless.CfnApplication.InteractiveConfigurationProperty The interactive configuration object that enables the interactive use cases for an application. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#cfn-emrserverless-application-interactiveconfiguration](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#cfn-emrserverless-application-interactiveconfiguration) --- ##### `maximumCapacity`^Optional ```typescript public readonly maximumCapacity: IResolvable | MaximumAllowedResourcesProperty; ``` - *Type:* aws-cdk-lib.IResolvable | aws-cdk-lib.aws_emrserverless.CfnApplication.MaximumAllowedResourcesProperty The maximum capacity of the application. This is cumulative across all workers at any given point in time during the lifespan of the application is created. No new resources will be created once any one of the defined limits is hit. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#cfn-emrserverless-application-maximumcapacity](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#cfn-emrserverless-application-maximumcapacity) --- ##### `monitoringConfiguration`^Optional ```typescript public readonly monitoringConfiguration: IResolvable | MonitoringConfigurationProperty; ``` - *Type:* aws-cdk-lib.IResolvable | aws-cdk-lib.aws_emrserverless.CfnApplication.MonitoringConfigurationProperty A configuration specification to be used when provisioning an application. A configuration consists of a classification, properties, and optional nested configurations. A classification refers to an application-specific configuration file. Properties are the settings you want to change in that file. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#cfn-emrserverless-application-monitoringconfiguration](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#cfn-emrserverless-application-monitoringconfiguration) --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string The name of the application. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#cfn-emrserverless-application-name](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#cfn-emrserverless-application-name) --- ##### `networkConfiguration`^Optional ```typescript public readonly networkConfiguration: IResolvable | NetworkConfigurationProperty; ``` - *Type:* aws-cdk-lib.IResolvable | aws-cdk-lib.aws_emrserverless.CfnApplication.NetworkConfigurationProperty The network configuration for customer VPC connectivity for the application. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#cfn-emrserverless-application-networkconfiguration](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#cfn-emrserverless-application-networkconfiguration) --- ##### `runtimeConfiguration`^Optional ```typescript public readonly runtimeConfiguration: IResolvable | IResolvable | ConfigurationObjectProperty[]; ``` - *Type:* aws-cdk-lib.IResolvable | aws-cdk-lib.IResolvable | aws-cdk-lib.aws_emrserverless.CfnApplication.ConfigurationObjectProperty[] The [Configuration](https://docs.aws.amazon.com/emr-serverless/latest/APIReference/API_Configuration.html) specifications of an application. Each configuration consists of a classification and properties. You use this parameter when creating or updating an application. To see the runtimeConfiguration object of an application, run the [GetApplication](https://docs.aws.amazon.com/emr-serverless/latest/APIReference/API_GetApplication.html) API operation. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#cfn-emrserverless-application-runtimeconfiguration](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#cfn-emrserverless-application-runtimeconfiguration) --- ##### `schedulerConfiguration`^Optional ```typescript public readonly schedulerConfiguration: IResolvable | SchedulerConfigurationProperty; ``` - *Type:* aws-cdk-lib.IResolvable | aws-cdk-lib.aws_emrserverless.CfnApplication.SchedulerConfigurationProperty The scheduler configuration for batch and streaming jobs running on this application. Supported with release labels emr-7.0.0 and above. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#cfn-emrserverless-application-schedulerconfiguration](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#cfn-emrserverless-application-schedulerconfiguration) --- ##### `tags`^Optional ```typescript public readonly tags: CfnTag[]; ``` - *Type:* aws-cdk-lib.CfnTag[] The tags assigned to the application. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#cfn-emrserverless-application-tags](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#cfn-emrserverless-application-tags) --- ##### `workerTypeSpecifications`^Optional ```typescript public readonly workerTypeSpecifications: IResolvable | {[ key: string ]: IResolvable | WorkerTypeSpecificationInputProperty}; ``` - *Type:* aws-cdk-lib.IResolvable | {[ key: string ]: aws-cdk-lib.IResolvable | aws-cdk-lib.aws_emrserverless.CfnApplication.WorkerTypeSpecificationInputProperty} The specification applied to each worker type. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#cfn-emrserverless-application-workertypespecifications](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrserverless-application.html#cfn-emrserverless-application-workertypespecifications) --- ##### `additionalPolicyStatements`^Optional ```typescript public readonly additionalPolicyStatements: PolicyStatement[]; ``` - *Type:* aws-cdk-lib.aws_iam.PolicyStatement[] Additional policy statements to add to the emr role. --- ##### `s3Bucket`^Optional ```typescript public readonly s3Bucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket S3 Bucket. --- ##### `securityGroup`^Optional ```typescript public readonly securityGroup: SecurityGroup; ``` - *Type:* aws-cdk-lib.aws_ec2.SecurityGroup Security Group. --- ##### `vpcCidr`^Optional ```typescript public readonly vpcCidr: string; ``` - *Type:* string The IP range (CIDR notation) for this VPC. --- ##### `vpcId`^Optional ```typescript public readonly vpcId: string; ``` - *Type:* string Existing vpc id. --- ### EMRServerlessJobStageProps Properties of the EMR Serverless Job stage. #### Initializer ```typescript import { EMRServerlessJobStageProps } from 'aws-ddk-core' const eMRServerlessJobStageProps: EMRServerlessJobStageProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | Description of the stage. | | name | string | Name of the stage. | | additionalRolePolicyStatements | aws-cdk-lib.aws_iam.PolicyStatement[] | Additional IAM policy statements to add to the state machine role. | | alarmsEnabled | boolean | Enable/Disable all alarms in the stage. | | definition | string \| aws-cdk-lib.aws_stepfunctions.IChainable | Steps for the state machine. | | definitionFile | string | File containing a JSON definition for the state machine. | | stateMachineFailedExecutionsAlarmEvaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | stateMachineFailedExecutionsAlarmThreshold | number | The number of failed state machine executions before triggering CW alarm. | | stateMachineInput | {[ key: string ]: any} | Input of the state machine. | | stateMachineName | string | Name of the state machine. | | applicationId | string | EMR Serverless Application Id. | | executionRoleArn | string | EMR Execution Role Arn. | | jobDriver | {[ key: string ]: any} | The job driver for the job run. | | jobExecutionStatusCheckPeriod | aws-cdk-lib.Duration | Duration to wait between polling job status. | | startJobRunProps | {[ key: string ]: any} | Additional properties to pass to 'emrserverless:StartJobRun'. | --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string Description of the stage. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Name of the stage. --- ##### `additionalRolePolicyStatements`^Optional ```typescript public readonly additionalRolePolicyStatements: PolicyStatement[]; ``` - *Type:* aws-cdk-lib.aws_iam.PolicyStatement[] Additional IAM policy statements to add to the state machine role. --- ##### `alarmsEnabled`^Optional ```typescript public readonly alarmsEnabled: boolean; ``` - *Type:* boolean - *Default:* true Enable/Disable all alarms in the stage. --- ##### `definition`^Optional ```typescript public readonly definition: string | IChainable; ``` - *Type:* string | aws-cdk-lib.aws_stepfunctions.IChainable Steps for the state machine. Can either be provided as 'sfn.IChainable' or a JSON string. --- ##### `definitionFile`^Optional ```typescript public readonly definitionFile: string; ``` - *Type:* string File containing a JSON definition for the state machine. --- ##### `stateMachineFailedExecutionsAlarmEvaluationPeriods`^Optional ```typescript public readonly stateMachineFailedExecutionsAlarmEvaluationPeriods: number; ``` - *Type:* number - *Default:* 1 The number of periods over which data is compared to the specified threshold. --- ##### `stateMachineFailedExecutionsAlarmThreshold`^Optional ```typescript public readonly stateMachineFailedExecutionsAlarmThreshold: number; ``` - *Type:* number - *Default:* 1 The number of failed state machine executions before triggering CW alarm. --- ##### `stateMachineInput`^Optional ```typescript public readonly stateMachineInput: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} Input of the state machine. --- ##### `stateMachineName`^Optional ```typescript public readonly stateMachineName: string; ``` - *Type:* string Name of the state machine. --- ##### `applicationId`^Required ```typescript public readonly applicationId: string; ``` - *Type:* string EMR Serverless Application Id. --- ##### `executionRoleArn`^Required ```typescript public readonly executionRoleArn: string; ``` - *Type:* string EMR Execution Role Arn. --- ##### `jobDriver`^Required ```typescript public readonly jobDriver: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} The job driver for the job run. This is a Tagged Union structure. Only one of the following top level keys can be set: 'sparkSubmit', 'hive' --- ##### `jobExecutionStatusCheckPeriod`^Optional ```typescript public readonly jobExecutionStatusCheckPeriod: Duration; ``` - *Type:* aws-cdk-lib.Duration Duration to wait between polling job status. Defaults to 30 seconds. --- ##### `startJobRunProps`^Optional ```typescript public readonly startJobRunProps: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} Additional properties to pass to 'emrserverless:StartJobRun'. https://docs.aws.amazon.com/emr-serverless/latest/APIReference/API_StartJobRun.html --- ### EnvironmentConfiguration #### Initializer ```typescript import { EnvironmentConfiguration } from 'aws-ddk-core' const environmentConfiguration: EnvironmentConfiguration = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | account | string | *No description.* | | bootstrap | {[ key: string ]: string} | *No description.* | | props | {[ key: string ]: any} | *No description.* | | region | string | *No description.* | | resources | {[ key: string ]: any} | *No description.* | | tags | {[ key: string ]: string} | *No description.* | --- ##### `account`^Optional ```typescript public readonly account: string; ``` - *Type:* string --- ##### `bootstrap`^Optional ```typescript public readonly bootstrap: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} --- ##### `props`^Optional ```typescript public readonly props: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} --- ##### `region`^Optional ```typescript public readonly region: string; ``` - *Type:* string --- ##### `resources`^Optional ```typescript public readonly resources: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} --- ##### `tags`^Optional ```typescript public readonly tags: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} --- ### EventStageProps Properties for the event stage. #### Initializer ```typescript import { EventStageProps } from 'aws-ddk-core' const eventStageProps: EventStageProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | Description of the stage. | | name | string | Name of the stage. | --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string Description of the stage. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Name of the stage. --- ### FirehoseToS3StageProps Properties for `FirehoseToS3Stage`. #### Initializer ```typescript import { FirehoseToS3StageProps } from 'aws-ddk-core' const firehoseToS3StageProps: FirehoseToS3StageProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | Description of the stage. | | name | string | Name of the stage. | | alarmsEnabled | boolean | Enable/Disable all alarms in a DataStage. | | dataOutputPrefix | string | A prefix that Kinesis Data Firehose evaluates and adds to records before writing them to S3. | | dataStream | aws-cdk-lib.aws_kinesis.Stream | Preexisting Kinesis Data Stream to use in stage before Delivery Stream. | | dataStreamEnabled | boolean | Add Kinesis Data Stream to front Firehose Delivery. | | deliveryStreamDataFreshnessErrorsAlarmThreshold | number | Threshold for Cloudwatch Alarm created for this stage. | | deliveryStreamDataFreshnessErrorsEvaluationPeriods | number | Evaluation period value for Cloudwatch alarm created for this stage. | | firehoseDeliveryStream | @aws-cdk/aws-kinesisfirehose-alpha.DeliveryStream | Firehose Delivery stream. | | firehoseDeliveryStreamProps | DeliveryStreamProps | Properties of the Firehose Delivery stream to be created. | | kinesisFirehoseDestinationsS3BucketProps | @aws-cdk/aws-kinesisfirehose-destinations-alpha.S3BucketProps | Props for defining an S3 destination of a Kinesis Data Firehose delivery stream. | | s3Bucket | aws-cdk-lib.aws_s3.IBucket | Preexisting S3 Bucket to use as a destination for the Firehose Stream. | | s3BucketProps | aws-cdk-lib.aws_s3.BucketProps | Properties of the S3 Bucket to be created as a delivery destination. | --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string Description of the stage. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Name of the stage. --- ##### `alarmsEnabled`^Optional ```typescript public readonly alarmsEnabled: boolean; ``` - *Type:* boolean - *Default:* true Enable/Disable all alarms in a DataStage. --- ##### `dataOutputPrefix`^Optional ```typescript public readonly dataOutputPrefix: string; ``` - *Type:* string - *Default:* “YYYY/MM/DD/HH” A prefix that Kinesis Data Firehose evaluates and adds to records before writing them to S3. This prefix appears immediately following the bucket name. --- ##### `dataStream`^Optional ```typescript public readonly dataStream: Stream; ``` - *Type:* aws-cdk-lib.aws_kinesis.Stream Preexisting Kinesis Data Stream to use in stage before Delivery Stream. Setting this parameter will override any creation of Kinesis Data Streams in this stage. The `dataStreamEnabled` parameter will have no effect. --- ##### `dataStreamEnabled`^Optional ```typescript public readonly dataStreamEnabled: boolean; ``` - *Type:* boolean - *Default:* false Add Kinesis Data Stream to front Firehose Delivery. --- ##### `deliveryStreamDataFreshnessErrorsAlarmThreshold`^Optional ```typescript public readonly deliveryStreamDataFreshnessErrorsAlarmThreshold: number; ``` - *Type:* number - *Default:* 900 Threshold for Cloudwatch Alarm created for this stage. --- ##### `deliveryStreamDataFreshnessErrorsEvaluationPeriods`^Optional ```typescript public readonly deliveryStreamDataFreshnessErrorsEvaluationPeriods: number; ``` - *Type:* number - *Default:* 1 Evaluation period value for Cloudwatch alarm created for this stage. --- ##### `firehoseDeliveryStream`^Optional ```typescript public readonly firehoseDeliveryStream: DeliveryStream; ``` - *Type:* @aws-cdk/aws-kinesisfirehose-alpha.DeliveryStream Firehose Delivery stream. If no stram is provided, a new one is created. --- ##### `firehoseDeliveryStreamProps`^Optional ```typescript public readonly firehoseDeliveryStreamProps: DeliveryStreamProps; ``` - *Type:* DeliveryStreamProps Properties of the Firehose Delivery stream to be created. --- ##### `kinesisFirehoseDestinationsS3BucketProps`^Optional ```typescript public readonly kinesisFirehoseDestinationsS3BucketProps: S3BucketProps; ``` - *Type:* @aws-cdk/aws-kinesisfirehose-destinations-alpha.S3BucketProps Props for defining an S3 destination of a Kinesis Data Firehose delivery stream. --- ##### `s3Bucket`^Optional ```typescript public readonly s3Bucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket Preexisting S3 Bucket to use as a destination for the Firehose Stream. If no bucket is provided, a new one is created. Amazon EventBridge notifications must be enabled on the bucket in order for this stage to produce events after its completion. --- ##### `s3BucketProps`^Optional ```typescript public readonly s3BucketProps: BucketProps; ``` - *Type:* aws-cdk-lib.aws_s3.BucketProps Properties of the S3 Bucket to be created as a delivery destination. Amazon EventBridge notifications must be enabled on the bucket in order for this stage to produce events after its completion. --- ### GetConfigProps #### Initializer ```typescript import { GetConfigProps } from 'aws-ddk-core' const getConfigProps: GetConfigProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | config | string \| Configuration | *No description.* | --- ##### `config`^Optional ```typescript public readonly config: string | Configuration; ``` - *Type:* string | Configuration --- ### GetEnvConfigProps #### Initializer ```typescript import { GetEnvConfigProps } from 'aws-ddk-core' const getEnvConfigProps: GetEnvConfigProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | environmentId | string | Environment identifier. | | configPath | string | Relative path to config file. | --- ##### `environmentId`^Required ```typescript public readonly environmentId: string; ``` - *Type:* string Environment identifier. --- ##### `configPath`^Optional ```typescript public readonly configPath: string; ``` - *Type:* string Relative path to config file. Defaults to './ddk.json' --- ### GetEnvironmentProps #### Initializer ```typescript import { GetEnvironmentProps } from 'aws-ddk-core' const getEnvironmentProps: GetEnvironmentProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | configPath | string | Relative path to config file. | | environmentId | string | Environment identifier. | --- ##### `configPath`^Optional ```typescript public readonly configPath: string; ``` - *Type:* string Relative path to config file. Defaults to './ddk.json' --- ##### `environmentId`^Optional ```typescript public readonly environmentId: string; ``` - *Type:* string Environment identifier. --- ### GetSynthActionProps #### Initializer ```typescript import { GetSynthActionProps } from 'aws-ddk-core' const getSynthActionProps: GetSynthActionProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | account | string | *No description.* | | additionalInstallCommands | string[] | *No description.* | | cdkVersion | string | *No description.* | | codeartifactDomain | string | *No description.* | | codeartifactDomainOwner | string | *No description.* | | codeartifactRepository | string | *No description.* | | codePipelineSource | aws-cdk-lib.pipelines.IFileSetProducer | *No description.* | | env | {[ key: string ]: string} | *No description.* | | partition | string | *No description.* | | region | string | *No description.* | | rolePolicyStatements | aws-cdk-lib.aws_iam.PolicyStatement[] | *No description.* | --- ##### `account`^Optional ```typescript public readonly account: string; ``` - *Type:* string --- ##### `additionalInstallCommands`^Optional ```typescript public readonly additionalInstallCommands: string[]; ``` - *Type:* string[] --- ##### `cdkVersion`^Optional ```typescript public readonly cdkVersion: string; ``` - *Type:* string --- ##### `codeartifactDomain`^Optional ```typescript public readonly codeartifactDomain: string; ``` - *Type:* string --- ##### `codeartifactDomainOwner`^Optional ```typescript public readonly codeartifactDomainOwner: string; ``` - *Type:* string --- ##### `codeartifactRepository`^Optional ```typescript public readonly codeartifactRepository: string; ``` - *Type:* string --- ##### `codePipelineSource`^Optional ```typescript public readonly codePipelineSource: IFileSetProducer; ``` - *Type:* aws-cdk-lib.pipelines.IFileSetProducer --- ##### `env`^Optional ```typescript public readonly env: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} --- ##### `partition`^Optional ```typescript public readonly partition: string; ``` - *Type:* string --- ##### `region`^Optional ```typescript public readonly region: string; ``` - *Type:* string --- ##### `rolePolicyStatements`^Optional ```typescript public readonly rolePolicyStatements: PolicyStatement[]; ``` - *Type:* aws-cdk-lib.aws_iam.PolicyStatement[] --- ### GetTagsProps #### Initializer ```typescript import { GetTagsProps } from 'aws-ddk-core' const getTagsProps: GetTagsProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | configPath | string | Relative path to config file. | | environmentId | string | Environment identifier. | --- ##### `configPath`^Optional ```typescript public readonly configPath: string; ``` - *Type:* string Relative path to config file. Defaults to './ddk.json' --- ##### `environmentId`^Optional ```typescript public readonly environmentId: string; ``` - *Type:* string Environment identifier. --- ### GlueFactoryProps #### Initializer ```typescript import { GlueFactoryProps } from 'aws-ddk-core' const glueFactoryProps: GlueFactoryProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | glueJobProperties |

@aws-cdk/aws-glue-alpha.PySparkEtlJobProps \| @aws-cdk/aws-glue-alpha.PythonShellJobProps \| @aws-cdk/aws-glue-alpha.PySparkStreamingJobProps \| @aws-cdk/aws-glue-alpha.PySparkFlexEtlJobProps \| @aws-cdk/aws-glue-alpha.ScalaSparkEtlJobProps \| @aws-cdk/aws-glue-alpha.ScalaSparkFlexEtlJobProps \| @aws-cdk/aws-glue-alpha.ScalaSparkStreamingJobProps

| *No description.* | | glueJobType | string | *No description.* | --- ##### `glueJobProperties`^Required ```typescript public readonly glueJobProperties: PySparkEtlJobProps | PythonShellJobProps | PySparkStreamingJobProps | PySparkFlexEtlJobProps | ScalaSparkEtlJobProps | ScalaSparkFlexEtlJobProps | ScalaSparkStreamingJobProps; ``` - *Type:* @aws-cdk/aws-glue-alpha.PySparkEtlJobProps | @aws-cdk/aws-glue-alpha.PythonShellJobProps | @aws-cdk/aws-glue-alpha.PySparkStreamingJobProps | @aws-cdk/aws-glue-alpha.PySparkFlexEtlJobProps | @aws-cdk/aws-glue-alpha.ScalaSparkEtlJobProps | @aws-cdk/aws-glue-alpha.ScalaSparkFlexEtlJobProps | @aws-cdk/aws-glue-alpha.ScalaSparkStreamingJobProps --- ##### `glueJobType`^Required ```typescript public readonly glueJobType: string; ``` - *Type:* string --- ### GlueTransformStageProps Properties for `GlueTransformStage`. #### Initializer ```typescript import { GlueTransformStageProps } from 'aws-ddk-core' const glueTransformStageProps: GlueTransformStageProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | Description of the stage. | | name | string | Name of the stage. | | additionalRolePolicyStatements | aws-cdk-lib.aws_iam.PolicyStatement[] | Additional IAM policy statements to add to the state machine role. | | alarmsEnabled | boolean | Enable/Disable all alarms in the stage. | | definition | string \| aws-cdk-lib.aws_stepfunctions.IChainable | Steps for the state machine. | | definitionFile | string | File containing a JSON definition for the state machine. | | stateMachineFailedExecutionsAlarmEvaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | stateMachineFailedExecutionsAlarmThreshold | number | The number of failed state machine executions before triggering CW alarm. | | stateMachineInput | {[ key: string ]: any} | Input of the state machine. | | stateMachineName | string | Name of the state machine. | | crawlerAllowFailure | boolean | Argument to allow stepfunction success for crawler failures/execption like Glue.CrawlerRunningException. | | crawlerName | string | The name of a preexisting Glue crawler to run. | | crawlerProps | aws-cdk-lib.aws_glue.CfnCrawlerProps | Properties for the Glue Crawler. | | crawlerRole | string | The crawler execution role. | | databaseName | string | The name of the database in which the crawler's output is stored. | | jobName | string | The name of a preexisting Glue job to run. | | jobProps | GlueFactoryProps | Additional Glue job properties. | | jobRunArgs | {[ key: string ]: any} | The input arguments to the Glue job. | | stateMachineRetryBackoffRate | number | Multiplication for how much longer the wait interval gets on every retry. | | stateMachineRetryInterval | aws-cdk-lib.Duration | How many seconds to wait initially before retrying. | | stateMachineRetryMaxAttempts | number | How many times to retry this particular error. | | targets | aws-cdk-lib.aws_glue.CfnCrawler.TargetsProperty | A collection of targets to crawl. | --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string Description of the stage. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Name of the stage. --- ##### `additionalRolePolicyStatements`^Optional ```typescript public readonly additionalRolePolicyStatements: PolicyStatement[]; ``` - *Type:* aws-cdk-lib.aws_iam.PolicyStatement[] Additional IAM policy statements to add to the state machine role. --- ##### `alarmsEnabled`^Optional ```typescript public readonly alarmsEnabled: boolean; ``` - *Type:* boolean - *Default:* true Enable/Disable all alarms in the stage. --- ##### `definition`^Optional ```typescript public readonly definition: string | IChainable; ``` - *Type:* string | aws-cdk-lib.aws_stepfunctions.IChainable Steps for the state machine. Can either be provided as 'sfn.IChainable' or a JSON string. --- ##### `definitionFile`^Optional ```typescript public readonly definitionFile: string; ``` - *Type:* string File containing a JSON definition for the state machine. --- ##### `stateMachineFailedExecutionsAlarmEvaluationPeriods`^Optional ```typescript public readonly stateMachineFailedExecutionsAlarmEvaluationPeriods: number; ``` - *Type:* number - *Default:* 1 The number of periods over which data is compared to the specified threshold. --- ##### `stateMachineFailedExecutionsAlarmThreshold`^Optional ```typescript public readonly stateMachineFailedExecutionsAlarmThreshold: number; ``` - *Type:* number - *Default:* 1 The number of failed state machine executions before triggering CW alarm. --- ##### `stateMachineInput`^Optional ```typescript public readonly stateMachineInput: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} Input of the state machine. --- ##### `stateMachineName`^Optional ```typescript public readonly stateMachineName: string; ``` - *Type:* string Name of the state machine. --- ##### `crawlerAllowFailure`^Optional ```typescript public readonly crawlerAllowFailure: boolean; ``` - *Type:* boolean - *Default:* true Argument to allow stepfunction success for crawler failures/execption like Glue.CrawlerRunningException. --- ##### `crawlerName`^Optional ```typescript public readonly crawlerName: string; ``` - *Type:* string The name of a preexisting Glue crawler to run. If None, a Glue crawler is created. --- ##### `crawlerProps`^Optional ```typescript public readonly crawlerProps: CfnCrawlerProps; ``` - *Type:* aws-cdk-lib.aws_glue.CfnCrawlerProps Properties for the Glue Crawler. > [https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_glue.CfnCrawler.html](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_glue.CfnCrawler.html) --- ##### `crawlerRole`^Optional ```typescript public readonly crawlerRole: string; ``` - *Type:* string The crawler execution role. --- ##### `databaseName`^Optional ```typescript public readonly databaseName: string; ``` - *Type:* string The name of the database in which the crawler's output is stored. --- ##### `jobName`^Optional ```typescript public readonly jobName: string; ``` - *Type:* string The name of a preexisting Glue job to run. If None, a Glue job is created. --- ##### `jobProps`^Optional ```typescript public readonly jobProps: GlueFactoryProps; ``` - *Type:* GlueFactoryProps Additional Glue job properties. For complete list of properties refer to CDK Documentation > [https://docs.aws.amazon.com/cdk/api/v2/docs/](https://docs.aws.amazon.com/cdk/api/v2/docs/) --- ##### `jobRunArgs`^Optional ```typescript public readonly jobRunArgs: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} The input arguments to the Glue job. --- ##### `stateMachineRetryBackoffRate`^Optional ```typescript public readonly stateMachineRetryBackoffRate: number; ``` - *Type:* number - *Default:* 2 Multiplication for how much longer the wait interval gets on every retry. --- ##### `stateMachineRetryInterval`^Optional ```typescript public readonly stateMachineRetryInterval: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* cdk.Duration.seconds(1) How many seconds to wait initially before retrying. --- ##### `stateMachineRetryMaxAttempts`^Optional ```typescript public readonly stateMachineRetryMaxAttempts: number; ``` - *Type:* number - *Default:* 3 How many times to retry this particular error. --- ##### `targets`^Optional ```typescript public readonly targets: TargetsProperty; ``` - *Type:* aws-cdk-lib.aws_glue.CfnCrawler.TargetsProperty A collection of targets to crawl. --- ### MWAAEnvironmentProps #### Initializer ```typescript import { MWAAEnvironmentProps } from 'aws-ddk-core' const mWAAEnvironmentProps: MWAAEnvironmentProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | The name of your Amazon MWAA environment. | | airflowConfigurationOptions | any | A list of key-value pairs containing the Airflow configuration options for your environment. | | airflowVersion | string | The version of Apache Airflow to use for the environment. | | dagS3Path | string | The relative path to the DAGs folder on your Amazon S3 bucket. | | endpointManagement | string | Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA. | | environmentClass | string | The environment class type. | | executionRoleArn | string | The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access AWS resources in your environment. | | kmsKey | string | The AWS Key Management Service (KMS) key to encrypt and decrypt the data in your environment. | | loggingConfiguration | aws-cdk-lib.IResolvable \| aws-cdk-lib.aws_mwaa.CfnEnvironment.LoggingConfigurationProperty | The Apache Airflow logs being sent to CloudWatch Logs: `DagProcessingLogs` , `SchedulerLogs` , `TaskLogs` , `WebserverLogs` , `WorkerLogs` . | | maxWebservers | number | The maximum number of web servers that you want to run in your environment. | | maxWorkers | number | The maximum number of workers that you want to run in your environment. | | minWebservers | number | The minimum number of web servers that you want to run in your environment. | | minWorkers | number | The minimum number of workers that you want to run in your environment. | | networkConfiguration | aws-cdk-lib.IResolvable \| aws-cdk-lib.aws_mwaa.CfnEnvironment.NetworkConfigurationProperty | The VPC networking components used to secure and enable network traffic between the AWS resources for your environment. | | pluginsS3ObjectVersion | string | The version of the plugins.zip file on your Amazon S3 bucket. To learn more, see [Installing custom plugins](https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html) . | | pluginsS3Path | string | The relative path to the `plugins.zip` file on your Amazon S3 bucket. For example, `plugins.zip` . To learn more, see [Installing custom plugins](https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html) . | | requirementsS3ObjectVersion | string | The version of the requirements.txt file on your Amazon S3 bucket. To learn more, see [Installing Python dependencies](https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html) . | | requirementsS3Path | string | The relative path to the `requirements.txt` file on your Amazon S3 bucket. For example, `requirements.txt` . To learn more, see [Installing Python dependencies](https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html) . | | schedulers | number | The number of schedulers that you want to run in your environment. Valid values:. | | sourceBucketArn | string | The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored. | | startupScriptS3ObjectVersion | string | The version of the startup shell script in your Amazon S3 bucket. | | startupScriptS3Path | string | The relative path to the startup shell script in your Amazon S3 bucket. For example, `s3://mwaa-environment/startup.sh` . | | tags | any | The key-value tag pairs associated to your environment. For example, `"Environment": "Staging"` . To learn more, see [Tagging](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) . | | webserverAccessMode | string | The Apache Airflow *Web server* access mode. | | weeklyMaintenanceWindowStart | string | The day and time of the week to start weekly maintenance updates of your environment in the following format: `DAY:HH:MM` . | | additionalPolicyStatements | aws-cdk-lib.aws_iam.PolicyStatement[] | Additional policy statements to add to the airflow execution role. | | dagFiles | string[] | File(s) to be uploaded to dags location in s3 bucket. | | dagProcessingLogs | string | Log level for DagProcessing. | | pluginFile | string | Plugin file to be uploaded to plugin path in S3. | | requirementsFile | string | Requirements file to be uploaded to plugin path in S3. | | s3Bucket | aws-cdk-lib.aws_s3.IBucket | S3 Bucket. | | schedulerLogsLevel | string | Log level for SchedulerLogs. | | taskLogsLevel | string | Log level for TaskLogs. | | vpcCidr | string | The IP range (CIDR notation) for this VPC. | | vpcId | string | Existing vpc id. | | webserverLogsLevel | string | Log level for WebserverLogs. | | workerLogsLevel | string | Log level for WorkerLogs. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of your Amazon MWAA environment. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-name](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-name) --- ##### `airflowConfigurationOptions`^Optional ```typescript public readonly airflowConfigurationOptions: any; ``` - *Type:* any A list of key-value pairs containing the Airflow configuration options for your environment. For example, `core.default_timezone: utc` . To learn more, see [Apache Airflow configuration options](https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-env-variables.html) . > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-airflowconfigurationoptions](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-airflowconfigurationoptions) --- ##### `airflowVersion`^Optional ```typescript public readonly airflowVersion: string; ``` - *Type:* string The version of Apache Airflow to use for the environment. If no value is specified, defaults to the latest version. If you specify a newer version number for an existing environment, the version update requires some service interruption before taking effect. *Allowed Values* : `1.10.12` | `2.0.2` | `2.2.2` | `2.4.3` | `2.5.1` | `2.6.3` | `2.7.2` | `2.8.1` | `2.9.2` (latest) > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-airflowversion](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-airflowversion) --- ##### `dagS3Path`^Optional ```typescript public readonly dagS3Path: string; ``` - *Type:* string The relative path to the DAGs folder on your Amazon S3 bucket. For example, `dags` . To learn more, see [Adding or updating DAGs](https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-folder.html) . > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-dags3path](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-dags3path) --- ##### `endpointManagement`^Optional ```typescript public readonly endpointManagement: string; ``` - *Type:* string Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA. If set to `SERVICE` , Amazon MWAA will create and manage the required VPC endpoints in your VPC. If set to `CUSTOMER` , you must create, and manage, the VPC endpoints in your VPC. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-endpointmanagement](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-endpointmanagement) --- ##### `environmentClass`^Optional ```typescript public readonly environmentClass: string; ``` - *Type:* string The environment class type. Valid values: `mw1.small` , `mw1.medium` , `mw1.large` . To learn more, see [Amazon MWAA environment class](https://docs.aws.amazon.com/mwaa/latest/userguide/environment-class.html) . > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-environmentclass](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-environmentclass) --- ##### `executionRoleArn`^Optional ```typescript public readonly executionRoleArn: string; ``` - *Type:* string The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access AWS resources in your environment. For example, `arn:aws:iam::123456789:role/my-execution-role` . To learn more, see [Amazon MWAA Execution role](https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-create-role.html) . > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-executionrolearn](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-executionrolearn) --- ##### `kmsKey`^Optional ```typescript public readonly kmsKey: string; ``` - *Type:* string The AWS Key Management Service (KMS) key to encrypt and decrypt the data in your environment. You can use an AWS KMS key managed by MWAA, or a customer-managed KMS key (advanced). > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-kmskey](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-kmskey) --- ##### `loggingConfiguration`^Optional ```typescript public readonly loggingConfiguration: IResolvable | LoggingConfigurationProperty; ``` - *Type:* aws-cdk-lib.IResolvable | aws-cdk-lib.aws_mwaa.CfnEnvironment.LoggingConfigurationProperty The Apache Airflow logs being sent to CloudWatch Logs: `DagProcessingLogs` , `SchedulerLogs` , `TaskLogs` , `WebserverLogs` , `WorkerLogs` . > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-loggingconfiguration](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-loggingconfiguration) --- ##### `maxWebservers`^Optional ```typescript public readonly maxWebservers: number; ``` - *Type:* number The maximum number of web servers that you want to run in your environment. Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for `MaxWebservers` when you interact with your Apache Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. For example, in scenarios where your workload requires network calls to the Apache Airflow REST API with a high transaction-per-second (TPS) rate, Amazon MWAA will increase the number of web servers up to the number set in `MaxWebserers` . As TPS rates decrease Amazon MWAA disposes of the additional web servers, and scales down to the number set in `MinxWebserers` . Valid values: For environments larger than mw1.micro, accepts values from `2` to `5` . Defaults to `2` for all environment sizes except mw1.micro, which defaults to `1` . > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-maxwebservers](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-maxwebservers) --- ##### `maxWorkers`^Optional ```typescript public readonly maxWorkers: number; ``` - *Type:* number The maximum number of workers that you want to run in your environment. MWAA scales the number of Apache Airflow workers up to the number you specify in the `MaxWorkers` field. For example, `20` . When there are no more tasks running, and no more in the queue, MWAA disposes of the extra workers leaving the one worker that is included with your environment, or the number you specify in `MinWorkers` . > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-maxworkers](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-maxworkers) --- ##### `minWebservers`^Optional ```typescript public readonly minWebservers: number; ``` - *Type:* number The minimum number of web servers that you want to run in your environment. Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for `MaxWebservers` when you interact with your Apache Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. As the transaction-per-second rate, and the network load, decrease, Amazon MWAA disposes of the additional web servers, and scales down to the number set in `MinxWebserers` . Valid values: For environments larger than mw1.micro, accepts values from `2` to `5` . Defaults to `2` for all environment sizes except mw1.micro, which defaults to `1` . > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-minwebservers](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-minwebservers) --- ##### `minWorkers`^Optional ```typescript public readonly minWorkers: number; ``` - *Type:* number The minimum number of workers that you want to run in your environment. MWAA scales the number of Apache Airflow workers up to the number you specify in the `MaxWorkers` field. When there are no more tasks running, and no more in the queue, MWAA disposes of the extra workers leaving the worker count you specify in the `MinWorkers` field. For example, `2` . > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-minworkers](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-minworkers) --- ##### `networkConfiguration`^Optional ```typescript public readonly networkConfiguration: IResolvable | NetworkConfigurationProperty; ``` - *Type:* aws-cdk-lib.IResolvable | aws-cdk-lib.aws_mwaa.CfnEnvironment.NetworkConfigurationProperty The VPC networking components used to secure and enable network traffic between the AWS resources for your environment. To learn more, see [About networking on Amazon MWAA](https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html) . > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-networkconfiguration](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-networkconfiguration) --- ##### `pluginsS3ObjectVersion`^Optional ```typescript public readonly pluginsS3ObjectVersion: string; ``` - *Type:* string The version of the plugins.zip file on your Amazon S3 bucket. To learn more, see [Installing custom plugins](https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html) . > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-pluginss3objectversion](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-pluginss3objectversion) --- ##### `pluginsS3Path`^Optional ```typescript public readonly pluginsS3Path: string; ``` - *Type:* string The relative path to the `plugins.zip` file on your Amazon S3 bucket. For example, `plugins.zip` . To learn more, see [Installing custom plugins](https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html) . > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-pluginss3path](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-pluginss3path) --- ##### `requirementsS3ObjectVersion`^Optional ```typescript public readonly requirementsS3ObjectVersion: string; ``` - *Type:* string The version of the requirements.txt file on your Amazon S3 bucket. To learn more, see [Installing Python dependencies](https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html) . > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-requirementss3objectversion](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-requirementss3objectversion) --- ##### `requirementsS3Path`^Optional ```typescript public readonly requirementsS3Path: string; ``` - *Type:* string The relative path to the `requirements.txt` file on your Amazon S3 bucket. For example, `requirements.txt` . To learn more, see [Installing Python dependencies](https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html) . > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-requirementss3path](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-requirementss3path) --- ##### `schedulers`^Optional ```typescript public readonly schedulers: number; ``` - *Type:* number The number of schedulers that you want to run in your environment. Valid values:. *v2* - Accepts between 2 to 5. Defaults to 2. - *v1* - Accepts 1. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-schedulers](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-schedulers) --- ##### `sourceBucketArn`^Optional ```typescript public readonly sourceBucketArn: string; ``` - *Type:* string The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored. For example, `arn:aws:s3:::my-airflow-bucket-unique-name` . To learn more, see [Create an Amazon S3 bucket for Amazon MWAA](https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-s3-bucket.html) . > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-sourcebucketarn](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-sourcebucketarn) --- ##### `startupScriptS3ObjectVersion`^Optional ```typescript public readonly startupScriptS3ObjectVersion: string; ``` - *Type:* string The version of the startup shell script in your Amazon S3 bucket. You must specify the [version ID](https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html) that Amazon S3 assigns to the file every time you update the script. Version IDs are Unicode, UTF-8 encoded, URL-ready, opaque strings that are no more than 1,024 bytes long. The following is an example: `3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo` For more information, see [Using a startup script](https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html) . > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-startupscripts3objectversion](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-startupscripts3objectversion) --- ##### `startupScriptS3Path`^Optional ```typescript public readonly startupScriptS3Path: string; ``` - *Type:* string The relative path to the startup shell script in your Amazon S3 bucket. For example, `s3://mwaa-environment/startup.sh` . Amazon MWAA runs the script as your environment starts, and before running the Apache Airflow process. You can use this script to install dependencies, modify Apache Airflow configuration options, and set environment variables. For more information, see [Using a startup script](https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html) . > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-startupscripts3path](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-startupscripts3path) --- ##### `tags`^Optional ```typescript public readonly tags: any; ``` - *Type:* any The key-value tag pairs associated to your environment. For example, `"Environment": "Staging"` . To learn more, see [Tagging](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) . If you specify new tags for an existing environment, the update requires service interruption before taking effect. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-tags](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-tags) --- ##### `webserverAccessMode`^Optional ```typescript public readonly webserverAccessMode: string; ``` - *Type:* string The Apache Airflow *Web server* access mode. To learn more, see [Apache Airflow access modes](https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-networking.html) . Valid values: `PRIVATE_ONLY` or `PUBLIC_ONLY` . > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-webserveraccessmode](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-webserveraccessmode) --- ##### `weeklyMaintenanceWindowStart`^Optional ```typescript public readonly weeklyMaintenanceWindowStart: string; ``` - *Type:* string The day and time of the week to start weekly maintenance updates of your environment in the following format: `DAY:HH:MM` . For example: `TUE:03:30` . You can specify a start time in 30 minute increments only. Supported input includes the following: - MON|TUE|WED|THU|FRI|SAT|SUN:([01]\\d|2[0-3]):(00|30) > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-weeklymaintenancewindowstart](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-weeklymaintenancewindowstart) --- ##### `additionalPolicyStatements`^Optional ```typescript public readonly additionalPolicyStatements: PolicyStatement[]; ``` - *Type:* aws-cdk-lib.aws_iam.PolicyStatement[] Additional policy statements to add to the airflow execution role. --- ##### `dagFiles`^Optional ```typescript public readonly dagFiles: string[]; ``` - *Type:* string[] File(s) to be uploaded to dags location in s3 bucket. --- ##### `dagProcessingLogs`^Optional ```typescript public readonly dagProcessingLogs: string; ``` - *Type:* string Log level for DagProcessing. --- ##### `pluginFile`^Optional ```typescript public readonly pluginFile: string; ``` - *Type:* string Plugin file to be uploaded to plugin path in S3. 'pluginsS3Path' must be specified as well. --- ##### `requirementsFile`^Optional ```typescript public readonly requirementsFile: string; ``` - *Type:* string Requirements file to be uploaded to plugin path in S3. 'requirementsS3Path' must be specified as well. --- ##### `s3Bucket`^Optional ```typescript public readonly s3Bucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket S3 Bucket. --- ##### `schedulerLogsLevel`^Optional ```typescript public readonly schedulerLogsLevel: string; ``` - *Type:* string Log level for SchedulerLogs. --- ##### `taskLogsLevel`^Optional ```typescript public readonly taskLogsLevel: string; ``` - *Type:* string Log level for TaskLogs. --- ##### `vpcCidr`^Optional ```typescript public readonly vpcCidr: string; ``` - *Type:* string The IP range (CIDR notation) for this VPC. --- ##### `vpcId`^Optional ```typescript public readonly vpcId: string; ``` - *Type:* string Existing vpc id. --- ##### `webserverLogsLevel`^Optional ```typescript public readonly webserverLogsLevel: string; ``` - *Type:* string Log level for WebserverLogs. --- ##### `workerLogsLevel`^Optional ```typescript public readonly workerLogsLevel: string; ``` - *Type:* string Log level for WorkerLogs. --- ### MWAALambdasResult #### Initializer ```typescript import { MWAALambdasResult } from 'aws-ddk-core' const mWAALambdasResult: MWAALambdasResult = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | statusLambda | aws-cdk-lib.aws_lambda.Function | *No description.* | | triggerLambda | aws-cdk-lib.aws_lambda.Function | *No description.* | --- ##### `statusLambda`^Required ```typescript public readonly statusLambda: Function; ``` - *Type:* aws-cdk-lib.aws_lambda.Function --- ##### `triggerLambda`^Required ```typescript public readonly triggerLambda: Function; ``` - *Type:* aws-cdk-lib.aws_lambda.Function --- ### MWAATriggerDagsStageProps Properties of the MWAA Trigger Dags stage. #### Initializer ```typescript import { MWAATriggerDagsStageProps } from 'aws-ddk-core' const mWAATriggerDagsStageProps: MWAATriggerDagsStageProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | Description of the stage. | | name | string | Name of the stage. | | additionalRolePolicyStatements | aws-cdk-lib.aws_iam.PolicyStatement[] | Additional IAM policy statements to add to the state machine role. | | alarmsEnabled | boolean | Enable/Disable all alarms in the stage. | | definition | string \| aws-cdk-lib.aws_stepfunctions.IChainable | Steps for the state machine. | | definitionFile | string | File containing a JSON definition for the state machine. | | stateMachineFailedExecutionsAlarmEvaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | stateMachineFailedExecutionsAlarmThreshold | number | The number of failed state machine executions before triggering CW alarm. | | stateMachineInput | {[ key: string ]: any} | Input of the state machine. | | stateMachineName | string | Name of the state machine. | | mwaaEnvironmentName | string | Name of airflow environment. | | dagPath | string | Path to array of dag id's to check. | | dags | string[] | Name of dag(s) to trigger. | | statusCheckPeriod | aws-cdk-lib.Duration | Time to wait between execution status checks. | --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string Description of the stage. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Name of the stage. --- ##### `additionalRolePolicyStatements`^Optional ```typescript public readonly additionalRolePolicyStatements: PolicyStatement[]; ``` - *Type:* aws-cdk-lib.aws_iam.PolicyStatement[] Additional IAM policy statements to add to the state machine role. --- ##### `alarmsEnabled`^Optional ```typescript public readonly alarmsEnabled: boolean; ``` - *Type:* boolean - *Default:* true Enable/Disable all alarms in the stage. --- ##### `definition`^Optional ```typescript public readonly definition: string | IChainable; ``` - *Type:* string | aws-cdk-lib.aws_stepfunctions.IChainable Steps for the state machine. Can either be provided as 'sfn.IChainable' or a JSON string. --- ##### `definitionFile`^Optional ```typescript public readonly definitionFile: string; ``` - *Type:* string File containing a JSON definition for the state machine. --- ##### `stateMachineFailedExecutionsAlarmEvaluationPeriods`^Optional ```typescript public readonly stateMachineFailedExecutionsAlarmEvaluationPeriods: number; ``` - *Type:* number - *Default:* 1 The number of periods over which data is compared to the specified threshold. --- ##### `stateMachineFailedExecutionsAlarmThreshold`^Optional ```typescript public readonly stateMachineFailedExecutionsAlarmThreshold: number; ``` - *Type:* number - *Default:* 1 The number of failed state machine executions before triggering CW alarm. --- ##### `stateMachineInput`^Optional ```typescript public readonly stateMachineInput: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} Input of the state machine. --- ##### `stateMachineName`^Optional ```typescript public readonly stateMachineName: string; ``` - *Type:* string Name of the state machine. --- ##### `mwaaEnvironmentName`^Required ```typescript public readonly mwaaEnvironmentName: string; ``` - *Type:* string Name of airflow environment. --- ##### `dagPath`^Optional ```typescript public readonly dagPath: string; ``` - *Type:* string Path to array of dag id's to check. --- ##### `dags`^Optional ```typescript public readonly dags: string[]; ``` - *Type:* string[] Name of dag(s) to trigger. --- ##### `statusCheckPeriod`^Optional ```typescript public readonly statusCheckPeriod: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* aws_cdk.Duration.seconds(15) Time to wait between execution status checks. --- ### PermissionsBoundaryProps #### Initializer ```typescript import { PermissionsBoundaryProps } from 'aws-ddk-core' const permissionsBoundaryProps: PermissionsBoundaryProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | environmentId | string | *No description.* | | prefix | string | *No description.* | | qualifier | string | *No description.* | --- ##### `environmentId`^Optional ```typescript public readonly environmentId: string; ``` - *Type:* string --- ##### `prefix`^Optional ```typescript public readonly prefix: string; ``` - *Type:* string --- ##### `qualifier`^Optional ```typescript public readonly qualifier: string; ``` - *Type:* string --- ### RedshiftDataApiStageProps Properties for `RedshiftDataApiStage`. #### Initializer ```typescript import { RedshiftDataApiStageProps } from 'aws-ddk-core' const redshiftDataApiStageProps: RedshiftDataApiStageProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | Description of the stage. | | name | string | Name of the stage. | | additionalRolePolicyStatements | aws-cdk-lib.aws_iam.PolicyStatement[] | Additional IAM policy statements to add to the state machine role. | | alarmsEnabled | boolean | Enable/Disable all alarms in the stage. | | definition | string \| aws-cdk-lib.aws_stepfunctions.IChainable | Steps for the state machine. | | definitionFile | string | File containing a JSON definition for the state machine. | | stateMachineFailedExecutionsAlarmEvaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | stateMachineFailedExecutionsAlarmThreshold | number | The number of failed state machine executions before triggering CW alarm. | | stateMachineInput | {[ key: string ]: any} | Input of the state machine. | | stateMachineName | string | Name of the state machine. | | redshiftClusterIdentifier | string | Identifier of the Redshift cluster. | | sqlStatements | string[] | List of SQL statements to execute. | | databaseName | string | Name of the database in Redshift. | | databaseUser | string | Database user. | | pollingTime | aws-cdk-lib.Duration | Waiting time between checking whether the statements have finished executing. | --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string Description of the stage. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Name of the stage. --- ##### `additionalRolePolicyStatements`^Optional ```typescript public readonly additionalRolePolicyStatements: PolicyStatement[]; ``` - *Type:* aws-cdk-lib.aws_iam.PolicyStatement[] Additional IAM policy statements to add to the state machine role. --- ##### `alarmsEnabled`^Optional ```typescript public readonly alarmsEnabled: boolean; ``` - *Type:* boolean - *Default:* true Enable/Disable all alarms in the stage. --- ##### `definition`^Optional ```typescript public readonly definition: string | IChainable; ``` - *Type:* string | aws-cdk-lib.aws_stepfunctions.IChainable Steps for the state machine. Can either be provided as 'sfn.IChainable' or a JSON string. --- ##### `definitionFile`^Optional ```typescript public readonly definitionFile: string; ``` - *Type:* string File containing a JSON definition for the state machine. --- ##### `stateMachineFailedExecutionsAlarmEvaluationPeriods`^Optional ```typescript public readonly stateMachineFailedExecutionsAlarmEvaluationPeriods: number; ``` - *Type:* number - *Default:* 1 The number of periods over which data is compared to the specified threshold. --- ##### `stateMachineFailedExecutionsAlarmThreshold`^Optional ```typescript public readonly stateMachineFailedExecutionsAlarmThreshold: number; ``` - *Type:* number - *Default:* 1 The number of failed state machine executions before triggering CW alarm. --- ##### `stateMachineInput`^Optional ```typescript public readonly stateMachineInput: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} Input of the state machine. --- ##### `stateMachineName`^Optional ```typescript public readonly stateMachineName: string; ``` - *Type:* string Name of the state machine. --- ##### `redshiftClusterIdentifier`^Required ```typescript public readonly redshiftClusterIdentifier: string; ``` - *Type:* string Identifier of the Redshift cluster. --- ##### `sqlStatements`^Required ```typescript public readonly sqlStatements: string[]; ``` - *Type:* string[] List of SQL statements to execute. --- ##### `databaseName`^Optional ```typescript public readonly databaseName: string; ``` - *Type:* string - *Default:* "dev" Name of the database in Redshift. --- ##### `databaseUser`^Optional ```typescript public readonly databaseUser: string; ``` - *Type:* string - *Default:* "awsuser" Database user. --- ##### `pollingTime`^Optional ```typescript public readonly pollingTime: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* cdk.Duration.seconds(15) Waiting time between checking whether the statements have finished executing. --- ### S3EventStageProps Properties for `S3EventStage`. #### Initializer ```typescript import { S3EventStageProps } from 'aws-ddk-core' const s3EventStageProps: S3EventStageProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | Description of the stage. | | name | string | Name of the stage. | | bucket | aws-cdk-lib.aws_s3.IBucket \| aws-cdk-lib.aws_s3.IBucket[] | S3 Bucket or list of buckets. | | eventNames | string[] | The list of events to capture, for example: ["Object Created"]. | | keyPrefix | string \| string[] | The S3 prefix or list of prefixes. | --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string Description of the stage. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Name of the stage. --- ##### `bucket`^Required ```typescript public readonly bucket: IBucket | IBucket[]; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket | aws-cdk-lib.aws_s3.IBucket[] S3 Bucket or list of buckets. Amazon EventBridge notifications must be enabled on the bucket in order to use this construct. --- ##### `eventNames`^Required ```typescript public readonly eventNames: string[]; ``` - *Type:* string[] The list of events to capture, for example: ["Object Created"]. > [https://docs.aws.amazon.com/AmazonS3/latest/userguide/EventBridge.html](https://docs.aws.amazon.com/AmazonS3/latest/userguide/EventBridge.html) --- ##### `keyPrefix`^Optional ```typescript public readonly keyPrefix: string | string[]; ``` - *Type:* string | string[] The S3 prefix or list of prefixes. Capture root level prefix ("/") by default. --- ### SnsToLambdaStageProps Properties for `SnsSqsToLambdaStage`. #### Initializer ```typescript import { SnsToLambdaStageProps } from 'aws-ddk-core' const snsToLambdaStageProps: SnsToLambdaStageProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | Description of the stage. | | name | string | Name of the stage. | | alarmsEnabled | boolean | Enable/Disable all alarms in a DataStage. | | batchSize | number | The maximum number of records retrieved from the event source at the function invocation time. | | dlqEnabled | boolean | Determines if DLQ is enabled. | | lambdaFunction | aws-cdk-lib.aws_lambda.IFunction | Preexisting Lambda Function to use in stage. | | lambdaFunctionProps | SqsToLambdaStageFunctionProps | Properties for the Lambda Function that will be created by this construct (if `lambdaFunction` is not provided). | | maxBatchingWindow | aws-cdk-lib.Duration | The maximum amount of time to gather records before invoking the function. | | maxReceiveCount | number | The number of times a message can be unsuccessfully dequeued before being moved to the dead-letter queue. | | messageGroupId | string | Message Group ID for messages sent to this queue. | | sqsQueue | aws-cdk-lib.aws_sqs.IQueue | Preexisting SQS Queue to use in stage. | | sqsQueueProps | aws-cdk-lib.aws_sqs.QueueProps | Properties for the SQS Queue that will be created by this construct (if `sqsQueue` is not provided). | | disableDefaultTopicPolicy | boolean | Whether to disable the default topic policy generated by SnsFactory. | | filterPolicy | {[ key: string ]: aws-cdk-lib.aws_sns.SubscriptionFilter} | The filter policy. | | rawMessageDelivery | boolean | The message to the queue is the same as it was sent to the topic. | | snsDlqEnabled | boolean | Queue to be used as dead letter queue. | | snsTopic | aws-cdk-lib.aws_sns.ITopic | Preexisting SNS Topic to use in stage. | | snsTopicProps | aws-cdk-lib.aws_sns.TopicProps | Properties for the SNS Topic that will be created by this construct (if `snsTopic` is not provided). | --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string Description of the stage. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Name of the stage. --- ##### `alarmsEnabled`^Optional ```typescript public readonly alarmsEnabled: boolean; ``` - *Type:* boolean - *Default:* true Enable/Disable all alarms in a DataStage. --- ##### `batchSize`^Optional ```typescript public readonly batchSize: number; ``` - *Type:* number - *Default:* 10 The maximum number of records retrieved from the event source at the function invocation time. --- ##### `dlqEnabled`^Optional ```typescript public readonly dlqEnabled: boolean; ``` - *Type:* boolean - *Default:* false Determines if DLQ is enabled. --- ##### `lambdaFunction`^Optional ```typescript public readonly lambdaFunction: IFunction; ``` - *Type:* aws-cdk-lib.aws_lambda.IFunction Preexisting Lambda Function to use in stage. If not provided, a new function will be created. --- ##### `lambdaFunctionProps`^Optional ```typescript public readonly lambdaFunctionProps: SqsToLambdaStageFunctionProps; ``` - *Type:* SqsToLambdaStageFunctionProps Properties for the Lambda Function that will be created by this construct (if `lambdaFunction` is not provided). --- ##### `maxBatchingWindow`^Optional ```typescript public readonly maxBatchingWindow: Duration; ``` - *Type:* aws-cdk-lib.Duration The maximum amount of time to gather records before invoking the function. Valid Range: Minimum value of 0 minutes, maximum value of 5 minutes. Default: - no batching window. --- ##### `maxReceiveCount`^Optional ```typescript public readonly maxReceiveCount: number; ``` - *Type:* number - *Default:* 1 The number of times a message can be unsuccessfully dequeued before being moved to the dead-letter queue. --- ##### `messageGroupId`^Optional ```typescript public readonly messageGroupId: string; ``` - *Type:* string Message Group ID for messages sent to this queue. Required for FIFO queues. --- ##### `sqsQueue`^Optional ```typescript public readonly sqsQueue: IQueue; ``` - *Type:* aws-cdk-lib.aws_sqs.IQueue Preexisting SQS Queue to use in stage. If not provided, a new queue will be created. --- ##### `sqsQueueProps`^Optional ```typescript public readonly sqsQueueProps: QueueProps; ``` - *Type:* aws-cdk-lib.aws_sqs.QueueProps Properties for the SQS Queue that will be created by this construct (if `sqsQueue` is not provided). --- ##### `disableDefaultTopicPolicy`^Optional ```typescript public readonly disableDefaultTopicPolicy: boolean; ``` - *Type:* boolean - *Default:* false Whether to disable the default topic policy generated by SnsFactory. > [SnsFactory.secureSnsTopicPolicy](SnsFactory.secureSnsTopicPolicy) --- ##### `filterPolicy`^Optional ```typescript public readonly filterPolicy: {[ key: string ]: SubscriptionFilter}; ``` - *Type:* {[ key: string ]: aws-cdk-lib.aws_sns.SubscriptionFilter} - *Default:* all messages are delivered The filter policy. --- ##### `rawMessageDelivery`^Optional ```typescript public readonly rawMessageDelivery: boolean; ``` - *Type:* boolean - *Default:* false The message to the queue is the same as it was sent to the topic. If false, the message will be wrapped in an SNS envelope. --- ##### `snsDlqEnabled`^Optional ```typescript public readonly snsDlqEnabled: boolean; ``` - *Type:* boolean - *Default:* No dead letter queue enabled. Queue to be used as dead letter queue. If not passed no dead letter queue is enabled. --- ##### `snsTopic`^Optional ```typescript public readonly snsTopic: ITopic; ``` - *Type:* aws-cdk-lib.aws_sns.ITopic Preexisting SNS Topic to use in stage. If not provided, a new one will be created. --- ##### `snsTopicProps`^Optional ```typescript public readonly snsTopicProps: TopicProps; ``` - *Type:* aws-cdk-lib.aws_sns.TopicProps Properties for the SNS Topic that will be created by this construct (if `snsTopic` is not provided). --- ### SourceActionProps Properties for the source action. #### Initializer ```typescript import { SourceActionProps } from 'aws-ddk-core' const sourceActionProps: SourceActionProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | repositoryName | string | Name of the SCM repository. | | branch | string | Branch of the SCM repository. | | sourceAction | aws-cdk-lib.pipelines.CodePipelineSource | Override source action. | --- ##### `repositoryName`^Required ```typescript public readonly repositoryName: string; ``` - *Type:* string Name of the SCM repository. --- ##### `branch`^Optional ```typescript public readonly branch: string; ``` - *Type:* string Branch of the SCM repository. --- ##### `sourceAction`^Optional ```typescript public readonly sourceAction: CodePipelineSource; ``` - *Type:* aws-cdk-lib.pipelines.CodePipelineSource Override source action. --- ### SqsToLambdaStageFunctionProps Properties for the Lambda Function created by `SqsToLambdaStage`. #### Initializer ```typescript import { SqsToLambdaStageFunctionProps } from 'aws-ddk-core' const sqsToLambdaStageFunctionProps: SqsToLambdaStageFunctionProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | maxEventAge | aws-cdk-lib.Duration | The maximum age of a request that Lambda sends to a function for processing. | | onFailure | aws-cdk-lib.aws_lambda.IDestination | The destination for failed invocations. | | onSuccess | aws-cdk-lib.aws_lambda.IDestination | The destination for successful invocations. | | retryAttempts | number | The maximum number of times to retry when the function returns an error. | | adotInstrumentation | aws-cdk-lib.aws_lambda.AdotInstrumentationConfig | Specify the configuration of AWS Distro for OpenTelemetry (ADOT) instrumentation. | | allowAllIpv6Outbound | boolean | Whether to allow the Lambda to send all ipv6 network traffic. | | allowAllOutbound | boolean | Whether to allow the Lambda to send all network traffic (except ipv6). | | allowPublicSubnet | boolean | Lambda Functions in a public subnet can NOT access the internet. | | applicationLogLevel | string | Sets the application log level for the function. | | applicationLogLevelV2 | aws-cdk-lib.aws_lambda.ApplicationLogLevel | Sets the application log level for the function. | | architecture | aws-cdk-lib.aws_lambda.Architecture | The system architectures compatible with this lambda function. | | codeSigningConfig | aws-cdk-lib.aws_lambda.ICodeSigningConfig | Code signing config associated with this function. | | currentVersionOptions | aws-cdk-lib.aws_lambda.VersionOptions | Options for the `lambda.Version` resource automatically created by the `fn.currentVersion` method. | | deadLetterQueue | aws-cdk-lib.aws_sqs.IQueue | The SQS queue to use if DLQ is enabled. | | deadLetterQueueEnabled | boolean | Enabled DLQ. | | deadLetterTopic | aws-cdk-lib.aws_sns.ITopic | The SNS topic to use as a DLQ. | | description | string | A description of the function. | | environment | {[ key: string ]: string} | Key-value pairs that Lambda caches and makes available for your Lambda functions. | | environmentEncryption | aws-cdk-lib.aws_kms.IKey | The AWS KMS key that's used to encrypt your function's environment variables. | | ephemeralStorageSize | aws-cdk-lib.Size | The size of the function’s /tmp directory in MiB. | | events | aws-cdk-lib.aws_lambda.IEventSource[] | Event sources for this function. | | filesystem | aws-cdk-lib.aws_lambda.FileSystem | The filesystem configuration for the lambda function. | | functionName | string | A name for the function. | | initialPolicy | aws-cdk-lib.aws_iam.PolicyStatement[] | Initial policy statements to add to the created Lambda Role. | | insightsVersion | aws-cdk-lib.aws_lambda.LambdaInsightsVersion | Specify the version of CloudWatch Lambda insights to use for monitoring. | | ipv6AllowedForDualStack | boolean | Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets. | | layers | aws-cdk-lib.aws_lambda.ILayerVersion[] | A list of layers to add to the function's execution environment. | | logFormat | string | Sets the logFormat for the function. | | loggingFormat | aws-cdk-lib.aws_lambda.LoggingFormat | Sets the loggingFormat for the function. | | logGroup | aws-cdk-lib.aws_logs.ILogGroup | The log group the function sends logs to. | | logRetention | aws-cdk-lib.aws_logs.RetentionDays | The number of days log events are kept in CloudWatch Logs. | | logRetentionRetryOptions | aws-cdk-lib.aws_lambda.LogRetentionRetryOptions | When log retention is specified, a custom resource attempts to create the CloudWatch log group. | | logRetentionRole | aws-cdk-lib.aws_iam.IRole | The IAM role for the Lambda function associated with the custom resource that sets the retention policy. | | memorySize | number | The amount of memory, in MB, that is allocated to your Lambda function. | | paramsAndSecrets | aws-cdk-lib.aws_lambda.ParamsAndSecretsLayerVersion | Specify the configuration of Parameters and Secrets Extension. | | profiling | boolean | Enable profiling. | | profilingGroup | aws-cdk-lib.aws_codeguruprofiler.IProfilingGroup | Profiling Group. | | recursiveLoop | aws-cdk-lib.aws_lambda.RecursiveLoop | Sets the Recursive Loop Protection for Lambda Function. | | reservedConcurrentExecutions | number | The maximum of concurrent executions you want to reserve for the function. | | role | aws-cdk-lib.aws_iam.IRole | Lambda execution role. | | runtimeManagementMode | aws-cdk-lib.aws_lambda.RuntimeManagementMode | Sets the runtime management configuration for a function's version. | | securityGroups | aws-cdk-lib.aws_ec2.ISecurityGroup[] | The list of security groups to associate with the Lambda's network interfaces. | | snapStart | aws-cdk-lib.aws_lambda.SnapStartConf | Enable SnapStart for Lambda Function. | | systemLogLevel | string | Sets the system log level for the function. | | systemLogLevelV2 | aws-cdk-lib.aws_lambda.SystemLogLevel | Sets the system log level for the function. | | timeout | aws-cdk-lib.Duration | The function execution time (in seconds) after which Lambda terminates the function. | | tracing | aws-cdk-lib.aws_lambda.Tracing | Enable AWS X-Ray Tracing for Lambda Function. | | vpc | aws-cdk-lib.aws_ec2.IVpc | VPC network to place Lambda network interfaces. | | vpcSubnets | aws-cdk-lib.aws_ec2.SubnetSelection | Where to place the network interfaces within the VPC. | | code | aws-cdk-lib.aws_lambda.Code | The source code of your Lambda function. | | handler | string | The name of the method within your code that Lambda calls to execute your function. | | runtime | aws-cdk-lib.aws_lambda.Runtime | The runtime environment for the Lambda function that you are uploading. | | errorsAlarmThreshold | number | Amount of errored function invocations before triggering CloudWatch alarm. | | errorsComparisonOperator | aws-cdk-lib.aws_cloudwatch.ComparisonOperator | Comparison operator for evaluating alarms. | | errorsEvaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `maxEventAge`^Optional ```typescript public readonly maxEventAge: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.hours(6) The maximum age of a request that Lambda sends to a function for processing. Minimum: 60 seconds Maximum: 6 hours --- ##### `onFailure`^Optional ```typescript public readonly onFailure: IDestination; ``` - *Type:* aws-cdk-lib.aws_lambda.IDestination - *Default:* no destination The destination for failed invocations. --- ##### `onSuccess`^Optional ```typescript public readonly onSuccess: IDestination; ``` - *Type:* aws-cdk-lib.aws_lambda.IDestination - *Default:* no destination The destination for successful invocations. --- ##### `retryAttempts`^Optional ```typescript public readonly retryAttempts: number; ``` - *Type:* number - *Default:* 2 The maximum number of times to retry when the function returns an error. Minimum: 0 Maximum: 2 --- ##### `adotInstrumentation`^Optional ```typescript public readonly adotInstrumentation: AdotInstrumentationConfig; ``` - *Type:* aws-cdk-lib.aws_lambda.AdotInstrumentationConfig - *Default:* No ADOT instrumentation Specify the configuration of AWS Distro for OpenTelemetry (ADOT) instrumentation. > [https://aws-otel.github.io/docs/getting-started/lambda](https://aws-otel.github.io/docs/getting-started/lambda) --- ##### `allowAllIpv6Outbound`^Optional ```typescript public readonly allowAllIpv6Outbound: boolean; ``` - *Type:* boolean - *Default:* false Whether to allow the Lambda to send all ipv6 network traffic. If set to true, there will only be a single egress rule which allows all outbound ipv6 traffic. If set to false, you must individually add traffic rules to allow the Lambda to connect to network targets using ipv6. Do not specify this property if the `securityGroups` or `securityGroup` property is set. Instead, configure `allowAllIpv6Outbound` directly on the security group. --- ##### `allowAllOutbound`^Optional ```typescript public readonly allowAllOutbound: boolean; ``` - *Type:* boolean - *Default:* true Whether to allow the Lambda to send all network traffic (except ipv6). If set to false, you must individually add traffic rules to allow the Lambda to connect to network targets. Do not specify this property if the `securityGroups` or `securityGroup` property is set. Instead, configure `allowAllOutbound` directly on the security group. --- ##### `allowPublicSubnet`^Optional ```typescript public readonly allowPublicSubnet: boolean; ``` - *Type:* boolean - *Default:* false Lambda Functions in a public subnet can NOT access the internet. Use this property to acknowledge this limitation and still place the function in a public subnet. > [https://stackoverflow.com/questions/52992085/why-cant-an-aws-lambda-function-inside-a-public-subnet-in-a-vpc-connect-to-the/52994841#52994841](https://stackoverflow.com/questions/52992085/why-cant-an-aws-lambda-function-inside-a-public-subnet-in-a-vpc-connect-to-the/52994841#52994841) --- ##### ~~`applicationLogLevel`~~^Optional - *Deprecated:* Use `applicationLogLevelV2` as a property instead. ```typescript public readonly applicationLogLevel: string; ``` - *Type:* string - *Default:* "INFO" Sets the application log level for the function. --- ##### `applicationLogLevelV2`^Optional ```typescript public readonly applicationLogLevelV2: ApplicationLogLevel; ``` - *Type:* aws-cdk-lib.aws_lambda.ApplicationLogLevel - *Default:* ApplicationLogLevel.INFO Sets the application log level for the function. --- ##### `architecture`^Optional ```typescript public readonly architecture: Architecture; ``` - *Type:* aws-cdk-lib.aws_lambda.Architecture - *Default:* Architecture.X86_64 The system architectures compatible with this lambda function. --- ##### `codeSigningConfig`^Optional ```typescript public readonly codeSigningConfig: ICodeSigningConfig; ``` - *Type:* aws-cdk-lib.aws_lambda.ICodeSigningConfig - *Default:* Not Sign the Code Code signing config associated with this function. --- ##### `currentVersionOptions`^Optional ```typescript public readonly currentVersionOptions: VersionOptions; ``` - *Type:* aws-cdk-lib.aws_lambda.VersionOptions - *Default:* default options as described in `VersionOptions` Options for the `lambda.Version` resource automatically created by the `fn.currentVersion` method. --- ##### `deadLetterQueue`^Optional ```typescript public readonly deadLetterQueue: IQueue; ``` - *Type:* aws-cdk-lib.aws_sqs.IQueue - *Default:* SQS queue with 14 day retention period if `deadLetterQueueEnabled` is `true` The SQS queue to use if DLQ is enabled. If SNS topic is desired, specify `deadLetterTopic` property instead. --- ##### `deadLetterQueueEnabled`^Optional ```typescript public readonly deadLetterQueueEnabled: boolean; ``` - *Type:* boolean - *Default:* false unless `deadLetterQueue` is set, which implies DLQ is enabled. Enabled DLQ. If `deadLetterQueue` is undefined, an SQS queue with default options will be defined for your Function. --- ##### `deadLetterTopic`^Optional ```typescript public readonly deadLetterTopic: ITopic; ``` - *Type:* aws-cdk-lib.aws_sns.ITopic - *Default:* no SNS topic The SNS topic to use as a DLQ. Note that if `deadLetterQueueEnabled` is set to `true`, an SQS queue will be created rather than an SNS topic. Using an SNS topic as a DLQ requires this property to be set explicitly. --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* No description. A description of the function. --- ##### `environment`^Optional ```typescript public readonly environment: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} - *Default:* No environment variables. Key-value pairs that Lambda caches and makes available for your Lambda functions. Use environment variables to apply configuration changes, such as test and production environment configurations, without changing your Lambda function source code. --- ##### `environmentEncryption`^Optional ```typescript public readonly environmentEncryption: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey - *Default:* AWS Lambda creates and uses an AWS managed customer master key (CMK). The AWS KMS key that's used to encrypt your function's environment variables. --- ##### `ephemeralStorageSize`^Optional ```typescript public readonly ephemeralStorageSize: Size; ``` - *Type:* aws-cdk-lib.Size - *Default:* 512 MiB The size of the function’s /tmp directory in MiB. --- ##### `events`^Optional ```typescript public readonly events: IEventSource[]; ``` - *Type:* aws-cdk-lib.aws_lambda.IEventSource[] - *Default:* No event sources. Event sources for this function. You can also add event sources using `addEventSource`. --- ##### `filesystem`^Optional ```typescript public readonly filesystem: FileSystem; ``` - *Type:* aws-cdk-lib.aws_lambda.FileSystem - *Default:* will not mount any filesystem The filesystem configuration for the lambda function. --- ##### `functionName`^Optional ```typescript public readonly functionName: string; ``` - *Type:* string - *Default:* AWS CloudFormation generates a unique physical ID and uses that ID for the function's name. For more information, see Name Type. A name for the function. --- ##### `initialPolicy`^Optional ```typescript public readonly initialPolicy: PolicyStatement[]; ``` - *Type:* aws-cdk-lib.aws_iam.PolicyStatement[] - *Default:* No policy statements are added to the created Lambda role. Initial policy statements to add to the created Lambda Role. You can call `addToRolePolicy` to the created lambda to add statements post creation. --- ##### `insightsVersion`^Optional ```typescript public readonly insightsVersion: LambdaInsightsVersion; ``` - *Type:* aws-cdk-lib.aws_lambda.LambdaInsightsVersion - *Default:* No Lambda Insights Specify the version of CloudWatch Lambda insights to use for monitoring. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Lambda-Insights-Getting-Started-docker.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Lambda-Insights-Getting-Started-docker.html) --- ##### `ipv6AllowedForDualStack`^Optional ```typescript public readonly ipv6AllowedForDualStack: boolean; ``` - *Type:* boolean - *Default:* false Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets. Only used if 'vpc' is supplied. --- ##### `layers`^Optional ```typescript public readonly layers: ILayerVersion[]; ``` - *Type:* aws-cdk-lib.aws_lambda.ILayerVersion[] - *Default:* No layers. A list of layers to add to the function's execution environment. You can configure your Lambda function to pull in additional code during initialization in the form of layers. Layers are packages of libraries or other dependencies that can be used by multiple functions. --- ##### ~~`logFormat`~~^Optional - *Deprecated:* Use `loggingFormat` as a property instead. ```typescript public readonly logFormat: string; ``` - *Type:* string - *Default:* "Text" Sets the logFormat for the function. --- ##### `loggingFormat`^Optional ```typescript public readonly loggingFormat: LoggingFormat; ``` - *Type:* aws-cdk-lib.aws_lambda.LoggingFormat - *Default:* LoggingFormat.TEXT Sets the loggingFormat for the function. --- ##### `logGroup`^Optional ```typescript public readonly logGroup: ILogGroup; ``` - *Type:* aws-cdk-lib.aws_logs.ILogGroup - *Default:* `/aws/lambda/${this.functionName}` - default log group created by Lambda The log group the function sends logs to. By default, Lambda functions send logs to an automatically created default log group named /aws/lambda/\. However you cannot change the properties of this auto-created log group using the AWS CDK, e.g. you cannot set a different log retention. Use the `logGroup` property to create a fully customizable LogGroup ahead of time, and instruct the Lambda function to send logs to it. Providing a user-controlled log group was rolled out to commercial regions on 2023-11-16. If you are deploying to another type of region, please check regional availability first. --- ##### `logRetention`^Optional ```typescript public readonly logRetention: RetentionDays; ``` - *Type:* aws-cdk-lib.aws_logs.RetentionDays - *Default:* logs.RetentionDays.INFINITE The number of days log events are kept in CloudWatch Logs. When updating this property, unsetting it doesn't remove the log retention policy. To remove the retention policy, set the value to `INFINITE`. This is a legacy API and we strongly recommend you move away from it if you can. Instead create a fully customizable log group with `logs.LogGroup` and use the `logGroup` property to instruct the Lambda function to send logs to it. Migrating from `logRetention` to `logGroup` will cause the name of the log group to change. Users and code and referencing the name verbatim will have to adjust. In AWS CDK code, you can access the log group name directly from the LogGroup construct: ```ts import * as logs from 'aws-cdk-lib/aws-logs'; declare const myLogGroup: logs.LogGroup; myLogGroup.logGroupName; ``` --- ##### `logRetentionRetryOptions`^Optional ```typescript public readonly logRetentionRetryOptions: LogRetentionRetryOptions; ``` - *Type:* aws-cdk-lib.aws_lambda.LogRetentionRetryOptions - *Default:* Default AWS SDK retry options. When log retention is specified, a custom resource attempts to create the CloudWatch log group. These options control the retry policy when interacting with CloudWatch APIs. This is a legacy API and we strongly recommend you migrate to `logGroup` if you can. `logGroup` allows you to create a fully customizable log group and instruct the Lambda function to send logs to it. --- ##### `logRetentionRole`^Optional ```typescript public readonly logRetentionRole: IRole; ``` - *Type:* aws-cdk-lib.aws_iam.IRole - *Default:* A new role is created. The IAM role for the Lambda function associated with the custom resource that sets the retention policy. This is a legacy API and we strongly recommend you migrate to `logGroup` if you can. `logGroup` allows you to create a fully customizable log group and instruct the Lambda function to send logs to it. --- ##### `memorySize`^Optional ```typescript public readonly memorySize: number; ``` - *Type:* number - *Default:* 128 The amount of memory, in MB, that is allocated to your Lambda function. Lambda uses this value to proportionally allocate the amount of CPU power. For more information, see Resource Model in the AWS Lambda Developer Guide. --- ##### `paramsAndSecrets`^Optional ```typescript public readonly paramsAndSecrets: ParamsAndSecretsLayerVersion; ``` - *Type:* aws-cdk-lib.aws_lambda.ParamsAndSecretsLayerVersion - *Default:* No Parameters and Secrets Extension Specify the configuration of Parameters and Secrets Extension. > [https://docs.aws.amazon.com/systems-manager/latest/userguide/ps-integration-lambda-extensions.html](https://docs.aws.amazon.com/systems-manager/latest/userguide/ps-integration-lambda-extensions.html) --- ##### `profiling`^Optional ```typescript public readonly profiling: boolean; ``` - *Type:* boolean - *Default:* No profiling. Enable profiling. > [https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html](https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html) --- ##### `profilingGroup`^Optional ```typescript public readonly profilingGroup: IProfilingGroup; ``` - *Type:* aws-cdk-lib.aws_codeguruprofiler.IProfilingGroup - *Default:* A new profiling group will be created if `profiling` is set. Profiling Group. > [https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html](https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html) --- ##### `recursiveLoop`^Optional ```typescript public readonly recursiveLoop: RecursiveLoop; ``` - *Type:* aws-cdk-lib.aws_lambda.RecursiveLoop - *Default:* RecursiveLoop.Terminate Sets the Recursive Loop Protection for Lambda Function. It lets Lambda detect and terminate unintended recursive loops. --- ##### `reservedConcurrentExecutions`^Optional ```typescript public readonly reservedConcurrentExecutions: number; ``` - *Type:* number - *Default:* No specific limit - account limit. The maximum of concurrent executions you want to reserve for the function. > [https://docs.aws.amazon.com/lambda/latest/dg/concurrent-executions.html](https://docs.aws.amazon.com/lambda/latest/dg/concurrent-executions.html) --- ##### `role`^Optional ```typescript public readonly role: IRole; ``` - *Type:* aws-cdk-lib.aws_iam.IRole - *Default:* A unique role will be generated for this lambda function. Both supplied and generated roles can always be changed by calling `addToRolePolicy`. Lambda execution role. This is the role that will be assumed by the function upon execution. It controls the permissions that the function will have. The Role must be assumable by the 'lambda.amazonaws.com' service principal. The default Role automatically has permissions granted for Lambda execution. If you provide a Role, you must add the relevant AWS managed policies yourself. The relevant managed policies are "service-role/AWSLambdaBasicExecutionRole" and "service-role/AWSLambdaVPCAccessExecutionRole". --- ##### `runtimeManagementMode`^Optional ```typescript public readonly runtimeManagementMode: RuntimeManagementMode; ``` - *Type:* aws-cdk-lib.aws_lambda.RuntimeManagementMode - *Default:* Auto Sets the runtime management configuration for a function's version. --- ##### `securityGroups`^Optional ```typescript public readonly securityGroups: ISecurityGroup[]; ``` - *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup[] - *Default:* If the function is placed within a VPC and a security group is not specified, either by this or securityGroup prop, a dedicated security group will be created for this function. The list of security groups to associate with the Lambda's network interfaces. Only used if 'vpc' is supplied. --- ##### `snapStart`^Optional ```typescript public readonly snapStart: SnapStartConf; ``` - *Type:* aws-cdk-lib.aws_lambda.SnapStartConf - *Default:* No snapstart Enable SnapStart for Lambda Function. SnapStart is currently supported for Java 11, Java 17, Python 3.12, Python 3.13, and .NET 8 runtime --- ##### ~~`systemLogLevel`~~^Optional - *Deprecated:* Use `systemLogLevelV2` as a property instead. ```typescript public readonly systemLogLevel: string; ``` - *Type:* string - *Default:* "INFO" Sets the system log level for the function. --- ##### `systemLogLevelV2`^Optional ```typescript public readonly systemLogLevelV2: SystemLogLevel; ``` - *Type:* aws-cdk-lib.aws_lambda.SystemLogLevel - *Default:* SystemLogLevel.INFO Sets the system log level for the function. --- ##### `timeout`^Optional ```typescript public readonly timeout: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.seconds(3) The function execution time (in seconds) after which Lambda terminates the function. Because the execution time affects cost, set this value based on the function's expected execution time. --- ##### `tracing`^Optional ```typescript public readonly tracing: Tracing; ``` - *Type:* aws-cdk-lib.aws_lambda.Tracing - *Default:* Tracing.Disabled Enable AWS X-Ray Tracing for Lambda Function. --- ##### `vpc`^Optional ```typescript public readonly vpc: IVpc; ``` - *Type:* aws-cdk-lib.aws_ec2.IVpc - *Default:* Function is not placed within a VPC. VPC network to place Lambda network interfaces. Specify this if the Lambda function needs to access resources in a VPC. This is required when `vpcSubnets` is specified. --- ##### `vpcSubnets`^Optional ```typescript public readonly vpcSubnets: SubnetSelection; ``` - *Type:* aws-cdk-lib.aws_ec2.SubnetSelection - *Default:* the Vpc default strategy if not specified Where to place the network interfaces within the VPC. This requires `vpc` to be specified in order for interfaces to actually be placed in the subnets. If `vpc` is not specify, this will raise an error. Note: Internet access for Lambda Functions requires a NAT Gateway, so picking public subnets is not allowed (unless `allowPublicSubnet` is set to `true`). --- ##### `code`^Required ```typescript public readonly code: Code; ``` - *Type:* aws-cdk-lib.aws_lambda.Code The source code of your Lambda function. You can point to a file in an Amazon Simple Storage Service (Amazon S3) bucket or specify your source code as inline text. --- ##### `handler`^Required ```typescript public readonly handler: string; ``` - *Type:* string The name of the method within your code that Lambda calls to execute your function. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see https://docs.aws.amazon.com/lambda/latest/dg/foundation-progmodel.html. Use `Handler.FROM_IMAGE` when defining a function from a Docker image. NOTE: If you specify your source code as inline text by specifying the ZipFile property within the Code property, specify index.function_name as the handler. --- ##### `runtime`^Required ```typescript public readonly runtime: Runtime; ``` - *Type:* aws-cdk-lib.aws_lambda.Runtime The runtime environment for the Lambda function that you are uploading. For valid values, see the Runtime property in the AWS Lambda Developer Guide. Use `Runtime.FROM_IMAGE` when defining a function from a Docker image. --- ##### `errorsAlarmThreshold`^Optional ```typescript public readonly errorsAlarmThreshold: number; ``` - *Type:* number - *Default:* 5 Amount of errored function invocations before triggering CloudWatch alarm. --- ##### `errorsComparisonOperator`^Optional ```typescript public readonly errorsComparisonOperator: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* cloudwatch.ComparisonOperator.GREATER_THAN_THRESHOLD Comparison operator for evaluating alarms. --- ##### `errorsEvaluationPeriods`^Optional ```typescript public readonly errorsEvaluationPeriods: number; ``` - *Type:* number - *Default:* 1 The number of periods over which data is compared to the specified threshold. --- ### SqsToLambdaStageProps Properties for `SqsToLambdaStage`. #### Initializer ```typescript import { SqsToLambdaStageProps } from 'aws-ddk-core' const sqsToLambdaStageProps: SqsToLambdaStageProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | Description of the stage. | | name | string | Name of the stage. | | alarmsEnabled | boolean | Enable/Disable all alarms in a DataStage. | | batchSize | number | The maximum number of records retrieved from the event source at the function invocation time. | | dlqEnabled | boolean | Determines if DLQ is enabled. | | lambdaFunction | aws-cdk-lib.aws_lambda.IFunction | Preexisting Lambda Function to use in stage. | | lambdaFunctionProps | SqsToLambdaStageFunctionProps | Properties for the Lambda Function that will be created by this construct (if `lambdaFunction` is not provided). | | maxBatchingWindow | aws-cdk-lib.Duration | The maximum amount of time to gather records before invoking the function. | | maxReceiveCount | number | The number of times a message can be unsuccessfully dequeued before being moved to the dead-letter queue. | | messageGroupId | string | Message Group ID for messages sent to this queue. | | sqsQueue | aws-cdk-lib.aws_sqs.IQueue | Preexisting SQS Queue to use in stage. | | sqsQueueProps | aws-cdk-lib.aws_sqs.QueueProps | Properties for the SQS Queue that will be created by this construct (if `sqsQueue` is not provided). | --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string Description of the stage. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Name of the stage. --- ##### `alarmsEnabled`^Optional ```typescript public readonly alarmsEnabled: boolean; ``` - *Type:* boolean - *Default:* true Enable/Disable all alarms in a DataStage. --- ##### `batchSize`^Optional ```typescript public readonly batchSize: number; ``` - *Type:* number - *Default:* 10 The maximum number of records retrieved from the event source at the function invocation time. --- ##### `dlqEnabled`^Optional ```typescript public readonly dlqEnabled: boolean; ``` - *Type:* boolean - *Default:* false Determines if DLQ is enabled. --- ##### `lambdaFunction`^Optional ```typescript public readonly lambdaFunction: IFunction; ``` - *Type:* aws-cdk-lib.aws_lambda.IFunction Preexisting Lambda Function to use in stage. If not provided, a new function will be created. --- ##### `lambdaFunctionProps`^Optional ```typescript public readonly lambdaFunctionProps: SqsToLambdaStageFunctionProps; ``` - *Type:* SqsToLambdaStageFunctionProps Properties for the Lambda Function that will be created by this construct (if `lambdaFunction` is not provided). --- ##### `maxBatchingWindow`^Optional ```typescript public readonly maxBatchingWindow: Duration; ``` - *Type:* aws-cdk-lib.Duration The maximum amount of time to gather records before invoking the function. Valid Range: Minimum value of 0 minutes, maximum value of 5 minutes. Default: - no batching window. --- ##### `maxReceiveCount`^Optional ```typescript public readonly maxReceiveCount: number; ``` - *Type:* number - *Default:* 1 The number of times a message can be unsuccessfully dequeued before being moved to the dead-letter queue. --- ##### `messageGroupId`^Optional ```typescript public readonly messageGroupId: string; ``` - *Type:* string Message Group ID for messages sent to this queue. Required for FIFO queues. --- ##### `sqsQueue`^Optional ```typescript public readonly sqsQueue: IQueue; ``` - *Type:* aws-cdk-lib.aws_sqs.IQueue Preexisting SQS Queue to use in stage. If not provided, a new queue will be created. --- ##### `sqsQueueProps`^Optional ```typescript public readonly sqsQueueProps: QueueProps; ``` - *Type:* aws-cdk-lib.aws_sqs.QueueProps Properties for the SQS Queue that will be created by this construct (if `sqsQueue` is not provided). --- ### StageProps Properties for the base abstract stage. #### Initializer ```typescript import { StageProps } from 'aws-ddk-core' const stageProps: StageProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | Description of the stage. | | name | string | Name of the stage. | --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string Description of the stage. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Name of the stage. --- ### StateMachineStageProps Properties of a state machine stage. #### Initializer ```typescript import { StateMachineStageProps } from 'aws-ddk-core' const stateMachineStageProps: StateMachineStageProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | description | string | Description of the stage. | | name | string | Name of the stage. | | additionalRolePolicyStatements | aws-cdk-lib.aws_iam.PolicyStatement[] | Additional IAM policy statements to add to the state machine role. | | alarmsEnabled | boolean | Enable/Disable all alarms in the stage. | | definition | string \| aws-cdk-lib.aws_stepfunctions.IChainable | Steps for the state machine. | | definitionFile | string | File containing a JSON definition for the state machine. | | stateMachineFailedExecutionsAlarmEvaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | stateMachineFailedExecutionsAlarmThreshold | number | The number of failed state machine executions before triggering CW alarm. | | stateMachineInput | {[ key: string ]: any} | Input of the state machine. | | stateMachineName | string | Name of the state machine. | --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string Description of the stage. --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string Name of the stage. --- ##### `additionalRolePolicyStatements`^Optional ```typescript public readonly additionalRolePolicyStatements: PolicyStatement[]; ``` - *Type:* aws-cdk-lib.aws_iam.PolicyStatement[] Additional IAM policy statements to add to the state machine role. --- ##### `alarmsEnabled`^Optional ```typescript public readonly alarmsEnabled: boolean; ``` - *Type:* boolean - *Default:* true Enable/Disable all alarms in the stage. --- ##### `definition`^Optional ```typescript public readonly definition: string | IChainable; ``` - *Type:* string | aws-cdk-lib.aws_stepfunctions.IChainable Steps for the state machine. Can either be provided as 'sfn.IChainable' or a JSON string. --- ##### `definitionFile`^Optional ```typescript public readonly definitionFile: string; ``` - *Type:* string File containing a JSON definition for the state machine. --- ##### `stateMachineFailedExecutionsAlarmEvaluationPeriods`^Optional ```typescript public readonly stateMachineFailedExecutionsAlarmEvaluationPeriods: number; ``` - *Type:* number - *Default:* 1 The number of periods over which data is compared to the specified threshold. --- ##### `stateMachineFailedExecutionsAlarmThreshold`^Optional ```typescript public readonly stateMachineFailedExecutionsAlarmThreshold: number; ``` - *Type:* number - *Default:* 1 The number of failed state machine executions before triggering CW alarm. --- ##### `stateMachineInput`^Optional ```typescript public readonly stateMachineInput: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} Input of the state machine. --- ##### `stateMachineName`^Optional ```typescript public readonly stateMachineName: string; ``` - *Type:* string Name of the state machine. --- ### SynthActionProps Properties for the synth action. #### Initializer ```typescript import { SynthActionProps } from 'aws-ddk-core' const synthActionProps: SynthActionProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | additionalInstallCommands | string[] | Additional install commands. | | cdkLanguageCommandLineArguments | {[ key: string ]: string} | Additional command line arguements to append to the install command of the `cdk_langauge` that is specified. | | cdkVersion | string | CDK versio to use during the synth action. | | codeartifactDomain | string | Name of the CodeArtifact domain. | | codeartifactDomainOwner | string | CodeArtifact domain owner account. | | codeartifactRepository | string | Name of the CodeArtifact repository to pull artifacts from. | | env | {[ key: string ]: any} | Environment variables to set. | | rolePolicyStatements | aws-cdk-lib.aws_iam.PolicyStatement[] | Additional policies to add to the synth action role. | | synthAction | aws-cdk-lib.pipelines.CodeBuildStep | Override synth action. | --- ##### `additionalInstallCommands`^Optional ```typescript public readonly additionalInstallCommands: string[]; ``` - *Type:* string[] Additional install commands. --- ##### `cdkLanguageCommandLineArguments`^Optional ```typescript public readonly cdkLanguageCommandLineArguments: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} - *Default:* No command line arguments are appended Additional command line arguements to append to the install command of the `cdk_langauge` that is specified. --- ##### `cdkVersion`^Optional ```typescript public readonly cdkVersion: string; ``` - *Type:* string - *Default:* "latest" CDK versio to use during the synth action. --- ##### `codeartifactDomain`^Optional ```typescript public readonly codeartifactDomain: string; ``` - *Type:* string Name of the CodeArtifact domain. --- ##### `codeartifactDomainOwner`^Optional ```typescript public readonly codeartifactDomainOwner: string; ``` - *Type:* string CodeArtifact domain owner account. --- ##### `codeartifactRepository`^Optional ```typescript public readonly codeartifactRepository: string; ``` - *Type:* string Name of the CodeArtifact repository to pull artifacts from. --- ##### `env`^Optional ```typescript public readonly env: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} Environment variables to set. --- ##### `rolePolicyStatements`^Optional ```typescript public readonly rolePolicyStatements: PolicyStatement[]; ``` - *Type:* aws-cdk-lib.aws_iam.PolicyStatement[] Additional policies to add to the synth action role. --- ##### `synthAction`^Optional ```typescript public readonly synthAction: CodeBuildStep; ``` - *Type:* aws-cdk-lib.pipelines.CodeBuildStep Override synth action. --- ## Classes ### CICDActions #### Initializers ```typescript import { CICDActions } from 'aws-ddk-core' new CICDActions() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Static Functions | **Name** | **Description** | | --- | --- | | getBanditAction | *No description.* | | getCfnNagAction | *No description.* | | getCodeArtifactPublishAction | *No description.* | | getCodeCommitSourceAction | *No description.* | | getSynthAction | *No description.* | | getTestsAction | *No description.* | --- ##### `getBanditAction` ```typescript import { CICDActions } from 'aws-ddk-core' CICDActions.getBanditAction(codePipelineSource: CodePipelineSource, stageName?: string) ``` ###### `codePipelineSource`^Required - *Type:* aws-cdk-lib.pipelines.CodePipelineSource --- ###### `stageName`^Optional - *Type:* string --- ##### `getCfnNagAction` ```typescript import { CICDActions } from 'aws-ddk-core' CICDActions.getCfnNagAction(fileSetProducer: IFileSetProducer, stageName?: string, failBuild?: boolean) ``` ###### `fileSetProducer`^Required - *Type:* aws-cdk-lib.pipelines.IFileSetProducer --- ###### `stageName`^Optional - *Type:* string --- ###### `failBuild`^Optional - *Type:* boolean --- ##### `getCodeArtifactPublishAction` ```typescript import { CICDActions } from 'aws-ddk-core' CICDActions.getCodeArtifactPublishAction(partition: string, region: string, account: string, codeartifactRepository: string, codeartifactDomain: string, codeartifactDomainOwner: string, codePipelineSource?: CodePipelineSource, rolePolicyStatements?: PolicyStatement[]) ``` ###### `partition`^Required - *Type:* string --- ###### `region`^Required - *Type:* string --- ###### `account`^Required - *Type:* string --- ###### `codeartifactRepository`^Required - *Type:* string --- ###### `codeartifactDomain`^Required - *Type:* string --- ###### `codeartifactDomainOwner`^Required - *Type:* string --- ###### `codePipelineSource`^Optional - *Type:* aws-cdk-lib.pipelines.CodePipelineSource --- ###### `rolePolicyStatements`^Optional - *Type:* aws-cdk-lib.aws_iam.PolicyStatement[] --- ##### `getCodeCommitSourceAction` ```typescript import { CICDActions } from 'aws-ddk-core' CICDActions.getCodeCommitSourceAction(scope: Construct, props: CodeCommitSourceActionProps) ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `props`^Required - *Type:* CodeCommitSourceActionProps --- ##### `getSynthAction` ```typescript import { CICDActions } from 'aws-ddk-core' CICDActions.getSynthAction(props: GetSynthActionProps) ``` ###### `props`^Required - *Type:* GetSynthActionProps --- ##### `getTestsAction` ```typescript import { CICDActions } from 'aws-ddk-core' CICDActions.getTestsAction(fileSetProducer: IFileSetProducer, commands?: string[], installCommands?: string[], stageName?: string) ``` ###### `fileSetProducer`^Required - *Type:* aws-cdk-lib.pipelines.IFileSetProducer --- ###### `commands`^Optional - *Type:* string[] --- ###### `installCommands`^Optional - *Type:* string[] --- ###### `stageName`^Optional - *Type:* string --- ### Configurator #### Initializers ```typescript import { Configurator } from 'aws-ddk-core' new Configurator(scope: Construct, config: string | Configuration, environmentId?: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | config | string \| Configuration | *No description.* | | environmentId | string | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `config`^Required - *Type:* string | Configuration --- ##### `environmentId`^Optional - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | getConfigAttribute | *No description.* | | tagConstruct | *No description.* | --- ##### `getConfigAttribute` ```typescript public getConfigAttribute(attribute: string): any ``` ###### `attribute`^Required - *Type:* string --- ##### `tagConstruct` ```typescript public tagConstruct(scope: Construct, tags: {[ key: string ]: string}): void ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `tags`^Required - *Type:* {[ key: string ]: string} --- #### Static Functions | **Name** | **Description** | | --- | --- | | getConfig | *No description.* | | getEnvConfig | *No description.* | | getEnvironment | *No description.* | | getTags | *No description.* | --- ##### `getConfig` ```typescript import { Configurator } from 'aws-ddk-core' Configurator.getConfig(props: GetConfigProps) ``` ###### `props`^Required - *Type:* GetConfigProps --- ##### `getEnvConfig` ```typescript import { Configurator } from 'aws-ddk-core' Configurator.getEnvConfig(props: GetEnvConfigProps) ``` ###### `props`^Required - *Type:* GetEnvConfigProps --- ##### `getEnvironment` ```typescript import { Configurator } from 'aws-ddk-core' Configurator.getEnvironment(props: GetEnvironmentProps) ``` ###### `props`^Required - *Type:* GetEnvironmentProps --- ##### `getTags` ```typescript import { Configurator } from 'aws-ddk-core' Configurator.getTags(props: GetTagsProps) ``` ###### `props`^Required - *Type:* GetTagsProps --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | config | Configuration | *No description.* | | environmentId | string | *No description.* | --- ##### `config`^Required ```typescript public readonly config: Configuration; ``` - *Type:* Configuration --- ##### `environmentId`^Optional ```typescript public readonly environmentId: string; ``` - *Type:* string --- ### GlueFactory #### Initializers ```typescript import { GlueFactory } from 'aws-ddk-core' new GlueFactory() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Static Functions | **Name** | **Description** | | --- | --- | | job | *No description.* | --- ##### `job` ```typescript import { GlueFactory } from 'aws-ddk-core' GlueFactory.job(scope: Construct, id: string, props: GlueFactoryProps) ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `props`^Required - *Type:* GlueFactoryProps --- ### KmsFactory #### Initializers ```typescript import { KmsFactory } from 'aws-ddk-core' new KmsFactory() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Static Functions | **Name** | **Description** | | --- | --- | | key | *No description.* | --- ##### `key` ```typescript import { KmsFactory } from 'aws-ddk-core' KmsFactory.key(scope: Construct, id: string, props: KeyProps) ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `props`^Required - *Type:* aws-cdk-lib.aws_kms.KeyProps --- ### S3Factory #### Initializers ```typescript import { S3Factory } from 'aws-ddk-core' new S3Factory() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Static Functions | **Name** | **Description** | | --- | --- | | bucket | *No description.* | --- ##### `bucket` ```typescript import { S3Factory } from 'aws-ddk-core' S3Factory.bucket(scope: Construct, id: string, props: BucketProps) ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `props`^Required - *Type:* aws-cdk-lib.aws_s3.BucketProps --- ### SnsFactory #### Initializers ```typescript import { SnsFactory } from 'aws-ddk-core' new SnsFactory() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Static Functions | **Name** | **Description** | | --- | --- | | secureSnsTopicPolicy | *No description.* | --- ##### `secureSnsTopicPolicy` ```typescript import { SnsFactory } from 'aws-ddk-core' SnsFactory.secureSnsTopicPolicy(topic: ITopic) ``` ###### `topic`^Required - *Type:* aws-cdk-lib.aws_sns.ITopic --- ## Enums ### GlueJobType #### Members | **Name** | **Description** | | --- | --- | | PY_SPARK_ETL_JOB | *No description.* | | PYTHON_SHELL_JOB | *No description.* | | PY_SPARK_STREAMING_JOB | *No description.* | | PY_SPARK_FLEX_ETL_JOB | *No description.* | | SCALA_SPARK_ETL_JOB | *No description.* | | SCALA_SPARK_FLEX_ETL_JOB | *No description.* | | SCALA_SPARK_STREAMING_JOB | *No description.* | --- ##### `PY_SPARK_ETL_JOB` --- ##### `PYTHON_SHELL_JOB` --- ##### `PY_SPARK_STREAMING_JOB` --- ##### `PY_SPARK_FLEX_ETL_JOB` --- ##### `SCALA_SPARK_ETL_JOB` --- ##### `SCALA_SPARK_FLEX_ETL_JOB` --- ##### `SCALA_SPARK_STREAMING_JOB` ---