software.amazon.awscdk.services.ec2

Class SecurityGroup.Builder

java.lang.Object

software.amazon.awscdk.services.ec2.SecurityGroup.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<SecurityGroup>

Enclosing class:

SecurityGroup

@Stability(value=Stable)
public static final class SecurityGroup.Builder
extends Object
implements software.amazon.jsii.Builder<SecurityGroup>

A fluent builder for SecurityGroup.

Method Summary

Modifier and Type	Method and Description
SecurityGroup.Builder	allowAllOutbound(Boolean allowAllOutbound) Whether to allow all outbound traffic by default.
SecurityGroup	build()
static SecurityGroup.Builder	create(software.constructs.Construct scope, String id)
SecurityGroup.Builder	description(String description) A description of the security group.
SecurityGroup.Builder	disableInlineRules(Boolean disableInlineRules) Whether to disable inline ingress and egress rule optimization.
SecurityGroup.Builder	securityGroupName(String securityGroupName) The name of the security group.
SecurityGroup.Builder	vpc(IVpc vpc) The VPC in which to create the security group.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Stable)
public static SecurityGroup.Builder create(software.constructs.Construct scope,
                                                                    String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of SecurityGroup.Builder.

vpc

@Stability(value=Stable)
public SecurityGroup.Builder vpc(IVpc vpc)

The VPC in which to create the security group.

Parameters:

vpc - The VPC in which to create the security group. This parameter is required.

Returns:

this

allowAllOutbound

@Stability(value=Stable)
public SecurityGroup.Builder allowAllOutbound(Boolean allowAllOutbound)

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

Parameters:

allowAllOutbound - Whether to allow all outbound traffic by default. This parameter is required.

Returns:

this

description

@Stability(value=Stable)
public SecurityGroup.Builder description(String description)

A description of the security group.

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

Parameters:

description - A description of the security group. This parameter is required.

Returns:

this

disableInlineRules

@Stability(value=Stable)
public SecurityGroup.Builder disableInlineRules(Boolean disableInlineRules)

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

Parameters:

disableInlineRules - Whether to disable inline ingress and egress rule optimization. This parameter is required.

Returns:

this

securityGroupName

@Stability(value=Stable)
public SecurityGroup.Builder securityGroupName(String securityGroupName)

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.

Parameters:

securityGroupName - The name of the security group. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public SecurityGroup build()

Specified by:

build in interface software.amazon.jsii.Builder<SecurityGroup>