Package 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("software.amazon.awssdk:codegen") public final class CreateResolverEndpointRequest extends Route53ResolverRequest implements ToCopyableBuilder<CreateResolverEndpointRequest.Builder,CreateResolverEndpointRequest>

  • Method Details

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

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

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

      Even though the minimum is 1, Route 53 requires that you create at least two.

      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.

      Even though the minimum is 1, Route 53 requires that you create at least two.

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

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

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

    • protocols

      public final List<Protocol> protocols()

      The protocols you want to use for the endpoint. DoH-FIPS is applicable for inbound endpoints only.

      For an inbound endpoint you can apply the protocols as follows:

      • Do53 and DoH in combination.

      • Do53 and DoH-FIPS in combination.

      • Do53 alone.

      • DoH alone.

      • DoH-FIPS alone.

      • None, which is treated as Do53.

      For an outbound endpoint you can apply the protocols as follows:

      • Do53 and DoH in combination.

      • Do53 alone.

      • DoH alone.

      • None, which is treated as Do53.

      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 hasProtocols() method.

      Returns:
      The protocols you want to use for the endpoint. DoH-FIPS is applicable for inbound endpoints only.

      For an inbound endpoint you can apply the protocols as follows:

      • Do53 and DoH in combination.

      • Do53 and DoH-FIPS in combination.

      • Do53 alone.

      • DoH alone.

      • DoH-FIPS alone.

      • None, which is treated as Do53.

      For an outbound endpoint you can apply the protocols as follows:

      • Do53 and DoH in combination.

      • Do53 alone.

      • DoH alone.

      • None, which is treated as Do53.

    • hasProtocols

      public final boolean hasProtocols()
      For responses, this returns true if the service returned a value for the Protocols 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.

    • protocolsAsStrings

      public final List<String> protocolsAsStrings()

      The protocols you want to use for the endpoint. DoH-FIPS is applicable for inbound endpoints only.

      For an inbound endpoint you can apply the protocols as follows:

      • Do53 and DoH in combination.

      • Do53 and DoH-FIPS in combination.

      • Do53 alone.

      • DoH alone.

      • DoH-FIPS alone.

      • None, which is treated as Do53.

      For an outbound endpoint you can apply the protocols as follows:

      • Do53 and DoH in combination.

      • Do53 alone.

      • DoH alone.

      • None, which is treated as Do53.

      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 hasProtocols() method.

      Returns:
      The protocols you want to use for the endpoint. DoH-FIPS is applicable for inbound endpoints only.

      For an inbound endpoint you can apply the protocols as follows:

      • Do53 and DoH in combination.

      • Do53 and DoH-FIPS in combination.

      • Do53 alone.

      • DoH alone.

      • DoH-FIPS alone.

      • None, which is treated as Do53.

      For an outbound endpoint you can apply the protocols as follows:

      • Do53 and DoH in combination.

      • Do53 alone.

      • DoH alone.

      • None, which is treated as Do53.

    • toBuilder

      public CreateResolverEndpointRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateResolverEndpointRequest.Builder,CreateResolverEndpointRequest>
      Specified by:
      toBuilder in class Route53ResolverRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.