software.amazon.awscdk.services.ec2

Class CfnSecurityGroup

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.ec2.CfnSecurityGroup

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.290Z")
 @Stability(value=Stable)
public class CfnSecurityGroup
extends CfnResource
implements IInspectable

A CloudFormation `AWS::EC2::SecurityGroup`.

Specifies a security group. To create a security group, use the VpcId property to specify the VPC for which to create the security group.

This type supports updates. For more information about updating stacks, see AWS CloudFormation Stacks Updates .

To cross-reference two security groups in the ingress and egress rules of those security groups, use the AWS::EC2::SecurityGroupEgress and AWS::EC2::SecurityGroupIngress resources to define your rules. Do not use the embedded ingress and egress rules in the AWS::EC2::SecurityGroup . Doing so creates a circular dependency, which AWS CloudFormation doesn't allow.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ec2.*;
 CfnSecurityGroup cfnSecurityGroup = CfnSecurityGroup.Builder.create(this, "MyCfnSecurityGroup")
         .groupDescription("groupDescription")
         // the properties below are optional
         .groupName("groupName")
         .securityGroupEgress(List.of(EgressProperty.builder()
                 .ipProtocol("ipProtocol")
                 // the properties below are optional
                 .cidrIp("cidrIp")
                 .cidrIpv6("cidrIpv6")
                 .description("description")
                 .destinationPrefixListId("destinationPrefixListId")
                 .destinationSecurityGroupId("destinationSecurityGroupId")
                 .fromPort(123)
                 .toPort(123)
                 .build()))
         .securityGroupIngress(List.of(IngressProperty.builder()
                 .ipProtocol("ipProtocol")
                 // the properties below are optional
                 .cidrIp("cidrIp")
                 .cidrIpv6("cidrIpv6")
                 .description("description")
                 .fromPort(123)
                 .sourcePrefixListId("sourcePrefixListId")
                 .sourceSecurityGroupId("sourceSecurityGroupId")
                 .sourceSecurityGroupName("sourceSecurityGroupName")
                 .sourceSecurityGroupOwnerId("sourceSecurityGroupOwnerId")
                 .toPort(123)
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .vpcId("vpcId")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnSecurityGroup.Builder A fluent builder for CfnSecurityGroup.
static interface	CfnSecurityGroup.EgressProperty [EC2-VPC only] Adds the specified egress rules to a security group for use with a VPC.
static interface	CfnSecurityGroup.IngressProperty Adds an inbound rule to a security group.

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnSecurityGroup(software.constructs.Construct scope, String id, CfnSecurityGroupProps props) Create a new `AWS::EC2::SecurityGroup`.
protected	CfnSecurityGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnSecurityGroup(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrGroupId() The group ID of the specified security group, such as `sg-94b3a1f6` .
String	getAttrVpcId() The physical ID of the VPC.
protected Map<String,Object>	getCfnProperties()
String	getGroupDescription() A description for the security group.
String	getGroupName() The name of the security group.
Object	getSecurityGroupEgress() [VPC only] The outbound rules associated with the security group.
Object	getSecurityGroupIngress() The inbound rules associated with the security group.
TagManager	getTags() Any tags assigned to the security group.
String	getVpcId() [VPC only] The ID of the VPC for the security group.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setGroupDescription(String value) A description for the security group.
void	setGroupName(String value) The name of the security group.
void	setSecurityGroupEgress(IResolvable value) [VPC only] The outbound rules associated with the security group.
void	setSecurityGroupEgress(List<Object> value) [VPC only] The outbound rules associated with the security group.
void	setSecurityGroupIngress(IResolvable value) The inbound rules associated with the security group.
void	setSecurityGroupIngress(List<Object> value) The inbound rules associated with the security group.
void	setVpcId(String value) [VPC only] The ID of the VPC for the security group.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnSecurityGroup

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

CfnSecurityGroup

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

CfnSecurityGroup

@Stability(value=Stable)
public CfnSecurityGroup(@NotNull
                                                 software.constructs.Construct scope,
                                                 @NotNull
                                                 String id,
                                                 @NotNull
                                                 CfnSecurityGroupProps props)

Create a new `AWS::EC2::SecurityGroup`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrGroupId

@Stability(value=Stable)
 @NotNull
public String getAttrGroupId()

The group ID of the specified security group, such as `sg-94b3a1f6` .

getAttrVpcId

@Stability(value=Stable)
 @NotNull
public String getAttrVpcId()

The physical ID of the VPC.

You can obtain the physical ID by using a reference to an AWS::EC2::VPC , such as: { "Ref" : "myVPC" } .

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

Any tags assigned to the security group.

getGroupDescription

@Stability(value=Stable)
 @NotNull
public String getGroupDescription()

A description for the security group. This is informational only.

Constraints: Up to 255 characters in length

Constraints for EC2-Classic: ASCII characters

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

setGroupDescription

@Stability(value=Stable)
public void setGroupDescription(@NotNull
                                                         String value)

A description for the security group. This is informational only.

Constraints: Up to 255 characters in length

Constraints for EC2-Classic: ASCII characters

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

getGroupName

@Stability(value=Stable)
 @Nullable
public String getGroupName()

The name of the security group.

Constraints: Up to 255 characters in length. Cannot start with sg- .

Constraints for EC2-Classic: ASCII characters

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

setGroupName

@Stability(value=Stable)
public void setGroupName(@Nullable
                                                  String value)

The name of the security group.

Constraints: Up to 255 characters in length. Cannot start with sg- .

Constraints for EC2-Classic: ASCII characters

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

getSecurityGroupEgress

@Stability(value=Stable)
 @Nullable
public Object getSecurityGroupEgress()

[VPC only] The outbound rules associated with the security group.

There is a short interruption during which you cannot connect to the security group.

setSecurityGroupEgress

@Stability(value=Stable)
public void setSecurityGroupEgress(@Nullable
                                                            IResolvable value)

[VPC only] The outbound rules associated with the security group.

There is a short interruption during which you cannot connect to the security group.

setSecurityGroupEgress

@Stability(value=Stable)
public void setSecurityGroupEgress(@Nullable
                                                            List<Object> value)

[VPC only] The outbound rules associated with the security group.

There is a short interruption during which you cannot connect to the security group.

getSecurityGroupIngress

@Stability(value=Stable)
 @Nullable
public Object getSecurityGroupIngress()

The inbound rules associated with the security group.

There is a short interruption during which you cannot connect to the security group.

setSecurityGroupIngress

@Stability(value=Stable)
public void setSecurityGroupIngress(@Nullable
                                                             IResolvable value)

The inbound rules associated with the security group.

There is a short interruption during which you cannot connect to the security group.

setSecurityGroupIngress

@Stability(value=Stable)
public void setSecurityGroupIngress(@Nullable
                                                             List<Object> value)

The inbound rules associated with the security group.

There is a short interruption during which you cannot connect to the security group.

getVpcId

@Stability(value=Stable)
 @Nullable
public String getVpcId()

[VPC only] The ID of the VPC for the security group.

setVpcId

@Stability(value=Stable)
public void setVpcId(@Nullable
                                              String value)

[VPC only] The ID of the VPC for the security group.