aws.ec2.SecurityGroup
Explore with Pulumi AI
Provides a security group resource.
NOTE: Avoid using the
ingress
andegress
arguments of theaws.ec2.SecurityGroup
resource to configure in-line rules, as they struggle 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 theaws.vpc.SecurityGroupEgressRule
andaws.vpc.SecurityGroupIngressRule
resources with one CIDR block per rule.
!> WARNING: You should not use the aws.ec2.SecurityGroup
resource with in-line rules (using the ingress
and egress
arguments of aws.ec2.SecurityGroup
) in conjunction with the aws.vpc.SecurityGroupEgressRule
and aws.vpc.SecurityGroupIngressRule
resources or the aws.ec2.SecurityGroupRule
resource. Doing so may cause rule conflicts, perpetual differences, and result in rules being overwritten.
NOTE: Referencing Security Groups across VPC peering has certain restrictions. More information is available in the VPC Peering User Guide.
NOTE: Due to AWS Lambda improved VPC networking changes that began deploying in September 2019, security groups associated with Lambda Functions can take up to 45 minutes to successfully delete. To allow for successful deletion, the provider will wait for at least 45 minutes even if a shorter delete timeout is specified.
NOTE: The
cidr_blocks
andipv6_cidr_blocks
parameters are optional in theingress
andegress
blocks. If nothing is specified, traffic will be blocked as described in NOTE on Egress rules later.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const allowTls = new aws.ec2.SecurityGroup("allow_tls", {
name: "allow_tls",
description: "Allow TLS inbound traffic and all outbound traffic",
vpcId: main.id,
tags: {
Name: "allow_tls",
},
});
const allowTlsIpv4 = new aws.vpc.SecurityGroupIngressRule("allow_tls_ipv4", {
securityGroupId: allowTls.id,
cidrIpv4: main.cidrBlock,
fromPort: 443,
ipProtocol: "tcp",
toPort: 443,
});
const allowTlsIpv6 = new aws.vpc.SecurityGroupIngressRule("allow_tls_ipv6", {
securityGroupId: allowTls.id,
cidrIpv6: main.ipv6CidrBlock,
fromPort: 443,
ipProtocol: "tcp",
toPort: 443,
});
const allowAllTrafficIpv4 = new aws.vpc.SecurityGroupEgressRule("allow_all_traffic_ipv4", {
securityGroupId: allowTls.id,
cidrIpv4: "0.0.0.0/0",
ipProtocol: "-1",
});
const allowAllTrafficIpv6 = new aws.vpc.SecurityGroupEgressRule("allow_all_traffic_ipv6", {
securityGroupId: allowTls.id,
cidrIpv6: "::/0",
ipProtocol: "-1",
});
import pulumi
import pulumi_aws as aws
allow_tls = aws.ec2.SecurityGroup("allow_tls",
name="allow_tls",
description="Allow TLS inbound traffic and all outbound traffic",
vpc_id=main["id"],
tags={
"Name": "allow_tls",
})
allow_tls_ipv4 = aws.vpc.SecurityGroupIngressRule("allow_tls_ipv4",
security_group_id=allow_tls.id,
cidr_ipv4=main["cidrBlock"],
from_port=443,
ip_protocol="tcp",
to_port=443)
allow_tls_ipv6 = aws.vpc.SecurityGroupIngressRule("allow_tls_ipv6",
security_group_id=allow_tls.id,
cidr_ipv6=main["ipv6CidrBlock"],
from_port=443,
ip_protocol="tcp",
to_port=443)
allow_all_traffic_ipv4 = aws.vpc.SecurityGroupEgressRule("allow_all_traffic_ipv4",
security_group_id=allow_tls.id,
cidr_ipv4="0.0.0.0/0",
ip_protocol="-1")
allow_all_traffic_ipv6 = aws.vpc.SecurityGroupEgressRule("allow_all_traffic_ipv6",
security_group_id=allow_tls.id,
cidr_ipv6="::/0",
ip_protocol="-1")
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 {
allowTls, err := ec2.NewSecurityGroup(ctx, "allow_tls", &ec2.SecurityGroupArgs{
Name: pulumi.String("allow_tls"),
Description: pulumi.String("Allow TLS inbound traffic and all outbound traffic"),
VpcId: pulumi.Any(main.Id),
Tags: pulumi.StringMap{
"Name": pulumi.String("allow_tls"),
},
})
if err != nil {
return err
}
_, err = vpc.NewSecurityGroupIngressRule(ctx, "allow_tls_ipv4", &vpc.SecurityGroupIngressRuleArgs{
SecurityGroupId: allowTls.ID(),
CidrIpv4: pulumi.Any(main.CidrBlock),
FromPort: pulumi.Int(443),
IpProtocol: pulumi.String("tcp"),
ToPort: pulumi.Int(443),
})
if err != nil {
return err
}
_, err = vpc.NewSecurityGroupIngressRule(ctx, "allow_tls_ipv6", &vpc.SecurityGroupIngressRuleArgs{
SecurityGroupId: allowTls.ID(),
CidrIpv6: pulumi.Any(main.Ipv6CidrBlock),
FromPort: pulumi.Int(443),
IpProtocol: pulumi.String("tcp"),
ToPort: pulumi.Int(443),
})
if err != nil {
return err
}
_, err = vpc.NewSecurityGroupEgressRule(ctx, "allow_all_traffic_ipv4", &vpc.SecurityGroupEgressRuleArgs{
SecurityGroupId: allowTls.ID(),
CidrIpv4: pulumi.String("0.0.0.0/0"),
IpProtocol: pulumi.String("-1"),
})
if err != nil {
return err
}
_, err = vpc.NewSecurityGroupEgressRule(ctx, "allow_all_traffic_ipv6", &vpc.SecurityGroupEgressRuleArgs{
SecurityGroupId: allowTls.ID(),
CidrIpv6: pulumi.String("::/0"),
IpProtocol: pulumi.String("-1"),
})
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 allowTls = new Aws.Ec2.SecurityGroup("allow_tls", new()
{
Name = "allow_tls",
Description = "Allow TLS inbound traffic and all outbound traffic",
VpcId = main.Id,
Tags =
{
{ "Name", "allow_tls" },
},
});
var allowTlsIpv4 = new Aws.Vpc.SecurityGroupIngressRule("allow_tls_ipv4", new()
{
SecurityGroupId = allowTls.Id,
CidrIpv4 = main.CidrBlock,
FromPort = 443,
IpProtocol = "tcp",
ToPort = 443,
});
var allowTlsIpv6 = new Aws.Vpc.SecurityGroupIngressRule("allow_tls_ipv6", new()
{
SecurityGroupId = allowTls.Id,
CidrIpv6 = main.Ipv6CidrBlock,
FromPort = 443,
IpProtocol = "tcp",
ToPort = 443,
});
var allowAllTrafficIpv4 = new Aws.Vpc.SecurityGroupEgressRule("allow_all_traffic_ipv4", new()
{
SecurityGroupId = allowTls.Id,
CidrIpv4 = "0.0.0.0/0",
IpProtocol = "-1",
});
var allowAllTrafficIpv6 = new Aws.Vpc.SecurityGroupEgressRule("allow_all_traffic_ipv6", new()
{
SecurityGroupId = allowTls.Id,
CidrIpv6 = "::/0",
IpProtocol = "-1",
});
});
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 com.pulumi.aws.vpc.SecurityGroupEgressRule;
import com.pulumi.aws.vpc.SecurityGroupEgressRuleArgs;
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 allowTls = new SecurityGroup("allowTls", SecurityGroupArgs.builder()
.name("allow_tls")
.description("Allow TLS inbound traffic and all outbound traffic")
.vpcId(main.id())
.tags(Map.of("Name", "allow_tls"))
.build());
var allowTlsIpv4 = new SecurityGroupIngressRule("allowTlsIpv4", SecurityGroupIngressRuleArgs.builder()
.securityGroupId(allowTls.id())
.cidrIpv4(main.cidrBlock())
.fromPort(443)
.ipProtocol("tcp")
.toPort(443)
.build());
var allowTlsIpv6 = new SecurityGroupIngressRule("allowTlsIpv6", SecurityGroupIngressRuleArgs.builder()
.securityGroupId(allowTls.id())
.cidrIpv6(main.ipv6CidrBlock())
.fromPort(443)
.ipProtocol("tcp")
.toPort(443)
.build());
var allowAllTrafficIpv4 = new SecurityGroupEgressRule("allowAllTrafficIpv4", SecurityGroupEgressRuleArgs.builder()
.securityGroupId(allowTls.id())
.cidrIpv4("0.0.0.0/0")
.ipProtocol("-1")
.build());
var allowAllTrafficIpv6 = new SecurityGroupEgressRule("allowAllTrafficIpv6", SecurityGroupEgressRuleArgs.builder()
.securityGroupId(allowTls.id())
.cidrIpv6("::/0")
.ipProtocol("-1")
.build());
}
}
resources:
allowTls:
type: aws:ec2:SecurityGroup
name: allow_tls
properties:
name: allow_tls
description: Allow TLS inbound traffic and all outbound traffic
vpcId: ${main.id}
tags:
Name: allow_tls
allowTlsIpv4:
type: aws:vpc:SecurityGroupIngressRule
name: allow_tls_ipv4
properties:
securityGroupId: ${allowTls.id}
cidrIpv4: ${main.cidrBlock}
fromPort: 443
ipProtocol: tcp
toPort: 443
allowTlsIpv6:
type: aws:vpc:SecurityGroupIngressRule
name: allow_tls_ipv6
properties:
securityGroupId: ${allowTls.id}
cidrIpv6: ${main.ipv6CidrBlock}
fromPort: 443
ipProtocol: tcp
toPort: 443
allowAllTrafficIpv4:
type: aws:vpc:SecurityGroupEgressRule
name: allow_all_traffic_ipv4
properties:
securityGroupId: ${allowTls.id}
cidrIpv4: 0.0.0.0/0
ipProtocol: '-1'
allowAllTrafficIpv6:
type: aws:vpc:SecurityGroupEgressRule
name: allow_all_traffic_ipv6
properties:
securityGroupId: ${allowTls.id}
cidrIpv6: ::/0
ipProtocol: '-1'
NOTE on Egress rules: By default, AWS creates an
ALLOW ALL
egress rule when creating a new Security Group inside of a VPC. When creating a new Security Group inside a VPC, this provider will remove this default rule, and require you specifically re-create it if you desire that rule. We feel this leads to fewer surprises in terms of controlling your egress rules. If you desire this rule to be in place, you can use thisegress
block:
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.ec2.SecurityGroup("example", {egress: [{
fromPort: 0,
toPort: 0,
protocol: "-1",
cidrBlocks: ["0.0.0.0/0"],
ipv6CidrBlocks: ["::/0"],
}]});
import pulumi
import pulumi_aws as aws
example = aws.ec2.SecurityGroup("example", egress=[{
"from_port": 0,
"to_port": 0,
"protocol": "-1",
"cidr_blocks": ["0.0.0.0/0"],
"ipv6_cidr_blocks": ["::/0"],
}])
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := ec2.NewSecurityGroup(ctx, "example", &ec2.SecurityGroupArgs{
Egress: ec2.SecurityGroupEgressArray{
&ec2.SecurityGroupEgressArgs{
FromPort: pulumi.Int(0),
ToPort: pulumi.Int(0),
Protocol: pulumi.String("-1"),
CidrBlocks: pulumi.StringArray{
pulumi.String("0.0.0.0/0"),
},
Ipv6CidrBlocks: pulumi.StringArray{
pulumi.String("::/0"),
},
},
},
})
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 = new Aws.Ec2.SecurityGroup("example", new()
{
Egress = new[]
{
new Aws.Ec2.Inputs.SecurityGroupEgressArgs
{
FromPort = 0,
ToPort = 0,
Protocol = "-1",
CidrBlocks = new[]
{
"0.0.0.0/0",
},
Ipv6CidrBlocks = new[]
{
"::/0",
},
},
},
});
});
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.ec2.inputs.SecurityGroupEgressArgs;
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()
.egress(SecurityGroupEgressArgs.builder()
.fromPort(0)
.toPort(0)
.protocol("-1")
.cidrBlocks("0.0.0.0/0")
.ipv6CidrBlocks("::/0")
.build())
.build());
}
}
resources:
example:
type: aws:ec2:SecurityGroup
properties:
egress:
- fromPort: 0
toPort: 0
protocol: '-1'
cidrBlocks:
- 0.0.0.0/0
ipv6CidrBlocks:
- ::/0
Usage With Prefix List IDs
Prefix Lists are either managed by AWS internally, or created by the customer using a 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:
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const myEndpoint = new aws.ec2.VpcEndpoint("my_endpoint", {});
const example = new aws.ec2.SecurityGroup("example", {egress: [{
fromPort: 0,
toPort: 0,
protocol: "-1",
prefixListIds: [myEndpoint.prefixListId],
}]});
import pulumi
import pulumi_aws as aws
my_endpoint = aws.ec2.VpcEndpoint("my_endpoint")
example = aws.ec2.SecurityGroup("example", egress=[{
"from_port": 0,
"to_port": 0,
"protocol": "-1",
"prefix_list_ids": [my_endpoint.prefix_list_id],
}])
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
myEndpoint, err := ec2.NewVpcEndpoint(ctx, "my_endpoint", nil)
if err != nil {
return err
}
_, err = ec2.NewSecurityGroup(ctx, "example", &ec2.SecurityGroupArgs{
Egress: ec2.SecurityGroupEgressArray{
&ec2.SecurityGroupEgressArgs{
FromPort: pulumi.Int(0),
ToPort: pulumi.Int(0),
Protocol: pulumi.String("-1"),
PrefixListIds: pulumi.StringArray{
myEndpoint.PrefixListId,
},
},
},
})
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 myEndpoint = new Aws.Ec2.VpcEndpoint("my_endpoint");
var example = new Aws.Ec2.SecurityGroup("example", new()
{
Egress = new[]
{
new Aws.Ec2.Inputs.SecurityGroupEgressArgs
{
FromPort = 0,
ToPort = 0,
Protocol = "-1",
PrefixListIds = new[]
{
myEndpoint.PrefixListId,
},
},
},
});
});
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.SecurityGroup;
import com.pulumi.aws.ec2.SecurityGroupArgs;
import com.pulumi.aws.ec2.inputs.SecurityGroupEgressArgs;
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 example = new SecurityGroup("example", SecurityGroupArgs.builder()
.egress(SecurityGroupEgressArgs.builder()
.fromPort(0)
.toPort(0)
.protocol("-1")
.prefixListIds(myEndpoint.prefixListId())
.build())
.build());
}
}
resources:
example:
type: aws:ec2:SecurityGroup
properties:
egress:
- fromPort: 0
toPort: 0
protocol: '-1'
prefixListIds:
- ${myEndpoint.prefixListId}
myEndpoint:
type: aws:ec2:VpcEndpoint
name: my_endpoint
You can also find a specific Prefix List using the aws.ec2.getPrefixList
data source.
Removing All Ingress and Egress Rules
The ingress
and egress
arguments are processed in attributes-as-blocks mode. Due to this, removing these arguments from the configuration will not cause the provider to destroy the managed rules. To subsequently remove all managed ingress and egress rules:
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.ec2.SecurityGroup("example", {
name: "sg",
vpcId: exampleAwsVpc.id,
ingress: [],
egress: [],
});
import pulumi
import pulumi_aws as aws
example = aws.ec2.SecurityGroup("example",
name="sg",
vpc_id=example_aws_vpc["id"],
ingress=[],
egress=[])
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := ec2.NewSecurityGroup(ctx, "example", &ec2.SecurityGroupArgs{
Name: pulumi.String("sg"),
VpcId: pulumi.Any(exampleAwsVpc.Id),
Ingress: ec2.SecurityGroupIngressArray{},
Egress: ec2.SecurityGroupEgressArray{},
})
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 = new Aws.Ec2.SecurityGroup("example", new()
{
Name = "sg",
VpcId = exampleAwsVpc.Id,
Ingress = new[] {},
Egress = new[] {},
});
});
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 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("sg")
.vpcId(exampleAwsVpc.id())
.ingress()
.egress()
.build());
}
}
resources:
example:
type: aws:ec2:SecurityGroup
properties:
name: sg
vpcId: ${exampleAwsVpc.id}
ingress: []
egress: []
Recreating a Security Group
A simple security group name
change “forces new” the security group–the provider destroys the security group and creates a new one. (Likewise, description
, name_prefix
, or vpc_id
cannot be changed.) Attempting to recreate the security group leads to a variety of complications depending on how it is used.
Security groups are generally associated with other resources–more than 100 AWS Provider resources reference security groups. Referencing a resource from another resource creates a one-way dependency. For example, if you create an EC2 aws.ec2.Instance
that has a vpc_security_group_ids
argument that refers to an aws.ec2.SecurityGroup
resource, the aws.ec2.SecurityGroup
is a dependent of the aws.ec2.Instance
. Because of this, the provider will create the security group first so that it can then be associated with the EC2 instance.
However, the dependency relationship actually goes both directions causing the Security Group Deletion Problem. AWS does not allow you to delete the security group associated with another resource (e.g., the aws.ec2.Instance
).
The provider does not model bi-directional dependencies like this, but, even if it did, simply knowing the dependency situation would not be enough to solve it. For example, some resources must always have an associated security group while others don’t need to. In addition, when the aws.ec2.SecurityGroup
resource attempts to recreate, it receives a dependent object error, which does not provide information on whether the dependent object is a security group rule or, for example, an associated EC2 instance. Within the provider, the associated resource (e.g., aws.ec2.Instance
) does not receive an error when the aws.ec2.SecurityGroup
is trying to recreate even though that is where changes to the associated resource would need to take place (e.g., removing the security group association).
Despite these sticky problems, below are some ways to improve your experience when you find it necessary to recreate a security group.
Shorter timeout
(This example is one approach to recreating security groups. For more information on the challenges and the Security Group Deletion Problem, see the section above.)
If destroying a security group takes a long time, it may be because the provider cannot distinguish between a dependent object (e.g., a security group rule or EC2 instance) that is in the process of being deleted and one that is not. In other words, it may be waiting for a train that isn’t scheduled to arrive. To fail faster, shorten the delete
timeout from the default timeout:
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.ec2.SecurityGroup("example", {name: "izizavle"});
import pulumi
import pulumi_aws as aws
example = aws.ec2.SecurityGroup("example", name="izizavle")
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := ec2.NewSecurityGroup(ctx, "example", &ec2.SecurityGroupArgs{
Name: pulumi.String("izizavle"),
})
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 = new Aws.Ec2.SecurityGroup("example", new()
{
Name = "izizavle",
});
});
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 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("izizavle")
.build());
}
}
resources:
example:
type: aws:ec2:SecurityGroup
properties:
name: izizavle
Provisioners
(This example is one approach to recreating security groups. For more information on the challenges and the Security Group Deletion Problem, see the section above.)
DISCLAIMER: We HIGHLY recommend using one of the above approaches and NOT using local provisioners. Provisioners, like the one shown below, should be considered a last resort since they are not readable, require skills outside standard configuration, are error prone and difficult to maintain, are not compatible with cloud environments and upgrade tools, require AWS CLI installation, and are subject to changes outside the AWS Provider.
import * as pulumi from "@pulumi/pulumi";
import * as _null from "@pulumi/null";
import * as aws from "@pulumi/aws";
import * as command from "@pulumi/command";
import * as std from "@pulumi/std";
const default = aws.ec2.getSecurityGroup({
name: "default",
});
const example = new aws.ec2.SecurityGroup("example", {
name: "sg",
tags: {
workaround1: "tagged-name",
workaround2: _default.then(_default => _default.id),
},
});
const exampleProvisioner0 = new command.local.Command("exampleProvisioner0", {
create: "true",
update: "true",
"delete": ` ENDPOINT_ID=`aws ec2 describe-vpc-endpoints --filters "Name=tag:Name,Values=${tags.workaround1}" --query "VpcEndpoints[0].VpcEndpointId" --output text` &&
aws ec2 modify-vpc-endpoint --vpc-endpoint-id ${ENDPOINT_ID} --add-security-group-ids ${tags.workaround2} --remove-security-group-ids ${id}
`,
}, {
dependsOn: [example],
});
const exampleResource = new _null.Resource("example", {triggers: {
rerun_upon_change_of: std.join({
separator: ",",
input: exampleAwsVpcEndpoint.securityGroupIds,
}).then(invoke => invoke.result),
}});
const exampleResourceProvisioner0 = new command.local.Command("exampleResourceProvisioner0", {create: ` aws ec2 modify-vpc-endpoint --vpc-endpoint-id ${exampleAwsVpcEndpoint.id} --remove-security-group-ids ${_default.id}
`}, {
dependsOn: [exampleResource],
});
import pulumi
import pulumi_aws as aws
import pulumi_command as command
import pulumi_null as null
import pulumi_std as std
default = aws.ec2.get_security_group(name="default")
example = aws.ec2.SecurityGroup("example",
name="sg",
tags={
"workaround1": "tagged-name",
"workaround2": default.id,
})
example_provisioner0 = command.local.Command("exampleProvisioner0",
create=true,
update=true,
delete=f ENDPOINT_ID=`aws ec2 describe-vpc-endpoints --filters "Name=tag:Name,Values={tags.workaround1}" --query "VpcEndpoints[0].VpcEndpointId" --output text` &&
aws ec2 modify-vpc-endpoint --vpc-endpoint-id ${{ENDPOINT_ID}} --add-security-group-ids {tags.workaround2} --remove-security-group-ids {id}
,
opts = pulumi.ResourceOptions(depends_on=[example]))
example_resource = null.Resource("example", triggers={
"rerun_upon_change_of": std.join(separator=",",
input=example_aws_vpc_endpoint["securityGroupIds"]).result,
})
example_resource_provisioner0 = command.local.Command("exampleResourceProvisioner0", create=f aws ec2 modify-vpc-endpoint --vpc-endpoint-id {example_aws_vpc_endpoint.id} --remove-security-group-ids {default.id}
,
opts = pulumi.ResourceOptions(depends_on=[example_resource]))
package main
import (
"fmt"
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2"
"github.com/pulumi/pulumi-command/sdk/go/command/local"
"github.com/pulumi/pulumi-null/sdk/go/null"
"github.com/pulumi/pulumi-std/sdk/go/std"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_default, err := ec2.LookupSecurityGroup(ctx, &ec2.LookupSecurityGroupArgs{
Name: pulumi.StringRef("default"),
}, nil)
if err != nil {
return err
}
example, err := ec2.NewSecurityGroup(ctx, "example", &ec2.SecurityGroupArgs{
Name: pulumi.String("sg"),
Tags: pulumi.StringMap{
"workaround1": pulumi.String("tagged-name"),
"workaround2": pulumi.String(_default.Id),
},
})
if err != nil {
return err
}
_, err = local.NewCommand(ctx, "exampleProvisioner0", &local.CommandArgs{
Create: "true",
Update: "true",
Delete: fmt.Sprintf(" ENDPOINT_ID=`aws ec2 describe-vpc-endpoints --filters \"Name=tag:Name,Values=%v\" --query \"VpcEndpoints[0].VpcEndpointId\" --output text` &&\n aws ec2 modify-vpc-endpoint --vpc-endpoint-id ${ENDPOINT_ID} --add-security-group-ids %v --remove-security-group-ids %v\n", tags.Workaround1, tags.Workaround2, id),
}, pulumi.DependsOn([]pulumi.Resource{
example,
}))
if err != nil {
return err
}
invokeJoin, err := std.Join(ctx, &std.JoinArgs{
Separator: ",",
Input: exampleAwsVpcEndpoint.SecurityGroupIds,
}, nil)
if err != nil {
return err
}
exampleResource, err := null.NewResource(ctx, "example", &null.ResourceArgs{
Triggers: pulumi.StringMap{
"rerun_upon_change_of": pulumi.String(invokeJoin.Result),
},
})
if err != nil {
return err
}
_, err = local.NewCommand(ctx, "exampleResourceProvisioner0", &local.CommandArgs{
Create: fmt.Sprintf(" aws ec2 modify-vpc-endpoint --vpc-endpoint-id %v --remove-security-group-ids %v\n", exampleAwsVpcEndpoint.Id, _default.Id),
}, pulumi.DependsOn([]pulumi.Resource{
exampleResource,
}))
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
using Command = Pulumi.Command;
using Null = Pulumi.Null;
using Std = Pulumi.Std;
return await Deployment.RunAsync(() =>
{
var @default = Aws.Ec2.GetSecurityGroup.Invoke(new()
{
Name = "default",
});
var example = new Aws.Ec2.SecurityGroup("example", new()
{
Name = "sg",
Tags =
{
{ "workaround1", "tagged-name" },
{ "workaround2", @default.Apply(@default => @default.Apply(getSecurityGroupResult => getSecurityGroupResult.Id)) },
},
});
var exampleProvisioner0 = new Command.Local.Command("exampleProvisioner0", new()
{
Create = "true",
Update = "true",
Delete = @$" ENDPOINT_ID=`aws ec2 describe-vpc-endpoints --filters ""Name=tag:Name,Values={tags.Workaround1}"" --query ""VpcEndpoints[0].VpcEndpointId"" --output text` &&
aws ec2 modify-vpc-endpoint --vpc-endpoint-id ${{ENDPOINT_ID}} --add-security-group-ids {tags.Workaround2} --remove-security-group-ids {id}
",
}, new CustomResourceOptions
{
DependsOn =
{
example,
},
});
var exampleResource = new Null.Resource("example", new()
{
Triggers =
{
{ "rerun_upon_change_of", Std.Join.Invoke(new()
{
Separator = ",",
Input = exampleAwsVpcEndpoint.SecurityGroupIds,
}).Apply(invoke => invoke.Result) },
},
});
var exampleResourceProvisioner0 = new Command.Local.Command("exampleResourceProvisioner0", new()
{
Create = @$" aws ec2 modify-vpc-endpoint --vpc-endpoint-id {exampleAwsVpcEndpoint.Id} --remove-security-group-ids {@default.Apply(getSecurityGroupResult => getSecurityGroupResult.Id)}
",
}, new CustomResourceOptions
{
DependsOn =
{
exampleResource,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.Ec2Functions;
import com.pulumi.aws.ec2.inputs.GetSecurityGroupArgs;
import com.pulumi.aws.ec2.SecurityGroup;
import com.pulumi.aws.ec2.SecurityGroupArgs;
import com.pulumi.command.local.Command;
import com.pulumi.command.local.CommandArgs;
import com.pulumi.null.Resource;
import com.pulumi.null.ResourceArgs;
import com.pulumi.resources.CustomResourceOptions;
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 default = Ec2Functions.getSecurityGroup(GetSecurityGroupArgs.builder()
.name("default")
.build());
var example = new SecurityGroup("example", SecurityGroupArgs.builder()
.name("sg")
.tags(Map.ofEntries(
Map.entry("workaround1", "tagged-name"),
Map.entry("workaround2", default_.id())
))
.build());
var exampleProvisioner0 = new Command("exampleProvisioner0", CommandArgs.builder()
.create("true")
.update("true")
.delete("""
ENDPOINT_ID=`aws ec2 describe-vpc-endpoints --filters "Name=tag:Name,Values=%s" --query "VpcEndpoints[0].VpcEndpointId" --output text` &&
aws ec2 modify-vpc-endpoint --vpc-endpoint-id ${ENDPOINT_ID} --add-security-group-ids %s --remove-security-group-ids %s
", tags.workaround1(),tags.workaround2(),id))
.build(), CustomResourceOptions.builder()
.dependsOn(example)
.build());
var exampleResource = new Resource("exampleResource", ResourceArgs.builder()
.triggers(Map.of("rerun_upon_change_of", StdFunctions.join(JoinArgs.builder()
.separator(",")
.input(exampleAwsVpcEndpoint.securityGroupIds())
.build()).result()))
.build());
var exampleResourceProvisioner0 = new Command("exampleResourceProvisioner0", CommandArgs.builder()
.create("""
aws ec2 modify-vpc-endpoint --vpc-endpoint-id %s --remove-security-group-ids %s
", exampleAwsVpcEndpoint.id(),default_.id()))
.build(), CustomResourceOptions.builder()
.dependsOn(exampleResource)
.build());
}
}
resources:
example:
type: aws:ec2:SecurityGroup
properties:
name: sg
tags:
workaround1: tagged-name
workaround2: ${default.id}
exampleProvisioner0:
type: command:local:Command
properties:
create: 'true'
update: 'true'
delete: |2
ENDPOINT_ID=`aws ec2 describe-vpc-endpoints --filters "Name=tag:Name,Values=${tags.workaround1}" --query "VpcEndpoints[0].VpcEndpointId" --output text` &&
aws ec2 modify-vpc-endpoint --vpc-endpoint-id ${ENDPOINT_ID} --add-security-group-ids ${tags.workaround2} --remove-security-group-ids ${id}
options:
dependson:
- ${example}
exampleResource:
type: null:Resource
name: example
properties:
triggers:
rerun_upon_change_of:
fn::invoke:
Function: std:join
Arguments:
separator: ','
input: ${exampleAwsVpcEndpoint.securityGroupIds}
Return: result
exampleResourceProvisioner0:
type: command:local:Command
properties:
create: |2
aws ec2 modify-vpc-endpoint --vpc-endpoint-id ${exampleAwsVpcEndpoint.id} --remove-security-group-ids ${default.id}
options:
dependson:
- ${exampleResource}
variables:
default:
fn::invoke:
Function: aws:ec2:getSecurityGroup
Arguments:
name: default
Create SecurityGroup Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new SecurityGroup(name: string, args?: SecurityGroupArgs, opts?: CustomResourceOptions);
@overload
def SecurityGroup(resource_name: str,
args: Optional[SecurityGroupArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def SecurityGroup(resource_name: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
egress: Optional[Sequence[SecurityGroupEgressArgs]] = None,
ingress: Optional[Sequence[SecurityGroupIngressArgs]] = None,
name: Optional[str] = None,
name_prefix: Optional[str] = None,
revoke_rules_on_delete: Optional[bool] = None,
tags: Optional[Mapping[str, str]] = None,
vpc_id: Optional[str] = None)
func NewSecurityGroup(ctx *Context, name string, args *SecurityGroupArgs, opts ...ResourceOption) (*SecurityGroup, error)
public SecurityGroup(string name, SecurityGroupArgs? args = null, CustomResourceOptions? opts = null)
public SecurityGroup(String name, SecurityGroupArgs args)
public SecurityGroup(String name, SecurityGroupArgs args, CustomResourceOptions options)
type: aws:ec2:SecurityGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args SecurityGroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args SecurityGroupArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args SecurityGroupArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SecurityGroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SecurityGroupArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var securityGroupResource = new Aws.Ec2.SecurityGroup("securityGroupResource", new()
{
Description = "string",
Egress = new[]
{
new Aws.Ec2.Inputs.SecurityGroupEgressArgs
{
FromPort = 0,
Protocol = "string",
ToPort = 0,
CidrBlocks = new[]
{
"string",
},
Description = "string",
Ipv6CidrBlocks = new[]
{
"string",
},
PrefixListIds = new[]
{
"string",
},
SecurityGroups = new[]
{
"string",
},
Self = false,
},
},
Ingress = new[]
{
new Aws.Ec2.Inputs.SecurityGroupIngressArgs
{
FromPort = 0,
Protocol = "string",
ToPort = 0,
CidrBlocks = new[]
{
"string",
},
Description = "string",
Ipv6CidrBlocks = new[]
{
"string",
},
PrefixListIds = new[]
{
"string",
},
SecurityGroups = new[]
{
"string",
},
Self = false,
},
},
Name = "string",
NamePrefix = "string",
RevokeRulesOnDelete = false,
Tags =
{
{ "string", "string" },
},
VpcId = "string",
});
example, err := ec2.NewSecurityGroup(ctx, "securityGroupResource", &ec2.SecurityGroupArgs{
Description: pulumi.String("string"),
Egress: ec2.SecurityGroupEgressArray{
&ec2.SecurityGroupEgressArgs{
FromPort: pulumi.Int(0),
Protocol: pulumi.String("string"),
ToPort: pulumi.Int(0),
CidrBlocks: pulumi.StringArray{
pulumi.String("string"),
},
Description: pulumi.String("string"),
Ipv6CidrBlocks: pulumi.StringArray{
pulumi.String("string"),
},
PrefixListIds: pulumi.StringArray{
pulumi.String("string"),
},
SecurityGroups: pulumi.StringArray{
pulumi.String("string"),
},
Self: pulumi.Bool(false),
},
},
Ingress: ec2.SecurityGroupIngressArray{
&ec2.SecurityGroupIngressArgs{
FromPort: pulumi.Int(0),
Protocol: pulumi.String("string"),
ToPort: pulumi.Int(0),
CidrBlocks: pulumi.StringArray{
pulumi.String("string"),
},
Description: pulumi.String("string"),
Ipv6CidrBlocks: pulumi.StringArray{
pulumi.String("string"),
},
PrefixListIds: pulumi.StringArray{
pulumi.String("string"),
},
SecurityGroups: pulumi.StringArray{
pulumi.String("string"),
},
Self: pulumi.Bool(false),
},
},
Name: pulumi.String("string"),
NamePrefix: pulumi.String("string"),
RevokeRulesOnDelete: pulumi.Bool(false),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
VpcId: pulumi.String("string"),
})
var securityGroupResource = new SecurityGroup("securityGroupResource", SecurityGroupArgs.builder()
.description("string")
.egress(SecurityGroupEgressArgs.builder()
.fromPort(0)
.protocol("string")
.toPort(0)
.cidrBlocks("string")
.description("string")
.ipv6CidrBlocks("string")
.prefixListIds("string")
.securityGroups("string")
.self(false)
.build())
.ingress(SecurityGroupIngressArgs.builder()
.fromPort(0)
.protocol("string")
.toPort(0)
.cidrBlocks("string")
.description("string")
.ipv6CidrBlocks("string")
.prefixListIds("string")
.securityGroups("string")
.self(false)
.build())
.name("string")
.namePrefix("string")
.revokeRulesOnDelete(false)
.tags(Map.of("string", "string"))
.vpcId("string")
.build());
security_group_resource = aws.ec2.SecurityGroup("securityGroupResource",
description="string",
egress=[{
"from_port": 0,
"protocol": "string",
"to_port": 0,
"cidr_blocks": ["string"],
"description": "string",
"ipv6_cidr_blocks": ["string"],
"prefix_list_ids": ["string"],
"security_groups": ["string"],
"self": False,
}],
ingress=[{
"from_port": 0,
"protocol": "string",
"to_port": 0,
"cidr_blocks": ["string"],
"description": "string",
"ipv6_cidr_blocks": ["string"],
"prefix_list_ids": ["string"],
"security_groups": ["string"],
"self": False,
}],
name="string",
name_prefix="string",
revoke_rules_on_delete=False,
tags={
"string": "string",
},
vpc_id="string")
const securityGroupResource = new aws.ec2.SecurityGroup("securityGroupResource", {
description: "string",
egress: [{
fromPort: 0,
protocol: "string",
toPort: 0,
cidrBlocks: ["string"],
description: "string",
ipv6CidrBlocks: ["string"],
prefixListIds: ["string"],
securityGroups: ["string"],
self: false,
}],
ingress: [{
fromPort: 0,
protocol: "string",
toPort: 0,
cidrBlocks: ["string"],
description: "string",
ipv6CidrBlocks: ["string"],
prefixListIds: ["string"],
securityGroups: ["string"],
self: false,
}],
name: "string",
namePrefix: "string",
revokeRulesOnDelete: false,
tags: {
string: "string",
},
vpcId: "string",
});
type: aws:ec2:SecurityGroup
properties:
description: string
egress:
- cidrBlocks:
- string
description: string
fromPort: 0
ipv6CidrBlocks:
- string
prefixListIds:
- string
protocol: string
securityGroups:
- string
self: false
toPort: 0
ingress:
- cidrBlocks:
- string
description: string
fromPort: 0
ipv6CidrBlocks:
- string
prefixListIds:
- string
protocol: string
securityGroups:
- string
self: false
toPort: 0
name: string
namePrefix: string
revokeRulesOnDelete: false
tags:
string: string
vpcId: string
SecurityGroup Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The SecurityGroup resource accepts the following input properties:
- Description string
- Security group description. Defaults to
Managed by Pulumi
. Cannot be""
. NOTE: This field maps to the AWSGroupDescription
attribute, for which there is no Update API. If you'd like to classify your security groups in a way that can be updated, usetags
. - Egress
List<Security
Group Egress> - Configuration block for egress rules. Can be specified multiple times for each egress rule. Each egress block supports fields documented below. This argument is processed in attribute-as-blocks mode.
- Ingress
List<Security
Group Ingress> - Configuration block for ingress rules. Can be specified multiple times for each ingress rule. Each ingress block supports fields documented below. This argument is processed in attribute-as-blocks mode.
- Name string
- Name of the security group. If omitted, the provider will assign a random, unique name.
- Name
Prefix string - Creates a unique name beginning with the specified prefix. Conflicts with
name
. - Revoke
Rules boolOn Delete - Instruct the provider to revoke all of the Security Groups attached ingress and egress rules before deleting the rule itself. This is normally not needed, however certain AWS services such as Elastic Map Reduce may automatically add required rules to security groups used with the service, and those rules may contain a cyclic dependency that prevent the security groups from being destroyed without removing the dependency first. Default
false
. - Dictionary<string, string>
- 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. - Vpc
Id string - VPC ID. Defaults to the region's default VPC.
- Description string
- Security group description. Defaults to
Managed by Pulumi
. Cannot be""
. NOTE: This field maps to the AWSGroupDescription
attribute, for which there is no Update API. If you'd like to classify your security groups in a way that can be updated, usetags
. - Egress
[]Security
Group Egress Args - Configuration block for egress rules. Can be specified multiple times for each egress rule. Each egress block supports fields documented below. This argument is processed in attribute-as-blocks mode.
- Ingress
[]Security
Group Ingress Args - Configuration block for ingress rules. Can be specified multiple times for each ingress rule. Each ingress block supports fields documented below. This argument is processed in attribute-as-blocks mode.
- Name string
- Name of the security group. If omitted, the provider will assign a random, unique name.
- Name
Prefix string - Creates a unique name beginning with the specified prefix. Conflicts with
name
. - Revoke
Rules boolOn Delete - Instruct the provider to revoke all of the Security Groups attached ingress and egress rules before deleting the rule itself. This is normally not needed, however certain AWS services such as Elastic Map Reduce may automatically add required rules to security groups used with the service, and those rules may contain a cyclic dependency that prevent the security groups from being destroyed without removing the dependency first. Default
false
. - map[string]string
- 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. - Vpc
Id string - VPC ID. Defaults to the region's default VPC.
- description String
- Security group description. Defaults to
Managed by Pulumi
. Cannot be""
. NOTE: This field maps to the AWSGroupDescription
attribute, for which there is no Update API. If you'd like to classify your security groups in a way that can be updated, usetags
. - egress
List<Security
Group Egress> - Configuration block for egress rules. Can be specified multiple times for each egress rule. Each egress block supports fields documented below. This argument is processed in attribute-as-blocks mode.
- ingress
List<Security
Group Ingress> - Configuration block for ingress rules. Can be specified multiple times for each ingress rule. Each ingress block supports fields documented below. This argument is processed in attribute-as-blocks mode.
- name String
- Name of the security group. If omitted, the provider will assign a random, unique name.
- name
Prefix String - Creates a unique name beginning with the specified prefix. Conflicts with
name
. - revoke
Rules BooleanOn Delete - Instruct the provider to revoke all of the Security Groups attached ingress and egress rules before deleting the rule itself. This is normally not needed, however certain AWS services such as Elastic Map Reduce may automatically add required rules to security groups used with the service, and those rules may contain a cyclic dependency that prevent the security groups from being destroyed without removing the dependency first. Default
false
. - Map<String,String>
- 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. - vpc
Id String - VPC ID. Defaults to the region's default VPC.
- description string
- Security group description. Defaults to
Managed by Pulumi
. Cannot be""
. NOTE: This field maps to the AWSGroupDescription
attribute, for which there is no Update API. If you'd like to classify your security groups in a way that can be updated, usetags
. - egress
Security
Group Egress[] - Configuration block for egress rules. Can be specified multiple times for each egress rule. Each egress block supports fields documented below. This argument is processed in attribute-as-blocks mode.
- ingress
Security
Group Ingress[] - Configuration block for ingress rules. Can be specified multiple times for each ingress rule. Each ingress block supports fields documented below. This argument is processed in attribute-as-blocks mode.
- name string
- Name of the security group. If omitted, the provider will assign a random, unique name.
- name
Prefix string - Creates a unique name beginning with the specified prefix. Conflicts with
name
. - revoke
Rules booleanOn Delete - Instruct the provider to revoke all of the Security Groups attached ingress and egress rules before deleting the rule itself. This is normally not needed, however certain AWS services such as Elastic Map Reduce may automatically add required rules to security groups used with the service, and those rules may contain a cyclic dependency that prevent the security groups from being destroyed without removing the dependency first. Default
false
. - {[key: string]: string}
- 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. - vpc
Id string - VPC ID. Defaults to the region's default VPC.
- description str
- Security group description. Defaults to
Managed by Pulumi
. Cannot be""
. NOTE: This field maps to the AWSGroupDescription
attribute, for which there is no Update API. If you'd like to classify your security groups in a way that can be updated, usetags
. - egress
Sequence[Security
Group Egress Args] - Configuration block for egress rules. Can be specified multiple times for each egress rule. Each egress block supports fields documented below. This argument is processed in attribute-as-blocks mode.
- ingress
Sequence[Security
Group Ingress Args] - Configuration block for ingress rules. Can be specified multiple times for each ingress rule. Each ingress block supports fields documented below. This argument is processed in attribute-as-blocks mode.
- name str
- Name of the security group. If omitted, the provider will assign a random, unique name.
- name_
prefix str - Creates a unique name beginning with the specified prefix. Conflicts with
name
. - revoke_
rules_ boolon_ delete - Instruct the provider to revoke all of the Security Groups attached ingress and egress rules before deleting the rule itself. This is normally not needed, however certain AWS services such as Elastic Map Reduce may automatically add required rules to security groups used with the service, and those rules may contain a cyclic dependency that prevent the security groups from being destroyed without removing the dependency first. Default
false
. - Mapping[str, str]
- 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. - vpc_
id str - VPC ID. Defaults to the region's default VPC.
- description String
- Security group description. Defaults to
Managed by Pulumi
. Cannot be""
. NOTE: This field maps to the AWSGroupDescription
attribute, for which there is no Update API. If you'd like to classify your security groups in a way that can be updated, usetags
. - egress List<Property Map>
- Configuration block for egress rules. Can be specified multiple times for each egress rule. Each egress block supports fields documented below. This argument is processed in attribute-as-blocks mode.
- ingress List<Property Map>
- Configuration block for ingress rules. Can be specified multiple times for each ingress rule. Each ingress block supports fields documented below. This argument is processed in attribute-as-blocks mode.
- name String
- Name of the security group. If omitted, the provider will assign a random, unique name.
- name
Prefix String - Creates a unique name beginning with the specified prefix. Conflicts with
name
. - revoke
Rules BooleanOn Delete - Instruct the provider to revoke all of the Security Groups attached ingress and egress rules before deleting the rule itself. This is normally not needed, however certain AWS services such as Elastic Map Reduce may automatically add required rules to security groups used with the service, and those rules may contain a cyclic dependency that prevent the security groups from being destroyed without removing the dependency first. Default
false
. - Map<String>
- 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. - vpc
Id String - VPC ID. Defaults to the region's default VPC.
Outputs
All input properties are implicitly available as output properties. Additionally, the SecurityGroup resource produces the following output properties:
Look up Existing SecurityGroup Resource
Get an existing SecurityGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: SecurityGroupState, opts?: CustomResourceOptions): SecurityGroup
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
arn: Optional[str] = None,
description: Optional[str] = None,
egress: Optional[Sequence[SecurityGroupEgressArgs]] = None,
ingress: Optional[Sequence[SecurityGroupIngressArgs]] = None,
name: Optional[str] = None,
name_prefix: Optional[str] = None,
owner_id: Optional[str] = None,
revoke_rules_on_delete: Optional[bool] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None,
vpc_id: Optional[str] = None) -> SecurityGroup
func GetSecurityGroup(ctx *Context, name string, id IDInput, state *SecurityGroupState, opts ...ResourceOption) (*SecurityGroup, error)
public static SecurityGroup Get(string name, Input<string> id, SecurityGroupState? state, CustomResourceOptions? opts = null)
public static SecurityGroup get(String name, Output<String> id, SecurityGroupState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Arn string
- ARN of the security group.
- Description string
- Security group description. Defaults to
Managed by Pulumi
. Cannot be""
. NOTE: This field maps to the AWSGroupDescription
attribute, for which there is no Update API. If you'd like to classify your security groups in a way that can be updated, usetags
. - Egress
List<Security
Group Egress> - Configuration block for egress rules. Can be specified multiple times for each egress rule. Each egress block supports fields documented below. This argument is processed in attribute-as-blocks mode.
- Ingress
List<Security
Group Ingress> - Configuration block for ingress rules. Can be specified multiple times for each ingress rule. Each ingress block supports fields documented below. This argument is processed in attribute-as-blocks mode.
- Name string
- Name of the security group. If omitted, the provider will assign a random, unique name.
- Name
Prefix string - Creates a unique name beginning with the specified prefix. Conflicts with
name
. - Owner
Id string - Owner ID.
- Revoke
Rules boolOn Delete - Instruct the provider to revoke all of the Security Groups attached ingress and egress rules before deleting the rule itself. This is normally not needed, however certain AWS services such as Elastic Map Reduce may automatically add required rules to security groups used with the service, and those rules may contain a cyclic dependency that prevent the security groups from being destroyed without removing the dependency first. Default
false
. - Dictionary<string, string>
- 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. - Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - Vpc
Id string - VPC ID. Defaults to the region's default VPC.
- Arn string
- ARN of the security group.
- Description string
- Security group description. Defaults to
Managed by Pulumi
. Cannot be""
. NOTE: This field maps to the AWSGroupDescription
attribute, for which there is no Update API. If you'd like to classify your security groups in a way that can be updated, usetags
. - Egress
[]Security
Group Egress Args - Configuration block for egress rules. Can be specified multiple times for each egress rule. Each egress block supports fields documented below. This argument is processed in attribute-as-blocks mode.
- Ingress
[]Security
Group Ingress Args - Configuration block for ingress rules. Can be specified multiple times for each ingress rule. Each ingress block supports fields documented below. This argument is processed in attribute-as-blocks mode.
- Name string
- Name of the security group. If omitted, the provider will assign a random, unique name.
- Name
Prefix string - Creates a unique name beginning with the specified prefix. Conflicts with
name
. - Owner
Id string - Owner ID.
- Revoke
Rules boolOn Delete - Instruct the provider to revoke all of the Security Groups attached ingress and egress rules before deleting the rule itself. This is normally not needed, however certain AWS services such as Elastic Map Reduce may automatically add required rules to security groups used with the service, and those rules may contain a cyclic dependency that prevent the security groups from being destroyed without removing the dependency first. Default
false
. - map[string]string
- 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. - map[string]string
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - Vpc
Id string - VPC ID. Defaults to the region's default VPC.
- arn String
- ARN of the security group.
- description String
- Security group description. Defaults to
Managed by Pulumi
. Cannot be""
. NOTE: This field maps to the AWSGroupDescription
attribute, for which there is no Update API. If you'd like to classify your security groups in a way that can be updated, usetags
. - egress
List<Security
Group Egress> - Configuration block for egress rules. Can be specified multiple times for each egress rule. Each egress block supports fields documented below. This argument is processed in attribute-as-blocks mode.
- ingress
List<Security
Group Ingress> - Configuration block for ingress rules. Can be specified multiple times for each ingress rule. Each ingress block supports fields documented below. This argument is processed in attribute-as-blocks mode.
- name String
- Name of the security group. If omitted, the provider will assign a random, unique name.
- name
Prefix String - Creates a unique name beginning with the specified prefix. Conflicts with
name
. - owner
Id String - Owner ID.
- revoke
Rules BooleanOn Delete - Instruct the provider to revoke all of the Security Groups attached ingress and egress rules before deleting the rule itself. This is normally not needed, however certain AWS services such as Elastic Map Reduce may automatically add required rules to security groups used with the service, and those rules may contain a cyclic dependency that prevent the security groups from being destroyed without removing the dependency first. Default
false
. - Map<String,String>
- 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. - Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - vpc
Id String - VPC ID. Defaults to the region's default VPC.
- arn string
- ARN of the security group.
- description string
- Security group description. Defaults to
Managed by Pulumi
. Cannot be""
. NOTE: This field maps to the AWSGroupDescription
attribute, for which there is no Update API. If you'd like to classify your security groups in a way that can be updated, usetags
. - egress
Security
Group Egress[] - Configuration block for egress rules. Can be specified multiple times for each egress rule. Each egress block supports fields documented below. This argument is processed in attribute-as-blocks mode.
- ingress
Security
Group Ingress[] - Configuration block for ingress rules. Can be specified multiple times for each ingress rule. Each ingress block supports fields documented below. This argument is processed in attribute-as-blocks mode.
- name string
- Name of the security group. If omitted, the provider will assign a random, unique name.
- name
Prefix string - Creates a unique name beginning with the specified prefix. Conflicts with
name
. - owner
Id string - Owner ID.
- revoke
Rules booleanOn Delete - Instruct the provider to revoke all of the Security Groups attached ingress and egress rules before deleting the rule itself. This is normally not needed, however certain AWS services such as Elastic Map Reduce may automatically add required rules to security groups used with the service, and those rules may contain a cyclic dependency that prevent the security groups from being destroyed without removing the dependency first. Default
false
. - {[key: string]: string}
- 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. - {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - vpc
Id string - VPC ID. Defaults to the region's default VPC.
- arn str
- ARN of the security group.
- description str
- Security group description. Defaults to
Managed by Pulumi
. Cannot be""
. NOTE: This field maps to the AWSGroupDescription
attribute, for which there is no Update API. If you'd like to classify your security groups in a way that can be updated, usetags
. - egress
Sequence[Security
Group Egress Args] - Configuration block for egress rules. Can be specified multiple times for each egress rule. Each egress block supports fields documented below. This argument is processed in attribute-as-blocks mode.
- ingress
Sequence[Security
Group Ingress Args] - Configuration block for ingress rules. Can be specified multiple times for each ingress rule. Each ingress block supports fields documented below. This argument is processed in attribute-as-blocks mode.
- name str
- Name of the security group. If omitted, the provider will assign a random, unique name.
- name_
prefix str - Creates a unique name beginning with the specified prefix. Conflicts with
name
. - owner_
id str - Owner ID.
- revoke_
rules_ boolon_ delete - Instruct the provider to revoke all of the Security Groups attached ingress and egress rules before deleting the rule itself. This is normally not needed, however certain AWS services such as Elastic Map Reduce may automatically add required rules to security groups used with the service, and those rules may contain a cyclic dependency that prevent the security groups from being destroyed without removing the dependency first. Default
false
. - Mapping[str, str]
- 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. - Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - vpc_
id str - VPC ID. Defaults to the region's default VPC.
- arn String
- ARN of the security group.
- description String
- Security group description. Defaults to
Managed by Pulumi
. Cannot be""
. NOTE: This field maps to the AWSGroupDescription
attribute, for which there is no Update API. If you'd like to classify your security groups in a way that can be updated, usetags
. - egress List<Property Map>
- Configuration block for egress rules. Can be specified multiple times for each egress rule. Each egress block supports fields documented below. This argument is processed in attribute-as-blocks mode.
- ingress List<Property Map>
- Configuration block for ingress rules. Can be specified multiple times for each ingress rule. Each ingress block supports fields documented below. This argument is processed in attribute-as-blocks mode.
- name String
- Name of the security group. If omitted, the provider will assign a random, unique name.
- name
Prefix String - Creates a unique name beginning with the specified prefix. Conflicts with
name
. - owner
Id String - Owner ID.
- revoke
Rules BooleanOn Delete - Instruct the provider to revoke all of the Security Groups attached ingress and egress rules before deleting the rule itself. This is normally not needed, however certain AWS services such as Elastic Map Reduce may automatically add required rules to security groups used with the service, and those rules may contain a cyclic dependency that prevent the security groups from being destroyed without removing the dependency first. Default
false
. - Map<String>
- 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. - Map<String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - vpc
Id String - VPC ID. Defaults to the region's default VPC.
Supporting Types
SecurityGroupEgress, SecurityGroupEgressArgs
- From
Port int - Start port (or ICMP type number if protocol is
icmp
) - Protocol string
- Protocol. If you select a protocol of
-1
(semantically equivalent toall
, which is not a valid value here), you must specify afrom_port
andto_port
equal to 0. The supported values are defined in theIpProtocol
argument in the IpPermission API reference. - To
Port int End range port (or ICMP code if protocol is
icmp
).The following arguments are optional:
Note Although
cidr_blocks
,ipv6_cidr_blocks
,prefix_list_ids
, andsecurity_groups
are all marked as optional, you must provide one of them in order to configure the destination of the traffic.- Cidr
Blocks List<string> - List of CIDR blocks.
- Description string
- Description of this egress rule.
- Ipv6Cidr
Blocks List<string> - List of IPv6 CIDR blocks.
- Prefix
List List<string>Ids - List of Prefix List IDs.
- Security
Groups List<string> - List of security groups. A group name can be used relative to the default VPC. Otherwise, group ID.
- Self bool
- Whether the security group itself will be added as a source to this egress rule.
- From
Port int - Start port (or ICMP type number if protocol is
icmp
) - Protocol string
- Protocol. If you select a protocol of
-1
(semantically equivalent toall
, which is not a valid value here), you must specify afrom_port
andto_port
equal to 0. The supported values are defined in theIpProtocol
argument in the IpPermission API reference. - To
Port int End range port (or ICMP code if protocol is
icmp
).The following arguments are optional:
Note Although
cidr_blocks
,ipv6_cidr_blocks
,prefix_list_ids
, andsecurity_groups
are all marked as optional, you must provide one of them in order to configure the destination of the traffic.- Cidr
Blocks []string - List of CIDR blocks.
- Description string
- Description of this egress rule.
- Ipv6Cidr
Blocks []string - List of IPv6 CIDR blocks.
- Prefix
List []stringIds - List of Prefix List IDs.
- Security
Groups []string - List of security groups. A group name can be used relative to the default VPC. Otherwise, group ID.
- Self bool
- Whether the security group itself will be added as a source to this egress rule.
- from
Port Integer - Start port (or ICMP type number if protocol is
icmp
) - protocol String
- Protocol. If you select a protocol of
-1
(semantically equivalent toall
, which is not a valid value here), you must specify afrom_port
andto_port
equal to 0. The supported values are defined in theIpProtocol
argument in the IpPermission API reference. - to
Port Integer End range port (or ICMP code if protocol is
icmp
).The following arguments are optional:
Note Although
cidr_blocks
,ipv6_cidr_blocks
,prefix_list_ids
, andsecurity_groups
are all marked as optional, you must provide one of them in order to configure the destination of the traffic.- cidr
Blocks List<String> - List of CIDR blocks.
- description String
- Description of this egress rule.
- ipv6Cidr
Blocks List<String> - List of IPv6 CIDR blocks.
- prefix
List List<String>Ids - List of Prefix List IDs.
- security
Groups List<String> - List of security groups. A group name can be used relative to the default VPC. Otherwise, group ID.
- self Boolean
- Whether the security group itself will be added as a source to this egress rule.
- from
Port number - Start port (or ICMP type number if protocol is
icmp
) - protocol string
- Protocol. If you select a protocol of
-1
(semantically equivalent toall
, which is not a valid value here), you must specify afrom_port
andto_port
equal to 0. The supported values are defined in theIpProtocol
argument in the IpPermission API reference. - to
Port number End range port (or ICMP code if protocol is
icmp
).The following arguments are optional:
Note Although
cidr_blocks
,ipv6_cidr_blocks
,prefix_list_ids
, andsecurity_groups
are all marked as optional, you must provide one of them in order to configure the destination of the traffic.- cidr
Blocks string[] - List of CIDR blocks.
- description string
- Description of this egress rule.
- ipv6Cidr
Blocks string[] - List of IPv6 CIDR blocks.
- prefix
List string[]Ids - List of Prefix List IDs.
- security
Groups string[] - List of security groups. A group name can be used relative to the default VPC. Otherwise, group ID.
- self boolean
- Whether the security group itself will be added as a source to this egress rule.
- from_
port int - Start port (or ICMP type number if protocol is
icmp
) - protocol str
- Protocol. If you select a protocol of
-1
(semantically equivalent toall
, which is not a valid value here), you must specify afrom_port
andto_port
equal to 0. The supported values are defined in theIpProtocol
argument in the IpPermission API reference. - to_
port int End range port (or ICMP code if protocol is
icmp
).The following arguments are optional:
Note Although
cidr_blocks
,ipv6_cidr_blocks
,prefix_list_ids
, andsecurity_groups
are all marked as optional, you must provide one of them in order to configure the destination of the traffic.- cidr_
blocks Sequence[str] - List of CIDR blocks.
- description str
- Description of this egress rule.
- ipv6_
cidr_ Sequence[str]blocks - List of IPv6 CIDR blocks.
- prefix_
list_ Sequence[str]ids - List of Prefix List IDs.
- security_
groups Sequence[str] - List of security groups. A group name can be used relative to the default VPC. Otherwise, group ID.
- self bool
- Whether the security group itself will be added as a source to this egress rule.
- from
Port Number - Start port (or ICMP type number if protocol is
icmp
) - protocol String
- Protocol. If you select a protocol of
-1
(semantically equivalent toall
, which is not a valid value here), you must specify afrom_port
andto_port
equal to 0. The supported values are defined in theIpProtocol
argument in the IpPermission API reference. - to
Port Number End range port (or ICMP code if protocol is
icmp
).The following arguments are optional:
Note Although
cidr_blocks
,ipv6_cidr_blocks
,prefix_list_ids
, andsecurity_groups
are all marked as optional, you must provide one of them in order to configure the destination of the traffic.- cidr
Blocks List<String> - List of CIDR blocks.
- description String
- Description of this egress rule.
- ipv6Cidr
Blocks List<String> - List of IPv6 CIDR blocks.
- prefix
List List<String>Ids - List of Prefix List IDs.
- security
Groups List<String> - List of security groups. A group name can be used relative to the default VPC. Otherwise, group ID.
- self Boolean
- Whether the security group itself will be added as a source to this egress rule.
SecurityGroupIngress, SecurityGroupIngressArgs
- From
Port int - Start port (or ICMP type number if protocol is
icmp
oricmpv6
). - Protocol string
Protocol. If you select a protocol of
-1
(semantically equivalent toall
, which is not a valid value here), you must specify afrom_port
andto_port
equal to 0. The supported values are defined in theIpProtocol
argument on the IpPermission API reference.The following arguments are optional:
Note Although
cidr_blocks
,ipv6_cidr_blocks
,prefix_list_ids
, andsecurity_groups
are all marked as optional, you must provide one of them in order to configure the source of the traffic.- To
Port int - End range port (or ICMP code if protocol is
icmp
). - Cidr
Blocks List<string> - List of CIDR blocks.
- Description string
- Description of this ingress rule.
- Ipv6Cidr
Blocks List<string> - List of IPv6 CIDR blocks.
- Prefix
List List<string>Ids - List of Prefix List IDs.
- Security
Groups List<string> - List of security groups. A group name can be used relative to the default VPC. Otherwise, group ID.
- Self bool
- Whether the security group itself will be added as a source to this ingress rule.
- From
Port int - Start port (or ICMP type number if protocol is
icmp
oricmpv6
). - Protocol string
Protocol. If you select a protocol of
-1
(semantically equivalent toall
, which is not a valid value here), you must specify afrom_port
andto_port
equal to 0. The supported values are defined in theIpProtocol
argument on the IpPermission API reference.The following arguments are optional:
Note Although
cidr_blocks
,ipv6_cidr_blocks
,prefix_list_ids
, andsecurity_groups
are all marked as optional, you must provide one of them in order to configure the source of the traffic.- To
Port int - End range port (or ICMP code if protocol is
icmp
). - Cidr
Blocks []string - List of CIDR blocks.
- Description string
- Description of this ingress rule.
- Ipv6Cidr
Blocks []string - List of IPv6 CIDR blocks.
- Prefix
List []stringIds - List of Prefix List IDs.
- Security
Groups []string - List of security groups. A group name can be used relative to the default VPC. Otherwise, group ID.
- Self bool
- Whether the security group itself will be added as a source to this ingress rule.
- from
Port Integer - Start port (or ICMP type number if protocol is
icmp
oricmpv6
). - protocol String
Protocol. If you select a protocol of
-1
(semantically equivalent toall
, which is not a valid value here), you must specify afrom_port
andto_port
equal to 0. The supported values are defined in theIpProtocol
argument on the IpPermission API reference.The following arguments are optional:
Note Although
cidr_blocks
,ipv6_cidr_blocks
,prefix_list_ids
, andsecurity_groups
are all marked as optional, you must provide one of them in order to configure the source of the traffic.- to
Port Integer - End range port (or ICMP code if protocol is
icmp
). - cidr
Blocks List<String> - List of CIDR blocks.
- description String
- Description of this ingress rule.
- ipv6Cidr
Blocks List<String> - List of IPv6 CIDR blocks.
- prefix
List List<String>Ids - List of Prefix List IDs.
- security
Groups List<String> - List of security groups. A group name can be used relative to the default VPC. Otherwise, group ID.
- self Boolean
- Whether the security group itself will be added as a source to this ingress rule.
- from
Port number - Start port (or ICMP type number if protocol is
icmp
oricmpv6
). - protocol string
Protocol. If you select a protocol of
-1
(semantically equivalent toall
, which is not a valid value here), you must specify afrom_port
andto_port
equal to 0. The supported values are defined in theIpProtocol
argument on the IpPermission API reference.The following arguments are optional:
Note Although
cidr_blocks
,ipv6_cidr_blocks
,prefix_list_ids
, andsecurity_groups
are all marked as optional, you must provide one of them in order to configure the source of the traffic.- to
Port number - End range port (or ICMP code if protocol is
icmp
). - cidr
Blocks string[] - List of CIDR blocks.
- description string
- Description of this ingress rule.
- ipv6Cidr
Blocks string[] - List of IPv6 CIDR blocks.
- prefix
List string[]Ids - List of Prefix List IDs.
- security
Groups string[] - List of security groups. A group name can be used relative to the default VPC. Otherwise, group ID.
- self boolean
- Whether the security group itself will be added as a source to this ingress rule.
- from_
port int - Start port (or ICMP type number if protocol is
icmp
oricmpv6
). - protocol str
Protocol. If you select a protocol of
-1
(semantically equivalent toall
, which is not a valid value here), you must specify afrom_port
andto_port
equal to 0. The supported values are defined in theIpProtocol
argument on the IpPermission API reference.The following arguments are optional:
Note Although
cidr_blocks
,ipv6_cidr_blocks
,prefix_list_ids
, andsecurity_groups
are all marked as optional, you must provide one of them in order to configure the source of the traffic.- to_
port int - End range port (or ICMP code if protocol is
icmp
). - cidr_
blocks Sequence[str] - List of CIDR blocks.
- description str
- Description of this ingress rule.
- ipv6_
cidr_ Sequence[str]blocks - List of IPv6 CIDR blocks.
- prefix_
list_ Sequence[str]ids - List of Prefix List IDs.
- security_
groups Sequence[str] - List of security groups. A group name can be used relative to the default VPC. Otherwise, group ID.
- self bool
- Whether the security group itself will be added as a source to this ingress rule.
- from
Port Number - Start port (or ICMP type number if protocol is
icmp
oricmpv6
). - protocol String
Protocol. If you select a protocol of
-1
(semantically equivalent toall
, which is not a valid value here), you must specify afrom_port
andto_port
equal to 0. The supported values are defined in theIpProtocol
argument on the IpPermission API reference.The following arguments are optional:
Note Although
cidr_blocks
,ipv6_cidr_blocks
,prefix_list_ids
, andsecurity_groups
are all marked as optional, you must provide one of them in order to configure the source of the traffic.- to
Port Number - End range port (or ICMP code if protocol is
icmp
). - cidr
Blocks List<String> - List of CIDR blocks.
- description String
- Description of this ingress rule.
- ipv6Cidr
Blocks List<String> - List of IPv6 CIDR blocks.
- prefix
List List<String>Ids - List of Prefix List IDs.
- security
Groups List<String> - List of security groups. A group name can be used relative to the default VPC. Otherwise, group ID.
- self Boolean
- Whether the security group itself will be added as a source to this ingress rule.
Import
Using pulumi import
, import Security Groups using the security group id
. For example:
$ pulumi import aws:ec2/securityGroup:SecurityGroup elb_sg sg-903004f8
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.