Class: Aws::Route53Resolver::Types::ResolverEndpoint

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb

Overview

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

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

Returns:

  • (String)


4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 4257

class ResolverEndpoint < Struct.new(
  :id,
  :creator_request_id,
  :arn,
  :name,
  :security_group_ids,
  :direction,
  :ip_address_count,
  :host_vpc_id,
  :status,
  :status_message,
  :creation_time,
  :modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#creation_timeString

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

Returns:

  • (String)


4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 4257

class ResolverEndpoint < Struct.new(
  :id,
  :creator_request_id,
  :arn,
  :name,
  :security_group_ids,
  :direction,
  :ip_address_count,
  :host_vpc_id,
  :status,
  :status_message,
  :creation_time,
  :modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#creator_request_idString

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.

Returns:

  • (String)


4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 4257

class ResolverEndpoint < Struct.new(
  :id,
  :creator_request_id,
  :arn,
  :name,
  :security_group_ids,
  :direction,
  :ip_address_count,
  :host_vpc_id,
  :status,
  :status_message,
  :creation_time,
  :modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#directionString

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

Returns:

  • (String)


4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 4257

class ResolverEndpoint < Struct.new(
  :id,
  :creator_request_id,
  :arn,
  :name,
  :security_group_ids,
  :direction,
  :ip_address_count,
  :host_vpc_id,
  :status,
  :status_message,
  :creation_time,
  :modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#host_vpc_idString

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

Returns:

  • (String)


4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 4257

class ResolverEndpoint < Struct.new(
  :id,
  :creator_request_id,
  :arn,
  :name,
  :security_group_ids,
  :direction,
  :ip_address_count,
  :host_vpc_id,
  :status,
  :status_message,
  :creation_time,
  :modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#idString

The ID of the Resolver endpoint.

Returns:

  • (String)


4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 4257

class ResolverEndpoint < Struct.new(
  :id,
  :creator_request_id,
  :arn,
  :name,
  :security_group_ids,
  :direction,
  :ip_address_count,
  :host_vpc_id,
  :status,
  :status_message,
  :creation_time,
  :modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#ip_address_countInteger

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

Returns:

  • (Integer)


4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 4257

class ResolverEndpoint < Struct.new(
  :id,
  :creator_request_id,
  :arn,
  :name,
  :security_group_ids,
  :direction,
  :ip_address_count,
  :host_vpc_id,
  :status,
  :status_message,
  :creation_time,
  :modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#modification_timeString

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

Returns:

  • (String)


4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 4257

class ResolverEndpoint < Struct.new(
  :id,
  :creator_request_id,
  :arn,
  :name,
  :security_group_ids,
  :direction,
  :ip_address_count,
  :host_vpc_id,
  :status,
  :status_message,
  :creation_time,
  :modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

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

Returns:

  • (String)


4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 4257

class ResolverEndpoint < Struct.new(
  :id,
  :creator_request_id,
  :arn,
  :name,
  :security_group_ids,
  :direction,
  :ip_address_count,
  :host_vpc_id,
  :status,
  :status_message,
  :creation_time,
  :modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#security_group_idsArray<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.

Returns:

  • (Array<String>)


4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 4257

class ResolverEndpoint < Struct.new(
  :id,
  :creator_request_id,
  :arn,
  :name,
  :security_group_ids,
  :direction,
  :ip_address_count,
  :host_vpc_id,
  :status,
  :status_message,
  :creation_time,
  :modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

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.

Returns:

  • (String)


4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 4257

class ResolverEndpoint < Struct.new(
  :id,
  :creator_request_id,
  :arn,
  :name,
  :security_group_ids,
  :direction,
  :ip_address_count,
  :host_vpc_id,
  :status,
  :status_message,
  :creation_time,
  :modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#status_messageString

A detailed description of the status of the Resolver endpoint.

Returns:

  • (String)


4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/types.rb', line 4257

class ResolverEndpoint < Struct.new(
  :id,
  :creator_request_id,
  :arn,
  :name,
  :security_group_ids,
  :direction,
  :ip_address_count,
  :host_vpc_id,
  :status,
  :status_message,
  :creation_time,
  :modification_time)
  SENSITIVE = []
  include Aws::Structure
end