Skip to content

EC2  >  Operations  >  modify_private_dns_name_options

modify_private_dns_name_options

Operation

modify_private_dns_name_options async

modify_private_dns_name_options(request: ModifyPrivateDnsNameOptionsInput | ModifyPrivateDnsNameOptionsInputDict, /, *, plugins: list[Plugin] | None = None) -> ModifyPrivateDnsNameOptionsOutput
modify_private_dns_name_options(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[ModifyPrivateDnsNameOptionsInputDict]) -> ModifyPrivateDnsNameOptionsOutput

Modifies the options for instance hostnames for the specified instance.

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
ModifyPrivateDnsNameOptionsOutput

An instance of ModifyPrivateDnsNameOptionsOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

ModifyPrivateDnsNameOptionsInput dataclass

Bases: _SerdeShape

Dataclass for ModifyPrivateDnsNameOptionsInput structure.

Attributes
dry_run class-attribute instance-attribute
dry_run: bool | None = ...

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.

enable_resource_name_dns_a_record class-attribute instance-attribute
enable_resource_name_dns_a_record: bool | None = ...

Indicates whether to respond to DNS queries for instance hostnames with DNS A records.

enable_resource_name_dns_aaaa_record class-attribute instance-attribute
enable_resource_name_dns_aaaa_record: bool | None = ...

Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.

instance_id class-attribute instance-attribute
instance_id: str | None = ...

The ID of the instance.

private_dns_hostname_type class-attribute instance-attribute
private_dns_hostname_type: str | None = ...

The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID.

Dictionaries

ModifyPrivateDnsNameOptionsInputDict

Bases: TypedDict

Dictionary form of ModifyPrivateDnsNameOptionsInput.

Attributes
dry_run instance-attribute
dry_run: bool | None

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.

enable_resource_name_dns_a_record instance-attribute
enable_resource_name_dns_a_record: bool | None

Indicates whether to respond to DNS queries for instance hostnames with DNS A records.

enable_resource_name_dns_aaaa_record instance-attribute
enable_resource_name_dns_aaaa_record: bool | None

Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.

instance_id instance-attribute
instance_id: Required[str]

The ID of the instance.

private_dns_hostname_type instance-attribute
private_dns_hostname_type: str | None

The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID.

Output

ModifyPrivateDnsNameOptionsOutput dataclass

Bases: _SerdeShape

Dataclass for ModifyPrivateDnsNameOptionsOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

return_ class-attribute instance-attribute
return_: bool | None = ...

Returns true if the request succeeds; otherwise, it returns an error.