Struct aws_sdk_route53resolver::types::ResolverEndpoint

#[non_exhaustive]
pub struct ResolverEndpoint {

    pub id: Option<String>,
    pub creator_request_id: Option<String>,
    pub arn: Option<String>,
    pub name: Option<String>,
    pub security_group_ids: Option<Vec<String>>,
    pub direction: Option<ResolverEndpointDirection>,
    pub ip_address_count: Option<i32>,
    pub host_vpc_id: Option<String>,
    pub status: Option<ResolverEndpointStatus>,
    pub status_message: Option<String>,
    pub creation_time: Option<String>,
    pub modification_time: Option<String>,
    pub outpost_arn: Option<String>,
    pub preferred_instance_type: Option<String>,
    pub resolver_endpoint_type: Option<ResolverEndpointType>,
    pub protocols: Option<Vec<Protocol>>,
}

In the response to a CreateResolverEndpoint, DeleteResolverEndpoint, GetResolverEndpoint, Updates the name, or ResolverEndpointType for an endpoint, or UpdateResolverEndpoint request, a complex type that contains settings for an existing inbound or outbound Resolver endpoint.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: Option<String>

The ID of the Resolver endpoint.

creator_request_id: Option<String>

A unique string that identifies the request that created the Resolver endpoint. The CreatorRequestId allows failed requests to be retried without the risk of running the operation twice.

arn: Option<String>

The ARN (Amazon Resource Name) for the Resolver endpoint.

name: Option<String>

The name that you assigned to the Resolver endpoint when you submitted a CreateResolverEndpoint request.

security_group_ids: Option<Vec<String>>

The ID of one or more security groups that control access to this VPC. The security group must include one or more inbound rules (for inbound endpoints) or outbound rules (for outbound endpoints). Inbound and outbound rules must allow TCP and UDP access. For inbound access, open port 53. For outbound access, open the port that you're using for DNS queries on your network.

direction: Option<ResolverEndpointDirection>

Indicates whether the Resolver endpoint allows inbound or outbound DNS queries:

• INBOUND: allows DNS queries to your VPC from your network

• OUTBOUND: allows DNS queries from your VPC to your network

ip_address_count: Option<i32>

The number of IP addresses that the Resolver endpoint can use for DNS queries.

host_vpc_id: Option<String>

The ID of the VPC that you want to create the Resolver endpoint in.

status: Option<ResolverEndpointStatus>

A code that specifies the current status of the Resolver endpoint. Valid values include the following:

• CREATING: Resolver is creating and configuring one or more Amazon VPC network interfaces for this endpoint.

• OPERATIONAL: The Amazon VPC network interfaces for this endpoint are correctly configured and able to pass inbound or outbound DNS queries between your network and Resolver.

• UPDATING: Resolver is associating or disassociating one or more network interfaces with this endpoint.

• AUTO_RECOVERING: Resolver is trying to recover one or more of the network interfaces that are associated with this endpoint. During the recovery process, the endpoint functions with limited capacity because of the limit on the number of DNS queries per IP address (per network interface). For the current limit, see Limits on Route 53 Resolver.

• ACTION_NEEDED: This endpoint is unhealthy, and Resolver can't automatically recover it. To resolve the problem, we recommend that you check each IP address that you associated with the endpoint. For each IP address that isn't available, add another IP address and then delete the IP address that isn't available. (An endpoint must always include at least two IP addresses.) A status of ACTION_NEEDED can have a variety of causes. Here are two common causes:

  • One or more of the network interfaces that are associated with the endpoint were deleted using Amazon VPC.

  • The network interface couldn't be created for some reason that's outside the control of Resolver.

• DELETING: Resolver is deleting this endpoint and the associated network interfaces.

status_message: Option<String>

A detailed description of the status of the Resolver endpoint.

creation_time: Option<String>

The date and time that the endpoint was created, in Unix time format and Coordinated Universal Time (UTC).

modification_time: Option<String>

The date and time that the endpoint was last modified, in Unix time format and Coordinated Universal Time (UTC).

outpost_arn: Option<String>

The ARN (Amazon Resource Name) for the Outpost.

preferred_instance_type: Option<String>

The Amazon EC2 instance type.

resolver_endpoint_type: Option<ResolverEndpointType>

The Resolver endpoint IP address type.

protocols: Option<Vec<Protocol>>

Protocols used for the endpoint. DoH-FIPS is applicable for inbound endpoints only.

For an inbound endpoint you can apply the protocols as follows:

• Do53 and DoH in combination.

• Do53 and DoH-FIPS in combination.

• Do53 alone.

• DoH alone.

• DoH-FIPS alone.

• None, which is treated as Do53.

For an outbound endpoint you can apply the protocols as follows:

• Do53 and DoH in combination.

• Do53 alone.

• DoH alone.

• None, which is treated as Do53.

Implementations

impl ResolverEndpoint

pub fn id(&self) -> Option<&str>

The ID of the Resolver endpoint.

pub fn creator_request_id(&self) -> Option<&str>

A unique string that identifies the request that created the Resolver endpoint. The CreatorRequestId allows failed requests to be retried without the risk of running the operation twice.

pub fn arn(&self) -> Option<&str>

The ARN (Amazon Resource Name) for the Resolver endpoint.

pub fn name(&self) -> Option<&str>

The name that you assigned to the Resolver endpoint when you submitted a CreateResolverEndpoint request.

pub fn security_group_ids(&self) -> &[String]

The ID of one or more security groups that control access to this VPC. The security group must include one or more inbound rules (for inbound endpoints) or outbound rules (for outbound endpoints). Inbound and outbound rules must allow TCP and UDP access. For inbound access, open port 53. For outbound access, open the port that you're using for DNS queries on your network.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .security_group_ids.is_none().

pub fn direction(&self) -> Option<&ResolverEndpointDirection>

Indicates whether the Resolver endpoint allows inbound or outbound DNS queries:

• INBOUND: allows DNS queries to your VPC from your network

• OUTBOUND: allows DNS queries from your VPC to your network

pub fn ip_address_count(&self) -> Option<i32>

The number of IP addresses that the Resolver endpoint can use for DNS queries.

pub fn host_vpc_id(&self) -> Option<&str>

The ID of the VPC that you want to create the Resolver endpoint in.

pub fn status(&self) -> Option<&ResolverEndpointStatus>

A code that specifies the current status of the Resolver endpoint. Valid values include the following:

• CREATING: Resolver is creating and configuring one or more Amazon VPC network interfaces for this endpoint.

• OPERATIONAL: The Amazon VPC network interfaces for this endpoint are correctly configured and able to pass inbound or outbound DNS queries between your network and Resolver.

• UPDATING: Resolver is associating or disassociating one or more network interfaces with this endpoint.

• AUTO_RECOVERING: Resolver is trying to recover one or more of the network interfaces that are associated with this endpoint. During the recovery process, the endpoint functions with limited capacity because of the limit on the number of DNS queries per IP address (per network interface). For the current limit, see Limits on Route 53 Resolver.

• ACTION_NEEDED: This endpoint is unhealthy, and Resolver can't automatically recover it. To resolve the problem, we recommend that you check each IP address that you associated with the endpoint. For each IP address that isn't available, add another IP address and then delete the IP address that isn't available. (An endpoint must always include at least two IP addresses.) A status of ACTION_NEEDED can have a variety of causes. Here are two common causes:

  • One or more of the network interfaces that are associated with the endpoint were deleted using Amazon VPC.

  • The network interface couldn't be created for some reason that's outside the control of Resolver.

• DELETING: Resolver is deleting this endpoint and the associated network interfaces.

pub fn status_message(&self) -> Option<&str>

A detailed description of the status of the Resolver endpoint.

pub fn creation_time(&self) -> Option<&str>

The date and time that the endpoint was created, in Unix time format and Coordinated Universal Time (UTC).

pub fn modification_time(&self) -> Option<&str>

The date and time that the endpoint was last modified, in Unix time format and Coordinated Universal Time (UTC).

pub fn outpost_arn(&self) -> Option<&str>

The ARN (Amazon Resource Name) for the Outpost.

pub fn preferred_instance_type(&self) -> Option<&str>

The Amazon EC2 instance type.

pub fn resolver_endpoint_type(&self) -> Option<&ResolverEndpointType>

The Resolver endpoint IP address type.

pub fn protocols(&self) -> &[Protocol]

Protocols used for the endpoint. DoH-FIPS is applicable for inbound endpoints only.

For an inbound endpoint you can apply the protocols as follows:

• Do53 and DoH in combination.

• Do53 and DoH-FIPS in combination.

• Do53 alone.

• DoH alone.

• DoH-FIPS alone.

• None, which is treated as Do53.

For an outbound endpoint you can apply the protocols as follows:

• Do53 and DoH in combination.

• Do53 alone.

• DoH alone.

• None, which is treated as Do53.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .protocols.is_none().

impl ResolverEndpoint

pub fn builder() -> ResolverEndpointBuilder

Creates a new builder-style object to manufacture ResolverEndpoint.

Trait Implementations

impl Clone for ResolverEndpoint

fn clone(&self) -> ResolverEndpoint

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ResolverEndpoint

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ResolverEndpoint

fn eq(&self, other: &ResolverEndpoint) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ResolverEndpoint