software.amazon.awscdk.services.ec2

Class SecurityGroup

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.ec2.SecurityGroup

All Implemented Interfaces:

software.amazon.awscdk.core.IConstruct, software.amazon.awscdk.core.IDependable, software.amazon.awscdk.core.IResource, IConnectable, IPeer, ISecurityGroup, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/0.17.0 (build 7d5d104)",
           date="2019-09-20T09:56:19.053Z")
 @Stability(value=Stable)
public class SecurityGroup
extends software.amazon.awscdk.core.Resource
implements ISecurityGroup

Creates an Amazon EC2 security group within a VPC. 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).

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ec2.ISecurityGroup

ISecurityGroup.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	SecurityGroup(software.amazon.awscdk.core.Construct scope, String id, SecurityGroupProps props)
protected	SecurityGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	SecurityGroup(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
void	addEgressRule(IPeer peer, Port connection) Add an egress rule for the current security group.
void	addEgressRule(IPeer peer, Port connection, String description) Add an egress rule for the current security group.
void	addEgressRule(IPeer peer, Port connection, String description, Boolean remoteRule) Add an egress rule for the current security group.
void	addIngressRule(IPeer peer, Port connection) Add an ingress rule for the current security group.
void	addIngressRule(IPeer peer, Port connection, String description) Add an ingress rule for the current security group.
void	addIngressRule(IPeer peer, Port connection, String description, Boolean remoteRule) Add an ingress rule for the current security group.
static ISecurityGroup	fromSecurityGroupId(software.amazon.awscdk.core.Construct scope, String id, String securityGroupId) Import an existing security group into this app.
static ISecurityGroup	fromSecurityGroupId(software.amazon.awscdk.core.Construct scope, String id, String securityGroupId, SecurityGroupImportOptions options) Import an existing security group into this app.
Boolean	getCanInlineRule() Whether the rule can be inlined into a SecurityGroup or not.
Connections	getConnections()
Port	getDefaultPort()
String	getSecurityGroupId() The ID of the security group.
String	getSecurityGroupName() An attribute that represents the security group name.
String	getSecurityGroupVpcId() The VPC ID this security group is part of.
String	getUniqueId() A unique identifier for this connection peer.
static Boolean	isSecurityGroup(Object x) Return whether the indicated object is a security group.
Object	toEgressRuleConfig() Produce the egress rule JSON for the given connection.
Object	toIngressRuleConfig() Produce the ingress rule JSON for the given connection.

Methods inherited from class software.amazon.awscdk.core.Resource

generatePhysicalName, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, prepare, synthesize, toString, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiCall, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticGet, jsiiStaticSet, setObjRef

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.core.IResource

getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

SecurityGroup

protected SecurityGroup(software.amazon.jsii.JsiiObjectRef objRef)

SecurityGroup

protected SecurityGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

SecurityGroup

@Stability(value=Stable)
public SecurityGroup(software.amazon.awscdk.core.Construct scope,
                                              String id,
                                              SecurityGroupProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromSecurityGroupId

@Stability(value=Stable)
public static ISecurityGroup fromSecurityGroupId(software.amazon.awscdk.core.Construct scope,
                                                                          String id,
                                                                          String securityGroupId,
                                                                          SecurityGroupImportOptions options)

Import an existing security group into this app.

Parameters:

scope - This parameter is required.

id - This parameter is required.

securityGroupId - This parameter is required.

options -

fromSecurityGroupId

@Stability(value=Stable)
public static ISecurityGroup fromSecurityGroupId(software.amazon.awscdk.core.Construct scope,
                                                                          String id,
                                                                          String securityGroupId)

Import an existing security group into this app.

Parameters:

scope - This parameter is required.

id - This parameter is required.

securityGroupId - This parameter is required.

isSecurityGroup

@Stability(value=Stable)
public static Boolean isSecurityGroup(Object x)

Return whether the indicated object is a security group.

Parameters:

x - This parameter is required.

addEgressRule

@Stability(value=Stable)
public void addEgressRule(IPeer peer,
                                                   Port connection,
                                                   String description,
                                                   Boolean remoteRule)

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.

Specified by:

addEgressRule in interface ISecurityGroup

Parameters:

peer - This parameter is required.

connection - This parameter is required.

description -

remoteRule -

addEgressRule

@Stability(value=Stable)
public void addEgressRule(IPeer peer,
                                                   Port connection,
                                                   String description)

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.

Specified by:

addEgressRule in interface ISecurityGroup

Parameters:

peer - This parameter is required.

connection - This parameter is required.

description -

addEgressRule

@Stability(value=Stable)
public void addEgressRule(IPeer peer,
                                                   Port connection)

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.

Specified by:

addEgressRule in interface ISecurityGroup

Parameters:

peer - This parameter is required.

connection - This parameter is required.

addIngressRule

@Stability(value=Stable)
public void addIngressRule(IPeer peer,
                                                    Port connection,
                                                    String description,
                                                    Boolean remoteRule)

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.

Specified by:

addIngressRule in interface ISecurityGroup

Parameters:

peer - This parameter is required.

connection - This parameter is required.

description -

remoteRule -

addIngressRule

@Stability(value=Stable)
public void addIngressRule(IPeer peer,
                                                    Port connection,
                                                    String description)

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.

Specified by:

addIngressRule in interface ISecurityGroup

Parameters:

peer - This parameter is required.

connection - This parameter is required.

description -

addIngressRule

@Stability(value=Stable)
public void addIngressRule(IPeer peer,
                                                    Port connection)

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.

Specified by:

addIngressRule in interface ISecurityGroup

Parameters:

peer - This parameter is required.

connection - This parameter is required.

toEgressRuleConfig

@Stability(value=Stable)
public Object toEgressRuleConfig()

Produce the egress rule JSON for the given connection.

Specified by:

toEgressRuleConfig in interface IPeer

toIngressRuleConfig

@Stability(value=Stable)
public Object toIngressRuleConfig()

Produce the ingress rule JSON for the given connection.

Specified by:

toIngressRuleConfig in interface IPeer

getCanInlineRule

@Stability(value=Stable)
public Boolean getCanInlineRule()

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

Specified by:

getCanInlineRule in interface IPeer

getConnections

@Stability(value=Stable)
public Connections getConnections()

Specified by:

getConnections in interface IConnectable

getSecurityGroupId

@Stability(value=Stable)
public String getSecurityGroupId()

The ID of the security group.

Specified by:

getSecurityGroupId in interface ISecurityGroup

getSecurityGroupName

@Stability(value=Stable)
public String getSecurityGroupName()

An attribute that represents the security group name.

getSecurityGroupVpcId

@Stability(value=Stable)
public String getSecurityGroupVpcId()

The VPC ID this security group is part of.

getUniqueId

@Stability(value=Stable)
public String getUniqueId()

A unique identifier for this connection peer.

Specified by:

getUniqueId in interface IPeer

getDefaultPort

@Stability(value=Stable)
public Port getDefaultPort()