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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceEc2InstanceConnectEndpoint.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringavailabilityZone()The Availability Zone of the EC2 Instance Connect Endpoint.static Ec2InstanceConnectEndpoint.Builderbuilder()InstantcreatedAt()The date and time that the EC2 Instance Connect Endpoint was created.StringdnsName()The DNS name of the EC2 Instance Connect Endpoint.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringfipsDnsName()The Federal Information Processing Standards (FIPS) compliant DNS name of the EC2 Instance Connect Endpoint.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasNetworkInterfaceIds()For responses, this returns true if the service returned a value for the NetworkInterfaceIds property.booleanhasSecurityGroupIds()For responses, this returns true if the service returned a value for the SecurityGroupIds property.booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.StringinstanceConnectEndpointArn()The Amazon Resource Name (ARN) of the EC2 Instance Connect Endpoint.StringinstanceConnectEndpointId()The ID of the EC2 Instance Connect Endpoint.IpAddressTypeipAddressType()The IP address type of the endpoint.StringipAddressTypeAsString()The IP address type of the endpoint.List<String>networkInterfaceIds()The ID of the elastic network interface that Amazon EC2 automatically created when creating the EC2 Instance Connect Endpoint.StringownerId()The ID of the Amazon Web Services account that created the EC2 Instance Connect Endpoint.BooleanpreserveClientIp()Indicates whether your client's IP address is preserved as the source when you connect to a resource.InstanceConnectEndpointPublicDnsNamespublicDnsNames()The public DNS names of the endpoint.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()List<String>securityGroupIds()The security groups associated with the endpoint.static Class<? extends Ec2InstanceConnectEndpoint.Builder>serializableBuilderClass()Ec2InstanceConnectEndpointStatestate()The current state of the EC2 Instance Connect Endpoint.StringstateAsString()The current state of the EC2 Instance Connect Endpoint.StringstateMessage()The message for the current state of the EC2 Instance Connect Endpoint.StringsubnetId()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.BuildertoBuilder()StringtoString()Returns a string representation of this object.StringvpcId()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,
statewill returnEc2InstanceConnectEndpointState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstateAsString().- 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,
statewill returnEc2InstanceConnectEndpointState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstateAsString().- 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()
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 theisEmpty()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 theisEmpty()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 theisEmpty()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,
ipAddressTypewill returnIpAddressType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromipAddressTypeAsString().- Returns:
- The IP address type of the endpoint.
- See Also:
IpAddressType
-
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,
ipAddressTypewill returnIpAddressType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromipAddressTypeAsString().- Returns:
- The IP address type of the endpoint.
- See Also:
IpAddressType
-
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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<Ec2InstanceConnectEndpoint.Builder,Ec2InstanceConnectEndpoint>
-
builder
public static Ec2InstanceConnectEndpoint.Builder builder()
-
serializableBuilderClass
public static Class<? extends Ec2InstanceConnectEndpoint.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-