Fugue.AWS.EC2.DhcpOptions

This is the preferred interface for making DHCP Options resources with Fugue. If you want to manage DHCP Options with Fugue, the new function is the right place to start.

Module Members

defaultForRegion

(Function)

Construct a default DhcpOptions value for a region.

The default DhcpOptions will enable Amazon provided DNS and the default AWS domain of “ec2.internal” for us-east-1 or “region.compute.internal” for all other regions.

Type Signature

 fun (Region) -> DhcpOptions
Argument: region

The region to create the DhcpOptions for.

Type: Region

Returns:

A DhcpOptions value configured with default DNS settings appropriate for region.

Type: DhcpOptions

defaultForRegionWithTags

(Function)

Construct a default DhcpOptions value for a region with tags.

The default DhcpOptions will enable Amazon provided DNS and the default AWS domain of “ec2.internal” for us-east-1 or “region.compute.internal” for all other regions.

Type Signature

 fun { region: Region,
       tags: Optional<List<Tag>> } -> DhcpOptions
Argument: region

The region to create the DhcpOptions for.

Type: Region

Argument: tags

The optional list of tags to apply to the DhcpOptions.

Type: Optional<List<Tag>>

Returns:

A DhcpOptions value configured with default DNS settings appropriate for region.

Type: DhcpOptions

equal

(Function)

DEPRECATED This function is deprecated. Use == instead.

Type Signature

 fun (DhcpOptions, DhcpOptions) -> Bool
Argument: this
Type: DhcpOptions
Argument: that
Type: DhcpOptions
Returns:
Type: Bool

external

(Function)

Create a reference to an externally managed DHCP Options.

Example usage:

dhcp: EC2.DhcpOptions.external("dopt-1234abcd", AWS.Us-east-1)

Type Signature

 fun (String, Region) -> DhcpOptions
Argument: dhcpOptionsId
Type: String
Argument: region

The Region containing the target DHCP Options.

Type: Region

Returns:

A reference to the specified DHCP Options.

Type: DhcpOptions

new

(Function)

new DHCP Options (Constructor)

Call this constructor to create a new Fugue.Core.AWS.EC2.DhcpOptions value.

Type Signature

 fun { tags: Optional<List<Tag>>,
       domainNameServers: Optional<List<String>>,
       domainName: Optional<String>,
       ntpServers: Optional<List<String>>,
       netBiosNameServers: Optional<List<String>>,
       netBiosNodeType: Optional<NetBiosNodeType>,
       region: Region} -> DhcpOptions
Argument: tags

Key-value pair tags to apply to the DHCP Options set. *Mutable.

Type: Optional<List<Tag>>

Argument: domainNameServers

The IP (IPv4) address of a domain name server. You can specify up to four addresses.

Type: Optional<List<String>>

Argument: domainName

A domain name of your choice.

Type: Optional<String>

Argument: ntpServers

The IP address (IPv4) of a Network Time Protocol (NTP) server. You can specify up to four addresses.

Type: Optional<List<String>>

Argument: netBiosNameServers
Type: Optional<List<String>>
Argument: netBiosNodeType
Type: Optional<NetBiosNodeType>
Argument: region
Type: Region
Returns:

A Fugue.Core.AWS.EC2.DhcpOptions value.

Type: DhcpOptions

Spec

(Type)

type Spec:
  tags: Optional<List<Tag>>
  domainNameServers: Optional<List<String>>
  domainName: Optional<String>
  ntpServers: Optional<List<String>>
  netBiosNameServers: Optional<List<String>>
  netBiosNodeType: Optional<NetBiosNodeType>
  region: Region

DEPRECATED Please use named arguments in the new constructor instead.

DHCP Options Specification (Resource)

Example usage:

mvc-dhcp-options: EC2.DhcpOptions.new {
  tags: [mvc-app-tag],
  domainNameServers: ["5.5.5.5"],
  domainName: "fugue.co",
  ntpServers: ["6.6.6.6"],
  netBiosNameServers: ["7.7.7.7"],
  netBiosNodeType: EC2.MNode,
  region: AWS.Us-west-2
}

Record {

Field: tags

Key-value pair tags to apply to the DHCP Options set.

Type: Optional<List<Tag>>

Field: domainNameServers

The IP (IPv4) address of a domain name server. You can specify up to four addresses.

Type: Optional<List<String>>

Field: domainName

A domain name of your choice.

Type: Optional<String>

Field: ntpServers

The IP address (IPv4) of a Network Time Protocol (NTP) server. You can specify up to four addresses.

Type: Optional<List<String>>

Field: netBiosNameServers
Type: Optional<List<String>>
Field: netBiosNodeType
Type: Optional<NetBiosNodeType>
Field: region
Type: Region

}

default

(Value)

default:
  tags: None
  domainNameServers: None
  domainName: None
  ntpServers: None
  netBiosNameServers: None
  netBiosNodeType: None

DEPRECATED Please use named arguments in the new constructor instead.

DHCP Options Specification (Default Values)