Class: Aws::EC2::Types::VpcEndpoint

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::VpcEndpoint

Includes:

Structure

Defined in:

lib/aws-sdk-ec2/types.rb

Overview

Describes a VPC endpoint.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #creation_timestamp ⇒ Time

  The date and time that the endpoint was created.

• #dns_entries ⇒ Array<Types::DnsEntry>

  (Interface endpoint) The DNS entries for the endpoint.

• #dns_options ⇒ Types::DnsOptions

  The DNS options for the endpoint.

• #failure_reason ⇒ String

  Reason for the failure.

• #groups ⇒ Array<Types::SecurityGroupIdentifier>

  (Interface endpoint) Information about the security groups that are associated with the network interface.

• #ip_address_type ⇒ String

  The IP address type for the endpoint.

• #ipv_4_prefixes ⇒ Array<Types::SubnetIpPrefixes>

  Array of IPv4 prefixes.

• #ipv_6_prefixes ⇒ Array<Types::SubnetIpPrefixes>

  Array of IPv6 prefixes.

• #last_error ⇒ Types::LastError

  The last error that occurred for endpoint.

• #network_interface_ids ⇒ Array<String>

  (Interface endpoint) The network interfaces for the endpoint.

• #owner_id ⇒ String

  The ID of the Amazon Web Services account that owns the endpoint.

• #policy_document ⇒ String

  The policy document associated with the endpoint, if applicable.

• #private_dns_enabled ⇒ Boolean

  (Interface endpoint) Indicates whether the VPC is associated with a private hosted zone.

• #requester_managed ⇒ Boolean

  Indicates whether the endpoint is being managed by its service.

• #resource_configuration_arn ⇒ String

  The Amazon Resource Name (ARN) of the resource configuration.

• #route_table_ids ⇒ Array<String>

  (Gateway endpoint) The IDs of the route tables associated with the endpoint.

• #service_name ⇒ String

  The name of the service to which the endpoint is associated.

• #service_network_arn ⇒ String

  The Amazon Resource Name (ARN) of the service network.

• #service_region ⇒ String

  The Region where the service is hosted.

• #state ⇒ String

  The state of the endpoint.

• #subnet_ids ⇒ Array<String>

  (Interface endpoint) The subnets for the endpoint.

• #tags ⇒ Array<Types::Tag>

  The tags assigned to the endpoint.

• #vpc_endpoint_id ⇒ String

  The ID of the endpoint.

• #vpc_endpoint_type ⇒ String

  The type of endpoint.

• #vpc_id ⇒ String

  The ID of the VPC to which the endpoint is associated.

Instance Attribute Details

#creation_timestamp ⇒ Time

The date and time that the endpoint was created.

Returns:

• (Time)

# File 'lib/aws-sdk-ec2/types.rb', line 74012

class VpcEndpoint < Struct.new(
  :vpc_endpoint_id,
  :vpc_endpoint_type,
  :vpc_id,
  :service_name,
  :state,
  :policy_document,
  :route_table_ids,
  :subnet_ids,
  :groups,
  :ip_address_type,
  :dns_options,
  :private_dns_enabled,
  :requester_managed,
  :network_interface_ids,
  :dns_entries,
  :creation_timestamp,
  :tags,
  :owner_id,
  :last_error,
  :ipv_4_prefixes,
  :ipv_6_prefixes,
  :failure_reason,
  :service_network_arn,
  :resource_configuration_arn,
  :service_region)
  SENSITIVE = []
  include Aws::Structure
end

#dns_entries ⇒ Array<Types::DnsEntry>

(Interface endpoint) The DNS entries for the endpoint.

Returns:

• (Array<Types::DnsEntry>)

# File 'lib/aws-sdk-ec2/types.rb', line 74012

class VpcEndpoint < Struct.new(
  :vpc_endpoint_id,
  :vpc_endpoint_type,
  :vpc_id,
  :service_name,
  :state,
  :policy_document,
  :route_table_ids,
  :subnet_ids,
  :groups,
  :ip_address_type,
  :dns_options,
  :private_dns_enabled,
  :requester_managed,
  :network_interface_ids,
  :dns_entries,
  :creation_timestamp,
  :tags,
  :owner_id,
  :last_error,
  :ipv_4_prefixes,
  :ipv_6_prefixes,
  :failure_reason,
  :service_network_arn,
  :resource_configuration_arn,
  :service_region)
  SENSITIVE = []
  include Aws::Structure
end

#dns_options ⇒ Types::DnsOptions

The DNS options for the endpoint.

Returns:

• (Types::DnsOptions)

# File 'lib/aws-sdk-ec2/types.rb', line 74012

class VpcEndpoint < Struct.new(
  :vpc_endpoint_id,
  :vpc_endpoint_type,
  :vpc_id,
  :service_name,
  :state,
  :policy_document,
  :route_table_ids,
  :subnet_ids,
  :groups,
  :ip_address_type,
  :dns_options,
  :private_dns_enabled,
  :requester_managed,
  :network_interface_ids,
  :dns_entries,
  :creation_timestamp,
  :tags,
  :owner_id,
  :last_error,
  :ipv_4_prefixes,
  :ipv_6_prefixes,
  :failure_reason,
  :service_network_arn,
  :resource_configuration_arn,
  :service_region)
  SENSITIVE = []
  include Aws::Structure
end

#failure_reason ⇒ String

Reason for the failure.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 74012

class VpcEndpoint < Struct.new(
  :vpc_endpoint_id,
  :vpc_endpoint_type,
  :vpc_id,
  :service_name,
  :state,
  :policy_document,
  :route_table_ids,
  :subnet_ids,
  :groups,
  :ip_address_type,
  :dns_options,
  :private_dns_enabled,
  :requester_managed,
  :network_interface_ids,
  :dns_entries,
  :creation_timestamp,
  :tags,
  :owner_id,
  :last_error,
  :ipv_4_prefixes,
  :ipv_6_prefixes,
  :failure_reason,
  :service_network_arn,
  :resource_configuration_arn,
  :service_region)
  SENSITIVE = []
  include Aws::Structure
end

#groups ⇒ Array<Types::SecurityGroupIdentifier>

(Interface endpoint) Information about the security groups that are associated with the network interface.

Returns:

• (Array<Types::SecurityGroupIdentifier>)

# File 'lib/aws-sdk-ec2/types.rb', line 74012

class VpcEndpoint < Struct.new(
  :vpc_endpoint_id,
  :vpc_endpoint_type,
  :vpc_id,
  :service_name,
  :state,
  :policy_document,
  :route_table_ids,
  :subnet_ids,
  :groups,
  :ip_address_type,
  :dns_options,
  :private_dns_enabled,
  :requester_managed,
  :network_interface_ids,
  :dns_entries,
  :creation_timestamp,
  :tags,
  :owner_id,
  :last_error,
  :ipv_4_prefixes,
  :ipv_6_prefixes,
  :failure_reason,
  :service_network_arn,
  :resource_configuration_arn,
  :service_region)
  SENSITIVE = []
  include Aws::Structure
end

#ip_address_type ⇒ String

The IP address type for the endpoint.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 74012

class VpcEndpoint < Struct.new(
  :vpc_endpoint_id,
  :vpc_endpoint_type,
  :vpc_id,
  :service_name,
  :state,
  :policy_document,
  :route_table_ids,
  :subnet_ids,
  :groups,
  :ip_address_type,
  :dns_options,
  :private_dns_enabled,
  :requester_managed,
  :network_interface_ids,
  :dns_entries,
  :creation_timestamp,
  :tags,
  :owner_id,
  :last_error,
  :ipv_4_prefixes,
  :ipv_6_prefixes,
  :failure_reason,
  :service_network_arn,
  :resource_configuration_arn,
  :service_region)
  SENSITIVE = []
  include Aws::Structure
end

#ipv_4_prefixes ⇒ Array<Types::SubnetIpPrefixes>

Array of IPv4 prefixes.

Returns:

• (Array<Types::SubnetIpPrefixes>)

# File 'lib/aws-sdk-ec2/types.rb', line 74012

class VpcEndpoint < Struct.new(
  :vpc_endpoint_id,
  :vpc_endpoint_type,
  :vpc_id,
  :service_name,
  :state,
  :policy_document,
  :route_table_ids,
  :subnet_ids,
  :groups,
  :ip_address_type,
  :dns_options,
  :private_dns_enabled,
  :requester_managed,
  :network_interface_ids,
  :dns_entries,
  :creation_timestamp,
  :tags,
  :owner_id,
  :last_error,
  :ipv_4_prefixes,
  :ipv_6_prefixes,
  :failure_reason,
  :service_network_arn,
  :resource_configuration_arn,
  :service_region)
  SENSITIVE = []
  include Aws::Structure
end

#ipv_6_prefixes ⇒ Array<Types::SubnetIpPrefixes>

Array of IPv6 prefixes.

Returns:

• (Array<Types::SubnetIpPrefixes>)

# File 'lib/aws-sdk-ec2/types.rb', line 74012

class VpcEndpoint < Struct.new(
  :vpc_endpoint_id,
  :vpc_endpoint_type,
  :vpc_id,
  :service_name,
  :state,
  :policy_document,
  :route_table_ids,
  :subnet_ids,
  :groups,
  :ip_address_type,
  :dns_options,
  :private_dns_enabled,
  :requester_managed,
  :network_interface_ids,
  :dns_entries,
  :creation_timestamp,
  :tags,
  :owner_id,
  :last_error,
  :ipv_4_prefixes,
  :ipv_6_prefixes,
  :failure_reason,
  :service_network_arn,
  :resource_configuration_arn,
  :service_region)
  SENSITIVE = []
  include Aws::Structure
end

#last_error ⇒ Types::LastError

The last error that occurred for endpoint.

Returns:

• (Types::LastError)

# File 'lib/aws-sdk-ec2/types.rb', line 74012

class VpcEndpoint < Struct.new(
  :vpc_endpoint_id,
  :vpc_endpoint_type,
  :vpc_id,
  :service_name,
  :state,
  :policy_document,
  :route_table_ids,
  :subnet_ids,
  :groups,
  :ip_address_type,
  :dns_options,
  :private_dns_enabled,
  :requester_managed,
  :network_interface_ids,
  :dns_entries,
  :creation_timestamp,
  :tags,
  :owner_id,
  :last_error,
  :ipv_4_prefixes,
  :ipv_6_prefixes,
  :failure_reason,
  :service_network_arn,
  :resource_configuration_arn,
  :service_region)
  SENSITIVE = []
  include Aws::Structure
end

#network_interface_ids ⇒ Array<String>

(Interface endpoint) The network interfaces for the endpoint.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-ec2/types.rb', line 74012

class VpcEndpoint < Struct.new(
  :vpc_endpoint_id,
  :vpc_endpoint_type,
  :vpc_id,
  :service_name,
  :state,
  :policy_document,
  :route_table_ids,
  :subnet_ids,
  :groups,
  :ip_address_type,
  :dns_options,
  :private_dns_enabled,
  :requester_managed,
  :network_interface_ids,
  :dns_entries,
  :creation_timestamp,
  :tags,
  :owner_id,
  :last_error,
  :ipv_4_prefixes,
  :ipv_6_prefixes,
  :failure_reason,
  :service_network_arn,
  :resource_configuration_arn,
  :service_region)
  SENSITIVE = []
  include Aws::Structure
end

#owner_id ⇒ String

The ID of the Amazon Web Services account that owns the endpoint.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 74012

class VpcEndpoint < Struct.new(
  :vpc_endpoint_id,
  :vpc_endpoint_type,
  :vpc_id,
  :service_name,
  :state,
  :policy_document,
  :route_table_ids,
  :subnet_ids,
  :groups,
  :ip_address_type,
  :dns_options,
  :private_dns_enabled,
  :requester_managed,
  :network_interface_ids,
  :dns_entries,
  :creation_timestamp,
  :tags,
  :owner_id,
  :last_error,
  :ipv_4_prefixes,
  :ipv_6_prefixes,
  :failure_reason,
  :service_network_arn,
  :resource_configuration_arn,
  :service_region)
  SENSITIVE = []
  include Aws::Structure
end

#policy_document ⇒ String

The policy document associated with the endpoint, if applicable.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 74012

class VpcEndpoint < Struct.new(
  :vpc_endpoint_id,
  :vpc_endpoint_type,
  :vpc_id,
  :service_name,
  :state,
  :policy_document,
  :route_table_ids,
  :subnet_ids,
  :groups,
  :ip_address_type,
  :dns_options,
  :private_dns_enabled,
  :requester_managed,
  :network_interface_ids,
  :dns_entries,
  :creation_timestamp,
  :tags,
  :owner_id,
  :last_error,
  :ipv_4_prefixes,
  :ipv_6_prefixes,
  :failure_reason,
  :service_network_arn,
  :resource_configuration_arn,
  :service_region)
  SENSITIVE = []
  include Aws::Structure
end

#private_dns_enabled ⇒ Boolean

(Interface endpoint) Indicates whether the VPC is associated with a private hosted zone.

Returns:

• (Boolean)

# File 'lib/aws-sdk-ec2/types.rb', line 74012

class VpcEndpoint < Struct.new(
  :vpc_endpoint_id,
  :vpc_endpoint_type,
  :vpc_id,
  :service_name,
  :state,
  :policy_document,
  :route_table_ids,
  :subnet_ids,
  :groups,
  :ip_address_type,
  :dns_options,
  :private_dns_enabled,
  :requester_managed,
  :network_interface_ids,
  :dns_entries,
  :creation_timestamp,
  :tags,
  :owner_id,
  :last_error,
  :ipv_4_prefixes,
  :ipv_6_prefixes,
  :failure_reason,
  :service_network_arn,
  :resource_configuration_arn,
  :service_region)
  SENSITIVE = []
  include Aws::Structure
end

#requester_managed ⇒ Boolean

Indicates whether the endpoint is being managed by its service.

Returns:

• (Boolean)

# File 'lib/aws-sdk-ec2/types.rb', line 74012

class VpcEndpoint < Struct.new(
  :vpc_endpoint_id,
  :vpc_endpoint_type,
  :vpc_id,
  :service_name,
  :state,
  :policy_document,
  :route_table_ids,
  :subnet_ids,
  :groups,
  :ip_address_type,
  :dns_options,
  :private_dns_enabled,
  :requester_managed,
  :network_interface_ids,
  :dns_entries,
  :creation_timestamp,
  :tags,
  :owner_id,
  :last_error,
  :ipv_4_prefixes,
  :ipv_6_prefixes,
  :failure_reason,
  :service_network_arn,
  :resource_configuration_arn,
  :service_region)
  SENSITIVE = []
  include Aws::Structure
end

#resource_configuration_arn ⇒ String

The Amazon Resource Name (ARN) of the resource configuration.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 74012

class VpcEndpoint < Struct.new(
  :vpc_endpoint_id,
  :vpc_endpoint_type,
  :vpc_id,
  :service_name,
  :state,
  :policy_document,
  :route_table_ids,
  :subnet_ids,
  :groups,
  :ip_address_type,
  :dns_options,
  :private_dns_enabled,
  :requester_managed,
  :network_interface_ids,
  :dns_entries,
  :creation_timestamp,
  :tags,
  :owner_id,
  :last_error,
  :ipv_4_prefixes,
  :ipv_6_prefixes,
  :failure_reason,
  :service_network_arn,
  :resource_configuration_arn,
  :service_region)
  SENSITIVE = []
  include Aws::Structure
end

#route_table_ids ⇒ Array<String>

(Gateway endpoint) The IDs of the route tables associated with the endpoint.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-ec2/types.rb', line 74012

class VpcEndpoint < Struct.new(
  :vpc_endpoint_id,
  :vpc_endpoint_type,
  :vpc_id,
  :service_name,
  :state,
  :policy_document,
  :route_table_ids,
  :subnet_ids,
  :groups,
  :ip_address_type,
  :dns_options,
  :private_dns_enabled,
  :requester_managed,
  :network_interface_ids,
  :dns_entries,
  :creation_timestamp,
  :tags,
  :owner_id,
  :last_error,
  :ipv_4_prefixes,
  :ipv_6_prefixes,
  :failure_reason,
  :service_network_arn,
  :resource_configuration_arn,
  :service_region)
  SENSITIVE = []
  include Aws::Structure
end

#service_name ⇒ String

The name of the service to which the endpoint is associated.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 74012

class VpcEndpoint < Struct.new(
  :vpc_endpoint_id,
  :vpc_endpoint_type,
  :vpc_id,
  :service_name,
  :state,
  :policy_document,
  :route_table_ids,
  :subnet_ids,
  :groups,
  :ip_address_type,
  :dns_options,
  :private_dns_enabled,
  :requester_managed,
  :network_interface_ids,
  :dns_entries,
  :creation_timestamp,
  :tags,
  :owner_id,
  :last_error,
  :ipv_4_prefixes,
  :ipv_6_prefixes,
  :failure_reason,
  :service_network_arn,
  :resource_configuration_arn,
  :service_region)
  SENSITIVE = []
  include Aws::Structure
end

#service_network_arn ⇒ String

The Amazon Resource Name (ARN) of the service network.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 74012

class VpcEndpoint < Struct.new(
  :vpc_endpoint_id,
  :vpc_endpoint_type,
  :vpc_id,
  :service_name,
  :state,
  :policy_document,
  :route_table_ids,
  :subnet_ids,
  :groups,
  :ip_address_type,
  :dns_options,
  :private_dns_enabled,
  :requester_managed,
  :network_interface_ids,
  :dns_entries,
  :creation_timestamp,
  :tags,
  :owner_id,
  :last_error,
  :ipv_4_prefixes,
  :ipv_6_prefixes,
  :failure_reason,
  :service_network_arn,
  :resource_configuration_arn,
  :service_region)
  SENSITIVE = []
  include Aws::Structure
end

#service_region ⇒ String

The Region where the service is hosted.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 74012

class VpcEndpoint < Struct.new(
  :vpc_endpoint_id,
  :vpc_endpoint_type,
  :vpc_id,
  :service_name,
  :state,
  :policy_document,
  :route_table_ids,
  :subnet_ids,
  :groups,
  :ip_address_type,
  :dns_options,
  :private_dns_enabled,
  :requester_managed,
  :network_interface_ids,
  :dns_entries,
  :creation_timestamp,
  :tags,
  :owner_id,
  :last_error,
  :ipv_4_prefixes,
  :ipv_6_prefixes,
  :failure_reason,
  :service_network_arn,
  :resource_configuration_arn,
  :service_region)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

The state of the endpoint.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 74012

class VpcEndpoint < Struct.new(
  :vpc_endpoint_id,
  :vpc_endpoint_type,
  :vpc_id,
  :service_name,
  :state,
  :policy_document,
  :route_table_ids,
  :subnet_ids,
  :groups,
  :ip_address_type,
  :dns_options,
  :private_dns_enabled,
  :requester_managed,
  :network_interface_ids,
  :dns_entries,
  :creation_timestamp,
  :tags,
  :owner_id,
  :last_error,
  :ipv_4_prefixes,
  :ipv_6_prefixes,
  :failure_reason,
  :service_network_arn,
  :resource_configuration_arn,
  :service_region)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_ids ⇒ Array<String>

(Interface endpoint) The subnets for the endpoint.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-ec2/types.rb', line 74012

class VpcEndpoint < Struct.new(
  :vpc_endpoint_id,
  :vpc_endpoint_type,
  :vpc_id,
  :service_name,
  :state,
  :policy_document,
  :route_table_ids,
  :subnet_ids,
  :groups,
  :ip_address_type,
  :dns_options,
  :private_dns_enabled,
  :requester_managed,
  :network_interface_ids,
  :dns_entries,
  :creation_timestamp,
  :tags,
  :owner_id,
  :last_error,
  :ipv_4_prefixes,
  :ipv_6_prefixes,
  :failure_reason,
  :service_network_arn,
  :resource_configuration_arn,
  :service_region)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

The tags assigned to the endpoint.

Returns:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-ec2/types.rb', line 74012

class VpcEndpoint < Struct.new(
  :vpc_endpoint_id,
  :vpc_endpoint_type,
  :vpc_id,
  :service_name,
  :state,
  :policy_document,
  :route_table_ids,
  :subnet_ids,
  :groups,
  :ip_address_type,
  :dns_options,
  :private_dns_enabled,
  :requester_managed,
  :network_interface_ids,
  :dns_entries,
  :creation_timestamp,
  :tags,
  :owner_id,
  :last_error,
  :ipv_4_prefixes,
  :ipv_6_prefixes,
  :failure_reason,
  :service_network_arn,
  :resource_configuration_arn,
  :service_region)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_endpoint_id ⇒ String

The ID of the endpoint.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 74012

class VpcEndpoint < Struct.new(
  :vpc_endpoint_id,
  :vpc_endpoint_type,
  :vpc_id,
  :service_name,
  :state,
  :policy_document,
  :route_table_ids,
  :subnet_ids,
  :groups,
  :ip_address_type,
  :dns_options,
  :private_dns_enabled,
  :requester_managed,
  :network_interface_ids,
  :dns_entries,
  :creation_timestamp,
  :tags,
  :owner_id,
  :last_error,
  :ipv_4_prefixes,
  :ipv_6_prefixes,
  :failure_reason,
  :service_network_arn,
  :resource_configuration_arn,
  :service_region)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_endpoint_type ⇒ String

The type of endpoint.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 74012

class VpcEndpoint < Struct.new(
  :vpc_endpoint_id,
  :vpc_endpoint_type,
  :vpc_id,
  :service_name,
  :state,
  :policy_document,
  :route_table_ids,
  :subnet_ids,
  :groups,
  :ip_address_type,
  :dns_options,
  :private_dns_enabled,
  :requester_managed,
  :network_interface_ids,
  :dns_entries,
  :creation_timestamp,
  :tags,
  :owner_id,
  :last_error,
  :ipv_4_prefixes,
  :ipv_6_prefixes,
  :failure_reason,
  :service_network_arn,
  :resource_configuration_arn,
  :service_region)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_id ⇒ String

The ID of the VPC to which the endpoint is associated.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 74012

class VpcEndpoint < Struct.new(
  :vpc_endpoint_id,
  :vpc_endpoint_type,
  :vpc_id,
  :service_name,
  :state,
  :policy_document,
  :route_table_ids,
  :subnet_ids,
  :groups,
  :ip_address_type,
  :dns_options,
  :private_dns_enabled,
  :requester_managed,
  :network_interface_ids,
  :dns_entries,
  :creation_timestamp,
  :tags,
  :owner_id,
  :last_error,
  :ipv_4_prefixes,
  :ipv_6_prefixes,
  :failure_reason,
  :service_network_arn,
  :resource_configuration_arn,
  :service_region)
  SENSITIVE = []
  include Aws::Structure
end