Package com.pulumi.aws.ec2

Class SecurityGroupRule

  • public class SecurityGroupRule
extends com.pulumi.resources.CustomResource
    Provides a security group rule resource. Represents a single `ingress` or `egress` group rule, which can be added to external Security Groups. > **NOTE:** Avoid using the `aws.ec2.SecurityGroupRule` resource, as it struggles with managing multiple CIDR blocks, and, due to the historical lack of unique IDs, tags and descriptions. To avoid these problems, use the current best practice of the `aws.vpc.SecurityGroupEgressRule` and `aws.vpc.SecurityGroupIngressRule` resources with one CIDR block per rule. !> **WARNING:** You should not use the `aws.ec2.SecurityGroupRule` resource in conjunction with `aws.vpc.SecurityGroupEgressRule` and `aws.vpc.SecurityGroupIngressRule` resources or with an `aws.ec2.SecurityGroup` resource that has in-line rules. Doing so may cause rule conflicts, perpetual differences, and result in rules being overwritten. > **NOTE:** Setting `protocol = "all"` or `protocol = -1` with `from_port` and `to_port` will result in the EC2 API creating a security group rule with all ports open. This API behavior cannot be controlled by this provider and may generate warnings in the future. > **NOTE:** Referencing Security Groups across VPC peering has certain restrictions. More information is available in the [VPC Peering User Guide](https://docs.aws.amazon.com/vpc/latest/peering/vpc-peering-security-groups.html). ## Example Usage Basic usage <!--Start PulumiCodeChooser --> 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.ec2.SecurityGroupRule;
 import com.pulumi.aws.ec2.SecurityGroupRuleArgs;
 import java.util.List;
 import java.util.ArrayList;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var example = new SecurityGroupRule("example", SecurityGroupRuleArgs.builder()
             .type("ingress")
             .fromPort(0)
             .toPort(65535)
             .protocol("tcp")
             .cidrBlocks(exampleAwsVpc.cidrBlock())
             .ipv6CidrBlocks(exampleAwsVpc.ipv6CidrBlock())
             .securityGroupId("sg-123456")
             .build());
 
     }
 }
    <!--End PulumiCodeChooser --> ### Usage With Prefix List IDs Prefix Lists are either managed by AWS internally, or created by the customer using a Managed Prefix List resource. Prefix Lists provided by AWS are associated with a prefix list name, or service name, that is linked to a specific region. Prefix list IDs are exported on VPC Endpoints, so you can use this format: <!--Start PulumiCodeChooser --> 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.ec2.VpcEndpoint;
 import com.pulumi.aws.ec2.SecurityGroupRule;
 import com.pulumi.aws.ec2.SecurityGroupRuleArgs;
 import java.util.List;
 import java.util.ArrayList;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         // ...
         var myEndpoint = new VpcEndpoint("myEndpoint");
 
         var allowAll = new SecurityGroupRule("allowAll", SecurityGroupRuleArgs.builder()
             .type("egress")
             .toPort(0)
             .protocol("-1")
             .prefixListIds(myEndpoint.prefixListId())
             .fromPort(0)
             .securityGroupId("sg-123456")
             .build());
 
     }
 }
    <!--End PulumiCodeChooser --> You can also find a specific Prefix List using the `aws.ec2.getPrefixList` or `ec2_managed_prefix_list` data sources: <!--Start PulumiCodeChooser --> 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.AwsFunctions;
 import com.pulumi.aws.inputs.GetRegionArgs;
 import com.pulumi.aws.ec2.Ec2Functions;
 import com.pulumi.aws.ec2.inputs.GetPrefixListArgs;
 import com.pulumi.aws.ec2.SecurityGroupRule;
 import com.pulumi.aws.ec2.SecurityGroupRuleArgs;
 import java.util.List;
 import java.util.ArrayList;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         final var current = AwsFunctions.getRegion();
 
         final var s3 = Ec2Functions.getPrefixList(GetPrefixListArgs.builder()
             .name(String.format("com.amazonaws.%s.s3", current.applyValue(getRegionResult -> getRegionResult.name())))
             .build());
 
         var s3GatewayEgress = new SecurityGroupRule("s3GatewayEgress", SecurityGroupRuleArgs.builder()
             .description("S3 Gateway Egress")
             .type("egress")
             .securityGroupId("sg-123456")
             .fromPort(443)
             .toPort(443)
             .protocol("tcp")
             .prefixListIds(s3.applyValue(getPrefixListResult -> getPrefixListResult.id()))
             .build());
 
     }
 }
    <!--End PulumiCodeChooser --> ## Import Import a rule with various IPv4 and IPv6 source CIDR blocks: Import a rule, applicable to all ports, with a protocol other than TCP/UDP/ICMP/ICMPV6/ALL, e.g., Multicast Transport Protocol (MTP), using the IANA protocol number. For example: 92. Import a default any/any egress rule to 0.0.0.0/0: Import an egress rule with a prefix list ID destination: Import a rule applicable to all protocols and ports with a security group source: Import a rule that has itself and an IPv6 CIDR block as sources: __Using `pulumi import` to import__ Security Group Rules using the `security_group_id`, `type`, `protocol`, `from_port`, `to_port`, and source(s)/destination(s) (such as a `cidr_block`) separated by underscores (`_`). All parts are required. For example: __NOTE:__ Not all rule permissions (e.g., not all of a rule's CIDR blocks) need to be imported for this provider to manage rule permissions. However, importing some of a rule's permissions but not others, and then making changes to the rule will result in the creation of an additional rule to capture the updated permissions. Rule permissions that were not imported are left intact in the original rule. Import an ingress rule in security group `sg-6e616f6d69` for TCP port 8000 with an IPv4 destination CIDR of `10.0.3.0/24`: ```sh $ pulumi import aws:ec2/securityGroupRule:SecurityGroupRule ingress sg-6e616f6d69_ingress_tcp_8000_8000_10.0.3.0/24 ``` Import a rule with various IPv4 and IPv6 source CIDR blocks: ```sh $ pulumi import aws:ec2/securityGroupRule:SecurityGroupRule ingress sg-4973616163_ingress_tcp_100_121_10.1.0.0/16_2001:db8::/48_10.2.0.0/16_2002:db8::/48 ``` Import a rule, applicable to all ports, with a protocol other than TCP/UDP/ICMP/ICMPV6/ALL, e.g., Multicast Transport Protocol (MTP), using the IANA protocol number. For example: 92. ```sh $ pulumi import aws:ec2/securityGroupRule:SecurityGroupRule ingress sg-6777656e646f6c796e_ingress_92_0_65536_10.0.3.0/24_10.0.4.0/24 ``` Import a default any/any egress rule to 0.0.0.0/0: ```sh $ pulumi import aws:ec2/securityGroupRule:SecurityGroupRule default_egress sg-6777656e646f6c796e_egress_all_0_0_0.0.0.0/0 ``` Import an egress rule with a prefix list ID destination: ```sh $ pulumi import aws:ec2/securityGroupRule:SecurityGroupRule egress sg-62726f6479_egress_tcp_8000_8000_pl-6469726b ``` Import a rule applicable to all protocols and ports with a security group source: ```sh $ pulumi import aws:ec2/securityGroupRule:SecurityGroupRule ingress_rule sg-7472697374616e_ingress_all_0_65536_sg-6176657279 ``` Import a rule that has itself and an IPv6 CIDR block as sources: ```sh $ pulumi import aws:ec2/securityGroupRule:SecurityGroupRule rule_name sg-656c65616e6f72_ingress_tcp_80_80_self_2001:db8::/48 ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> cidrBlocks()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      com.pulumi.core.Output<java.lang.Integer> fromPort()  
      static SecurityGroupRule get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, SecurityGroupRuleState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> ipv6CidrBlocks()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> prefixListIds()  
      com.pulumi.core.Output<java.lang.String> protocol()  
      com.pulumi.core.Output<java.lang.String> securityGroupId()  
      com.pulumi.core.Output<java.lang.String> securityGroupRuleId()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> self()  
      com.pulumi.core.Output<java.lang.String> sourceSecurityGroupId()  
      com.pulumi.core.Output<java.lang.Integer> toPort()  
      com.pulumi.core.Output<java.lang.String> type()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • SecurityGroupRule

        public SecurityGroupRule​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • SecurityGroupRule

        public SecurityGroupRule​(java.lang.String name,
                         SecurityGroupRuleArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • SecurityGroupRule

        public SecurityGroupRule​(java.lang.String name,
                         SecurityGroupRuleArgs args,
                         @Nullable
                         com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • cidrBlocks

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> cidrBlocks()
        Returns:
        List of CIDR blocks. Cannot be specified with `source_security_group_id` or `self`.

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        Description of the rule.

      • fromPort

        public com.pulumi.core.Output<java.lang.Integer> fromPort()
        Returns:
        Start port (or ICMP type number if protocol is "icmp" or "icmpv6").

      • ipv6CidrBlocks

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> ipv6CidrBlocks()
        Returns:
        List of IPv6 CIDR blocks. Cannot be specified with `source_security_group_id` or `self`.

      • prefixListIds

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> prefixListIds()
        Returns:
        List of Prefix List IDs.

      • protocol

        public com.pulumi.core.Output<java.lang.String> protocol()
        Returns:
        Protocol. If not icmp, icmpv6, tcp, udp, or all use the [protocol number](https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml)

      • securityGroupId

        public com.pulumi.core.Output<java.lang.String> securityGroupId()
        Returns:
        Security group to apply this rule to.

      • securityGroupRuleId

        public com.pulumi.core.Output<java.lang.String> securityGroupRuleId()
        Returns:
        If the `aws.ec2.SecurityGroupRule` resource has a single source or destination then this is the AWS Security Group Rule resource ID. Otherwise it is empty.

      • self

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> self()
        Returns:
        Whether the security group itself will be added as a source to this ingress rule. Cannot be specified with `cidr_blocks`, `ipv6_cidr_blocks`, or `source_security_group_id`.

      • sourceSecurityGroupId

        public com.pulumi.core.Output<java.lang.String> sourceSecurityGroupId()
        Returns:
        Security group id to allow access to/from, depending on the `type`. Cannot be specified with `cidr_blocks`, `ipv6_cidr_blocks`, or `self`.

      • toPort

        public com.pulumi.core.Output<java.lang.Integer> toPort()
        Returns:
        End port (or ICMP code if protocol is "icmp").

      • type

        public com.pulumi.core.Output<java.lang.String> type()
        Returns:
        Type of rule being created. Valid options are `ingress` (inbound) or `egress` (outbound). The following arguments are optional: > **Note** Although `cidr_blocks`, `ipv6_cidr_blocks`, `prefix_list_ids`, and `source_security_group_id` are all marked as optional, you _must_ provide one of them in order to configure the source of the traffic.

      • get

        public static SecurityGroupRule get​(java.lang.String name,
                                    com.pulumi.core.Output<java.lang.String> id,
                                    @Nullable
                                    SecurityGroupRuleState state,
                                    @Nullable
                                    com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.