Ec2InstanceConnectEndpoint (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.ec2.model.Ec2InstanceConnectEndpoint

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Ec2InstanceConnectEndpoint.Builder,Ec2InstanceConnectEndpoint>

@Generated(value="software.amazon.awssdk:codegen")
public final class Ec2InstanceConnectEndpoint
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Ec2InstanceConnectEndpoint.Builder,Ec2InstanceConnectEndpoint>

The EC2 Instance Connect Endpoint.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Ec2InstanceConnectEndpoint.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Ec2InstanceConnectEndpoint.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`availabilityZone()` The Availability Zone of the EC2 Instance Connect Endpoint.
`static Ec2InstanceConnectEndpoint.Builder`	`builder()`
`Instant`	`createdAt()` The date and time that the EC2 Instance Connect Endpoint was created.
`String`	`dnsName()` The DNS name of the EC2 Instance Connect Endpoint.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`fipsDnsName()`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasNetworkInterfaceIds()` For responses, this returns true if the service returned a value for the NetworkInterfaceIds property.
`boolean`	`hasSecurityGroupIds()` For responses, this returns true if the service returned a value for the SecurityGroupIds property.
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`String`	`instanceConnectEndpointArn()` The Amazon Resource Name (ARN) of the EC2 Instance Connect Endpoint.
`String`	`instanceConnectEndpointId()` The ID of the EC2 Instance Connect Endpoint.
`List<String>`	`networkInterfaceIds()` The ID of the elastic network interface that Amazon EC2 automatically created when creating the EC2 Instance Connect Endpoint.
`String`	`ownerId()` The ID of the Amazon Web Services account that created the EC2 Instance Connect Endpoint.
`Boolean`	`preserveClientIp()` Indicates whether your client's IP address is preserved as the source.
`List<SdkField<?>>`	`sdkFields()`
`List<String>`	`securityGroupIds()` The security groups associated with the endpoint.
`static Class<? extends Ec2InstanceConnectEndpoint.Builder>`	`serializableBuilderClass()`
`Ec2InstanceConnectEndpointState`	`state()` The current state of the EC2 Instance Connect Endpoint.
`String`	`stateAsString()` The current state of the EC2 Instance Connect Endpoint.
`String`	`stateMessage()` The message for the current state of the EC2 Instance Connect Endpoint.
`String`	`subnetId()` The ID of the subnet in which the EC2 Instance Connect Endpoint was created.
`List<Tag>`	`tags()` The tags assigned to the EC2 Instance Connect Endpoint.
`Ec2InstanceConnectEndpoint.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`vpcId()` The ID of the VPC in which the EC2 Instance Connect Endpoint was created.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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:
    
    Ec2InstanceConnectEndpointState
  - 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:
    
    Ec2InstanceConnectEndpointState
  - 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()
```
    Returns:
  - 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. The value is true or false.
    - If true, your client's IP address is used when you connect to a resource.
    - If false, the elastic network interface IP address is used when you connect to a resource.
    Default: true
    Returns:
    Indicates whether your client's IP address is preserved as the source. The value is true or false.
    
    If true, your client's IP address is used when you connect to a resource.
    
    If false, the elastic network interface IP address is used when you connect to a resource.
    
    Default: true
  - 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.
  - toBuilder
```
public Ec2InstanceConnectEndpoint.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Ec2InstanceConnectEndpoint.Builder,Ec2InstanceConnectEndpoint>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class Ec2InstanceConnectEndpoint

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

ownerId

instanceConnectEndpointId

instanceConnectEndpointArn

state

stateAsString

stateMessage

dnsName

fipsDnsName

hasNetworkInterfaceIds

networkInterfaceIds

vpcId

availabilityZone

createdAt

subnetId

preserveClientIp

hasSecurityGroupIds

securityGroupIds

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields