cdk-bootstrapless-synthesizer
Version:
Generate directly usable AWS CloudFormation template with aws-cdk v2.
598 lines (349 loc) • 25.7 kB
Markdown
# API Reference <a name="API Reference" id="api-reference"></a>
## Structs <a name="Structs" id="structs"></a>
### BootstraplessStackSynthesizerProps <a name="cdk-bootstrapless-synthesizer.BootstraplessStackSynthesizerProps" id="cdkbootstraplesssynthesizerbootstraplessstacksynthesizerprops"></a>
Configuration properties for BootstraplessStackSynthesizer.
#### Initializer <a name="[object Object].Initializer" id="object-objectinitializer"></a>
```typescript
import { BootstraplessStackSynthesizerProps } from 'cdk-bootstrapless-synthesizer'
const bootstraplessStackSynthesizerProps: BootstraplessStackSynthesizerProps = { ... }
```
#### Properties <a name="Properties" id="properties"></a>
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`fileAssetBucketName`](#cdkbootstraplesssynthesizerbootstraplessstacksynthesizerpropspropertyfileassetbucketname) | `string` | Name of the S3 bucket to hold file assets. |
| [`fileAssetPrefix`](#cdkbootstraplesssynthesizerbootstraplessstacksynthesizerpropspropertyfileassetprefix) | `string` | Object key prefix to use while storing S3 Assets. |
| [`fileAssetPublishingRoleArn`](#cdkbootstraplesssynthesizerbootstraplessstacksynthesizerpropspropertyfileassetpublishingrolearn) | `string` | The role to use to publish file assets to the S3 bucket in this environment. |
| [`fileAssetRegionSet`](#cdkbootstraplesssynthesizerbootstraplessstacksynthesizerpropspropertyfileassetregionset) | `string`[] | The regions set of file assets to be published only when `fileAssetBucketName` contains `${AWS::Region}`. |
| [`imageAssetAccountId`](#cdkbootstraplesssynthesizerbootstraplessstacksynthesizerpropspropertyimageassetaccountid) | `string` | Override the ECR repository account id of the Docker Image assets. |
| [`imageAssetPublishingRoleArn`](#cdkbootstraplesssynthesizerbootstraplessstacksynthesizerpropspropertyimageassetpublishingrolearn) | `string` | The role to use to publish image assets to the ECR repository in this environment. |
| [`imageAssetRegionSet`](#cdkbootstraplesssynthesizerbootstraplessstacksynthesizerpropspropertyimageassetregionset) | `string`[] | Override the ECR repository region of the Docker Image assets. |
| [`imageAssetRepositoryName`](#cdkbootstraplesssynthesizerbootstraplessstacksynthesizerpropspropertyimageassetrepositoryname) | `string` | Name of the ECR repository to hold Docker Image assets. |
| [`imageAssetTagPrefix`](#cdkbootstraplesssynthesizerbootstraplessstacksynthesizerpropspropertyimageassettagprefix) | `string` | Override the tag prefix of the Docker Image assets. |
| [`imageAssetTagSuffixType`](#cdkbootstraplesssynthesizerbootstraplessstacksynthesizerpropspropertyimageassettagsuffixtype) | [`cdk-bootstrapless-synthesizer.ImageAssetTagSuffixType`](#cdk-bootstrapless-synthesizer.ImageAssetTagSuffixType) | Override the tag suffix of the Docker Image assets. |
| [`templateBucketName`](#cdkbootstraplesssynthesizerbootstraplessstacksynthesizerpropspropertytemplatebucketname) | `string` | Override the name of the S3 bucket to hold Cloudformation template. |
##### `fileAssetBucketName`<sup>Optional</sup> <a name="cdk-bootstrapless-synthesizer.BootstraplessStackSynthesizerProps.property.fileAssetBucketName" id="cdkbootstraplesssynthesizerbootstraplessstacksynthesizerpropspropertyfileassetbucketname"></a>
```typescript
public readonly fileAssetBucketName: string;
```
- *Type:* `string`
- *Default:* process.env.BSS_FILE_ASSET_BUCKET_NAME
Name of the S3 bucket to hold file assets.
You must supply this if you have given a non-standard name to the staging bucket. The placeholders `${AWS::AccountId}` and `${AWS::Region}` will be replaced with the values of qualifier and the stack's account and region, respectively.
##### `fileAssetPrefix`<sup>Optional</sup> <a name="cdk-bootstrapless-synthesizer.BootstraplessStackSynthesizerProps.property.fileAssetPrefix" id="cdkbootstraplesssynthesizerbootstraplessstacksynthesizerpropspropertyfileassetprefix"></a>
```typescript
public readonly fileAssetPrefix: string;
```
- *Type:* `string`
- *Default:* process.env.BSS_FILE_ASSET_PREFIX
Object key prefix to use while storing S3 Assets.
##### `fileAssetPublishingRoleArn`<sup>Optional</sup> <a name="cdk-bootstrapless-synthesizer.BootstraplessStackSynthesizerProps.property.fileAssetPublishingRoleArn" id="cdkbootstraplesssynthesizerbootstraplessstacksynthesizerpropspropertyfileassetpublishingrolearn"></a>
```typescript
public readonly fileAssetPublishingRoleArn: string;
```
- *Type:* `string`
- *Default:* process.env.BSS_FILE_ASSET_PUBLISHING_ROLE_ARN
The role to use to publish file assets to the S3 bucket in this environment.
You must supply this if you have given a non-standard name to the publishing role. The placeholders `${AWS::AccountId}` and `${AWS::Region}` will be replaced with the values of qualifier and the stack's account and region, respectively.
##### `fileAssetRegionSet`<sup>Optional</sup> <a name="cdk-bootstrapless-synthesizer.BootstraplessStackSynthesizerProps.property.fileAssetRegionSet" id="cdkbootstraplesssynthesizerbootstraplessstacksynthesizerpropspropertyfileassetregionset"></a>
```typescript
public readonly fileAssetRegionSet: string[];
```
- *Type:* `string`[]
- *Default:* process.env.BSS_FILE_ASSET_REGION_SET // comma delimited list
The regions set of file assets to be published only when `fileAssetBucketName` contains `${AWS::Region}`.
For examples: `['us-east-1', 'us-west-1']`
##### `imageAssetAccountId`<sup>Optional</sup> <a name="cdk-bootstrapless-synthesizer.BootstraplessStackSynthesizerProps.property.imageAssetAccountId" id="cdkbootstraplesssynthesizerbootstraplessstacksynthesizerpropspropertyimageassetaccountid"></a>
```typescript
public readonly imageAssetAccountId: string;
```
- *Type:* `string`
- *Default:* process.env.BSS_IMAGE_ASSET_ACCOUNT_ID
Override the ECR repository account id of the Docker Image assets.
##### `imageAssetPublishingRoleArn`<sup>Optional</sup> <a name="cdk-bootstrapless-synthesizer.BootstraplessStackSynthesizerProps.property.imageAssetPublishingRoleArn" id="cdkbootstraplesssynthesizerbootstraplessstacksynthesizerpropspropertyimageassetpublishingrolearn"></a>
```typescript
public readonly imageAssetPublishingRoleArn: string;
```
- *Type:* `string`
- *Default:* process.env.BSS_IMAGE_ASSET_PUBLISHING_ROLE_ARN
The role to use to publish image assets to the ECR repository in this environment.
You must supply this if you have given a non-standard name to the publishing role. The placeholders `${AWS::AccountId}` and `${AWS::Region}` will be replaced with the values of qualifier and the stack's account and region, respectively.
##### `imageAssetRegionSet`<sup>Optional</sup> <a name="cdk-bootstrapless-synthesizer.BootstraplessStackSynthesizerProps.property.imageAssetRegionSet" id="cdkbootstraplesssynthesizerbootstraplessstacksynthesizerpropspropertyimageassetregionset"></a>
```typescript
public readonly imageAssetRegionSet: string[];
```
- *Type:* `string`[]
- *Default:* process.env.BSS_IMAGE_ASSET_REGION_SET // comma delimited list
Override the ECR repository region of the Docker Image assets.
For examples: `['us-east-1', 'us-west-1']`
##### `imageAssetRepositoryName`<sup>Optional</sup> <a name="cdk-bootstrapless-synthesizer.BootstraplessStackSynthesizerProps.property.imageAssetRepositoryName" id="cdkbootstraplesssynthesizerbootstraplessstacksynthesizerpropspropertyimageassetrepositoryname"></a>
```typescript
public readonly imageAssetRepositoryName: string;
```
- *Type:* `string`
- *Default:* process.env.BSS_IMAGE_ASSET_REPOSITORY_NAME
Name of the ECR repository to hold Docker Image assets.
You must supply this if you have given a non-standard name to the ECR repository. The placeholders `${AWS::AccountId}` and `${AWS::Region}` will be replaced with the values of qualifier and the stack's account and region, respectively.
##### `imageAssetTagPrefix`<sup>Optional</sup> <a name="cdk-bootstrapless-synthesizer.BootstraplessStackSynthesizerProps.property.imageAssetTagPrefix" id="cdkbootstraplesssynthesizerbootstraplessstacksynthesizerpropspropertyimageassettagprefix"></a>
```typescript
public readonly imageAssetTagPrefix: string;
```
- *Type:* `string`
- *Default:* process.env.BSS_IMAGE_ASSET_TAG_PREFIX
Override the tag prefix of the Docker Image assets.
##### `imageAssetTagSuffixType`<sup>Optional</sup> <a name="cdk-bootstrapless-synthesizer.BootstraplessStackSynthesizerProps.property.imageAssetTagSuffixType" id="cdkbootstraplesssynthesizerbootstraplessstacksynthesizerpropspropertyimageassettagsuffixtype"></a>
```typescript
public readonly imageAssetTagSuffixType: ImageAssetTagSuffixType;
```
- *Type:* [`cdk-bootstrapless-synthesizer.ImageAssetTagSuffixType`](#cdk-bootstrapless-synthesizer.ImageAssetTagSuffixType)
- *Default:* HASH or process.env.BSS_IMAGE_ASSET_TAG_SUFFIX_TYPE
Override the tag suffix of the Docker Image assets.
##### `templateBucketName`<sup>Optional</sup> <a name="cdk-bootstrapless-synthesizer.BootstraplessStackSynthesizerProps.property.templateBucketName" id="cdkbootstraplesssynthesizerbootstraplessstacksynthesizerpropspropertytemplatebucketname"></a>
```typescript
public readonly templateBucketName: string;
```
- *Type:* `string`
- *Default:* process.env.BSS_TEMPLATE_BUCKET_NAME
Override the name of the S3 bucket to hold Cloudformation template.
### ECRRepositoryAspectProps <a name="cdk-bootstrapless-synthesizer.ECRRepositoryAspectProps" id="cdkbootstraplesssynthesizerecrrepositoryaspectprops"></a>
Configuration properties for ECRRepositoryAspect.
#### Initializer <a name="[object Object].Initializer" id="object-objectinitializer"></a>
```typescript
import { ECRRepositoryAspectProps } from 'cdk-bootstrapless-synthesizer'
const eCRRepositoryAspectProps: ECRRepositoryAspectProps = { ... }
```
#### Properties <a name="Properties" id="properties"></a>
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`imageAssetAccountId`](#cdkbootstraplesssynthesizerecrrepositoryaspectpropspropertyimageassetaccountid) | `string` | Override the ECR repository account id of the Docker Image assets. |
##### `imageAssetAccountId`<sup>Optional</sup> <a name="cdk-bootstrapless-synthesizer.ECRRepositoryAspectProps.property.imageAssetAccountId" id="cdkbootstraplesssynthesizerecrrepositoryaspectpropspropertyimageassetaccountid"></a>
```typescript
public readonly imageAssetAccountId: string;
```
- *Type:* `string`
- *Default:* process.env.BSS_IMAGE_ASSET_ACCOUNT_ID
Override the ECR repository account id of the Docker Image assets.
## Classes <a name="Classes" id="classes"></a>
### BatchJobDefinition <a name="cdk-bootstrapless-synthesizer.BatchJobDefinition" id="cdkbootstraplesssynthesizerbatchjobdefinition"></a>
Process the image assets in AWS Batch job.
#### Initializers <a name="cdk-bootstrapless-synthesizer.BatchJobDefinition.Initializer" id="cdkbootstraplesssynthesizerbatchjobdefinitioninitializer"></a>
```typescript
import { BatchJobDefinition } from 'cdk-bootstrapless-synthesizer'
new BatchJobDefinition(props?: ECRRepositoryAspectProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`props`](#cdkbootstraplesssynthesizerbatchjobdefinitionparameterprops) | [`cdk-bootstrapless-synthesizer.ECRRepositoryAspectProps`](#cdk-bootstrapless-synthesizer.ECRRepositoryAspectProps) | *No description.* |
##### `props`<sup>Optional</sup> <a name="cdk-bootstrapless-synthesizer.BatchJobDefinition.parameter.props" id="cdkbootstraplesssynthesizerbatchjobdefinitionparameterprops"></a>
- *Type:* [`cdk-bootstrapless-synthesizer.ECRRepositoryAspectProps`](#cdk-bootstrapless-synthesizer.ECRRepositoryAspectProps)
#### Methods <a name="Methods" id="methods"></a>
| **Name** | **Description** |
| --- | --- |
| [`visit`](#cdkbootstraplesssynthesizerbatchjobdefinitionvisit) | All aspects can visit an IConstruct. |
##### `visit` <a name="cdk-bootstrapless-synthesizer.BatchJobDefinition.visit" id="cdkbootstraplesssynthesizerbatchjobdefinitionvisit"></a>
```typescript
public visit(construct: IConstruct)
```
###### `construct`<sup>Required</sup> <a name="cdk-bootstrapless-synthesizer.BatchJobDefinition.parameter.construct" id="cdkbootstraplesssynthesizerbatchjobdefinitionparameterconstruct"></a>
- *Type:* [`constructs.IConstruct`](#constructs.IConstruct)
### BootstraplessStackSynthesizer <a name="cdk-bootstrapless-synthesizer.BootstraplessStackSynthesizer" id="cdkbootstraplesssynthesizerbootstraplessstacksynthesizer"></a>
A Bootstrapless stack synthesizer that is designated to generate templates that can be directly used by Cloudformation.
#### Initializers <a name="cdk-bootstrapless-synthesizer.BootstraplessStackSynthesizer.Initializer" id="cdkbootstraplesssynthesizerbootstraplessstacksynthesizerinitializer"></a>
```typescript
import { BootstraplessStackSynthesizer } from 'cdk-bootstrapless-synthesizer'
new BootstraplessStackSynthesizer(props?: BootstraplessStackSynthesizerProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`props`](#cdkbootstraplesssynthesizerbootstraplessstacksynthesizerparameterprops) | [`cdk-bootstrapless-synthesizer.BootstraplessStackSynthesizerProps`](#cdk-bootstrapless-synthesizer.BootstraplessStackSynthesizerProps) | *No description.* |
##### `props`<sup>Optional</sup> <a name="cdk-bootstrapless-synthesizer.BootstraplessStackSynthesizer.parameter.props" id="cdkbootstraplesssynthesizerbootstraplessstacksynthesizerparameterprops"></a>
- *Type:* [`cdk-bootstrapless-synthesizer.BootstraplessStackSynthesizerProps`](#cdk-bootstrapless-synthesizer.BootstraplessStackSynthesizerProps)
#### Methods <a name="Methods" id="methods"></a>
| **Name** | **Description** |
| --- | --- |
| [`addDockerImageAsset`](#cdkbootstraplesssynthesizerbootstraplessstacksynthesizeradddockerimageasset) | Register a Docker Image Asset. |
| [`addFileAsset`](#cdkbootstraplesssynthesizerbootstraplessstacksynthesizeraddfileasset) | Register a File Asset. |
| [`bind`](#cdkbootstraplesssynthesizerbootstraplessstacksynthesizerbind) | Bind to the stack this environment is going to be used on. |
| [`dumps`](#cdkbootstraplesssynthesizerbootstraplessstacksynthesizerdumps) | Dumps current manifest into JSON format. |
| [`synthesize`](#cdkbootstraplesssynthesizerbootstraplessstacksynthesizersynthesize) | Synthesize the associated stack to the session. |
##### `addDockerImageAsset` <a name="cdk-bootstrapless-synthesizer.BootstraplessStackSynthesizer.addDockerImageAsset" id="cdkbootstraplesssynthesizerbootstraplessstacksynthesizeradddockerimageasset"></a>
```typescript
public addDockerImageAsset(asset: DockerImageAssetSource)
```
###### `asset`<sup>Required</sup> <a name="cdk-bootstrapless-synthesizer.BootstraplessStackSynthesizer.parameter.asset" id="cdkbootstraplesssynthesizerbootstraplessstacksynthesizerparameterasset"></a>
- *Type:* [`aws-cdk-lib.DockerImageAssetSource`](#aws-cdk-lib.DockerImageAssetSource)
##### `addFileAsset` <a name="cdk-bootstrapless-synthesizer.BootstraplessStackSynthesizer.addFileAsset" id="cdkbootstraplesssynthesizerbootstraplessstacksynthesizeraddfileasset"></a>
```typescript
public addFileAsset(asset: FileAssetSource)
```
###### `asset`<sup>Required</sup> <a name="cdk-bootstrapless-synthesizer.BootstraplessStackSynthesizer.parameter.asset" id="cdkbootstraplesssynthesizerbootstraplessstacksynthesizerparameterasset"></a>
- *Type:* [`aws-cdk-lib.FileAssetSource`](#aws-cdk-lib.FileAssetSource)
##### `bind` <a name="cdk-bootstrapless-synthesizer.BootstraplessStackSynthesizer.bind" id="cdkbootstraplesssynthesizerbootstraplessstacksynthesizerbind"></a>
```typescript
public bind(stack: Stack)
```
###### `stack`<sup>Required</sup> <a name="cdk-bootstrapless-synthesizer.BootstraplessStackSynthesizer.parameter.stack" id="cdkbootstraplesssynthesizerbootstraplessstacksynthesizerparameterstack"></a>
- *Type:* [`aws-cdk-lib.Stack`](#aws-cdk-lib.Stack)
##### `dumps` <a name="cdk-bootstrapless-synthesizer.BootstraplessStackSynthesizer.dumps" id="cdkbootstraplesssynthesizerbootstraplessstacksynthesizerdumps"></a>
```typescript
public dumps()
```
##### `synthesize` <a name="cdk-bootstrapless-synthesizer.BootstraplessStackSynthesizer.synthesize" id="cdkbootstraplesssynthesizerbootstraplessstacksynthesizersynthesize"></a>
```typescript
public synthesize(session: ISynthesisSession)
```
###### `session`<sup>Required</sup> <a name="cdk-bootstrapless-synthesizer.BootstraplessStackSynthesizer.parameter.session" id="cdkbootstraplesssynthesizerbootstraplessstacksynthesizerparametersession"></a>
- *Type:* [`aws-cdk-lib.ISynthesisSession`](#aws-cdk-lib.ISynthesisSession)
### CompositeECRRepositoryAspect <a name="cdk-bootstrapless-synthesizer.CompositeECRRepositoryAspect" id="cdkbootstraplesssynthesizercompositeecrrepositoryaspect"></a>
Default ECR asset aspect, support using ECR assets in below services,.
ECS task definition - SageMaker training job in Step Functions - AWS Batch job - AWS Lambda container image
#### Initializers <a name="cdk-bootstrapless-synthesizer.CompositeECRRepositoryAspect.Initializer" id="cdkbootstraplesssynthesizercompositeecrrepositoryaspectinitializer"></a>
```typescript
import { CompositeECRRepositoryAspect } from 'cdk-bootstrapless-synthesizer'
new CompositeECRRepositoryAspect(props?: ECRRepositoryAspectProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`props`](#cdkbootstraplesssynthesizercompositeecrrepositoryaspectparameterprops) | [`cdk-bootstrapless-synthesizer.ECRRepositoryAspectProps`](#cdk-bootstrapless-synthesizer.ECRRepositoryAspectProps) | *No description.* |
##### `props`<sup>Optional</sup> <a name="cdk-bootstrapless-synthesizer.CompositeECRRepositoryAspect.parameter.props" id="cdkbootstraplesssynthesizercompositeecrrepositoryaspectparameterprops"></a>
- *Type:* [`cdk-bootstrapless-synthesizer.ECRRepositoryAspectProps`](#cdk-bootstrapless-synthesizer.ECRRepositoryAspectProps)
#### Methods <a name="Methods" id="methods"></a>
| **Name** | **Description** |
| --- | --- |
| [`visit`](#cdkbootstraplesssynthesizercompositeecrrepositoryaspectvisit) | All aspects can visit an IConstruct. |
##### `visit` <a name="cdk-bootstrapless-synthesizer.CompositeECRRepositoryAspect.visit" id="cdkbootstraplesssynthesizercompositeecrrepositoryaspectvisit"></a>
```typescript
public visit(construct: IConstruct)
```
###### `construct`<sup>Required</sup> <a name="cdk-bootstrapless-synthesizer.CompositeECRRepositoryAspect.parameter.construct" id="cdkbootstraplesssynthesizercompositeecrrepositoryaspectparameterconstruct"></a>
- *Type:* [`constructs.IConstruct`](#constructs.IConstruct)
### ECRRepositoryAspect <a name="cdk-bootstrapless-synthesizer.ECRRepositoryAspect" id="cdkbootstraplesssynthesizerecrrepositoryaspect"></a>
- *Implements:* [`aws-cdk-lib.IAspect`](#aws-cdk-lib.IAspect)
Abtract aspect for ECR repository.
You must provide the account id in props or set BSS_IMAGE_ASSET_ACCOUNT_ID in env
#### Initializers <a name="cdk-bootstrapless-synthesizer.ECRRepositoryAspect.Initializer" id="cdkbootstraplesssynthesizerecrrepositoryaspectinitializer"></a>
```typescript
import { ECRRepositoryAspect } from 'cdk-bootstrapless-synthesizer'
new ECRRepositoryAspect(props?: ECRRepositoryAspectProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`props`](#cdkbootstraplesssynthesizerecrrepositoryaspectparameterprops) | [`cdk-bootstrapless-synthesizer.ECRRepositoryAspectProps`](#cdk-bootstrapless-synthesizer.ECRRepositoryAspectProps) | *No description.* |
##### `props`<sup>Optional</sup> <a name="cdk-bootstrapless-synthesizer.ECRRepositoryAspect.parameter.props" id="cdkbootstraplesssynthesizerecrrepositoryaspectparameterprops"></a>
- *Type:* [`cdk-bootstrapless-synthesizer.ECRRepositoryAspectProps`](#cdk-bootstrapless-synthesizer.ECRRepositoryAspectProps)
#### Methods <a name="Methods" id="methods"></a>
| **Name** | **Description** |
| --- | --- |
| [`visit`](#cdkbootstraplesssynthesizerecrrepositoryaspectvisit) | All aspects can visit an IConstruct. |
##### `visit` <a name="cdk-bootstrapless-synthesizer.ECRRepositoryAspect.visit" id="cdkbootstraplesssynthesizerecrrepositoryaspectvisit"></a>
```typescript
public visit(construct: IConstruct)
```
###### `construct`<sup>Required</sup> <a name="cdk-bootstrapless-synthesizer.ECRRepositoryAspect.parameter.construct" id="cdkbootstraplesssynthesizerecrrepositoryaspectparameterconstruct"></a>
- *Type:* [`constructs.IConstruct`](#constructs.IConstruct)
#### Properties <a name="Properties" id="properties"></a>
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`account`](#cdkbootstraplesssynthesizerecrrepositoryaspectpropertyaccount)<span title="Required">*</span> | `string` | *No description.* |
##### `account`<sup>Required</sup> <a name="cdk-bootstrapless-synthesizer.ECRRepositoryAspect.property.account" id="cdkbootstraplesssynthesizerecrrepositoryaspectpropertyaccount"></a>
```typescript
public readonly account: string;
```
- *Type:* `string`
### ECSTaskDefinition <a name="cdk-bootstrapless-synthesizer.ECSTaskDefinition" id="cdkbootstraplesssynthesizerecstaskdefinition"></a>
Process the image assets in ECS task definition.
#### Initializers <a name="cdk-bootstrapless-synthesizer.ECSTaskDefinition.Initializer" id="cdkbootstraplesssynthesizerecstaskdefinitioninitializer"></a>
```typescript
import { ECSTaskDefinition } from 'cdk-bootstrapless-synthesizer'
new ECSTaskDefinition(props?: ECRRepositoryAspectProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`props`](#cdkbootstraplesssynthesizerecstaskdefinitionparameterprops) | [`cdk-bootstrapless-synthesizer.ECRRepositoryAspectProps`](#cdk-bootstrapless-synthesizer.ECRRepositoryAspectProps) | *No description.* |
##### `props`<sup>Optional</sup> <a name="cdk-bootstrapless-synthesizer.ECSTaskDefinition.parameter.props" id="cdkbootstraplesssynthesizerecstaskdefinitionparameterprops"></a>
- *Type:* [`cdk-bootstrapless-synthesizer.ECRRepositoryAspectProps`](#cdk-bootstrapless-synthesizer.ECRRepositoryAspectProps)
#### Methods <a name="Methods" id="methods"></a>
| **Name** | **Description** |
| --- | --- |
| [`visit`](#cdkbootstraplesssynthesizerecstaskdefinitionvisit) | All aspects can visit an IConstruct. |
##### `visit` <a name="cdk-bootstrapless-synthesizer.ECSTaskDefinition.visit" id="cdkbootstraplesssynthesizerecstaskdefinitionvisit"></a>
```typescript
public visit(construct: IConstruct)
```
###### `construct`<sup>Required</sup> <a name="cdk-bootstrapless-synthesizer.ECSTaskDefinition.parameter.construct" id="cdkbootstraplesssynthesizerecstaskdefinitionparameterconstruct"></a>
- *Type:* [`constructs.IConstruct`](#constructs.IConstruct)
### StepFunctionsSageMakerTrainingJob <a name="cdk-bootstrapless-synthesizer.StepFunctionsSageMakerTrainingJob" id="cdkbootstraplesssynthesizerstepfunctionssagemakertrainingjob"></a>
Process the image assets in SageMaker training job in Step Functions.
#### Initializers <a name="cdk-bootstrapless-synthesizer.StepFunctionsSageMakerTrainingJob.Initializer" id="cdkbootstraplesssynthesizerstepfunctionssagemakertrainingjobinitializer"></a>
```typescript
import { StepFunctionsSageMakerTrainingJob } from 'cdk-bootstrapless-synthesizer'
new StepFunctionsSageMakerTrainingJob(props?: ECRRepositoryAspectProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`props`](#cdkbootstraplesssynthesizerstepfunctionssagemakertrainingjobparameterprops) | [`cdk-bootstrapless-synthesizer.ECRRepositoryAspectProps`](#cdk-bootstrapless-synthesizer.ECRRepositoryAspectProps) | *No description.* |
##### `props`<sup>Optional</sup> <a name="cdk-bootstrapless-synthesizer.StepFunctionsSageMakerTrainingJob.parameter.props" id="cdkbootstraplesssynthesizerstepfunctionssagemakertrainingjobparameterprops"></a>
- *Type:* [`cdk-bootstrapless-synthesizer.ECRRepositoryAspectProps`](#cdk-bootstrapless-synthesizer.ECRRepositoryAspectProps)
#### Methods <a name="Methods" id="methods"></a>
| **Name** | **Description** |
| --- | --- |
| [`visit`](#cdkbootstraplesssynthesizerstepfunctionssagemakertrainingjobvisit) | All aspects can visit an IConstruct. |
##### `visit` <a name="cdk-bootstrapless-synthesizer.StepFunctionsSageMakerTrainingJob.visit" id="cdkbootstraplesssynthesizerstepfunctionssagemakertrainingjobvisit"></a>
```typescript
public visit(construct: IConstruct)
```
###### `construct`<sup>Required</sup> <a name="cdk-bootstrapless-synthesizer.StepFunctionsSageMakerTrainingJob.parameter.construct" id="cdkbootstraplesssynthesizerstepfunctionssagemakertrainingjobparameterconstruct"></a>
- *Type:* [`constructs.IConstruct`](#constructs.IConstruct)
## Enums <a name="Enums" id="enums"></a>
### ImageAssetTagSuffixType <a name="ImageAssetTagSuffixType" id="imageassettagsuffixtype"></a>
| **Name** | **Description** |
| --- | --- |
| [`NONE`](#cdkbootstraplesssynthesizerimageassettagsuffixtypenone) | *No description.* |
| [`HASH`](#cdkbootstraplesssynthesizerimageassettagsuffixtypehash) | *No description.* |
#### `NONE` <a name="cdk-bootstrapless-synthesizer.ImageAssetTagSuffixType.NONE" id="cdkbootstraplesssynthesizerimageassettagsuffixtypenone"></a>
#### `HASH` <a name="cdk-bootstrapless-synthesizer.ImageAssetTagSuffixType.HASH" id="cdkbootstraplesssynthesizerimageassettagsuffixtypehash"></a>