Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore(custom-resources): clear awslint exclusions #6523

Merged
merged 2 commits into from
Mar 1, 2020
Merged

chore(custom-resources): clear awslint exclusions #6523

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
63c6c1b
fix awslint exclusions
iliapolo Mar 1, 2020
96395f4
Merge branch 'master' into epolon/clear-custom-resources-awslint
mergify[bot] Mar 1, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion packages/@aws-cdk/custom-resources/lib/aws-custom-resource/aws-custom-resource.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ export interface AwsSdkCall {
/**
* The parameters for the service action
*
* @default - no paramters
* @see https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/index.html
*/
readonly parameters?: any;
Expand Down Expand Up @@ -114,6 +115,11 @@ export interface AwsSdkCall {
readonly outputPath?: string;
}

/**
* Properties for AwsCustomResource.
*
* Note that at least onCreate, onUpdate or onDelete must be specified.
*/
export interface AwsCustomResourceProps {
/**
* Cloudformation Resource type.
Expand All @@ -124,7 +130,6 @@ export interface AwsCustomResourceProps {

/**
* The AWS SDK call to make when the resource is created.
* At least onCreate, onUpdate or onDelete must be specified.
*
* @default - the call when the resource is updated
*/
Expand Down Expand Up @@ -177,11 +182,20 @@ export interface AwsCustomResourceProps {
readonly timeout?: cdk.Duration
}

/**
* Defines a custom resource that is materialized using specific AWS API calls.
*
* Use this to bridge any gap that might exist in the CloudFormation Coverage.
* You can specify exactly which calls are invoked for the 'CREATE', 'UPDATE' and 'DELETE' life cycle events.
*
*/
export class AwsCustomResource extends cdk.Construct implements iam.IGrantable {
public readonly grantPrincipal: iam.IPrincipal;

private readonly customResource: CustomResource;

// 'props' cannot be optional, even though all its properties are optional.
// this is because at least one sdk call must be provided.
constructor(scope: cdk.Construct, id: string, props: AwsCustomResourceProps) {
super(scope, id);

Expand Down
8 changes: 2 additions & 6 deletions packages/@aws-cdk/custom-resources/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,11 +125,7 @@
"stability": "experimental",
"awslint": {
"exclude": [
"construct-ctor-props-optional:@aws-cdk/custom-resources.AwsCustomResource",
"props-physical-name:@aws-cdk/custom-resources.AsyncCustomResourceProps",
"docs-public-apis:@aws-cdk/custom-resources.AwsCustomResource",
"docs-public-apis:@aws-cdk/custom-resources.AwsCustomResourceProps",
"props-default-doc:@aws-cdk/custom-resources.AwsSdkCall.parameters"
"construct-ctor-props-optional:@aws-cdk/custom-resources.AwsCustomResource"
]
}
}
}