AWS CDK Reference

Appearance

v2.274.0

ISecurityGroup Interface ​

Interface for security group-like objects.

Source
aws-ec2/lib/security-group.ts
Type last changed
v2.224.0 · 13 Nov 2025

Properties ​

allowAllOutboundbooleanallow_all_outboundboolallowAllOutboundBooleanAllowAllOutboundboolAllowAllOutbound*boolrequired#
Whether the SecurityGroup has been configured to allow all outbound traffic.
canInlineRulebooleancan_inline_ruleboolcanInlineRuleBooleanCanInlineRuleboolCanInlineRule*boolrequired#
Whether the rule can be inlined into a SecurityGroup or not.
connectionsConnectionsconnectionsConnectionsconnectionsConnectionsConnectionsConnectionsConnectionsConnectionsrequired#
The network connections associated with this resource.
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#
The environment this resource belongs to.
notes

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#
The tree node.
securityGroupIdstringsecurity_group_idstrsecurityGroupIdStringSecurityGroupIdstringSecurityGroupId*stringrequired#
ID for the current security group.
securityGroupRefSecurityGroupReferencesecurity_group_refSecurityGroupReferencesecurityGroupRefSecurityGroupReferenceSecurityGroupRefSecurityGroupReferenceSecurityGroupRefSecurityGroupReferencerequired#
A reference to a SecurityGroup resource.
stackStackstackStackstackStackStackStackStackStackrequired#
The stack in which this resource is defined.
uniqueIdstringunique_idstruniqueIdStringUniqueIdstringUniqueId*stringrequired#
A unique identifier for this connection peer.

Methods ​

addEgressRule(peer: IPeer, connection: Port, description?: string, remoteRule?: boolean): voiddef add_egress_rule(self, peer: IPeer, connection: Port, description: typing.Optional[str] = None, remote_rule: typing.Optional[bool] = None) -> Nonepublic void addEgressRule(IPeer peer, Port connection, String description, Boolean remoteRule)public void AddEgressRule(IPeer peer, Port connection, string? description = null, bool? remoteRule = null)func AddEgressRule(Peer IPeer, Connection Port, Description *string, RemoteRule *bool)#
Add an egress rule for the current security group.
notes

remoteRule controls where the Rule object is created if the peer is also a securityGroup and they are in different stack. If false (default) the rule object is created under the current SecurityGroup object. If true and the peer is also a SecurityGroup, the rule object is created under the remote SecurityGroup object.

addIngressRule(peer: IPeer, connection: Port, description?: string, remoteRule?: boolean): voiddef add_ingress_rule(self, peer: IPeer, connection: Port, description: typing.Optional[str] = None, remote_rule: typing.Optional[bool] = None) -> Nonepublic void addIngressRule(IPeer peer, Port connection, String description, Boolean remoteRule)public void AddIngressRule(IPeer peer, Port connection, string? description = null, bool? remoteRule = null)func AddIngressRule(Peer IPeer, Connection Port, Description *string, RemoteRule *bool)#
Add an ingress rule for the current security group.
notes

remoteRule controls where the Rule object is created if the peer is also a securityGroup and they are in different stack. If false (default) the rule object is created under the current SecurityGroup object. If true and the peer is also a SecurityGroup, the rule object is created under the remote SecurityGroup object.

applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#
Apply the given removal policy to this resource.
notes

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

toEgressRuleConfig(): EgressRuleConfigdef to_egress_rule_config(self, ) -> EgressRuleConfigpublic EgressRuleConfig toEgressRuleConfig()public EgressRuleConfig ToEgressRuleConfig()func ToEgressRuleConfig() EgressRuleConfig#
Produce the egress rule JSON for the given connection.
toIngressRuleConfig(): IngressRuleConfigdef to_ingress_rule_config(self, ) -> IngressRuleConfigpublic IngressRuleConfig toIngressRuleConfig()public IngressRuleConfig ToIngressRuleConfig()func ToIngressRuleConfig() IngressRuleConfig#
Produce the ingress rule JSON for the given connection.
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#
Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.

1 parameter · returns

Parameters

  • mixinsmixinsmixinsmixinsMixins — The mixins to apply.

Returns: This construct for chaining