github.com/hobbeswalsh/terraform@v0.3.7-0.20150619183303-ad17cf55a0fa/website/source/docs/providers/aws/r/security_group.html.markdown (about)

     1  ---
     2  layout: "aws"
     3  page_title: "AWS: aws_security_group"
     4  sidebar_current: "docs-aws-resource-security-group"
     5  description: |-
     6    Provides a security group resource.
     7  ---
     8  
     9  # aws\_security\_group
    10  
    11  Provides a security group resource.
    12  
    13  ~> **NOTE on Security Groups and Security Group Rules:** Terraform currently
    14  provides both a standalone [Security Group Rule resource](security_group_rule.html) (a single `ingress` or
    15  `egress` rule), and a Security Group resource with `ingress` and `egress` rules
    16  defined in-line. At this time you cannot use a Security Group with in-line rules
    17  in conjunction with any Security Group Rule resources. Doing so will cause
    18  a conflict of rule settings and will overwrite rules.
    19  
    20  ## Example Usage
    21  
    22  Basic usage
    23  
    24  ```
    25  resource "aws_security_group" "allow_all" {
    26    name = "allow_all"
    27    description = "Allow all inbound traffic"
    28  
    29    ingress {
    30        from_port = 0
    31        to_port = 0
    32        protocol = "-1"
    33        cidr_blocks = ["0.0.0.0/0"]
    34    }
    35  
    36    egress {
    37        from_port = 0
    38        to_port = 0
    39        protocol = "-1"
    40        cidr_blocks = ["0.0.0.0/0"]
    41    }
    42  }
    43  ```
    44  
    45  Basic usage with tags:
    46  
    47  ```
    48  resource "aws_security_group" "allow_all" {
    49    name = "allow_all"
    50    description = "Allow all inbound traffic"
    51  
    52    ingress {
    53        from_port = 0
    54        to_port = 65535
    55        protocol = "tcp"
    56        cidr_blocks = ["0.0.0.0/0"]
    57    }
    58  
    59    tags {
    60      Name = "allow_all"
    61    }
    62  }
    63  ```
    64  
    65  ## Argument Reference
    66  
    67  The following arguments are supported:
    68  
    69  * `name` - (Required) The name of the security group
    70  * `description` - (Optional) The security group description. Defaults to "Managed by Terraform". Cannot be "".
    71  * `ingress` - (Optional) Can be specified multiple times for each
    72     ingress rule. Each ingress block supports fields documented below.
    73  * `egress` - (Optional, VPC only) Can be specified multiple times for each
    74        egress rule. Each egress block supports fields documented below.
    75  * `vpc_id` - (Optional) The VPC ID.
    76  * `tags` - (Optional) A mapping of tags to assign to the resource.
    77  
    78  The `ingress` block supports:
    79  
    80  * `cidr_blocks` - (Optional) List of CIDR blocks. Cannot be used with `security_groups`.
    81  * `from_port` - (Required) The start port.
    82  * `protocol` - (Required) The protocol. If you select a protocol of
    83  "-1", you must specify a "from_port" and "to_port" equal to 0.
    84  * `security_groups` - (Optional) List of security group Group Names if using
    85      EC2-Classic or the default VPC, or Group IDs if using a non-default VPC.
    86      Cannot be used with `cidr_blocks`.
    87  * `self` - (Optional) If true, the security group itself will be added as
    88       a source to this ingress rule.
    89  * `to_port` - (Required) The end range port.
    90  
    91  The `egress` block supports:
    92  
    93  * `cidr_blocks` - (Optional) List of CIDR blocks. Cannot be used with `security_groups`.
    94  * `from_port` - (Required) The start port.
    95  * `protocol` - (Required) The protocol. If you select a protocol of
    96  "-1", you must specify a "from_port" and "to_port" equal to 0.
    97  * `security_groups` - (Optional) List of security group Group Names if using
    98      EC2-Classic or the default VPC, or Group IDs if using a non-default VPC.
    99      Cannot be used with `cidr_blocks`.
   100  * `self` - (Optional) If true, the security group itself will be added as
   101       a source to this egress rule.
   102  * `to_port` - (Required) The end range port.
   103  
   104  ~> **NOTE on Egress rules:** By default, AWS creates an `ALLOW ALL` egress rule when creating a
   105  new Security Group inside of a VPC. When creating a new Security
   106  Group inside a VPC, **Terraform will remove this default rule**, and require you
   107  specifically re-create it if you desire that rule. We feel this leads to fewer
   108  surprises in terms of controlling your egress rules. If you desire this rule to
   109  be in place, you can use this `egress` block:
   110  
   111      egress {
   112        from_port = 0
   113        to_port = 0
   114        protocol = "-1"
   115        cidr_blocks = ["0.0.0.0/0"]
   116      }
   117  
   118  ## Attributes Reference
   119  
   120  The following attributes are exported:
   121  
   122  * `id` - The ID of the security group
   123  * `vpc_id` - The VPC ID.
   124  * `owner_id` - The owner ID.
   125  * `name` - The name of the security group
   126  * `description` - The description of the security group
   127  * `ingress` - The ingress rules. See above for more.
   128  * `egress` - The egress rules. See above for more.