Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. AWS
  4. API Docs
  5. vpc
  6. getSecurityGroupRule
Viewing docs for AWS v7.51.1
published on Friday, Oct 16, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

aws.vpc.getSecurityGroupRule

aws logo aws logo
Viewing docs for AWS v7.51.1
published on Friday, Oct 16, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

    aws.vpc.getSecurityGroupRule provides details about a specific security group rule.

    The arguments of this data source act as filters for querying the available security group rules. The given filters must match exactly one security group rule whose data will be exported as attributes.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.vpc.getSecurityGroupRule({
    securityGroupRuleId: securityGroupRuleId,
});

    import pulumi
import pulumi_aws as aws

example = aws.vpc.get_security_group_rule(security_group_rule_id=security_group_rule_id)

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/vpc"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vpc.GetSecurityGroupRule(ctx, &vpc.GetSecurityGroupRuleArgs{
			SecurityGroupRuleId: pulumi.StringRef(securityGroupRuleId),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.Vpc.GetSecurityGroupRule.Invoke(new()
    {
        SecurityGroupRuleId = securityGroupRuleId,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.vpc.VpcFunctions;
import com.pulumi.aws.vpc.inputs.GetSecurityGroupRuleArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 example = VpcFunctions.getSecurityGroupRule(GetSecurityGroupRuleArgs.builder()
            .securityGroupRuleId(securityGroupRuleId)
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: aws:vpc:getSecurityGroupRule
      arguments:
        securityGroupRuleId: ${securityGroupRuleId}

    pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_vpc_getsecuritygrouprule" "example" {
  security_group_rule_id = securityGroupRuleId
}

    Using getSecurityGroupRule

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getSecurityGroupRule(args: GetSecurityGroupRuleArgs, opts?: InvokeOptions): Promise<GetSecurityGroupRuleResult>
function getSecurityGroupRuleOutput(args: GetSecurityGroupRuleOutputArgs, opts?: InvokeOutputOptions): Output<GetSecurityGroupRuleResult>
    def get_security_group_rule(filters: Optional[Sequence[GetSecurityGroupRuleFilter]] = None,
                            region: Optional[str] = None,
                            security_group_rule_id: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetSecurityGroupRuleResult
def get_security_group_rule_output(filters: pulumi.Input[Optional[Sequence[pulumi.Input[GetSecurityGroupRuleFilterArgs]]]] = None,
                            region: pulumi.Input[Optional[str]] = None,
                            security_group_rule_id: pulumi.Input[Optional[str]] = None,
                            opts: Optional[InvokeOutputOptions] = None) -> Output[GetSecurityGroupRuleResult]
    func GetSecurityGroupRule(ctx *Context, args *GetSecurityGroupRuleArgs, opts ...InvokeOption) (*GetSecurityGroupRuleResult, error)
func GetSecurityGroupRuleOutput(ctx *Context, args *GetSecurityGroupRuleOutputArgs, opts ...InvokeOption) GetSecurityGroupRuleResultOutput

    > Note: This function is named GetSecurityGroupRule in the Go SDK.

    public static class GetSecurityGroupRule 
{
    public static Task<GetSecurityGroupRuleResult> InvokeAsync(GetSecurityGroupRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetSecurityGroupRuleResult> Invoke(GetSecurityGroupRuleInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetSecurityGroupRuleResult> Invoke(GetSecurityGroupRuleInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetSecurityGroupRuleResult> getSecurityGroupRule(GetSecurityGroupRuleArgs args, InvokeOptions options)
public static Output<GetSecurityGroupRuleResult> getSecurityGroupRule(GetSecurityGroupRuleArgs args, InvokeOptions options)
public static Output<GetSecurityGroupRuleResult> getSecurityGroupRule(GetSecurityGroupRuleArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: aws:vpc/getSecurityGroupRule:getSecurityGroupRule
  arguments:
    # arguments dictionary
    data "aws_vpc_get_security_group_rule" "name" {
    # arguments
}

    The following arguments are supported:

    Filters List<GetSecurityGroupRuleFilter>
    Configuration block(s) for filtering. Detailed below.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    SecurityGroupRuleId string
    ID of the security group rule to select.
    Filters []GetSecurityGroupRuleFilter
    Configuration block(s) for filtering. Detailed below.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    SecurityGroupRuleId string
    ID of the security group rule to select.
    filters list(object)
    Configuration block(s) for filtering. Detailed below.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    security_group_rule_id string
    ID of the security group rule to select.
    filters List<GetSecurityGroupRuleFilter>
    Configuration block(s) for filtering. Detailed below.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    securityGroupRuleId String
    ID of the security group rule to select.
    filters GetSecurityGroupRuleFilter[]
    Configuration block(s) for filtering. Detailed below.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    securityGroupRuleId string
    ID of the security group rule to select.
    filters Sequence[GetSecurityGroupRuleFilter]
    Configuration block(s) for filtering. Detailed below.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    security_group_rule_id str
    ID of the security group rule to select.
    filters List<Property Map>
    Configuration block(s) for filtering. Detailed below.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    securityGroupRuleId String
    ID of the security group rule to select.

    getSecurityGroupRule Result

    The following output properties are available:

    Arn string
    ARN of the security group rule.
    CidrIpv4 string
    Destination IPv4 CIDR range.
    CidrIpv6 string
    Destination IPv6 CIDR range.
    Description string
    Security group rule description.
    FromPort int
    Start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type.
    Id string
    IpProtocol string
    IP protocol name or number. Use -1 to specify all protocols.
    IsEgress bool
    Whether the security group rule is an outbound rule.
    PrefixListId string
    ID of the destination prefix list.
    ReferencedSecurityGroupId string
    Destination security group that is referenced in the rule.
    Region string
    SecurityGroupId string
    ID of the security group.
    SecurityGroupRuleId string
    Tags Dictionary<string, string>
    Map of tags assigned to the resource.
    ToPort int
    End of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.
    Filters List<GetSecurityGroupRuleFilter>
    Arn string
    ARN of the security group rule.
    CidrIpv4 string
    Destination IPv4 CIDR range.
    CidrIpv6 string
    Destination IPv6 CIDR range.
    Description string
    Security group rule description.
    FromPort int
    Start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type.
    Id string
    IpProtocol string
    IP protocol name or number. Use -1 to specify all protocols.
    IsEgress bool
    Whether the security group rule is an outbound rule.
    PrefixListId string
    ID of the destination prefix list.
    ReferencedSecurityGroupId string
    Destination security group that is referenced in the rule.
    Region string
    SecurityGroupId string
    ID of the security group.
    SecurityGroupRuleId string
    Tags map[string]string
    Map of tags assigned to the resource.
    ToPort int
    End of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.
    Filters []GetSecurityGroupRuleFilter
    arn string
    ARN of the security group rule.
    cidr_ipv4 string
    Destination IPv4 CIDR range.
    cidr_ipv6 string
    Destination IPv6 CIDR range.
    description string
    Security group rule description.
    from_port number
    Start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type.
    id string
    ip_protocol string
    IP protocol name or number. Use -1 to specify all protocols.
    is_egress bool
    Whether the security group rule is an outbound rule.
    prefix_list_id string
    ID of the destination prefix list.
    referenced_security_group_id string
    Destination security group that is referenced in the rule.
    region string
    security_group_id string
    ID of the security group.
    security_group_rule_id string
    tags map(string)
    Map of tags assigned to the resource.
    to_port number
    End of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.
    filters list(object)
    arn String
    ARN of the security group rule.
    cidrIpv4 String
    Destination IPv4 CIDR range.
    cidrIpv6 String
    Destination IPv6 CIDR range.
    description String
    Security group rule description.
    fromPort Integer
    Start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type.
    id String
    ipProtocol String
    IP protocol name or number. Use -1 to specify all protocols.
    isEgress Boolean
    Whether the security group rule is an outbound rule.
    prefixListId String
    ID of the destination prefix list.
    referencedSecurityGroupId String
    Destination security group that is referenced in the rule.
    region String
    securityGroupId String
    ID of the security group.
    securityGroupRuleId String
    tags Map<String,String>
    Map of tags assigned to the resource.
    toPort Integer
    End of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.
    filters List<GetSecurityGroupRuleFilter>
    arn string
    ARN of the security group rule.
    cidrIpv4 string
    Destination IPv4 CIDR range.
    cidrIpv6 string
    Destination IPv6 CIDR range.
    description string
    Security group rule description.
    fromPort number
    Start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type.
    id string
    ipProtocol string
    IP protocol name or number. Use -1 to specify all protocols.
    isEgress boolean
    Whether the security group rule is an outbound rule.
    prefixListId string
    ID of the destination prefix list.
    referencedSecurityGroupId string
    Destination security group that is referenced in the rule.
    region string
    securityGroupId string
    ID of the security group.
    securityGroupRuleId string
    tags {[key: string]: string}
    Map of tags assigned to the resource.
    toPort number
    End of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.
    filters GetSecurityGroupRuleFilter[]
    arn str
    ARN of the security group rule.
    cidr_ipv4 str
    Destination IPv4 CIDR range.
    cidr_ipv6 str
    Destination IPv6 CIDR range.
    description str
    Security group rule description.
    from_port int
    Start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type.
    id str
    ip_protocol str
    IP protocol name or number. Use -1 to specify all protocols.
    is_egress bool
    Whether the security group rule is an outbound rule.
    prefix_list_id str
    ID of the destination prefix list.
    referenced_security_group_id str
    Destination security group that is referenced in the rule.
    region str
    security_group_id str
    ID of the security group.
    security_group_rule_id str
    tags Mapping[str, str]
    Map of tags assigned to the resource.
    to_port int
    End of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.
    filters Sequence[GetSecurityGroupRuleFilter]
    arn String
    ARN of the security group rule.
    cidrIpv4 String
    Destination IPv4 CIDR range.
    cidrIpv6 String
    Destination IPv6 CIDR range.
    description String
    Security group rule description.
    fromPort Number
    Start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type.
    id String
    ipProtocol String
    IP protocol name or number. Use -1 to specify all protocols.
    isEgress Boolean
    Whether the security group rule is an outbound rule.
    prefixListId String
    ID of the destination prefix list.
    referencedSecurityGroupId String
    Destination security group that is referenced in the rule.
    region String
    securityGroupId String
    ID of the security group.
    securityGroupRuleId String
    tags Map<String>
    Map of tags assigned to the resource.
    toPort Number
    End of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.
    filters List<Property Map>

    Supporting Types

    GetSecurityGroupRuleFilter

    Name string
    Name of the filter field. Valid values can be found in the EC2 DescribeSecurityGroupRules API Reference.
    Values List<string>
    Set of values that are accepted for the given filter field. Results will be selected if any given value matches.
    Name string
    Name of the filter field. Valid values can be found in the EC2 DescribeSecurityGroupRules API Reference.
    Values []string
    Set of values that are accepted for the given filter field. Results will be selected if any given value matches.
    name string
    Name of the filter field. Valid values can be found in the EC2 DescribeSecurityGroupRules API Reference.
    values list(string)
    Set of values that are accepted for the given filter field. Results will be selected if any given value matches.
    name String
    Name of the filter field. Valid values can be found in the EC2 DescribeSecurityGroupRules API Reference.
    values List<String>
    Set of values that are accepted for the given filter field. Results will be selected if any given value matches.
    name string
    Name of the filter field. Valid values can be found in the EC2 DescribeSecurityGroupRules API Reference.
    values string[]
    Set of values that are accepted for the given filter field. Results will be selected if any given value matches.
    name str
    Name of the filter field. Valid values can be found in the EC2 DescribeSecurityGroupRules API Reference.
    values Sequence[str]
    Set of values that are accepted for the given filter field. Results will be selected if any given value matches.
    name String
    Name of the filter field. Valid values can be found in the EC2 DescribeSecurityGroupRules API Reference.
    values List<String>
    Set of values that are accepted for the given filter field. Results will be selected if any given value matches.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo aws logo
    Viewing docs for AWS v7.51.1
    published on Friday, Oct 16, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial