Package software.amazon.awscdk.services.ec2

Interface SecurityGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

SecurityGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:39.528Z")
@Stability(Stable)
public interface SecurityGroupProps
extends software.amazon.jsii.JsiiSerializable

Example:

 Vpc vpc;
 SecurityGroup securityGroup1 = SecurityGroup.Builder.create(this, "SecurityGroup1").vpc(vpc).build();
 ApplicationLoadBalancer lb = ApplicationLoadBalancer.Builder.create(this, "LB")
         .vpc(vpc)
         .internetFacing(true)
         .securityGroup(securityGroup1)
         .build();
 SecurityGroup securityGroup2 = SecurityGroup.Builder.create(this, "SecurityGroup2").vpc(vpc).build();
 lb.addSecurityGroup(securityGroup2);
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	SecurityGroupProps.Builder	A builder for SecurityGroupProps
static final class	SecurityGroupProps.Jsii$Proxy	An implementation for SecurityGroupProps

Method Summary

Modifier and Type	Method	Description
static SecurityGroupProps.Builder	builder()
default Boolean	getAllowAllOutbound()	Whether to allow all outbound traffic by default.
default String	getDescription()	A description of the security group.
default Boolean	getDisableInlineRules()	Whether to disable inline ingress and egress rule optimization.
default String	getSecurityGroupName()	The name of the security group.
IVpc	getVpc()	The VPC in which to create the security group.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getVpc

@Stability(Stable)
@NotNull
IVpc getVpc()

The VPC in which to create the security group.

getAllowAllOutbound

@Stability(Stable)
@Nullable
default Boolean getAllowAllOutbound()

Whether to allow all outbound traffic by default.

If this is set to true, there will only be a single egress rule which allows all outbound traffic. If this is set to false, no outbound traffic will be allowed by default and all egress traffic must be explicitly authorized.

Default: true

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description of the security group.

Default: The default name will be the construct's CDK path.

getDisableInlineRules

@Stability(Stable)
@Nullable
default Boolean getDisableInlineRules()

Whether to disable inline ingress and egress rule optimization.

If this is set to true, ingress and egress rules will not be declared under the SecurityGroup in cloudformation, but will be separate elements.

Inlining rules is an optimization for producing smaller stack templates. Sometimes this is not desirable, for example when security group access is managed via tags.

The default value can be overriden globally by setting the context variable '@aws-cdk/aws-ec2.securityGroupDisableInlineRules'.

Default: false

getSecurityGroupName

@Stability(Stable)
@Nullable
default String getSecurityGroupName()

The name of the security group.

For valid values, see the GroupName parameter of the CreateSecurityGroup action in the Amazon EC2 API Reference.

It is not recommended to use an explicit group name.

Default: If you don't specify a GroupName, AWS CloudFormation generates a unique physical ID and uses that ID for the group name.

builder

@Stability(Stable)
static SecurityGroupProps.Builder builder()

Returns:

a SecurityGroupProps.Builder of SecurityGroupProps