CreateVpcEndpointRequest (AWS Java SDK :: Services

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

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateVpcEndpointRequest.Builder,CreateVpcEndpointRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateVpcEndpointRequest
extends Ec2Request
implements ToCopyableBuilder<CreateVpcEndpointRequest.Builder,CreateVpcEndpointRequest>

Contains the parameters for CreateVpcEndpoint.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateVpcEndpointRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateVpcEndpointRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CreateVpcEndpointRequest.Builder`	`builder()`
`String`	`clientToken()` Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasRouteTableIds()` Returns true if the RouteTableIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasSecurityGroupIds()` Returns true if the SecurityGroupIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasSubnetIds()` Returns true if the SubnetIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`String`	`policyDocument()` A policy to attach to the endpoint that controls access to the service.
`Boolean`	`privateDnsEnabled()` (Interface endpoint) Indicates whether to associate a private hosted zone with the specified VPC.
`List<String>`	`routeTableIds()` (Gateway endpoint) One or more route table IDs.
`List<SdkField<?>>`	`sdkFields()`
`List<String>`	`securityGroupIds()` (Interface endpoint) The ID of one or more security groups to associate with the endpoint network interface.
`static Class<? extends CreateVpcEndpointRequest.Builder>`	`serializableBuilderClass()`
`String`	`serviceName()` The service name.
`List<String>`	`subnetIds()` (Interface endpoint) The ID of one or more subnets in which to create an endpoint network interface.
`CreateVpcEndpointRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`VpcEndpointType`	`vpcEndpointType()` The type of endpoint.
`String`	`vpcEndpointTypeAsString()` The type of endpoint.
`String`	`vpcId()` The ID of the VPC in which the endpoint will be used.

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
  - vpcEndpointType
```
public VpcEndpointType vpcEndpointType()
```
    The type of endpoint.
    
    Default: Gateway
    
    If the service returns an enum value that is not available in the current SDK version, vpcEndpointType will return VpcEndpointType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from vpcEndpointTypeAsString().
    
    Returns:
    
    The type of endpoint.
    
    Default: Gateway
    
    See Also:
    
    VpcEndpointType
  - vpcEndpointTypeAsString
```
public String vpcEndpointTypeAsString()
```
    The type of endpoint.
    
    Default: Gateway
    
    If the service returns an enum value that is not available in the current SDK version, vpcEndpointType will return VpcEndpointType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from vpcEndpointTypeAsString().
    
    Returns:
    
    The type of endpoint.
    
    Default: Gateway
    
    See Also:
    
    VpcEndpointType
  - vpcId
```
public String vpcId()
```
    The ID of the VPC in which the endpoint will be used.
    
    Returns:
    
    The ID of the VPC in which the endpoint will be used.
  - serviceName
```
public String serviceName()
```
    The service name. To get a list of available services, use the DescribeVpcEndpointServices request, or get the name from the service provider.
    
    Returns:
    
    The service name. To get a list of available services, use the DescribeVpcEndpointServices request, or get the name from the service provider.
  - policyDocument
```
public String policyDocument()
```
    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:
    
    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.
  - hasRouteTableIds
```
public boolean hasRouteTableIds()
```
    Returns true if the RouteTableIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - routeTableIds
```
public List<String> routeTableIds()
```
    (Gateway endpoint) One or more route table IDs.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasRouteTableIds() to see if a value was sent in this field.
    
    Returns:
    
    (Gateway endpoint) One or more route table IDs.
  - hasSubnetIds
```
public boolean hasSubnetIds()
```
    Returns true if the SubnetIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - subnetIds
```
public List<String> subnetIds()
```
    (Interface endpoint) The ID of one or more subnets in which to create an endpoint network interface.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasSubnetIds() to see if a value was sent in this field.
    
    Returns:
    
    (Interface endpoint) The ID of one or more subnets in which to create an endpoint network interface.
  - hasSecurityGroupIds
```
public boolean hasSecurityGroupIds()
```
    Returns true if the SecurityGroupIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - securityGroupIds
```
public List<String> securityGroupIds()
```
    (Interface endpoint) The ID of one or more security groups to associate with the endpoint network interface.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasSecurityGroupIds() to see if a value was sent in this field.
    
    Returns:
    
    (Interface endpoint) The ID of one or more security groups to associate with the endpoint network interface.
  - clientToken
```
public String clientToken()
```
    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
    
    Returns:
    
    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
  - privateDnsEnabled
```
public 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.
    
    Default: true
    
    Returns:
    
    (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.
    
    Default: true
  - toBuilder
```
public CreateVpcEndpointRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateVpcEndpointRequest.Builder,CreateVpcEndpointRequest>
    
    Specified by:
    
    toBuilder in class Ec2Request
  - builder
```
public static CreateVpcEndpointRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateVpcEndpointRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateVpcEndpointRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

vpcEndpointType

vpcEndpointTypeAsString

vpcId

serviceName

policyDocument

hasRouteTableIds

routeTableIds

hasSubnetIds

subnetIds

hasSecurityGroupIds

securityGroupIds

clientToken

privateDnsEnabled

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields