software.amazon.awscdk.services.ec2

Class SecurityGroupProps.Builder

java.lang.Object

software.amazon.awscdk.services.ec2.SecurityGroupProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<SecurityGroupProps>

Enclosing interface:

SecurityGroupProps

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

A builder for SecurityGroupProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
SecurityGroupProps.Builder	allowAllOutbound(Boolean allowAllOutbound) Sets the value of SecurityGroupProps.getAllowAllOutbound()
SecurityGroupProps	build() Builds the configured instance.
SecurityGroupProps.Builder	description(String description) Sets the value of SecurityGroupProps.getDescription()
SecurityGroupProps.Builder	disableInlineRules(Boolean disableInlineRules) Sets the value of SecurityGroupProps.getDisableInlineRules()
SecurityGroupProps.Builder	securityGroupName(String securityGroupName) Sets the value of SecurityGroupProps.getSecurityGroupName()
SecurityGroupProps.Builder	vpc(IVpc vpc) Sets the value of SecurityGroupProps.getVpc()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

vpc

@Stability(value=Experimental)
public SecurityGroupProps.Builder vpc(IVpc vpc)

Sets the value of SecurityGroupProps.getVpc()

Parameters:

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

Returns:

this

allowAllOutbound

@Stability(value=Experimental)
public SecurityGroupProps.Builder allowAllOutbound(Boolean allowAllOutbound)

Sets the value of SecurityGroupProps.getAllowAllOutbound()

Parameters:

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.

Returns:

this

description

@Stability(value=Experimental)
public SecurityGroupProps.Builder description(String description)

Sets the value of SecurityGroupProps.getDescription()

Parameters:

description - A description of the security group.

Returns:

this

disableInlineRules

@Stability(value=Experimental)
public SecurityGroupProps.Builder disableInlineRules(Boolean disableInlineRules)

Sets the value of SecurityGroupProps.getDisableInlineRules()

Parameters:

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'.

Returns:

this

securityGroupName

@Stability(value=Experimental)
public SecurityGroupProps.Builder securityGroupName(String securityGroupName)

Sets the value of SecurityGroupProps.getSecurityGroupName()

Parameters:

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.

Returns:

this

build

@Stability(value=Experimental)
public SecurityGroupProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of SecurityGroupProps

Throws:

NullPointerException - if any required attribute was not provided