Class SecurityGroup

Creates an Amazon EC2 security group within a VPC.

Inheritance

System.Object

Construct

Resource

SecurityGroup

Implements

Inherited Members

Resource.GeneratePhysicalName()

Resource.GetResourceArnAttribute(String, IArnComponents)

Resource.GetResourceNameAttribute(String)

Resource.PhysicalName

Resource.Stack

Construct.IsConstruct(Object)

Construct.Prepare()

Construct.Synthesize(ISynthesisSession)

Construct.ToString()

Construct.Validate()

Construct.Node

Namespace: Amazon.CDK.AWS.EC2

Assembly: Amazon.CDK.AWS.EC2.dll

Syntax (csharp)

public class SecurityGroup : Resource, ISecurityGroup, IResource, IConstruct, IDependable, IPeer, IConnectable

Syntax (vb)

Public Class SecurityGroup
    Inherits Resource
    Implements ISecurityGroup, IResource, IConstruct, IDependable, IPeer, IConnectable

Remarks

This class has an additional optimization over imported security groups that it can also create inline ingress and egress rule (which saves on the total number of resources inside the template). stability: Stable

Synopsis

Constructors

SecurityGroup(Construct, String, ISecurityGroupProps)
SecurityGroup(ByRefValue)
SecurityGroup(DeputyBase.DeputyProps)

Properties

CanInlineRule	Whether the rule can be inlined into a SecurityGroup or not.
Connections
DefaultPort
SecurityGroupId	The ID of the security group.
SecurityGroupName	An attribute that represents the security group name.
SecurityGroupVpcId	The VPC ID this security group is part of.
UniqueId	A unique identifier for this connection peer.

Methods

AddEgressRule(IPeer, Port, String, Nullable<Boolean>)	Add an egress rule for the current security group.
AddIngressRule(IPeer, Port, String, Nullable<Boolean>)	Add an ingress rule for the current security group.
FromSecurityGroupId(Construct, String, String, ISecurityGroupImportOptions)	Import an existing security group into this app.
IsSecurityGroup(Object)	Return whether the indicated object is a security group.
ToEgressRuleConfig()	Produce the egress rule JSON for the given connection.
ToIngressRuleConfig()	Produce the ingress rule JSON for the given connection.

Constructors

SecurityGroup(Construct, String, ISecurityGroupProps)

public SecurityGroup(Construct scope, string id, ISecurityGroupProps props)

Parameters

scope Construct
id System.String
props ISecurityGroupProps

Remarks

stability: Stable

SecurityGroup(ByRefValue)

protected SecurityGroup(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue

SecurityGroup(DeputyBase.DeputyProps)

protected SecurityGroup(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

Properties

CanInlineRule

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

public virtual bool CanInlineRule { get; }

Property Value

System.Boolean

Remarks

stability: Stable

Connections

public virtual Connections_ Connections { get; }

Property Value

Connections_

Remarks

stability: Stable

DefaultPort

public virtual Port DefaultPort { get; }

Property Value

Port

Remarks

stability: Stable

SecurityGroupId

The ID of the security group.

public virtual string SecurityGroupId { get; }

Property Value

System.String

Remarks

stability: Stable attribute: true

SecurityGroupName

An attribute that represents the security group name.

public virtual string SecurityGroupName { get; }

Property Value

System.String

Remarks

stability: Stable attribute: true

SecurityGroupVpcId

The VPC ID this security group is part of.

public virtual string SecurityGroupVpcId { get; }

Property Value

System.String

Remarks

stability: Stable attribute: true

UniqueId

A unique identifier for this connection peer.

public virtual string UniqueId { get; }

Property Value

System.String

Remarks

stability: Stable

Methods

AddEgressRule(IPeer, Port, String, Nullable<Boolean>)

Add an egress rule for the current security group.

public virtual void AddEgressRule(IPeer peer, Port connection, string description = null, Nullable<bool> remoteRule = null)

Parameters

peer IPeer
connection Port
description System.String
remoteRule System.Nullable<System.Boolean>

Remarks

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. stability: Stable

AddIngressRule(IPeer, Port, String, Nullable<Boolean>)

Add an ingress rule for the current security group.

public virtual void AddIngressRule(IPeer peer, Port connection, string description = null, Nullable<bool> remoteRule = null)

Parameters

peer IPeer
connection Port
description System.String
remoteRule System.Nullable<System.Boolean>

Remarks

FromSecurityGroupId(Construct, String, String, ISecurityGroupImportOptions)

Import an existing security group into this app.

public static ISecurityGroup FromSecurityGroupId(Construct scope, string id, string securityGroupId, ISecurityGroupImportOptions options = null)

Parameters

scope Construct
id System.String
securityGroupId System.String
options ISecurityGroupImportOptions

Returns

ISecurityGroup

Remarks

stability: Stable

IsSecurityGroup(Object)

Return whether the indicated object is a security group.

public static bool IsSecurityGroup(object x)

Parameters

x System.Object

Returns

System.Boolean

Remarks

stability: Stable

ToEgressRuleConfig()

Produce the egress rule JSON for the given connection.

public virtual object ToEgressRuleConfig()

Returns

System.Object

Remarks

stability: Stable

ToIngressRuleConfig()

Produce the ingress rule JSON for the given connection.

public virtual object ToIngressRuleConfig()

Returns

System.Object

Remarks

stability: Stable

Implements

ISecurityGroup

IResource

IConstruct

IDependable

IPeer

IConnectable