Skip to content

Commit

Permalink
Merge pull request #61 from DataChefHQ/60-allow-clients-to-easily-use…
Browse files Browse the repository at this point in the history
…-the-ssm-parameters-without-looking-the-format-up-in-the-glossary

feat: added data landing zone client to ease access of ssm parameters
  • Loading branch information
Warrenn authored Oct 29, 2024
2 parents 35e01c8 + 3f89f51 commit 166db1b
Show file tree
Hide file tree
Showing 8 changed files with 1,430 additions and 207 deletions.
447 changes: 447 additions & 0 deletions API.md

Large diffs are not rendered by default.

16 changes: 16 additions & 0 deletions docs/rough-docs/ssm-parameters-glossary/ssm-parameters-glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

## `/dlz/networking-entity/bastion/${bastion.name}/security-group/id`

**Scope:** External

The security group ID of the bastion host [link](../bastion-hosts/bastion-hosts.md).

- **bastion.name** - The name of the bastion host. Property is optional, but if not provided, it will default to `default`.
Expand All @@ -10,6 +12,8 @@ The security group ID of the bastion host [link](../bastion-hosts/bastion-hosts.

## `/dlz/networking-entity/vpc/${vpcAddress}/id`

**Scope:** External

The VPC ID of the VPC.

- **vpcAddress** - The address of the VPC.
Expand All @@ -18,6 +22,8 @@ The VPC ID of the VPC.

## `/dlz/networking-entity/vpc/${routeTableAddress}/id`

**Scope:** External

The route table ID of the route table.

- **routeTableAddress** - The address of the route table.
Expand All @@ -26,6 +32,8 @@ The route table ID of the route table.

## `/dlz/networking-entity/vpc/${subnetAddress}/id`

**Scope:** External

The subnet ID of the subnet.

- **subnetAddress** - The address of the subnet.
Expand All @@ -34,18 +42,24 @@ The subnet ID of the subnet.

## `/dlz/sns/default-notification/arn`

**Scope:** External

The ARN of the default notification topic.

---

## `/dlz/iam/permission-boundary-policy/arn`

**Scope:** External

The ARN of the permission boundary policy.

---

## `/dlz/networking/vpc-peering-role-arn--${vpcPeeringRolesKey}`

**Scope:** Internal

The ARN of the VPC peering role.

- **vpcPeeringRolesKey** - The key used to identify the VPC peering role.
Expand All @@ -54,6 +68,8 @@ The ARN of the VPC peering role.

## `/dlz/networking-entity/vpc/${fromVpc.address}/peer/${toVpc.address}/id`

**Scope:** Internal

The ID of the VPC peering connection.

- **fromVpc.address** - The address of the source VPC.
Expand Down
Loading

0 comments on commit 166db1b

Please sign in to comment.