Class: Aws::EC2::Types::Ec2InstanceConnectEndpoint

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::Ec2InstanceConnectEndpoint

Defined in:

gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Describes an EC2 Instance Connect Endpoint.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #availability_zone ⇒ String

  The Availability Zone of the EC2 Instance Connect Endpoint.

• #availability_zone_id ⇒ String

  The ID of the Availability Zone of the EC2 Instance Connect Endpoint.

• #created_at ⇒ Time

  The date and time that the EC2 Instance Connect Endpoint was created.

• #dns_name ⇒ String

  The DNS name of the EC2 Instance Connect Endpoint.

• #fips_dns_name ⇒ String

  The Federal Information Processing Standards (FIPS) compliant DNS name of the EC2 Instance Connect Endpoint.

• #instance_connect_endpoint_arn ⇒ String

  The Amazon Resource Name (ARN) of the EC2 Instance Connect Endpoint.

• #instance_connect_endpoint_id ⇒ String

  The ID of the EC2 Instance Connect Endpoint.

• #ip_address_type ⇒ String

  The IP address type of the endpoint.

• #network_interface_ids ⇒ Array<String>

  The ID of the elastic network interface that Amazon EC2 automatically created when creating the EC2 Instance Connect Endpoint.

• #owner_id ⇒ String

  The ID of the Amazon Web Services account that created the EC2 Instance Connect Endpoint.

• #preserve_client_ip ⇒ Boolean

  Indicates whether your client's IP address is preserved as the source when you connect to a resource.

• #public_dns_names ⇒ Types::InstanceConnectEndpointPublicDnsNames

  The public DNS names of the endpoint.

• #security_group_ids ⇒ Array<String>

  The security groups associated with the endpoint.

• #state ⇒ String

  The current state of the EC2 Instance Connect Endpoint.

• #state_message ⇒ String

  The message for the current state of the EC2 Instance Connect Endpoint.

• #subnet_id ⇒ String

  The ID of the subnet in which the EC2 Instance Connect Endpoint was created.

• #tags ⇒ Array<Types::Tag>

  The tags assigned to the EC2 Instance Connect Endpoint.

• #vpc_id ⇒ String

  The ID of the VPC in which the EC2 Instance Connect Endpoint was created.

Instance Attribute Details

#availability_zone ⇒ String

The Availability Zone of the EC2 Instance Connect Endpoint.

Returns:

• (String)

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

class Ec2InstanceConnectEndpoint < Struct.new(
  :owner_id,
  :instance_connect_endpoint_id,
  :instance_connect_endpoint_arn,
  :state,
  :state_message,
  :dns_name,
  :fips_dns_name,
  :network_interface_ids,
  :vpc_id,
  :availability_zone,
  :created_at,
  :subnet_id,
  :preserve_client_ip,
  :security_group_ids,
  :tags,
  :ip_address_type,
  :public_dns_names,
  :availability_zone_id)
  SENSITIVE = []
  include Aws::Structure
end

#availability_zone_id ⇒ String

The ID of the Availability Zone of the EC2 Instance Connect Endpoint.

Returns:

• (String)

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

class Ec2InstanceConnectEndpoint < Struct.new(
  :owner_id,
  :instance_connect_endpoint_id,
  :instance_connect_endpoint_arn,
  :state,
  :state_message,
  :dns_name,
  :fips_dns_name,
  :network_interface_ids,
  :vpc_id,
  :availability_zone,
  :created_at,
  :subnet_id,
  :preserve_client_ip,
  :security_group_ids,
  :tags,
  :ip_address_type,
  :public_dns_names,
  :availability_zone_id)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

The date and time that the EC2 Instance Connect Endpoint was created.

Returns:

• (Time)

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

class Ec2InstanceConnectEndpoint < Struct.new(
  :owner_id,
  :instance_connect_endpoint_id,
  :instance_connect_endpoint_arn,
  :state,
  :state_message,
  :dns_name,
  :fips_dns_name,
  :network_interface_ids,
  :vpc_id,
  :availability_zone,
  :created_at,
  :subnet_id,
  :preserve_client_ip,
  :security_group_ids,
  :tags,
  :ip_address_type,
  :public_dns_names,
  :availability_zone_id)
  SENSITIVE = []
  include Aws::Structure
end

#dns_name ⇒ String

The DNS name of the EC2 Instance Connect Endpoint.

Returns:

• (String)

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

class Ec2InstanceConnectEndpoint < Struct.new(
  :owner_id,
  :instance_connect_endpoint_id,
  :instance_connect_endpoint_arn,
  :state,
  :state_message,
  :dns_name,
  :fips_dns_name,
  :network_interface_ids,
  :vpc_id,
  :availability_zone,
  :created_at,
  :subnet_id,
  :preserve_client_ip,
  :security_group_ids,
  :tags,
  :ip_address_type,
  :public_dns_names,
  :availability_zone_id)
  SENSITIVE = []
  include Aws::Structure
end

#fips_dns_name ⇒ String

The Federal Information Processing Standards (FIPS) compliant DNS name of the EC2 Instance Connect Endpoint.

Returns:

• (String)

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

class Ec2InstanceConnectEndpoint < Struct.new(
  :owner_id,
  :instance_connect_endpoint_id,
  :instance_connect_endpoint_arn,
  :state,
  :state_message,
  :dns_name,
  :fips_dns_name,
  :network_interface_ids,
  :vpc_id,
  :availability_zone,
  :created_at,
  :subnet_id,
  :preserve_client_ip,
  :security_group_ids,
  :tags,
  :ip_address_type,
  :public_dns_names,
  :availability_zone_id)
  SENSITIVE = []
  include Aws::Structure
end

#instance_connect_endpoint_arn ⇒ String

The Amazon Resource Name (ARN) of the EC2 Instance Connect Endpoint.

Returns:

• (String)

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

class Ec2InstanceConnectEndpoint < Struct.new(
  :owner_id,
  :instance_connect_endpoint_id,
  :instance_connect_endpoint_arn,
  :state,
  :state_message,
  :dns_name,
  :fips_dns_name,
  :network_interface_ids,
  :vpc_id,
  :availability_zone,
  :created_at,
  :subnet_id,
  :preserve_client_ip,
  :security_group_ids,
  :tags,
  :ip_address_type,
  :public_dns_names,
  :availability_zone_id)
  SENSITIVE = []
  include Aws::Structure
end

#instance_connect_endpoint_id ⇒ String

The ID of the EC2 Instance Connect Endpoint.

Returns:

• (String)

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

class Ec2InstanceConnectEndpoint < Struct.new(
  :owner_id,
  :instance_connect_endpoint_id,
  :instance_connect_endpoint_arn,
  :state,
  :state_message,
  :dns_name,
  :fips_dns_name,
  :network_interface_ids,
  :vpc_id,
  :availability_zone,
  :created_at,
  :subnet_id,
  :preserve_client_ip,
  :security_group_ids,
  :tags,
  :ip_address_type,
  :public_dns_names,
  :availability_zone_id)
  SENSITIVE = []
  include Aws::Structure
end

#ip_address_type ⇒ String

The IP address type of the endpoint.

Returns:

• (String)

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

class Ec2InstanceConnectEndpoint < Struct.new(
  :owner_id,
  :instance_connect_endpoint_id,
  :instance_connect_endpoint_arn,
  :state,
  :state_message,
  :dns_name,
  :fips_dns_name,
  :network_interface_ids,
  :vpc_id,
  :availability_zone,
  :created_at,
  :subnet_id,
  :preserve_client_ip,
  :security_group_ids,
  :tags,
  :ip_address_type,
  :public_dns_names,
  :availability_zone_id)
  SENSITIVE = []
  include Aws::Structure
end

#network_interface_ids ⇒ Array<String>

The ID of the elastic network interface that Amazon EC2 automatically created when creating the EC2 Instance Connect Endpoint.

Returns:

• (Array<String>)

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

class Ec2InstanceConnectEndpoint < Struct.new(
  :owner_id,
  :instance_connect_endpoint_id,
  :instance_connect_endpoint_arn,
  :state,
  :state_message,
  :dns_name,
  :fips_dns_name,
  :network_interface_ids,
  :vpc_id,
  :availability_zone,
  :created_at,
  :subnet_id,
  :preserve_client_ip,
  :security_group_ids,
  :tags,
  :ip_address_type,
  :public_dns_names,
  :availability_zone_id)
  SENSITIVE = []
  include Aws::Structure
end

#owner_id ⇒ String

The ID of the Amazon Web Services account that created the EC2 Instance Connect Endpoint.

Returns:

• (String)

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

class Ec2InstanceConnectEndpoint < Struct.new(
  :owner_id,
  :instance_connect_endpoint_id,
  :instance_connect_endpoint_arn,
  :state,
  :state_message,
  :dns_name,
  :fips_dns_name,
  :network_interface_ids,
  :vpc_id,
  :availability_zone,
  :created_at,
  :subnet_id,
  :preserve_client_ip,
  :security_group_ids,
  :tags,
  :ip_address_type,
  :public_dns_names,
  :availability_zone_id)
  SENSITIVE = []
  include Aws::Structure
end

#preserve_client_ip ⇒ Boolean

Indicates whether your client's IP address is preserved as the source when you connect to a resource. The following are the possible values.

• true - Use the IP address of the client. Your instance must have an IPv4 address.

• false - Use the IP address of the network interface.

Default: false

Returns:

• (Boolean)

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

class Ec2InstanceConnectEndpoint < Struct.new(
  :owner_id,
  :instance_connect_endpoint_id,
  :instance_connect_endpoint_arn,
  :state,
  :state_message,
  :dns_name,
  :fips_dns_name,
  :network_interface_ids,
  :vpc_id,
  :availability_zone,
  :created_at,
  :subnet_id,
  :preserve_client_ip,
  :security_group_ids,
  :tags,
  :ip_address_type,
  :public_dns_names,
  :availability_zone_id)
  SENSITIVE = []
  include Aws::Structure
end

#public_dns_names ⇒ Types::InstanceConnectEndpointPublicDnsNames

The public DNS names of the endpoint.

Returns:

• (Types::InstanceConnectEndpointPublicDnsNames)

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

class Ec2InstanceConnectEndpoint < Struct.new(
  :owner_id,
  :instance_connect_endpoint_id,
  :instance_connect_endpoint_arn,
  :state,
  :state_message,
  :dns_name,
  :fips_dns_name,
  :network_interface_ids,
  :vpc_id,
  :availability_zone,
  :created_at,
  :subnet_id,
  :preserve_client_ip,
  :security_group_ids,
  :tags,
  :ip_address_type,
  :public_dns_names,
  :availability_zone_id)
  SENSITIVE = []
  include Aws::Structure
end

#security_group_ids ⇒ Array<String>

The security groups associated with the endpoint. If you didn't specify a security group, the default security group for your VPC is associated with the endpoint.

Returns:

• (Array<String>)

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

class Ec2InstanceConnectEndpoint < Struct.new(
  :owner_id,
  :instance_connect_endpoint_id,
  :instance_connect_endpoint_arn,
  :state,
  :state_message,
  :dns_name,
  :fips_dns_name,
  :network_interface_ids,
  :vpc_id,
  :availability_zone,
  :created_at,
  :subnet_id,
  :preserve_client_ip,
  :security_group_ids,
  :tags,
  :ip_address_type,
  :public_dns_names,
  :availability_zone_id)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

The current state of the EC2 Instance Connect Endpoint.

Returns:

• (String)

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

class Ec2InstanceConnectEndpoint < Struct.new(
  :owner_id,
  :instance_connect_endpoint_id,
  :instance_connect_endpoint_arn,
  :state,
  :state_message,
  :dns_name,
  :fips_dns_name,
  :network_interface_ids,
  :vpc_id,
  :availability_zone,
  :created_at,
  :subnet_id,
  :preserve_client_ip,
  :security_group_ids,
  :tags,
  :ip_address_type,
  :public_dns_names,
  :availability_zone_id)
  SENSITIVE = []
  include Aws::Structure
end

#state_message ⇒ String

The message for the current state of the EC2 Instance Connect Endpoint. Can include a failure message.

Returns:

• (String)

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

class Ec2InstanceConnectEndpoint < Struct.new(
  :owner_id,
  :instance_connect_endpoint_id,
  :instance_connect_endpoint_arn,
  :state,
  :state_message,
  :dns_name,
  :fips_dns_name,
  :network_interface_ids,
  :vpc_id,
  :availability_zone,
  :created_at,
  :subnet_id,
  :preserve_client_ip,
  :security_group_ids,
  :tags,
  :ip_address_type,
  :public_dns_names,
  :availability_zone_id)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_id ⇒ String

The ID of the subnet in which the EC2 Instance Connect Endpoint was created.

Returns:

• (String)

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

class Ec2InstanceConnectEndpoint < Struct.new(
  :owner_id,
  :instance_connect_endpoint_id,
  :instance_connect_endpoint_arn,
  :state,
  :state_message,
  :dns_name,
  :fips_dns_name,
  :network_interface_ids,
  :vpc_id,
  :availability_zone,
  :created_at,
  :subnet_id,
  :preserve_client_ip,
  :security_group_ids,
  :tags,
  :ip_address_type,
  :public_dns_names,
  :availability_zone_id)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

The tags assigned to the EC2 Instance Connect Endpoint.

Returns:

• (Array<Types::Tag>)

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

class Ec2InstanceConnectEndpoint < Struct.new(
  :owner_id,
  :instance_connect_endpoint_id,
  :instance_connect_endpoint_arn,
  :state,
  :state_message,
  :dns_name,
  :fips_dns_name,
  :network_interface_ids,
  :vpc_id,
  :availability_zone,
  :created_at,
  :subnet_id,
  :preserve_client_ip,
  :security_group_ids,
  :tags,
  :ip_address_type,
  :public_dns_names,
  :availability_zone_id)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_id ⇒ String

The ID of the VPC in which the EC2 Instance Connect Endpoint was created.

Returns:

• (String)

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

class Ec2InstanceConnectEndpoint < Struct.new(
  :owner_id,
  :instance_connect_endpoint_id,
  :instance_connect_endpoint_arn,
  :state,
  :state_message,
  :dns_name,
  :fips_dns_name,
  :network_interface_ids,
  :vpc_id,
  :availability_zone,
  :created_at,
  :subnet_id,
  :preserve_client_ip,
  :security_group_ids,
  :tags,
  :ip_address_type,
  :public_dns_names,
  :availability_zone_id)
  SENSITIVE = []
  include Aws::Structure
end