-
Notifications
You must be signed in to change notification settings - Fork 3.9k
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.
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
refactor: use interface references in public api (awslint:ref-via-interface) #2499
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…erface) Adds a new awslint:ref-via-interface rule which validates that all input APIs (e.g. props, method arguments) use construct interface (IBucket) and not concrete classes (Bucket). This is in order to enable passing in unowned resources and in accordance with the aws construct library guidelines. There are situations where an owned resource is required. In those, the rule can be disabled by adding [disable-awslint:ref-via-interface] to the element's inline documentation. To enable this, the following new construct interfaces were added, along with `fromXxx` import methods: * `applicationautoscaling.IScalableTarget` * `cloudwatch.IAlarm` * `ecs.IService` * `ecs.IEc2Service` * `ec2.IFargateService` * `ecs.ITaskDefinition` * `iam.IGroup` * `iam.IUser` * `iam.IPolicy` * `lambda.IVersion` BREAKING CHANGE: `apigateway.ResourceBase.trackChild` is now internal. * `cloudfront.S3OriginConfig.originAccessIdentity` is now `originAccessIdentityId` * `codedeploy.LambdaDeploymentGroup.alarms` is now `cloudwatch.IAlarm[]` (previously `cloudwatch.Alarm[]`) * `codepipeline.crossRegionScaffoldingStacks` renamed to `crossRegionScaffolding` * `codepipeline.CrossRegionScaffoldingStack` renamed to `codepipeline.CrossRegionScaffolding` and cannot be instantiated (abstract) * `ec2.VpcSubnet.addDefaultRouteToNAT` renamed to `addDefaultNatRoute` and made public * `ec2.VpcSubnet.addDefaultRouteToIGW` renamed to `addDefaultInternetRoute`, made public and first argument is the gateway ID (string) and not the CFN L1 class * `ecs.Ec2EventRuleTarget.taskDefinition` is now `ITaskDefinition` (previously `TaskDefinition`) * `lambda.IEventSource.bind` now accepts `IFunction` instead of `FunctionBase`. Use `IFunction.addEventSourceMapping` to add an event source mapping under the function. * `lambda.Layer.grantUsage` renamed to `lambda.layer.addPermission` and returns void * `stepfunctions.StateMachine.role` is now `iam.IRole` (previously `iam.Role`)
eladb
requested review from
RomainMuller,
skinny85,
SoManyHs and
a team
as code owners
May 8, 2019 07:39
rix0rrr
approved these changes
May 8, 2019
shivlaks
approved these changes
May 8, 2019
* add VpcSubnet.isVpcSubnet * Do not use arbitrary duck-typing in EKS
SanderKnape
pushed a commit
to SanderKnape/aws-cdk
that referenced
this pull request
May 14, 2019
…erface) (aws#2499) Adds a new awslint:ref-via-interface rule which validates that all input APIs (e.g. props, method arguments) use construct interface (IBucket) and not concrete classes (Bucket). This is in order to enable passing in unowned resources and in accordance with the aws construct library guidelines. There are situations where an owned resource is required. In those, the rule can be disabled by adding [disable-awslint:ref-via-interface] to the element's inline documentation. To enable this, the following new construct interfaces were added, along with `fromXxx` import methods: * `applicationautoscaling.IScalableTarget` * `cloudwatch.IAlarm` * `ecs.IService` * `ecs.IEc2Service` * `ec2.IFargateService` * `ecs.ITaskDefinition` * `iam.IGroup` * `iam.IUser` * `iam.IPolicy` * `lambda.IVersion` Fixes aws#2412 BREAKING CHANGE: `apigateway.ResourceBase.trackChild` is now internal. * `cloudfront.S3OriginConfig.originAccessIdentity` is now `originAccessIdentityId` * `codedeploy.LambdaDeploymentGroup.alarms` is now `cloudwatch.IAlarm[]` (previously `cloudwatch.Alarm[]`) * `codepipeline.crossRegionScaffoldingStacks` renamed to `crossRegionScaffolding` * `codepipeline.CrossRegionScaffoldingStack` renamed to `codepipeline.CrossRegionScaffolding` and cannot be instantiated (abstract) * `ec2.VpcSubnet.addDefaultRouteToNAT` renamed to `addDefaultNatRoute` and made public * `ec2.VpcSubnet.addDefaultRouteToIGW` renamed to `addDefaultInternetRoute`, made public and first argument is the gateway ID (string) and not the CFN L1 class * `ecs.Ec2EventRuleTarget.taskDefinition` is now `ITaskDefinition` (previously `TaskDefinition`) * `lambda.IEventSource.bind` now accepts `IFunction` instead of `FunctionBase`. Use `IFunction.addEventSourceMapping` to add an event source mapping under the function. * `lambda.Layer.grantUsage` renamed to `lambda.layer.addPermission` and returns void * `stepfunctions.StateMachine.role` is now `iam.IRole` (previously `iam.Role`)
This was referenced Aug 22, 2019
Thanks so much for taking the time to contribute to the AWS CDK ❤️ We will shortly assign someone to review this pull request and help get it
|
This was referenced Dec 12, 2019
This was referenced Dec 12, 2019
This was referenced Jan 20, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds a new awslint:ref-via-interface rule which validates that all input APIs
(e.g. props, method arguments) use construct interface (IBucket) and not concrete
classes (Bucket). This is in order to enable passing in unowned resources and
in accordance with the aws construct library guidelines.
There are situations where an owned resource is required. In those, the rule
can be disabled by adding [disable-awslint:ref-via-interface] to the element's
inline documentation.
To enable this, the following new construct interfaces were added, along with
fromXxx
import methods:applicationautoscaling.IScalableTarget
cloudwatch.IAlarm
ecs.IService
ecs.IEc2Service
ec2.IFargateService
ecs.ITaskDefinition
iam.IGroup
iam.IUser
iam.IPolicy
lambda.IVersion
Fixes #2412
BREAKING CHANGE:
apigateway.ResourceBase.trackChild
is now internal.cloudfront.S3OriginConfig.originAccessIdentity
is noworiginAccessIdentityId
codedeploy.LambdaDeploymentGroup.alarms
is nowcloudwatch.IAlarm[]
(previouslycloudwatch.Alarm[]
)codepipeline.crossRegionScaffoldingStacks
renamed tocrossRegionScaffolding
codepipeline.CrossRegionScaffoldingStack
renamed tocodepipeline.CrossRegionScaffolding
and cannot be instantiated (abstract)ec2.VpcSubnet.addDefaultRouteToNAT
renamed toaddDefaultNatRoute
and made publicec2.VpcSubnet.addDefaultRouteToIGW
renamed toaddDefaultInternetRoute
, made public and first argument is the gateway ID (string) and not the CFN L1 classecs.Ec2EventRuleTarget.taskDefinition
is nowITaskDefinition
(previouslyTaskDefinition
)lambda.IEventSource.bind
now acceptsIFunction
instead ofFunctionBase
. UseIFunction.addEventSourceMapping
to add an event source mapping under the function.lambda.Layer.grantUsage
renamed tolambda.layer.addPermission
and returns voidstepfunctions.StateMachine.role
is nowiam.IRole
(previouslyiam.Role
)Pull Request Checklist
design
folderBy submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license.