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

     1  ---
     2  layout: "aws"
     3  page_title: "AWS: aws_dms_endpoint"
     4  sidebar_current: "docs-aws-resource-dms-endpoint"
     5  description: |-
     6    Provides a DMS (Data Migration Service) endpoint resource.
     7  ---
     8  
     9  # aws\_dms\_endpoint
    10  
    11  Provides a DMS (Data Migration Service) endpoint resource. DMS endpoints can be created, updated, deleted, and imported.
    12  
    13  ~> **Note:** All arguments including the password will be stored in the raw state as plain-text.
    14  [Read more about sensitive data in state](/docs/state/sensitive-data.html).
    15  
    16  ## Example Usage
    17  
    18  ```hcl
    19  # Create a new endpoint
    20  resource "aws_dms_endpoint" "test" {
    21    certificate_arn             = "arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012"
    22    database_name               = "test"
    23    endpoint_id                 = "test-dms-endpoint-tf"
    24    endpoint_type               = "source"
    25    engine_name                 = "aurora"
    26    extra_connection_attributes = ""
    27    kms_key_arn                 = "arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012"
    28    password                    = "test"
    29    port                        = 3306
    30    server_name                 = "test"
    31    ssl_mode                    = "none"
    32  
    33    tags {
    34      Name = "test"
    35    }
    36  
    37    username = "test"
    38  }
    39  ```
    40  
    41  ## Argument Reference
    42  
    43  The following arguments are supported:
    44  
    45  * `certificate_arn` - (Optional, Default: empty string) The Amazon Resource Name (ARN) for the certificate.
    46  * `database_name` - (Optional) The name of the endpoint database.
    47  * `endpoint_id` - (Required) The database endpoint identifier.
    48  
    49      - Must contain from 1 to 255 alphanumeric characters or hyphens.
    50      - Must begin with a letter
    51      - Must contain only ASCII letters, digits, and hyphens
    52      - Must not end with a hyphen
    53      - Must not contain two consecutive hyphens
    54  
    55  * `endpoint_type` - (Required) The type of endpoint. Can be one of `source | target`.
    56  * `engine_name` - (Required) The type of engine for the endpoint. Can be one of `mysql | oracle | postgres | mariadb | aurora | redshift | sybase | sqlserver`.
    57  * `extra_connection_attributes` - (Optional) Additional attributes associated with the connection. For available attributes see [Using Extra Connection Attributes with AWS Database Migration Service](http://docs.aws.amazon.com/dms/latest/userguide/CHAP_Introduction.ConnectionAttributes.html).
    58  * `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.
    59  * `password` - (Required) The password to be used to login to the endpoint database.
    60  * `port` - (Required) The port used by the endpoint database.
    61  * `server_name` - (Required) The host name of the server.
    62  * `ssl_mode` - (Optional, Default: none) The SSL mode to use for the connection. Can be one of `none | require | verify-ca | verify-full`
    63  * `tags` - (Optional) A mapping of tags to assign to the resource.
    64  * `username` - (Required) The user name to be used to login to the endpoint database.
    65  
    66  ## Attributes Reference
    67  
    68  The following attributes are exported:
    69  
    70  * `endpoint_arn` - The Amazon Resource Name (ARN) for the endpoint.
    71  
    72  ## Import
    73  
    74  Endpoints can be imported using the `endpoint_id`, e.g.
    75  
    76  ```
    77  $ terraform import aws_dms_endpoint.test test-dms-endpoint-tf
    78  ```