amazonka-ec2-2.0: Amazon Elastic Compute Cloud SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.EC2.CreateDhcpOptions

Description

Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see RFC 2132.

  • domain-name-servers - The IP addresses of up to four domain name servers, or AmazonProvidedDNS. The default DHCP option set specifies AmazonProvidedDNS. If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas. To have your instance receive a custom DNS hostname as specified in domain-name, you must set domain-name-servers to a custom DNS server.
  • domain-name - 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, ExampleCompany.com). This value is used to complete unqualified DNS hostnames. Important: Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP options set is associated with a VPC that has instances with multiple operating systems, specify only one domain name.
  • ntp-servers - The IP addresses of up to four Network Time Protocol (NTP) servers.
  • netbios-name-servers - The IP addresses of up to four NetBIOS name servers.
  • netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2 (broadcast and multicast are not currently supported). For more information about these node types, see RFC 2132.

Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an internet gateway, make sure to set the domain-name-servers option either to AmazonProvidedDNS or to a domain name server of your choice. For more information, see DHCP options sets in the Amazon Virtual Private Cloud User Guide.

Synopsis

Creating a Request

data CreateDhcpOptions Source #

See: newCreateDhcpOptions smart constructor.

Constructors

CreateDhcpOptions' 

Fields

Instances

Instances details
ToHeaders CreateDhcpOptions Source # 
Instance details

Defined in Amazonka.EC2.CreateDhcpOptions

ToPath CreateDhcpOptions Source # 
Instance details

Defined in Amazonka.EC2.CreateDhcpOptions

ToQuery CreateDhcpOptions Source # 
Instance details

Defined in Amazonka.EC2.CreateDhcpOptions

AWSRequest CreateDhcpOptions Source # 
Instance details

Defined in Amazonka.EC2.CreateDhcpOptions

Associated Types

type AWSResponse CreateDhcpOptions #

Generic CreateDhcpOptions Source # 
Instance details

Defined in Amazonka.EC2.CreateDhcpOptions

Associated Types

type Rep CreateDhcpOptions :: Type -> Type #

Read CreateDhcpOptions Source # 
Instance details

Defined in Amazonka.EC2.CreateDhcpOptions

Show CreateDhcpOptions Source # 
Instance details

Defined in Amazonka.EC2.CreateDhcpOptions

NFData CreateDhcpOptions Source # 
Instance details

Defined in Amazonka.EC2.CreateDhcpOptions

Methods

rnf :: CreateDhcpOptions -> () #

Eq CreateDhcpOptions Source # 
Instance details

Defined in Amazonka.EC2.CreateDhcpOptions

Hashable CreateDhcpOptions Source # 
Instance details

Defined in Amazonka.EC2.CreateDhcpOptions

type AWSResponse CreateDhcpOptions Source # 
Instance details

Defined in Amazonka.EC2.CreateDhcpOptions

type Rep CreateDhcpOptions Source # 
Instance details

Defined in Amazonka.EC2.CreateDhcpOptions

type Rep CreateDhcpOptions = D1 ('MetaData "CreateDhcpOptions" "Amazonka.EC2.CreateDhcpOptions" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "CreateDhcpOptions'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "tagSpecifications") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TagSpecification])) :*: S1 ('MetaSel ('Just "dhcpConfigurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [NewDhcpConfiguration]))))

newCreateDhcpOptions :: CreateDhcpOptions Source #

Create a value of CreateDhcpOptions with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dryRun:CreateDhcpOptions', createDhcpOptions_dryRun - Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

CreateDhcpOptions, createDhcpOptions_tagSpecifications - The tags to assign to the DHCP option.

CreateDhcpOptions, createDhcpOptions_dhcpConfigurations - A DHCP configuration option.

Request Lenses

createDhcpOptions_dryRun :: Lens' CreateDhcpOptions (Maybe Bool) Source #

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Destructuring the Response

data CreateDhcpOptionsResponse Source #

See: newCreateDhcpOptionsResponse smart constructor.

Constructors

CreateDhcpOptionsResponse' 

Fields

Instances

Instances details
Generic CreateDhcpOptionsResponse Source # 
Instance details

Defined in Amazonka.EC2.CreateDhcpOptions

Associated Types

type Rep CreateDhcpOptionsResponse :: Type -> Type #

Read CreateDhcpOptionsResponse Source # 
Instance details

Defined in Amazonka.EC2.CreateDhcpOptions

Show CreateDhcpOptionsResponse Source # 
Instance details

Defined in Amazonka.EC2.CreateDhcpOptions

NFData CreateDhcpOptionsResponse Source # 
Instance details

Defined in Amazonka.EC2.CreateDhcpOptions

Eq CreateDhcpOptionsResponse Source # 
Instance details

Defined in Amazonka.EC2.CreateDhcpOptions

type Rep CreateDhcpOptionsResponse Source # 
Instance details

Defined in Amazonka.EC2.CreateDhcpOptions

type Rep CreateDhcpOptionsResponse = D1 ('MetaData "CreateDhcpOptionsResponse" "Amazonka.EC2.CreateDhcpOptions" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "CreateDhcpOptionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dhcpOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DhcpOptions)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateDhcpOptionsResponse Source #

Create a value of CreateDhcpOptionsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dhcpOptions:CreateDhcpOptionsResponse', createDhcpOptionsResponse_dhcpOptions - A set of DHCP options.

$sel:httpStatus:CreateDhcpOptionsResponse', createDhcpOptionsResponse_httpStatus - The response's http status code.

Response Lenses