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.97.0 (build 729de35)", date="2024-04-18T17:54:16.132Z") @Stability(Stable) public interface SecurityGroupProps extends software.amazon.jsii.JsiiSerializable
Example: 

 Vpc vpc;
 SecurityGroup mySecurityGroup = SecurityGroup.Builder.create(this, "SecurityGroup").vpc(vpc).build();
 AutoScalingGroup.Builder.create(this, "ASG")
         .vpc(vpc)
         .instanceType(InstanceType.of(InstanceClass.BURSTABLE2, InstanceSize.MICRO))
         .machineImage(MachineImage.latestAmazonLinux2())
         .securityGroup(mySecurityGroup)
         .build();

  • Method Details

    • getVpc

      @Stability(Stable) @NotNull IVpc getVpc()
      The VPC in which to create the security group.

    • getAllowAllIpv6Outbound

      @Stability(Stable) @Nullable default Boolean getAllowAllIpv6Outbound()
      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

      Default: false

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

      To allow all ipv6 traffic use allowAllIpv6Outbound

      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