ISecurityGroup

class aws_cdk.aws_ec2.ISecurityGroup(*args, **kwargs)

Bases: aws_cdk.core.IResource, aws_cdk.aws_ec2.IPeer, typing_extensions.Protocol

Interface for security group-like objects.

__init__(*args, **kwargs)

Methods

add_egress_rule(peer, connection, description=None, remote_rule=None)

Add an egress rule for the current security group.

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.

Parameters
  • peer (IPeer) –

  • connection (Port) –

  • description (Optional[str]) –

  • remote_rule (Optional[bool]) –

Return type

None

add_ingress_rule(peer, connection, description=None, remote_rule=None)

Add an ingress rule for the current security group.

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.

Parameters
  • peer (IPeer) –

  • connection (Port) –

  • description (Optional[str]) –

  • remote_rule (Optional[bool]) –

Return type

None

to_egress_rule_config()

Produce the egress rule JSON for the given connection.

Return type

Any

to_ingress_rule_config()

Produce the ingress rule JSON for the given connection.

Return type

Any

Attributes

allow_all_outbound

Whether the SecurityGroup has been configured to allow all outbound traffic.

Return type

bool

can_inline_rule

Whether the rule can be inlined into a SecurityGroup or not.

Return type

bool

connections
Return type

Connections

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

Return type

ResourceEnvironment

node

The construct tree node for this construct.

Return type

ConstructNode

security_group_id

ID for the current security group.

attribute: :attribute:: true

Return type

str

stack

The stack in which this resource is defined.

Return type

Stack

unique_id

A unique identifier for this connection peer.

Return type

str