aws-dms-replication-instance/README.yaml at main · cloudposse-terraform-components/aws-dms-replication-instance · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
name: "aws-dms-replication-instance"
# Canonical GitHub repo
github_repo: "cloudposse-terraform-components/aws-dms-replication-instance"
# Short description of this project
description: |-
  This component provisions DMS replication instances.
# Usage examples and guidance
usage: |-
  **Stack Level**: Regional

  Here are some example snippets for how to use this component:

  ```yaml
  components:
    terraform:
      dms/replication-instance/defaults:
        metadata:
          type: abstract
        settings:
          spacelift:
            workspace_enabled: true
            autodeploy: false
        vars:
          enabled: true
          allocated_storage: 50
          apply_immediately: true
          auto_minor_version_upgrade: true
          allow_major_version_upgrade: false
          availability_zone: null
          engine_version: "3.4"
          multi_az: false
          preferred_maintenance_window: "sun:10:30-sun:14:30"
          publicly_accessible: false

      dms-replication-instance-t2-small:
        metadata:
          component: dms/replication-instance
          inherits:
            - dms/replication-instance/defaults
        vars:
          # Replication instance name must start with a letter, only contain alphanumeric characters and hyphens
          name: "t2-small"
          replication_instance_class: "dms.t2.small"
          allocated_storage: 50
  ```

  <!-- prettier-ignore-start -->
  <!-- prettier-ignore-end -->
# External references for this component
references:
  - name: cloudposse-terraform-components
    url: https://github.com/orgs/cloudposse-terraform-components/repositories
    description: Cloud Posse's upstream component
tags:
  - component/dms/replication-instance
  - layer/unassigned
  - provider/aws
# Categories of this project
categories:
  - component/dms/replication-instance
  - layer/unassigned
  - provider/aws
# License of this project
license: "APACHE2"
# Badges to display
badges:
  - name: Latest Release
    image: https://img.shields.io/github/release/cloudposse-terraform-components/aws-dms-replication-instance.svg?style=for-the-badge
    url: https://github.com/cloudposse-terraform-components/aws-dms-replication-instance/releases/latest
  - name: Slack Community
    image: https://slack.cloudposse.com/for-the-badge.svg
    url: https://slack.cloudposse.com
related:
  - name: "Cloud Posse Terraform Modules"
    description: Our collection of reusable Terraform modules used by our reference architectures.
    url: "https://docs.cloudposse.com/modules/"
  - name: "Atmos"
    description: "Atmos is like docker-compose but for your infrastructure"
    url: "https://atmos.tools"
contributors: [] # If included generates contribs