Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Native
  3. API Docs
  4. ec2
  5. SecurityGroupIngress

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.ec2.SecurityGroupIngress

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::EC2::SecurityGroupIngress

    Create SecurityGroupIngress Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new SecurityGroupIngress(name: string, args: SecurityGroupIngressArgs, opts?: CustomResourceOptions);
    @overload
def SecurityGroupIngress(resource_name: str,
                         args: SecurityGroupIngressInitArgs,
                         opts: Optional[ResourceOptions] = None)

@overload
def SecurityGroupIngress(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         ip_protocol: Optional[str] = None,
                         cidr_ip: Optional[str] = None,
                         cidr_ipv6: Optional[str] = None,
                         description: Optional[str] = None,
                         from_port: Optional[int] = None,
                         group_id: Optional[str] = None,
                         group_name: Optional[str] = None,
                         source_prefix_list_id: Optional[str] = None,
                         source_security_group_id: Optional[str] = None,
                         source_security_group_name: Optional[str] = None,
                         source_security_group_owner_id: Optional[str] = None,
                         to_port: Optional[int] = None)
    func NewSecurityGroupIngress(ctx *Context, name string, args SecurityGroupIngressArgs, opts ...ResourceOption) (*SecurityGroupIngress, error)
    public SecurityGroupIngress(string name, SecurityGroupIngressArgs args, CustomResourceOptions? opts = null)
    public SecurityGroupIngress(String name, SecurityGroupIngressArgs args)
public SecurityGroupIngress(String name, SecurityGroupIngressArgs args, CustomResourceOptions options)

    type: aws-native:ec2:SecurityGroupIngress
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 SecurityGroupIngressArgs
    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 SecurityGroupIngressInitArgs
    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 SecurityGroupIngressArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SecurityGroupIngressArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SecurityGroupIngressArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    SecurityGroupIngress Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The SecurityGroupIngress resource accepts the following input properties:

    IpProtocol string

    The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).

    [VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.

    CidrIp string
    The IPv4 ranges
    CidrIpv6 string
    [VPC only] The IPv6 ranges
    Description string
    Updates the description of an ingress (inbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously
    FromPort int

    The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.

    Use this for ICMP and any protocol that uses ports.

    GroupId string

    The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.

    You must specify the GroupName property or the GroupId property. For security groups that are in a VPC, you must use the GroupId property.

    GroupName string
    The name of the security group.
    SourcePrefixListId string
    [EC2-VPC only] The ID of a prefix list.
    SourceSecurityGroupId string
    The ID of the security group. You must specify either the security group ID or the security group name. For security groups in a nondefault VPC, you must specify the security group ID.
    SourceSecurityGroupName string

    [EC2-Classic, default VPC] The name of the source security group.

    You must specify the GroupName property or the GroupId property. For security groups that are in a VPC, you must use the GroupId property.

    SourceSecurityGroupOwnerId string

    [nondefault VPC] The AWS account ID that owns the source security group. You can't specify this property with an IP address range.

    If you specify SourceSecurityGroupName or SourceSecurityGroupId and that security group is owned by a different account than the account creating the stack, you must specify the SourceSecurityGroupOwnerId; otherwise, this property is optional.

    ToPort int

    The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes for the specified ICMP type. If you specify all ICMP/ICMPv6 types, you must specify all codes.

    Use this for ICMP and any protocol that uses ports.

    IpProtocol string

    The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).

    [VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.

    CidrIp string
    The IPv4 ranges
    CidrIpv6 string
    [VPC only] The IPv6 ranges
    Description string
    Updates the description of an ingress (inbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously
    FromPort int

    The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.

    Use this for ICMP and any protocol that uses ports.

    GroupId string

    The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.

    You must specify the GroupName property or the GroupId property. For security groups that are in a VPC, you must use the GroupId property.

    GroupName string
    The name of the security group.
    SourcePrefixListId string
    [EC2-VPC only] The ID of a prefix list.
    SourceSecurityGroupId string
    The ID of the security group. You must specify either the security group ID or the security group name. For security groups in a nondefault VPC, you must specify the security group ID.
    SourceSecurityGroupName string

    [EC2-Classic, default VPC] The name of the source security group.

    You must specify the GroupName property or the GroupId property. For security groups that are in a VPC, you must use the GroupId property.

    SourceSecurityGroupOwnerId string

    [nondefault VPC] The AWS account ID that owns the source security group. You can't specify this property with an IP address range.

    If you specify SourceSecurityGroupName or SourceSecurityGroupId and that security group is owned by a different account than the account creating the stack, you must specify the SourceSecurityGroupOwnerId; otherwise, this property is optional.

    ToPort int

    The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes for the specified ICMP type. If you specify all ICMP/ICMPv6 types, you must specify all codes.

    Use this for ICMP and any protocol that uses ports.

    ipProtocol String

    The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).

    [VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.

    cidrIp String
    The IPv4 ranges
    cidrIpv6 String
    [VPC only] The IPv6 ranges
    description String
    Updates the description of an ingress (inbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously
    fromPort Integer

    The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.

    Use this for ICMP and any protocol that uses ports.

    groupId String

    The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.

    You must specify the GroupName property or the GroupId property. For security groups that are in a VPC, you must use the GroupId property.

    groupName String
    The name of the security group.
    sourcePrefixListId String
    [EC2-VPC only] The ID of a prefix list.
    sourceSecurityGroupId String
    The ID of the security group. You must specify either the security group ID or the security group name. For security groups in a nondefault VPC, you must specify the security group ID.
    sourceSecurityGroupName String

    [EC2-Classic, default VPC] The name of the source security group.

    You must specify the GroupName property or the GroupId property. For security groups that are in a VPC, you must use the GroupId property.

    sourceSecurityGroupOwnerId String

    [nondefault VPC] The AWS account ID that owns the source security group. You can't specify this property with an IP address range.

    If you specify SourceSecurityGroupName or SourceSecurityGroupId and that security group is owned by a different account than the account creating the stack, you must specify the SourceSecurityGroupOwnerId; otherwise, this property is optional.

    toPort Integer

    The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes for the specified ICMP type. If you specify all ICMP/ICMPv6 types, you must specify all codes.

    Use this for ICMP and any protocol that uses ports.

    ipProtocol string

    The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).

    [VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.

    cidrIp string
    The IPv4 ranges
    cidrIpv6 string
    [VPC only] The IPv6 ranges
    description string
    Updates the description of an ingress (inbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously
    fromPort number

    The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.

    Use this for ICMP and any protocol that uses ports.

    groupId string

    The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.

    You must specify the GroupName property or the GroupId property. For security groups that are in a VPC, you must use the GroupId property.

    groupName string
    The name of the security group.
    sourcePrefixListId string
    [EC2-VPC only] The ID of a prefix list.
    sourceSecurityGroupId string
    The ID of the security group. You must specify either the security group ID or the security group name. For security groups in a nondefault VPC, you must specify the security group ID.
    sourceSecurityGroupName string

    [EC2-Classic, default VPC] The name of the source security group.

    You must specify the GroupName property or the GroupId property. For security groups that are in a VPC, you must use the GroupId property.

    sourceSecurityGroupOwnerId string

    [nondefault VPC] The AWS account ID that owns the source security group. You can't specify this property with an IP address range.

    If you specify SourceSecurityGroupName or SourceSecurityGroupId and that security group is owned by a different account than the account creating the stack, you must specify the SourceSecurityGroupOwnerId; otherwise, this property is optional.

    toPort number

    The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes for the specified ICMP type. If you specify all ICMP/ICMPv6 types, you must specify all codes.

    Use this for ICMP and any protocol that uses ports.

    ip_protocol str

    The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).

    [VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.

    cidr_ip str
    The IPv4 ranges
    cidr_ipv6 str
    [VPC only] The IPv6 ranges
    description str
    Updates the description of an ingress (inbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously
    from_port int

    The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.

    Use this for ICMP and any protocol that uses ports.

    group_id str

    The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.

    You must specify the GroupName property or the GroupId property. For security groups that are in a VPC, you must use the GroupId property.

    group_name str
    The name of the security group.
    source_prefix_list_id str
    [EC2-VPC only] The ID of a prefix list.
    source_security_group_id str
    The ID of the security group. You must specify either the security group ID or the security group name. For security groups in a nondefault VPC, you must specify the security group ID.
    source_security_group_name str

    [EC2-Classic, default VPC] The name of the source security group.

    You must specify the GroupName property or the GroupId property. For security groups that are in a VPC, you must use the GroupId property.

    source_security_group_owner_id str

    [nondefault VPC] The AWS account ID that owns the source security group. You can't specify this property with an IP address range.

    If you specify SourceSecurityGroupName or SourceSecurityGroupId and that security group is owned by a different account than the account creating the stack, you must specify the SourceSecurityGroupOwnerId; otherwise, this property is optional.

    to_port int

    The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes for the specified ICMP type. If you specify all ICMP/ICMPv6 types, you must specify all codes.

    Use this for ICMP and any protocol that uses ports.

    ipProtocol String

    The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).

    [VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.

    cidrIp String
    The IPv4 ranges
    cidrIpv6 String
    [VPC only] The IPv6 ranges
    description String
    Updates the description of an ingress (inbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously
    fromPort Number

    The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.

    Use this for ICMP and any protocol that uses ports.

    groupId String

    The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.

    You must specify the GroupName property or the GroupId property. For security groups that are in a VPC, you must use the GroupId property.

    groupName String
    The name of the security group.
    sourcePrefixListId String
    [EC2-VPC only] The ID of a prefix list.
    sourceSecurityGroupId String
    The ID of the security group. You must specify either the security group ID or the security group name. For security groups in a nondefault VPC, you must specify the security group ID.
    sourceSecurityGroupName String

    [EC2-Classic, default VPC] The name of the source security group.

    You must specify the GroupName property or the GroupId property. For security groups that are in a VPC, you must use the GroupId property.

    sourceSecurityGroupOwnerId String

    [nondefault VPC] The AWS account ID that owns the source security group. You can't specify this property with an IP address range.

    If you specify SourceSecurityGroupName or SourceSecurityGroupId and that security group is owned by a different account than the account creating the stack, you must specify the SourceSecurityGroupOwnerId; otherwise, this property is optional.

    toPort Number

    The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes for the specified ICMP type. If you specify all ICMP/ICMPv6 types, you must specify all codes.

    Use this for ICMP and any protocol that uses ports.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SecurityGroupIngress resource produces the following output properties:

    AwsId string
    The Security Group Rule Id
    Id string
    The provider-assigned unique ID for this managed resource.
    AwsId string
    The Security Group Rule Id
    Id string
    The provider-assigned unique ID for this managed resource.
    awsId String
    The Security Group Rule Id
    id String
    The provider-assigned unique ID for this managed resource.
    awsId string
    The Security Group Rule Id
    id string
    The provider-assigned unique ID for this managed resource.
    aws_id str
    The Security Group Rule Id
    id str
    The provider-assigned unique ID for this managed resource.
    awsId String
    The Security Group Rule Id
    id String
    The provider-assigned unique ID for this managed resource.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
    pulumi/pulumi-aws-native