Class Ec2InstanceConnectEndpoint

java.lang.Object
software.amazon.awssdk.services.ec2.model.Ec2InstanceConnectEndpoint
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Ec2InstanceConnectEndpoint.Builder,Ec2InstanceConnectEndpoint>
@Generated("software.amazon.awssdk:codegen") public final class Ec2InstanceConnectEndpoint extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Ec2InstanceConnectEndpoint.Builder,Ec2InstanceConnectEndpoint>

Describes an EC2 Instance Connect Endpoint.

See Also:

  • Method Details

    • ownerId

      public final String ownerId()

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

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

    • instanceConnectEndpointId

      public final String instanceConnectEndpointId()

      The ID of the EC2 Instance Connect Endpoint.

      Returns:
      The ID of the EC2 Instance Connect Endpoint.

    • instanceConnectEndpointArn

      public final String instanceConnectEndpointArn()

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

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

    • state

      public final Ec2InstanceConnectEndpointState state()

      The current state of the EC2 Instance Connect Endpoint.

      If the service returns an enum value that is not available in the current SDK version, state will return Ec2InstanceConnectEndpointState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      The current state of the EC2 Instance Connect Endpoint.
      See Also:

    • stateAsString

      public final String stateAsString()

      The current state of the EC2 Instance Connect Endpoint.

      If the service returns an enum value that is not available in the current SDK version, state will return Ec2InstanceConnectEndpointState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      The current state of the EC2 Instance Connect Endpoint.
      See Also:

    • stateMessage

      public final String stateMessage()

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

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

    • dnsName

      public final String dnsName()

      The DNS name of the EC2 Instance Connect Endpoint.

      Returns:
      The DNS name of the EC2 Instance Connect Endpoint.

    • fipsDnsName

      public final String fipsDnsName()

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

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

    • hasNetworkInterfaceIds

      public final boolean hasNetworkInterfaceIds()
      For responses, this returns true if the service returned a value for the NetworkInterfaceIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • networkInterfaceIds

      public final List<String> networkInterfaceIds()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasNetworkInterfaceIds() method.

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

    • vpcId

      public final String vpcId()

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

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

    • availabilityZone

      public final String availabilityZone()

      The Availability Zone of the EC2 Instance Connect Endpoint.

      Returns:
      The Availability Zone of the EC2 Instance Connect Endpoint.

    • createdAt

      public final Instant createdAt()

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

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

    • subnetId

      public final String subnetId()

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

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

    • preserveClientIp

      public final Boolean preserveClientIp()

      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:
      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

    • hasSecurityGroupIds

      public final boolean hasSecurityGroupIds()
      For responses, this returns true if the service returned a value for the SecurityGroupIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • securityGroupIds

      public final List<String> securityGroupIds()

      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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSecurityGroupIds() method.

      Returns:
      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.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<Tag> tags()

      The tags assigned to the EC2 Instance Connect Endpoint.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      The tags assigned to the EC2 Instance Connect Endpoint.

    • ipAddressType

      public final IpAddressType ipAddressType()

      The IP address type of the endpoint.

      If the service returns an enum value that is not available in the current SDK version, ipAddressType will return IpAddressType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ipAddressTypeAsString().

      Returns:
      The IP address type of the endpoint.
      See Also:

    • ipAddressTypeAsString

      public final String ipAddressTypeAsString()

      The IP address type of the endpoint.

      If the service returns an enum value that is not available in the current SDK version, ipAddressType will return IpAddressType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ipAddressTypeAsString().

      Returns:
      The IP address type of the endpoint.
      See Also:

    • publicDnsNames

      public final InstanceConnectEndpointPublicDnsNames publicDnsNames()

      The public DNS names of the endpoint.

      Returns:
      The public DNS names of the endpoint.

    • toBuilder

      public Ec2InstanceConnectEndpoint.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Ec2InstanceConnectEndpoint.Builder,Ec2InstanceConnectEndpoint>
      Returns:
      a builder for type T

    • builder

      public static Ec2InstanceConnectEndpoint.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Ec2InstanceConnectEndpoint.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.