Package 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(Stable) public static final class SecurityGroupProps.Builder extends Object implements software.amazon.jsii.Builder<SecurityGroupProps>
A builder for SecurityGroupProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • vpc

      @Stability(Stable) 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

    • allowAllIpv6Outbound

      @Stability(Stable) public SecurityGroupProps.Builder allowAllIpv6Outbound(Boolean allowAllIpv6Outbound)
      Sets the value of SecurityGroupProps.getAllowAllIpv6Outbound()
      Parameters:
      allowAllIpv6Outbound - Whether to allow all outbound ipv6 traffic by default. If this is set to true, there will only be a single egress rule which allows all outbound ipv6 traffic. If this is set to false, no outbound traffic will be allowed by default and all egress ipv6 traffic must be explicitly authorized.

      To allow all ipv4 traffic use allowAllOutbound

      Returns:
      this

    • allowAllOutbound

      @Stability(Stable) 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.

      To allow all ipv6 traffic use allowAllIpv6Outbound

      Returns:
      this

    • description

      @Stability(Stable) public SecurityGroupProps.Builder description(String description)
      Sets the value of SecurityGroupProps.getDescription()
      Parameters:
      description - A description of the security group.
      Returns:
      this

    • disableInlineRules

      @Stability(Stable) 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(Stable) 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(Stable) 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