Class ModifyInstanceConnectEndpointRequest

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.ModifyInstanceConnectEndpointRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ModifyInstanceConnectEndpointRequest.Builder,ModifyInstanceConnectEndpointRequest>
@Generated("software.amazon.awssdk:codegen") public final class ModifyInstanceConnectEndpointRequest extends Ec2Request implements ToCopyableBuilder<ModifyInstanceConnectEndpointRequest.Builder,ModifyInstanceConnectEndpointRequest>

  • Method Details

    • dryRun

      public final Boolean dryRun()

      Checks whether you have the required permissions for the operation, 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 operation, 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.

    • instanceConnectEndpointId

      public final String instanceConnectEndpointId()

      The ID of the EC2 Instance Connect Endpoint to modify.

      Returns:
      The ID of the EC2 Instance Connect Endpoint to modify.

    • ipAddressType

      public final IpAddressType ipAddressType()

      The new IP address type for the EC2 Instance Connect Endpoint.

      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 new IP address type for the EC2 Instance Connect Endpoint.

      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 new IP address type for the EC2 Instance Connect Endpoint.

      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 new IP address type for the EC2 Instance Connect Endpoint.

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

      See Also:

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

      Changes the security groups for the EC2 Instance Connect Endpoint. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name.

      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:
      Changes the security groups for the EC2 Instance Connect Endpoint. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name.

    • 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=true is only supported on IPv4 EC2 Instance Connect Endpoints. If modifying PreserveClientIp to true, either the endpoint's existing IpAddressType must be ipv4, or if modifying IpAddressType in the same request, the new value 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=true is only supported on IPv4 EC2 Instance Connect Endpoints. If modifying PreserveClientIp to true, either the endpoint's existing IpAddressType must be ipv4, or if modifying IpAddressType in the same request, the new value must be ipv4.

      Default: false

    • toBuilder

      public ModifyInstanceConnectEndpointRequest.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<ModifyInstanceConnectEndpointRequest.Builder,ModifyInstanceConnectEndpointRequest>
      Specified by:
      toBuilder in class Ec2Request
      Returns:
      a builder for type T

    • builder

      public static ModifyInstanceConnectEndpointRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ModifyInstanceConnectEndpointRequest.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)
      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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.