github.com/nevins-b/terraform@v0.3.8-0.20170215184714-bbae22007d5a/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  ## Example Usage
    14  
    15  ```
    16  # Create a new endpoint
    17  resource "aws_dms_endpoint" "test" {
    18    certificate_arn = "arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012"
    19    database_name = "test"
    20    endpoint_id = "test-dms-endpoint-tf"
    21    endpoint_type = "source"
    22    engine_name = "aurora"
    23    extra_connection_attributes = ""
    24    kms_key_arn = "arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012"
    25    password = "test"
    26    port = 3306
    27    server_name = "test"
    28    ssl_mode = "none"
    29    tags {
    30      Name = "test"
    31    }
    32    username = "test"
    33  }
    34  ```
    35  
    36  ## Argument Reference
    37  
    38  The following arguments are supported:
    39  
    40  * `certificate_arn` - (Optional, Default: empty string) The Amazon Resource Name (ARN) for the certificate.
    41  * `database_name` - (Optional) The name of the endpoint database.
    42  * `endpoint_id` - (Required) The database endpoint identifier.
    43  
    44      - Must contain from 1 to 255 alphanumeric characters or hyphens.
    45      - Must begin with a letter
    46      - Must contain only ASCII letters, digits, and hyphens
    47      - Must not end with a hyphen
    48      - Must not contain two consecutive hyphens
    49  
    50  * `endpoint_type` - (Required) The type of endpoint. Can be one of `source | target`.
    51  * `engine_name` - (Required) The type of engine for the endpoint. Can be one of `mysql | oracle | postgres | mariadb | aurora | redshift | sybase | sqlserver`.
    52  * `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).
    53  * `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.
    54  * `password` - (Required) The password to be used to login to the endpoint database.
    55  * `port` - (Required) The port used by the endpoint database.
    56  * `server_name` - (Required) The host name of the server.
    57  * `ssl_mode` - (Optional, Default: none) The SSL mode to use for the connection. Can be one of `none | require | verify-ca | verify-full`
    58  * `tags` - (Optional) A mapping of tags to assign to the resource.
    59  * `username` - (Required) The user name to be used to login to the endpoint database.
    60  
    61  ## Attributes Reference
    62  
    63  The following attributes are exported:
    64  
    65  * `endpoint_arn` - The Amazon Resource Name (ARN) for the endpoint.
    66  
    67  ## Import
    68  
    69  Endpoints can be imported using the `endpoint_id`, e.g.
    70  
    71  ```
    72  $ terraform import aws_dms_endpoint.test test-dms-endpoint-tf
    73  ```