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>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceModifyInstanceConnectEndpointRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ModifyInstanceConnectEndpointRequest.Builderbuilder()BooleandryRun()Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasSecurityGroupIds()For responses, this returns true if the service returned a value for the SecurityGroupIds property.StringinstanceConnectEndpointId()The ID of the EC2 Instance Connect Endpoint to modify.IpAddressTypeipAddressType()The new IP address type for the EC2 Instance Connect Endpoint.StringipAddressTypeAsString()The new IP address type for the EC2 Instance Connect Endpoint.BooleanpreserveClientIp()Indicates whether the client IP address is preserved as the source when you connect to a resource.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()List<String>securityGroupIds()Changes the security groups for the EC2 Instance Connect Endpoint.static Class<? extends ModifyInstanceConnectEndpointRequest.Builder>serializableBuilderClass()ModifyInstanceConnectEndpointRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
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
-
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 isUnauthorizedOperation.- 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 isUnauthorizedOperation.
-
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.
PreserveClientIpis only supported on IPv4 EC2 Instance Connect Endpoints. To usePreserveClientIp, the value forIpAddressTypemust beipv4.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 new IP address type for the EC2 Instance Connect Endpoint.
PreserveClientIpis only supported on IPv4 EC2 Instance Connect Endpoints. To usePreserveClientIp, the value forIpAddressTypemust beipv4. - See Also:
IpAddressType
-
ipAddressTypeAsString
public final String ipAddressTypeAsString()
The new IP address type for the EC2 Instance Connect Endpoint.
PreserveClientIpis only supported on IPv4 EC2 Instance Connect Endpoints. To usePreserveClientIp, the value forIpAddressTypemust beipv4.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 new IP address type for the EC2 Instance Connect Endpoint.
PreserveClientIpis only supported on IPv4 EC2 Instance Connect Endpoints. To usePreserveClientIp, the value forIpAddressTypemust beipv4. - 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 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()
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.
-
-
-
toBuilder
public ModifyInstanceConnectEndpointRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ModifyInstanceConnectEndpointRequest.Builder,ModifyInstanceConnectEndpointRequest>- Specified by:
toBuilderin classEc2Request
-
builder
public static ModifyInstanceConnectEndpointRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends ModifyInstanceConnectEndpointRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-