github.com/nathanielks/terraform@v0.6.1-0.20170509030759-13e1a62319dc/website/source/docs/providers/aws/r/db_option_group.html.markdown (about)

     1  ---
     2  layout: "aws"
     3  page_title: "AWS: aws_db_option_group"
     4  sidebar_current: "docs-aws-resource-db-option-group"
     5  ---
     6  
     7  # aws\_db\_option\_group
     8  
     9  Provides an RDS DB option group resource.
    10  
    11  ## Example Usage
    12  
    13  ```hcl
    14  resource "aws_db_option_group" "bar" {
    15    name                     = "option-group-test-terraform"
    16    option_group_description = "Terraform Option Group"
    17    engine_name              = "sqlserver-ee"
    18    major_engine_version     = "11.00"
    19  
    20    option {
    21      option_name = "Timezone"
    22  
    23      option_settings {
    24        name  = "TIME_ZONE"
    25        value = "UTC"
    26      }
    27    }
    28  
    29    option {
    30      option_name = "TDE"
    31    }
    32  }
    33  ```
    34  
    35  ~> **Note**: Any modifications to the `db_option_group` are set to happen immediately as we default to applying immediately.
    36  
    37  ## Argument Reference
    38  
    39  The following arguments are supported:
    40  
    41  * `name` - (Optional, Forces new resource) The name of the option group. If omitted, Terraform will assign a random, unique name. This is converted to lowercase, as is stored in AWS.
    42  * `name_prefix` - (Optional, Forces new resource) Creates a unique name beginning with the specified prefix. Conflicts with `name`. This is converted to lowercase, as is stored in AWS.
    43  * `option_group_description` - (Optional) The description of the option group. Defaults to "Managed by Terraform".
    44  * `engine_name` - (Required) Specifies the name of the engine that this option group should be associated with.
    45  * `major_engine_version` - (Required) Specifies the major version of the engine that this option group should be associated with.
    46  * `option` - (Optional) A list of Options to apply.
    47  * `tags` - (Optional) A mapping of tags to assign to the resource.
    48  
    49  Option blocks support the following:
    50  
    51  * `option_name` - (Required) The Name of the Option (e.g. MEMCACHED).
    52  * `option_settings` - (Optional) A list of option settings to apply.
    53  * `port` - (Optional) The Port number when connecting to the Option (e.g. 11211).
    54  * `db_security_group_memberships` - (Optional) A list of DB Security Groups for which the option is enabled.
    55  * `vpc_security_group_memberships` - (Optional) A list of VPC Security Groups for which the option is enabled.
    56  
    57  Option Settings blocks support the following:
    58  
    59  * `name` - (Optional) The Name of the setting.
    60  * `value` - (Optional) The Value of the setting.
    61  
    62  ## Attributes Reference
    63  
    64  The following attributes are exported:
    65  
    66  * `arn` - The ARN of the db option group.
    67  
    68  ## Import
    69  
    70  DB Option groups can be imported using the `name`, e.g.
    71  
    72  ```
    73  $ terraform import aws_db_option_group.bar mysql-option-group
    74  ```