Class Ec2InstanceConnectEndpoint
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Ec2InstanceConnectEndpoint.Builder,
Ec2InstanceConnectEndpoint>
The EC2 Instance Connect Endpoint.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The Availability Zone of the EC2 Instance Connect Endpoint.builder()
final Instant
The date and time that the EC2 Instance Connect Endpoint was created.final String
dnsName()
The DNS name of the EC2 Instance Connect Endpoint.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the NetworkInterfaceIds property.final boolean
For responses, this returns true if the service returned a value for the SecurityGroupIds property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
The Amazon Resource Name (ARN) of the EC2 Instance Connect Endpoint.final String
The ID of the EC2 Instance Connect Endpoint.The ID of the elastic network interface that Amazon EC2 automatically created when creating the EC2 Instance Connect Endpoint.final String
ownerId()
The ID of the Amazon Web Services account that created the EC2 Instance Connect Endpoint.final Boolean
Indicates whether your client's IP address is preserved as the source.The security groups associated with the endpoint.static Class
<? extends Ec2InstanceConnectEndpoint.Builder> state()
The current state of the EC2 Instance Connect Endpoint.final String
The current state of the EC2 Instance Connect Endpoint.final String
The message for the current state of the EC2 Instance Connect Endpoint.final String
subnetId()
The ID of the subnet in which the EC2 Instance Connect Endpoint was created.tags()
The tags assigned to the EC2 Instance Connect Endpoint.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
vpcId()
The ID of the VPC in which the EC2 Instance Connect Endpoint was created.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The ID of the EC2 Instance Connect Endpoint.
- Returns:
- The ID of the EC2 Instance Connect Endpoint.
-
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
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 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:
-
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 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:
-
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
The DNS name of the EC2 Instance Connect Endpoint.
- Returns:
- The DNS name of the EC2 Instance Connect Endpoint.
-
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 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
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
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
The Availability Zone of the EC2 Instance Connect Endpoint.
- Returns:
- The Availability Zone of the EC2 Instance Connect Endpoint.
-
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
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
Indicates whether your client's IP address is preserved as the source. The value is
true
orfalse
.-
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
orfalse
.-
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 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
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
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
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 interfaceToCopyableBuilder<Ec2InstanceConnectEndpoint.Builder,
Ec2InstanceConnectEndpoint> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-