amazonka-route53resolver-2.0: Amazon Route 53 Resolver 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.Route53Resolver.Types.ResolverEndpoint

Description

 
Synopsis

Documentation

data ResolverEndpoint Source #

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

See: newResolverEndpoint smart constructor.

Constructors

ResolverEndpoint' 

Fields

  • arn :: Maybe Text

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

  • creationTime :: Maybe Text

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

  • creatorRequestId :: Maybe Text

    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.

  • direction :: Maybe 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
  • hostVPCId :: Maybe Text

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

  • id :: Maybe Text

    The ID of the Resolver endpoint.

  • ipAddressCount :: Maybe Int

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

  • modificationTime :: Maybe Text

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

  • name :: Maybe Text

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

  • securityGroupIds :: Maybe [Text]

    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.

  • status :: Maybe 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.
  • statusMessage :: Maybe Text

    A detailed description of the status of the Resolver endpoint.

Instances

Instances details
FromJSON ResolverEndpoint Source # 
Instance details

Defined in Amazonka.Route53Resolver.Types.ResolverEndpoint

Generic ResolverEndpoint Source # 
Instance details

Defined in Amazonka.Route53Resolver.Types.ResolverEndpoint

Associated Types

type Rep ResolverEndpoint :: Type -> Type #

Read ResolverEndpoint Source # 
Instance details

Defined in Amazonka.Route53Resolver.Types.ResolverEndpoint

Show ResolverEndpoint Source # 
Instance details

Defined in Amazonka.Route53Resolver.Types.ResolverEndpoint

NFData ResolverEndpoint Source # 
Instance details

Defined in Amazonka.Route53Resolver.Types.ResolverEndpoint

Methods

rnf :: ResolverEndpoint -> () #

Eq ResolverEndpoint Source # 
Instance details

Defined in Amazonka.Route53Resolver.Types.ResolverEndpoint

Hashable ResolverEndpoint Source # 
Instance details

Defined in Amazonka.Route53Resolver.Types.ResolverEndpoint

type Rep ResolverEndpoint Source # 
Instance details

Defined in Amazonka.Route53Resolver.Types.ResolverEndpoint

type Rep ResolverEndpoint = D1 ('MetaData "ResolverEndpoint" "Amazonka.Route53Resolver.Types.ResolverEndpoint" "amazonka-route53resolver-2.0-GFukx1WIgCPEXMh1BiYlp6" 'False) (C1 ('MetaCons "ResolverEndpoint'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "creatorRequestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "direction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResolverEndpointDirection)) :*: (S1 ('MetaSel ('Just "hostVPCId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "ipAddressCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "modificationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "securityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResolverEndpointStatus)) :*: S1 ('MetaSel ('Just "statusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newResolverEndpoint :: ResolverEndpoint Source #

Create a value of ResolverEndpoint 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:arn:ResolverEndpoint', resolverEndpoint_arn - The ARN (Amazon Resource Name) for the Resolver endpoint.

$sel:creationTime:ResolverEndpoint', resolverEndpoint_creationTime - The date and time that the endpoint was created, in Unix time format and Coordinated Universal Time (UTC).

$sel:creatorRequestId:ResolverEndpoint', resolverEndpoint_creatorRequestId - 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.

$sel:direction:ResolverEndpoint', resolverEndpoint_direction - 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

$sel:hostVPCId:ResolverEndpoint', resolverEndpoint_hostVPCId - The ID of the VPC that you want to create the Resolver endpoint in.

$sel:id:ResolverEndpoint', resolverEndpoint_id - The ID of the Resolver endpoint.

$sel:ipAddressCount:ResolverEndpoint', resolverEndpoint_ipAddressCount - The number of IP addresses that the Resolver endpoint can use for DNS queries.

$sel:modificationTime:ResolverEndpoint', resolverEndpoint_modificationTime - The date and time that the endpoint was last modified, in Unix time format and Coordinated Universal Time (UTC).

$sel:name:ResolverEndpoint', resolverEndpoint_name - The name that you assigned to the Resolver endpoint when you submitted a CreateResolverEndpoint request.

$sel:securityGroupIds:ResolverEndpoint', resolverEndpoint_securityGroupIds - 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.

$sel:status:ResolverEndpoint', resolverEndpoint_status - 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.

$sel:statusMessage:ResolverEndpoint', resolverEndpoint_statusMessage - A detailed description of the status of the Resolver endpoint.

resolverEndpoint_arn :: Lens' ResolverEndpoint (Maybe Text) Source #

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

resolverEndpoint_creationTime :: Lens' ResolverEndpoint (Maybe Text) Source #

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

resolverEndpoint_creatorRequestId :: Lens' ResolverEndpoint (Maybe Text) Source #

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.

resolverEndpoint_direction :: Lens' ResolverEndpoint (Maybe ResolverEndpointDirection) Source #

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

resolverEndpoint_hostVPCId :: Lens' ResolverEndpoint (Maybe Text) Source #

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

resolverEndpoint_id :: Lens' ResolverEndpoint (Maybe Text) Source #

The ID of the Resolver endpoint.

resolverEndpoint_ipAddressCount :: Lens' ResolverEndpoint (Maybe Int) Source #

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

resolverEndpoint_modificationTime :: Lens' ResolverEndpoint (Maybe Text) Source #

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

resolverEndpoint_name :: Lens' ResolverEndpoint (Maybe Text) Source #

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

resolverEndpoint_securityGroupIds :: Lens' ResolverEndpoint (Maybe [Text]) Source #

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.

resolverEndpoint_status :: Lens' ResolverEndpoint (Maybe ResolverEndpointStatus) Source #

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.

resolverEndpoint_statusMessage :: Lens' ResolverEndpoint (Maybe Text) Source #

A detailed description of the status of the Resolver endpoint.