Interface CreateBasePathMappingRequest.Builder

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

  • Method Details

    • domainName

      CreateBasePathMappingRequest.Builder domainName(String domainName)

      The domain name of the BasePathMapping resource to create.

      Parameters:
      domainName - The domain name of the BasePathMapping resource to create.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • domainNameId

      CreateBasePathMappingRequest.Builder domainNameId(String domainNameId)

      The identifier for the domain name resource. Required for private custom domain names.

      Parameters:
      domainNameId - The identifier for the domain name resource. Required for private custom domain names.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • basePath

      CreateBasePathMappingRequest.Builder basePath(String basePath)

      The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Specify '(none)' if you do not want callers to specify a base path name after the domain name.

      Parameters:
      basePath - The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Specify '(none)' if you do not want callers to specify a base path name after the domain name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • restApiId

      CreateBasePathMappingRequest.Builder restApiId(String restApiId)

      The string identifier of the associated RestApi.

      Parameters:
      restApiId - The string identifier of the associated RestApi.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stage

      CreateBasePathMappingRequest.Builder stage(String stage)

      The name of the API's stage that you want to use for this mapping. Specify '(none)' if you want callers to explicitly specify the stage name after any base path name.

      Parameters:
      stage - The name of the API's stage that you want to use for this mapping. Specify '(none)' if you want callers to explicitly specify the stage name after any base path name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateBasePathMappingRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateBasePathMappingRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.