Interface CreateInstanceConnectEndpointRequest.Builder

  • Method Details

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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.
    • subnetId

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

      Parameters:
      subnetId - The ID of the subnet in which to create the EC2 Instance Connect Endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • securityGroupIds

      CreateInstanceConnectEndpointRequest.Builder securityGroupIds(Collection<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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • securityGroupIds

      CreateInstanceConnectEndpointRequest.Builder securityGroupIds(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • preserveClientIp

      CreateInstanceConnectEndpointRequest.Builder preserveClientIp(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.
    • clientToken

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

      Parameters:
      clientToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • tagSpecifications

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

      Parameters:
      tagSpecifications - The tags to apply to the EC2 Instance Connect Endpoint during creation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • tagSpecifications

      CreateInstanceConnectEndpointRequest.Builder tagSpecifications(TagSpecification... tagSpecifications)

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

      Parameters:
      tagSpecifications - The tags to apply to the EC2 Instance Connect Endpoint during creation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • tagSpecifications

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

      This is a convenience method that creates an instance of the TagSpecification.Builder avoiding the need to create one manually via TagSpecification.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tagSpecifications(List<TagSpecification>).

      Parameters:
      tagSpecifications - a consumer that will call methods on TagSpecification.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • overrideConfiguration

      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.
    • overrideConfiguration

      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.