Skip to content

Commit

Permalink
Update the doc comments of misc classes.
Browse files Browse the repository at this point in the history
  • Loading branch information
nateglims committed Nov 21, 2023
1 parent 0efc681 commit 297330e
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 1 deletion.
3 changes: 3 additions & 0 deletions lib/constructs/source-repo.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ export interface SourceRepoProps extends cdk.StackProps {

/**
* The repository for the Source Stage of the pipeline.
*
* The initial contents of this repository are seeded by the assets contained
* in the `source-repo/` folder of this library.
*/
export class SourceRepo extends Construct {
/** The CodeCommit Repo itself. */
Expand Down
3 changes: 3 additions & 0 deletions lib/network.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ import { LogGroup, RetentionDays } from 'aws-cdk-lib/aws-logs';

/**
* The network resources to run the pipeline in.
*
* This stack is provided for when users do not have an existing VPC with
* private and public subnets for the pipeline.
*/
export class PipelineNetworkStack extends cdk.Stack {
/** The VPC for the pipeline to reside in. */
Expand Down
2 changes: 1 addition & 1 deletion lib/vm-import-bucket.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ export interface VMImportBucketProps extends s3.BucketProps {
}

/**
* ...
* An S3 Bucket with roles for the VM Import/Export service.
*/
export class VMImportBucket extends s3.Bucket {
public readonly roleName: string;
Expand Down

0 comments on commit 297330e

Please sign in to comment.