メニュー
AWS CloudFormation
ユーザーガイド (API Version 2010-05-15)

AWS::EC2::DHCPOptions

VPC 用の DHCP オプションセットを作成します。

詳細については、Amazon EC2 API Referenceの「CreateDhcpOptions」を参照してください。

構文

AWS CloudFormation テンプレートでこのエンティティを宣言するには、次の構文を使用します。

JSON

Copy
{ "Type" : "AWS::EC2::DHCPOptions", "Properties" : { "DomainName" : String, "DomainNameServers" : [ String, ... ], "NetbiosNameServers" : [ String, ... ], "NetbiosNodeType" : Number, "NtpServers" : [ String, ... ], "Tags" : [ Resource Tag, ... ] } }

YAML

Copy
Type: "AWS::EC2::DHCPOptions" Properties: DomainName: String DomainNameServers: - 文字列 NetbiosNameServers: - 文字列 NetbiosNodeType: Number NtpServers: - 文字列 Tags: -Resource Tag

プロパティ

DomainName

任意のドメイン名。

必須: 条件による。「注意」を参照してください。

Type: String

更新に伴う要件: 置換

Example: "example.com"

DomainNameServers

ドメインネームサーバーの IP アドレス (IPv4)。最大で 4 個のアドレスを指定できます。

必須: 条件による。「注意」を参照してください。

Type: List of String values

更新に伴う要件: 置換

Example: "DomainNameServers" : [ "10.0.0.1", "10.0.0.2" ]

Example: IP アドレスの順序を維持するには、カンマの区切りのリストを単一の文字列として指定します。"DomainNameServers" : [ "10.0.0.1, 10.0.0.2" ]

NetbiosNameServers

NetBIOS ネームサーバーの IP アドレス (IPv4)。最大で 4 個のアドレスを指定できます。

必須: 条件による。「注意」を参照してください。

Type: List of String values

更新に伴う要件: 置換

Example: "NetbiosNameServers" : [ "10.0.0.1", "10.0.0.2" ]

Example: IP アドレスの順序を維持するには、カンマの区切りのリストを単一の文字列として指定します。"NetbiosNameServers" : [ "10.0.0.1, 10.0.0.2" ]

NetbiosNodeType

NetBIOS ノードタイプを示す整数値:

  • 1: ブロードキャスト ("B")

  • 2: ポイントツーポイント ("P")

  • 4: ミックスモード ("M")

  • 8: ハイブリッド ("H")

これらの値および NetBIOS ノードタイプの詳細については、RFC 2132RFC 1001、および RFC 1002 を参照してください。現時点では値 2 のみを使用することをお勧めします (ブロードキャストとマルチキャストは現在サポートされていません)。

Required: NetBiosNameServers を指定した場合は必須、それ以外の場合はオプション。

Type: List of numbers

更新に伴う要件: 置換

Example: "NetbiosNodeType" : 2

NtpServers

Network Time Protocol (NTP) サーバーの IP アドレス (IPv4)。最大で 4 個のアドレスを指定できます。

必須: 条件による。「注意」を参照してください。

Type: List of String values

更新に伴う要件: 置換

Example: "NtpServers" : [ "10.0.0.1" ]

Example: IP アドレスの順序を維持するには、カンマの区切りのリストを単一の文字列として指定します。"NtpServers" : [ "10.0.0.1, 10.0.0.2" ]

Tags

このリソースに対する任意のタグのセット (キーと値のペア)。

Required: No

Type: AWS CloudFormation Resource Tags

更新に伴う要件: 中断はありません。

条件付きプロパティ

次のプロパティを少なくとも 1 つ指定する必要があります。

この要件が満たされた後の残りのプロパティはオプションです。

NetbiosNameServers を指定する場合、NetbiosNodeType が必要です。

戻り値

参照番号

このリソースの論理 ID が Ref 組み込み関数に提供されると、Ref によりリソース名が返されます。

Ref 関数の使用方法の詳細については、「Ref」を参照してください。

JSON

Copy
{ "AWSTemplateFormatVersion" : "2010-09-09", "Resources" : { "myDhcpOptions" : { "Type" : "AWS::EC2::DHCPOptions", "Properties" : { "DomainName" : "example.com", "DomainNameServers" : [ "AmazonProvidedDNS" ], "NtpServers" : [ "10.2.5.1" ], "NetbiosNameServers" : [ "10.2.5.1" ], "NetbiosNodeType" : 2, "Tags" : [ { "Key" : "foo", "Value" : "bar" } ] } } } }

YAML

Copy
AWSTemplateFormatVersion: "2010-09-09" Resources: myDhcpOptions: Type: "AWS::EC2::DHCPOptions" Properties: DomainName: example.com DomainNameServers: - AmazonProvidedDNS NtpServers: - 10.2.5.1 NetbiosNameServers: - 10.2.5.1 NetbiosNodeType: 2 Tags: - Key: foo Value: bar

以下の資料も参照してください。

  • Amazon EC2 API Referenceの「CreateDhcpOptions

  • Amazon Elastic Compute Cloud ユーザーガイドの「タグの使用

  • RFC 2132 - DHCP Options and BOOTP Vendor Extensions、Network Working Group、1997 年

  • RFC 1001 - Protocol Standard for a NetBIOS Service on a TCP/UDP Transport: Concepts and Methods、Network Working Group、1987 年

  • RFC 1002 - Protocol Standard for a NetBIOS Service on a TCP/UDP Transport: Detailed Specifications、Network Working Group、1987 年