Fugue.AWS.RDS.DBSubnetGroup

Module Members

external

(Function)

Create a reference to an externally managed DBSubnetGroup.

Example usage:

dbsubnets: RDS.DBSubnetGroup.external("test-sn-group", AWS.Us-east-1)

Type Signature

 fun (String, Region) -> DBSubnetGroup
Argument: name

The name of the target DBSubnetGroup.

Type: String

Argument: region

The Region containing the target DBSubnetGroup.

Type: Region

Returns:

A reference to the specified DBSubnetGroup.

Type: DBSubnetGroup

new

(Function)

Create a new DBSubnetGroup.

Example:

import Fugue.AWS as AWS
import Fugue.AWS.Pattern.Network as Network
import Fugue.AWS.RDS as RDS

net: Network.new {
  name: "EXAMPLE",
  cidr: "10.42.0.0/16",
  region: AWS.Us-east-1,
  publicSubnets: [
    (AWS.B, "10.42.12.0/24"),
    (AWS.C, "10.42.13.0/24")
  ],
  privateSubnets: [
    (AWS.B, "10.42.22.0/24"),
    (AWS.C, "10.42.23.0/24")
  ]
}

dbSubnetGroup: RDS.DBSubnetGroup.new {
  name: "private",
  description: "private subnets",
  subnets: net.privateSubnets,
  tags: [AWS.Tag {key: "network", value: "private"}]
}

Type Signature

 fun { name: String,
       description: String,
       subnets: List<Subnet>,
       tags: Optional<List<Tag>>,
       resourceId: Optional<String> } -> DBSubnetGroup
Argument: name

The name of the DBSubnetGroup. Must be a lowercase string of a maximum of 255 alphanumeric characters. The following characters may not be used: ., _, [space], and -. Cannot be "default".

Type: String

Argument: description

The description of the DBSubnetGroup. Mutable.

Type: String

Argument: subnets

The list of subnets to include. Must contain subnets in two availability zones of the region. Mutable.

Type: List<Subnet>

Argument: tags

An optional list of tags to apply to the DBSubnetGroup. Mutable.

Type: Optional<List<Tag>>

Argument: resourceId

Resource ID of the resource to import with Fugue Import. This field is only honored on fugue run. The resource ID is the ARN. Mutable. Example: arn:aws:rds:us-east-1:123456789012:subgrp:prod-subgrp1

Type: Optional<String>

Returns:

The DBSubnetGroup.

Type: DBSubnetGroup

region

(Function)

Retrieve the region from an subnet group value.

Works for subnet group defined in the composition as well external values.

Type Signature

 fun (DBSubnetGroup) -> Region
Argument: dbSubnetGroup
Type: DBSubnetGroup
Returns:

The region containing the subnet group.

Type: Region

Spec

(Type)

type Spec:
  name: String
  description: String
  subnets: List<Subnet>
  tags: Optional<List<Tag>>

Record {

Field: name

The name of the DBSubnetGroup. Must be a lowercase string of a maximum of 255 alphanumeric characters. The following characters may not be used: ., _, [space], and -. Cannot be "default".

Type: String

Field: description

The description of the DBSubnetGroup. Mutable.

Type: String

Field: subnets

The list of subnets to include. Must contain subnets in two availability zones of the region. Mutable.

Type: List<Subnet>

Field: tags

An optional list of tags to apply to the DBSubnetGroup. Mutable.

Type: Optional<List<Tag>>

}

default

(Value)

default:
  tags: None

Defaults for RDS DBSubnetGroups.

  • tags: None, meaning no tags are applied.