Route53Resolver / Client / associate_resolver_endpoint_ip_address

associate_resolver_endpoint_ip_address

Route53Resolver.Client.associate_resolver_endpoint_ip_address(**kwargs)

Adds IP addresses to an inbound or an outbound Resolver endpoint. If you want to add more than one IP address, submit one AssociateResolverEndpointIpAddress request for each IP address.

To remove an IP address from an endpoint, see DisassociateResolverEndpointIpAddress.

See also: AWS API Documentation

Request Syntax

response = client.associate_resolver_endpoint_ip_address(
    ResolverEndpointId='string',
    IpAddress={
        'IpId': 'string',
        'SubnetId': 'string',
        'Ip': 'string',
        'Ipv6': 'string'
    }
)

Parameters:

• ResolverEndpointId (string) –

  [REQUIRED]

  The ID of the Resolver endpoint that you want to associate IP addresses with.

• IpAddress (dict) –

  [REQUIRED]

  Either the IPv4 address that you want to add to a Resolver endpoint or a subnet ID. If you specify a subnet ID, Resolver chooses an IP address for you from the available IPs in the specified subnet.

  • IpId (string) –

    Only when removing an IP address from a Resolver endpoint: The ID of the IP address that you want to remove. To get this ID, use GetResolverEndpoint.

  • SubnetId (string) –

    The ID of the subnet that includes the IP address that you want to update. To get this ID, use GetResolverEndpoint.

  • Ip (string) –

    The new IPv4 address.

  • Ipv6 (string) –

    The new IPv6 address.

Return type:

dict

Returns:

Response Syntax

{
    'ResolverEndpoint': {
        'Id': 'string',
        'CreatorRequestId': 'string',
        'Arn': 'string',
        'Name': 'string',
        'SecurityGroupIds': [
            'string',
        ],
        'Direction': 'INBOUND'|'OUTBOUND',
        'IpAddressCount': 123,
        'HostVPCId': 'string',
        'Status': 'CREATING'|'OPERATIONAL'|'UPDATING'|'AUTO_RECOVERING'|'ACTION_NEEDED'|'DELETING',
        'StatusMessage': 'string',
        'CreationTime': 'string',
        'ModificationTime': 'string',
        'OutpostArn': 'string',
        'PreferredInstanceType': 'string',
        'ResolverEndpointType': 'IPV6'|'IPV4'|'DUALSTACK',
        'Protocols': [
            'DoH'|'Do53'|'DoH-FIPS',
        ]
    }
}

Response Structure

• (dict) –

  • ResolverEndpoint (dict) –

    The response to an AssociateResolverEndpointIpAddress request.

    • Id (string) –

      The ID of the Resolver endpoint.

    • CreatorRequestId (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 (string) –

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

    • Name (string) –

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

    • SecurityGroupIds (list) –

      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.

      • (string) –

    • Direction (string) –

      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

    • IpAddressCount (integer) –

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

    • HostVPCId (string) –

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

    • Status (string) –

      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 (string) –

      A detailed description of the status of the Resolver endpoint.

    • CreationTime (string) –

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

    • ModificationTime (string) –

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

    • OutpostArn (string) –

      The ARN (Amazon Resource Name) for the Outpost.

    • PreferredInstanceType (string) –

      The Amazon EC2 instance type.

    • ResolverEndpointType (string) –

      The Resolver endpoint IP address type.

    • Protocols (list) –

      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.

      • (string) –

Exceptions

• Route53Resolver.Client.exceptions.ResourceNotFoundException

• Route53Resolver.Client.exceptions.InvalidParameterException

• Route53Resolver.Client.exceptions.InvalidRequestException

• Route53Resolver.Client.exceptions.ResourceExistsException

• Route53Resolver.Client.exceptions.InternalServiceErrorException

• Route53Resolver.Client.exceptions.LimitExceededException

• Route53Resolver.Client.exceptions.ThrottlingException