Class CfnDHCPOptions
A CloudFormation AWS::EC2::DHCPOptions
.
Inherited Members
Namespace: Amazon.CDK.AWS.EC2
Assembly: Amazon.CDK.AWS.EC2.dll
Syntax (csharp)
public class CfnDHCPOptions : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnDHCPOptions
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Specifies a set of DHCP options for your VPC.
You must specify at least one of the following properties: DomainNameServers
, NetbiosNameServers
, NtpServers
. If you specify NetbiosNameServers
, you must specify NetbiosNodeType
.
CloudformationResource: AWS::EC2::DHCPOptions
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-dhcpoptions.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.EC2;
var cfnDHCPOptions = new CfnDHCPOptions(this, "MyCfnDHCPOptions", new CfnDHCPOptionsProps {
DomainName = "domainName",
DomainNameServers = new [] { "domainNameServers" },
NetbiosNameServers = new [] { "netbiosNameServers" },
NetbiosNodeType = 123,
NtpServers = new [] { "ntpServers" },
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnDHCPOptions(Construct, String, ICfnDHCPOptionsProps) | Create a new |
CfnDHCPOptions(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnDHCPOptions(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrDhcpOptionsId | The ID of the DHCP options set. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DomainName | This value is used to complete unqualified DNS hostnames. |
DomainNameServers | The IPv4 addresses of up to four domain name servers, or |
NetbiosNameServers | The IPv4 addresses of up to four NetBIOS name servers. |
NetbiosNodeType | The NetBIOS node type (1, 2, 4, or 8). |
NtpServers | The IPv4 addresses of up to four Network Time Protocol (NTP) servers. |
Tags | Any tags assigned to the DHCP options set. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDHCPOptions(Construct, String, ICfnDHCPOptionsProps)
Create a new AWS::EC2::DHCPOptions
.
public CfnDHCPOptions(Construct scope, string id, ICfnDHCPOptionsProps props = null)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnDHCPOptionsProps
- resource properties.
CfnDHCPOptions(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDHCPOptions(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnDHCPOptions(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDHCPOptions(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrDhcpOptionsId
The ID of the DHCP options set.
public virtual string AttrDhcpOptionsId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: DhcpOptionsId
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DomainName
This value is used to complete unqualified DNS hostnames.
public virtual string DomainName { get; set; }
Property Value
System.String
Remarks
If you're using AmazonProvidedDNS in us-east-1
, specify ec2.internal
. If you're using AmazonProvidedDNS in another Region, specify region . compute.internal
(for example, ap-northeast-1.compute.internal
). Otherwise, specify a domain name (for example, MyCompany.com ).
DomainNameServers
The IPv4 addresses of up to four domain name servers, or AmazonProvidedDNS
.
public virtual string[] DomainNameServers { get; set; }
Property Value
System.String[]
Remarks
The default is AmazonProvidedDNS
. To have your instance receive a custom DNS hostname as specified in DomainName
, you must set this property to a custom DNS server.
NetbiosNameServers
The IPv4 addresses of up to four NetBIOS name servers.
public virtual string[] NetbiosNameServers { get; set; }
Property Value
System.String[]
Remarks
NetbiosNodeType
The NetBIOS node type (1, 2, 4, or 8).
public virtual Nullable<double> NetbiosNodeType { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
We recommend that you specify 2 (broadcast and multicast are not currently supported).
NtpServers
The IPv4 addresses of up to four Network Time Protocol (NTP) servers.
public virtual string[] NtpServers { get; set; }
Property Value
System.String[]
Remarks
Tags
Any tags assigned to the DHCP options set.
public virtual TagManager Tags { get; }
Property Value
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>