Oracle Cloud Infrastructure

v0.5.0 published on Monday, Sep 12, 2022 by Pulumi

DhcpOptions

This resource provides the Dhcp Options resource in Oracle Cloud Infrastructure Core service.

Creates a new set of DHCP options for the specified VCN. For more information, see DhcpOptions.

For the purposes of access control, you must provide the OCID of the compartment where you want the set of DHCP options to reside. Notice that the set of options doesn’t have to be in the same compartment as the VCN, subnets, or other Networking Service components. If you’re not sure which compartment to use, put the set of DHCP options in the same compartment as the VCN. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers.

You may optionally specify a display name for the set of DHCP options, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information.

For more information on configuring a VCN’s default DHCP options, see Managing Default VCN Resources

Create DhcpOptions Resource

new DhcpOptions(name: string, args: DhcpOptionsArgs, opts?: CustomResourceOptions);
@overload
def DhcpOptions(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                compartment_id: Optional[str] = None,
                defined_tags: Optional[Mapping[str, Any]] = None,
                display_name: Optional[str] = None,
                domain_name_type: Optional[str] = None,
                freeform_tags: Optional[Mapping[str, Any]] = None,
                options: Optional[Sequence[_core.DhcpOptionsOptionArgs]] = None,
                vcn_id: Optional[str] = None)
@overload
def DhcpOptions(resource_name: str,
                args: DhcpOptionsArgs,
                opts: Optional[ResourceOptions] = None)
func NewDhcpOptions(ctx *Context, name string, args DhcpOptionsArgs, opts ...ResourceOption) (*DhcpOptions, error)
public DhcpOptions(string name, DhcpOptionsArgs args, CustomResourceOptions? opts = null)
public DhcpOptions(String name, DhcpOptionsArgs args)
public DhcpOptions(String name, DhcpOptionsArgs args, CustomResourceOptions options)
type: oci:Core:DhcpOptions
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args DhcpOptionsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args DhcpOptionsArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args DhcpOptionsArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DhcpOptionsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args DhcpOptionsArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

DhcpOptions Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The DhcpOptions resource accepts the following input properties:

CompartmentId string

(Updatable) The OCID of the compartment to contain the set of DHCP options.

Options List<DhcpOptionsOptionArgs>

(Updatable) A set of DHCP options.

VcnId string

The OCID of the VCN the set of DHCP options belongs to.

DefinedTags Dictionary<string, object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

DisplayName string

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

DomainNameType string

(Updatable) The search domain name type of DHCP options

FreeformTags Dictionary<string, object>

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

CompartmentId string

(Updatable) The OCID of the compartment to contain the set of DHCP options.

Options []DhcpOptionsOptionArgs

(Updatable) A set of DHCP options.

VcnId string

The OCID of the VCN the set of DHCP options belongs to.

DefinedTags map[string]interface{}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

DisplayName string

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

DomainNameType string

(Updatable) The search domain name type of DHCP options

FreeformTags map[string]interface{}

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

compartmentId String

(Updatable) The OCID of the compartment to contain the set of DHCP options.

options List<DhcpOptionsOptionArgs>

(Updatable) A set of DHCP options.

vcnId String

The OCID of the VCN the set of DHCP options belongs to.

definedTags Map<String,Object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName String

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

domainNameType String

(Updatable) The search domain name type of DHCP options

freeformTags Map<String,Object>

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

compartmentId string

(Updatable) The OCID of the compartment to contain the set of DHCP options.

options DhcpOptionsOptionArgs[]

(Updatable) A set of DHCP options.

vcnId string

The OCID of the VCN the set of DHCP options belongs to.

definedTags {[key: string]: any}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName string

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

domainNameType string

(Updatable) The search domain name type of DHCP options

freeformTags {[key: string]: any}

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

compartment_id str

(Updatable) The OCID of the compartment to contain the set of DHCP options.

options DhcpOptionsOptionArgs]

(Updatable) A set of DHCP options.

vcn_id str

The OCID of the VCN the set of DHCP options belongs to.

defined_tags Mapping[str, Any]

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

display_name str

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

domain_name_type str

(Updatable) The search domain name type of DHCP options

freeform_tags Mapping[str, Any]

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

compartmentId String

(Updatable) The OCID of the compartment to contain the set of DHCP options.

options List<Property Map>

(Updatable) A set of DHCP options.

vcnId String

The OCID of the VCN the set of DHCP options belongs to.

definedTags Map<Any>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName String

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

domainNameType String

(Updatable) The search domain name type of DHCP options

freeformTags Map<Any>

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

Outputs

All input properties are implicitly available as output properties. Additionally, the DhcpOptions resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

State string

The current state of the set of DHCP options.

TimeCreated string

Date and time the set of DHCP options was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

Id string

The provider-assigned unique ID for this managed resource.

State string

The current state of the set of DHCP options.

TimeCreated string

Date and time the set of DHCP options was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

id String

The provider-assigned unique ID for this managed resource.

state String

The current state of the set of DHCP options.

timeCreated String

Date and time the set of DHCP options was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

id string

The provider-assigned unique ID for this managed resource.

state string

The current state of the set of DHCP options.

timeCreated string

Date and time the set of DHCP options was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

id str

The provider-assigned unique ID for this managed resource.

state str

The current state of the set of DHCP options.

time_created str

Date and time the set of DHCP options was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

id String

The provider-assigned unique ID for this managed resource.

state String

The current state of the set of DHCP options.

timeCreated String

Date and time the set of DHCP options was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

Look up Existing DhcpOptions Resource

Get an existing DhcpOptions resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: DhcpOptionsState, opts?: CustomResourceOptions): DhcpOptions
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, Any]] = None,
        display_name: Optional[str] = None,
        domain_name_type: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, Any]] = None,
        options: Optional[Sequence[_core.DhcpOptionsOptionArgs]] = None,
        state: Optional[str] = None,
        time_created: Optional[str] = None,
        vcn_id: Optional[str] = None) -> DhcpOptions
func GetDhcpOptions(ctx *Context, name string, id IDInput, state *DhcpOptionsState, opts ...ResourceOption) (*DhcpOptions, error)
public static DhcpOptions Get(string name, Input<string> id, DhcpOptionsState? state, CustomResourceOptions? opts = null)
public static DhcpOptions get(String name, Output<String> id, DhcpOptionsState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
CompartmentId string

(Updatable) The OCID of the compartment to contain the set of DHCP options.

DefinedTags Dictionary<string, object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

DisplayName string

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

DomainNameType string

(Updatable) The search domain name type of DHCP options

FreeformTags Dictionary<string, object>

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

Options List<DhcpOptionsOptionArgs>

(Updatable) A set of DHCP options.

State string

The current state of the set of DHCP options.

TimeCreated string

Date and time the set of DHCP options was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

VcnId string

The OCID of the VCN the set of DHCP options belongs to.

CompartmentId string

(Updatable) The OCID of the compartment to contain the set of DHCP options.

DefinedTags map[string]interface{}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

DisplayName string

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

DomainNameType string

(Updatable) The search domain name type of DHCP options

FreeformTags map[string]interface{}

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

Options []DhcpOptionsOptionArgs

(Updatable) A set of DHCP options.

State string

The current state of the set of DHCP options.

TimeCreated string

Date and time the set of DHCP options was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

VcnId string

The OCID of the VCN the set of DHCP options belongs to.

compartmentId String

(Updatable) The OCID of the compartment to contain the set of DHCP options.

definedTags Map<String,Object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName String

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

domainNameType String

(Updatable) The search domain name type of DHCP options

freeformTags Map<String,Object>

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

options List<DhcpOptionsOptionArgs>

(Updatable) A set of DHCP options.

state String

The current state of the set of DHCP options.

timeCreated String

Date and time the set of DHCP options was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

vcnId String

The OCID of the VCN the set of DHCP options belongs to.

compartmentId string

(Updatable) The OCID of the compartment to contain the set of DHCP options.

definedTags {[key: string]: any}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName string

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

domainNameType string

(Updatable) The search domain name type of DHCP options

freeformTags {[key: string]: any}

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

options DhcpOptionsOptionArgs[]

(Updatable) A set of DHCP options.

state string

The current state of the set of DHCP options.

timeCreated string

Date and time the set of DHCP options was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

vcnId string

The OCID of the VCN the set of DHCP options belongs to.

compartment_id str

(Updatable) The OCID of the compartment to contain the set of DHCP options.

defined_tags Mapping[str, Any]

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

display_name str

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

domain_name_type str

(Updatable) The search domain name type of DHCP options

freeform_tags Mapping[str, Any]

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

options DhcpOptionsOptionArgs]

(Updatable) A set of DHCP options.

state str

The current state of the set of DHCP options.

time_created str

Date and time the set of DHCP options was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

vcn_id str

The OCID of the VCN the set of DHCP options belongs to.

compartmentId String

(Updatable) The OCID of the compartment to contain the set of DHCP options.

definedTags Map<Any>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName String

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

domainNameType String

(Updatable) The search domain name type of DHCP options

freeformTags Map<Any>

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

options List<Property Map>

(Updatable) A set of DHCP options.

state String

The current state of the set of DHCP options.

timeCreated String

Date and time the set of DHCP options was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

vcnId String

The OCID of the VCN the set of DHCP options belongs to.

Supporting Types

DhcpOptionsOption

Type string

(Updatable) The specific DHCP option. Either DomainNameServer (for DhcpDnsOption) or SearchDomain (for DhcpSearchDomainOption).

CustomDnsServers List<string>

(Updatable) If you set serverType to CustomDnsServer, specify the IP address of at least one DNS server of your choice (three maximum).

SearchDomainNames List<string>

(Updatable) A single search domain name according to RFC 952 and RFC 1123. During a DNS query, the OS will append this search domain name to the value being queried.

ServerType string

(Updatable)

  • VcnLocal: Reserved for future use.
  • VcnLocalPlusInternet: Also referred to as "Internet and VCN Resolver". Instances can resolve internet hostnames (no internet gateway is required), and can resolve hostnames of instances in the VCN. This is the default value in the default set of DHCP options in the VCN. For the Internet and VCN Resolver to work across the VCN, there must also be a DNS label set for the VCN, a DNS label set for each subnet, and a hostname for each instance. The Internet and VCN Resolver also enables reverse DNS lookup, which lets you determine the hostname corresponding to the private IP address. For more information, see DNS in Your Virtual Cloud Network.
  • CustomDnsServer: Instances use a DNS server of your choice (three maximum).
Type string

(Updatable) The specific DHCP option. Either DomainNameServer (for DhcpDnsOption) or SearchDomain (for DhcpSearchDomainOption).

CustomDnsServers []string

(Updatable) If you set serverType to CustomDnsServer, specify the IP address of at least one DNS server of your choice (three maximum).

SearchDomainNames []string

(Updatable) A single search domain name according to RFC 952 and RFC 1123. During a DNS query, the OS will append this search domain name to the value being queried.

ServerType string

(Updatable)

  • VcnLocal: Reserved for future use.
  • VcnLocalPlusInternet: Also referred to as "Internet and VCN Resolver". Instances can resolve internet hostnames (no internet gateway is required), and can resolve hostnames of instances in the VCN. This is the default value in the default set of DHCP options in the VCN. For the Internet and VCN Resolver to work across the VCN, there must also be a DNS label set for the VCN, a DNS label set for each subnet, and a hostname for each instance. The Internet and VCN Resolver also enables reverse DNS lookup, which lets you determine the hostname corresponding to the private IP address. For more information, see DNS in Your Virtual Cloud Network.
  • CustomDnsServer: Instances use a DNS server of your choice (three maximum).
type String

(Updatable) The specific DHCP option. Either DomainNameServer (for DhcpDnsOption) or SearchDomain (for DhcpSearchDomainOption).

customDnsServers List<String>

(Updatable) If you set serverType to CustomDnsServer, specify the IP address of at least one DNS server of your choice (three maximum).

searchDomainNames List<String>

(Updatable) A single search domain name according to RFC 952 and RFC 1123. During a DNS query, the OS will append this search domain name to the value being queried.

serverType String

(Updatable)

  • VcnLocal: Reserved for future use.
  • VcnLocalPlusInternet: Also referred to as "Internet and VCN Resolver". Instances can resolve internet hostnames (no internet gateway is required), and can resolve hostnames of instances in the VCN. This is the default value in the default set of DHCP options in the VCN. For the Internet and VCN Resolver to work across the VCN, there must also be a DNS label set for the VCN, a DNS label set for each subnet, and a hostname for each instance. The Internet and VCN Resolver also enables reverse DNS lookup, which lets you determine the hostname corresponding to the private IP address. For more information, see DNS in Your Virtual Cloud Network.
  • CustomDnsServer: Instances use a DNS server of your choice (three maximum).
type string

(Updatable) The specific DHCP option. Either DomainNameServer (for DhcpDnsOption) or SearchDomain (for DhcpSearchDomainOption).

customDnsServers string[]

(Updatable) If you set serverType to CustomDnsServer, specify the IP address of at least one DNS server of your choice (three maximum).

searchDomainNames string[]

(Updatable) A single search domain name according to RFC 952 and RFC 1123. During a DNS query, the OS will append this search domain name to the value being queried.

serverType string

(Updatable)

  • VcnLocal: Reserved for future use.
  • VcnLocalPlusInternet: Also referred to as "Internet and VCN Resolver". Instances can resolve internet hostnames (no internet gateway is required), and can resolve hostnames of instances in the VCN. This is the default value in the default set of DHCP options in the VCN. For the Internet and VCN Resolver to work across the VCN, there must also be a DNS label set for the VCN, a DNS label set for each subnet, and a hostname for each instance. The Internet and VCN Resolver also enables reverse DNS lookup, which lets you determine the hostname corresponding to the private IP address. For more information, see DNS in Your Virtual Cloud Network.
  • CustomDnsServer: Instances use a DNS server of your choice (three maximum).
type str

(Updatable) The specific DHCP option. Either DomainNameServer (for DhcpDnsOption) or SearchDomain (for DhcpSearchDomainOption).

custom_dns_servers Sequence[str]

(Updatable) If you set serverType to CustomDnsServer, specify the IP address of at least one DNS server of your choice (three maximum).

search_domain_names Sequence[str]

(Updatable) A single search domain name according to RFC 952 and RFC 1123. During a DNS query, the OS will append this search domain name to the value being queried.

server_type str

(Updatable)

  • VcnLocal: Reserved for future use.
  • VcnLocalPlusInternet: Also referred to as "Internet and VCN Resolver". Instances can resolve internet hostnames (no internet gateway is required), and can resolve hostnames of instances in the VCN. This is the default value in the default set of DHCP options in the VCN. For the Internet and VCN Resolver to work across the VCN, there must also be a DNS label set for the VCN, a DNS label set for each subnet, and a hostname for each instance. The Internet and VCN Resolver also enables reverse DNS lookup, which lets you determine the hostname corresponding to the private IP address. For more information, see DNS in Your Virtual Cloud Network.
  • CustomDnsServer: Instances use a DNS server of your choice (three maximum).
type String

(Updatable) The specific DHCP option. Either DomainNameServer (for DhcpDnsOption) or SearchDomain (for DhcpSearchDomainOption).

customDnsServers List<String>

(Updatable) If you set serverType to CustomDnsServer, specify the IP address of at least one DNS server of your choice (three maximum).

searchDomainNames List<String>

(Updatable) A single search domain name according to RFC 952 and RFC 1123. During a DNS query, the OS will append this search domain name to the value being queried.

serverType String

(Updatable)

  • VcnLocal: Reserved for future use.
  • VcnLocalPlusInternet: Also referred to as "Internet and VCN Resolver". Instances can resolve internet hostnames (no internet gateway is required), and can resolve hostnames of instances in the VCN. This is the default value in the default set of DHCP options in the VCN. For the Internet and VCN Resolver to work across the VCN, there must also be a DNS label set for the VCN, a DNS label set for each subnet, and a hostname for each instance. The Internet and VCN Resolver also enables reverse DNS lookup, which lets you determine the hostname corresponding to the private IP address. For more information, see DNS in Your Virtual Cloud Network.
  • CustomDnsServer: Instances use a DNS server of your choice (three maximum).

Import

DhcpOptions can be imported using the id, e.g.

 $ pulumi import oci:Core/dhcpOptions:DhcpOptions test_dhcp_options "id"

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.