Package software.amazon.awssdk.services.apigateway.model

Interface EndpointConfiguration.Builder

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

  • Method Details

    • typesWithStrings

      EndpointConfiguration.Builder typesWithStrings(Collection<String> types)

      A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is "EDGE". For a regional API and its custom domain name, the endpoint type is REGIONAL. For a private API, the endpoint type is PRIVATE.

      Parameters:
      types - A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is "EDGE". For a regional API and its custom domain name, the endpoint type is REGIONAL. For a private API, the endpoint type is PRIVATE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • typesWithStrings

      EndpointConfiguration.Builder typesWithStrings(String... types)

      A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is "EDGE". For a regional API and its custom domain name, the endpoint type is REGIONAL. For a private API, the endpoint type is PRIVATE.

      Parameters:
      types - A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is "EDGE". For a regional API and its custom domain name, the endpoint type is REGIONAL. For a private API, the endpoint type is PRIVATE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • types

      EndpointConfiguration.Builder types(Collection<EndpointType> types)

      A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is "EDGE". For a regional API and its custom domain name, the endpoint type is REGIONAL. For a private API, the endpoint type is PRIVATE.

      Parameters:
      types - A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is "EDGE". For a regional API and its custom domain name, the endpoint type is REGIONAL. For a private API, the endpoint type is PRIVATE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • types

      EndpointConfiguration.Builder types(EndpointType... types)

      A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is "EDGE". For a regional API and its custom domain name, the endpoint type is REGIONAL. For a private API, the endpoint type is PRIVATE.

      Parameters:
      types - A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is "EDGE". For a regional API and its custom domain name, the endpoint type is REGIONAL. For a private API, the endpoint type is PRIVATE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ipAddressType

      EndpointConfiguration.Builder ipAddressType(String ipAddressType)

      The IP address types that can invoke an API (RestApi) or a DomainName. Use ipv4 to allow only IPv4 addresses to invoke an API or DomainName, or use dualstack to allow both IPv4 and IPv6 addresses to invoke an API or a DomainName. For the PRIVATE endpoint type, only dualstack is supported.

      Parameters:
      ipAddressType - The IP address types that can invoke an API (RestApi) or a DomainName. Use ipv4 to allow only IPv4 addresses to invoke an API or DomainName, or use dualstack to allow both IPv4 and IPv6 addresses to invoke an API or a DomainName. For the PRIVATE endpoint type, only dualstack is supported.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • ipAddressType

      EndpointConfiguration.Builder ipAddressType(IpAddressType ipAddressType)

      The IP address types that can invoke an API (RestApi) or a DomainName. Use ipv4 to allow only IPv4 addresses to invoke an API or DomainName, or use dualstack to allow both IPv4 and IPv6 addresses to invoke an API or a DomainName. For the PRIVATE endpoint type, only dualstack is supported.

      Parameters:
      ipAddressType - The IP address types that can invoke an API (RestApi) or a DomainName. Use ipv4 to allow only IPv4 addresses to invoke an API or DomainName, or use dualstack to allow both IPv4 and IPv6 addresses to invoke an API or a DomainName. For the PRIVATE endpoint type, only dualstack is supported.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • vpcEndpointIds

      EndpointConfiguration.Builder vpcEndpointIds(Collection<String> vpcEndpointIds)

      A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for PRIVATE endpoint type.

      Parameters:
      vpcEndpointIds - A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for PRIVATE endpoint type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcEndpointIds

      EndpointConfiguration.Builder vpcEndpointIds(String... vpcEndpointIds)

      A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for PRIVATE endpoint type.

      Parameters:
      vpcEndpointIds - A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for PRIVATE endpoint type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.