Class ModifyInstanceConnectEndpointRequest

    • Method Detail

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

        Returns:
        Indicates whether the client 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.

      • 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