pulumi-aws-kotlin/com.pulumi.aws.vpc.kotlin/SecurityGroupIngressRuleArgs

SecurityGroupIngressRuleArgs

data class SecurityGroupIngressRuleArgs(val cidrIpv4: Output<String>? = null, val cidrIpv6: Output<String>? = null, val description: Output<String>? = null, val fromPort: Output<Int>? = null, val ipProtocol: Output<String>? = null, val prefixListId: Output<String>? = null, val referencedSecurityGroupId: Output<String>? = null, val securityGroupId: Output<String>? = null, val tags: Output<Map<String, String>>? = null, val toPort: Output<Int>? = null) : ConvertibleToJava<SecurityGroupIngressRuleArgs>

Manages an inbound (ingress) rule for a security group. When specifying an inbound rule for your security group in a VPC, the configuration must include a source for the traffic.

NOTE on Security Groups and Security Group Rules: this provider currently provides a Security Group resource with ingress and egress rules defined in-line and a Security Group Rule resource which manages one or more ingress or egress rules. Both of these resource were added before AWS assigned a security group rule unique ID, and they do not work well in all scenarios using thedescription and tags attributes, which rely on the unique ID. The aws.vpc.SecurityGroupIngressRule resource has been added to address these limitations and should be used for all new security group rules. You should not use the aws.vpc.SecurityGroupIngressRule resource in conjunction with an aws.ec2.SecurityGroup resource with in-line rules or with aws.ec2.SecurityGroupRule resources defined for the same Security Group, as rule conflicts may occur and rules will be overwritten.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.ec2.SecurityGroup("example", {
    name: "example",
    description: "example",
    vpcId: main.id,
    tags: {
        Name: "example",
    },
});
const exampleSecurityGroupIngressRule = new aws.vpc.SecurityGroupIngressRule("example", {
    securityGroupId: example.id,
    cidrIpv4: "10.0.0.0/8",
    fromPort: 80,
    ipProtocol: "tcp",
    toPort: 80,
});
Content copied to clipboard
import pulumi
import pulumi_aws as aws
example = aws.ec2.SecurityGroup("example",
    name="example",
    description="example",
    vpc_id=main["id"],
    tags={
        "Name": "example",
    })
example_security_group_ingress_rule = aws.vpc.SecurityGroupIngressRule("example",
    security_group_id=example.id,
    cidr_ipv4="10.0.0.0/8",
    from_port=80,
    ip_protocol="tcp",
    to_port=80)
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
    var example = new Aws.Ec2.SecurityGroup("example", new()
    {
        Name = "example",
        Description = "example",
        VpcId = main.Id,
        Tags =
        {
            { "Name", "example" },
        },
    });
    var exampleSecurityGroupIngressRule = new Aws.Vpc.SecurityGroupIngressRule("example", new()
    {
        SecurityGroupId = example.Id,
        CidrIpv4 = "10.0.0.0/8",
        FromPort = 80,
        IpProtocol = "tcp",
        ToPort = 80,
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/vpc"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := ec2.NewSecurityGroup(ctx, "example", &ec2.SecurityGroupArgs{
			Name:        pulumi.String("example"),
			Description: pulumi.String("example"),
			VpcId:       pulumi.Any(main.Id),
			Tags: pulumi.StringMap{
				"Name": pulumi.String("example"),
			},
		})
		if err != nil {
			return err
		}
		_, err = vpc.NewSecurityGroupIngressRule(ctx, "example", &vpc.SecurityGroupIngressRuleArgs{
			SecurityGroupId: example.ID(),
			CidrIpv4:        pulumi.String("10.0.0.0/8"),
			FromPort:        pulumi.Int(80),
			IpProtocol:      pulumi.String("tcp"),
			ToPort:          pulumi.Int(80),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.SecurityGroup;
import com.pulumi.aws.ec2.SecurityGroupArgs;
import com.pulumi.aws.vpc.SecurityGroupIngressRule;
import com.pulumi.aws.vpc.SecurityGroupIngressRuleArgs;
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 SecurityGroup("example", SecurityGroupArgs.builder()
            .name("example")
            .description("example")
            .vpcId(main.id())
            .tags(Map.of("Name", "example"))
            .build());
        var exampleSecurityGroupIngressRule = new SecurityGroupIngressRule("exampleSecurityGroupIngressRule", SecurityGroupIngressRuleArgs.builder()
            .securityGroupId(example.id())
            .cidrIpv4("10.0.0.0/8")
            .fromPort(80)
            .ipProtocol("tcp")
            .toPort(80)
            .build());
    }
}
Content copied to clipboard
resources:
  example:
    type: aws:ec2:SecurityGroup
    properties:
      name: example
      description: example
      vpcId: ${main.id}
      tags:
        Name: example
  exampleSecurityGroupIngressRule:
    type: aws:vpc:SecurityGroupIngressRule
    name: example
    properties:
      securityGroupId: ${example.id}
      cidrIpv4: 10.0.0.0/8
      fromPort: 80
      ipProtocol: tcp
      toPort: 80
Content copied to clipboard

Import

Using pulumi import, import security group ingress rules using the security_group_rule_id. For example:

$ pulumi import aws:vpc/securityGroupIngressRule:SecurityGroupIngressRule example sgr-02108b27edd666983
Content copied to clipboard

Constructors

Link copied to clipboard
fun SecurityGroupIngressRuleArgs(cidrIpv4: Output<String>? = null, cidrIpv6: Output<String>? = null, description: Output<String>? = null, fromPort: Output<Int>? = null, ipProtocol: Output<String>? = null, prefixListId: Output<String>? = null, referencedSecurityGroupId: Output<String>? = null, securityGroupId: Output<String>? = null, tags: Output<Map<String, String>>? = null, toPort: Output<Int>? = null)

Functions

Link copied to clipboard
open override fun toJava(): SecurityGroupIngressRuleArgs

Properties

Link copied to clipboard
val cidrIpv4: Output<String>? = null

The source IPv4 CIDR range.

Link copied to clipboard
val cidrIpv6: Output<String>? = null

The source IPv6 CIDR range.

Link copied to clipboard
val description: Output<String>? = null

The security group rule description.

Link copied to clipboard
val fromPort: Output<Int>? = null

The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type.

Link copied to clipboard
val ipProtocol: Output<String>? = null

The IP protocol name or number. Use -1 to specify all protocols. Note that if ip_protocol is set to -1, it translates to all protocols, all port ranges, and from_port and to_port values should not be defined.

Link copied to clipboard
val prefixListId: Output<String>? = null

The ID of the source prefix list.

Link copied to clipboard
val referencedSecurityGroupId: Output<String>? = null

The source security group that is referenced in the rule.

Link copied to clipboard
val securityGroupId: Output<String>? = null

The ID of the security group.

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Link copied to clipboard
val toPort: Output<Int>? = null

The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.