software.amazon.awssdk.services.route53resolver.model

Class CreateResolverEndpointRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.route53resolver.model.Route53ResolverRequest

software.amazon.awssdk.services.route53resolver.model.CreateResolverEndpointRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateResolverEndpointRequest.Builder,CreateResolverEndpointRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateResolverEndpointRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateResolverEndpointRequest.Builder	builder()
String	creatorRequestId() A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice.
ResolverEndpointDirection	direction() Specify the applicable value:
String	directionAsString() Specify the applicable value:
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasIpAddresses() For responses, this returns true if the service returned a value for the IpAddresses property.
boolean	hasSecurityGroupIds() For responses, this returns true if the service returned a value for the SecurityGroupIds property.
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
List<IpAddressRequest>	ipAddresses() The subnets and IP addresses in your VPC that DNS queries originate from (for outbound endpoints) or that you forward DNS queries to (for inbound endpoints).
String	name() A friendly name that lets you easily find a configuration in the Resolver dashboard in the Route 53 console.
String	outpostArn() The Amazon Resource Name (ARN) of the Outpost.
String	preferredInstanceType() The instance type.
ResolverEndpointType	resolverEndpointType() For the endpoint type you can choose either IPv4, IPv6, or dual-stack.
String	resolverEndpointTypeAsString() For the endpoint type you can choose either IPv4, IPv6, or dual-stack.
List<SdkField<?>>	sdkFields()
List<String>	securityGroupIds() The ID of one or more security groups that you want to use to control access to this VPC.
static Class<? extends CreateResolverEndpointRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() A list of the tag keys and values that you want to associate with the endpoint.
CreateResolverEndpointRequest.Builder	toBuilder()
String	toString() 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

creatorRequestId

public final String creatorRequestId()

A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

Returns:

A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

name

public final String name()

A friendly name that lets you easily find a configuration in the Resolver dashboard in the Route 53 console.

Returns:

A friendly name that lets you easily find a configuration in the Resolver dashboard in the Route 53 console.

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 the isEmpty() 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()

The ID of one or more security groups that you want to use to control access to this VPC. The security group that you specify must include one or more inbound rules (for inbound Resolver endpoints) or outbound rules (for outbound Resolver endpoints). Inbound and outbound rules must allow TCP and UDP access. For inbound access, open port 53. For outbound access, open the port that you're using for DNS queries on your network.

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:

The ID of one or more security groups that you want to use to control access to this VPC. The security group that you specify must include one or more inbound rules (for inbound Resolver endpoints) or outbound rules (for outbound Resolver endpoints). Inbound and outbound rules must allow TCP and UDP access. For inbound access, open port 53. For outbound access, open the port that you're using for DNS queries on your network.

direction

public final ResolverEndpointDirection direction()

Specify the applicable value:

• INBOUND: Resolver forwards DNS queries to the DNS service for a VPC from your network

• OUTBOUND: Resolver forwards DNS queries from the DNS service for a VPC to your network

If the service returns an enum value that is not available in the current SDK version, direction will return ResolverEndpointDirection.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from directionAsString().

Returns:

Specify the applicable value:

• INBOUND: Resolver forwards DNS queries to the DNS service for a VPC from your network

• OUTBOUND: Resolver forwards DNS queries from the DNS service for a VPC to your network

See Also:

ResolverEndpointDirection

directionAsString

public final String directionAsString()

Specify the applicable value:

• INBOUND: Resolver forwards DNS queries to the DNS service for a VPC from your network

• OUTBOUND: Resolver forwards DNS queries from the DNS service for a VPC to your network

If the service returns an enum value that is not available in the current SDK version, direction will return ResolverEndpointDirection.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from directionAsString().

Returns:

Specify the applicable value:

• INBOUND: Resolver forwards DNS queries to the DNS service for a VPC from your network

• OUTBOUND: Resolver forwards DNS queries from the DNS service for a VPC to your network

See Also:

ResolverEndpointDirection

hasIpAddresses

public final boolean hasIpAddresses()

For responses, this returns true if the service returned a value for the IpAddresses property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

ipAddresses

public final List<IpAddressRequest> ipAddresses()

The subnets and IP addresses in your VPC that DNS queries originate from (for outbound endpoints) or that you forward DNS queries to (for inbound endpoints). The subnet ID uniquely identifies a 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 hasIpAddresses() method.

Returns:

The subnets and IP addresses in your VPC that DNS queries originate from (for outbound endpoints) or that you forward DNS queries to (for inbound endpoints). The subnet ID uniquely identifies a VPC.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

tags

public final List<Tag> tags()

A list of the tag keys and values that you want 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 hasTags() method.

Returns:

A list of the tag keys and values that you want to associate with the endpoint.

resolverEndpointType

public final ResolverEndpointType resolverEndpointType()

For the endpoint type you can choose either IPv4, IPv6, or dual-stack. A dual-stack endpoint means that it will resolve via both IPv4 and IPv6. This endpoint type is applied to all IP addresses.

If the service returns an enum value that is not available in the current SDK version, resolverEndpointType will return ResolverEndpointType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resolverEndpointTypeAsString().

Returns:

For the endpoint type you can choose either IPv4, IPv6, or dual-stack. A dual-stack endpoint means that it will resolve via both IPv4 and IPv6. This endpoint type is applied to all IP addresses.

See Also:

ResolverEndpointType

resolverEndpointTypeAsString

public final String resolverEndpointTypeAsString()

For the endpoint type you can choose either IPv4, IPv6, or dual-stack. A dual-stack endpoint means that it will resolve via both IPv4 and IPv6. This endpoint type is applied to all IP addresses.

If the service returns an enum value that is not available in the current SDK version, resolverEndpointType will return ResolverEndpointType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resolverEndpointTypeAsString().

Returns:

For the endpoint type you can choose either IPv4, IPv6, or dual-stack. A dual-stack endpoint means that it will resolve via both IPv4 and IPv6. This endpoint type is applied to all IP addresses.

See Also:

ResolverEndpointType

outpostArn

public final String outpostArn()

The Amazon Resource Name (ARN) of the Outpost. If you specify this, you must also specify a value for the PreferredInstanceType.

Returns:

The Amazon Resource Name (ARN) of the Outpost. If you specify this, you must also specify a value for the PreferredInstanceType.

preferredInstanceType

public final String preferredInstanceType()

The instance type. If you specify this, you must also specify a value for the OutpostArn.

Returns:

The instance type. If you specify this, you must also specify a value for the OutpostArn.

toBuilder

public CreateResolverEndpointRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateResolverEndpointRequest.Builder,CreateResolverEndpointRequest>

Specified by:

toBuilder in class Route53ResolverRequest

builder

public static CreateResolverEndpointRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateResolverEndpointRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo