Interface CreateVpcEndpointRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateVpcEndpointRequest.Builder,CreateVpcEndpointRequest>, Ec2Request.Builder, SdkBuilder<CreateVpcEndpointRequest.Builder,CreateVpcEndpointRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateVpcEndpointRequest
@Mutable @NotThreadSafe public static interface CreateVpcEndpointRequest.Builder extends Ec2Request.Builder, SdkPojo, CopyableBuilder<CreateVpcEndpointRequest.Builder,CreateVpcEndpointRequest>

  • Method Details

    • dryRun

      CreateVpcEndpointRequest.Builder dryRun(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.

      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.

    • vpcEndpointType

      CreateVpcEndpointRequest.Builder vpcEndpointType(String vpcEndpointType)

      The type of endpoint.

      For more information about the types of VPC endpoints, see VPC endpoints in the Amazon Web Services PrivateLink User Guide.

      Default: Gateway

      Parameters:
      vpcEndpointType - The type of endpoint.

      For more information about the types of VPC endpoints, see VPC endpoints in the Amazon Web Services PrivateLink User Guide.

      Default: Gateway

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

    • vpcEndpointType

      CreateVpcEndpointRequest.Builder vpcEndpointType(VpcEndpointType vpcEndpointType)

      The type of endpoint.

      For more information about the types of VPC endpoints, see VPC endpoints in the Amazon Web Services PrivateLink User Guide.

      Default: Gateway

      Parameters:
      vpcEndpointType - The type of endpoint.

      For more information about the types of VPC endpoints, see VPC endpoints in the Amazon Web Services PrivateLink User Guide.

      Default: Gateway

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

    • vpcId

      CreateVpcEndpointRequest.Builder vpcId(String vpcId)

      The ID of the VPC.

      Parameters:
      vpcId - The ID of the VPC.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • serviceName

      CreateVpcEndpointRequest.Builder serviceName(String serviceName)

      The name of the endpoint service.

      Parameters:
      serviceName - The name of the endpoint service.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • policyDocument

      CreateVpcEndpointRequest.Builder policyDocument(String policyDocument)

      (Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format. If this parameter is not specified, we attach a default policy that allows full access to the service.

      Parameters:
      policyDocument - (Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format. If this parameter is not specified, we attach a default policy that allows full access to the service.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • routeTableIds

      CreateVpcEndpointRequest.Builder routeTableIds(Collection<String> routeTableIds)

      (Gateway endpoint) The route table IDs.

      Parameters:
      routeTableIds - (Gateway endpoint) The route table IDs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • routeTableIds

      CreateVpcEndpointRequest.Builder routeTableIds(String... routeTableIds)

      (Gateway endpoint) The route table IDs.

      Parameters:
      routeTableIds - (Gateway endpoint) The route table IDs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • subnetIds

      CreateVpcEndpointRequest.Builder subnetIds(Collection<String> subnetIds)

      (Interface, Gateway Load Balancer endpoints, Resource, ServiceNetwork, and Tunnel endpoints only) The IDs of the subnets in which to create endpoint network interfaces. For a Gateway Load Balancer endpoint, you can specify only one subnet. For a Tunnel endpoint, the subnets must be in the Availability Zones of the resource gateway associated with the shared resource configuration. An endpoint network interface is created only in an Availability Zone that the resource gateway is also in.

      Parameters:
      subnetIds - (Interface, Gateway Load Balancer endpoints, Resource, ServiceNetwork, and Tunnel endpoints only) The IDs of the subnets in which to create endpoint network interfaces. For a Gateway Load Balancer endpoint, you can specify only one subnet. For a Tunnel endpoint, the subnets must be in the Availability Zones of the resource gateway associated with the shared resource configuration. An endpoint network interface is created only in an Availability Zone that the resource gateway is also in.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • subnetIds

      CreateVpcEndpointRequest.Builder subnetIds(String... subnetIds)

      (Interface, Gateway Load Balancer endpoints, Resource, ServiceNetwork, and Tunnel endpoints only) The IDs of the subnets in which to create endpoint network interfaces. For a Gateway Load Balancer endpoint, you can specify only one subnet. For a Tunnel endpoint, the subnets must be in the Availability Zones of the resource gateway associated with the shared resource configuration. An endpoint network interface is created only in an Availability Zone that the resource gateway is also in.

      Parameters:
      subnetIds - (Interface, Gateway Load Balancer endpoints, Resource, ServiceNetwork, and Tunnel endpoints only) The IDs of the subnets in which to create endpoint network interfaces. For a Gateway Load Balancer endpoint, you can specify only one subnet. For a Tunnel endpoint, the subnets must be in the Availability Zones of the resource gateway associated with the shared resource configuration. An endpoint network interface is created only in an Availability Zone that the resource gateway is also in.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • securityGroupIds

      CreateVpcEndpointRequest.Builder securityGroupIds(Collection<String> securityGroupIds)

      (Interface, Resource, ServiceNetwork, and Tunnel endpoints only) The IDs of the security groups to associate with the endpoint network interfaces. If this parameter is not specified, we use the default security group for the VPC.

      Parameters:
      securityGroupIds - (Interface, Resource, ServiceNetwork, and Tunnel endpoints only) The IDs of the security groups to associate with the endpoint network interfaces. If this parameter is not specified, we use the default security group for the VPC.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • securityGroupIds

      CreateVpcEndpointRequest.Builder securityGroupIds(String... securityGroupIds)

      (Interface, Resource, ServiceNetwork, and Tunnel endpoints only) The IDs of the security groups to associate with the endpoint network interfaces. If this parameter is not specified, we use the default security group for the VPC.

      Parameters:
      securityGroupIds - (Interface, Resource, ServiceNetwork, and Tunnel endpoints only) The IDs of the security groups to associate with the endpoint network interfaces. If this parameter is not specified, we use the default security group for the VPC.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ipAddressType

      CreateVpcEndpointRequest.Builder ipAddressType(String ipAddressType)

      The IP address type for the endpoint.

      Parameters:
      ipAddressType - The IP address type for the endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • ipAddressType

      CreateVpcEndpointRequest.Builder ipAddressType(IpAddressType ipAddressType)

      The IP address type for the endpoint.

      Parameters:
      ipAddressType - The IP address type for the endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • dnsOptions

      CreateVpcEndpointRequest.Builder dnsOptions(DnsOptionsSpecification dnsOptions)

      The DNS options for the endpoint.

      Parameters:
      dnsOptions - The DNS options for the endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dnsOptions

      default CreateVpcEndpointRequest.Builder dnsOptions(Consumer<DnsOptionsSpecification.Builder> dnsOptions)

      The DNS options for the endpoint.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dnsOptions(DnsOptionsSpecification).

      Parameters:
      dnsOptions - a consumer that will call methods on DnsOptionsSpecification.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clientToken

      CreateVpcEndpointRequest.Builder clientToken(String clientToken)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

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

    • privateDnsEnabled

      CreateVpcEndpointRequest.Builder privateDnsEnabled(Boolean privateDnsEnabled)

      (Interface endpoint) Indicates whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, kinesis.us-east-1.amazonaws.com), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service.

      To use a private hosted zone, you must set the following VPC attributes to true: enableDnsHostnames and enableDnsSupport. Use ModifyVpcAttribute to set the VPC attributes.

      Parameters:
      privateDnsEnabled - (Interface endpoint) Indicates whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, kinesis.us-east-1.amazonaws.com), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service.

      To use a private hosted zone, you must set the following VPC attributes to true: enableDnsHostnames and enableDnsSupport. Use ModifyVpcAttribute to set the VPC attributes.

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

    • tagSpecifications

      CreateVpcEndpointRequest.Builder tagSpecifications(Collection<TagSpecification> tagSpecifications)

      The tags to associate with the endpoint.

      Parameters:
      tagSpecifications - The tags to associate with the endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tagSpecifications

      CreateVpcEndpointRequest.Builder tagSpecifications(TagSpecification... tagSpecifications)

      The tags to associate with the endpoint.

      Parameters:
      tagSpecifications - The tags to associate with the endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tagSpecifications

      CreateVpcEndpointRequest.Builder tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications)

      The tags to associate with the endpoint.

      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:

    • subnetConfigurations

      CreateVpcEndpointRequest.Builder subnetConfigurations(Collection<SubnetConfiguration> subnetConfigurations)

      The subnet configurations for the endpoint.

      Parameters:
      subnetConfigurations - The subnet configurations for the endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • subnetConfigurations

      CreateVpcEndpointRequest.Builder subnetConfigurations(SubnetConfiguration... subnetConfigurations)

      The subnet configurations for the endpoint.

      Parameters:
      subnetConfigurations - The subnet configurations for the endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • subnetConfigurations

      CreateVpcEndpointRequest.Builder subnetConfigurations(Consumer<SubnetConfiguration.Builder>... subnetConfigurations)

      The subnet configurations for the endpoint.

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

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

      Parameters:
      subnetConfigurations - a consumer that will call methods on SubnetConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • serviceNetworkArn

      CreateVpcEndpointRequest.Builder serviceNetworkArn(String serviceNetworkArn)

      The Amazon Resource Name (ARN) of a service network that will be associated with the VPC endpoint of type service-network.

      Parameters:
      serviceNetworkArn - The Amazon Resource Name (ARN) of a service network that will be associated with the VPC endpoint of type service-network.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourceConfigurationArn

      CreateVpcEndpointRequest.Builder resourceConfigurationArn(String resourceConfigurationArn)

      (Resource and Tunnel endpoints only) The Amazon Resource Name (ARN) of a resource configuration associated with the VPC endpoint. The type of resource configuration depends on the endpoint type:

      • For a Resource endpoint, you can specify a resource configuration that is of type SINGLE, GROUP, or ARN. To reach a resource that belongs to a group, specify the parent GROUP resource configuration.

      • For a Tunnel endpoint, you can specify a resource configuration that is of type CIDR.

      For more information about the types of resource configurations, see Types of resource configurations in the Amazon Web Services PrivateLink User Guide.

      This request fails if a VPC endpoint owned by a different Amazon Web Services account already exists on a resource gateway that is enabled for ResourceGatewayCharges payer responsibility.

      Parameters:
      resourceConfigurationArn - (Resource and Tunnel endpoints only) The Amazon Resource Name (ARN) of a resource configuration associated with the VPC endpoint. The type of resource configuration depends on the endpoint type:

      • For a Resource endpoint, you can specify a resource configuration that is of type SINGLE, GROUP, or ARN. To reach a resource that belongs to a group, specify the parent GROUP resource configuration.

      • For a Tunnel endpoint, you can specify a resource configuration that is of type CIDR.

      For more information about the types of resource configurations, see Types of resource configurations in the Amazon Web Services PrivateLink User Guide.

      This request fails if a VPC endpoint owned by a different Amazon Web Services account already exists on a resource gateway that is enabled for ResourceGatewayCharges payer responsibility.

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

    • serviceRegion

      CreateVpcEndpointRequest.Builder serviceRegion(String serviceRegion)

      The Region where the service is hosted. The default is the current Region.

      Parameters:
      serviceRegion - The Region where the service is hosted. The default is the current Region.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateVpcEndpointRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration 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

      CreateVpcEndpointRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      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.