Amazon Elastic Compute Cloud
API Reference (API Version 2014-10-01)
Did this page help you?  Yes | No |  Tell us about it...
« PreviousNext »
View the PDF for this guide.Go to the AWS Discussion Forum for this product.

AssociateDhcpOptions

Description

Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC.

After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.

For more information, see DHCP Options Sets in the Amazon VPC User Guide.

Request Parameters

For information about the common parameters that all actions use, see Common Query Parameters.

DhcpOptionsId

The ID of the DHCP options set, or default to associate no DHCP options with the VPC.

Type: String

Default: None

Required: Yes

VpcId

The ID of the VPC.

Type: String

Default: None

Required: Yes

Response Elements

The following elements are returned in an AssociateDhcpOptionsResponse element.

requestId

The ID of the request.

Type: xsd:string

return

Returns true if the request succeeds. Otherwise, returns an error.

Type: xsd:boolean

Errors

The following are some of the client API errors you might encounter when using this request. For more information about common API errors, see Common Causes of Client Errors. For a summary of API error codes, see Client Error Codes.

Examples

Example Request

This example request associates the DHCP options with the ID dopt-7a8b9c2d with the VPC with the ID vpc-1a2b3c4d.

https://ec2.amazonaws.com/?Action=AssociateDhcpOptions 
&DhcpOptionsId=dopt-7a8b9c2d
&VpcId=vpc-1a2b3c4d
&AUTHPARAMS

Example Response

<AssociateDhcpOptionsResponse xmlns="http://ec2.amazonaws.com/doc/2014-10-01/">
   <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>
   <return>true</return> 
</AssociateDhcpOptionsResponse>

Example Request

This example request changes the VPC with the ID vpc-1a2b3c4d to have no associated DHCP options set.

https://ec2.amazonaws.com/?Action=AssociateDhcpOptions 
&DhcpOptionsId=default
&VpcId=vpc-1a2b3c4d
&AUTHPARAMS

Example Response

<AssociateDhcpOptionsResponse xmlns="http://ec2.amazonaws.com/doc/2014-10-01/">
   <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>
   <return>true</return> 
</AssociateDhcpOptionsResponse>