interface CfnSecurityGroupProps

Language	Type name
.NET	Amazon.CDK.AWS.EC2.CfnSecurityGroupProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsec2#CfnSecurityGroupProps
Java	software.amazon.awscdk.services.ec2.CfnSecurityGroupProps
Python	aws_cdk.aws_ec2.CfnSecurityGroupProps
TypeScript	aws-cdk-lib » aws_ec2 » CfnSecurityGroupProps

Properties for defining a CfnSecurityGroup.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroup.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
const cfnSecurityGroupProps: ec2.CfnSecurityGroupProps = {
  groupDescription: 'groupDescription',

  // the properties below are optional
  groupName: 'groupName',
  securityGroupEgress: [{
    ipProtocol: 'ipProtocol',

    // the properties below are optional
    cidrIp: 'cidrIp',
    cidrIpv6: 'cidrIpv6',
    description: 'description',
    destinationPrefixListId: 'destinationPrefixListId',
    destinationSecurityGroupId: 'destinationSecurityGroupId',
    fromPort: 123,
    toPort: 123,
  }],
  securityGroupIngress: [{
    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,
  }],
  tags: [{
    key: 'key',
    value: 'value',
  }],
  vpcId: 'vpcId',
};

Properties

Name	Type	Description
groupDescription	string	A description for the security group.
groupName?	string	The name of the security group. Names are case-insensitive and must be unique within the VPC.
securityGroupEgress?	IResolvable | (IResolvable | EgressProperty)[]	The outbound rules associated with the security group.
securityGroupIngress?	IResolvable | (IResolvable | IngressProperty)[]	The inbound rules associated with the security group.
tags?	CfnTag[]	Any tags assigned to the security group.
vpcId?	string	The ID of the VPC for the security group.

---

groupDescription

Type: string

A description for the security group.

Constraints: Up to 255 characters in length

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroup.html#cfn-ec2-securitygroup-groupdescription

---

groupName?

Type: string (optional)

The name of the security group. Names are case-insensitive and must be unique within the VPC.

Constraints: Up to 255 characters in length. Can't start with sg- .

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroup.html#cfn-ec2-securitygroup-groupname

---

securityGroupEgress?

Type: IResolvable | (IResolvable | EgressProperty)[] (optional)

The outbound rules associated with the security group.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroup.html#cfn-ec2-securitygroup-securitygroupegress

---

securityGroupIngress?

Type: IResolvable | (IResolvable | IngressProperty)[] (optional)

The inbound rules associated with the security group.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroup.html#cfn-ec2-securitygroup-securitygroupingress

---

tags?

Type: CfnTag[] (optional)

Any tags assigned to the security group.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroup.html#cfn-ec2-securitygroup-tags

---

vpcId?

Type: string (optional)

The ID of the VPC for the security group.

If you do not specify a VPC, the default is to use the default VPC for the Region. If there's no specified VPC and no default VPC, security group creation fails.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroup.html#cfn-ec2-securitygroup-vpcid