Class CreateVpcEndpointRequest
- 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("software.amazon.awssdk:codegen") public final class CreateVpcEndpointRequest extends Ec2Request implements ToCopyableBuilder<CreateVpcEndpointRequest.Builder,CreateVpcEndpointRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
CreateVpcEndpointRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CreateVpcEndpointRequest.Builder
builder()
String
clientToken()
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.DnsOptionsSpecification
dnsOptions()
The DNS options for the endpoint.Boolean
dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasRouteTableIds()
For responses, this returns true if the service returned a value for the RouteTableIds property.boolean
hasSecurityGroupIds()
For responses, this returns true if the service returned a value for the SecurityGroupIds property.boolean
hasSubnetConfigurations()
For responses, this returns true if the service returned a value for the SubnetConfigurations property.boolean
hasSubnetIds()
For responses, this returns true if the service returned a value for the SubnetIds property.boolean
hasTagSpecifications()
For responses, this returns true if the service returned a value for the TagSpecifications property.IpAddressType
ipAddressType()
The IP address type for the endpoint.String
ipAddressTypeAsString()
The IP address type for the endpoint.String
policyDocument()
(Interface and gateway endpoints) 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) The route table IDs.List<SdkField<?>>
sdkFields()
List<String>
securityGroupIds()
(Interface endpoint) The IDs of the security groups to associate with the endpoint network interfaces.static Class<? extends CreateVpcEndpointRequest.Builder>
serializableBuilderClass()
String
serviceName()
The name of the endpoint service.List<SubnetConfiguration>
subnetConfigurations()
The subnet configurations for the endpoint.List<String>
subnetIds()
(Interface and Gateway Load Balancer endpoints) The IDs of the subnets in which to create endpoint network interfaces.List<TagSpecification>
tagSpecifications()
The tags to associate with the endpoint.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.-
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 action, 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 action, without actually making the request, and
provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.
-
vpcEndpointType
public final 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 returnVpcEndpointType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromvpcEndpointTypeAsString()
.- Returns:
- The type of endpoint.
Default: Gateway
- See Also:
VpcEndpointType
-
vpcEndpointTypeAsString
public final 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 returnVpcEndpointType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromvpcEndpointTypeAsString()
.- Returns:
- The type of endpoint.
Default: Gateway
- See Also:
VpcEndpointType
-
vpcId
public final String vpcId()
The ID of the VPC.
- Returns:
- The ID of the VPC.
-
serviceName
public final String serviceName()
The name of the endpoint service.
- Returns:
- The name of the endpoint service.
-
policyDocument
public final 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.
- Returns:
- (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.
-
hasRouteTableIds
public final boolean hasRouteTableIds()
For responses, this returns true if the service returned a value for the RouteTableIds 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.
-
routeTableIds
public final List<String> routeTableIds()
(Gateway endpoint) The route table IDs.
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
hasRouteTableIds()
method.- Returns:
- (Gateway endpoint) The route table IDs.
-
hasSubnetIds
public final boolean hasSubnetIds()
For responses, this returns true if the service returned a value for the SubnetIds 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.
-
subnetIds
public final List<String> subnetIds()
(Interface and Gateway Load Balancer endpoints) The IDs of the subnets in which to create endpoint network interfaces. For a Gateway Load Balancer endpoint, you can specify only one subnet.
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
hasSubnetIds()
method.- Returns:
- (Interface and Gateway Load Balancer endpoints) The IDs of the subnets in which to create endpoint network interfaces. For a Gateway Load Balancer endpoint, you can specify only one subnet.
-
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()
(Interface endpoint) 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.
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:
- (Interface endpoint) 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.
-
ipAddressType
public final IpAddressType ipAddressType()
The IP address type for the endpoint.
If the service returns an enum value that is not available in the current SDK version,
ipAddressType
will returnIpAddressType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromipAddressTypeAsString()
.- Returns:
- The IP address type for the endpoint.
- See Also:
IpAddressType
-
ipAddressTypeAsString
public final String ipAddressTypeAsString()
The IP address type for the endpoint.
If the service returns an enum value that is not available in the current SDK version,
ipAddressType
will returnIpAddressType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromipAddressTypeAsString()
.- Returns:
- The IP address type for the endpoint.
- See Also:
IpAddressType
-
dnsOptions
public final DnsOptionsSpecification dnsOptions()
The DNS options for the endpoint.
- Returns:
- The DNS options for the endpoint.
-
clientToken
public final 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 final 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
andenableDnsSupport
. 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
andenableDnsSupport
. Use ModifyVpcAttribute to set the VPC attributes.Default:
true
-
hasTagSpecifications
public final boolean hasTagSpecifications()
For responses, this returns true if the service returned a value for the TagSpecifications 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.
-
tagSpecifications
public final List<TagSpecification> tagSpecifications()
The tags to associate with the endpoint.
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
hasTagSpecifications()
method.- Returns:
- The tags to associate with the endpoint.
-
hasSubnetConfigurations
public final boolean hasSubnetConfigurations()
For responses, this returns true if the service returned a value for the SubnetConfigurations 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.
-
subnetConfigurations
public final List<SubnetConfiguration> subnetConfigurations()
The subnet configurations for the endpoint.
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
hasSubnetConfigurations()
method.- Returns:
- The subnet configurations for the endpoint.
-
toBuilder
public CreateVpcEndpointRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateVpcEndpointRequest.Builder,CreateVpcEndpointRequest>
- Specified by:
toBuilder
in classEc2Request
-
builder
public static CreateVpcEndpointRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateVpcEndpointRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in 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:
getValueForField
in classSdkRequest
-
-