Skip to content

Commit

Permalink
docs: clarify egress default for fromSecurityGroupId (aws#12350)
Browse files Browse the repository at this point in the history
The default is currently not clearly documented.

Fixes aws#12082.


----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
  • Loading branch information
rix0rrr authored Jan 13, 2021
1 parent adb2a18 commit 2fed1e1
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions packages/@aws-cdk/aws-ec2/lib/security-group.ts
Original file line number Diff line number Diff line change
Expand Up @@ -321,6 +321,13 @@ export class SecurityGroup extends SecurityGroupBase {

/**
* Import an existing security group into this app.
*
* This method will assume that the Security Group has a rule in it which allows
* all outbound traffic, and so will not add egress rules to the imported Security
* Group (only ingress rules).
*
* If your existing Security Group needs to have egress rules added, pass the
* `allowAllOutbound: false` option on import.
*/
public static fromSecurityGroupId(scope: Construct, id: string, securityGroupId: string, options: SecurityGroupImportOptions = {}): ISecurityGroup {
class MutableImport extends SecurityGroupBase {
Expand Down

0 comments on commit 2fed1e1

Please sign in to comment.