github.com/danp/terraform@v0.9.5-0.20170426144147-39d740081351/website/source/docs/providers/aws/r/dms_replication_instance.html.markdown (about)

     1  ---
     2  layout: "aws"
     3  page_title: "AWS: aws_dms_replication_instance"
     4  sidebar_current: "docs-aws-resource-dms-replication-instance"
     5  description: |-
     6    Provides a DMS (Data Migration Service) replication instance resource.
     7  ---
     8  
     9  # aws\_dms\_replication\_instance
    10  
    11  Provides a DMS (Data Migration Service) replication instance resource. DMS replication instances can be created, updated, deleted, and imported.
    12  
    13  ## Example Usage
    14  
    15  ```hcl
    16  # Create a new replication instance
    17  resource "aws_dms_replication_instance" "test" {
    18    allocated_storage            = 20
    19    apply_immediately            = true
    20    auto_minor_version_upgrade   = true
    21    availability_zone            = "us-west-2c"
    22    engine_version               = "1.9.0"
    23    kms_key_arn                  = "arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012"
    24    multi_az                     = false
    25    preferred_maintenance_window = "sun:10:30-sun:14:30"
    26    publicly_accessible          = true
    27    replication_instance_class   = "dms.t2.micro"
    28    replication_instance_id      = "test-dms-replication-instance-tf"
    29    replication_subnet_group_id  = "${aws_dms_replication_subnet_group.test-dms-replication-subnet-group-tf}"
    30  
    31    tags {
    32      Name = "test"
    33    }
    34  
    35    vpc_security_group_ids = [
    36      "sg-12345678",
    37    ]
    38  }
    39  ```
    40  
    41  ## Argument Reference
    42  
    43  The following arguments are supported:
    44  
    45  * `allocated_storage` - (Optional, Default: 50, Min: 5, Max: 6144) The amount of storage (in gigabytes) to be initially allocated for the replication instance.
    46  * `apply_immediately` - (Optional, Default: false) Indicates whether the changes should be applied immediately or during the next maintenance window. Only used when updating an existing resource.
    47  * `auto_minor_version_upgrade` - (Optional, Default: false) Indicates that minor engine upgrades will be applied automatically to the replication instance during the maintenance window.
    48  * `availability_zone` - (Optional) The EC2 Availability Zone that the replication instance will be created in.
    49  * `engine_version` - (Optional) The engine version number of the replication instance.
    50  * `kms_key_arn` - (Optional) The Amazon Resource Name (ARN) for the KMS key that will be used to encrypt the connection parameters. If you do not specify a value for `kms_key_arn`, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.
    51  * `multi_az` - (Optional) Specifies if the replication instance is a multi-az deployment. You cannot set the `availability_zone` parameter if the `multi_az` parameter is set to `true`.
    52  * `preferred_maintenance_window` - (Optional) The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
    53  
    54      - Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week.
    55      - Format: `ddd:hh24:mi-ddd:hh24:mi`
    56      - Valid Days: `mon, tue, wed, thu, fri, sat, sun`
    57      - Constraints: Minimum 30-minute window.
    58  
    59  * `publicly_accessible` - (Optional, Default: false) Specifies the accessibility options for the replication instance. A value of true represents an instance with a public IP address. A value of false represents an instance with a private IP address.
    60  * `replication_instance_class` - (Required) The compute and memory capacity of the replication instance as specified by the replication instance class. Can be one of `dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge`
    61  * `replication_instance_id` - (Required) The replication instance identifier. This parameter is stored as a lowercase string.
    62  
    63      - Must contain from 1 to 63 alphanumeric characters or hyphens.
    64      - First character must be a letter.
    65      - Cannot end with a hyphen
    66      - Cannot contain two consecutive hyphens.
    67  
    68  * `replication_subnet_group_id` - (Optional) A subnet group to associate with the replication instance.
    69  * `tags` - (Optional) A mapping of tags to assign to the resource.
    70  * `vpc_security_group_ids` - (Optional) A list of VPC security group IDs to be used with the replication instance. The VPC security groups must work with the VPC containing the replication instance.
    71  
    72  ## Attributes Reference
    73  
    74  The following attributes are exported:
    75  
    76  * `replication_instance_arn` - The Amazon Resource Name (ARN) of the replication instance.
    77  * `replication_instance_private_ips` -  A list of the private IP addresses of the replication instance.
    78  * `replication_instance_public_ips` - A list of the public IP addresses of the replication instance.
    79  
    80  ## Import
    81  
    82  Replication instances can be imported using the `replication_instance_id`, e.g.
    83  
    84  ```
    85  $ terraform import aws_dms_replication_instance.test test-dms-replication-instance-tf
    86  ```