Package software.amazon.awssdk.services.ec2.model

Class CreateInstanceConnectEndpointRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.ec2.model.Ec2Request
software.amazon.awssdk.services.ec2.model.CreateInstanceConnectEndpointRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateInstanceConnectEndpointRequest.Builder,CreateInstanceConnectEndpointRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateInstanceConnectEndpointRequest extends Ec2Request implements ToCopyableBuilder<CreateInstanceConnectEndpointRequest.Builder,CreateInstanceConnectEndpointRequest>

  • Method Details

    • dryRun

      public final Boolean dryRun()

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

      Returns:
      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    • subnetId

      public final String subnetId()

      The ID of the subnet in which to create the EC2 Instance Connect Endpoint.

      Returns:
      The ID of the subnet in which to create the EC2 Instance Connect Endpoint.

    • 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()

      One or more security groups to associate with the endpoint. If you don't specify a security group, the default security group for your VPC will be 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:
      One or more security groups to associate with the endpoint. If you don't specify a security group, the default security group for your VPC will be associated with the endpoint.

    • preserveClientIp

      public final Boolean preserveClientIp()

      Indicates whether the client IP address is preserved as the source. The following are the possible values.

      • true - Use the client IP address as the source.

      • false - Use the network interface IP address as the source.

      PreserveClientIp is only supported on IPv4 EC2 Instance Connect Endpoints. To use PreserveClientIp, the value for IpAddressType must be ipv4.

      Default: false

      Returns:
      Indicates whether the client IP address is preserved as the source. The following are the possible values.

      • true - Use the client IP address as the source.

      • false - Use the network interface IP address as the source.

      PreserveClientIp is only supported on IPv4 EC2 Instance Connect Endpoints. To use PreserveClientIp, the value for IpAddressType must be ipv4.

      Default: false

    • clientToken

      public final String clientToken()

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

      Returns:
      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    • hasTagSpecifications

      public final boolean hasTagSpecifications()
      For responses, this returns true if the service returned a value for the TagSpecifications 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.

    • tagSpecifications

      public final List<TagSpecification> tagSpecifications()

      The tags to apply to the EC2 Instance Connect Endpoint during creation.

      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 hasTagSpecifications() method.

      Returns:
      The tags to apply to the EC2 Instance Connect Endpoint during creation.

    • ipAddressType

      public final IpAddressType ipAddressType()

      The IP address type of the endpoint.

      If no value is specified, the default value is determined by the IP address type of the subnet:

      • dualstack - If the subnet has both IPv4 and IPv6 CIDRs

      • ipv4 - If the subnet has only IPv4 CIDRs

      • ipv6 - If the subnet has only IPv6 CIDRs

      PreserveClientIp is only supported on IPv4 EC2 Instance Connect Endpoints. To use PreserveClientIp, the value for IpAddressType must be ipv4.

      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.

      If no value is specified, the default value is determined by the IP address type of the subnet:

      • dualstack - If the subnet has both IPv4 and IPv6 CIDRs

      • ipv4 - If the subnet has only IPv4 CIDRs

      • ipv6 - If the subnet has only IPv6 CIDRs

      PreserveClientIp is only supported on IPv4 EC2 Instance Connect Endpoints. To use PreserveClientIp, the value for IpAddressType must be ipv4.

      See Also:

    • ipAddressTypeAsString

      public final String ipAddressTypeAsString()

      The IP address type of the endpoint.

      If no value is specified, the default value is determined by the IP address type of the subnet:

      • dualstack - If the subnet has both IPv4 and IPv6 CIDRs

      • ipv4 - If the subnet has only IPv4 CIDRs

      • ipv6 - If the subnet has only IPv6 CIDRs

      PreserveClientIp is only supported on IPv4 EC2 Instance Connect Endpoints. To use PreserveClientIp, the value for IpAddressType must be ipv4.

      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.

      If no value is specified, the default value is determined by the IP address type of the subnet:

      • dualstack - If the subnet has both IPv4 and IPv6 CIDRs

      • ipv4 - If the subnet has only IPv4 CIDRs

      • ipv6 - If the subnet has only IPv6 CIDRs

      PreserveClientIp is only supported on IPv4 EC2 Instance Connect Endpoints. To use PreserveClientIp, the value for IpAddressType must be ipv4.

      See Also:

    • toBuilder

      public CreateInstanceConnectEndpointRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateInstanceConnectEndpointRequest.Builder,CreateInstanceConnectEndpointRequest>
      Specified by:
      toBuilder in class Ec2Request

    • builder

      public static CreateInstanceConnectEndpointRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo