Interface Api.Builder

    • Method Detail

      • apiId

        Api.Builder apiId​(String apiId)

        The Api ID.

        Parameters:
        apiId - The Api ID.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • name

        Api.Builder name​(String name)

        The name of the Api.

        Parameters:
        name - The name of the Api.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • ownerContact

        Api.Builder ownerContact​(String ownerContact)

        The owner contact information for the Api

        Parameters:
        ownerContact - The owner contact information for the Api
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • tags

        Api.Builder tags​(Map<String,​String> tags)
        Sets the value of the Tags property for this object.
        Parameters:
        tags - The new value for the Tags property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • dns

        Api.Builder dns​(Map<String,​String> dns)

        The DNS records for the API. This will include an HTTP and a real-time endpoint.

        Parameters:
        dns - The DNS records for the API. This will include an HTTP and a real-time endpoint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • apiArn

        Api.Builder apiArn​(String apiArn)

        The Amazon Resource Name (ARN) for the Api.

        Parameters:
        apiArn - The Amazon Resource Name (ARN) for the Api.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • created

        Api.Builder created​(Instant created)

        The date and time that the Api was created.

        Parameters:
        created - The date and time that the Api was created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • xrayEnabled

        Api.Builder xrayEnabled​(Boolean xrayEnabled)

        A flag indicating whether to use X-Ray tracing for this Api.

        Parameters:
        xrayEnabled - A flag indicating whether to use X-Ray tracing for this Api.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • wafWebAclArn

        Api.Builder wafWebAclArn​(String wafWebAclArn)

        The Amazon Resource Name (ARN) of the WAF web access control list (web ACL) associated with this Api, if one exists.

        Parameters:
        wafWebAclArn - The Amazon Resource Name (ARN) of the WAF web access control list (web ACL) associated with this Api, if one exists.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • eventConfig

        Api.Builder eventConfig​(EventConfig eventConfig)

        The Event API configuration. This includes the default authorization configuration for connecting, publishing, and subscribing to an Event API.

        Parameters:
        eventConfig - The Event API configuration. This includes the default authorization configuration for connecting, publishing, and subscribing to an Event API.
        Returns:
        Returns a reference to this object so that method calls can be chained together.